[mirror_ubuntu-bionic-kernel.git] / include / net / nl802154.h

#ifndef __NL802154_H
#define __NL802154_H
/*
 * 802.15.4 netlink interface public header
 *
 * Copyright 2014 Alexander Aring <aar@pengutronix.de>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 */

#define NL802154_GENL_NAME "nl802154"

enum nl802154_commands {
/* don't change the order or add anything between, this is ABI! */
/* currently we don't shipping this file via uapi, ignore the above one */
	NL802154_CMD_UNSPEC,

	NL802154_CMD_GET_WPAN_PHY,		/* can dump */
	NL802154_CMD_SET_WPAN_PHY,
	NL802154_CMD_NEW_WPAN_PHY,
	NL802154_CMD_DEL_WPAN_PHY,

	NL802154_CMD_GET_INTERFACE,		/* can dump */
	NL802154_CMD_SET_INTERFACE,
	NL802154_CMD_NEW_INTERFACE,
	NL802154_CMD_DEL_INTERFACE,

	NL802154_CMD_SET_CHANNEL,

	NL802154_CMD_SET_PAN_ID,
	NL802154_CMD_SET_SHORT_ADDR,

	NL802154_CMD_SET_TX_POWER,
	NL802154_CMD_SET_CCA_MODE,
	NL802154_CMD_SET_CCA_ED_LEVEL,

	NL802154_CMD_SET_MAX_FRAME_RETRIES,

	NL802154_CMD_SET_BACKOFF_EXPONENT,
	NL802154_CMD_SET_MAX_CSMA_BACKOFFS,

	NL802154_CMD_SET_LBT_MODE,

	/* add new commands above here */

	/* used to define NL802154_CMD_MAX below */
	__NL802154_CMD_AFTER_LAST,
	NL802154_CMD_MAX = __NL802154_CMD_AFTER_LAST - 1
};

enum nl802154_attrs {
/* don't change the order or add anything between, this is ABI! */
/* currently we don't shipping this file via uapi, ignore the above one */
	NL802154_ATTR_UNSPEC,

	NL802154_ATTR_WPAN_PHY,
	NL802154_ATTR_WPAN_PHY_NAME,

	NL802154_ATTR_IFINDEX,
	NL802154_ATTR_IFNAME,
	NL802154_ATTR_IFTYPE,

	NL802154_ATTR_WPAN_DEV,

	NL802154_ATTR_PAGE,
	NL802154_ATTR_CHANNEL,

	NL802154_ATTR_PAN_ID,
	NL802154_ATTR_SHORT_ADDR,

	NL802154_ATTR_TX_POWER,

	NL802154_ATTR_CCA_MODE,
	NL802154_ATTR_CCA_OPT,
	NL802154_ATTR_CCA_ED_LEVEL,

	NL802154_ATTR_MAX_FRAME_RETRIES,

	NL802154_ATTR_MAX_BE,
	NL802154_ATTR_MIN_BE,
	NL802154_ATTR_MAX_CSMA_BACKOFFS,

	NL802154_ATTR_LBT_MODE,

	NL802154_ATTR_GENERATION,

	NL802154_ATTR_CHANNELS_SUPPORTED,
	NL802154_ATTR_SUPPORTED_CHANNEL,

	NL802154_ATTR_EXTENDED_ADDR,

	NL802154_ATTR_WPAN_PHY_CAPS,

	NL802154_ATTR_SUPPORTED_COMMANDS,

	/* add attributes here, update the policy in nl802154.c */

	__NL802154_ATTR_AFTER_LAST,
	NL802154_ATTR_MAX = __NL802154_ATTR_AFTER_LAST - 1
};

enum nl802154_iftype {
	/* for backwards compatibility TODO */
	NL802154_IFTYPE_UNSPEC = -1,

	NL802154_IFTYPE_NODE,
	NL802154_IFTYPE_MONITOR,
	NL802154_IFTYPE_COORD,

	/* keep last */
	NUM_NL802154_IFTYPES,
	NL802154_IFTYPE_MAX = NUM_NL802154_IFTYPES - 1
};

/**
 * enum nl802154_wpan_phy_capability_attr - wpan phy capability attributes
 *
 * @__NL802154_CAP_ATTR_INVALID: attribute number 0 is reserved
 * @NL802154_CAP_ATTR_CHANNELS: a nested attribute for nl802154_channel_attr
 * @NL802154_CAP_ATTR_TX_POWERS: a nested attribute for
 *	nl802154_wpan_phy_tx_power
 * @NL802154_CAP_ATTR_MIN_CCA_ED_LEVEL: minimum value for cca_ed_level
 * @NL802154_CAP_ATTR_MAX_CCA_ED_LEVEL: maxmimum value for cca_ed_level
 * @NL802154_CAP_ATTR_CCA_MODES: nl802154_cca_modes flags
 * @NL802154_CAP_ATTR_CCA_OPTS: nl802154_cca_opts flags
 * @NL802154_CAP_ATTR_MIN_MINBE: minimum of minbe value
 * @NL802154_CAP_ATTR_MAX_MINBE: maximum of minbe value
 * @NL802154_CAP_ATTR_MIN_MAXBE: minimum of maxbe value
 * @NL802154_CAP_ATTR_MAX_MINBE: maximum of maxbe value
 * @NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS: minimum of csma backoff value
 * @NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS: maximum of csma backoffs value
 * @NL802154_CAP_ATTR_MIN_FRAME_RETRIES: minimum of frame retries value
 * @NL802154_CAP_ATTR_MAX_FRAME_RETRIES: maximum of frame retries value
 * @NL802154_CAP_ATTR_IFTYPES: nl802154_iftype flags
 * @NL802154_CAP_ATTR_LBT: nl802154_supported_bool_states flags
 * @NL802154_CAP_ATTR_MAX: highest cap attribute currently defined
 * @__NL802154_CAP_ATTR_AFTER_LAST: internal use
 */
enum nl802154_wpan_phy_capability_attr {
	__NL802154_CAP_ATTR_INVALID,

	NL802154_CAP_ATTR_IFTYPES,

	NL802154_CAP_ATTR_CHANNELS,
	NL802154_CAP_ATTR_TX_POWERS,

	NL802154_CAP_ATTR_CCA_ED_LEVELS,
	NL802154_CAP_ATTR_CCA_MODES,
	NL802154_CAP_ATTR_CCA_OPTS,

	NL802154_CAP_ATTR_MIN_MINBE,
	NL802154_CAP_ATTR_MAX_MINBE,

	NL802154_CAP_ATTR_MIN_MAXBE,
	NL802154_CAP_ATTR_MAX_MAXBE,

	NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS,
	NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS,

	NL802154_CAP_ATTR_MIN_FRAME_RETRIES,
	NL802154_CAP_ATTR_MAX_FRAME_RETRIES,

	NL802154_CAP_ATTR_LBT,

	/* keep last */
	__NL802154_CAP_ATTR_AFTER_LAST,
	NL802154_CAP_ATTR_MAX = __NL802154_CAP_ATTR_AFTER_LAST - 1
};

/**
 * enum nl802154_cca_modes - cca modes
 *
 * @__NL802154_CCA_INVALID: cca mode number 0 is reserved
 * @NL802154_CCA_ENERGY: Energy above threshold
 * @NL802154_CCA_CARRIER: Carrier sense only
 * @NL802154_CCA_ENERGY_CARRIER: Carrier sense with energy above threshold
 * @NL802154_CCA_ALOHA: CCA shall always report an idle medium
 * @NL802154_CCA_UWB_SHR: UWB preamble sense based on the SHR of a frame
 * @NL802154_CCA_UWB_MULTIPLEXED: UWB preamble sense based on the packet with
 *	the multiplexed preamble
 * @__NL802154_CCA_ATTR_AFTER_LAST: Internal
 * @NL802154_CCA_ATTR_MAX: Maximum CCA attribute number
 */
enum nl802154_cca_modes {
	__NL802154_CCA_INVALID,
	NL802154_CCA_ENERGY,
	NL802154_CCA_CARRIER,
	NL802154_CCA_ENERGY_CARRIER,
	NL802154_CCA_ALOHA,
	NL802154_CCA_UWB_SHR,
	NL802154_CCA_UWB_MULTIPLEXED,

	/* keep last */
	__NL802154_CCA_ATTR_AFTER_LAST,
	NL802154_CCA_ATTR_MAX = __NL802154_CCA_ATTR_AFTER_LAST - 1
};

/**
 * enum nl802154_cca_opts - additional options for cca modes
 *
 * @NL802154_CCA_OPT_ENERGY_CARRIER_OR: NL802154_CCA_ENERGY_CARRIER with OR
 * @NL802154_CCA_OPT_ENERGY_CARRIER_AND: NL802154_CCA_ENERGY_CARRIER with AND
 */
enum nl802154_cca_opts {
	NL802154_CCA_OPT_ENERGY_CARRIER_AND,
	NL802154_CCA_OPT_ENERGY_CARRIER_OR,

	/* keep last */
	__NL802154_CCA_OPT_ATTR_AFTER_LAST,
	NL802154_CCA_OPT_ATTR_MAX = __NL802154_CCA_OPT_ATTR_AFTER_LAST - 1
};

/**
 * enum nl802154_supported_bool_states - bool states for bool capability entry
 *
 * @NL802154_SUPPORTED_BOOL_FALSE: indicates to set false
 * @NL802154_SUPPORTED_BOOL_TRUE: indicates to set true
 * @__NL802154_SUPPORTED_BOOL_INVALD: reserved
 * @NL802154_SUPPORTED_BOOL_BOTH: indicates to set true and false
 * @__NL802154_SUPPORTED_BOOL_AFTER_LAST: Internal
 * @NL802154_SUPPORTED_BOOL_MAX: highest value for bool states
 */
enum nl802154_supported_bool_states {
	NL802154_SUPPORTED_BOOL_FALSE,
	NL802154_SUPPORTED_BOOL_TRUE,
	/* to handle them in a mask */
	__NL802154_SUPPORTED_BOOL_INVALD,
	NL802154_SUPPORTED_BOOL_BOTH,

	/* keep last */
	__NL802154_SUPPORTED_BOOL_AFTER_LAST,
	NL802154_SUPPORTED_BOOL_MAX = __NL802154_SUPPORTED_BOOL_AFTER_LAST - 1
};

#endif /* __NL802154_H */
Commit	Line	Data
3ae75e02 AA	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,
ba2a9506	85	NL802154_ATTR_CCA_OPT,
3ae75e02 AA	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
0e665457 AA	103	NL802154_ATTR_WPAN_PHY_CAPS,
0e665457 AA	104
133be026 VB	105	NL802154_ATTR_SUPPORTED_COMMANDS,
133be026 VB	106
3ae75e02 AA	107	/* add attributes here, update the policy in nl802154.c */
	108
	109	__NL802154_ATTR_AFTER_LAST,
	110	NL802154_ATTR_MAX = __NL802154_ATTR_AFTER_LAST - 1
	111	};
	112
	113	enum nl802154_iftype {
	114	/* for backwards compatibility TODO */
	115	NL802154_IFTYPE_UNSPEC = -1,
	116
	117	NL802154_IFTYPE_NODE,
	118	NL802154_IFTYPE_MONITOR,
	119	NL802154_IFTYPE_COORD,
	120
	121	/* keep last */
	122	NUM_NL802154_IFTYPES,
	123	NL802154_IFTYPE_MAX = NUM_NL802154_IFTYPES - 1
	124	};
	125
0e665457 AA	126	/**
	127	* enum nl802154_wpan_phy_capability_attr - wpan phy capability attributes
	128	*
	129	* @__NL802154_CAP_ATTR_INVALID: attribute number 0 is reserved
	130	* @NL802154_CAP_ATTR_CHANNELS: a nested attribute for nl802154_channel_attr
	131	* @NL802154_CAP_ATTR_TX_POWERS: a nested attribute for
	132	* nl802154_wpan_phy_tx_power
	133	* @NL802154_CAP_ATTR_MIN_CCA_ED_LEVEL: minimum value for cca_ed_level
	134	* @NL802154_CAP_ATTR_MAX_CCA_ED_LEVEL: maxmimum value for cca_ed_level
	135	* @NL802154_CAP_ATTR_CCA_MODES: nl802154_cca_modes flags
	136	* @NL802154_CAP_ATTR_CCA_OPTS: nl802154_cca_opts flags
	137	* @NL802154_CAP_ATTR_MIN_MINBE: minimum of minbe value
	138	* @NL802154_CAP_ATTR_MAX_MINBE: maximum of minbe value
	139	* @NL802154_CAP_ATTR_MIN_MAXBE: minimum of maxbe value
	140	* @NL802154_CAP_ATTR_MAX_MINBE: maximum of maxbe value
	141	* @NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS: minimum of csma backoff value
	142	* @NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS: maximum of csma backoffs value
	143	* @NL802154_CAP_ATTR_MIN_FRAME_RETRIES: minimum of frame retries value
	144	* @NL802154_CAP_ATTR_MAX_FRAME_RETRIES: maximum of frame retries value
	145	* @NL802154_CAP_ATTR_IFTYPES: nl802154_iftype flags
	146	* @NL802154_CAP_ATTR_LBT: nl802154_supported_bool_states flags
	147	* @NL802154_CAP_ATTR_MAX: highest cap attribute currently defined
	148	* @__NL802154_CAP_ATTR_AFTER_LAST: internal use
	149	*/
	150	enum nl802154_wpan_phy_capability_attr {
	151	__NL802154_CAP_ATTR_INVALID,
	152
	153	NL802154_CAP_ATTR_IFTYPES,
	154
	155	NL802154_CAP_ATTR_CHANNELS,
	156	NL802154_CAP_ATTR_TX_POWERS,
	157
	158	NL802154_CAP_ATTR_CCA_ED_LEVELS,
	159	NL802154_CAP_ATTR_CCA_MODES,
	160	NL802154_CAP_ATTR_CCA_OPTS,
	161
	162	NL802154_CAP_ATTR_MIN_MINBE,
	163	NL802154_CAP_ATTR_MAX_MINBE,
	164
	165	NL802154_CAP_ATTR_MIN_MAXBE,
	166	NL802154_CAP_ATTR_MAX_MAXBE,
	167
	168	NL802154_CAP_ATTR_MIN_CSMA_BACKOFFS,
	169	NL802154_CAP_ATTR_MAX_CSMA_BACKOFFS,
	170
	171	NL802154_CAP_ATTR_MIN_FRAME_RETRIES,
	172	NL802154_CAP_ATTR_MAX_FRAME_RETRIES,
	173
	174	NL802154_CAP_ATTR_LBT,
	175
	176	/* keep last */
	177	__NL802154_CAP_ATTR_AFTER_LAST,
	178	NL802154_CAP_ATTR_MAX = __NL802154_CAP_ATTR_AFTER_LAST - 1
	179	};
	180
b40d6376 AA	181	/**
	182	* enum nl802154_cca_modes - cca modes
	183	*
	184	* @__NL802154_CCA_INVALID: cca mode number 0 is reserved
	185	* @NL802154_CCA_ENERGY: Energy above threshold
	186	* @NL802154_CCA_CARRIER: Carrier sense only
	187	* @NL802154_CCA_ENERGY_CARRIER: Carrier sense with energy above threshold
	188	* @NL802154_CCA_ALOHA: CCA shall always report an idle medium
	189	* @NL802154_CCA_UWB_SHR: UWB preamble sense based on the SHR of a frame
d446278c	190	* @NL802154_CCA_UWB_MULTIPLEXED: UWB preamble sense based on the packet with
b40d6376 AA	191	* the multiplexed preamble
	192	* @__NL802154_CCA_ATTR_AFTER_LAST: Internal
	193	* @NL802154_CCA_ATTR_MAX: Maximum CCA attribute number
	194	*/
	195	enum nl802154_cca_modes {
	196	__NL802154_CCA_INVALID,
	197	NL802154_CCA_ENERGY,
	198	NL802154_CCA_CARRIER,
	199	NL802154_CCA_ENERGY_CARRIER,
	200	NL802154_CCA_ALOHA,
	201	NL802154_CCA_UWB_SHR,
d446278c	202	NL802154_CCA_UWB_MULTIPLEXED,
b40d6376 AA	203
	204	/* keep last */
	205	__NL802154_CCA_ATTR_AFTER_LAST,
	206	NL802154_CCA_ATTR_MAX = __NL802154_CCA_ATTR_AFTER_LAST - 1
	207	};
	208
	209	/**
	210	* enum nl802154_cca_opts - additional options for cca modes
	211	*
	212	* @NL802154_CCA_OPT_ENERGY_CARRIER_OR: NL802154_CCA_ENERGY_CARRIER with OR
	213	* @NL802154_CCA_OPT_ENERGY_CARRIER_AND: NL802154_CCA_ENERGY_CARRIER with AND
	214	*/
	215	enum nl802154_cca_opts {
	216	NL802154_CCA_OPT_ENERGY_CARRIER_AND,
	217	NL802154_CCA_OPT_ENERGY_CARRIER_OR,
	218
	219	/* keep last */
	220	__NL802154_CCA_OPT_ATTR_AFTER_LAST,
	221	NL802154_CCA_OPT_ATTR_MAX = __NL802154_CCA_OPT_ATTR_AFTER_LAST - 1
	222	};
	223
fea3318d AA	224	/**
	225	* enum nl802154_supported_bool_states - bool states for bool capability entry
	226	*
	227	* @NL802154_SUPPORTED_BOOL_FALSE: indicates to set false
	228	* @NL802154_SUPPORTED_BOOL_TRUE: indicates to set true
	229	* @__NL802154_SUPPORTED_BOOL_INVALD: reserved
	230	* @NL802154_SUPPORTED_BOOL_BOTH: indicates to set true and false
	231	* @__NL802154_SUPPORTED_BOOL_AFTER_LAST: Internal
	232	* @NL802154_SUPPORTED_BOOL_MAX: highest value for bool states
	233	*/
	234	enum nl802154_supported_bool_states {
	235	NL802154_SUPPORTED_BOOL_FALSE,
	236	NL802154_SUPPORTED_BOOL_TRUE,
	237	/* to handle them in a mask */
	238	__NL802154_SUPPORTED_BOOL_INVALD,
	239	NL802154_SUPPORTED_BOOL_BOTH,
	240
	241	/* keep last */
	242	__NL802154_SUPPORTED_BOOL_AFTER_LAST,
	243	NL802154_SUPPORTED_BOOL_MAX = __NL802154_SUPPORTED_BOOL_AFTER_LAST - 1
	244	};
	245
3ae75e02	246	#endif /* __NL802154_H */