Commit | Line | Data |
---|---|---|
9ec76716 SL |
1 | /* |
2 | * IEEE802.15.4-2003 specification | |
3 | * | |
4 | * Copyright (C) 2007, 2008 Siemens AG | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License version 2 | |
8 | * as published by the Free Software Foundation. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
9ec76716 SL |
15 | * Written by: |
16 | * Pavel Smolenskiy <pavel.smolenskiy@gmail.com> | |
17 | * Maxim Gorbachyov <maxim.gorbachev@siemens.com> | |
18 | * Maxim Osipov <maxim.osipov@siemens.com> | |
19 | * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com> | |
719269af | 20 | * Alexander Smirnov <alex.bluesman.smirnov@gmail.com> |
9ec76716 SL |
21 | */ |
22 | ||
4ca24aca AA |
23 | #ifndef LINUX_IEEE802154_H |
24 | #define LINUX_IEEE802154_H | |
9ec76716 | 25 | |
fa491001 | 26 | #include <linux/types.h> |
35d5a374 | 27 | #include <linux/random.h> |
c28bee84 | 28 | #include <asm/byteorder.h> |
fa491001 | 29 | |
719269af | 30 | #define IEEE802154_MTU 127 |
306f7aa1 AA |
31 | #define IEEE802154_ACK_PSDU_LEN 5 |
32 | #define IEEE802154_MIN_PSDU_LEN 9 | |
719269af | 33 | |
702bf371 | 34 | #define IEEE802154_PAN_ID_BROADCAST 0xffff |
9830c62a AA |
35 | #define IEEE802154_ADDR_SHORT_BROADCAST 0xffff |
36 | #define IEEE802154_ADDR_SHORT_UNSPEC 0xfffe | |
702bf371 | 37 | |
1906bbbd AA |
38 | #define IEEE802154_EXTENDED_ADDR_LEN 8 |
39 | ||
61f2dcba AA |
40 | #define IEEE802154_LIFS_PERIOD 40 |
41 | #define IEEE802154_SIFS_PERIOD 12 | |
42 | ||
cb41c8dd AA |
43 | #define IEEE802154_MAX_CHANNEL 26 |
44 | #define IEEE802154_MAX_PAGE 31 | |
45 | ||
9ec76716 SL |
46 | #define IEEE802154_FC_TYPE_BEACON 0x0 /* Frame is beacon */ |
47 | #define IEEE802154_FC_TYPE_DATA 0x1 /* Frame is data */ | |
48 | #define IEEE802154_FC_TYPE_ACK 0x2 /* Frame is acknowledgment */ | |
49 | #define IEEE802154_FC_TYPE_MAC_CMD 0x3 /* Frame is MAC command */ | |
50 | ||
51 | #define IEEE802154_FC_TYPE_SHIFT 0 | |
52 | #define IEEE802154_FC_TYPE_MASK ((1 << 3) - 1) | |
53 | #define IEEE802154_FC_TYPE(x) ((x & IEEE802154_FC_TYPE_MASK) >> IEEE802154_FC_TYPE_SHIFT) | |
54 | #define IEEE802154_FC_SET_TYPE(v, x) do { \ | |
55 | v = (((v) & ~IEEE802154_FC_TYPE_MASK) | \ | |
56 | (((x) << IEEE802154_FC_TYPE_SHIFT) & IEEE802154_FC_TYPE_MASK)); \ | |
57 | } while (0) | |
58 | ||
94b4f6c2 PB |
59 | #define IEEE802154_FC_SECEN_SHIFT 3 |
60 | #define IEEE802154_FC_SECEN (1 << IEEE802154_FC_SECEN_SHIFT) | |
61 | #define IEEE802154_FC_FRPEND_SHIFT 4 | |
62 | #define IEEE802154_FC_FRPEND (1 << IEEE802154_FC_FRPEND_SHIFT) | |
63 | #define IEEE802154_FC_ACK_REQ_SHIFT 5 | |
64 | #define IEEE802154_FC_ACK_REQ (1 << IEEE802154_FC_ACK_REQ_SHIFT) | |
65 | #define IEEE802154_FC_INTRA_PAN_SHIFT 6 | |
66 | #define IEEE802154_FC_INTRA_PAN (1 << IEEE802154_FC_INTRA_PAN_SHIFT) | |
9ec76716 SL |
67 | |
68 | #define IEEE802154_FC_SAMODE_SHIFT 14 | |
69 | #define IEEE802154_FC_SAMODE_MASK (3 << IEEE802154_FC_SAMODE_SHIFT) | |
70 | #define IEEE802154_FC_DAMODE_SHIFT 10 | |
71 | #define IEEE802154_FC_DAMODE_MASK (3 << IEEE802154_FC_DAMODE_SHIFT) | |
72 | ||
94b4f6c2 PB |
73 | #define IEEE802154_FC_VERSION_SHIFT 12 |
74 | #define IEEE802154_FC_VERSION_MASK (3 << IEEE802154_FC_VERSION_SHIFT) | |
75 | #define IEEE802154_FC_VERSION(x) ((x & IEEE802154_FC_VERSION_MASK) >> IEEE802154_FC_VERSION_SHIFT) | |
76 | ||
9ec76716 SL |
77 | #define IEEE802154_FC_SAMODE(x) \ |
78 | (((x) & IEEE802154_FC_SAMODE_MASK) >> IEEE802154_FC_SAMODE_SHIFT) | |
79 | ||
80 | #define IEEE802154_FC_DAMODE(x) \ | |
81 | (((x) & IEEE802154_FC_DAMODE_MASK) >> IEEE802154_FC_DAMODE_SHIFT) | |
82 | ||
94b4f6c2 PB |
83 | #define IEEE802154_SCF_SECLEVEL_MASK 7 |
84 | #define IEEE802154_SCF_SECLEVEL_SHIFT 0 | |
85 | #define IEEE802154_SCF_SECLEVEL(x) (x & IEEE802154_SCF_SECLEVEL_MASK) | |
86 | #define IEEE802154_SCF_KEY_ID_MODE_SHIFT 3 | |
87 | #define IEEE802154_SCF_KEY_ID_MODE_MASK (3 << IEEE802154_SCF_KEY_ID_MODE_SHIFT) | |
88 | #define IEEE802154_SCF_KEY_ID_MODE(x) \ | |
89 | ((x & IEEE802154_SCF_KEY_ID_MODE_MASK) >> IEEE802154_SCF_KEY_ID_MODE_SHIFT) | |
90 | ||
91 | #define IEEE802154_SCF_KEY_IMPLICIT 0 | |
92 | #define IEEE802154_SCF_KEY_INDEX 1 | |
93 | #define IEEE802154_SCF_KEY_SHORT_INDEX 2 | |
94 | #define IEEE802154_SCF_KEY_HW_INDEX 3 | |
9ec76716 | 95 | |
c3a6114f PB |
96 | #define IEEE802154_SCF_SECLEVEL_NONE 0 |
97 | #define IEEE802154_SCF_SECLEVEL_MIC32 1 | |
98 | #define IEEE802154_SCF_SECLEVEL_MIC64 2 | |
99 | #define IEEE802154_SCF_SECLEVEL_MIC128 3 | |
100 | #define IEEE802154_SCF_SECLEVEL_ENC 4 | |
101 | #define IEEE802154_SCF_SECLEVEL_ENC_MIC32 5 | |
102 | #define IEEE802154_SCF_SECLEVEL_ENC_MIC64 6 | |
103 | #define IEEE802154_SCF_SECLEVEL_ENC_MIC128 7 | |
104 | ||
719269af | 105 | /* MAC footer size */ |
106 | #define IEEE802154_MFR_SIZE 2 /* 2 octets */ | |
107 | ||
9ec76716 SL |
108 | /* MAC's Command Frames Identifiers */ |
109 | #define IEEE802154_CMD_ASSOCIATION_REQ 0x01 | |
110 | #define IEEE802154_CMD_ASSOCIATION_RESP 0x02 | |
111 | #define IEEE802154_CMD_DISASSOCIATION_NOTIFY 0x03 | |
112 | #define IEEE802154_CMD_DATA_REQ 0x04 | |
113 | #define IEEE802154_CMD_PANID_CONFLICT_NOTIFY 0x05 | |
114 | #define IEEE802154_CMD_ORPHAN_NOTIFY 0x06 | |
115 | #define IEEE802154_CMD_BEACON_REQ 0x07 | |
116 | #define IEEE802154_CMD_COORD_REALIGN_NOTIFY 0x08 | |
117 | #define IEEE802154_CMD_GTS_REQ 0x09 | |
118 | ||
119 | /* | |
120 | * The return values of MAC operations | |
121 | */ | |
122 | enum { | |
123 | /* | |
124 | * The requested operation was completed successfully. | |
125 | * For a transmission request, this value indicates | |
126 | * a successful transmission. | |
127 | */ | |
128 | IEEE802154_SUCCESS = 0x0, | |
129 | ||
130 | /* The beacon was lost following a synchronization request. */ | |
131 | IEEE802154_BEACON_LOSS = 0xe0, | |
132 | /* | |
133 | * A transmission could not take place due to activity on the | |
134 | * channel, i.e., the CSMA-CA mechanism has failed. | |
135 | */ | |
136 | IEEE802154_CHNL_ACCESS_FAIL = 0xe1, | |
137 | /* The GTS request has been denied by the PAN coordinator. */ | |
138 | IEEE802154_DENINED = 0xe2, | |
139 | /* The attempt to disable the transceiver has failed. */ | |
140 | IEEE802154_DISABLE_TRX_FAIL = 0xe3, | |
141 | /* | |
142 | * The received frame induces a failed security check according to | |
143 | * the security suite. | |
144 | */ | |
145 | IEEE802154_FAILED_SECURITY_CHECK = 0xe4, | |
146 | /* | |
147 | * The frame resulting from secure processing has a length that is | |
148 | * greater than aMACMaxFrameSize. | |
149 | */ | |
150 | IEEE802154_FRAME_TOO_LONG = 0xe5, | |
151 | /* | |
152 | * The requested GTS transmission failed because the specified GTS | |
153 | * either did not have a transmit GTS direction or was not defined. | |
154 | */ | |
155 | IEEE802154_INVALID_GTS = 0xe6, | |
156 | /* | |
157 | * A request to purge an MSDU from the transaction queue was made using | |
158 | * an MSDU handle that was not found in the transaction table. | |
159 | */ | |
160 | IEEE802154_INVALID_HANDLE = 0xe7, | |
161 | /* A parameter in the primitive is out of the valid range.*/ | |
162 | IEEE802154_INVALID_PARAMETER = 0xe8, | |
163 | /* No acknowledgment was received after aMaxFrameRetries. */ | |
164 | IEEE802154_NO_ACK = 0xe9, | |
165 | /* A scan operation failed to find any network beacons.*/ | |
166 | IEEE802154_NO_BEACON = 0xea, | |
167 | /* No response data were available following a request. */ | |
168 | IEEE802154_NO_DATA = 0xeb, | |
169 | /* The operation failed because a short address was not allocated. */ | |
170 | IEEE802154_NO_SHORT_ADDRESS = 0xec, | |
171 | /* | |
172 | * A receiver enable request was unsuccessful because it could not be | |
173 | * completed within the CAP. | |
174 | */ | |
175 | IEEE802154_OUT_OF_CAP = 0xed, | |
176 | /* | |
177 | * A PAN identifier conflict has been detected and communicated to the | |
178 | * PAN coordinator. | |
179 | */ | |
180 | IEEE802154_PANID_CONFLICT = 0xee, | |
181 | /* A coordinator realignment command has been received. */ | |
182 | IEEE802154_REALIGMENT = 0xef, | |
183 | /* The transaction has expired and its information discarded. */ | |
184 | IEEE802154_TRANSACTION_EXPIRED = 0xf0, | |
185 | /* There is no capacity to store the transaction. */ | |
186 | IEEE802154_TRANSACTION_OVERFLOW = 0xf1, | |
187 | /* | |
188 | * The transceiver was in the transmitter enabled state when the | |
189 | * receiver was requested to be enabled. | |
190 | */ | |
191 | IEEE802154_TX_ACTIVE = 0xf2, | |
192 | /* The appropriate key is not available in the ACL. */ | |
193 | IEEE802154_UNAVAILABLE_KEY = 0xf3, | |
194 | /* | |
195 | * A SET/GET request was issued with the identifier of a PIB attribute | |
196 | * that is not supported. | |
197 | */ | |
198 | IEEE802154_UNSUPPORTED_ATTR = 0xf4, | |
199 | /* | |
200 | * A request to perform a scan operation failed because the MLME was | |
201 | * in the process of performing a previously initiated scan operation. | |
202 | */ | |
203 | IEEE802154_SCAN_IN_PROGRESS = 0xfc, | |
204 | }; | |
205 | ||
fa491001 AA |
206 | /** |
207 | * ieee802154_is_valid_psdu_len - check if psdu len is valid | |
306f7aa1 AA |
208 | * available lengths: |
209 | * 0-4 Reserved | |
210 | * 5 MPDU (Acknowledgment) | |
211 | * 6-8 Reserved | |
212 | * 9-127 MPDU | |
213 | * | |
fa491001 AA |
214 | * @len: psdu len with (MHR + payload + MFR) |
215 | */ | |
216 | static inline bool ieee802154_is_valid_psdu_len(const u8 len) | |
217 | { | |
306f7aa1 AA |
218 | return (len == IEEE802154_ACK_PSDU_LEN || |
219 | (len >= IEEE802154_MIN_PSDU_LEN && len <= IEEE802154_MTU)); | |
fa491001 | 220 | } |
9ec76716 | 221 | |
cb904b0a AA |
222 | /** |
223 | * ieee802154_is_valid_psdu_len - check if extended addr is valid | |
224 | * @addr: extended addr to check | |
225 | */ | |
226 | static inline bool ieee802154_is_valid_extended_addr(const __le64 addr) | |
227 | { | |
228 | /* These EUI-64 addresses are reserved by IEEE. 0xffffffffffffffff | |
229 | * is used internally as extended to short address broadcast mapping. | |
230 | * This is currently a workaround because neighbor discovery can't | |
231 | * deal with short addresses types right now. | |
232 | */ | |
0d8a52f9 | 233 | return ((addr != cpu_to_le64(0x0000000000000000ULL)) && |
c28bee84 | 234 | (addr != cpu_to_le64(0xffffffffffffffffULL))); |
cb904b0a AA |
235 | } |
236 | ||
35d5a374 AA |
237 | /** |
238 | * ieee802154_random_extended_addr - generates a random extended address | |
239 | * @addr: extended addr pointer to place the random address | |
240 | */ | |
241 | static inline void ieee802154_random_extended_addr(__le64 *addr) | |
242 | { | |
243 | get_random_bytes(addr, IEEE802154_EXTENDED_ADDR_LEN); | |
244 | ||
245 | /* toggle some bit if we hit an invalid extended addr */ | |
246 | if (!ieee802154_is_valid_extended_addr(*addr)) | |
247 | ((u8 *)addr)[IEEE802154_EXTENDED_ADDR_LEN - 1] ^= 0x01; | |
248 | } | |
249 | ||
4ca24aca | 250 | #endif /* LINUX_IEEE802154_H */ |