blob: 77c3c202991b4ded85f4795ef33e3e73186dd784 [file] [log] [blame]
Johannes Bergdbbea672008-02-26 14:34:06 +01001<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
4
5<book id="mac80211-developers-guide">
6 <bookinfo>
7 <title>The mac80211 subsystem for kernel developers</title>
8
9 <authorgroup>
10 <author>
11 <firstname>Johannes</firstname>
12 <surname>Berg</surname>
13 <affiliation>
14 <address><email>johannes@sipsolutions.net</email></address>
15 </affiliation>
16 </author>
17 </authorgroup>
18
19 <copyright>
20 <year>2007</year>
21 <year>2008</year>
22 <holder>Johannes Berg</holder>
23 </copyright>
24
25 <legalnotice>
26 <para>
27 This documentation is free software; you can redistribute
28 it and/or modify it under the terms of the GNU General Public
29 License version 2 as published by the Free Software Foundation.
30 </para>
31
32 <para>
33 This documentation is distributed in the hope that it will be
34 useful, but WITHOUT ANY WARRANTY; without even the implied
35 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
36 See the GNU General Public License for more details.
37 </para>
38
39 <para>
40 You should have received a copy of the GNU General Public
41 License along with this documentation; if not, write to the Free
42 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
43 MA 02111-1307 USA
44 </para>
45
46 <para>
47 For more details see the file COPYING in the source
48 distribution of Linux.
49 </para>
50 </legalnotice>
51
52 <abstract>
53!Pinclude/net/mac80211.h Introduction
54!Pinclude/net/mac80211.h Warning
55 </abstract>
56 </bookinfo>
57
58 <toc></toc>
59
60<!--
61Generally, this document shall be ordered by increasing complexity.
62It is important to note that readers should be able to read only
63the first few sections to get a working driver and only advanced
64usage should require reading the full document.
65-->
66
67 <part>
68 <title>The basic mac80211 driver interface</title>
69 <partintro>
70 <para>
71 You should read and understand the information contained
72 within this part of the book while implementing a driver.
73 In some chapters, advanced usage is noted, that may be
74 skipped at first.
75 </para>
76 <para>
77 This part of the book only covers station and monitor mode
78 functionality, additional information required to implement
79 the other modes is covered in the second part of the book.
80 </para>
81 </partintro>
82
83 <chapter id="basics">
84 <title>Basic hardware handling</title>
85 <para>TBD</para>
86 <para>
87 This chapter shall contain information on getting a hw
88 struct allocated and registered with mac80211.
89 </para>
90 <para>
91 Since it is required to allocate rates/modes before registering
92 a hw struct, this chapter shall also contain information on setting
93 up the rate/mode structs.
94 </para>
95 <para>
96 Additionally, some discussion about the callbacks and
97 the general programming model should be in here, including
98 the definition of ieee80211_ops which will be referred to
99 a lot.
100 </para>
101 <para>
102 Finally, a discussion of hardware capabilities should be done
103 with references to other parts of the book.
104 </para>
105<!-- intentionally multiple !F lines to get proper order -->
106!Finclude/net/mac80211.h ieee80211_hw
107!Finclude/net/mac80211.h ieee80211_hw_flags
108!Finclude/net/mac80211.h SET_IEEE80211_DEV
109!Finclude/net/mac80211.h SET_IEEE80211_PERM_ADDR
110!Finclude/net/mac80211.h ieee80211_ops
111!Finclude/net/mac80211.h ieee80211_alloc_hw
112!Finclude/net/mac80211.h ieee80211_register_hw
113!Finclude/net/mac80211.h ieee80211_get_tx_led_name
114!Finclude/net/mac80211.h ieee80211_get_rx_led_name
115!Finclude/net/mac80211.h ieee80211_get_assoc_led_name
116!Finclude/net/mac80211.h ieee80211_get_radio_led_name
117!Finclude/net/mac80211.h ieee80211_unregister_hw
118!Finclude/net/mac80211.h ieee80211_free_hw
119 </chapter>
120
121 <chapter id="phy-handling">
122 <title>PHY configuration</title>
123 <para>TBD</para>
124 <para>
125 This chapter should describe PHY handling including
126 start/stop callbacks and the various structures used.
127 </para>
128!Finclude/net/mac80211.h ieee80211_conf
129!Finclude/net/mac80211.h ieee80211_conf_flags
130 </chapter>
131
132 <chapter id="iface-handling">
133 <title>Virtual interfaces</title>
134 <para>TBD</para>
135 <para>
136 This chapter should describe virtual interface basics
137 that are relevant to the driver (VLANs, MGMT etc are not.)
138 It should explain the use of the add_iface/remove_iface
139 callbacks as well as the interface configuration callbacks.
140 </para>
141 <para>Things related to AP mode should be discussed there.</para>
142 <para>
143 Things related to supporting multiple interfaces should be
144 in the appropriate chapter, a BIG FAT note should be here about
145 this though and the recommendation to allow only a single
146 interface in STA mode at first!
147 </para>
Johannes Bergdbbea672008-02-26 14:34:06 +0100148!Finclude/net/mac80211.h ieee80211_if_init_conf
149!Finclude/net/mac80211.h ieee80211_if_conf
150 </chapter>
151
152 <chapter id="rx-tx">
153 <title>Receive and transmit processing</title>
154 <sect1>
155 <title>what should be here</title>
156 <para>TBD</para>
157 <para>
158 This should describe the receive and transmit
159 paths in mac80211/the drivers as well as
160 transmit status handling.
161 </para>
162 </sect1>
163 <sect1>
164 <title>Frame format</title>
165!Pinclude/net/mac80211.h Frame format
166 </sect1>
167 <sect1>
168 <title>Alignment issues</title>
169 <para>TBD</para>
170 </sect1>
171 <sect1>
172 <title>Calling into mac80211 from interrupts</title>
173!Pinclude/net/mac80211.h Calling mac80211 from interrupts
174 </sect1>
175 <sect1>
176 <title>functions/definitions</title>
177!Finclude/net/mac80211.h ieee80211_rx_status
178!Finclude/net/mac80211.h mac80211_rx_flags
Johannes Berg62c1f952008-09-12 10:18:44 +0200179!Finclude/net/mac80211.h ieee80211_tx_info
Johannes Bergdbbea672008-02-26 14:34:06 +0100180!Finclude/net/mac80211.h ieee80211_rx
181!Finclude/net/mac80211.h ieee80211_rx_irqsafe
182!Finclude/net/mac80211.h ieee80211_tx_status
183!Finclude/net/mac80211.h ieee80211_tx_status_irqsafe
184!Finclude/net/mac80211.h ieee80211_rts_get
185!Finclude/net/mac80211.h ieee80211_rts_duration
186!Finclude/net/mac80211.h ieee80211_ctstoself_get
187!Finclude/net/mac80211.h ieee80211_ctstoself_duration
188!Finclude/net/mac80211.h ieee80211_generic_frame_duration
189!Finclude/net/mac80211.h ieee80211_get_hdrlen_from_skb
Johannes Berg62c1f952008-09-12 10:18:44 +0200190!Finclude/net/mac80211.h ieee80211_hdrlen
Johannes Bergdbbea672008-02-26 14:34:06 +0100191!Finclude/net/mac80211.h ieee80211_wake_queue
192!Finclude/net/mac80211.h ieee80211_stop_queue
Johannes Bergdbbea672008-02-26 14:34:06 +0100193!Finclude/net/mac80211.h ieee80211_wake_queues
Johannes Berg62c1f952008-09-12 10:18:44 +0200194!Finclude/net/mac80211.h ieee80211_stop_queues
Johannes Bergdbbea672008-02-26 14:34:06 +0100195 </sect1>
196 </chapter>
197
198 <chapter id="filters">
199 <title>Frame filtering</title>
200!Pinclude/net/mac80211.h Frame filtering
201!Finclude/net/mac80211.h ieee80211_filter_flags
202 </chapter>
203 </part>
204
205 <part id="advanced">
206 <title>Advanced driver interface</title>
207 <partintro>
208 <para>
209 Information contained within this part of the book is
210 of interest only for advanced interaction of mac80211
211 with drivers to exploit more hardware capabilities and
212 improve performance.
213 </para>
214 </partintro>
215
216 <chapter id="hardware-crypto-offload">
217 <title>Hardware crypto acceleration</title>
218!Pinclude/net/mac80211.h Hardware crypto acceleration
219<!-- intentionally multiple !F lines to get proper order -->
220!Finclude/net/mac80211.h set_key_cmd
221!Finclude/net/mac80211.h ieee80211_key_conf
222!Finclude/net/mac80211.h ieee80211_key_alg
223!Finclude/net/mac80211.h ieee80211_key_flags
224 </chapter>
225
226 <chapter id="qos">
227 <title>Multiple queues and QoS support</title>
228 <para>TBD</para>
229!Finclude/net/mac80211.h ieee80211_tx_queue_params
Johannes Berg62c1f952008-09-12 10:18:44 +0200230!Finclude/net/mac80211.h ieee80211_tx_queue_stats
Johannes Bergdbbea672008-02-26 14:34:06 +0100231 </chapter>
232
233 <chapter id="AP">
234 <title>Access point mode support</title>
235 <para>TBD</para>
236 <para>Some parts of the if_conf should be discussed here instead</para>
237 <para>
238 Insert notes about VLAN interfaces with hw crypto here or
239 in the hw crypto chapter.
240 </para>
241!Finclude/net/mac80211.h ieee80211_get_buffered_bc
242!Finclude/net/mac80211.h ieee80211_beacon_get
243 </chapter>
244
245 <chapter id="multi-iface">
246 <title>Supporting multiple virtual interfaces</title>
247 <para>TBD</para>
248 <para>
249 Note: WDS with identical MAC address should almost always be OK
250 </para>
251 <para>
252 Insert notes about having multiple virtual interfaces with
253 different MAC addresses here, note which configurations are
254 supported by mac80211, add notes about supporting hw crypto
255 with it.
256 </para>
257 </chapter>
258
259 <chapter id="hardware-scan-offload">
260 <title>Hardware scan offload</title>
261 <para>TBD</para>
262!Finclude/net/mac80211.h ieee80211_scan_completed
263 </chapter>
264 </part>
265
266 <part id="rate-control">
267 <title>Rate control interface</title>
268 <partintro>
269 <para>TBD</para>
270 <para>
271 This part of the book describes the rate control algorithm
272 interface and how it relates to mac80211 and drivers.
273 </para>
274 </partintro>
275 <chapter id="dummy">
276 <title>dummy chapter</title>
277 <para>TBD</para>
278 </chapter>
279 </part>
280
281 <part id="internal">
282 <title>Internals</title>
283 <partintro>
284 <para>TBD</para>
285 <para>
286 This part of the book describes mac80211 internals.
287 </para>
288 </partintro>
289
290 <chapter id="key-handling">
291 <title>Key handling</title>
292 <sect1>
293 <title>Key handling basics</title>
294!Pnet/mac80211/key.c Key handling basics
295 </sect1>
296 <sect1>
297 <title>MORE TBD</title>
298 <para>TBD</para>
299 </sect1>
300 </chapter>
301
302 <chapter id="rx-processing">
303 <title>Receive processing</title>
304 <para>TBD</para>
305 </chapter>
306
307 <chapter id="tx-processing">
308 <title>Transmit processing</title>
309 <para>TBD</para>
310 </chapter>
311
312 <chapter id="sta-info">
313 <title>Station info handling</title>
314 <sect1>
315 <title>Programming information</title>
316!Fnet/mac80211/sta_info.h sta_info
317!Fnet/mac80211/sta_info.h ieee80211_sta_info_flags
318 </sect1>
319 <sect1>
320 <title>STA information lifetime rules</title>
321!Pnet/mac80211/sta_info.c STA information lifetime rules
322 </sect1>
323 </chapter>
324
325 <chapter id="synchronisation">
326 <title>Synchronisation</title>
327 <para>TBD</para>
328 <para>Locking, lots of RCU</para>
329 </chapter>
330 </part>
331</book>