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