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