Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d4d24d2d authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-4.9-2' of git://git.lwn.net/linux 

Pull one more documentation update from Jonathan Corbet:
 "A single commit converting the mac80211 DocBook template over to
  Sphinx.  Only 32 more to go..."

* tag 'docs-4.9-2' of git://git.lwn.net/linux:
  docs-rst: sphinxify 802.11 documentation
parents ac9ef8cd 819bf593

Documentation/80211/cfg80211.rst

0 → 100644
+345 −0
Original line number Diff line number Diff line 
==================

cfg80211 subsystem

==================



Device registration

===================



.. kernel-doc:: include/net/cfg80211.h

   :doc: Device registration



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_channel_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_channel



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_rate_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_rate



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_sta_ht_cap



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_supported_band



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_signal_type



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_params_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy



.. kernel-doc:: include/net/cfg80211.h

   :functions: wireless_dev



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_new



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_register



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_unregister



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_free



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_name



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_dev



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_priv



.. kernel-doc:: include/net/cfg80211.h

   :functions: priv_to_wiphy



.. kernel-doc:: include/net/cfg80211.h

   :functions: set_wiphy_dev



.. kernel-doc:: include/net/cfg80211.h

   :functions: wdev_priv



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_iface_limit



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_iface_combination



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_check_combinations



Actions and configuration

=========================



.. kernel-doc:: include/net/cfg80211.h

   :doc: Actions and configuration



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_ops



.. kernel-doc:: include/net/cfg80211.h

   :functions: vif_params



.. kernel-doc:: include/net/cfg80211.h

   :functions: key_params



.. kernel-doc:: include/net/cfg80211.h

   :functions: survey_info_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: survey_info



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_beacon_data



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_ap_settings



.. kernel-doc:: include/net/cfg80211.h

   :functions: station_parameters



.. kernel-doc:: include/net/cfg80211.h

   :functions: rate_info_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: rate_info



.. kernel-doc:: include/net/cfg80211.h

   :functions: station_info



.. kernel-doc:: include/net/cfg80211.h

   :functions: monitor_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: mpath_info_flags



.. kernel-doc:: include/net/cfg80211.h

   :functions: mpath_info



.. kernel-doc:: include/net/cfg80211.h

   :functions: bss_parameters



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_txq_params



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_crypto_settings



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_auth_request



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_assoc_request



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_deauth_request



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_disassoc_request



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_ibss_params



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_connect_params



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_pmksa



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_rx_mlme_mgmt



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_auth_timeout



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_rx_assoc_resp



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_assoc_timeout



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_tx_mlme_mgmt



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_ibss_joined



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_connect_result



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_connect_bss



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_connect_timeout



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_roamed



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_disconnected



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_ready_on_channel



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_remain_on_channel_expired



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_new_sta



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_rx_mgmt



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_mgmt_tx_status



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_cqm_rssi_notify



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_cqm_pktloss_notify



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_michael_mic_failure



Scanning and BSS list handling

==============================



.. kernel-doc:: include/net/cfg80211.h

   :doc: Scanning and BSS list handling



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_ssid



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_scan_request



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_scan_done



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_bss



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_inform_bss



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_inform_bss_frame_data



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_inform_bss_data



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_unlink_bss



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_find_ie



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_bss_get_ie



Utility functions

=================



.. kernel-doc:: include/net/cfg80211.h

   :doc: Utility functions



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_channel_to_frequency



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_frequency_to_channel



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_get_channel



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_get_response_rate



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_hdrlen



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_get_hdrlen_from_skb



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_radiotap_iterator



Data path helpers

=================



.. kernel-doc:: include/net/cfg80211.h

   :doc: Data path helpers



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_data_to_8023



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_data_from_8023



.. kernel-doc:: include/net/cfg80211.h

   :functions: ieee80211_amsdu_to_8023s



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_classify8021d



Regulatory enforcement infrastructure

=====================================



.. kernel-doc:: include/net/cfg80211.h

   :doc: Regulatory enforcement infrastructure



.. kernel-doc:: include/net/cfg80211.h

   :functions: regulatory_hint



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_apply_custom_regulatory



.. kernel-doc:: include/net/cfg80211.h

   :functions: freq_reg_info



RFkill integration

==================



.. kernel-doc:: include/net/cfg80211.h

   :doc: RFkill integration



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_rfkill_set_hw_state



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_rfkill_start_polling



.. kernel-doc:: include/net/cfg80211.h

   :functions: wiphy_rfkill_stop_polling



Test mode

=========



.. kernel-doc:: include/net/cfg80211.h

   :doc: Test mode



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_testmode_alloc_reply_skb



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_testmode_reply



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_testmode_alloc_event_skb



.. kernel-doc:: include/net/cfg80211.h

   :functions: cfg80211_testmode_event

Documentation/80211/conf.py

0 → 100644
+5 −0
Original line number Diff line number Diff line 
# -*- coding: utf-8; mode: python -*-



project = "Linux 802.11 Driver Developer's Guide"



tags.add("subproject")

Documentation/80211/index.rst

0 → 100644
+17 −0
Original line number Diff line number Diff line 
=====================================

Linux 802.11 Driver Developer's Guide

=====================================



.. toctree::



   introduction

   cfg80211

   mac80211

   mac80211-advanced



.. only::  subproject



   Indices

   =======



   * :ref:`genindex`

Documentation/80211/introduction.rst

0 → 100644
+17 −0
Original line number Diff line number Diff line 
============

Introduction

============



Explaining wireless 802.11 networking in the Linux kernel



Copyright 2007-2009 Johannes Berg



These books attempt to give a description of the various subsystems

that play a role in 802.11 wireless networking in Linux. Since these

books are for kernel developers they attempts to document the

structures and functions used in the kernel as well as giving a

higher-level overview.



The reader is expected to be familiar with the 802.11 standard as

published by the IEEE in 802.11-2007 (or possibly later versions).

References to this standard will be given as "802.11-2007 8.1.5".

Documentation/80211/mac80211-advanced.rst

0 → 100644
+295 −0
Original line number Diff line number Diff line 
=============================

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



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

   :functions: rate_control_send_low



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

===========



.. 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

===============



TBD



Locking, lots of RCU