include/linux/ieee802154.h

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