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