diff options
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/80211.tmpl | 495 | ||||
-rw-r--r-- | Documentation/DocBook/Makefile | 2 | ||||
-rw-r--r-- | Documentation/DocBook/drm.tmpl | 1 | ||||
-rw-r--r-- | Documentation/DocBook/genericirq.tmpl | 84 | ||||
-rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 3 | ||||
-rw-r--r-- | Documentation/DocBook/kernel-locking.tmpl | 14 | ||||
-rw-r--r-- | Documentation/DocBook/mac80211.tmpl | 337 |
7 files changed, 555 insertions, 381 deletions
diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl new file mode 100644 index 00000000000..19a1210c253 --- /dev/null +++ b/Documentation/DocBook/80211.tmpl | |||
@@ -0,0 +1,495 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | ||
2 | <!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> | ||
4 | <set> | ||
5 | <setinfo> | ||
6 | <title>The 802.11 subsystems – for kernel developers</title> | ||
7 | <subtitle> | ||
8 | Explaining wireless 802.11 networking in the Linux kernel | ||
9 | </subtitle> | ||
10 | |||
11 | <copyright> | ||
12 | <year>2007-2009</year> | ||
13 | <holder>Johannes Berg</holder> | ||
14 | </copyright> | ||
15 | |||
16 | <authorgroup> | ||
17 | <author> | ||
18 | <firstname>Johannes</firstname> | ||
19 | <surname>Berg</surname> | ||
20 | <affiliation> | ||
21 | <address><email>johannes@sipsolutions.net</email></address> | ||
22 | </affiliation> | ||
23 | </author> | ||
24 | </authorgroup> | ||
25 | |||
26 | <legalnotice> | ||
27 | <para> | ||
28 | This documentation is free software; you can redistribute | ||
29 | it and/or modify it under the terms of the GNU General Public | ||
30 | License version 2 as published by the Free Software Foundation. | ||
31 | </para> | ||
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 | <para> | ||
39 | You should have received a copy of the GNU General Public | ||
40 | License along with this documentation; if not, write to the Free | ||
41 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, | ||
42 | MA 02111-1307 USA | ||
43 | </para> | ||
44 | <para> | ||
45 | For more details see the file COPYING in the source | ||
46 | distribution of Linux. | ||
47 | </para> | ||
48 | </legalnotice> | ||
49 | |||
50 | <abstract> | ||
51 | <para> | ||
52 | These books attempt to give a description of the | ||
53 | various subsystems that play a role in 802.11 wireless | ||
54 | networking in Linux. Since these books are for kernel | ||
55 | developers they attempts to document the structures | ||
56 | and functions used in the kernel as well as giving a | ||
57 | higher-level overview. | ||
58 | </para> | ||
59 | <para> | ||
60 | The reader is expected to be familiar with the 802.11 | ||
61 | standard as published by the IEEE in 802.11-2007 (or | ||
62 | possibly later versions). References to this standard | ||
63 | will be given as "802.11-2007 8.1.5". | ||
64 | </para> | ||
65 | </abstract> | ||
66 | </setinfo> | ||
67 | <book id="cfg80211-developers-guide"> | ||
68 | <bookinfo> | ||
69 | <title>The cfg80211 subsystem</title> | ||
70 | |||
71 | <abstract> | ||
72 | !Pinclude/net/cfg80211.h Introduction | ||
73 | </abstract> | ||
74 | </bookinfo> | ||
75 | <chapter> | ||
76 | <title>Device registration</title> | ||
77 | !Pinclude/net/cfg80211.h Device registration | ||
78 | !Finclude/net/cfg80211.h ieee80211_band | ||
79 | !Finclude/net/cfg80211.h ieee80211_channel_flags | ||
80 | !Finclude/net/cfg80211.h ieee80211_channel | ||
81 | !Finclude/net/cfg80211.h ieee80211_rate_flags | ||
82 | !Finclude/net/cfg80211.h ieee80211_rate | ||
83 | !Finclude/net/cfg80211.h ieee80211_sta_ht_cap | ||
84 | !Finclude/net/cfg80211.h ieee80211_supported_band | ||
85 | !Finclude/net/cfg80211.h cfg80211_signal_type | ||
86 | !Finclude/net/cfg80211.h wiphy_params_flags | ||
87 | !Finclude/net/cfg80211.h wiphy_flags | ||
88 | !Finclude/net/cfg80211.h wiphy | ||
89 | !Finclude/net/cfg80211.h wireless_dev | ||
90 | !Finclude/net/cfg80211.h wiphy_new | ||
91 | !Finclude/net/cfg80211.h wiphy_register | ||
92 | !Finclude/net/cfg80211.h wiphy_unregister | ||
93 | !Finclude/net/cfg80211.h wiphy_free | ||
94 | |||
95 | !Finclude/net/cfg80211.h wiphy_name | ||
96 | !Finclude/net/cfg80211.h wiphy_dev | ||
97 | !Finclude/net/cfg80211.h wiphy_priv | ||
98 | !Finclude/net/cfg80211.h priv_to_wiphy | ||
99 | !Finclude/net/cfg80211.h set_wiphy_dev | ||
100 | !Finclude/net/cfg80211.h wdev_priv | ||
101 | </chapter> | ||
102 | <chapter> | ||
103 | <title>Actions and configuration</title> | ||
104 | !Pinclude/net/cfg80211.h Actions and configuration | ||
105 | !Finclude/net/cfg80211.h cfg80211_ops | ||
106 | !Finclude/net/cfg80211.h vif_params | ||
107 | !Finclude/net/cfg80211.h key_params | ||
108 | !Finclude/net/cfg80211.h survey_info_flags | ||
109 | !Finclude/net/cfg80211.h survey_info | ||
110 | !Finclude/net/cfg80211.h beacon_parameters | ||
111 | !Finclude/net/cfg80211.h plink_actions | ||
112 | !Finclude/net/cfg80211.h station_parameters | ||
113 | !Finclude/net/cfg80211.h station_info_flags | ||
114 | !Finclude/net/cfg80211.h rate_info_flags | ||
115 | !Finclude/net/cfg80211.h rate_info | ||
116 | !Finclude/net/cfg80211.h station_info | ||
117 | !Finclude/net/cfg80211.h monitor_flags | ||
118 | !Finclude/net/cfg80211.h mpath_info_flags | ||
119 | !Finclude/net/cfg80211.h mpath_info | ||
120 | !Finclude/net/cfg80211.h bss_parameters | ||
121 | !Finclude/net/cfg80211.h ieee80211_txq_params | ||
122 | !Finclude/net/cfg80211.h cfg80211_crypto_settings | ||
123 | !Finclude/net/cfg80211.h cfg80211_auth_request | ||
124 | !Finclude/net/cfg80211.h cfg80211_assoc_request | ||
125 | !Finclude/net/cfg80211.h cfg80211_deauth_request | ||
126 | !Finclude/net/cfg80211.h cfg80211_disassoc_request | ||
127 | !Finclude/net/cfg80211.h cfg80211_ibss_params | ||
128 | !Finclude/net/cfg80211.h cfg80211_connect_params | ||
129 | !Finclude/net/cfg80211.h cfg80211_pmksa | ||
130 | !Finclude/net/cfg80211.h cfg80211_send_rx_auth | ||
131 | !Finclude/net/cfg80211.h cfg80211_send_auth_timeout | ||
132 | !Finclude/net/cfg80211.h __cfg80211_auth_canceled | ||
133 | !Finclude/net/cfg80211.h cfg80211_send_rx_assoc | ||
134 | !Finclude/net/cfg80211.h cfg80211_send_assoc_timeout | ||
135 | !Finclude/net/cfg80211.h cfg80211_send_deauth | ||
136 | !Finclude/net/cfg80211.h __cfg80211_send_deauth | ||
137 | !Finclude/net/cfg80211.h cfg80211_send_disassoc | ||
138 | !Finclude/net/cfg80211.h __cfg80211_send_disassoc | ||
139 | !Finclude/net/cfg80211.h cfg80211_ibss_joined | ||
140 | !Finclude/net/cfg80211.h cfg80211_connect_result | ||
141 | !Finclude/net/cfg80211.h cfg80211_roamed | ||
142 | !Finclude/net/cfg80211.h cfg80211_disconnected | ||
143 | !Finclude/net/cfg80211.h cfg80211_ready_on_channel | ||
144 | !Finclude/net/cfg80211.h cfg80211_remain_on_channel_expired | ||
145 | !Finclude/net/cfg80211.h cfg80211_new_sta | ||
146 | !Finclude/net/cfg80211.h cfg80211_rx_mgmt | ||
147 | !Finclude/net/cfg80211.h cfg80211_mgmt_tx_status | ||
148 | !Finclude/net/cfg80211.h cfg80211_cqm_rssi_notify | ||
149 | !Finclude/net/cfg80211.h cfg80211_michael_mic_failure | ||
150 | </chapter> | ||
151 | <chapter> | ||
152 | <title>Scanning and BSS list handling</title> | ||
153 | !Pinclude/net/cfg80211.h Scanning and BSS list handling | ||
154 | !Finclude/net/cfg80211.h cfg80211_ssid | ||
155 | !Finclude/net/cfg80211.h cfg80211_scan_request | ||
156 | !Finclude/net/cfg80211.h cfg80211_scan_done | ||
157 | !Finclude/net/cfg80211.h cfg80211_bss | ||
158 | !Finclude/net/cfg80211.h cfg80211_inform_bss_frame | ||
159 | !Finclude/net/cfg80211.h cfg80211_inform_bss | ||
160 | !Finclude/net/cfg80211.h cfg80211_unlink_bss | ||
161 | !Finclude/net/cfg80211.h cfg80211_find_ie | ||
162 | !Finclude/net/cfg80211.h ieee80211_bss_get_ie | ||
163 | </chapter> | ||
164 | <chapter> | ||
165 | <title>Utility functions</title> | ||
166 | !Pinclude/net/cfg80211.h Utility functions | ||
167 | !Finclude/net/cfg80211.h ieee80211_channel_to_frequency | ||
168 | !Finclude/net/cfg80211.h ieee80211_frequency_to_channel | ||
169 | !Finclude/net/cfg80211.h ieee80211_get_channel | ||
170 | !Finclude/net/cfg80211.h ieee80211_get_response_rate | ||
171 | !Finclude/net/cfg80211.h ieee80211_hdrlen | ||
172 | !Finclude/net/cfg80211.h ieee80211_get_hdrlen_from_skb | ||
173 | !Finclude/net/cfg80211.h ieee80211_radiotap_iterator | ||
174 | </chapter> | ||
175 | <chapter> | ||
176 | <title>Data path helpers</title> | ||
177 | !Pinclude/net/cfg80211.h Data path helpers | ||
178 | !Finclude/net/cfg80211.h ieee80211_data_to_8023 | ||
179 | !Finclude/net/cfg80211.h ieee80211_data_from_8023 | ||
180 | !Finclude/net/cfg80211.h ieee80211_amsdu_to_8023s | ||
181 | !Finclude/net/cfg80211.h cfg80211_classify8021d | ||
182 | </chapter> | ||
183 | <chapter> | ||
184 | <title>Regulatory enforcement infrastructure</title> | ||
185 | !Pinclude/net/cfg80211.h Regulatory enforcement infrastructure | ||
186 | !Finclude/net/cfg80211.h regulatory_hint | ||
187 | !Finclude/net/cfg80211.h wiphy_apply_custom_regulatory | ||
188 | !Finclude/net/cfg80211.h freq_reg_info | ||
189 | </chapter> | ||
190 | <chapter> | ||
191 | <title>RFkill integration</title> | ||
192 | !Pinclude/net/cfg80211.h RFkill integration | ||
193 | !Finclude/net/cfg80211.h wiphy_rfkill_set_hw_state | ||
194 | !Finclude/net/cfg80211.h wiphy_rfkill_start_polling | ||
195 | !Finclude/net/cfg80211.h wiphy_rfkill_stop_polling | ||
196 | </chapter> | ||
197 | <chapter> | ||
198 | <title>Test mode</title> | ||
199 | !Pinclude/net/cfg80211.h Test mode | ||
200 | !Finclude/net/cfg80211.h cfg80211_testmode_alloc_reply_skb | ||
201 | !Finclude/net/cfg80211.h cfg80211_testmode_reply | ||
202 | !Finclude/net/cfg80211.h cfg80211_testmode_alloc_event_skb | ||
203 | !Finclude/net/cfg80211.h cfg80211_testmode_event | ||
204 | </chapter> | ||
205 | </book> | ||
206 | <book id="mac80211-developers-guide"> | ||
207 | <bookinfo> | ||
208 | <title>The mac80211 subsystem</title> | ||
209 | <abstract> | ||
210 | !Pinclude/net/mac80211.h Introduction | ||
211 | !Pinclude/net/mac80211.h Warning | ||
212 | </abstract> | ||
213 | </bookinfo> | ||
214 | |||
215 | <toc></toc> | ||
216 | |||
217 | <!-- | ||
218 | Generally, this document shall be ordered by increasing complexity. | ||
219 | It is important to note that readers should be able to read only | ||
220 | the first few sections to get a working driver and only advanced | ||
221 | usage should require reading the full document. | ||
222 | --> | ||
223 | |||
224 | <part> | ||
225 | <title>The basic mac80211 driver interface</title> | ||
226 | <partintro> | ||
227 | <para> | ||
228 | You should read and understand the information contained | ||
229 | within this part of the book while implementing a driver. | ||
230 | In some chapters, advanced usage is noted, that may be | ||
231 | skipped at first. | ||
232 | </para> | ||
233 | <para> | ||
234 | This part of the book only covers station and monitor mode | ||
235 | functionality, additional information required to implement | ||
236 | the other modes is covered in the second part of the book. | ||
237 | </para> | ||
238 | </partintro> | ||
239 | |||
240 | <chapter id="basics"> | ||
241 | <title>Basic hardware handling</title> | ||
242 | <para>TBD</para> | ||
243 | <para> | ||
244 | This chapter shall contain information on getting a hw | ||
245 | struct allocated and registered with mac80211. | ||
246 | </para> | ||
247 | <para> | ||
248 | Since it is required to allocate rates/modes before registering | ||
249 | a hw struct, this chapter shall also contain information on setting | ||
250 | up the rate/mode structs. | ||
251 | </para> | ||
252 | <para> | ||
253 | Additionally, some discussion about the callbacks and | ||
254 | the general programming model should be in here, including | ||
255 | the definition of ieee80211_ops which will be referred to | ||
256 | a lot. | ||
257 | </para> | ||
258 | <para> | ||
259 | Finally, a discussion of hardware capabilities should be done | ||
260 | with references to other parts of the book. | ||
261 | </para> | ||
262 | <!-- intentionally multiple !F lines to get proper order --> | ||
263 | !Finclude/net/mac80211.h ieee80211_hw | ||
264 | !Finclude/net/mac80211.h ieee80211_hw_flags | ||
265 | !Finclude/net/mac80211.h SET_IEEE80211_DEV | ||
266 | !Finclude/net/mac80211.h SET_IEEE80211_PERM_ADDR | ||
267 | !Finclude/net/mac80211.h ieee80211_ops | ||
268 | !Finclude/net/mac80211.h ieee80211_alloc_hw | ||
269 | !Finclude/net/mac80211.h ieee80211_register_hw | ||
270 | !Finclude/net/mac80211.h ieee80211_get_tx_led_name | ||
271 | !Finclude/net/mac80211.h ieee80211_get_rx_led_name | ||
272 | !Finclude/net/mac80211.h ieee80211_get_assoc_led_name | ||
273 | !Finclude/net/mac80211.h ieee80211_get_radio_led_name | ||
274 | !Finclude/net/mac80211.h ieee80211_unregister_hw | ||
275 | !Finclude/net/mac80211.h ieee80211_free_hw | ||
276 | </chapter> | ||
277 | |||
278 | <chapter id="phy-handling"> | ||
279 | <title>PHY configuration</title> | ||
280 | <para>TBD</para> | ||
281 | <para> | ||
282 | This chapter should describe PHY handling including | ||
283 | start/stop callbacks and the various structures used. | ||
284 | </para> | ||
285 | !Finclude/net/mac80211.h ieee80211_conf | ||
286 | !Finclude/net/mac80211.h ieee80211_conf_flags | ||
287 | </chapter> | ||
288 | |||
289 | <chapter id="iface-handling"> | ||
290 | <title>Virtual interfaces</title> | ||
291 | <para>TBD</para> | ||
292 | <para> | ||
293 | This chapter should describe virtual interface basics | ||
294 | that are relevant to the driver (VLANs, MGMT etc are not.) | ||
295 | It should explain the use of the add_iface/remove_iface | ||
296 | callbacks as well as the interface configuration callbacks. | ||
297 | </para> | ||
298 | <para>Things related to AP mode should be discussed there.</para> | ||
299 | <para> | ||
300 | Things related to supporting multiple interfaces should be | ||
301 | in the appropriate chapter, a BIG FAT note should be here about | ||
302 | this though and the recommendation to allow only a single | ||
303 | interface in STA mode at first! | ||
304 | </para> | ||
305 | !Finclude/net/mac80211.h ieee80211_vif | ||
306 | </chapter> | ||
307 | |||
308 | <chapter id="rx-tx"> | ||
309 | <title>Receive and transmit processing</title> | ||
310 | <sect1> | ||
311 | <title>what should be here</title> | ||
312 | <para>TBD</para> | ||
313 | <para> | ||
314 | This should describe the receive and transmit | ||
315 | paths in mac80211/the drivers as well as | ||
316 | transmit status handling. | ||
317 | </para> | ||
318 | </sect1> | ||
319 | <sect1> | ||
320 | <title>Frame format</title> | ||
321 | !Pinclude/net/mac80211.h Frame format | ||
322 | </sect1> | ||
323 | <sect1> | ||
324 | <title>Packet alignment</title> | ||
325 | !Pnet/mac80211/rx.c Packet alignment | ||
326 | </sect1> | ||
327 | <sect1> | ||
328 | <title>Calling into mac80211 from interrupts</title> | ||
329 | !Pinclude/net/mac80211.h Calling mac80211 from interrupts | ||
330 | </sect1> | ||
331 | <sect1> | ||
332 | <title>functions/definitions</title> | ||
333 | !Finclude/net/mac80211.h ieee80211_rx_status | ||
334 | !Finclude/net/mac80211.h mac80211_rx_flags | ||
335 | !Finclude/net/mac80211.h ieee80211_tx_info | ||
336 | !Finclude/net/mac80211.h ieee80211_rx | ||
337 | !Finclude/net/mac80211.h ieee80211_rx_irqsafe | ||
338 | !Finclude/net/mac80211.h ieee80211_tx_status | ||
339 | !Finclude/net/mac80211.h ieee80211_tx_status_irqsafe | ||
340 | !Finclude/net/mac80211.h ieee80211_rts_get | ||
341 | !Finclude/net/mac80211.h ieee80211_rts_duration | ||
342 | !Finclude/net/mac80211.h ieee80211_ctstoself_get | ||
343 | !Finclude/net/mac80211.h ieee80211_ctstoself_duration | ||
344 | !Finclude/net/mac80211.h ieee80211_generic_frame_duration | ||
345 | !Finclude/net/mac80211.h ieee80211_wake_queue | ||
346 | !Finclude/net/mac80211.h ieee80211_stop_queue | ||
347 | !Finclude/net/mac80211.h ieee80211_wake_queues | ||
348 | !Finclude/net/mac80211.h ieee80211_stop_queues | ||
349 | </sect1> | ||
350 | </chapter> | ||
351 | |||
352 | <chapter id="filters"> | ||
353 | <title>Frame filtering</title> | ||
354 | !Pinclude/net/mac80211.h Frame filtering | ||
355 | !Finclude/net/mac80211.h ieee80211_filter_flags | ||
356 | </chapter> | ||
357 | </part> | ||
358 | |||
359 | <part id="advanced"> | ||
360 | <title>Advanced driver interface</title> | ||
361 | <partintro> | ||
362 | <para> | ||
363 | Information contained within this part of the book is | ||
364 | of interest only for advanced interaction of mac80211 | ||
365 | with drivers to exploit more hardware capabilities and | ||
366 | improve performance. | ||
367 | </para> | ||
368 | </partintro> | ||
369 | |||
370 | <chapter id="hardware-crypto-offload"> | ||
371 | <title>Hardware crypto acceleration</title> | ||
372 | !Pinclude/net/mac80211.h Hardware crypto acceleration | ||
373 | <!-- intentionally multiple !F lines to get proper order --> | ||
374 | !Finclude/net/mac80211.h set_key_cmd | ||
375 | !Finclude/net/mac80211.h ieee80211_key_conf | ||
376 | !Finclude/net/mac80211.h ieee80211_key_flags | ||
377 | </chapter> | ||
378 | |||
379 | <chapter id="powersave"> | ||
380 | <title>Powersave support</title> | ||
381 | !Pinclude/net/mac80211.h Powersave support | ||
382 | </chapter> | ||
383 | |||
384 | <chapter id="beacon-filter"> | ||
385 | <title>Beacon filter support</title> | ||
386 | !Pinclude/net/mac80211.h Beacon filter support | ||
387 | !Finclude/net/mac80211.h ieee80211_beacon_loss | ||
388 | </chapter> | ||
389 | |||
390 | <chapter id="qos"> | ||
391 | <title>Multiple queues and QoS support</title> | ||
392 | <para>TBD</para> | ||
393 | !Finclude/net/mac80211.h ieee80211_tx_queue_params | ||
394 | </chapter> | ||
395 | |||
396 | <chapter id="AP"> | ||
397 | <title>Access point mode support</title> | ||
398 | <para>TBD</para> | ||
399 | <para>Some parts of the if_conf should be discussed here instead</para> | ||
400 | <para> | ||
401 | Insert notes about VLAN interfaces with hw crypto here or | ||
402 | in the hw crypto chapter. | ||
403 | </para> | ||
404 | !Finclude/net/mac80211.h ieee80211_get_buffered_bc | ||
405 | !Finclude/net/mac80211.h ieee80211_beacon_get | ||
406 | </chapter> | ||
407 | |||
408 | <chapter id="multi-iface"> | ||
409 | <title>Supporting multiple virtual interfaces</title> | ||
410 | <para>TBD</para> | ||
411 | <para> | ||
412 | Note: WDS with identical MAC address should almost always be OK | ||
413 | </para> | ||
414 | <para> | ||
415 | Insert notes about having multiple virtual interfaces with | ||
416 | different MAC addresses here, note which configurations are | ||
417 | supported by mac80211, add notes about supporting hw crypto | ||
418 | with it. | ||
419 | </para> | ||
420 | </chapter> | ||
421 | |||
422 | <chapter id="hardware-scan-offload"> | ||
423 | <title>Hardware scan offload</title> | ||
424 | <para>TBD</para> | ||
425 | !Finclude/net/mac80211.h ieee80211_scan_completed | ||
426 | </chapter> | ||
427 | </part> | ||
428 | |||
429 | <part id="rate-control"> | ||
430 | <title>Rate control interface</title> | ||
431 | <partintro> | ||
432 | <para>TBD</para> | ||
433 | <para> | ||
434 | This part of the book describes the rate control algorithm | ||
435 | interface and how it relates to mac80211 and drivers. | ||
436 | </para> | ||
437 | </partintro> | ||
438 | <chapter id="dummy"> | ||
439 | <title>dummy chapter</title> | ||
440 | <para>TBD</para> | ||
441 | </chapter> | ||
442 | </part> | ||
443 | |||
444 | <part id="internal"> | ||
445 | <title>Internals</title> | ||
446 | <partintro> | ||
447 | <para>TBD</para> | ||
448 | <para> | ||
449 | This part of the book describes mac80211 internals. | ||
450 | </para> | ||
451 | </partintro> | ||
452 | |||
453 | <chapter id="key-handling"> | ||
454 | <title>Key handling</title> | ||
455 | <sect1> | ||
456 | <title>Key handling basics</title> | ||
457 | !Pnet/mac80211/key.c Key handling basics | ||
458 | </sect1> | ||
459 | <sect1> | ||
460 | <title>MORE TBD</title> | ||
461 | <para>TBD</para> | ||
462 | </sect1> | ||
463 | </chapter> | ||
464 | |||
465 | <chapter id="rx-processing"> | ||
466 | <title>Receive processing</title> | ||
467 | <para>TBD</para> | ||
468 | </chapter> | ||
469 | |||
470 | <chapter id="tx-processing"> | ||
471 | <title>Transmit processing</title> | ||
472 | <para>TBD</para> | ||
473 | </chapter> | ||
474 | |||
475 | <chapter id="sta-info"> | ||
476 | <title>Station info handling</title> | ||
477 | <sect1> | ||
478 | <title>Programming information</title> | ||
479 | !Fnet/mac80211/sta_info.h sta_info | ||
480 | !Fnet/mac80211/sta_info.h ieee80211_sta_info_flags | ||
481 | </sect1> | ||
482 | <sect1> | ||
483 | <title>STA information lifetime rules</title> | ||
484 | !Pnet/mac80211/sta_info.c STA information lifetime rules | ||
485 | </sect1> | ||
486 | </chapter> | ||
487 | |||
488 | <chapter id="synchronisation"> | ||
489 | <title>Synchronisation</title> | ||
490 | <para>TBD</para> | ||
491 | <para>Locking, lots of RCU</para> | ||
492 | </chapter> | ||
493 | </part> | ||
494 | </book> | ||
495 | </set> | ||
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 34929f24c28..8b6e00a7103 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
@@ -12,7 +12,7 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \ | |||
12 | kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ | 12 | kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ |
13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ | 13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ |
14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ | 14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ |
15 | mac80211.xml debugobjects.xml sh.xml regulator.xml \ | 15 | 80211.xml debugobjects.xml sh.xml regulator.xml \ |
16 | alsa-driver-api.xml writing-an-alsa-driver.xml \ | 16 | alsa-driver-api.xml writing-an-alsa-driver.xml \ |
17 | tracepoint.xml media.xml drm.xml | 17 | tracepoint.xml media.xml drm.xml |
18 | 18 | ||
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index 910c923a9b8..2861055afd7 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl | |||
@@ -136,6 +136,7 @@ | |||
136 | #ifdef CONFIG_COMPAT | 136 | #ifdef CONFIG_COMPAT |
137 | .compat_ioctl = i915_compat_ioctl, | 137 | .compat_ioctl = i915_compat_ioctl, |
138 | #endif | 138 | #endif |
139 | .llseek = noop_llseek, | ||
139 | }, | 140 | }, |
140 | .pci_driver = { | 141 | .pci_driver = { |
141 | .name = DRIVER_NAME, | 142 | .name = DRIVER_NAME, |
diff --git a/Documentation/DocBook/genericirq.tmpl b/Documentation/DocBook/genericirq.tmpl index 1448b33fd22..fb10fd08c05 100644 --- a/Documentation/DocBook/genericirq.tmpl +++ b/Documentation/DocBook/genericirq.tmpl | |||
@@ -28,7 +28,7 @@ | |||
28 | </authorgroup> | 28 | </authorgroup> |
29 | 29 | ||
30 | <copyright> | 30 | <copyright> |
31 | <year>2005-2006</year> | 31 | <year>2005-2010</year> |
32 | <holder>Thomas Gleixner</holder> | 32 | <holder>Thomas Gleixner</holder> |
33 | </copyright> | 33 | </copyright> |
34 | <copyright> | 34 | <copyright> |
@@ -100,6 +100,10 @@ | |||
100 | <listitem><para>Edge type</para></listitem> | 100 | <listitem><para>Edge type</para></listitem> |
101 | <listitem><para>Simple type</para></listitem> | 101 | <listitem><para>Simple type</para></listitem> |
102 | </itemizedlist> | 102 | </itemizedlist> |
103 | During the implementation we identified another type: | ||
104 | <itemizedlist> | ||
105 | <listitem><para>Fast EOI type</para></listitem> | ||
106 | </itemizedlist> | ||
103 | In the SMP world of the __do_IRQ() super-handler another type | 107 | In the SMP world of the __do_IRQ() super-handler another type |
104 | was identified: | 108 | was identified: |
105 | <itemizedlist> | 109 | <itemizedlist> |
@@ -153,6 +157,7 @@ | |||
153 | is still available. This leads to a kind of duality for the time | 157 | is still available. This leads to a kind of duality for the time |
154 | being. Over time the new model should be used in more and more | 158 | being. Over time the new model should be used in more and more |
155 | architectures, as it enables smaller and cleaner IRQ subsystems. | 159 | architectures, as it enables smaller and cleaner IRQ subsystems. |
160 | It's deprecated for three years now and about to be removed. | ||
156 | </para> | 161 | </para> |
157 | </chapter> | 162 | </chapter> |
158 | <chapter id="bugs"> | 163 | <chapter id="bugs"> |
@@ -217,6 +222,7 @@ | |||
217 | <itemizedlist> | 222 | <itemizedlist> |
218 | <listitem><para>handle_level_irq</para></listitem> | 223 | <listitem><para>handle_level_irq</para></listitem> |
219 | <listitem><para>handle_edge_irq</para></listitem> | 224 | <listitem><para>handle_edge_irq</para></listitem> |
225 | <listitem><para>handle_fasteoi_irq</para></listitem> | ||
220 | <listitem><para>handle_simple_irq</para></listitem> | 226 | <listitem><para>handle_simple_irq</para></listitem> |
221 | <listitem><para>handle_percpu_irq</para></listitem> | 227 | <listitem><para>handle_percpu_irq</para></listitem> |
222 | </itemizedlist> | 228 | </itemizedlist> |
@@ -233,33 +239,33 @@ | |||
233 | are used by the default flow implementations. | 239 | are used by the default flow implementations. |
234 | The following helper functions are implemented (simplified excerpt): | 240 | The following helper functions are implemented (simplified excerpt): |
235 | <programlisting> | 241 | <programlisting> |
236 | default_enable(irq) | 242 | default_enable(struct irq_data *data) |
237 | { | 243 | { |
238 | desc->chip->unmask(irq); | 244 | desc->chip->irq_unmask(data); |
239 | } | 245 | } |
240 | 246 | ||
241 | default_disable(irq) | 247 | default_disable(struct irq_data *data) |
242 | { | 248 | { |
243 | if (!delay_disable(irq)) | 249 | if (!delay_disable(data)) |
244 | desc->chip->mask(irq); | 250 | desc->chip->irq_mask(data); |
245 | } | 251 | } |
246 | 252 | ||
247 | default_ack(irq) | 253 | default_ack(struct irq_data *data) |
248 | { | 254 | { |
249 | chip->ack(irq); | 255 | chip->irq_ack(data); |
250 | } | 256 | } |
251 | 257 | ||
252 | default_mask_ack(irq) | 258 | default_mask_ack(struct irq_data *data) |
253 | { | 259 | { |
254 | if (chip->mask_ack) { | 260 | if (chip->irq_mask_ack) { |
255 | chip->mask_ack(irq); | 261 | chip->irq_mask_ack(data); |
256 | } else { | 262 | } else { |
257 | chip->mask(irq); | 263 | chip->irq_mask(data); |
258 | chip->ack(irq); | 264 | chip->irq_ack(data); |
259 | } | 265 | } |
260 | } | 266 | } |
261 | 267 | ||
262 | noop(irq) | 268 | noop(struct irq_data *data)) |
263 | { | 269 | { |
264 | } | 270 | } |
265 | 271 | ||
@@ -278,12 +284,27 @@ noop(irq) | |||
278 | <para> | 284 | <para> |
279 | The following control flow is implemented (simplified excerpt): | 285 | The following control flow is implemented (simplified excerpt): |
280 | <programlisting> | 286 | <programlisting> |
281 | desc->chip->start(); | 287 | desc->chip->irq_mask(); |
282 | handle_IRQ_event(desc->action); | 288 | handle_IRQ_event(desc->action); |
283 | desc->chip->end(); | 289 | desc->chip->irq_unmask(); |
284 | </programlisting> | 290 | </programlisting> |
285 | </para> | 291 | </para> |
286 | </sect3> | 292 | </sect3> |
293 | <sect3 id="Default_FASTEOI_IRQ_flow_handler"> | ||
294 | <title>Default Fast EOI IRQ flow handler</title> | ||
295 | <para> | ||
296 | handle_fasteoi_irq provides a generic implementation | ||
297 | for interrupts, which only need an EOI at the end of | ||
298 | the handler | ||
299 | </para> | ||
300 | <para> | ||
301 | The following control flow is implemented (simplified excerpt): | ||
302 | <programlisting> | ||
303 | handle_IRQ_event(desc->action); | ||
304 | desc->chip->irq_eoi(); | ||
305 | </programlisting> | ||
306 | </para> | ||
307 | </sect3> | ||
287 | <sect3 id="Default_Edge_IRQ_flow_handler"> | 308 | <sect3 id="Default_Edge_IRQ_flow_handler"> |
288 | <title>Default Edge IRQ flow handler</title> | 309 | <title>Default Edge IRQ flow handler</title> |
289 | <para> | 310 | <para> |
@@ -294,20 +315,19 @@ desc->chip->end(); | |||
294 | The following control flow is implemented (simplified excerpt): | 315 | The following control flow is implemented (simplified excerpt): |
295 | <programlisting> | 316 | <programlisting> |
296 | if (desc->status & running) { | 317 | if (desc->status & running) { |
297 | desc->chip->hold(); | 318 | desc->chip->irq_mask(); |
298 | desc->status |= pending | masked; | 319 | desc->status |= pending | masked; |
299 | return; | 320 | return; |
300 | } | 321 | } |
301 | desc->chip->start(); | 322 | desc->chip->irq_ack(); |
302 | desc->status |= running; | 323 | desc->status |= running; |
303 | do { | 324 | do { |
304 | if (desc->status & masked) | 325 | if (desc->status & masked) |
305 | desc->chip->enable(); | 326 | desc->chip->irq_unmask(); |
306 | desc->status &= ~pending; | 327 | desc->status &= ~pending; |
307 | handle_IRQ_event(desc->action); | 328 | handle_IRQ_event(desc->action); |
308 | } while (status & pending); | 329 | } while (status & pending); |
309 | desc->status &= ~running; | 330 | desc->status &= ~running; |
310 | desc->chip->end(); | ||
311 | </programlisting> | 331 | </programlisting> |
312 | </para> | 332 | </para> |
313 | </sect3> | 333 | </sect3> |
@@ -342,9 +362,9 @@ handle_IRQ_event(desc->action); | |||
342 | <para> | 362 | <para> |
343 | The following control flow is implemented (simplified excerpt): | 363 | The following control flow is implemented (simplified excerpt): |
344 | <programlisting> | 364 | <programlisting> |
345 | desc->chip->start(); | ||
346 | handle_IRQ_event(desc->action); | 365 | handle_IRQ_event(desc->action); |
347 | desc->chip->end(); | 366 | if (desc->chip->irq_eoi) |
367 | desc->chip->irq_eoi(); | ||
348 | </programlisting> | 368 | </programlisting> |
349 | </para> | 369 | </para> |
350 | </sect3> | 370 | </sect3> |
@@ -375,8 +395,7 @@ desc->chip->end(); | |||
375 | mechanism. (It's necessary to enable CONFIG_HARDIRQS_SW_RESEND when | 395 | mechanism. (It's necessary to enable CONFIG_HARDIRQS_SW_RESEND when |
376 | you want to use the delayed interrupt disable feature and your | 396 | you want to use the delayed interrupt disable feature and your |
377 | hardware is not capable of retriggering an interrupt.) | 397 | hardware is not capable of retriggering an interrupt.) |
378 | The delayed interrupt disable can be runtime enabled, per interrupt, | 398 | The delayed interrupt disable is not configurable. |
379 | by setting the IRQ_DELAYED_DISABLE flag in the irq_desc status field. | ||
380 | </para> | 399 | </para> |
381 | </sect2> | 400 | </sect2> |
382 | </sect1> | 401 | </sect1> |
@@ -387,13 +406,13 @@ desc->chip->end(); | |||
387 | contains all the direct chip relevant functions, which | 406 | contains all the direct chip relevant functions, which |
388 | can be utilized by the irq flow implementations. | 407 | can be utilized by the irq flow implementations. |
389 | <itemizedlist> | 408 | <itemizedlist> |
390 | <listitem><para>ack()</para></listitem> | 409 | <listitem><para>irq_ack()</para></listitem> |
391 | <listitem><para>mask_ack() - Optional, recommended for performance</para></listitem> | 410 | <listitem><para>irq_mask_ack() - Optional, recommended for performance</para></listitem> |
392 | <listitem><para>mask()</para></listitem> | 411 | <listitem><para>irq_mask()</para></listitem> |
393 | <listitem><para>unmask()</para></listitem> | 412 | <listitem><para>irq_unmask()</para></listitem> |
394 | <listitem><para>retrigger() - Optional</para></listitem> | 413 | <listitem><para>irq_retrigger() - Optional</para></listitem> |
395 | <listitem><para>set_type() - Optional</para></listitem> | 414 | <listitem><para>irq_set_type() - Optional</para></listitem> |
396 | <listitem><para>set_wake() - Optional</para></listitem> | 415 | <listitem><para>irq_set_wake() - Optional</para></listitem> |
397 | </itemizedlist> | 416 | </itemizedlist> |
398 | These primitives are strictly intended to mean what they say: ack means | 417 | These primitives are strictly intended to mean what they say: ack means |
399 | ACK, masking means masking of an IRQ line, etc. It is up to the flow | 418 | ACK, masking means masking of an IRQ line, etc. It is up to the flow |
@@ -458,6 +477,7 @@ desc->chip->end(); | |||
458 | <para> | 477 | <para> |
459 | This chapter contains the autogenerated documentation of the internal functions. | 478 | This chapter contains the autogenerated documentation of the internal functions. |
460 | </para> | 479 | </para> |
480 | !Ikernel/irq/irqdesc.c | ||
461 | !Ikernel/irq/handle.c | 481 | !Ikernel/irq/handle.c |
462 | !Ikernel/irq/chip.c | 482 | !Ikernel/irq/chip.c |
463 | </chapter> | 483 | </chapter> |
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index 6899f471fb1..6b4e07f28b6 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl | |||
@@ -257,7 +257,8 @@ X!Earch/x86/kernel/mca_32.c | |||
257 | !Iblock/blk-sysfs.c | 257 | !Iblock/blk-sysfs.c |
258 | !Eblock/blk-settings.c | 258 | !Eblock/blk-settings.c |
259 | !Eblock/blk-exec.c | 259 | !Eblock/blk-exec.c |
260 | !Eblock/blk-barrier.c | 260 | !Eblock/blk-flush.c |
261 | !Eblock/blk-lib.c | ||
261 | !Eblock/blk-tag.c | 262 | !Eblock/blk-tag.c |
262 | !Iblock/blk-tag.c | 263 | !Iblock/blk-tag.c |
263 | !Eblock/blk-integrity.c | 264 | !Eblock/blk-integrity.c |
diff --git a/Documentation/DocBook/kernel-locking.tmpl b/Documentation/DocBook/kernel-locking.tmpl index a0d479d1e1d..f66f4df1869 100644 --- a/Documentation/DocBook/kernel-locking.tmpl +++ b/Documentation/DocBook/kernel-locking.tmpl | |||
@@ -1645,7 +1645,9 @@ the amount of locking which needs to be done. | |||
1645 | all the readers who were traversing the list when we deleted the | 1645 | all the readers who were traversing the list when we deleted the |
1646 | element are finished. We use <function>call_rcu()</function> to | 1646 | element are finished. We use <function>call_rcu()</function> to |
1647 | register a callback which will actually destroy the object once | 1647 | register a callback which will actually destroy the object once |
1648 | the readers are finished. | 1648 | all pre-existing readers are finished. Alternatively, |
1649 | <function>synchronize_rcu()</function> may be used to block until | ||
1650 | all pre-existing are finished. | ||
1649 | </para> | 1651 | </para> |
1650 | <para> | 1652 | <para> |
1651 | But how does Read Copy Update know when the readers are | 1653 | But how does Read Copy Update know when the readers are |
@@ -1714,7 +1716,7 @@ the amount of locking which needs to be done. | |||
1714 | - object_put(obj); | 1716 | - object_put(obj); |
1715 | + list_del_rcu(&obj->list); | 1717 | + list_del_rcu(&obj->list); |
1716 | cache_num--; | 1718 | cache_num--; |
1717 | + call_rcu(&obj->rcu, cache_delete_rcu, obj); | 1719 | + call_rcu(&obj->rcu, cache_delete_rcu); |
1718 | } | 1720 | } |
1719 | 1721 | ||
1720 | /* Must be holding cache_lock */ | 1722 | /* Must be holding cache_lock */ |
@@ -1725,14 +1727,6 @@ the amount of locking which needs to be done. | |||
1725 | if (++cache_num > MAX_CACHE_SIZE) { | 1727 | if (++cache_num > MAX_CACHE_SIZE) { |
1726 | struct object *i, *outcast = NULL; | 1728 | struct object *i, *outcast = NULL; |
1727 | list_for_each_entry(i, &cache, list) { | 1729 | list_for_each_entry(i, &cache, list) { |
1728 | @@ -85,6 +94,7 @@ | ||
1729 | obj->popularity = 0; | ||
1730 | atomic_set(&obj->refcnt, 1); /* The cache holds a reference */ | ||
1731 | spin_lock_init(&obj->lock); | ||
1732 | + INIT_RCU_HEAD(&obj->rcu); | ||
1733 | |||
1734 | spin_lock_irqsave(&cache_lock, flags); | ||
1735 | __cache_add(obj); | ||
1736 | @@ -104,12 +114,11 @@ | 1730 | @@ -104,12 +114,11 @@ |
1737 | struct object *cache_find(int id) | 1731 | struct object *cache_find(int id) |
1738 | { | 1732 | { |
diff --git a/Documentation/DocBook/mac80211.tmpl b/Documentation/DocBook/mac80211.tmpl deleted file mode 100644 index affb15a344a..00000000000 --- a/Documentation/DocBook/mac80211.tmpl +++ /dev/null | |||
@@ -1,337 +0,0 @@ | |||
1 | <?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-2009</year> | ||
21 | <holder>Johannes Berg</holder> | ||
22 | </copyright> | ||
23 | |||
24 | <legalnotice> | ||
25 | <para> | ||
26 | This documentation is free software; you can redistribute | ||
27 | it and/or modify it under the terms of the GNU General Public | ||
28 | License version 2 as published by the Free Software Foundation. | ||
29 | </para> | ||
30 | |||
31 | <para> | ||
32 | This documentation is distributed in the hope that it will be | ||
33 | useful, but WITHOUT ANY WARRANTY; without even the implied | ||
34 | warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
35 | See the GNU General Public License for more details. | ||
36 | </para> | ||
37 | |||
38 | <para> | ||
39 | You should have received a copy of the GNU General Public | ||
40 | License along with this documentation; if not, write to the Free | ||
41 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, | ||
42 | MA 02111-1307 USA | ||
43 | </para> | ||
44 | |||
45 | <para> | ||
46 | For more details see the file COPYING in the source | ||
47 | distribution of Linux. | ||
48 | </para> | ||
49 | </legalnotice> | ||
50 | |||
51 | <abstract> | ||
52 | !Pinclude/net/mac80211.h Introduction | ||
53 | !Pinclude/net/mac80211.h Warning | ||
54 | </abstract> | ||
55 | </bookinfo> | ||
56 | |||
57 | <toc></toc> | ||
58 | |||
59 | <!-- | ||
60 | Generally, this document shall be ordered by increasing complexity. | ||
61 | It is important to note that readers should be able to read only | ||
62 | the first few sections to get a working driver and only advanced | ||
63 | usage should require reading the full document. | ||
64 | --> | ||
65 | |||
66 | <part> | ||
67 | <title>The basic mac80211 driver interface</title> | ||
68 | <partintro> | ||
69 | <para> | ||
70 | You should read and understand the information contained | ||
71 | within this part of the book while implementing a driver. | ||
72 | In some chapters, advanced usage is noted, that may be | ||
73 | skipped at first. | ||
74 | </para> | ||
75 | <para> | ||
76 | This part of the book only covers station and monitor mode | ||
77 | functionality, additional information required to implement | ||
78 | the other modes is covered in the second part of the book. | ||
79 | </para> | ||
80 | </partintro> | ||
81 | |||
82 | <chapter id="basics"> | ||
83 | <title>Basic hardware handling</title> | ||
84 | <para>TBD</para> | ||
85 | <para> | ||
86 | This chapter shall contain information on getting a hw | ||
87 | struct allocated and registered with mac80211. | ||
88 | </para> | ||
89 | <para> | ||
90 | Since it is required to allocate rates/modes before registering | ||
91 | a hw struct, this chapter shall also contain information on setting | ||
92 | up the rate/mode structs. | ||
93 | </para> | ||
94 | <para> | ||
95 | Additionally, some discussion about the callbacks and | ||
96 | the general programming model should be in here, including | ||
97 | the definition of ieee80211_ops which will be referred to | ||
98 | a lot. | ||
99 | </para> | ||
100 | <para> | ||
101 | Finally, a discussion of hardware capabilities should be done | ||
102 | with references to other parts of the book. | ||
103 | </para> | ||
104 | <!-- intentionally multiple !F lines to get proper order --> | ||
105 | !Finclude/net/mac80211.h ieee80211_hw | ||
106 | !Finclude/net/mac80211.h ieee80211_hw_flags | ||
107 | !Finclude/net/mac80211.h SET_IEEE80211_DEV | ||
108 | !Finclude/net/mac80211.h SET_IEEE80211_PERM_ADDR | ||
109 | !Finclude/net/mac80211.h ieee80211_ops | ||
110 | !Finclude/net/mac80211.h ieee80211_alloc_hw | ||
111 | !Finclude/net/mac80211.h ieee80211_register_hw | ||
112 | !Finclude/net/mac80211.h ieee80211_get_tx_led_name | ||
113 | !Finclude/net/mac80211.h ieee80211_get_rx_led_name | ||
114 | !Finclude/net/mac80211.h ieee80211_get_assoc_led_name | ||
115 | !Finclude/net/mac80211.h ieee80211_get_radio_led_name | ||
116 | !Finclude/net/mac80211.h ieee80211_unregister_hw | ||
117 | !Finclude/net/mac80211.h ieee80211_free_hw | ||
118 | </chapter> | ||
119 | |||
120 | <chapter id="phy-handling"> | ||
121 | <title>PHY configuration</title> | ||
122 | <para>TBD</para> | ||
123 | <para> | ||
124 | This chapter should describe PHY handling including | ||
125 | start/stop callbacks and the various structures used. | ||
126 | </para> | ||
127 | !Finclude/net/mac80211.h ieee80211_conf | ||
128 | !Finclude/net/mac80211.h ieee80211_conf_flags | ||
129 | </chapter> | ||
130 | |||
131 | <chapter id="iface-handling"> | ||
132 | <title>Virtual interfaces</title> | ||
133 | <para>TBD</para> | ||
134 | <para> | ||
135 | This chapter should describe virtual interface basics | ||
136 | that are relevant to the driver (VLANs, MGMT etc are not.) | ||
137 | It should explain the use of the add_iface/remove_iface | ||
138 | callbacks as well as the interface configuration callbacks. | ||
139 | </para> | ||
140 | <para>Things related to AP mode should be discussed there.</para> | ||
141 | <para> | ||
142 | Things related to supporting multiple interfaces should be | ||
143 | in the appropriate chapter, a BIG FAT note should be here about | ||
144 | this though and the recommendation to allow only a single | ||
145 | interface in STA mode at first! | ||
146 | </para> | ||
147 | !Finclude/net/mac80211.h ieee80211_vif | ||
148 | </chapter> | ||
149 | |||
150 | <chapter id="rx-tx"> | ||
151 | <title>Receive and transmit processing</title> | ||
152 | <sect1> | ||
153 | <title>what should be here</title> | ||
154 | <para>TBD</para> | ||
155 | <para> | ||
156 | This should describe the receive and transmit | ||
157 | paths in mac80211/the drivers as well as | ||
158 | transmit status handling. | ||
159 | </para> | ||
160 | </sect1> | ||
161 | <sect1> | ||
162 | <title>Frame format</title> | ||
163 | !Pinclude/net/mac80211.h Frame format | ||
164 | </sect1> | ||
165 | <sect1> | ||
166 | <title>Packet alignment</title> | ||
167 | !Pnet/mac80211/rx.c Packet alignment | ||
168 | </sect1> | ||
169 | <sect1> | ||
170 | <title>Calling into mac80211 from interrupts</title> | ||
171 | !Pinclude/net/mac80211.h Calling mac80211 from interrupts | ||
172 | </sect1> | ||
173 | <sect1> | ||
174 | <title>functions/definitions</title> | ||
175 | !Finclude/net/mac80211.h ieee80211_rx_status | ||
176 | !Finclude/net/mac80211.h mac80211_rx_flags | ||
177 | !Finclude/net/mac80211.h ieee80211_tx_info | ||
178 | !Finclude/net/mac80211.h ieee80211_rx | ||
179 | !Finclude/net/mac80211.h ieee80211_rx_irqsafe | ||
180 | !Finclude/net/mac80211.h ieee80211_tx_status | ||
181 | !Finclude/net/mac80211.h ieee80211_tx_status_irqsafe | ||
182 | !Finclude/net/mac80211.h ieee80211_rts_get | ||
183 | !Finclude/net/mac80211.h ieee80211_rts_duration | ||
184 | !Finclude/net/mac80211.h ieee80211_ctstoself_get | ||
185 | !Finclude/net/mac80211.h ieee80211_ctstoself_duration | ||
186 | !Finclude/net/mac80211.h ieee80211_generic_frame_duration | ||
187 | !Finclude/net/mac80211.h ieee80211_wake_queue | ||
188 | !Finclude/net/mac80211.h ieee80211_stop_queue | ||
189 | !Finclude/net/mac80211.h ieee80211_wake_queues | ||
190 | !Finclude/net/mac80211.h ieee80211_stop_queues | ||
191 | </sect1> | ||
192 | </chapter> | ||
193 | |||
194 | <chapter id="filters"> | ||
195 | <title>Frame filtering</title> | ||
196 | !Pinclude/net/mac80211.h Frame filtering | ||
197 | !Finclude/net/mac80211.h ieee80211_filter_flags | ||
198 | </chapter> | ||
199 | </part> | ||
200 | |||
201 | <part id="advanced"> | ||
202 | <title>Advanced driver interface</title> | ||
203 | <partintro> | ||
204 | <para> | ||
205 | Information contained within this part of the book is | ||
206 | of interest only for advanced interaction of mac80211 | ||
207 | with drivers to exploit more hardware capabilities and | ||
208 | improve performance. | ||
209 | </para> | ||
210 | </partintro> | ||
211 | |||
212 | <chapter id="hardware-crypto-offload"> | ||
213 | <title>Hardware crypto acceleration</title> | ||
214 | !Pinclude/net/mac80211.h Hardware crypto acceleration | ||
215 | <!-- intentionally multiple !F lines to get proper order --> | ||
216 | !Finclude/net/mac80211.h set_key_cmd | ||
217 | !Finclude/net/mac80211.h ieee80211_key_conf | ||
218 | !Finclude/net/mac80211.h ieee80211_key_alg | ||
219 | !Finclude/net/mac80211.h ieee80211_key_flags | ||
220 | </chapter> | ||
221 | |||
222 | <chapter id="powersave"> | ||
223 | <title>Powersave support</title> | ||
224 | !Pinclude/net/mac80211.h Powersave support | ||
225 | </chapter> | ||
226 | |||
227 | <chapter id="beacon-filter"> | ||
228 | <title>Beacon filter support</title> | ||
229 | !Pinclude/net/mac80211.h Beacon filter support | ||
230 | !Finclude/net/mac80211.h ieee80211_beacon_loss | ||
231 | </chapter> | ||
232 | |||
233 | <chapter id="qos"> | ||
234 | <title>Multiple queues and QoS support</title> | ||
235 | <para>TBD</para> | ||
236 | !Finclude/net/mac80211.h ieee80211_tx_queue_params | ||
237 | </chapter> | ||
238 | |||
239 | <chapter id="AP"> | ||
240 | <title>Access point mode support</title> | ||
241 | <para>TBD</para> | ||
242 | <para>Some parts of the if_conf should be discussed here instead</para> | ||
243 | <para> | ||
244 | Insert notes about VLAN interfaces with hw crypto here or | ||
245 | in the hw crypto chapter. | ||
246 | </para> | ||
247 | !Finclude/net/mac80211.h ieee80211_get_buffered_bc | ||
248 | !Finclude/net/mac80211.h ieee80211_beacon_get | ||
249 | </chapter> | ||
250 | |||
251 | <chapter id="multi-iface"> | ||
252 | <title>Supporting multiple virtual interfaces</title> | ||
253 | <para>TBD</para> | ||
254 | <para> | ||
255 | Note: WDS with identical MAC address should almost always be OK | ||
256 | </para> | ||
257 | <para> | ||
258 | Insert notes about having multiple virtual interfaces with | ||
259 | different MAC addresses here, note which configurations are | ||
260 | supported by mac80211, add notes about supporting hw crypto | ||
261 | with it. | ||
262 | </para> | ||
263 | </chapter> | ||
264 | |||
265 | <chapter id="hardware-scan-offload"> | ||
266 | <title>Hardware scan offload</title> | ||
267 | <para>TBD</para> | ||
268 | !Finclude/net/mac80211.h ieee80211_scan_completed | ||
269 | </chapter> | ||
270 | </part> | ||
271 | |||
272 | <part id="rate-control"> | ||
273 | <title>Rate control interface</title> | ||
274 | <partintro> | ||
275 | <para>TBD</para> | ||
276 | <para> | ||
277 | This part of the book describes the rate control algorithm | ||
278 | interface and how it relates to mac80211 and drivers. | ||
279 | </para> | ||
280 | </partintro> | ||
281 | <chapter id="dummy"> | ||
282 | <title>dummy chapter</title> | ||
283 | <para>TBD</para> | ||
284 | </chapter> | ||
285 | </part> | ||
286 | |||
287 | <part id="internal"> | ||
288 | <title>Internals</title> | ||
289 | <partintro> | ||
290 | <para>TBD</para> | ||
291 | <para> | ||
292 | This part of the book describes mac80211 internals. | ||
293 | </para> | ||
294 | </partintro> | ||
295 | |||
296 | <chapter id="key-handling"> | ||
297 | <title>Key handling</title> | ||
298 | <sect1> | ||
299 | <title>Key handling basics</title> | ||
300 | !Pnet/mac80211/key.c Key handling basics | ||
301 | </sect1> | ||
302 | <sect1> | ||
303 | <title>MORE TBD</title> | ||
304 | <para>TBD</para> | ||
305 | </sect1> | ||
306 | </chapter> | ||
307 | |||
308 | <chapter id="rx-processing"> | ||
309 | <title>Receive processing</title> | ||
310 | <para>TBD</para> | ||
311 | </chapter> | ||
312 | |||
313 | <chapter id="tx-processing"> | ||
314 | <title>Transmit processing</title> | ||
315 | <para>TBD</para> | ||
316 | </chapter> | ||
317 | |||
318 | <chapter id="sta-info"> | ||
319 | <title>Station info handling</title> | ||
320 | <sect1> | ||
321 | <title>Programming information</title> | ||
322 | !Fnet/mac80211/sta_info.h sta_info | ||
323 | !Fnet/mac80211/sta_info.h ieee80211_sta_info_flags | ||
324 | </sect1> | ||
325 | <sect1> | ||
326 | <title>STA information lifetime rules</title> | ||
327 | !Pnet/mac80211/sta_info.c STA information lifetime rules | ||
328 | </sect1> | ||
329 | </chapter> | ||
330 | |||
331 | <chapter id="synchronisation"> | ||
332 | <title>Synchronisation</title> | ||
333 | <para>TBD</para> | ||
334 | <para>Locking, lots of RCU</para> | ||
335 | </chapter> | ||
336 | </part> | ||
337 | </book> | ||