mirror of
https://github.com/brain-hackers/linux-brain.git
synced 2024-06-09 23:36:23 +09:00
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: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
9c970ab54c
commit
ff497db295
|
@ -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
|
||||||
|
|
|
@ -1,18 +1,23 @@
|
||||||
|
.. include:: <isonum.txt>
|
||||||
|
|
||||||
Driver for the Intel Wireless Wimax Connection 2400m
|
====================================================
|
||||||
|
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
|
This provides a driver for the Intel Wireless WiMAX Connection 2400m
|
||||||
and a basic Linux kernel WiMAX stack.
|
and a basic Linux kernel WiMAX stack.
|
||||||
|
|
||||||
1. Requirements
|
1. Requirements
|
||||||
|
===============
|
||||||
|
|
||||||
* Linux installation with Linux kernel 2.6.22 or newer (if building
|
* Linux installation with Linux kernel 2.6.22 or newer (if building
|
||||||
from a separate tree)
|
from a separate tree)
|
||||||
* Intel i2400m Echo Peak or Baxter Peak; this includes the Intel
|
* Intel i2400m Echo Peak or Baxter Peak; this includes the Intel
|
||||||
Wireless WiMAX/WiFi Link 5x50 series.
|
Wireless WiMAX/WiFi Link 5x50 series.
|
||||||
* build tools:
|
* build tools:
|
||||||
|
|
||||||
+ Linux kernel development package for the target kernel; to
|
+ Linux kernel development package for the target kernel; to
|
||||||
build against your currently running kernel, you need to have
|
build against your currently running kernel, you need to have
|
||||||
the kernel development package corresponding to the running
|
the kernel development package corresponding to the running
|
||||||
|
@ -22,8 +27,10 @@
|
||||||
+ GNU C Compiler, make
|
+ GNU C Compiler, make
|
||||||
|
|
||||||
2. Compilation and installation
|
2. Compilation and installation
|
||||||
|
===============================
|
||||||
|
|
||||||
2.1. Compilation of the drivers included in the kernel
|
2.1. Compilation of the drivers included in the kernel
|
||||||
|
------------------------------------------------------
|
||||||
|
|
||||||
Configure the kernel; to enable the WiMAX drivers select Drivers >
|
Configure the kernel; to enable the WiMAX drivers select Drivers >
|
||||||
Networking Drivers > WiMAX device support. Enable all of them as
|
Networking Drivers > WiMAX device support. Enable all of them as
|
||||||
|
@ -36,37 +43,39 @@
|
||||||
Compile and install your kernel as usual.
|
Compile and install your kernel as usual.
|
||||||
|
|
||||||
2.2. Compilation of the drivers distributed as an standalone module
|
2.2. Compilation of the drivers distributed as an standalone module
|
||||||
|
-------------------------------------------------------------------
|
||||||
|
|
||||||
To compile
|
To compile::
|
||||||
|
|
||||||
$ cd source/directory
|
$ cd source/directory
|
||||||
$ make
|
$ make
|
||||||
|
|
||||||
Once built you can load and unload using the provided load.sh script;
|
Once built you can load and unload using the provided load.sh script;
|
||||||
load.sh will load the modules, load.sh u will unload them.
|
load.sh will load the modules, load.sh u will unload them.
|
||||||
|
|
||||||
To install in the default kernel directories (and enable auto loading
|
To install in the default kernel directories (and enable auto loading
|
||||||
when the device is plugged):
|
when the device is plugged)::
|
||||||
|
|
||||||
$ make install
|
$ make install
|
||||||
$ depmod -a
|
$ depmod -a
|
||||||
|
|
||||||
If your kernel development files are located in a non standard
|
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
|
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
|
$ make KDIR=/path/to/kernel/dev/tree
|
||||||
|
|
||||||
For more information, please contact linux-wimax@intel.com.
|
For more information, please contact linux-wimax@intel.com.
|
||||||
|
|
||||||
3. Installing the firmware
|
3. Installing the firmware
|
||||||
|
--------------------------
|
||||||
|
|
||||||
The firmware can be obtained from http://linuxwimax.org or might have
|
The firmware can be obtained from http://linuxwimax.org or might have
|
||||||
been supplied with your hardware.
|
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
|
$ cp FIRMWAREFILE.sbcf /lib/firmware/i2400m-fw-BUSTYPE-1.3.sbcf
|
||||||
|
|
||||||
* NOTE: if your firmware came in an .rpm or .deb file, just install
|
* NOTE: if your firmware came in an .rpm or .deb file, just install
|
||||||
it as normal, with the rpm (rpm -i FIRMWARE.rpm) or dpkg
|
it as normal, with the rpm (rpm -i FIRMWARE.rpm) or dpkg
|
||||||
|
@ -76,6 +85,7 @@ $ cp FIRMWAREFILE.sbcf /lib/firmware/i2400m-fw-BUSTYPE-1.3.sbcf
|
||||||
with other types.
|
with other types.
|
||||||
|
|
||||||
4. Design
|
4. Design
|
||||||
|
=========
|
||||||
|
|
||||||
This package contains two major parts: a WiMAX kernel stack and a
|
This package contains two major parts: a WiMAX kernel stack and a
|
||||||
driver for the Intel i2400m.
|
driver for the Intel i2400m.
|
||||||
|
@ -102,16 +112,17 @@ $ cp FIRMWAREFILE.sbcf /lib/firmware/i2400m-fw-BUSTYPE-1.3.sbcf
|
||||||
API calls should be replaced with the target OS's.
|
API calls should be replaced with the target OS's.
|
||||||
|
|
||||||
5. Usage
|
5. Usage
|
||||||
|
========
|
||||||
|
|
||||||
To load the driver, follow the instructions in the install section;
|
To load the driver, follow the instructions in the install section;
|
||||||
once the driver is loaded, plug in the device (unless it is permanently
|
once the driver is loaded, plug in the device (unless it is permanently
|
||||||
plugged in). The driver will enumerate the device, upload the firmware
|
plugged in). The driver will enumerate the device, upload the firmware
|
||||||
and output messages in the kernel log (dmesg, /var/log/messages or
|
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
|
i2400m_usb 5-4:1.0: firmware interface version 8.0.0
|
||||||
i2400m_usb 5-4:1.0: WiMAX interface wmx0 (00:1d:e1:01:94:2c) ready
|
i2400m_usb 5-4:1.0: WiMAX interface wmx0 (00:1d:e1:01:94:2c) ready
|
||||||
|
|
||||||
At this point the device is ready to work.
|
At this point the device is ready to work.
|
||||||
|
|
||||||
|
@ -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.
|
on how to scan, connect and disconnect.
|
||||||
|
|
||||||
5.1. Module parameters
|
5.1. Module parameters
|
||||||
|
----------------------
|
||||||
|
|
||||||
Module parameters can be set at kernel or module load time or by
|
Module parameters can be set at kernel or module load time or by
|
||||||
echoing values:
|
echoing values::
|
||||||
|
|
||||||
$ echo VALUE > /sys/module/MODULENAME/parameters/PARAMETERNAME
|
$ echo VALUE > /sys/module/MODULENAME/parameters/PARAMETERNAME
|
||||||
|
|
||||||
To make changes permanent, for example, for the i2400m module, you can
|
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
|
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
|
$ modinfo path/to/module.ko
|
||||||
|
|
||||||
During kernel bootup (if the driver is linked in the kernel), specify
|
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
|
i2400m.PARAMETER=VALUE
|
||||||
|
|
||||||
5.1.1. i2400m: idle_mode_disabled
|
5.1.1. i2400m: idle_mode_disabled
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
The i2400m module supports a parameter to disable idle mode. This
|
The i2400m module supports a parameter to disable idle mode. This
|
||||||
parameter, once set, will take effect only when the device is
|
parameter, once set, will take effect only when the device is
|
||||||
reinitialized by the driver (eg: following a reset or a reconnect).
|
reinitialized by the driver (eg: following a reset or a reconnect).
|
||||||
|
|
||||||
5.2. Debug operations: debugfs entries
|
5.2. Debug operations: debugfs entries
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
The driver will register debugfs entries that allow the user to tweak
|
The driver will register debugfs entries that allow the user to tweak
|
||||||
debug settings. There are three main container directories where
|
debug settings. There are three main container directories where
|
||||||
entries are placed, which correspond to the three blocks a i2400m WiMAX
|
entries are placed, which correspond to the three blocks a i2400m WiMAX
|
||||||
driver has:
|
driver has:
|
||||||
|
|
||||||
* /sys/kernel/debug/wimax:DEVNAME/ for the generic WiMAX stack
|
* /sys/kernel/debug/wimax:DEVNAME/ for the generic WiMAX stack
|
||||||
controls
|
controls
|
||||||
* /sys/kernel/debug/wimax:DEVNAME/i2400m for the i2400m generic
|
* /sys/kernel/debug/wimax:DEVNAME/i2400m for the i2400m generic
|
||||||
|
@ -163,52 +178,55 @@ i2400m.PARAMETER=VALUE
|
||||||
/sys/kernel/debug, those paths will change.
|
/sys/kernel/debug, those paths will change.
|
||||||
|
|
||||||
5.2.1. Increasing debug output
|
5.2.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 different submodules::
|
||||||
*
|
|
||||||
# find /sys/kernel/debug/wimax\:wmx0 -name \*dl_\*
|
# 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_tx
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_rx
|
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_rx
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_notif
|
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_notif
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_fw
|
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_fw
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_usb
|
/sys/kernel/debug/wimax:wmx0/i2400m-usb/dl_usb
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_tx
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_tx
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_rx
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_rx
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_rfkill
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_rfkill
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_netdev
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_netdev
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_fw
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_fw
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_debugfs
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_debugfs
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_driver
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_driver
|
||||||
/sys/kernel/debug/wimax:wmx0/i2400m/dl_control
|
/sys/kernel/debug/wimax:wmx0/i2400m/dl_control
|
||||||
/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
|
||||||
|
|
||||||
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
|
||||||
level; by writing to it, you can set it.
|
level; by writing to it, you can set it.
|
||||||
|
|
||||||
To increase the debug level of, for example, the i2400m's generic TX
|
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
|
$ echo 3 > /sys/kernel/debug/wimax:wmx0/i2400m/dl_tx
|
||||||
|
|
||||||
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
|
||||||
uses 0 for disabled and increasing values until 8.
|
uses 0 for disabled and increasing values until 8.
|
||||||
|
|
||||||
5.2.2. RX and TX statistics
|
5.2.2. RX and TX statistics
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
The i2400m/rx_stats and i2400m/tx_stats provide statistics about the
|
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
|
$ cat /sys/kernel/debug/wimax:wmx0/i2400m/rx_stats
|
||||||
45 1 3 34 3104 48 480
|
45 1 3 34 3104 48 480
|
||||||
|
|
||||||
|
The numbers reported are:
|
||||||
|
|
||||||
The numbers reported are
|
|
||||||
* packets/RX-buffer: total, min, max
|
* packets/RX-buffer: total, min, max
|
||||||
* RX-buffers: total RX buffers received, accumulated RX buffer size
|
* RX-buffers: total RX buffers received, accumulated RX buffer size
|
||||||
in bytes, min size received, max size received
|
in bytes, min size received, max size received
|
||||||
|
@ -216,9 +234,9 @@ $ cat /sys/kernel/debug/wimax:wmx0/i2400m/rx_stats
|
||||||
Thus, to find the average buffer size received, divide accumulated
|
Thus, to find the average buffer size received, divide accumulated
|
||||||
RX-buffer / total RX-buffers.
|
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
|
$ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m_rx_stats
|
||||||
|
|
||||||
Likewise for TX.
|
Likewise for TX.
|
||||||
|
|
||||||
|
@ -227,14 +245,16 @@ $ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m_rx_stats
|
||||||
to the host. See drivers/net/wimax/i2400m/tx.c.
|
to the host. See drivers/net/wimax/i2400m/tx.c.
|
||||||
|
|
||||||
5.2.3. Tracing messages received from user space
|
5.2.3. Tracing messages received from user space
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
To echo messages received from user space into the trace pipe that the
|
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
|
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
|
$ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m/trace_msg_from_user
|
||||||
|
|
||||||
5.2.4. Performing a device reset
|
5.2.4. Performing a device reset
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
By writing a 0, a 1 or a 2 to the file
|
By writing a 0, a 1 or a 2 to the file
|
||||||
/sys/kernel/debug/wimax:wmx0/reset, the driver performs a warm (without
|
/sys/kernel/debug/wimax:wmx0/reset, the driver performs a warm (without
|
||||||
|
@ -242,18 +262,21 @@ $ echo 1 > /sys/kernel/debug/wimax:wmx0/i2400m/trace_msg_from_user
|
||||||
(bus specific) reset on the device.
|
(bus specific) reset on the device.
|
||||||
|
|
||||||
5.2.5. Asking the device to enter power saving mode
|
5.2.5. Asking the device to enter power saving mode
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
By writing any value to the /sys/kernel/debug/wimax:wmx0 file, the
|
By writing any value to the /sys/kernel/debug/wimax:wmx0 file, the
|
||||||
device will attempt to enter power saving mode.
|
device will attempt to enter power saving mode.
|
||||||
|
|
||||||
6. Troubleshooting
|
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
|
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
|
i2400m_usb 5-4:1.0: fw i2400m-fw-usb-1.3.sbcf: request failed: -2
|
||||||
|
|
||||||
This means that the driver cannot locate the firmware file named
|
This means that the driver cannot locate the firmware file named
|
||||||
/lib/firmware/i2400m-fw-usb-1.2.sbcf. Check that the file is present in
|
/lib/firmware/i2400m-fw-usb-1.2.sbcf. Check that the file is present in
|
19
Documentation/admin-guide/wimax/index.rst
Normal file
19
Documentation/admin-guide/wimax/index.rst
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
|
===============
|
||||||
|
WiMAX subsystem
|
||||||
|
===============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
wimax
|
||||||
|
|
||||||
|
i2400m
|
||||||
|
|
||||||
|
.. only:: subproject and html
|
||||||
|
|
||||||
|
Indices
|
||||||
|
=======
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
|
@ -1,12 +1,16 @@
|
||||||
|
.. 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 @@
|
||||||
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 @@
|
||||||
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 @@
|
||||||
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_\*
|
|
||||||
/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_reset
|
|
||||||
/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_debugfs
|
|
||||||
/sys/kernel/debug/wimax:wmx0/.... # other driver specific files
|
|
||||||
|
|
||||||
NOTE: Of course, if debugfs is mounted in a directory other than
|
# 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
|
||||||
|
/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_id_table
|
||||||
|
/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
|
||||||
/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 @@
|
||||||
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
|
||||||
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
|
||||||
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
|
||||||
|
|
Loading…
Reference in New Issue
Block a user