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