aboutsummaryrefslogtreecommitdiff
path: root/Documentation/driver-api/80211/mac80211-advanced.rst
blob: 24cb64b3b7151f6dd6bc0ffa3f76d0454011bf5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
=============================
mac80211 subsystem (advanced)
=============================

Information contained within this part of the book is of interest only
for advanced interaction of mac80211 with drivers to exploit more
hardware capabilities and improve performance.

LED support
===========

Mac80211 supports various ways of blinking LEDs. Wherever possible,
device LEDs should be exposed as LED class devices and hooked up to the
appropriate trigger, which will then be triggered appropriately by
mac80211.

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_tx_led_name

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_rx_led_name

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_assoc_led_name

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_radio_led_name

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_tpt_blink

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_tpt_led_trigger_flags

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_create_tpt_led_trigger

Hardware crypto acceleration
============================

.. kernel-doc:: include/net/mac80211.h
   :doc: Hardware crypto acceleration

.. kernel-doc:: include/net/mac80211.h
   :functions: set_key_cmd

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_key_conf

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_key_flags

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_tkip_p1k

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_tkip_p1k_iv

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_tkip_p2k

Powersave support
=================

.. kernel-doc:: include/net/mac80211.h
   :doc: Powersave support

Beacon filter support
=====================

.. kernel-doc:: include/net/mac80211.h
   :doc: Beacon filter support

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_beacon_loss

Multiple queues and QoS support
===============================

TBD

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_tx_queue_params

Access point mode support
=========================

TBD

Some parts of the if_conf should be discussed here instead

Insert notes about VLAN interfaces with hw crypto here or in the hw
crypto chapter.

support for powersaving clients
-------------------------------

.. kernel-doc:: include/net/mac80211.h
   :doc: AP support for powersaving clients

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_get_buffered_bc

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_beacon_get

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_sta_eosp

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_frame_release_type

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_sta_ps_transition

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_sta_ps_transition_ni

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_sta_set_buffered

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_sta_block_awake

Supporting multiple virtual interfaces
======================================

TBD

Note: WDS with identical MAC address should almost always be OK

Insert notes about having multiple virtual interfaces with different MAC
addresses here, note which configurations are supported by mac80211, add
notes about supporting hw crypto with it.

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_iterate_active_interfaces

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_iterate_active_interfaces_atomic

Station handling
================

TODO

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_sta

.. kernel-doc:: include/net/mac80211.h
   :functions: sta_notify_cmd

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_find_sta

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_find_sta_by_ifaddr

Hardware scan offload
=====================

TBD

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_scan_completed

Aggregation
===========

TX A-MPDU aggregation
---------------------

.. kernel-doc:: net/mac80211/agg-tx.c
   :doc: TX A-MPDU aggregation

.. WARNING: DOCPROC directive not supported: !Cnet/mac80211/agg-tx.c

RX A-MPDU aggregation
---------------------

.. kernel-doc:: net/mac80211/agg-rx.c
   :doc: RX A-MPDU aggregation

.. WARNING: DOCPROC directive not supported: !Cnet/mac80211/agg-rx.c

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_ampdu_mlme_action

Spatial Multiplexing Powersave (SMPS)
=====================================

.. kernel-doc:: include/net/mac80211.h
   :doc: Spatial multiplexing power save

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_request_smps

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_smps_mode

TBD

This part of the book describes the rate control algorithm interface and
how it relates to mac80211 and drivers.

Rate Control API
================

TBD

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_start_tx_ba_session

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_start_tx_ba_cb_irqsafe

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_stop_tx_ba_session

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_stop_tx_ba_cb_irqsafe

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_rate_control_changed

.. kernel-doc:: include/net/mac80211.h
   :functions: ieee80211_tx_rate_control

TBD

This part of the book describes mac80211 internals.

Key handling
============

Key handling basics
-------------------

.. kernel-doc:: net/mac80211/key.c
   :doc: Key handling basics

MORE TBD
--------

TBD

Receive processing
==================

TBD

Transmit processing
===================

TBD

Station info handling
=====================

Programming information
-----------------------

.. kernel-doc:: net/mac80211/sta_info.h
   :functions: sta_info

.. kernel-doc:: net/mac80211/sta_info.h
   :functions: ieee80211_sta_info_flags

STA information lifetime rules
------------------------------

.. kernel-doc:: net/mac80211/sta_info.c
   :doc: STA information lifetime rules

Aggregation Functions
=====================

.. kernel-doc:: net/mac80211/sta_info.h
   :functions: sta_ampdu_mlme

.. kernel-doc:: net/mac80211/sta_info.h
   :functions: tid_ampdu_tx

.. kernel-doc:: net/mac80211/sta_info.h
   :functions: tid_ampdu_rx

Synchronisation Functions
=========================

TBD

Locking, lots of RCU