Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 *
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>
20 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
21 */
22
23#ifndef LINUX_IEEE802154_H
24#define LINUX_IEEE802154_H
25
26#include <linux/types.h>
27#include <linux/random.h>
28
29#define IEEE802154_MTU 127
30#define IEEE802154_ACK_PSDU_LEN 5
31#define IEEE802154_MIN_PSDU_LEN 9
32#define IEEE802154_FCS_LEN 2
33#define IEEE802154_MAX_AUTH_TAG_LEN 16
34
35/* General MAC frame format:
36 * 2 bytes: Frame Control
37 * 1 byte: Sequence Number
38 * 20 bytes: Addressing fields
39 * 14 bytes: Auxiliary Security Header
40 */
41#define IEEE802154_MAX_HEADER_LEN (2 + 1 + 20 + 14)
42#define IEEE802154_MIN_HEADER_LEN (IEEE802154_ACK_PSDU_LEN - \
43 IEEE802154_FCS_LEN)
44
45#define IEEE802154_PAN_ID_BROADCAST 0xffff
46#define IEEE802154_ADDR_SHORT_BROADCAST 0xffff
47#define IEEE802154_ADDR_SHORT_UNSPEC 0xfffe
48
49#define IEEE802154_EXTENDED_ADDR_LEN 8
50#define IEEE802154_SHORT_ADDR_LEN 2
51
52#define IEEE802154_LIFS_PERIOD 40
53#define IEEE802154_SIFS_PERIOD 12
54#define IEEE802154_MAX_SIFS_FRAME_SIZE 18
55
56#define IEEE802154_MAX_CHANNEL 26
57#define IEEE802154_MAX_PAGE 31
58
59#define IEEE802154_FC_TYPE_BEACON 0x0 /* Frame is beacon */
60#define IEEE802154_FC_TYPE_DATA 0x1 /* Frame is data */
61#define IEEE802154_FC_TYPE_ACK 0x2 /* Frame is acknowledgment */
62#define IEEE802154_FC_TYPE_MAC_CMD 0x3 /* Frame is MAC command */
63
64#define IEEE802154_FC_TYPE_SHIFT 0
65#define IEEE802154_FC_TYPE_MASK ((1 << 3) - 1)
66#define IEEE802154_FC_TYPE(x) ((x & IEEE802154_FC_TYPE_MASK) >> IEEE802154_FC_TYPE_SHIFT)
67#define IEEE802154_FC_SET_TYPE(v, x) do { \
68 v = (((v) & ~IEEE802154_FC_TYPE_MASK) | \
69 (((x) << IEEE802154_FC_TYPE_SHIFT) & IEEE802154_FC_TYPE_MASK)); \
70 } while (0)
71
72#define IEEE802154_FC_SECEN_SHIFT 3
73#define IEEE802154_FC_SECEN (1 << IEEE802154_FC_SECEN_SHIFT)
74#define IEEE802154_FC_FRPEND_SHIFT 4
75#define IEEE802154_FC_FRPEND (1 << IEEE802154_FC_FRPEND_SHIFT)
76#define IEEE802154_FC_ACK_REQ_SHIFT 5
77#define IEEE802154_FC_ACK_REQ (1 << IEEE802154_FC_ACK_REQ_SHIFT)
78#define IEEE802154_FC_INTRA_PAN_SHIFT 6
79#define IEEE802154_FC_INTRA_PAN (1 << IEEE802154_FC_INTRA_PAN_SHIFT)
80
81#define IEEE802154_FC_SAMODE_SHIFT 14
82#define IEEE802154_FC_SAMODE_MASK (3 << IEEE802154_FC_SAMODE_SHIFT)
83#define IEEE802154_FC_DAMODE_SHIFT 10
84#define IEEE802154_FC_DAMODE_MASK (3 << IEEE802154_FC_DAMODE_SHIFT)
85
86#define IEEE802154_FC_VERSION_SHIFT 12
87#define IEEE802154_FC_VERSION_MASK (3 << IEEE802154_FC_VERSION_SHIFT)
88#define IEEE802154_FC_VERSION(x) ((x & IEEE802154_FC_VERSION_MASK) >> IEEE802154_FC_VERSION_SHIFT)
89
90#define IEEE802154_FC_SAMODE(x) \
91 (((x) & IEEE802154_FC_SAMODE_MASK) >> IEEE802154_FC_SAMODE_SHIFT)
92
93#define IEEE802154_FC_DAMODE(x) \
94 (((x) & IEEE802154_FC_DAMODE_MASK) >> IEEE802154_FC_DAMODE_SHIFT)
95
96#define IEEE802154_SCF_SECLEVEL_MASK 7
97#define IEEE802154_SCF_SECLEVEL_SHIFT 0
98#define IEEE802154_SCF_SECLEVEL(x) (x & IEEE802154_SCF_SECLEVEL_MASK)
99#define IEEE802154_SCF_KEY_ID_MODE_SHIFT 3
100#define IEEE802154_SCF_KEY_ID_MODE_MASK (3 << IEEE802154_SCF_KEY_ID_MODE_SHIFT)
101#define IEEE802154_SCF_KEY_ID_MODE(x) \
102 ((x & IEEE802154_SCF_KEY_ID_MODE_MASK) >> IEEE802154_SCF_KEY_ID_MODE_SHIFT)
103
104#define IEEE802154_SCF_KEY_IMPLICIT 0
105#define IEEE802154_SCF_KEY_INDEX 1
106#define IEEE802154_SCF_KEY_SHORT_INDEX 2
107#define IEEE802154_SCF_KEY_HW_INDEX 3
108
109#define IEEE802154_SCF_SECLEVEL_NONE 0
110#define IEEE802154_SCF_SECLEVEL_MIC32 1
111#define IEEE802154_SCF_SECLEVEL_MIC64 2
112#define IEEE802154_SCF_SECLEVEL_MIC128 3
113#define IEEE802154_SCF_SECLEVEL_ENC 4
114#define IEEE802154_SCF_SECLEVEL_ENC_MIC32 5
115#define IEEE802154_SCF_SECLEVEL_ENC_MIC64 6
116#define IEEE802154_SCF_SECLEVEL_ENC_MIC128 7
117
118/* MAC footer size */
119#define IEEE802154_MFR_SIZE 2 /* 2 octets */
120
121/* MAC's Command Frames Identifiers */
122#define IEEE802154_CMD_ASSOCIATION_REQ 0x01
123#define IEEE802154_CMD_ASSOCIATION_RESP 0x02
124#define IEEE802154_CMD_DISASSOCIATION_NOTIFY 0x03
125#define IEEE802154_CMD_DATA_REQ 0x04
126#define IEEE802154_CMD_PANID_CONFLICT_NOTIFY 0x05
127#define IEEE802154_CMD_ORPHAN_NOTIFY 0x06
128#define IEEE802154_CMD_BEACON_REQ 0x07
129#define IEEE802154_CMD_COORD_REALIGN_NOTIFY 0x08
130#define IEEE802154_CMD_GTS_REQ 0x09
131
132/*
133 * The return values of MAC operations
134 */
135enum {
136 /*
137 * The requested operation was completed successfully.
138 * For a transmission request, this value indicates
139 * a successful transmission.
140 */
141 IEEE802154_SUCCESS = 0x0,
142
143 /* The beacon was lost following a synchronization request. */
144 IEEE802154_BEACON_LOSS = 0xe0,
145 /*
146 * A transmission could not take place due to activity on the
147 * channel, i.e., the CSMA-CA mechanism has failed.
148 */
149 IEEE802154_CHNL_ACCESS_FAIL = 0xe1,
150 /* The GTS request has been denied by the PAN coordinator. */
151 IEEE802154_DENINED = 0xe2,
152 /* The attempt to disable the transceiver has failed. */
153 IEEE802154_DISABLE_TRX_FAIL = 0xe3,
154 /*
155 * The received frame induces a failed security check according to
156 * the security suite.
157 */
158 IEEE802154_FAILED_SECURITY_CHECK = 0xe4,
159 /*
160 * The frame resulting from secure processing has a length that is
161 * greater than aMACMaxFrameSize.
162 */
163 IEEE802154_FRAME_TOO_LONG = 0xe5,
164 /*
165 * The requested GTS transmission failed because the specified GTS
166 * either did not have a transmit GTS direction or was not defined.
167 */
168 IEEE802154_INVALID_GTS = 0xe6,
169 /*
170 * A request to purge an MSDU from the transaction queue was made using
171 * an MSDU handle that was not found in the transaction table.
172 */
173 IEEE802154_INVALID_HANDLE = 0xe7,
174 /* A parameter in the primitive is out of the valid range.*/
175 IEEE802154_INVALID_PARAMETER = 0xe8,
176 /* No acknowledgment was received after aMaxFrameRetries. */
177 IEEE802154_NO_ACK = 0xe9,
178 /* A scan operation failed to find any network beacons.*/
179 IEEE802154_NO_BEACON = 0xea,
180 /* No response data were available following a request. */
181 IEEE802154_NO_DATA = 0xeb,
182 /* The operation failed because a short address was not allocated. */
183 IEEE802154_NO_SHORT_ADDRESS = 0xec,
184 /*
185 * A receiver enable request was unsuccessful because it could not be
186 * completed within the CAP.
187 */
188 IEEE802154_OUT_OF_CAP = 0xed,
189 /*
190 * A PAN identifier conflict has been detected and communicated to the
191 * PAN coordinator.
192 */
193 IEEE802154_PANID_CONFLICT = 0xee,
194 /* A coordinator realignment command has been received. */
195 IEEE802154_REALIGMENT = 0xef,
196 /* The transaction has expired and its information discarded. */
197 IEEE802154_TRANSACTION_EXPIRED = 0xf0,
198 /* There is no capacity to store the transaction. */
199 IEEE802154_TRANSACTION_OVERFLOW = 0xf1,
200 /*
201 * The transceiver was in the transmitter enabled state when the
202 * receiver was requested to be enabled.
203 */
204 IEEE802154_TX_ACTIVE = 0xf2,
205 /* The appropriate key is not available in the ACL. */
206 IEEE802154_UNAVAILABLE_KEY = 0xf3,
207 /*
208 * A SET/GET request was issued with the identifier of a PIB attribute
209 * that is not supported.
210 */
211 IEEE802154_UNSUPPORTED_ATTR = 0xf4,
212 /*
213 * A request to perform a scan operation failed because the MLME was
214 * in the process of performing a previously initiated scan operation.
215 */
216 IEEE802154_SCAN_IN_PROGRESS = 0xfc,
217};
218
219/* frame control handling */
220#define IEEE802154_FCTL_FTYPE 0x0003
221#define IEEE802154_FCTL_ACKREQ 0x0020
222#define IEEE802154_FCTL_SECEN 0x0004
223#define IEEE802154_FCTL_INTRA_PAN 0x0040
224
225#define IEEE802154_FTYPE_DATA 0x0001
226
227/*
228 * ieee802154_is_data - check if type is IEEE802154_FTYPE_DATA
229 * @fc: frame control bytes in little-endian byteorder
230 */
231static inline int ieee802154_is_data(__le16 fc)
232{
233 return (fc & cpu_to_le16(IEEE802154_FCTL_FTYPE)) ==
234 cpu_to_le16(IEEE802154_FTYPE_DATA);
235}
236
237/**
238 * ieee802154_is_secen - check if Security bit is set
239 * @fc: frame control bytes in little-endian byteorder
240 */
241static inline bool ieee802154_is_secen(__le16 fc)
242{
243 return fc & cpu_to_le16(IEEE802154_FCTL_SECEN);
244}
245
246/**
247 * ieee802154_is_ackreq - check if acknowledgment request bit is set
248 * @fc: frame control bytes in little-endian byteorder
249 */
250static inline bool ieee802154_is_ackreq(__le16 fc)
251{
252 return fc & cpu_to_le16(IEEE802154_FCTL_ACKREQ);
253}
254
255/**
256 * ieee802154_is_intra_pan - check if intra pan id communication
257 * @fc: frame control bytes in little-endian byteorder
258 */
259static inline bool ieee802154_is_intra_pan(__le16 fc)
260{
261 return fc & cpu_to_le16(IEEE802154_FCTL_INTRA_PAN);
262}
263
264/**
265 * ieee802154_is_valid_psdu_len - check if psdu len is valid
266 * available lengths:
267 * 0-4 Reserved
268 * 5 MPDU (Acknowledgment)
269 * 6-8 Reserved
270 * 9-127 MPDU
271 *
272 * @len: psdu len with (MHR + payload + MFR)
273 */
274static inline bool ieee802154_is_valid_psdu_len(u8 len)
275{
276 return (len == IEEE802154_ACK_PSDU_LEN ||
277 (len >= IEEE802154_MIN_PSDU_LEN && len <= IEEE802154_MTU));
278}
279
280/**
281 * ieee802154_is_valid_extended_unicast_addr - check if extended addr is valid
282 * @addr: extended addr to check
283 */
284static inline bool ieee802154_is_valid_extended_unicast_addr(__le64 addr)
285{
286 /* Bail out if the address is all zero, or if the group
287 * address bit is set.
288 */
289 return ((addr != cpu_to_le64(0x0000000000000000ULL)) &&
290 !(addr & cpu_to_le64(0x0100000000000000ULL)));
291}
292
293/**
294 * ieee802154_is_broadcast_short_addr - check if short addr is broadcast
295 * @addr: short addr to check
296 */
297static inline bool ieee802154_is_broadcast_short_addr(__le16 addr)
298{
299 return (addr == cpu_to_le16(IEEE802154_ADDR_SHORT_BROADCAST));
300}
301
302/**
303 * ieee802154_is_unspec_short_addr - check if short addr is unspecified
304 * @addr: short addr to check
305 */
306static inline bool ieee802154_is_unspec_short_addr(__le16 addr)
307{
308 return (addr == cpu_to_le16(IEEE802154_ADDR_SHORT_UNSPEC));
309}
310
311/**
312 * ieee802154_is_valid_src_short_addr - check if source short address is valid
313 * @addr: short addr to check
314 */
315static inline bool ieee802154_is_valid_src_short_addr(__le16 addr)
316{
317 return !(ieee802154_is_broadcast_short_addr(addr) ||
318 ieee802154_is_unspec_short_addr(addr));
319}
320
321/**
322 * ieee802154_random_extended_addr - generates a random extended address
323 * @addr: extended addr pointer to place the random address
324 */
325static inline void ieee802154_random_extended_addr(__le64 *addr)
326{
327 get_random_bytes(addr, IEEE802154_EXTENDED_ADDR_LEN);
328
329 /* clear the group bit, and set the locally administered bit */
330 ((u8 *)addr)[IEEE802154_EXTENDED_ADDR_LEN - 1] &= ~0x01;
331 ((u8 *)addr)[IEEE802154_EXTENDED_ADDR_LEN - 1] |= 0x02;
332}
333
334#endif /* LINUX_IEEE802154_H */