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