mac80211_hwsim.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  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. #ifndef __MAC80211_HWSIM_H
  11. #define __MAC80211_HWSIM_H
  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. */
  23. enum 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. * DOC: Frame transmission/registration support
  30. *
  31. * Frame transmission and registration support exists to allow userspace
  32. * entities such as wmediumd to receive and process all broadcasted
  33. * frames from a mac80211_hwsim radio device.
  34. *
  35. * This allow user space applications to decide if the frame should be
  36. * dropped or not and implement a wireless medium simulator at user space.
  37. *
  38. * Registration is done by sending a register message to the driver and
  39. * will be automatically unregistered if the user application doesn't
  40. * responds to sent frames.
  41. * Once registered the user application has to take responsibility of
  42. * broadcasting the frames to all listening mac80211_hwsim radio
  43. * interfaces.
  44. *
  45. * For more technical details, see the corresponding command descriptions
  46. * below.
  47. */
  48. /**
  49. * enum hwsim_commands - supported hwsim commands
  50. *
  51. * @HWSIM_CMD_UNSPEC: unspecified command to catch errors
  52. *
  53. * @HWSIM_CMD_REGISTER: request to register and received all broadcasted
  54. * frames by any mac80211_hwsim radio device.
  55. * @HWSIM_CMD_FRAME: send/receive a broadcasted frame from/to kernel/user
  56. * space, uses:
  57. * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_ADDR_RECEIVER,
  58. * %HWSIM_ATTR_FRAME, %HWSIM_ATTR_FLAGS, %HWSIM_ATTR_RX_RATE,
  59. * %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
  60. * @HWSIM_CMD_TX_INFO_FRAME: Transmission info report from user space to
  61. * kernel, uses:
  62. * %HWSIM_ATTR_ADDR_TRANSMITTER, %HWSIM_ATTR_FLAGS,
  63. * %HWSIM_ATTR_TX_INFO, %HWSIM_ATTR_SIGNAL, %HWSIM_ATTR_COOKIE
  64. * @__HWSIM_CMD_MAX: enum limit
  65. */
  66. enum {
  67. HWSIM_CMD_UNSPEC,
  68. HWSIM_CMD_REGISTER,
  69. HWSIM_CMD_FRAME,
  70. HWSIM_CMD_TX_INFO_FRAME,
  71. __HWSIM_CMD_MAX,
  72. };
  73. #define HWSIM_CMD_MAX (_HWSIM_CMD_MAX - 1)
  74. /**
  75. * enum hwsim_attrs - hwsim netlink attributes
  76. *
  77. * @HWSIM_ATTR_UNSPEC: unspecified attribute to catch errors
  78. *
  79. * @HWSIM_ATTR_ADDR_RECEIVER: MAC address of the radio device that
  80. * the frame is broadcasted to
  81. * @HWSIM_ATTR_ADDR_TRANSMITTER: MAC address of the radio device that
  82. * the frame was broadcasted from
  83. * @HWSIM_ATTR_FRAME: Data array
  84. * @HWSIM_ATTR_FLAGS: mac80211 transmission flags, used to process
  85. properly the frame at user space
  86. * @HWSIM_ATTR_RX_RATE: estimated rx rate index for this frame at user
  87. space
  88. * @HWSIM_ATTR_SIGNAL: estimated RX signal for this frame at user
  89. space
  90. * @HWSIM_ATTR_TX_INFO: ieee80211_tx_rate array
  91. * @HWSIM_ATTR_COOKIE: sk_buff cookie to identify the frame
  92. * @__HWSIM_ATTR_MAX: enum limit
  93. */
  94. enum {
  95. HWSIM_ATTR_UNSPEC,
  96. HWSIM_ATTR_ADDR_RECEIVER,
  97. HWSIM_ATTR_ADDR_TRANSMITTER,
  98. HWSIM_ATTR_FRAME,
  99. HWSIM_ATTR_FLAGS,
  100. HWSIM_ATTR_RX_RATE,
  101. HWSIM_ATTR_SIGNAL,
  102. HWSIM_ATTR_TX_INFO,
  103. HWSIM_ATTR_COOKIE,
  104. __HWSIM_ATTR_MAX,
  105. };
  106. #define HWSIM_ATTR_MAX (__HWSIM_ATTR_MAX - 1)
  107. /**
  108. * struct hwsim_tx_rate - rate selection/status
  109. *
  110. * @idx: rate index to attempt to send with
  111. * @count: number of tries in this rate before going to the next rate
  112. *
  113. * A value of -1 for @idx indicates an invalid rate and, if used
  114. * in an array of retry rates, that no more rates should be tried.
  115. *
  116. * When used for transmit status reporting, the driver should
  117. * always report the rate and number of retries used.
  118. *
  119. */
  120. struct hwsim_tx_rate {
  121. s8 idx;
  122. u8 count;
  123. } __packed;
  124. #endif /* __MAC80211_HWSIM_H */