Contiki-NG
ieee-addr.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013, Texas Instruments Incorporated - http://www.ti.com/
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived
16  * from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29  * OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 /**
32  * \addtogroup cc2538
33  * @{
34  *
35  * \defgroup cc2538-ieee-addr cc2538 IEEE Address Control
36  *
37  * Driver for the retrieval of an IEEE address from flash
38  * @{
39  *
40  * \file
41  * Header file with register and macro declarations for the cc2538 IEEE address
42  * driver
43  */
44 #ifndef IEEE_ADDR_H_
45 #define IEEE_ADDR_H_
46 
47 #include "contiki.h"
48 
49 #include <stdint.h>
50 /*---------------------------------------------------------------------------*/
51 /**
52  * \name TI OUI
53  * @{
54  */
55 #define IEEE_ADDR_OUI_TI { 0x00, 0x12, 0x4B } /**< TI OUI */
56 /** @} */
57 /*---------------------------------------------------------------------------*/
58 /**
59  * \name IEEE address locations
60  *
61  * The address of the secondary location can be configured by the platform
62  * or example
63  *
64  * @{
65  */
66 #define IEEE_ADDR_LOCATION_PRIMARY 0x00280028 /**< Primary IEEE address location */
67 
68 #ifdef IEEE_ADDR_CONF_LOCATION_SECONDARY
69 #define IEEE_ADDR_LOCATION_SECONDARY IEEE_ADDR_CONF_LOCATION_SECONDARY
70 #else
71 #define IEEE_ADDR_LOCATION_SECONDARY 0x0027FFCC /**< Secondary IEEE address location */
72 #endif
73 /** @} */
74 /*---------------------------------------------------------------------------*/
75 /**
76  * \brief Select which address location to use
77  * @{
78  */
79 #if IEEE_ADDR_CONF_USE_SECONDARY_LOCATION
80 #define IEEE_ADDR_LOCATION IEEE_ADDR_LOCATION_SECONDARY
81 #else
82 #define IEEE_ADDR_LOCATION IEEE_ADDR_LOCATION_PRIMARY
83 #endif
84 /** @} */
85 /*---------------------------------------------------------------------------*/
86 /*
87  * \brief Copy the node's IEEE address to a destination memory area
88  * \param dst A pointer to the destination area where the IEEE address is to be
89  * written
90  * \param len The number of bytes to write to destination area
91  *
92  * The address will be read from an InfoPage location or a hard-coded address
93  * will be used, depending on the value of configuration parameter
94  * IEEE_ADDR_CONF_HARDCODED
95  *
96  * This function will copy \e len LS bytes
97  *
98  * The destination address will be populated with dst[0] holding the MSB and
99  * dst[len - 1] holding the LSB
100  */
101 void ieee_addr_cpy_to(uint8_t *dst, uint8_t len);
102 
103 #endif /* IEEE_ADDR_H_ */
104 
105 /**
106  * @}
107  * @}
108  */
void ieee_addr_cpy_to(uint8_t *dst, uint8_t len)
Copy the node&#39;s IEEE address to a destination memory area.
Definition: ieee-addr.c:46