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 #define NL802154_GENL_NAME "nl802154"
  23
  24 enum nl802154_commands {
  25 /* don't change the order or add anything between, this is ABI! */
  26 /* currently we don't shipping this file via uapi, ignore the above one */
  27         NL802154_CMD_UNSPEC,
  28
  29         NL802154_CMD_GET_WPAN_PHY,              /* can dump */
  30         NL802154_CMD_SET_WPAN_PHY,
  31         NL802154_CMD_NEW_WPAN_PHY,
  32         NL802154_CMD_DEL_WPAN_PHY,
  33
  34         NL802154_CMD_GET_INTERFACE,             /* can dump */
  35         NL802154_CMD_SET_INTERFACE,
  36         NL802154_CMD_NEW_INTERFACE,
  37         NL802154_CMD_DEL_INTERFACE,
  38
  39         NL802154_CMD_SET_CHANNEL,
  40
  41         NL802154_CMD_SET_PAN_ID,
  42         NL802154_CMD_SET_SHORT_ADDR,
  43
  44         NL802154_CMD_SET_TX_POWER,
  45         NL802154_CMD_SET_CCA_MODE,
  46         NL802154_CMD_SET_CCA_ED_LEVEL,
  47
  48         NL802154_CMD_SET_MAX_FRAME_RETRIES,
  49
  50         NL802154_CMD_SET_BACKOFF_EXPONENT,
  51         NL802154_CMD_SET_MAX_CSMA_BACKOFFS,
  52
  53         NL802154_CMD_SET_LBT_MODE,
  54
  55         /* add new commands above here */
  56
  57         /* used to define NL802154_CMD_MAX below */
  58         __NL802154_CMD_AFTER_LAST,
  59         NL802154_CMD_MAX = __NL802154_CMD_AFTER_LAST - 1
  60 };
  61
  62 enum nl802154_attrs {
  63 /* don't change the order or add anything between, this is ABI! */
  64 /* currently we don't shipping this file via uapi, ignore the above one */
  65         NL802154_ATTR_UNSPEC,
  66
  67         NL802154_ATTR_WPAN_PHY,
  68         NL802154_ATTR_WPAN_PHY_NAME,
  69
  70         NL802154_ATTR_IFINDEX,
  71         NL802154_ATTR_IFNAME,
  72         NL802154_ATTR_IFTYPE,
  73
  74         NL802154_ATTR_WPAN_DEV,
  75
  76         NL802154_ATTR_PAGE,
  77         NL802154_ATTR_CHANNEL,
  78
  79         NL802154_ATTR_PAN_ID,
  80         NL802154_ATTR_SHORT_ADDR,
  81
  82         NL802154_ATTR_TX_POWER,
  83
  84         NL802154_ATTR_CCA_MODE,
  85         NL802154_ATTR_CCA_OPT,
  86         NL802154_ATTR_CCA_ED_LEVEL,
  87
  88         NL802154_ATTR_MAX_FRAME_RETRIES,
  89
  90         NL802154_ATTR_MAX_BE,
  91         NL802154_ATTR_MIN_BE,
  92         NL802154_ATTR_MAX_CSMA_BACKOFFS,
  93
  94         NL802154_ATTR_LBT_MODE,
  95
  96         NL802154_ATTR_GENERATION,
  97
  98         NL802154_ATTR_CHANNELS_SUPPORTED,
  99         NL802154_ATTR_SUPPORTED_CHANNEL,
 100
 101         NL802154_ATTR_EXTENDED_ADDR,
 102
 103         NL802154_ATTR_WPAN_PHY_CAPS,
 104
 105         /* add attributes here, update the policy in nl802154.c */
 106
 107         __NL802154_ATTR_AFTER_LAST,
 108         NL802154_ATTR_MAX = __NL802154_ATTR_AFTER_LAST - 1
 109 };
 110
 111 enum nl802154_iftype {
 112         /* for backwards compatibility TODO */
 113         NL802154_IFTYPE_UNSPEC = -1,
 114
 115         NL802154_IFTYPE_NODE,
 116         NL802154_IFTYPE_MONITOR,
 117         NL802154_IFTYPE_COORD,
 118
 119         /* keep last */
 120         NUM_NL802154_IFTYPES,
 121         NL802154_IFTYPE_MAX = NUM_NL802154_IFTYPES - 1
 122 };
 123
 124 /**
 125  * enum nl802154_wpan_phy_capability_attr - wpan phy capability attributes
 126  *
 127  * @__NL802154_CAP_ATTR_INVALID: attribute number 0 is reserved
 128  * @NL802154_CAP_ATTR_CHANNELS: a nested attribute for nl802154_channel_attr
 129  * @NL802154_CAP_ATTR_TX_POWERS: a nested attribute for
 130  *      nl802154_wpan_phy_tx_power
 131  * @NL802154_CAP_ATTR_MIN_CCA_ED_LEVEL: minimum value for cca_ed_level
 132  * @NL802154_CAP_ATTR_MAX_CCA_ED_LEVEL: maxmimum value for cca_ed_level
 133  * @NL802154_CAP_ATTR_CCA_MODES: nl802154_cca_modes flags
 134  * @NL802154_CAP_ATTR_CCA_OPTS: nl802154_cca_opts flags
 135  * @NL802154_CAP_ATTR_MIN_MINBE: minimum of minbe value
 136  * @NL802154_CAP_ATTR_MAX_MINBE: maximum of minbe value
 137  * @NL802154_CAP_ATTR_MIN_MAXBE: minimum of maxbe value
 138  * @NL802154_CAP_ATTR_MAX_MINBE: maximum of maxbe value
 139  * @NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS: minimum of csma backoff value
 140  * @NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS: maximum of csma backoffs value
 141  * @NL802154_CAP_ATTR_MIN_FRAME_RETRIES: minimum of frame retries value
 142  * @NL802154_CAP_ATTR_MAX_FRAME_RETRIES: maximum of frame retries value
 143  * @NL802154_CAP_ATTR_IFTYPES: nl802154_iftype flags
 144  * @NL802154_CAP_ATTR_LBT: nl802154_supported_bool_states flags
 145  * @NL802154_CAP_ATTR_MAX: highest cap attribute currently defined
 146  * @__NL802154_CAP_ATTR_AFTER_LAST: internal use
 147  */
 148 enum nl802154_wpan_phy_capability_attr {
 149         __NL802154_CAP_ATTR_INVALID,
 150
 151         NL802154_CAP_ATTR_IFTYPES,
 152
 153         NL802154_CAP_ATTR_CHANNELS,
 154         NL802154_CAP_ATTR_TX_POWERS,
 155
 156         NL802154_CAP_ATTR_CCA_ED_LEVELS,
 157         NL802154_CAP_ATTR_CCA_MODES,
 158         NL802154_CAP_ATTR_CCA_OPTS,
 159
 160         NL802154_CAP_ATTR_MIN_MINBE,
 161         NL802154_CAP_ATTR_MAX_MINBE,
 162
 163         NL802154_CAP_ATTR_MIN_MAXBE,
 164         NL802154_CAP_ATTR_MAX_MAXBE,
 165
 166         NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS,
 167         NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS,
 168
 169         NL802154_CAP_ATTR_MIN_FRAME_RETRIES,
 170         NL802154_CAP_ATTR_MAX_FRAME_RETRIES,
 171
 172         NL802154_CAP_ATTR_LBT,
 173
 174         /* keep last */
 175         __NL802154_CAP_ATTR_AFTER_LAST,
 176         NL802154_CAP_ATTR_MAX = __NL802154_CAP_ATTR_AFTER_LAST - 1
 177 };
 178
 179 /**
 180  * enum nl802154_cca_modes - cca modes
 181  *
 182  * @__NL802154_CCA_INVALID: cca mode number 0 is reserved
 183  * @NL802154_CCA_ENERGY: Energy above threshold
 184  * @NL802154_CCA_CARRIER: Carrier sense only
 185  * @NL802154_CCA_ENERGY_CARRIER: Carrier sense with energy above threshold
 186  * @NL802154_CCA_ALOHA: CCA shall always report an idle medium
 187  * @NL802154_CCA_UWB_SHR: UWB preamble sense based on the SHR of a frame
 188  * @NL802154_CCA_UWB_MULTIPEXED: UWB preamble sense based on the packet with
 189  *      the multiplexed preamble
 190  * @__NL802154_CCA_ATTR_AFTER_LAST: Internal
 191  * @NL802154_CCA_ATTR_MAX: Maximum CCA attribute number
 192  */
 193 enum nl802154_cca_modes {
 194         __NL802154_CCA_INVALID,
 195         NL802154_CCA_ENERGY,
 196         NL802154_CCA_CARRIER,
 197         NL802154_CCA_ENERGY_CARRIER,
 198         NL802154_CCA_ALOHA,
 199         NL802154_CCA_UWB_SHR,
 200         NL802154_CCA_UWB_MULTIPEXED,
 201
 202         /* keep last */
 203         __NL802154_CCA_ATTR_AFTER_LAST,
 204         NL802154_CCA_ATTR_MAX = __NL802154_CCA_ATTR_AFTER_LAST - 1
 205 };
 206
 207 /**
 208  * enum nl802154_cca_opts - additional options for cca modes
 209  *
 210  * @NL802154_CCA_OPT_ENERGY_CARRIER_OR: NL802154_CCA_ENERGY_CARRIER with OR
 211  * @NL802154_CCA_OPT_ENERGY_CARRIER_AND: NL802154_CCA_ENERGY_CARRIER with AND
 212  */
 213 enum nl802154_cca_opts {
 214         NL802154_CCA_OPT_ENERGY_CARRIER_AND,
 215         NL802154_CCA_OPT_ENERGY_CARRIER_OR,
 216
 217         /* keep last */
 218         __NL802154_CCA_OPT_ATTR_AFTER_LAST,
 219         NL802154_CCA_OPT_ATTR_MAX = __NL802154_CCA_OPT_ATTR_AFTER_LAST - 1
 220 };
 221
 222 /**
 223  * enum nl802154_supported_bool_states - bool states for bool capability entry
 224  *
 225  * @NL802154_SUPPORTED_BOOL_FALSE: indicates to set false
 226  * @NL802154_SUPPORTED_BOOL_TRUE: indicates to set true
 227  * @__NL802154_SUPPORTED_BOOL_INVALD: reserved
 228  * @NL802154_SUPPORTED_BOOL_BOTH: indicates to set true and false
 229  * @__NL802154_SUPPORTED_BOOL_AFTER_LAST: Internal
 230  * @NL802154_SUPPORTED_BOOL_MAX: highest value for bool states
 231  */
 232 enum nl802154_supported_bool_states {
 233         NL802154_SUPPORTED_BOOL_FALSE,
 234         NL802154_SUPPORTED_BOOL_TRUE,
 235         /* to handle them in a mask */
 236         __NL802154_SUPPORTED_BOOL_INVALD,
 237         NL802154_SUPPORTED_BOOL_BOTH,
 238
 239         /* keep last */
 240         __NL802154_SUPPORTED_BOOL_AFTER_LAST,
 241         NL802154_SUPPORTED_BOOL_MAX = __NL802154_SUPPORTED_BOOL_AFTER_LAST - 1
 242 };
 243
 244 #endif /* __NL802154_H */