diff options
author | Johannes Berg <johannes.berg@intel.com> | 2010-08-19 10:11:27 -0400 |
---|---|---|
committer | John W. Linville <linville@tuxdriver.com> | 2010-08-24 16:32:06 -0400 |
commit | d70e96932de55fb2c05b1c0af1dff178651a9b77 (patch) | |
tree | aa79113a4fffbc5e3163effd3949ad39e31a71c0 /Documentation/DocBook | |
parent | 672ddeffeb2afad18fe1a2fc5aa14a07b4da1551 (diff) |
cfg80211: add some documentation
Add some documentation for cfg80211. I'm hoping some of
the regulatory documentation will be filled by somebody
more familiar with it, hint hint! :)
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: John W. Linville <linville@tuxdriver.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/80211.tmpl | 136 |
1 files changed, 131 insertions, 5 deletions
diff --git a/Documentation/DocBook/80211.tmpl b/Documentation/DocBook/80211.tmpl index 52310ac892ea..b84c9282828f 100644 --- a/Documentation/DocBook/80211.tmpl +++ b/Documentation/DocBook/80211.tmpl | |||
@@ -65,18 +65,144 @@ | |||
65 | </abstract> | 65 | </abstract> |
66 | </setinfo> | 66 | </setinfo> |
67 | <book id="cfg80211-developers-guide"> | 67 | <book id="cfg80211-developers-guide"> |
68 | !Ainclude/net/cfg80211.h | ||
68 | <bookinfo> | 69 | <bookinfo> |
69 | <title>The cfg80211 subsystem</title> | 70 | <title>The cfg80211 subsystem</title> |
70 | 71 | ||
71 | <abstract> | 72 | <abstract> |
72 | <para> | 73 | !Pinclude/net/cfg80211.h Introduction |
73 | MISSING | ||
74 | </para> | ||
75 | </abstract> | 74 | </abstract> |
76 | </bookinfo> | 75 | </bookinfo> |
77 | <part><chapter> | 76 | <chapter> |
77 | <title>Device registration</title> | ||
78 | !Pinclude/net/cfg80211.h Device registration | ||
78 | !Finclude/net/cfg80211.h ieee80211_band | 79 | !Finclude/net/cfg80211.h ieee80211_band |
79 | </chapter></part> | 80 | !Finclude/net/cfg80211.h ieee80211_channel_flags |
81 | !Finclude/net/cfg80211.h ieee80211_channel | ||
82 | !Finclude/net/cfg80211.h ieee80211_rate_flags | ||
83 | !Finclude/net/cfg80211.h ieee80211_rate | ||
84 | !Finclude/net/cfg80211.h ieee80211_sta_ht_cap | ||
85 | !Finclude/net/cfg80211.h ieee80211_supported_band | ||
86 | !Finclude/net/cfg80211.h cfg80211_signal_type | ||
87 | !Finclude/net/cfg80211.h wiphy_params_flags | ||
88 | !Finclude/net/cfg80211.h wiphy_flags | ||
89 | !Finclude/net/cfg80211.h wiphy | ||
90 | !Finclude/net/cfg80211.h wireless_dev | ||
91 | !Finclude/net/cfg80211.h wiphy_new | ||
92 | !Finclude/net/cfg80211.h wiphy_register | ||
93 | !Finclude/net/cfg80211.h wiphy_unregister | ||
94 | !Finclude/net/cfg80211.h wiphy_free | ||
95 | |||
96 | !Finclude/net/cfg80211.h wiphy_name | ||
97 | !Finclude/net/cfg80211.h wiphy_dev | ||
98 | !Finclude/net/cfg80211.h wiphy_priv | ||
99 | !Finclude/net/cfg80211.h priv_to_wiphy | ||
100 | !Finclude/net/cfg80211.h set_wiphy_dev | ||
101 | !Finclude/net/cfg80211.h wdev_priv | ||
102 | </chapter> | ||
103 | <chapter> | ||
104 | <title>Actions and configuration</title> | ||
105 | !Pinclude/net/cfg80211.h Actions and configuration | ||
106 | !Finclude/net/cfg80211.h cfg80211_ops | ||
107 | !Finclude/net/cfg80211.h vif_params | ||
108 | !Finclude/net/cfg80211.h key_params | ||
109 | !Finclude/net/cfg80211.h survey_info_flags | ||
110 | !Finclude/net/cfg80211.h survey_info | ||
111 | !Finclude/net/cfg80211.h beacon_parameters | ||
112 | !Finclude/net/cfg80211.h plink_actions | ||
113 | !Finclude/net/cfg80211.h station_parameters | ||
114 | !Finclude/net/cfg80211.h station_info_flags | ||
115 | !Finclude/net/cfg80211.h rate_info_flags | ||
116 | !Finclude/net/cfg80211.h rate_info | ||
117 | !Finclude/net/cfg80211.h station_info | ||
118 | !Finclude/net/cfg80211.h monitor_flags | ||
119 | !Finclude/net/cfg80211.h mpath_info_flags | ||
120 | !Finclude/net/cfg80211.h mpath_info | ||
121 | !Finclude/net/cfg80211.h bss_parameters | ||
122 | !Finclude/net/cfg80211.h ieee80211_txq_params | ||
123 | !Finclude/net/cfg80211.h cfg80211_crypto_settings | ||
124 | !Finclude/net/cfg80211.h cfg80211_auth_request | ||
125 | !Finclude/net/cfg80211.h cfg80211_assoc_request | ||
126 | !Finclude/net/cfg80211.h cfg80211_deauth_request | ||
127 | !Finclude/net/cfg80211.h cfg80211_disassoc_request | ||
128 | !Finclude/net/cfg80211.h cfg80211_ibss_params | ||
129 | !Finclude/net/cfg80211.h cfg80211_connect_params | ||
130 | !Finclude/net/cfg80211.h cfg80211_pmksa | ||
131 | !Finclude/net/cfg80211.h cfg80211_send_rx_auth | ||
132 | !Finclude/net/cfg80211.h cfg80211_send_auth_timeout | ||
133 | !Finclude/net/cfg80211.h __cfg80211_auth_canceled | ||
134 | !Finclude/net/cfg80211.h cfg80211_send_rx_assoc | ||
135 | !Finclude/net/cfg80211.h cfg80211_send_assoc_timeout | ||
136 | !Finclude/net/cfg80211.h cfg80211_send_deauth | ||
137 | !Finclude/net/cfg80211.h __cfg80211_send_deauth | ||
138 | !Finclude/net/cfg80211.h cfg80211_send_disassoc | ||
139 | !Finclude/net/cfg80211.h __cfg80211_send_disassoc | ||
140 | !Finclude/net/cfg80211.h cfg80211_ibss_joined | ||
141 | !Finclude/net/cfg80211.h cfg80211_connect_result | ||
142 | !Finclude/net/cfg80211.h cfg80211_roamed | ||
143 | !Finclude/net/cfg80211.h cfg80211_disconnected | ||
144 | !Finclude/net/cfg80211.h cfg80211_ready_on_channel | ||
145 | !Finclude/net/cfg80211.h cfg80211_remain_on_channel_expired | ||
146 | !Finclude/net/cfg80211.h cfg80211_new_sta | ||
147 | !Finclude/net/cfg80211.h cfg80211_rx_mgmt | ||
148 | !Finclude/net/cfg80211.h cfg80211_mgmt_tx_status | ||
149 | !Finclude/net/cfg80211.h cfg80211_cqm_rssi_notify | ||
150 | !Finclude/net/cfg80211.h cfg80211_michael_mic_failure | ||
151 | </chapter> | ||
152 | <chapter> | ||
153 | <title>Scanning and BSS list handling</title> | ||
154 | !Pinclude/net/cfg80211.h Scanning and BSS list handling | ||
155 | !Finclude/net/cfg80211.h cfg80211_ssid | ||
156 | !Finclude/net/cfg80211.h cfg80211_scan_request | ||
157 | !Finclude/net/cfg80211.h cfg80211_scan_done | ||
158 | !Finclude/net/cfg80211.h cfg80211_bss | ||
159 | !Finclude/net/cfg80211.h cfg80211_inform_bss_frame | ||
160 | !Finclude/net/cfg80211.h cfg80211_inform_bss | ||
161 | !Finclude/net/cfg80211.h cfg80211_unlink_bss | ||
162 | !Finclude/net/cfg80211.h cfg80211_find_ie | ||
163 | !Finclude/net/cfg80211.h ieee80211_bss_get_ie | ||
164 | </chapter> | ||
165 | <chapter> | ||
166 | <title>Utility functions</title> | ||
167 | !Pinclude/net/cfg80211.h Utility functions | ||
168 | !Finclude/net/cfg80211.h ieee80211_channel_to_frequency | ||
169 | !Finclude/net/cfg80211.h ieee80211_frequency_to_channel | ||
170 | !Finclude/net/cfg80211.h ieee80211_get_channel | ||
171 | !Finclude/net/cfg80211.h ieee80211_get_response_rate | ||
172 | !Finclude/net/cfg80211.h ieee80211_hdrlen | ||
173 | !Finclude/net/cfg80211.h ieee80211_get_hdrlen_from_skb | ||
174 | !Finclude/net/cfg80211.h ieee80211_radiotap_iterator | ||
175 | </chapter> | ||
176 | <chapter> | ||
177 | <title>Data path helpers</title> | ||
178 | !Pinclude/net/cfg80211.h Data path helpers | ||
179 | !Finclude/net/cfg80211.h ieee80211_data_to_8023 | ||
180 | !Finclude/net/cfg80211.h ieee80211_data_from_8023 | ||
181 | !Finclude/net/cfg80211.h ieee80211_amsdu_to_8023s | ||
182 | !Finclude/net/cfg80211.h cfg80211_classify8021d | ||
183 | </chapter> | ||
184 | <chapter> | ||
185 | <title>Regulatory enforcement infrastructure</title> | ||
186 | !Pinclude/net/cfg80211.h Regulatory enforcement infrastructure | ||
187 | !Finclude/net/cfg80211.h regulatory_hint | ||
188 | !Finclude/net/cfg80211.h wiphy_apply_custom_regulatory | ||
189 | !Finclude/net/cfg80211.h freq_reg_info | ||
190 | </chapter> | ||
191 | <chapter> | ||
192 | <title>RFkill integration</title> | ||
193 | !Pinclude/net/cfg80211.h RFkill integration | ||
194 | !Finclude/net/cfg80211.h wiphy_rfkill_set_hw_state | ||
195 | !Finclude/net/cfg80211.h wiphy_rfkill_start_polling | ||
196 | !Finclude/net/cfg80211.h wiphy_rfkill_stop_polling | ||
197 | </chapter> | ||
198 | <chapter> | ||
199 | <title>Test mode</title> | ||
200 | !Pinclude/net/cfg80211.h Test mode | ||
201 | !Finclude/net/cfg80211.h cfg80211_testmode_alloc_reply_skb | ||
202 | !Finclude/net/cfg80211.h cfg80211_testmode_reply | ||
203 | !Finclude/net/cfg80211.h cfg80211_testmode_alloc_event_skb | ||
204 | !Finclude/net/cfg80211.h cfg80211_testmode_event | ||
205 | </chapter> | ||
80 | </book> | 206 | </book> |
81 | <book id="mac80211-developers-guide"> | 207 | <book id="mac80211-developers-guide"> |
82 | <bookinfo> | 208 | <bookinfo> |