Commit ff497db2 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: wimax: convert to ReST and add to admin-guide

Manually convert wimax documentation to ReST and add theit
to the Kernel doc body, inside the admin-guide.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 9c970ab5
...@@ -108,6 +108,7 @@ configure specific aspects of kernel behavior to your liking. ...@@ -108,6 +108,7 @@ configure specific aspects of kernel behavior to your liking.
pnp pnp
rtc rtc
svga svga
wimax/index
video-output video-output
.. only:: subproject and html .. only:: subproject and html
......
.. SPDX-License-Identifier: GPL-2.0
===============
WiMAX subsystem
===============
.. toctree::
:maxdepth: 2
wimax
i2400m
.. only:: subproject and html
Indices
=======
* :ref:`genindex`
.. include:: <isonum.txt>
Linux kernel WiMAX stack ========================
Linux kernel WiMAX stack
========================
(C) 2008 Intel Corporation < linux-wimax@intel.com > :Copyright: |copy| 2008 Intel Corporation < linux-wimax@intel.com >
This provides a basic Linux kernel WiMAX stack to provide a common This provides a basic Linux kernel WiMAX stack to provide a common
control API for WiMAX devices, usable from kernel and user space. control API for WiMAX devices, usable from kernel and user space.
1. Design 1. Design
=========
The WiMAX stack is designed to provide for common WiMAX control The WiMAX stack is designed to provide for common WiMAX control
services to current and future WiMAX devices from any vendor. services to current and future WiMAX devices from any vendor.
...@@ -31,6 +35,7 @@ ...@@ -31,6 +35,7 @@
include/linux/wimax.h. include/linux/wimax.h.
2. Usage 2. Usage
========
For usage in a driver (registration, API, etc) please refer to the For usage in a driver (registration, API, etc) please refer to the
instructions in the header file include/linux/wimax.h. instructions in the header file include/linux/wimax.h.
...@@ -40,6 +45,7 @@ ...@@ -40,6 +45,7 @@
control. control.
2.1. Obtaining debug information: debugfs entries 2.1. Obtaining debug information: debugfs entries
-------------------------------------------------
The WiMAX stack is compiled, by default, with debug messages that can The WiMAX stack is compiled, by default, with debug messages that can
be used to diagnose issues. By default, said messages are disabled. be used to diagnose issues. By default, said messages are disabled.
...@@ -52,20 +58,22 @@ ...@@ -52,20 +58,22 @@
create more subentries below it. create more subentries below it.
2.1.1. Increasing debug output 2.1.1. Increasing debug output
------------------------------
The files named *dl_* indicate knobs for controlling the debug output The files named *dl_* indicate knobs for controlling the debug output
of different submodules of the WiMAX stack: of different submodules of the WiMAX stack::
*
# find /sys/kernel/debug/wimax\:wmx0 -name \*dl_\* # find /sys/kernel/debug/wimax\:wmx0 -name \*dl_\*
/sys/kernel/debug/wimax:wmx0/wimax_dl_stack /sys/kernel/debug/wimax:wmx0/wimax_dl_stack
/sys/kernel/debug/wimax:wmx0/wimax_dl_op_rfkill /sys/kernel/debug/wimax:wmx0/wimax_dl_op_rfkill
/sys/kernel/debug/wimax:wmx0/wimax_dl_op_reset /sys/kernel/debug/wimax:wmx0/wimax_dl_op_reset
/sys/kernel/debug/wimax:wmx0/wimax_dl_op_msg /sys/kernel/debug/wimax:wmx0/wimax_dl_op_msg
/sys/kernel/debug/wimax:wmx0/wimax_dl_id_table /sys/kernel/debug/wimax:wmx0/wimax_dl_id_table
/sys/kernel/debug/wimax:wmx0/wimax_dl_debugfs /sys/kernel/debug/wimax:wmx0/wimax_dl_debugfs
/sys/kernel/debug/wimax:wmx0/.... # other driver specific files /sys/kernel/debug/wimax:wmx0/.... # other driver specific files
NOTE: Of course, if debugfs is mounted in a directory other than NOTE:
Of course, if debugfs is mounted in a directory other than
/sys/kernel/debug, those paths will change. /sys/kernel/debug, those paths will change.
By reading the file you can obtain the current value of said debug By reading the file you can obtain the current value of said debug
...@@ -74,7 +82,7 @@ ...@@ -74,7 +82,7 @@
To increase the debug level of, for example, the id-table submodule, To increase the debug level of, for example, the id-table submodule,
just write: just write:
$ echo 3 > /sys/kernel/debug/wimax:wmx0/wimax_dl_id_table $ echo 3 > /sys/kernel/debug/wimax:wmx0/wimax_dl_id_table
Increasing numbers yield increasing debug information; for details of Increasing numbers yield increasing debug information; for details of
what is printed and the available levels, check the source. The code what is printed and the available levels, check the source. The code
......
...@@ -8356,7 +8356,7 @@ M: linux-wimax@intel.com ...@@ -8356,7 +8356,7 @@ M: linux-wimax@intel.com
L: wimax@linuxwimax.org (subscribers-only) L: wimax@linuxwimax.org (subscribers-only)
S: Supported S: Supported
W: http://linuxwimax.org W: http://linuxwimax.org
F: Documentation/wimax/README.i2400m F: Documentation/admin-guide/wimax/i2400m.rst
F: drivers/net/wimax/i2400m/ F: drivers/net/wimax/i2400m/
F: include/uapi/linux/wimax/i2400m.h F: include/uapi/linux/wimax/i2400m.h
...@@ -17358,7 +17358,7 @@ M: linux-wimax@intel.com ...@@ -17358,7 +17358,7 @@ M: linux-wimax@intel.com
L: wimax@linuxwimax.org (subscribers-only) L: wimax@linuxwimax.org (subscribers-only)
S: Supported S: Supported
W: http://linuxwimax.org W: http://linuxwimax.org
F: Documentation/wimax/README.wimax F: Documentation/admin-guide/wimax/wimax.rst
F: include/linux/wimax/debug.h F: include/linux/wimax/debug.h
F: include/net/wimax.h F: include/net/wimax.h
F: include/uapi/linux/wimax.h F: include/uapi/linux/wimax.h
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment