Loading...
1/*
2 * mac80211_hwsim - software simulator of 802.11 radio(s) for mac80211
3 * Copyright (c) 2008, Jouni Malinen <j@w1.fi>
4 * Copyright (c) 2011, Javier Lopez <jlopex@gmail.com>
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 as
8 * published by the Free Software Foundation.
9 */
10
11#ifndef __MAC80211_HWSIM_H
12#define __MAC80211_HWSIM_H
13
14/**
15 * enum hwsim_tx_control_flags - flags to describe transmission info/status
16 *
17 * These flags are used to give the wmediumd extra information in order to
18 * modify its behavior for each frame
19 *
20 * @HWSIM_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
21 * @HWSIM_TX_CTL_NO_ACK: tell the wmediumd not to wait for an ack
22 * @HWSIM_TX_STAT_ACK: Frame was acknowledged
23 *
24 */
25enum hwsim_tx_control_flags {
26 HWSIM_TX_CTL_REQ_TX_STATUS = BIT(0),
27 HWSIM_TX_CTL_NO_ACK = BIT(1),
28 HWSIM_TX_STAT_ACK = BIT(2),
29};
30
31/**
32 * DOC: Frame transmission/registration support
33 *
34 * Frame transmission and registration support exists to allow userspace
35 * entities such as wmediumd to receive and process all broadcasted
36 * frames from a mac80211_hwsim radio device.
37 *
38 * This allow user space applications to decide if the frame should be
39 * dropped or not and implement a wireless medium simulator at user space.
40 *
41 * Registration is done by sending a register message to the driver and
42 * will be automatically unregistered if the user application doesn't
43 * responds to sent frames.
44 * Once registered the user application has to take responsibility of
45 * broadcasting the frames to all listening mac80211_hwsim radio
46 * interfaces.
47 *
48 * For more technical details, see the corresponding command descriptions
49 * below.
50 */
51
52/**
53 * enum hwsim_commands - supported hwsim commands
54 *
55 * @HWSIM_CMD_UNSPEC: unspecified command to catch errors
56 *
57 * @HWSIM_CMD_REGISTER: request to register and received all broadcasted
58 * frames by any mac80211_hwsim radio device.
59 * @HWSIM_CMD_FRAME: send/receive a broadcasted frame from/to kernel/user
60 * space, uses:
61 * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_ADDR_RECEIVER,
62 * %HWSIM_ATTR_FRAME, %HWSIM_ATTR_FLAGS, %HWSIM_ATTR_RX_RATE,
63 * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
64 * @HWSIM_CMD_TX_INFO_FRAME: Transmission info report from user space to
65 * kernel, uses:
66 * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_FLAGS,
67 * %HWSIM_ATTR_TX_INFO, %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
68 * @__HWSIM_CMD_MAX: enum limit
69 */
70enum {
71 HWSIM_CMD_UNSPEC,
72 HWSIM_CMD_REGISTER,
73 HWSIM_CMD_FRAME,
74 HWSIM_CMD_TX_INFO_FRAME,
75 __HWSIM_CMD_MAX,
76};
77#define HWSIM_CMD_MAX (_HWSIM_CMD_MAX - 1)
78
79/**
80 * enum hwsim_attrs - hwsim netlink attributes
81 *
82 * @HWSIM_ATTR_UNSPEC: unspecified attribute to catch errors
83 *
84 * @HWSIM_ATTR_ADDR_RECEIVER: MAC address of the radio device that
85 * the frame is broadcasted to
86 * @HWSIM_ATTR_ADDR_TRANSMITTER: MAC address of the radio device that
87 * the frame was broadcasted from
88 * @HWSIM_ATTR_FRAME: Data array
89 * @HWSIM_ATTR_FLAGS: mac80211 transmission flags, used to process
90 properly the frame at user space
91 * @HWSIM_ATTR_RX_RATE: estimated rx rate index for this frame at user
92 space
93 * @HWSIM_ATTR_SIGNAL: estimated RX signal for this frame at user
94 space
95 * @HWSIM_ATTR_TX_INFO: ieee80211_tx_rate array
96 * @HWSIM_ATTR_COOKIE: sk_buff cookie to identify the frame
97 * @__HWSIM_ATTR_MAX: enum limit
98 */
99
100
101enum {
102 HWSIM_ATTR_UNSPEC,
103 HWSIM_ATTR_ADDR_RECEIVER,
104 HWSIM_ATTR_ADDR_TRANSMITTER,
105 HWSIM_ATTR_FRAME,
106 HWSIM_ATTR_FLAGS,
107 HWSIM_ATTR_RX_RATE,
108 HWSIM_ATTR_SIGNAL,
109 HWSIM_ATTR_TX_INFO,
110 HWSIM_ATTR_COOKIE,
111 __HWSIM_ATTR_MAX,
112};
113#define HWSIM_ATTR_MAX (__HWSIM_ATTR_MAX - 1)
114
115/**
116 * struct hwsim_tx_rate - rate selection/status
117 *
118 * @idx: rate index to attempt to send with
119 * @count: number of tries in this rate before going to the next rate
120 *
121 * A value of -1 for @idx indicates an invalid rate and, if used
122 * in an array of retry rates, that no more rates should be tried.
123 *
124 * When used for transmit status reporting, the driver should
125 * always report the rate and number of retries used.
126 *
127 */
128struct hwsim_tx_rate {
129 s8 idx;
130 u8 count;
131} __packed;
132
133#endif /* __MAC80211_HWSIM_H */
1/*
2 * mac80211_hwsim - software simulator of 802.11 radio(s) for mac80211
3 * Copyright (c) 2008, Jouni Malinen <j@w1.fi>
4 * Copyright (c) 2011, Javier Lopez <jlopex@gmail.com>
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 as
8 * published by the Free Software Foundation.
9 */
10
11#ifndef __MAC80211_HWSIM_H
12#define __MAC80211_HWSIM_H
13
14/**
15 * enum hwsim_tx_control_flags - flags to describe transmission info/status
16 *
17 * These flags are used to give the wmediumd extra information in order to
18 * modify its behavior for each frame
19 *
20 * @HWSIM_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
21 * @HWSIM_TX_CTL_NO_ACK: tell the wmediumd not to wait for an ack
22 * @HWSIM_TX_STAT_ACK: Frame was acknowledged
23 *
24 */
25enum hwsim_tx_control_flags {
26 HWSIM_TX_CTL_REQ_TX_STATUS = BIT(0),
27 HWSIM_TX_CTL_NO_ACK = BIT(1),
28 HWSIM_TX_STAT_ACK = BIT(2),
29};
30
31/**
32 * DOC: Frame transmission/registration support
33 *
34 * Frame transmission and registration support exists to allow userspace
35 * entities such as wmediumd to receive and process all broadcasted
36 * frames from a mac80211_hwsim radio device.
37 *
38 * This allow user space applications to decide if the frame should be
39 * dropped or not and implement a wireless medium simulator at user space.
40 *
41 * Registration is done by sending a register message to the driver and
42 * will be automatically unregistered if the user application doesn't
43 * responds to sent frames.
44 * Once registered the user application has to take responsibility of
45 * broadcasting the frames to all listening mac80211_hwsim radio
46 * interfaces.
47 *
48 * For more technical details, see the corresponding command descriptions
49 * below.
50 */
51
52/**
53 * enum hwsim_commands - supported hwsim commands
54 *
55 * @HWSIM_CMD_UNSPEC: unspecified command to catch errors
56 *
57 * @HWSIM_CMD_REGISTER: request to register and received all broadcasted
58 * frames by any mac80211_hwsim radio device.
59 * @HWSIM_CMD_FRAME: send/receive a broadcasted frame from/to kernel/user
60 * space, uses:
61 * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_ADDR_RECEIVER,
62 * %HWSIM_ATTR_FRAME, %HWSIM_ATTR_FLAGS, %HWSIM_ATTR_RX_RATE,
63 * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
64 * @HWSIM_CMD_TX_INFO_FRAME: Transmission info report from user space to
65 * kernel, uses:
66 * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_FLAGS,
67 * %HWSIM_ATTR_TX_INFO, %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
68 * @HWSIM_CMD_CREATE_RADIO: create a new radio with the given parameters,
69 * returns the radio ID (>= 0) or negative on errors
70 * @HWSIM_CMD_DESTROY_RADIO: destroy a radio
71 * @__HWSIM_CMD_MAX: enum limit
72 */
73enum {
74 HWSIM_CMD_UNSPEC,
75 HWSIM_CMD_REGISTER,
76 HWSIM_CMD_FRAME,
77 HWSIM_CMD_TX_INFO_FRAME,
78 HWSIM_CMD_CREATE_RADIO,
79 HWSIM_CMD_DESTROY_RADIO,
80 __HWSIM_CMD_MAX,
81};
82#define HWSIM_CMD_MAX (_HWSIM_CMD_MAX - 1)
83
84/**
85 * enum hwsim_attrs - hwsim netlink attributes
86 *
87 * @HWSIM_ATTR_UNSPEC: unspecified attribute to catch errors
88 *
89 * @HWSIM_ATTR_ADDR_RECEIVER: MAC address of the radio device that
90 * the frame is broadcasted to
91 * @HWSIM_ATTR_ADDR_TRANSMITTER: MAC address of the radio device that
92 * the frame was broadcasted from
93 * @HWSIM_ATTR_FRAME: Data array
94 * @HWSIM_ATTR_FLAGS: mac80211 transmission flags, used to process
95 properly the frame at user space
96 * @HWSIM_ATTR_RX_RATE: estimated rx rate index for this frame at user
97 space
98 * @HWSIM_ATTR_SIGNAL: estimated RX signal for this frame at user
99 space
100 * @HWSIM_ATTR_TX_INFO: ieee80211_tx_rate array
101 * @HWSIM_ATTR_COOKIE: sk_buff cookie to identify the frame
102 * @HWSIM_ATTR_CHANNELS: u32 attribute used with the %HWSIM_CMD_CREATE_RADIO
103 * command giving the number of channels supported by the new radio
104 * @HWSIM_ATTR_RADIO_ID: u32 attribute used with %HWSIM_CMD_DESTROY_RADIO
105 * only to destroy a radio
106 * @HWSIM_ATTR_REG_HINT_ALPHA2: alpha2 for regulatoro driver hint
107 * (nla string, length 2)
108 * @HWSIM_ATTR_REG_CUSTOM_REG: custom regulatory domain index (u32 attribute)
109 * @HWSIM_ATTR_REG_STRICT_REG: request REGULATORY_STRICT_REG (flag attribute)
110 * @HWSIM_ATTR_SUPPORT_P2P_DEVICE: support P2P Device virtual interface (flag)
111 * @HWSIM_ATTR_USE_CHANCTX: used with the %HWSIM_CMD_CREATE_RADIO
112 * command to force use of channel contexts even when only a
113 * single channel is supported
114 * @__HWSIM_ATTR_MAX: enum limit
115 */
116
117
118enum {
119 HWSIM_ATTR_UNSPEC,
120 HWSIM_ATTR_ADDR_RECEIVER,
121 HWSIM_ATTR_ADDR_TRANSMITTER,
122 HWSIM_ATTR_FRAME,
123 HWSIM_ATTR_FLAGS,
124 HWSIM_ATTR_RX_RATE,
125 HWSIM_ATTR_SIGNAL,
126 HWSIM_ATTR_TX_INFO,
127 HWSIM_ATTR_COOKIE,
128 HWSIM_ATTR_CHANNELS,
129 HWSIM_ATTR_RADIO_ID,
130 HWSIM_ATTR_REG_HINT_ALPHA2,
131 HWSIM_ATTR_REG_CUSTOM_REG,
132 HWSIM_ATTR_REG_STRICT_REG,
133 HWSIM_ATTR_SUPPORT_P2P_DEVICE,
134 HWSIM_ATTR_USE_CHANCTX,
135 __HWSIM_ATTR_MAX,
136};
137#define HWSIM_ATTR_MAX (__HWSIM_ATTR_MAX - 1)
138
139/**
140 * struct hwsim_tx_rate - rate selection/status
141 *
142 * @idx: rate index to attempt to send with
143 * @count: number of tries in this rate before going to the next rate
144 *
145 * A value of -1 for @idx indicates an invalid rate and, if used
146 * in an array of retry rates, that no more rates should be tried.
147 *
148 * When used for transmit status reporting, the driver should
149 * always report the rate and number of retries used.
150 *
151 */
152struct hwsim_tx_rate {
153 s8 idx;
154 u8 count;
155} __packed;
156
157#endif /* __MAC80211_HWSIM_H */