drivers/net/wireless/mac80211_hwsim.h

   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  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  */
  10
  11 #ifndef __MAC80211_HWSIM_H
  12 #define __MAC80211_HWSIM_H
  13
  14 /**
  15  * enum hwsim_tx_control_flags - flags to describe transmission info/status
  16  *
  17  * These flags are used to give the wmediumd extra information in order to
  18  * modify its behavior for each frame
  19  *
  20  * @HWSIM_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
  21  * @HWSIM_TX_CTL_NO_ACK: tell the wmediumd not to wait for an ack
  22  * @HWSIM_TX_STAT_ACK: Frame was acknowledged
  23  *
  24  */
  25 enum hwsim_tx_control_flags {
  26         HWSIM_TX_CTL_REQ_TX_STATUS              = BIT(0),
  27         HWSIM_TX_CTL_NO_ACK                     = BIT(1),
  28         HWSIM_TX_STAT_ACK                       = BIT(2),
  29 };
  30
  31 /**
  32  * DOC: Frame transmission/registration support
  33  *
  34  * Frame transmission and registration support exists to allow userspace
  35  * entities such as wmediumd to receive and process all broadcasted
  36  * frames from a mac80211_hwsim radio device.
  37  *
  38  * This allow user space applications to decide if the frame should be
  39  * dropped or not and implement a wireless medium simulator at user space.
  40  *
  41  * Registration is done by sending a register message to the driver and
  42  * will be automatically unregistered if the user application doesn't
  43  * responds to sent frames.
  44  * Once registered the user application has to take responsibility of
  45  * broadcasting the frames to all listening mac80211_hwsim radio
  46  * interfaces.
  47  *
  48  * For more technical details, see the corresponding command descriptions
  49  * below.
  50  */
  51
  52 /**
  53  * enum hwsim_commands - supported hwsim commands
  54  *
  55  * @HWSIM_CMD_UNSPEC: unspecified command to catch errors
  56  *
  57  * @HWSIM_CMD_REGISTER: request to register and received all broadcasted
  58  *      frames by any mac80211_hwsim radio device.
  59  * @HWSIM_CMD_FRAME: send/receive a broadcasted frame from/to kernel/user
  60  * space, uses:
  61  *      %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_ADDR_RECEIVER,
  62  *      %HWSIM_ATTR_FRAME, %HWSIM_ATTR_FLAGS, %HWSIM_ATTR_RX_RATE,
  63  *      %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE, %HWSIM_ATTR_FREQ (optional)
  64  * @HWSIM_CMD_TX_INFO_FRAME: Transmission info report from user space to
  65  * kernel, uses:
  66  *      %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_FLAGS,
  67  *      %HWSIM_ATTR_TX_INFO, %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
  68  * @HWSIM_CMD_NEW_RADIO: create a new radio with the given parameters,
  69  *      returns the radio ID (>= 0) or negative on errors, if successful
  70  *      then multicast the result
  71  * @HWSIM_CMD_DEL_RADIO: destroy a radio, reply is multicasted
  72  * @__HWSIM_CMD_MAX: enum limit
  73  */
  74 enum {
  75         HWSIM_CMD_UNSPEC,
  76         HWSIM_CMD_REGISTER,
  77         HWSIM_CMD_FRAME,
  78         HWSIM_CMD_TX_INFO_FRAME,
  79         HWSIM_CMD_NEW_RADIO,
  80         HWSIM_CMD_DEL_RADIO,
  81         __HWSIM_CMD_MAX,
  82 };
  83 #define HWSIM_CMD_MAX (_HWSIM_CMD_MAX - 1)
  84
  85 #define HWSIM_CMD_CREATE_RADIO   HWSIM_CMD_NEW_RADIO
  86 #define HWSIM_CMD_DESTROY_RADIO  HWSIM_CMD_DEL_RADIO
  87
  88 /**
  89  * enum hwsim_attrs - hwsim netlink attributes
  90  *
  91  * @HWSIM_ATTR_UNSPEC: unspecified attribute to catch errors
  92  *
  93  * @HWSIM_ATTR_ADDR_RECEIVER: MAC address of the radio device that
  94  *      the frame is broadcasted to
  95  * @HWSIM_ATTR_ADDR_TRANSMITTER: MAC address of the radio device that
  96  *      the frame was broadcasted from
  97  * @HWSIM_ATTR_FRAME: Data array
  98  * @HWSIM_ATTR_FLAGS: mac80211 transmission flags, used to process
  99         properly the frame at user space
 100  * @HWSIM_ATTR_RX_RATE: estimated rx rate index for this frame at user
 101         space
 102  * @HWSIM_ATTR_SIGNAL: estimated RX signal for this frame at user
 103         space
 104  * @HWSIM_ATTR_TX_INFO: ieee80211_tx_rate array
 105  * @HWSIM_ATTR_COOKIE: sk_buff cookie to identify the frame
 106  * @HWSIM_ATTR_CHANNELS: u32 attribute used with the %HWSIM_CMD_CREATE_RADIO
 107  *      command giving the number of channels supported by the new radio
 108  * @HWSIM_ATTR_RADIO_ID: u32 attribute used with %HWSIM_CMD_DESTROY_RADIO
 109  *      only to destroy a radio
 110  * @HWSIM_ATTR_REG_HINT_ALPHA2: alpha2 for regulatoro driver hint
 111  *      (nla string, length 2)
 112  * @HWSIM_ATTR_REG_CUSTOM_REG: custom regulatory domain index (u32 attribute)
 113  * @HWSIM_ATTR_REG_STRICT_REG: request REGULATORY_STRICT_REG (flag attribute)
 114  * @HWSIM_ATTR_SUPPORT_P2P_DEVICE: support P2P Device virtual interface (flag)
 115  * @HWSIM_ATTR_USE_CHANCTX: used with the %HWSIM_CMD_CREATE_RADIO
 116  *      command to force use of channel contexts even when only a
 117  *      single channel is supported
 118  * @HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE: used with the %HWSIM_CMD_CREATE_RADIO
 119  *      command to force radio removal when process that created the radio dies
 120  * @HWSIM_ATTR_RADIO_NAME: Name of radio, e.g. phy666
 121  * @HWSIM_ATTR_NO_VIF:  Do not create vif (wlanX) when creating radio.
 122  * @HWSIM_ATTR_FREQ: Frequency at which packet is transmitted or received.
 123  * @__HWSIM_ATTR_MAX: enum limit
 124  */
 125
 126
 127 enum {
 128         HWSIM_ATTR_UNSPEC,
 129         HWSIM_ATTR_ADDR_RECEIVER,
 130         HWSIM_ATTR_ADDR_TRANSMITTER,
 131         HWSIM_ATTR_FRAME,
 132         HWSIM_ATTR_FLAGS,
 133         HWSIM_ATTR_RX_RATE,
 134         HWSIM_ATTR_SIGNAL,
 135         HWSIM_ATTR_TX_INFO,
 136         HWSIM_ATTR_COOKIE,
 137         HWSIM_ATTR_CHANNELS,
 138         HWSIM_ATTR_RADIO_ID,
 139         HWSIM_ATTR_REG_HINT_ALPHA2,
 140         HWSIM_ATTR_REG_CUSTOM_REG,
 141         HWSIM_ATTR_REG_STRICT_REG,
 142         HWSIM_ATTR_SUPPORT_P2P_DEVICE,
 143         HWSIM_ATTR_USE_CHANCTX,
 144         HWSIM_ATTR_DESTROY_RADIO_ON_CLOSE,
 145         HWSIM_ATTR_RADIO_NAME,
 146         HWSIM_ATTR_NO_VIF,
 147         HWSIM_ATTR_FREQ,
 148         __HWSIM_ATTR_MAX,
 149 };
 150 #define HWSIM_ATTR_MAX (__HWSIM_ATTR_MAX - 1)
 151
 152 /**
 153  * struct hwsim_tx_rate - rate selection/status
 154  *
 155  * @idx: rate index to attempt to send with
 156  * @count: number of tries in this rate before going to the next rate
 157  *
 158  * A value of -1 for @idx indicates an invalid rate and, if used
 159  * in an array of retry rates, that no more rates should be tried.
 160  *
 161  * When used for transmit status reporting, the driver should
 162  * always report the rate and number of retries used.
 163  *
 164  */
 165 struct hwsim_tx_rate {
 166         s8 idx;
 167         u8 count;
 168 } __packed;
 169
 170 #endif /* __MAC80211_HWSIM_H */