]>
Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
7882513b JL |
2 | /* |
3 | * mac80211_hwsim - software simulator of 802.11 radio(s) for mac80211 | |
4 | * Copyright (c) 2008, Jouni Malinen <j@w1.fi> | |
5 | * Copyright (c) 2011, Javier Lopez <jlopex@gmail.com> | |
5d44fe7c | 6 | * Copyright (C) 2020 Intel Corporation |
7882513b JL |
7 | */ |
8 | ||
9 | #ifndef __MAC80211_HWSIM_H | |
10 | #define __MAC80211_HWSIM_H | |
11 | ||
12 | /** | |
13 | * enum hwsim_tx_control_flags - flags to describe transmission info/status | |
14 | * | |
15 | * These flags are used to give the wmediumd extra information in order to | |
16 | * modify its behavior for each frame | |
17 | * | |
18 | * @HWSIM_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame. | |
19 | * @HWSIM_TX_CTL_NO_ACK: tell the wmediumd not to wait for an ack | |
20 | * @HWSIM_TX_STAT_ACK: Frame was acknowledged | |
21 | * | |
22 | */ | |
23 | enum hwsim_tx_control_flags { | |
24 | HWSIM_TX_CTL_REQ_TX_STATUS = BIT(0), | |
25 | HWSIM_TX_CTL_NO_ACK = BIT(1), | |
26 | HWSIM_TX_STAT_ACK = BIT(2), | |
27 | }; | |
28 | ||
29 | /** | |
30 | * DOC: Frame transmission/registration support | |
31 | * | |
32 | * Frame transmission and registration support exists to allow userspace | |
33 | * entities such as wmediumd to receive and process all broadcasted | |
34 | * frames from a mac80211_hwsim radio device. | |
35 | * | |
36 | * This allow user space applications to decide if the frame should be | |
37 | * dropped or not and implement a wireless medium simulator at user space. | |
38 | * | |
39 | * Registration is done by sending a register message to the driver and | |
40 | * will be automatically unregistered if the user application doesn't | |
41 | * responds to sent frames. | |
42 | * Once registered the user application has to take responsibility of | |
43 | * broadcasting the frames to all listening mac80211_hwsim radio | |
44 | * interfaces. | |
45 | * | |
46 | * For more technical details, see the corresponding command descriptions | |
47 | * below. | |
48 | */ | |
49 | ||
50 | /** | |
51 | * enum hwsim_commands - supported hwsim commands | |
52 | * | |
53 | * @HWSIM_CMD_UNSPEC: unspecified command to catch errors | |
54 | * | |
55 | * @HWSIM_CMD_REGISTER: request to register and received all broadcasted | |
56 | * frames by any mac80211_hwsim radio device. | |
57 | * @HWSIM_CMD_FRAME: send/receive a broadcasted frame from/to kernel/user | |
03765195 | 58 | * space, uses: |
7882513b JL |
59 | * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_ADDR_RECEIVER, |
60 | * %HWSIM_ATTR_FRAME, %HWSIM_ATTR_FLAGS, %HWSIM_ATTR_RX_RATE, | |
4f86ed8f | 61 | * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE, %HWSIM_ATTR_FREQ (optional) |
7882513b | 62 | * @HWSIM_CMD_TX_INFO_FRAME: Transmission info report from user space to |
03765195 | 63 | * kernel, uses: |
7882513b | 64 | * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_FLAGS, |
6e3d6ca1 BB |
65 | * %HWSIM_ATTR_TX_INFO, %WSIM_ATTR_TX_INFO_FLAGS, |
66 | * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE | |
5940c3e4 JR |
67 | * @HWSIM_CMD_NEW_RADIO: create a new radio with the given parameters, |
68 | * returns the radio ID (>= 0) or negative on errors, if successful | |
cb1a5bae BB |
69 | * then multicast the result, uses optional parameter: |
70 | * %HWSIM_ATTR_REG_STRICT_REG, %HWSIM_ATTR_SUPPORT_P2P_DEVICE, | |
71 | * %HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE, %HWSIM_ATTR_CHANNELS, | |
72 | * %HWSIM_ATTR_NO_VIF, %HWSIM_ATTR_RADIO_NAME, %HWSIM_ATTR_USE_CHANCTX, | |
73 | * %HWSIM_ATTR_REG_HINT_ALPHA2, %HWSIM_ATTR_REG_CUSTOM_REG, | |
74 | * %HWSIM_ATTR_PERM_ADDR | |
5940c3e4 | 75 | * @HWSIM_CMD_DEL_RADIO: destroy a radio, reply is multicasted |
93d638d4 PF |
76 | * @HWSIM_CMD_GET_RADIO: fetch information about existing radios, uses: |
77 | * %HWSIM_ATTR_RADIO_ID | |
5cc58a9e JB |
78 | * @HWSIM_CMD_ADD_MAC_ADDR: add a receive MAC address (given in the |
79 | * %HWSIM_ATTR_ADDR_RECEIVER attribute) to a device identified by | |
80 | * %HWSIM_ATTR_ADDR_TRANSMITTER. This lets wmediumd forward frames | |
81 | * to this receiver address for a given station. | |
82 | * @HWSIM_CMD_DEL_MAC_ADDR: remove the MAC address again, the attributes | |
83 | * are the same as to @HWSIM_CMD_ADD_MAC_ADDR. | |
7882513b JL |
84 | * @__HWSIM_CMD_MAX: enum limit |
85 | */ | |
86 | enum { | |
87 | HWSIM_CMD_UNSPEC, | |
88 | HWSIM_CMD_REGISTER, | |
89 | HWSIM_CMD_FRAME, | |
90 | HWSIM_CMD_TX_INFO_FRAME, | |
5940c3e4 JR |
91 | HWSIM_CMD_NEW_RADIO, |
92 | HWSIM_CMD_DEL_RADIO, | |
93d638d4 | 93 | HWSIM_CMD_GET_RADIO, |
5cc58a9e JB |
94 | HWSIM_CMD_ADD_MAC_ADDR, |
95 | HWSIM_CMD_DEL_MAC_ADDR, | |
7882513b JL |
96 | __HWSIM_CMD_MAX, |
97 | }; | |
98 | #define HWSIM_CMD_MAX (_HWSIM_CMD_MAX - 1) | |
99 | ||
5940c3e4 JR |
100 | #define HWSIM_CMD_CREATE_RADIO HWSIM_CMD_NEW_RADIO |
101 | #define HWSIM_CMD_DESTROY_RADIO HWSIM_CMD_DEL_RADIO | |
102 | ||
7882513b JL |
103 | /** |
104 | * enum hwsim_attrs - hwsim netlink attributes | |
105 | * | |
106 | * @HWSIM_ATTR_UNSPEC: unspecified attribute to catch errors | |
107 | * | |
108 | * @HWSIM_ATTR_ADDR_RECEIVER: MAC address of the radio device that | |
109 | * the frame is broadcasted to | |
110 | * @HWSIM_ATTR_ADDR_TRANSMITTER: MAC address of the radio device that | |
111 | * the frame was broadcasted from | |
112 | * @HWSIM_ATTR_FRAME: Data array | |
113 | * @HWSIM_ATTR_FLAGS: mac80211 transmission flags, used to process | |
114 | properly the frame at user space | |
115 | * @HWSIM_ATTR_RX_RATE: estimated rx rate index for this frame at user | |
116 | space | |
117 | * @HWSIM_ATTR_SIGNAL: estimated RX signal for this frame at user | |
118 | space | |
119 | * @HWSIM_ATTR_TX_INFO: ieee80211_tx_rate array | |
120 | * @HWSIM_ATTR_COOKIE: sk_buff cookie to identify the frame | |
bc791098 JB |
121 | * @HWSIM_ATTR_CHANNELS: u32 attribute used with the %HWSIM_CMD_CREATE_RADIO |
122 | * command giving the number of channels supported by the new radio | |
123 | * @HWSIM_ATTR_RADIO_ID: u32 attribute used with %HWSIM_CMD_DESTROY_RADIO | |
124 | * only to destroy a radio | |
26b0e411 JB |
125 | * @HWSIM_ATTR_REG_HINT_ALPHA2: alpha2 for regulatoro driver hint |
126 | * (nla string, length 2) | |
127 | * @HWSIM_ATTR_REG_CUSTOM_REG: custom regulatory domain index (u32 attribute) | |
128 | * @HWSIM_ATTR_REG_STRICT_REG: request REGULATORY_STRICT_REG (flag attribute) | |
8c66a3d9 | 129 | * @HWSIM_ATTR_SUPPORT_P2P_DEVICE: support P2P Device virtual interface (flag) |
361c3e04 LC |
130 | * @HWSIM_ATTR_USE_CHANCTX: used with the %HWSIM_CMD_CREATE_RADIO |
131 | * command to force use of channel contexts even when only a | |
132 | * single channel is supported | |
e9ed49bf JR |
133 | * @HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE: used with the %HWSIM_CMD_CREATE_RADIO |
134 | * command to force radio removal when process that created the radio dies | |
8cdd9e1c | 135 | * @HWSIM_ATTR_RADIO_NAME: Name of radio, e.g. phy666 |
9a0cb89a | 136 | * @HWSIM_ATTR_NO_VIF: Do not create vif (wlanX) when creating radio. |
4f86ed8f | 137 | * @HWSIM_ATTR_FREQ: Frequency at which packet is transmitted or received. |
6e3d6ca1 BB |
138 | * @HWSIM_ATTR_TX_INFO_FLAGS: additional flags for corresponding |
139 | * rates of %HWSIM_ATTR_TX_INFO | |
cb1a5bae | 140 | * @HWSIM_ATTR_PERM_ADDR: permanent mac address of new radio |
99e3a44b | 141 | * @HWSIM_ATTR_IFTYPE_SUPPORT: u32 attribute of supported interface types bits |
c0a0189d | 142 | * @HWSIM_ATTR_CIPHER_SUPPORT: u32 array of supported cipher types |
7882513b JL |
143 | * @__HWSIM_ATTR_MAX: enum limit |
144 | */ | |
145 | ||
146 | ||
147 | enum { | |
148 | HWSIM_ATTR_UNSPEC, | |
149 | HWSIM_ATTR_ADDR_RECEIVER, | |
150 | HWSIM_ATTR_ADDR_TRANSMITTER, | |
151 | HWSIM_ATTR_FRAME, | |
152 | HWSIM_ATTR_FLAGS, | |
153 | HWSIM_ATTR_RX_RATE, | |
154 | HWSIM_ATTR_SIGNAL, | |
155 | HWSIM_ATTR_TX_INFO, | |
156 | HWSIM_ATTR_COOKIE, | |
bc791098 JB |
157 | HWSIM_ATTR_CHANNELS, |
158 | HWSIM_ATTR_RADIO_ID, | |
26b0e411 JB |
159 | HWSIM_ATTR_REG_HINT_ALPHA2, |
160 | HWSIM_ATTR_REG_CUSTOM_REG, | |
161 | HWSIM_ATTR_REG_STRICT_REG, | |
8c66a3d9 | 162 | HWSIM_ATTR_SUPPORT_P2P_DEVICE, |
361c3e04 | 163 | HWSIM_ATTR_USE_CHANCTX, |
e9ed49bf | 164 | HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE, |
8cdd9e1c | 165 | HWSIM_ATTR_RADIO_NAME, |
9a0cb89a | 166 | HWSIM_ATTR_NO_VIF, |
4f86ed8f | 167 | HWSIM_ATTR_FREQ, |
08f4cbb8 | 168 | HWSIM_ATTR_PAD, |
6e3d6ca1 | 169 | HWSIM_ATTR_TX_INFO_FLAGS, |
cb1a5bae | 170 | HWSIM_ATTR_PERM_ADDR, |
99e3a44b | 171 | HWSIM_ATTR_IFTYPE_SUPPORT, |
c0a0189d | 172 | HWSIM_ATTR_CIPHER_SUPPORT, |
7882513b JL |
173 | __HWSIM_ATTR_MAX, |
174 | }; | |
175 | #define HWSIM_ATTR_MAX (__HWSIM_ATTR_MAX - 1) | |
176 | ||
177 | /** | |
178 | * struct hwsim_tx_rate - rate selection/status | |
179 | * | |
180 | * @idx: rate index to attempt to send with | |
181 | * @count: number of tries in this rate before going to the next rate | |
182 | * | |
183 | * A value of -1 for @idx indicates an invalid rate and, if used | |
184 | * in an array of retry rates, that no more rates should be tried. | |
185 | * | |
186 | * When used for transmit status reporting, the driver should | |
187 | * always report the rate and number of retries used. | |
188 | * | |
189 | */ | |
190 | struct hwsim_tx_rate { | |
191 | s8 idx; | |
192 | u8 count; | |
193 | } __packed; | |
194 | ||
6e3d6ca1 BB |
195 | /** |
196 | * enum hwsim_tx_rate_flags - per-rate flags set by the rate control algorithm. | |
197 | * Inspired by structure mac80211_rate_control_flags. New flags may be | |
198 | * appended, but old flags not deleted, to keep compatibility for | |
199 | * userspace. | |
200 | * | |
201 | * These flags are set by the Rate control algorithm for each rate during tx, | |
202 | * in the @flags member of struct ieee80211_tx_rate. | |
203 | * | |
204 | * @MAC80211_HWSIM_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate. | |
205 | * @MAC80211_HWSIM_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required. | |
206 | * This is set if the current BSS requires ERP protection. | |
207 | * @MAC80211_HWSIM_TX_RC_USE_SHORT_PREAMBLE: Use short preamble. | |
208 | * @MAC80211_HWSIM_TX_RC_MCS: HT rate. | |
209 | * @MAC80211_HWSIM_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is | |
210 | * split into a higher 4 bits (Nss) and lower 4 bits (MCS number) | |
211 | * @MAC80211_HWSIM_TX_RC_GREEN_FIELD: Indicates whether this rate should be used | |
212 | * in Greenfield mode. | |
213 | * @MAC80211_HWSIM_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be | |
214 | * 40 MHz. | |
215 | * @MAC80211_HWSIM_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission | |
216 | * @MAC80211_HWSIM_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission | |
217 | * (80+80 isn't supported yet) | |
218 | * @MAC80211_HWSIM_TX_RC_DUP_DATA: The frame should be transmitted on both of | |
219 | * the adjacent 20 MHz channels, if the current channel type is | |
220 | * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS. | |
221 | * @MAC80211_HWSIM_TX_RC_SHORT_GI: Short Guard interval should be used for this | |
222 | * rate. | |
223 | */ | |
224 | enum hwsim_tx_rate_flags { | |
225 | MAC80211_HWSIM_TX_RC_USE_RTS_CTS = BIT(0), | |
226 | MAC80211_HWSIM_TX_RC_USE_CTS_PROTECT = BIT(1), | |
227 | MAC80211_HWSIM_TX_RC_USE_SHORT_PREAMBLE = BIT(2), | |
228 | ||
229 | /* rate index is an HT/VHT MCS instead of an index */ | |
230 | MAC80211_HWSIM_TX_RC_MCS = BIT(3), | |
231 | MAC80211_HWSIM_TX_RC_GREEN_FIELD = BIT(4), | |
232 | MAC80211_HWSIM_TX_RC_40_MHZ_WIDTH = BIT(5), | |
233 | MAC80211_HWSIM_TX_RC_DUP_DATA = BIT(6), | |
234 | MAC80211_HWSIM_TX_RC_SHORT_GI = BIT(7), | |
235 | MAC80211_HWSIM_TX_RC_VHT_MCS = BIT(8), | |
236 | MAC80211_HWSIM_TX_RC_80_MHZ_WIDTH = BIT(9), | |
237 | MAC80211_HWSIM_TX_RC_160_MHZ_WIDTH = BIT(10), | |
238 | }; | |
239 | ||
240 | /** | |
241 | * struct hwsim_tx_rate - rate selection/status | |
242 | * | |
243 | * @idx: rate index to attempt to send with | |
244 | * @count: number of tries in this rate before going to the next rate | |
245 | * | |
246 | * A value of -1 for @idx indicates an invalid rate and, if used | |
247 | * in an array of retry rates, that no more rates should be tried. | |
248 | * | |
249 | * When used for transmit status reporting, the driver should | |
250 | * always report the rate and number of retries used. | |
251 | * | |
252 | */ | |
253 | struct hwsim_tx_rate_flag { | |
254 | s8 idx; | |
255 | u16 flags; | |
256 | } __packed; | |
5d44fe7c EG |
257 | |
258 | /** | |
259 | * DOC: Frame transmission support over virtio | |
260 | * | |
261 | * Frame transmission is also supported over virtio to allow communication | |
262 | * with external entities. | |
263 | */ | |
264 | ||
265 | /** | |
266 | * enum hwsim_vqs - queues for virtio frame transmission | |
267 | * | |
268 | * @HWSIM_VQ_TX: send frames to external entity | |
269 | * @HWSIM_VQ_RX: receive frames and transmission info reports | |
270 | * @HWSIM_NUM_VQS: enum limit | |
271 | */ | |
272 | enum { | |
273 | HWSIM_VQ_TX, | |
274 | HWSIM_VQ_RX, | |
275 | HWSIM_NUM_VQS, | |
276 | }; | |
7882513b | 277 | #endif /* __MAC80211_HWSIM_H */ |