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

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

Documentation/admin-guide/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -108,6 +108,7 @@ configure specific aspects of kernel behavior to your liking. 
   pnp

   rtc

   svga

   wimax/index

   video-output



.. only::  subproject and html

Documentation/wimax/README.i2400m→Documentation/admin-guide/wimax/i2400m.rst

+84 −61
Original line number Diff line number Diff line 
.. include:: <isonum.txt>



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

Driver for the Intel Wireless Wimax Connection 2400m

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



   (C) 2008 Intel Corporation < linux-wimax@intel.com >

:Copyright: |copy| 2008 Intel Corporation < linux-wimax@intel.com >



   This provides a driver for the Intel Wireless WiMAX Connection 2400m

   and a basic Linux kernel WiMAX stack.



1. Requirements

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



     * Linux installation with Linux kernel 2.6.22 or newer (if building

       from a separate tree)

     * Intel i2400m Echo Peak or Baxter Peak; this includes the Intel

       Wireless WiMAX/WiFi Link 5x50 series.

     * build tools:



          + Linux kernel development package for the target kernel; to

            build against your currently running kernel, you need to have

            the kernel development package corresponding to the running
@@ -22,8 +27,10 @@ 
          + GNU C Compiler, make



2. Compilation and installation

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



2.1. Compilation of the drivers included in the kernel

------------------------------------------------------



   Configure the kernel; to enable the WiMAX drivers select Drivers >

   Networking Drivers > WiMAX device support. Enable all of them as
@@ -36,8 +43,9 @@ 
   Compile and install your kernel as usual.



2.2. Compilation of the drivers distributed as an standalone module

-------------------------------------------------------------------



   To compile

   To compile::



	$ cd source/directory

	$ make
@@ -46,26 +54,27 @@ $ make 
   load.sh will load the modules, load.sh u will unload them.



   To install in the default kernel directories (and enable auto loading

   when the device is plugged):

   when the device is plugged)::



	$ make install

	$ depmod -a



   If your kernel development files are located in a non standard

   directory or if you want to build for a kernel that is not the

   currently running one, set KDIR to the right location:

   currently running one, set KDIR to the right location::



	$ make KDIR=/path/to/kernel/dev/tree



   For more information, please contact linux-wimax@intel.com.



3. Installing the firmware

--------------------------



   The firmware can be obtained from http://linuxwimax.org or might have

   been supplied with your hardware.



   It has to be installed in the target system:

     *

   It has to be installed in the target system::



	$ cp FIRMWAREFILE.sbcf /lib/firmware/i2400m-fw-BUSTYPE-1.3.sbcf



     * NOTE: if your firmware came in an .rpm or .deb file, just install
@@ -76,6 +85,7 @@ $ cp FIRMWAREFILE.sbcf /lib/firmware/i2400m-fw-BUSTYPE-1.3.sbcf 
       with other types.



4. Design

=========



   This package contains two major parts: a WiMAX kernel stack and a

   driver for the Intel i2400m.
@@ -102,12 +112,13 @@ $ cp FIRMWAREFILE.sbcf /lib/firmware/i2400m-fw-BUSTYPE-1.3.sbcf 
   API calls should be replaced with the target OS's.



5. Usage

========



   To load the driver, follow the instructions in the install section;

   once the driver is loaded, plug in the device (unless it is permanently

   plugged in). The driver will enumerate the device, upload the firmware

   and output messages in the kernel log (dmesg, /var/log/messages or

   /var/log/kern.log) such as:

   /var/log/kern.log) such as::



	...

	i2400m_usb 5-4:1.0: firmware interface version 8.0.0
@@ -120,38 +131,42 @@ i2400m_usb 5-4:1.0: WiMAX interface wmx0 (00:1d:e1:01:94:2c) ready 
   on how to scan, connect and disconnect.



5.1. Module parameters

----------------------



   Module parameters can be set at kernel or module load time or by

   echoing values:

   echoing values::



	$ echo VALUE > /sys/module/MODULENAME/parameters/PARAMETERNAME



   To make changes permanent, for example, for the i2400m module, you can

   also create a file named /etc/modprobe.d/i2400m containing:

   also create a file named /etc/modprobe.d/i2400m containing::



	options i2400m idle_mode_disabled=1



   To find which parameters are supported by a module, run:

   To find which parameters are supported by a module, run::



	$ modinfo path/to/module.ko



   During kernel bootup (if the driver is linked in the kernel), specify

   the following to the kernel command line:

   the following to the kernel command line::



	i2400m.PARAMETER=VALUE



5.1.1. i2400m: idle_mode_disabled

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



   The i2400m module supports a parameter to disable idle mode. This

   parameter, once set, will take effect only when the device is

   reinitialized by the driver (eg: following a reset or a reconnect).



5.2. Debug operations: debugfs entries

--------------------------------------



   The driver will register debugfs entries that allow the user to tweak

   debug settings. There are three main container directories where

   entries are placed, which correspond to the three blocks a i2400m WiMAX

   driver has:



     * /sys/kernel/debug/wimax:DEVNAME/ for the generic WiMAX stack

       controls

     * /sys/kernel/debug/wimax:DEVNAME/i2400m for the i2400m generic
@@ -163,10 +178,11 @@ i2400m.PARAMETER=VALUE 
   /sys/kernel/debug, those paths will change.



5.2.1. Increasing debug output

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



   The files named *dl_* indicate knobs for controlling the debug output

   of different submodules:

     *

   of different submodules::



	# find /sys/kernel/debug/wimax\:wmx0 -name \*dl_\*

	/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_tx

	/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_rx
@@ -192,7 +208,7 @@ i2400m.PARAMETER=VALUE 
   level; by writing to it, you can set it.



   To increase the debug level of, for example, the i2400m's generic TX

   engine, just write:

   engine, just write::



	$ echo 3 > /sys/kernel/debug/wimax:wmx0/i2400m/dl_tx
@@ -201,14 +217,16 @@ $ echo 3 > /sys/kernel/debug/wimax:wmx0/i2400m/dl_tx 
   uses 0 for disabled and increasing values until 8.



5.2.2. RX and TX statistics

^^^^^^^^^^^^^^^^^^^^^^^^^^^



   The i2400m/rx_stats and i2400m/tx_stats provide statistics about the

   data reception/delivery from the device:

   data reception/delivery from the device::



	$ cat /sys/kernel/debug/wimax:wmx0/i2400m/rx_stats

	45 1 3 34 3104 48 480



   The numbers reported are

   The numbers reported are:



     * packets/RX-buffer: total, min, max

     * RX-buffers: total RX buffers received, accumulated RX buffer size

       in bytes, min size received, max size received
@@ -216,7 +234,7 @@ $ cat /sys/kernel/debug/wimax:wmx0/i2400m/rx_stats 
   Thus, to find the average buffer size received, divide accumulated

   RX-buffer / total RX-buffers.



   To clear the statistics back to 0, write anything to the rx_stats file:

   To clear the statistics back to 0, write anything to the rx_stats file::



	$ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m_rx_stats
@@ -227,14 +245,16 @@ $ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m_rx_stats 
   to the host. See drivers/net/wimax/i2400m/tx.c.



5.2.3. Tracing messages received from user space

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



   To echo messages received from user space into the trace pipe that the

   i2400m driver creates, set the debug file i2400m/trace_msg_from_user to

   1:

     *

   1::



	$ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m/trace_msg_from_user



5.2.4. Performing a device reset

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



   By writing a 0, a 1 or a 2 to the file

   /sys/kernel/debug/wimax:wmx0/reset, the driver performs a warm (without
@@ -242,16 +262,19 @@ $ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m/trace_msg_from_user 
   (bus specific) reset on the device.



5.2.5. Asking the device to enter power saving mode

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



   By writing any value to the /sys/kernel/debug/wimax:wmx0 file, the

   device will attempt to enter power saving mode.



6. Troubleshooting

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



6.1. Driver complains about 'i2400m-fw-usb-1.2.sbcf: request failed'

6.1. Driver complains about ``i2400m-fw-usb-1.2.sbcf: request failed``

----------------------------------------------------------------------



   If upon connecting the device, the following is output in the kernel

   log:

   log::



	i2400m_usb 5-4:1.0: fw i2400m-fw-usb-1.3.sbcf: request failed: -2

Documentation/admin-guide/wimax/index.rst

0 → 100644
+19 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



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

WiMAX subsystem

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



.. toctree::

   :maxdepth: 2



   wimax



   i2400m



.. only::  subproject and html



   Indices

   =======



   * :ref:`genindex`

Documentation/wimax/README.wimax→Documentation/admin-guide/wimax/wimax.rst

+23 −15
Original line number Diff line number Diff line 
.. include:: <isonum.txt>



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

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

   control API for WiMAX devices, usable from kernel and user space.



1. Design

=========



   The WiMAX stack is designed to provide for common WiMAX control

   services to current and future WiMAX devices from any vendor.
@@ -31,6 +35,7 @@ 
   include/linux/wimax.h.



2. Usage

========



   For usage in a driver (registration, API, etc) please refer to the

   instructions in the header file include/linux/wimax.h.
@@ -40,6 +45,7 @@ 
   control.



2.1. Obtaining debug information: debugfs entries

-------------------------------------------------



   The WiMAX stack is compiled, by default, with debug messages that can

   be used to diagnose issues. By default, said messages are disabled.
@@ -52,10 +58,11 @@ 
   create more subentries below it.



2.1.1. Increasing 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_\*

	/sys/kernel/debug/wimax:wmx0/wimax_dl_stack

	/sys/kernel/debug/wimax:wmx0/wimax_dl_op_rfkill
@@ -65,7 +72,8 @@ 
	/sys/kernel/debug/wimax:wmx0/wimax_dl_debugfs

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



   By reading the file you can obtain the current value of said debug

MAINTAINERS

+2 −2
Original line number Diff line number Diff line
@@ -8356,7 +8356,7 @@ M: linux-wimax@intel.com 
L:	wimax@linuxwimax.org (subscribers-only)

S:	Supported

W:	http://linuxwimax.org

F:	Documentation/wimax/README.i2400m

F:	Documentation/admin-guide/wimax/i2400m.rst

F:	drivers/net/wimax/i2400m/

F:	include/uapi/linux/wimax/i2400m.h
@@ -17358,7 +17358,7 @@ M: linux-wimax@intel.com 
L:	wimax@linuxwimax.org (subscribers-only)

S:	Supported

W:	http://linuxwimax.org

F:	Documentation/wimax/README.wimax

F:	Documentation/admin-guide/wimax/wimax.rst

F:	include/linux/wimax/debug.h

F:	include/net/wimax.h

F:	include/uapi/linux/wimax.h