1/* SPDX-License-Identifier: GPL-2.0-only */ 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> 6 * Copyright (C) 2020, 2022 Intel Corporation 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 */ 23enum 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 58 * space, uses: 59 * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_ADDR_RECEIVER, 60 * %HWSIM_ATTR_FRAME, %HWSIM_ATTR_FLAGS, %HWSIM_ATTR_RX_RATE, 61 * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE, %HWSIM_ATTR_FREQ (optional) 62 * @HWSIM_CMD_TX_INFO_FRAME: Transmission info report from user space to 63 * kernel, uses: 64 * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_FLAGS, 65 * %HWSIM_ATTR_TX_INFO, %WSIM_ATTR_TX_INFO_FLAGS, 66 * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE 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 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 75 * @HWSIM_CMD_DEL_RADIO: destroy a radio, reply is multicasted 76 * @HWSIM_CMD_GET_RADIO: fetch information about existing radios, uses: 77 * %HWSIM_ATTR_RADIO_ID 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. 84 * @HWSIM_CMD_START_PMSR: request to start peer measurement with the 85 * %HWSIM_ATTR_PMSR_REQUEST. Result will be sent back asynchronously 86 * with %HWSIM_CMD_REPORT_PMSR. 87 * @__HWSIM_CMD_MAX: enum limit 88 */ 89enum { 90 HWSIM_CMD_UNSPEC, 91 HWSIM_CMD_REGISTER, 92 HWSIM_CMD_FRAME, 93 HWSIM_CMD_TX_INFO_FRAME, 94 HWSIM_CMD_NEW_RADIO, 95 HWSIM_CMD_DEL_RADIO, 96 HWSIM_CMD_GET_RADIO, 97 HWSIM_CMD_ADD_MAC_ADDR, 98 HWSIM_CMD_DEL_MAC_ADDR, 99 HWSIM_CMD_START_PMSR, 100 HWSIM_CMD_ABORT_PMSR, 101 HWSIM_CMD_REPORT_PMSR, 102 __HWSIM_CMD_MAX, 103}; 104#define HWSIM_CMD_MAX (_HWSIM_CMD_MAX - 1) 105 106#define HWSIM_CMD_CREATE_RADIO HWSIM_CMD_NEW_RADIO 107#define HWSIM_CMD_DESTROY_RADIO HWSIM_CMD_DEL_RADIO 108 109/** 110 * enum hwsim_attrs - hwsim netlink attributes 111 * 112 * @HWSIM_ATTR_UNSPEC: unspecified attribute to catch errors 113 * 114 * @HWSIM_ATTR_ADDR_RECEIVER: MAC address of the radio device that 115 * the frame is broadcasted to 116 * @HWSIM_ATTR_ADDR_TRANSMITTER: MAC address of the radio device that 117 * the frame was broadcasted from 118 * @HWSIM_ATTR_FRAME: Data array 119 * @HWSIM_ATTR_FLAGS: mac80211 transmission flags, used to process 120 properly the frame at user space 121 * @HWSIM_ATTR_RX_RATE: estimated rx rate index for this frame at user 122 space 123 * @HWSIM_ATTR_SIGNAL: estimated RX signal for this frame at user 124 space 125 * @HWSIM_ATTR_TX_INFO: ieee80211_tx_rate array 126 * @HWSIM_ATTR_COOKIE: sk_buff cookie to identify the frame 127 * @HWSIM_ATTR_CHANNELS: u32 attribute used with the %HWSIM_CMD_CREATE_RADIO 128 * command giving the number of channels supported by the new radio 129 * @HWSIM_ATTR_RADIO_ID: u32 attribute used with %HWSIM_CMD_DESTROY_RADIO 130 * only to destroy a radio 131 * @HWSIM_ATTR_REG_HINT_ALPHA2: alpha2 for regulatoro driver hint 132 * (nla string, length 2) 133 * @HWSIM_ATTR_REG_CUSTOM_REG: custom regulatory domain index (u32 attribute) 134 * @HWSIM_ATTR_REG_STRICT_REG: request REGULATORY_STRICT_REG (flag attribute) 135 * @HWSIM_ATTR_SUPPORT_P2P_DEVICE: support P2P Device virtual interface (flag) 136 * @HWSIM_ATTR_USE_CHANCTX: used with the %HWSIM_CMD_CREATE_RADIO 137 * command to force use of channel contexts even when only a 138 * single channel is supported 139 * @HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE: used with the %HWSIM_CMD_CREATE_RADIO 140 * command to force radio removal when process that created the radio dies 141 * @HWSIM_ATTR_RADIO_NAME: Name of radio, e.g. phy666 142 * @HWSIM_ATTR_NO_VIF: Do not create vif (wlanX) when creating radio. 143 * @HWSIM_ATTR_FREQ: Frequency at which packet is transmitted or received. 144 * @HWSIM_ATTR_TX_INFO_FLAGS: additional flags for corresponding 145 * rates of %HWSIM_ATTR_TX_INFO 146 * @HWSIM_ATTR_PERM_ADDR: permanent mac address of new radio 147 * @HWSIM_ATTR_IFTYPE_SUPPORT: u32 attribute of supported interface types bits 148 * @HWSIM_ATTR_CIPHER_SUPPORT: u32 array of supported cipher types 149 * @HWSIM_ATTR_MLO_SUPPORT: claim MLO support (exact parameters TBD) for 150 * the new radio 151 * @HWSIM_ATTR_PMSR_SUPPORT: nested attribute used with %HWSIM_CMD_CREATE_RADIO 152 * to provide peer measurement capabilities. (nl80211_peer_measurement_attrs) 153 * @HWSIM_ATTR_PMSR_REQUEST: nested attribute used with %HWSIM_CMD_START_PMSR 154 * to provide details about peer measurement request (nl80211_peer_measurement_attrs) 155 * @HWSIM_ATTR_PMSR_RESULT: nested attributed used with %HWSIM_CMD_REPORT_PMSR 156 * to provide peer measurement result (nl80211_peer_measurement_attrs) 157 * @__HWSIM_ATTR_MAX: enum limit 158 */ 159 160 161enum { 162 HWSIM_ATTR_UNSPEC, 163 HWSIM_ATTR_ADDR_RECEIVER, 164 HWSIM_ATTR_ADDR_TRANSMITTER, 165 HWSIM_ATTR_FRAME, 166 HWSIM_ATTR_FLAGS, 167 HWSIM_ATTR_RX_RATE, 168 HWSIM_ATTR_SIGNAL, 169 HWSIM_ATTR_TX_INFO, 170 HWSIM_ATTR_COOKIE, 171 HWSIM_ATTR_CHANNELS, 172 HWSIM_ATTR_RADIO_ID, 173 HWSIM_ATTR_REG_HINT_ALPHA2, 174 HWSIM_ATTR_REG_CUSTOM_REG, 175 HWSIM_ATTR_REG_STRICT_REG, 176 HWSIM_ATTR_SUPPORT_P2P_DEVICE, 177 HWSIM_ATTR_USE_CHANCTX, 178 HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE, 179 HWSIM_ATTR_RADIO_NAME, 180 HWSIM_ATTR_NO_VIF, 181 HWSIM_ATTR_FREQ, 182 HWSIM_ATTR_PAD, 183 HWSIM_ATTR_TX_INFO_FLAGS, 184 HWSIM_ATTR_PERM_ADDR, 185 HWSIM_ATTR_IFTYPE_SUPPORT, 186 HWSIM_ATTR_CIPHER_SUPPORT, 187 HWSIM_ATTR_MLO_SUPPORT, 188 HWSIM_ATTR_PMSR_SUPPORT, 189 HWSIM_ATTR_PMSR_REQUEST, 190 HWSIM_ATTR_PMSR_RESULT, 191 __HWSIM_ATTR_MAX, 192}; 193#define HWSIM_ATTR_MAX (__HWSIM_ATTR_MAX - 1) 194 195/** 196 * struct hwsim_tx_rate - rate selection/status 197 * 198 * @idx: rate index to attempt to send with 199 * @count: number of tries in this rate before going to the next rate 200 * 201 * A value of -1 for @idx indicates an invalid rate and, if used 202 * in an array of retry rates, that no more rates should be tried. 203 * 204 * When used for transmit status reporting, the driver should 205 * always report the rate and number of retries used. 206 * 207 */ 208struct hwsim_tx_rate { 209 s8 idx; 210 u8 count; 211} __packed; 212 213/** 214 * enum hwsim_tx_rate_flags - per-rate flags set by the rate control algorithm. 215 * Inspired by structure mac80211_rate_control_flags. New flags may be 216 * appended, but old flags not deleted, to keep compatibility for 217 * userspace. 218 * 219 * These flags are set by the Rate control algorithm for each rate during tx, 220 * in the @flags member of struct ieee80211_tx_rate. 221 * 222 * @MAC80211_HWSIM_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate. 223 * @MAC80211_HWSIM_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required. 224 * This is set if the current BSS requires ERP protection. 225 * @MAC80211_HWSIM_TX_RC_USE_SHORT_PREAMBLE: Use short preamble. 226 * @MAC80211_HWSIM_TX_RC_MCS: HT rate. 227 * @MAC80211_HWSIM_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is 228 * split into a higher 4 bits (Nss) and lower 4 bits (MCS number) 229 * @MAC80211_HWSIM_TX_RC_GREEN_FIELD: Indicates whether this rate should be used 230 * in Greenfield mode. 231 * @MAC80211_HWSIM_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 232 * 40 MHz. 233 * @MAC80211_HWSIM_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission 234 * @MAC80211_HWSIM_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission 235 * (80+80 isn't supported yet) 236 * @MAC80211_HWSIM_TX_RC_DUP_DATA: The frame should be transmitted on both of 237 * the adjacent 20 MHz channels, if the current channel type is 238 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS. 239 * @MAC80211_HWSIM_TX_RC_SHORT_GI: Short Guard interval should be used for this 240 * rate. 241 */ 242enum hwsim_tx_rate_flags { 243 MAC80211_HWSIM_TX_RC_USE_RTS_CTS = BIT(0), 244 MAC80211_HWSIM_TX_RC_USE_CTS_PROTECT = BIT(1), 245 MAC80211_HWSIM_TX_RC_USE_SHORT_PREAMBLE = BIT(2), 246 247 /* rate index is an HT/VHT MCS instead of an index */ 248 MAC80211_HWSIM_TX_RC_MCS = BIT(3), 249 MAC80211_HWSIM_TX_RC_GREEN_FIELD = BIT(4), 250 MAC80211_HWSIM_TX_RC_40_MHZ_WIDTH = BIT(5), 251 MAC80211_HWSIM_TX_RC_DUP_DATA = BIT(6), 252 MAC80211_HWSIM_TX_RC_SHORT_GI = BIT(7), 253 MAC80211_HWSIM_TX_RC_VHT_MCS = BIT(8), 254 MAC80211_HWSIM_TX_RC_80_MHZ_WIDTH = BIT(9), 255 MAC80211_HWSIM_TX_RC_160_MHZ_WIDTH = BIT(10), 256}; 257 258/** 259 * struct hwsim_tx_rate - rate selection/status 260 * 261 * @idx: rate index to attempt to send with 262 * @count: number of tries in this rate before going to the next rate 263 * 264 * A value of -1 for @idx indicates an invalid rate and, if used 265 * in an array of retry rates, that no more rates should be tried. 266 * 267 * When used for transmit status reporting, the driver should 268 * always report the rate and number of retries used. 269 * 270 */ 271struct hwsim_tx_rate_flag { 272 s8 idx; 273 u16 flags; 274} __packed; 275 276/** 277 * DOC: Frame transmission support over virtio 278 * 279 * Frame transmission is also supported over virtio to allow communication 280 * with external entities. 281 */ 282 283/** 284 * enum hwsim_vqs - queues for virtio frame transmission 285 * 286 * @HWSIM_VQ_TX: send frames to external entity 287 * @HWSIM_VQ_RX: receive frames and transmission info reports 288 * @HWSIM_NUM_VQS: enum limit 289 */ 290enum { 291 HWSIM_VQ_TX, 292 HWSIM_VQ_RX, 293 HWSIM_NUM_VQS, 294}; 295 296/** 297 * enum hwsim_rate_info -- bitrate information. 298 * 299 * Information about a receiving or transmitting bitrate 300 * that can be mapped to struct rate_info 301 * 302 * @HWSIM_RATE_INFO_ATTR_FLAGS: bitflag of flags from &enum rate_info_flags 303 * @HWSIM_RATE_INFO_ATTR_MCS: mcs index if struct describes an HT/VHT/HE rate 304 * @HWSIM_RATE_INFO_ATTR_LEGACY: bitrate in 100kbit/s for 802.11abg 305 * @HWSIM_RATE_INFO_ATTR_NSS: number of streams (VHT & HE only) 306 * @HWSIM_RATE_INFO_ATTR_BW: bandwidth (from &enum rate_info_bw) 307 * @HWSIM_RATE_INFO_ATTR_HE_GI: HE guard interval (from &enum nl80211_he_gi) 308 * @HWSIM_RATE_INFO_ATTR_HE_DCM: HE DCM value 309 * @HWSIM_RATE_INFO_ATTR_HE_RU_ALLOC: HE RU allocation (from &enum nl80211_he_ru_alloc, 310 * only valid if bw is %RATE_INFO_BW_HE_RU) 311 * @HWSIM_RATE_INFO_ATTR_N_BOUNDED_CH: In case of EDMG the number of bonded channels (1-4) 312 * @HWSIM_RATE_INFO_ATTR_EHT_GI: EHT guard interval (from &enum nl80211_eht_gi) 313 * @HWSIM_RATE_INFO_ATTR_EHT_RU_ALLOC: EHT RU allocation (from &enum nl80211_eht_ru_alloc, 314 * only valid if bw is %RATE_INFO_BW_EHT_RU) 315 * @NUM_HWSIM_RATE_INFO_ATTRS: internal 316 * @HWSIM_RATE_INFO_ATTR_MAX: highest attribute number 317 */ 318enum hwsim_rate_info_attributes { 319 __HWSIM_RATE_INFO_ATTR_INVALID, 320 321 HWSIM_RATE_INFO_ATTR_FLAGS, 322 HWSIM_RATE_INFO_ATTR_MCS, 323 HWSIM_RATE_INFO_ATTR_LEGACY, 324 HWSIM_RATE_INFO_ATTR_NSS, 325 HWSIM_RATE_INFO_ATTR_BW, 326 HWSIM_RATE_INFO_ATTR_HE_GI, 327 HWSIM_RATE_INFO_ATTR_HE_DCM, 328 HWSIM_RATE_INFO_ATTR_HE_RU_ALLOC, 329 HWSIM_RATE_INFO_ATTR_N_BOUNDED_CH, 330 HWSIM_RATE_INFO_ATTR_EHT_GI, 331 HWSIM_RATE_INFO_ATTR_EHT_RU_ALLOC, 332 333 /* keep last */ 334 NUM_HWSIM_RATE_INFO_ATTRS, 335 HWSIM_RATE_INFO_ATTR_MAX = NUM_HWSIM_RATE_INFO_ATTRS - 1 336}; 337 338#endif /* __MAC80211_HWSIM_H */ 339