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, %HWSIM_ATTR_FREQ (optional)
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, %WSIM_ATTR_TX_INFO_FLAGS,
68 * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
69 * @HWSIM_CMD_NEW_RADIO: create a new radio with the given parameters,
70 * returns the radio ID (>= 0) or negative on errors, if successful
71 * then multicast the result, uses optional parameter:
72 * %HWSIM_ATTR_REG_STRICT_REG, %HWSIM_ATTR_SUPPORT_P2P_DEVICE,
73 * %HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE, %HWSIM_ATTR_CHANNELS,
74 * %HWSIM_ATTR_NO_VIF, %HWSIM_ATTR_RADIO_NAME, %HWSIM_ATTR_USE_CHANCTX,
75 * %HWSIM_ATTR_REG_HINT_ALPHA2, %HWSIM_ATTR_REG_CUSTOM_REG,
76 * %HWSIM_ATTR_PERM_ADDR
77 * @HWSIM_CMD_DEL_RADIO: destroy a radio, reply is multicasted
78 * @HWSIM_CMD_GET_RADIO: fetch information about existing radios, uses:
79 * %HWSIM_ATTR_RADIO_ID
80 * @__HWSIM_CMD_MAX: enum limit
81 */
82enum {
83 HWSIM_CMD_UNSPEC,
84 HWSIM_CMD_REGISTER,
85 HWSIM_CMD_FRAME,
86 HWSIM_CMD_TX_INFO_FRAME,
87 HWSIM_CMD_NEW_RADIO,
88 HWSIM_CMD_DEL_RADIO,
89 HWSIM_CMD_GET_RADIO,
90 __HWSIM_CMD_MAX,
91};
92#define HWSIM_CMD_MAX (_HWSIM_CMD_MAX - 1)
93
94#define HWSIM_CMD_CREATE_RADIO HWSIM_CMD_NEW_RADIO
95#define HWSIM_CMD_DESTROY_RADIO HWSIM_CMD_DEL_RADIO
96
97/**
98 * enum hwsim_attrs - hwsim netlink attributes
99 *
100 * @HWSIM_ATTR_UNSPEC: unspecified attribute to catch errors
101 *
102 * @HWSIM_ATTR_ADDR_RECEIVER: MAC address of the radio device that
103 * the frame is broadcasted to
104 * @HWSIM_ATTR_ADDR_TRANSMITTER: MAC address of the radio device that
105 * the frame was broadcasted from
106 * @HWSIM_ATTR_FRAME: Data array
107 * @HWSIM_ATTR_FLAGS: mac80211 transmission flags, used to process
108 properly the frame at user space
109 * @HWSIM_ATTR_RX_RATE: estimated rx rate index for this frame at user
110 space
111 * @HWSIM_ATTR_SIGNAL: estimated RX signal for this frame at user
112 space
113 * @HWSIM_ATTR_TX_INFO: ieee80211_tx_rate array
114 * @HWSIM_ATTR_COOKIE: sk_buff cookie to identify the frame
115 * @HWSIM_ATTR_CHANNELS: u32 attribute used with the %HWSIM_CMD_CREATE_RADIO
116 * command giving the number of channels supported by the new radio
117 * @HWSIM_ATTR_RADIO_ID: u32 attribute used with %HWSIM_CMD_DESTROY_RADIO
118 * only to destroy a radio
119 * @HWSIM_ATTR_REG_HINT_ALPHA2: alpha2 for regulatoro driver hint
120 * (nla string, length 2)
121 * @HWSIM_ATTR_REG_CUSTOM_REG: custom regulatory domain index (u32 attribute)
122 * @HWSIM_ATTR_REG_STRICT_REG: request REGULATORY_STRICT_REG (flag attribute)
123 * @HWSIM_ATTR_SUPPORT_P2P_DEVICE: support P2P Device virtual interface (flag)
124 * @HWSIM_ATTR_USE_CHANCTX: used with the %HWSIM_CMD_CREATE_RADIO
125 * command to force use of channel contexts even when only a
126 * single channel is supported
127 * @HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE: used with the %HWSIM_CMD_CREATE_RADIO
128 * command to force radio removal when process that created the radio dies
129 * @HWSIM_ATTR_RADIO_NAME: Name of radio, e.g. phy666
130 * @HWSIM_ATTR_NO_VIF: Do not create vif (wlanX) when creating radio.
131 * @HWSIM_ATTR_FREQ: Frequency at which packet is transmitted or received.
132 * @HWSIM_ATTR_TX_INFO_FLAGS: additional flags for corresponding
133 * rates of %HWSIM_ATTR_TX_INFO
134 * @HWSIM_ATTR_PERM_ADDR: permanent mac address of new radio
135 * @__HWSIM_ATTR_MAX: enum limit
136 */
137
138
139enum {
140 HWSIM_ATTR_UNSPEC,
141 HWSIM_ATTR_ADDR_RECEIVER,
142 HWSIM_ATTR_ADDR_TRANSMITTER,
143 HWSIM_ATTR_FRAME,
144 HWSIM_ATTR_FLAGS,
145 HWSIM_ATTR_RX_RATE,
146 HWSIM_ATTR_SIGNAL,
147 HWSIM_ATTR_TX_INFO,
148 HWSIM_ATTR_COOKIE,
149 HWSIM_ATTR_CHANNELS,
150 HWSIM_ATTR_RADIO_ID,
151 HWSIM_ATTR_REG_HINT_ALPHA2,
152 HWSIM_ATTR_REG_CUSTOM_REG,
153 HWSIM_ATTR_REG_STRICT_REG,
154 HWSIM_ATTR_SUPPORT_P2P_DEVICE,
155 HWSIM_ATTR_USE_CHANCTX,
156 HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE,
157 HWSIM_ATTR_RADIO_NAME,
158 HWSIM_ATTR_NO_VIF,
159 HWSIM_ATTR_FREQ,
160 HWSIM_ATTR_PAD,
161 HWSIM_ATTR_TX_INFO_FLAGS,
162 HWSIM_ATTR_PERM_ADDR,
163 __HWSIM_ATTR_MAX,
164};
165#define HWSIM_ATTR_MAX (__HWSIM_ATTR_MAX - 1)
166
167/**
168 * struct hwsim_tx_rate - rate selection/status
169 *
170 * @idx: rate index to attempt to send with
171 * @count: number of tries in this rate before going to the next rate
172 *
173 * A value of -1 for @idx indicates an invalid rate and, if used
174 * in an array of retry rates, that no more rates should be tried.
175 *
176 * When used for transmit status reporting, the driver should
177 * always report the rate and number of retries used.
178 *
179 */
180struct hwsim_tx_rate {
181 s8 idx;
182 u8 count;
183} __packed;
184
185/**
186 * enum hwsim_tx_rate_flags - per-rate flags set by the rate control algorithm.
187 * Inspired by structure mac80211_rate_control_flags. New flags may be
188 * appended, but old flags not deleted, to keep compatibility for
189 * userspace.
190 *
191 * These flags are set by the Rate control algorithm for each rate during tx,
192 * in the @flags member of struct ieee80211_tx_rate.
193 *
194 * @MAC80211_HWSIM_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
195 * @MAC80211_HWSIM_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
196 * This is set if the current BSS requires ERP protection.
197 * @MAC80211_HWSIM_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
198 * @MAC80211_HWSIM_TX_RC_MCS: HT rate.
199 * @MAC80211_HWSIM_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is
200 * split into a higher 4 bits (Nss) and lower 4 bits (MCS number)
201 * @MAC80211_HWSIM_TX_RC_GREEN_FIELD: Indicates whether this rate should be used
202 * in Greenfield mode.
203 * @MAC80211_HWSIM_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be
204 * 40 MHz.
205 * @MAC80211_HWSIM_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
206 * @MAC80211_HWSIM_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
207 * (80+80 isn't supported yet)
208 * @MAC80211_HWSIM_TX_RC_DUP_DATA: The frame should be transmitted on both of
209 * the adjacent 20 MHz channels, if the current channel type is
210 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
211 * @MAC80211_HWSIM_TX_RC_SHORT_GI: Short Guard interval should be used for this
212 * rate.
213 */
214enum hwsim_tx_rate_flags {
215 MAC80211_HWSIM_TX_RC_USE_RTS_CTS = BIT(0),
216 MAC80211_HWSIM_TX_RC_USE_CTS_PROTECT = BIT(1),
217 MAC80211_HWSIM_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
218
219 /* rate index is an HT/VHT MCS instead of an index */
220 MAC80211_HWSIM_TX_RC_MCS = BIT(3),
221 MAC80211_HWSIM_TX_RC_GREEN_FIELD = BIT(4),
222 MAC80211_HWSIM_TX_RC_40_MHZ_WIDTH = BIT(5),
223 MAC80211_HWSIM_TX_RC_DUP_DATA = BIT(6),
224 MAC80211_HWSIM_TX_RC_SHORT_GI = BIT(7),
225 MAC80211_HWSIM_TX_RC_VHT_MCS = BIT(8),
226 MAC80211_HWSIM_TX_RC_80_MHZ_WIDTH = BIT(9),
227 MAC80211_HWSIM_TX_RC_160_MHZ_WIDTH = BIT(10),
228};
229
230/**
231 * struct hwsim_tx_rate - rate selection/status
232 *
233 * @idx: rate index to attempt to send with
234 * @count: number of tries in this rate before going to the next rate
235 *
236 * A value of -1 for @idx indicates an invalid rate and, if used
237 * in an array of retry rates, that no more rates should be tried.
238 *
239 * When used for transmit status reporting, the driver should
240 * always report the rate and number of retries used.
241 *
242 */
243struct hwsim_tx_rate_flag {
244 s8 idx;
245 u16 flags;
246} __packed;
247#endif /* __MAC80211_HWSIM_H */