Documentation/driver-api/80211/mac80211.rst

   1 ===========================
   2 mac80211 subsystem (basics)
   3 ===========================
   4
   5 You should read and understand the information contained within this
   6 part of the book while implementing a mac80211 driver. In some chapters,
   7 advanced usage is noted, those may be skipped if this isn't needed.
   8
   9 This part of the book only covers station and monitor mode
  10 functionality, additional information required to implement the other
  11 modes is covered in the second part of the book.
  12
  13 Basic hardware handling
  14 =======================
  15
  16 TBD
  17
  18 This chapter shall contain information on getting a hw struct allocated
  19 and registered with mac80211.
  20
  21 Since it is required to allocate rates/modes before registering a hw
  22 struct, this chapter shall also contain information on setting up the
  23 rate/mode structs.
  24
  25 Additionally, some discussion about the callbacks and the general
  26 programming model should be in here, including the definition of
  27 ieee80211_ops which will be referred to a lot.
  28
  29 Finally, a discussion of hardware capabilities should be done with
  30 references to other parts of the book.
  31
  32 .. kernel-doc:: include/net/mac80211.h
  33    :functions:
  34         ieee80211_hw
  35         ieee80211_hw_flags
  36         SET_IEEE80211_DEV
  37         SET_IEEE80211_PERM_ADDR
  38         ieee80211_ops
  39         ieee80211_alloc_hw
  40         ieee80211_register_hw
  41         ieee80211_unregister_hw
  42         ieee80211_free_hw
  43
  44 PHY configuration
  45 =================
  46
  47 TBD
  48
  49 This chapter should describe PHY handling including start/stop callbacks
  50 and the various structures used.
  51
  52 .. kernel-doc:: include/net/mac80211.h
  53    :functions:
  54         ieee80211_conf
  55         ieee80211_conf_flags
  56
  57 Virtual interfaces
  58 ==================
  59
  60 TBD
  61
  62 This chapter should describe virtual interface basics that are relevant
  63 to the driver (VLANs, MGMT etc are not.) It should explain the use of
  64 the add_iface/remove_iface callbacks as well as the interface
  65 configuration callbacks.
  66
  67 Things related to AP mode should be discussed there.
  68
  69 Things related to supporting multiple interfaces should be in the
  70 appropriate chapter, a BIG FAT note should be here about this though and
  71 the recommendation to allow only a single interface in STA mode at
  72 first!
  73
  74 .. kernel-doc:: include/net/mac80211.h
  75    :functions: ieee80211_vif
  76
  77 Receive and transmit processing
  78 ===============================
  79
  80 what should be here
  81 -------------------
  82
  83 TBD
  84
  85 This should describe the receive and transmit paths in mac80211/the
  86 drivers as well as transmit status handling.
  87
  88 Frame format
  89 ------------
  90
  91 .. kernel-doc:: include/net/mac80211.h
  92    :doc: Frame format
  93
  94 Packet alignment
  95 ----------------
  96
  97 .. kernel-doc:: net/mac80211/rx.c
  98    :doc: Packet alignment
  99
 100 Calling into mac80211 from interrupts
 101 -------------------------------------
 102
 103 .. kernel-doc:: include/net/mac80211.h
 104    :doc: Calling mac80211 from interrupts
 105
 106 functions/definitions
 107 ---------------------
 108
 109 .. kernel-doc:: include/net/mac80211.h
 110    :functions:
 111         ieee80211_rx_status
 112         mac80211_rx_encoding_flags
 113         mac80211_rx_flags
 114         mac80211_tx_info_flags
 115         mac80211_tx_control_flags
 116         mac80211_rate_control_flags
 117         ieee80211_tx_rate
 118         ieee80211_tx_info
 119         ieee80211_tx_info_clear_status
 120         ieee80211_rx
 121         ieee80211_rx_ni
 122         ieee80211_rx_irqsafe
 123         ieee80211_tx_status
 124         ieee80211_tx_status_ni
 125         ieee80211_tx_status_irqsafe
 126         ieee80211_rts_get
 127         ieee80211_rts_duration
 128         ieee80211_ctstoself_get
 129         ieee80211_ctstoself_duration
 130         ieee80211_generic_frame_duration
 131         ieee80211_wake_queue
 132         ieee80211_stop_queue
 133         ieee80211_wake_queues
 134         ieee80211_stop_queues
 135         ieee80211_queue_stopped
 136
 137 Frame filtering
 138 ===============
 139
 140 .. kernel-doc:: include/net/mac80211.h
 141    :doc: Frame filtering
 142
 143 .. kernel-doc:: include/net/mac80211.h
 144    :functions: ieee80211_filter_flags
 145
 146 The mac80211 workqueue
 147 ======================
 148
 149 .. kernel-doc:: include/net/mac80211.h
 150    :doc: mac80211 workqueue
 151
 152 .. kernel-doc:: include/net/mac80211.h
 153    :functions:
 154         ieee80211_queue_work
 155         ieee80211_queue_delayed_work