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