include/net/nl802154.h

   1 #ifndef __NL802154_H
   2 #define __NL802154_H
   3 /*
   4  * 802.15.4 netlink interface public header
   5  *
   6  * Copyright 2014 Alexander Aring <aar@pengutronix.de>
   7  *
   8  * Permission to use, copy, modify, and/or distribute this software for any
   9  * purpose with or without fee is hereby granted, provided that the above
  10  * copyright notice and this permission notice appear in all copies.
  11  *
  12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  19  *
  20  */
  21
  22 #include <linux/types.h>
  23
  24 #define NL802154_GENL_NAME "nl802154"
  25
  26 enum nl802154_commands {
  27 /* don't change the order or add anything between, this is ABI! */
  28 /* currently we don't shipping this file via uapi, ignore the above one */
  29         NL802154_CMD_UNSPEC,
  30
  31         NL802154_CMD_GET_WPAN_PHY,              /* can dump */
  32         NL802154_CMD_SET_WPAN_PHY,
  33         NL802154_CMD_NEW_WPAN_PHY,
  34         NL802154_CMD_DEL_WPAN_PHY,
  35
  36         NL802154_CMD_GET_INTERFACE,             /* can dump */
  37         NL802154_CMD_SET_INTERFACE,
  38         NL802154_CMD_NEW_INTERFACE,
  39         NL802154_CMD_DEL_INTERFACE,
  40
  41         NL802154_CMD_SET_CHANNEL,
  42
  43         NL802154_CMD_SET_PAN_ID,
  44         NL802154_CMD_SET_SHORT_ADDR,
  45
  46         NL802154_CMD_SET_TX_POWER,
  47         NL802154_CMD_SET_CCA_MODE,
  48         NL802154_CMD_SET_CCA_ED_LEVEL,
  49
  50         NL802154_CMD_SET_MAX_FRAME_RETRIES,
  51
  52         NL802154_CMD_SET_BACKOFF_EXPONENT,
  53         NL802154_CMD_SET_MAX_CSMA_BACKOFFS,
  54
  55         NL802154_CMD_SET_LBT_MODE,
  56
  57         NL802154_CMD_SET_ACKREQ_DEFAULT,
  58
  59         /* add new commands above here */
  60
  61 #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
  62         NL802154_CMD_SET_SEC_PARAMS,
  63         NL802154_CMD_GET_SEC_KEY,               /* can dump */
  64         NL802154_CMD_NEW_SEC_KEY,
  65         NL802154_CMD_DEL_SEC_KEY,
  66         NL802154_CMD_GET_SEC_DEV,               /* can dump */
  67         NL802154_CMD_NEW_SEC_DEV,
  68         NL802154_CMD_DEL_SEC_DEV,
  69         NL802154_CMD_GET_SEC_DEVKEY,            /* can dump */
  70         NL802154_CMD_NEW_SEC_DEVKEY,
  71         NL802154_CMD_DEL_SEC_DEVKEY,
  72         NL802154_CMD_GET_SEC_LEVEL,             /* can dump */
  73         NL802154_CMD_NEW_SEC_LEVEL,
  74         NL802154_CMD_DEL_SEC_LEVEL,
  75 #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
  76
  77         /* used to define NL802154_CMD_MAX below */
  78         __NL802154_CMD_AFTER_LAST,
  79         NL802154_CMD_MAX = __NL802154_CMD_AFTER_LAST - 1
  80 };
  81
  82 enum nl802154_attrs {
  83 /* don't change the order or add anything between, this is ABI! */
  84 /* currently we don't shipping this file via uapi, ignore the above one */
  85         NL802154_ATTR_UNSPEC,
  86
  87         NL802154_ATTR_WPAN_PHY,
  88         NL802154_ATTR_WPAN_PHY_NAME,
  89
  90         NL802154_ATTR_IFINDEX,
  91         NL802154_ATTR_IFNAME,
  92         NL802154_ATTR_IFTYPE,
  93
  94         NL802154_ATTR_WPAN_DEV,
  95
  96         NL802154_ATTR_PAGE,
  97         NL802154_ATTR_CHANNEL,
  98
  99         NL802154_ATTR_PAN_ID,
 100         NL802154_ATTR_SHORT_ADDR,
 101
 102         NL802154_ATTR_TX_POWER,
 103
 104         NL802154_ATTR_CCA_MODE,
 105         NL802154_ATTR_CCA_OPT,
 106         NL802154_ATTR_CCA_ED_LEVEL,
 107
 108         NL802154_ATTR_MAX_FRAME_RETRIES,
 109
 110         NL802154_ATTR_MAX_BE,
 111         NL802154_ATTR_MIN_BE,
 112         NL802154_ATTR_MAX_CSMA_BACKOFFS,
 113
 114         NL802154_ATTR_LBT_MODE,
 115
 116         NL802154_ATTR_GENERATION,
 117
 118         NL802154_ATTR_CHANNELS_SUPPORTED,
 119         NL802154_ATTR_SUPPORTED_CHANNEL,
 120
 121         NL802154_ATTR_EXTENDED_ADDR,
 122
 123         NL802154_ATTR_WPAN_PHY_CAPS,
 124
 125         NL802154_ATTR_SUPPORTED_COMMANDS,
 126
 127         NL802154_ATTR_ACKREQ_DEFAULT,
 128
 129         /* add attributes here, update the policy in nl802154.c */
 130
 131 #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
 132         NL802154_ATTR_SEC_ENABLED,
 133         NL802154_ATTR_SEC_OUT_LEVEL,
 134         NL802154_ATTR_SEC_OUT_KEY_ID,
 135         NL802154_ATTR_SEC_FRAME_COUNTER,
 136
 137         NL802154_ATTR_SEC_LEVEL,
 138         NL802154_ATTR_SEC_DEVICE,
 139         NL802154_ATTR_SEC_DEVKEY,
 140         NL802154_ATTR_SEC_KEY,
 141 #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
 142
 143         __NL802154_ATTR_AFTER_LAST,
 144         NL802154_ATTR_MAX = __NL802154_ATTR_AFTER_LAST - 1
 145 };
 146
 147 enum nl802154_iftype {
 148         NL802154_IFTYPE_UNSPEC = (~(__u32)0),
 149
 150         NL802154_IFTYPE_NODE = 0,
 151         NL802154_IFTYPE_MONITOR,
 152         NL802154_IFTYPE_COORD,
 153
 154         /* keep last */
 155         NUM_NL802154_IFTYPES,
 156         NL802154_IFTYPE_MAX = NUM_NL802154_IFTYPES - 1
 157 };
 158
 159 /**
 160  * enum nl802154_wpan_phy_capability_attr - wpan phy capability attributes
 161  *
 162  * @__NL802154_CAP_ATTR_INVALID: attribute number 0 is reserved
 163  * @NL802154_CAP_ATTR_CHANNELS: a nested attribute for nl802154_channel_attr
 164  * @NL802154_CAP_ATTR_TX_POWERS: a nested attribute for
 165  *      nl802154_wpan_phy_tx_power
 166  * @NL802154_CAP_ATTR_MIN_CCA_ED_LEVEL: minimum value for cca_ed_level
 167  * @NL802154_CAP_ATTR_MAX_CCA_ED_LEVEL: maxmimum value for cca_ed_level
 168  * @NL802154_CAP_ATTR_CCA_MODES: nl802154_cca_modes flags
 169  * @NL802154_CAP_ATTR_CCA_OPTS: nl802154_cca_opts flags
 170  * @NL802154_CAP_ATTR_MIN_MINBE: minimum of minbe value
 171  * @NL802154_CAP_ATTR_MAX_MINBE: maximum of minbe value
 172  * @NL802154_CAP_ATTR_MIN_MAXBE: minimum of maxbe value
 173  * @NL802154_CAP_ATTR_MAX_MINBE: maximum of maxbe value
 174  * @NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS: minimum of csma backoff value
 175  * @NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS: maximum of csma backoffs value
 176  * @NL802154_CAP_ATTR_MIN_FRAME_RETRIES: minimum of frame retries value
 177  * @NL802154_CAP_ATTR_MAX_FRAME_RETRIES: maximum of frame retries value
 178  * @NL802154_CAP_ATTR_IFTYPES: nl802154_iftype flags
 179  * @NL802154_CAP_ATTR_LBT: nl802154_supported_bool_states flags
 180  * @NL802154_CAP_ATTR_MAX: highest cap attribute currently defined
 181  * @__NL802154_CAP_ATTR_AFTER_LAST: internal use
 182  */
 183 enum nl802154_wpan_phy_capability_attr {
 184         __NL802154_CAP_ATTR_INVALID,
 185
 186         NL802154_CAP_ATTR_IFTYPES,
 187
 188         NL802154_CAP_ATTR_CHANNELS,
 189         NL802154_CAP_ATTR_TX_POWERS,
 190
 191         NL802154_CAP_ATTR_CCA_ED_LEVELS,
 192         NL802154_CAP_ATTR_CCA_MODES,
 193         NL802154_CAP_ATTR_CCA_OPTS,
 194
 195         NL802154_CAP_ATTR_MIN_MINBE,
 196         NL802154_CAP_ATTR_MAX_MINBE,
 197
 198         NL802154_CAP_ATTR_MIN_MAXBE,
 199         NL802154_CAP_ATTR_MAX_MAXBE,
 200
 201         NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS,
 202         NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS,
 203
 204         NL802154_CAP_ATTR_MIN_FRAME_RETRIES,
 205         NL802154_CAP_ATTR_MAX_FRAME_RETRIES,
 206
 207         NL802154_CAP_ATTR_LBT,
 208
 209         /* keep last */
 210         __NL802154_CAP_ATTR_AFTER_LAST,
 211         NL802154_CAP_ATTR_MAX = __NL802154_CAP_ATTR_AFTER_LAST - 1
 212 };
 213
 214 /**
 215  * enum nl802154_cca_modes - cca modes
 216  *
 217  * @__NL802154_CCA_INVALID: cca mode number 0 is reserved
 218  * @NL802154_CCA_ENERGY: Energy above threshold
 219  * @NL802154_CCA_CARRIER: Carrier sense only
 220  * @NL802154_CCA_ENERGY_CARRIER: Carrier sense with energy above threshold
 221  * @NL802154_CCA_ALOHA: CCA shall always report an idle medium
 222  * @NL802154_CCA_UWB_SHR: UWB preamble sense based on the SHR of a frame
 223  * @NL802154_CCA_UWB_MULTIPLEXED: UWB preamble sense based on the packet with
 224  *      the multiplexed preamble
 225  * @__NL802154_CCA_ATTR_AFTER_LAST: Internal
 226  * @NL802154_CCA_ATTR_MAX: Maximum CCA attribute number
 227  */
 228 enum nl802154_cca_modes {
 229         __NL802154_CCA_INVALID,
 230         NL802154_CCA_ENERGY,
 231         NL802154_CCA_CARRIER,
 232         NL802154_CCA_ENERGY_CARRIER,
 233         NL802154_CCA_ALOHA,
 234         NL802154_CCA_UWB_SHR,
 235         NL802154_CCA_UWB_MULTIPLEXED,
 236
 237         /* keep last */
 238         __NL802154_CCA_ATTR_AFTER_LAST,
 239         NL802154_CCA_ATTR_MAX = __NL802154_CCA_ATTR_AFTER_LAST - 1
 240 };
 241
 242 /**
 243  * enum nl802154_cca_opts - additional options for cca modes
 244  *
 245  * @NL802154_CCA_OPT_ENERGY_CARRIER_OR: NL802154_CCA_ENERGY_CARRIER with OR
 246  * @NL802154_CCA_OPT_ENERGY_CARRIER_AND: NL802154_CCA_ENERGY_CARRIER with AND
 247  */
 248 enum nl802154_cca_opts {
 249         NL802154_CCA_OPT_ENERGY_CARRIER_AND,
 250         NL802154_CCA_OPT_ENERGY_CARRIER_OR,
 251
 252         /* keep last */
 253         __NL802154_CCA_OPT_ATTR_AFTER_LAST,
 254         NL802154_CCA_OPT_ATTR_MAX = __NL802154_CCA_OPT_ATTR_AFTER_LAST - 1
 255 };
 256
 257 /**
 258  * enum nl802154_supported_bool_states - bool states for bool capability entry
 259  *
 260  * @NL802154_SUPPORTED_BOOL_FALSE: indicates to set false
 261  * @NL802154_SUPPORTED_BOOL_TRUE: indicates to set true
 262  * @__NL802154_SUPPORTED_BOOL_INVALD: reserved
 263  * @NL802154_SUPPORTED_BOOL_BOTH: indicates to set true and false
 264  * @__NL802154_SUPPORTED_BOOL_AFTER_LAST: Internal
 265  * @NL802154_SUPPORTED_BOOL_MAX: highest value for bool states
 266  */
 267 enum nl802154_supported_bool_states {
 268         NL802154_SUPPORTED_BOOL_FALSE,
 269         NL802154_SUPPORTED_BOOL_TRUE,
 270         /* to handle them in a mask */
 271         __NL802154_SUPPORTED_BOOL_INVALD,
 272         NL802154_SUPPORTED_BOOL_BOTH,
 273
 274         /* keep last */
 275         __NL802154_SUPPORTED_BOOL_AFTER_LAST,
 276         NL802154_SUPPORTED_BOOL_MAX = __NL802154_SUPPORTED_BOOL_AFTER_LAST - 1
 277 };
 278
 279 #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
 280
 281 enum nl802154_dev_addr_modes {
 282         NL802154_DEV_ADDR_NONE,
 283         __NL802154_DEV_ADDR_INVALID,
 284         NL802154_DEV_ADDR_SHORT,
 285         NL802154_DEV_ADDR_EXTENDED,
 286
 287         /* keep last */
 288         __NL802154_DEV_ADDR_AFTER_LAST,
 289         NL802154_DEV_ADDR_MAX = __NL802154_DEV_ADDR_AFTER_LAST - 1
 290 };
 291
 292 enum nl802154_dev_addr_attrs {
 293         NL802154_DEV_ADDR_ATTR_UNSPEC,
 294
 295         NL802154_DEV_ADDR_ATTR_PAN_ID,
 296         NL802154_DEV_ADDR_ATTR_MODE,
 297         NL802154_DEV_ADDR_ATTR_SHORT,
 298         NL802154_DEV_ADDR_ATTR_EXTENDED,
 299
 300         /* keep last */
 301         __NL802154_DEV_ADDR_ATTR_AFTER_LAST,
 302         NL802154_DEV_ADDR_ATTR_MAX = __NL802154_DEV_ADDR_ATTR_AFTER_LAST - 1
 303 };
 304
 305 enum nl802154_key_id_modes {
 306         NL802154_KEY_ID_MODE_IMPLICIT,
 307         NL802154_KEY_ID_MODE_INDEX,
 308         NL802154_KEY_ID_MODE_INDEX_SHORT,
 309         NL802154_KEY_ID_MODE_INDEX_EXTENDED,
 310
 311         /* keep last */
 312         __NL802154_KEY_ID_MODE_AFTER_LAST,
 313         NL802154_KEY_ID_MODE_MAX = __NL802154_KEY_ID_MODE_AFTER_LAST - 1
 314 };
 315
 316 enum nl802154_key_id_attrs {
 317         NL802154_KEY_ID_ATTR_UNSPEC,
 318
 319         NL802154_KEY_ID_ATTR_MODE,
 320         NL802154_KEY_ID_ATTR_INDEX,
 321         NL802154_KEY_ID_ATTR_IMPLICIT,
 322         NL802154_KEY_ID_ATTR_SOURCE_SHORT,
 323         NL802154_KEY_ID_ATTR_SOURCE_EXTENDED,
 324
 325         /* keep last */
 326         __NL802154_KEY_ID_ATTR_AFTER_LAST,
 327         NL802154_KEY_ID_ATTR_MAX = __NL802154_KEY_ID_ATTR_AFTER_LAST - 1
 328 };
 329
 330 enum nl802154_seclevels {
 331         NL802154_SECLEVEL_NONE,
 332         NL802154_SECLEVEL_MIC32,
 333         NL802154_SECLEVEL_MIC64,
 334         NL802154_SECLEVEL_MIC128,
 335         NL802154_SECLEVEL_ENC,
 336         NL802154_SECLEVEL_ENC_MIC32,
 337         NL802154_SECLEVEL_ENC_MIC64,
 338         NL802154_SECLEVEL_ENC_MIC128,
 339
 340         /* keep last */
 341         __NL802154_SECLEVEL_AFTER_LAST,
 342         NL802154_SECLEVEL_MAX = __NL802154_SECLEVEL_AFTER_LAST - 1
 343 };
 344
 345 enum nl802154_frames {
 346         NL802154_FRAME_BEACON,
 347         NL802154_FRAME_DATA,
 348         NL802154_FRAME_ACK,
 349         NL802154_FRAME_CMD,
 350
 351         /* keep last */
 352         __NL802154_FRAME_AFTER_LAST,
 353         NL802154_FRAME_MAX = __NL802154_FRAME_AFTER_LAST - 1
 354 };
 355
 356 enum nl802154_cmd_frames {
 357         __NL802154_CMD_FRAME_INVALID,
 358         NL802154_CMD_FRAME_ASSOC_REQUEST,
 359         NL802154_CMD_FRAME_ASSOC_RESPONSE,
 360         NL802154_CMD_FRAME_DISASSOC_NOTIFY,
 361         NL802154_CMD_FRAME_DATA_REQUEST,
 362         NL802154_CMD_FRAME_PAN_ID_CONFLICT_NOTIFY,
 363         NL802154_CMD_FRAME_ORPHAN_NOTIFY,
 364         NL802154_CMD_FRAME_BEACON_REQUEST,
 365         NL802154_CMD_FRAME_COORD_REALIGNMENT,
 366         NL802154_CMD_FRAME_GTS_REQUEST,
 367
 368         /* keep last */
 369         __NL802154_CMD_FRAME_AFTER_LAST,
 370         NL802154_CMD_FRAME_MAX = __NL802154_CMD_FRAME_AFTER_LAST - 1
 371 };
 372
 373 enum nl802154_seclevel_attrs {
 374         NL802154_SECLEVEL_ATTR_UNSPEC,
 375
 376         NL802154_SECLEVEL_ATTR_LEVELS,
 377         NL802154_SECLEVEL_ATTR_FRAME,
 378         NL802154_SECLEVEL_ATTR_CMD_FRAME,
 379         NL802154_SECLEVEL_ATTR_DEV_OVERRIDE,
 380
 381         /* keep last */
 382         __NL802154_SECLEVEL_ATTR_AFTER_LAST,
 383         NL802154_SECLEVEL_ATTR_MAX = __NL802154_SECLEVEL_ATTR_AFTER_LAST - 1
 384 };
 385
 386 /* TODO what is this? couldn't find in mib */
 387 enum {
 388         NL802154_DEVKEY_IGNORE,
 389         NL802154_DEVKEY_RESTRICT,
 390         NL802154_DEVKEY_RECORD,
 391
 392         /* keep last */
 393         __NL802154_DEVKEY_AFTER_LAST,
 394         NL802154_DEVKEY_MAX = __NL802154_DEVKEY_AFTER_LAST - 1
 395 };
 396
 397 enum nl802154_dev {
 398         NL802154_DEV_ATTR_UNSPEC,
 399
 400         NL802154_DEV_ATTR_FRAME_COUNTER,
 401         NL802154_DEV_ATTR_PAN_ID,
 402         NL802154_DEV_ATTR_SHORT_ADDR,
 403         NL802154_DEV_ATTR_EXTENDED_ADDR,
 404         NL802154_DEV_ATTR_SECLEVEL_EXEMPT,
 405         NL802154_DEV_ATTR_KEY_MODE,
 406
 407         /* keep last */
 408         __NL802154_DEV_ATTR_AFTER_LAST,
 409         NL802154_DEV_ATTR_MAX = __NL802154_DEV_ATTR_AFTER_LAST - 1
 410 };
 411
 412 enum nl802154_devkey {
 413         NL802154_DEVKEY_ATTR_UNSPEC,
 414
 415         NL802154_DEVKEY_ATTR_FRAME_COUNTER,
 416         NL802154_DEVKEY_ATTR_EXTENDED_ADDR,
 417         NL802154_DEVKEY_ATTR_ID,
 418
 419         /* keep last */
 420         __NL802154_DEVKEY_ATTR_AFTER_LAST,
 421         NL802154_DEVKEY_ATTR_MAX = __NL802154_DEVKEY_ATTR_AFTER_LAST - 1
 422 };
 423
 424 enum nl802154_key {
 425         NL802154_KEY_ATTR_UNSPEC,
 426
 427         NL802154_KEY_ATTR_ID,
 428         NL802154_KEY_ATTR_USAGE_FRAMES,
 429         NL802154_KEY_ATTR_USAGE_CMDS,
 430         NL802154_KEY_ATTR_BYTES,
 431
 432         /* keep last */
 433         __NL802154_KEY_ATTR_AFTER_LAST,
 434         NL802154_KEY_ATTR_MAX = __NL802154_KEY_ATTR_AFTER_LAST - 1
 435 };
 436
 437 #define NL802154_KEY_SIZE               16
 438 #define NL802154_CMD_FRAME_NR_IDS       256
 439
 440 #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
 441
 442 #endif /* __NL802154_H */