Skip to content

L
linux
Commit c81f1957 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller
Browse files
Options

docs: networking: device drivers: convert intel/ipw2200.txt to ReST 

- add SPDX header;
- adjust titles and chapters, adding proper markups;
- comment out text-only TOC from html/pdf output;
- use copyright symbol;
- use :field: markup;
- mark code blocks and literals as such;
- mark tables as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent cf7eba49
Show whitespace changes
Inline Side-by-side
Showing with 237 additions and 182 deletions
Documentation/networking/device_drivers/index.rst
View file @ c81f1957
......@@ -40,6 +40,7 @@ Contents:
freescale/dpaa
freescale/gianfar
intel/ipw2100
intel/ipw2200
.. only:: subproject and html
......
Documentation/networking/device_drivers/intel/ipw2200.txt → Documentation/networking/device_drivers/intel/ipw2200.rst
View file @ c81f1957
.. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
Intel(R) PRO/Wireless 2915ABG Driver for Linux in support of:
==============================================
Intel(R) PRO/Wireless 2915ABG Driver for Linux
==============================================
Intel(R) PRO/Wireless 2200BG Network Connection
Intel(R) PRO/Wireless 2915ABG Network Connection
Support for:
- Intel(R) PRO/Wireless 2200BG Network Connection
- Intel(R) PRO/Wireless 2915ABG Network Connection
Note: The Intel(R) PRO/Wireless 2915ABG Driver for Linux and Intel(R)
PRO/Wireless 2200BG Driver for Linux is a unified driver that works on
......@@ -10,35 +17,35 @@ both hardware adapters listed above. In this document the Intel(R)
PRO/Wireless 2915ABG Driver for Linux will be used to reference the
unified driver.
Copyright (C) 2004-2006, Intel Corporation
Copyright |copy| 2004-2006, Intel Corporation
README.ipw2200
Version: 1.1.2
Date : March 30, 2006
:Version: 1.1.2
:Date: March 30, 2006
Index
-----------------------------------------------
0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER
1. Introduction
1.1. Overview of features
1.2. Module parameters
1.3. Wireless Extension Private Methods
1.4. Sysfs Helper Files
1.5. Supported channels
2. Ad-Hoc Networking
3. Interacting with Wireless Tools
3.1. iwconfig mode
3.2. iwconfig sens
4. About the Version Numbers
5. Firmware installation
6. Support
7. License
.. Index
0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER
1. Introduction
1.1. Overview of features
1.2. Module parameters
1.3. Wireless Extension Private Methods
1.4. Sysfs Helper Files
1.5. Supported channels
2. Ad-Hoc Networking
3. Interacting with Wireless Tools
3.1. iwconfig mode
3.2. iwconfig sens
4. About the Version Numbers
5. Firmware installation
6. Support
7. License
0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER
-----------------------------------------------
=================================================
Important Notice FOR ALL USERS OR DISTRIBUTORS!!!!
......@@ -89,7 +96,8 @@ http://support.intel.com
1. Introduction
-----------------------------------------------
===============
The following sections attempt to provide a brief introduction to using
the Intel(R) PRO/Wireless 2915ABG Driver for Linux.
......@@ -102,7 +110,7 @@ file.
1.1. Overview of Features
-----------------------------------------------
-------------------------
The current release (1.1.2) supports the following features:
+ BSS mode (Infrastructure, Managed)
......@@ -129,16 +137,16 @@ performed on a given feature.
1.2. Command Line Parameters
-----------------------------------------------
----------------------------
Like many modules used in the Linux kernel, the Intel(R) PRO/Wireless
2915ABG Driver for Linux allows configuration options to be provided
as module parameters. The most common way to specify a module parameter
is via the command line.
The general form is:
The general form is::
% modprobe ipw2200 parameter=value
% modprobe ipw2200 parameter=value
Where the supported parameter are:
......@@ -179,7 +187,7 @@ Where the supported parameter are:
1.3. Wireless Extension Private Methods
-----------------------------------------------
---------------------------------------
As an interface designed to handle generic hardware, there are certain
capabilities not exposed through the normal Wireless Tool interface. As
......@@ -187,7 +195,7 @@ such, a provision is provided for a driver to declare custom, or
private, methods. The Intel(R) PRO/Wireless 2915ABG Driver for Linux
defines several of these to configure various settings.
The general form of using the private wireless methods is:
The general form of using the private wireless methods is::
% iwpriv $IFNAME method parameters
......@@ -208,9 +216,13 @@ The supported private methods are:
Can be used to configure which IEEE mode the driver will
support.
Usage:
Usage::
% iwpriv eth1 set_mode {mode}
Where {mode} is a number in the range 1-7:
== =====================
1 802.11a (2915 only)
2 802.11b
3 802.11ab (2915 only)
......@@ -218,6 +230,7 @@ The supported private methods are:
5 802.11ag (2915 only)
6 802.11bg
7 802.11abg (2915 only)
== =====================
get_preamble
Can be used to report configuration of preamble length.
......@@ -225,15 +238,20 @@ The supported private methods are:
set_preamble
Can be used to set the configuration of preamble length:
Usage:
Usage::
% iwpriv eth1 set_preamble {mode}
Where {mode} is one of:
== ========================================
1 Long preamble only
0 Auto (long or short based on connection)
== ========================================
1.4. Sysfs Helper Files:
-----------------------------------------------
1.4. Sysfs Helper Files
-----------------------
The Linux kernel provides a pseudo file system that can be used to
access various components of the operating system. The Intel(R)
......@@ -242,17 +260,17 @@ parameters through this mechanism.
An entry in the sysfs can support reading and/or writing. You can
typically query the contents of a sysfs entry through the use of cat,
and can set the contents via echo. For example:
and can set the contents via echo. For example::
% cat /sys/bus/pci/drivers/ipw2200/debug_level
% cat /sys/bus/pci/drivers/ipw2200/debug_level
Will report the current debug level of the driver's logging subsystem
(only available if CONFIG_IPW2200_DEBUG was configured when the driver
was built).
You can set the debug level via:
You can set the debug level via::
% echo $VALUE > /sys/bus/pci/drivers/ipw2200/debug_level
% echo $VALUE > /sys/bus/pci/drivers/ipw2200/debug_level
Where $VALUE would be a number in the case of this sysfs entry. The
input to sysfs files does not have to be a number. For example, the
......@@ -266,39 +284,48 @@ level, which applies only to the single specific instance.
1.4.1 Driver Level Sysfs Helper Files
-----------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For the driver level files, look in /sys/bus/pci/drivers/ipw2200/
debug_level
This controls the same global as the 'debug' module parameter
1.4.2 Device Level Sysfs Helper Files
-----------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For the device level files, look in
For the device level files, look in::
/sys/bus/pci/drivers/ipw2200/{PCI-ID}/
For example:
For example:::
/sys/bus/pci/drivers/ipw2200/0000:02:01.0
For the device level files, see /sys/bus/pci/drivers/ipw2200:
rf_kill
read -
0 = RF kill not enabled (radio on)
1 = SW based RF kill active (radio off)
2 = HW based RF kill active (radio off)
3 = Both HW and SW RF kill active (radio off)
== =========================================
0 RF kill not enabled (radio on)
1 SW based RF kill active (radio off)
2 HW based RF kill active (radio off)
3 Both HW and SW RF kill active (radio off)
== =========================================
write -
0 = If SW based RF kill active, turn the radio back on
1 = If radio is on, activate SW based RF kill
NOTE: If you enable the SW based RF kill and then toggle the HW
== ==================================================
0 If SW based RF kill active, turn the radio back on
1 If radio is on, activate SW based RF kill
== ==================================================
.. note::
If you enable the SW based RF kill and then toggle the HW
based RF kill from ON -> OFF -> ON, the radio will NOT come back on
ucode
......@@ -306,18 +333,28 @@ For the device level files, see /sys/bus/pci/drivers/ipw2200:
led
read -
0 = LED code disabled
1 = LED code enabled
== =================
0 LED code disabled
1 LED code enabled
== =================
write -
0 = Disable LED code
1 = Enable LED code
NOTE: The LED code has been reported to hang some systems when
== ================
0 Disable LED code
1 Enable LED code
== ================
.. note::
The LED code has been reported to hang some systems when
running ifconfig and is therefore disabled by default.
1.5. Supported channels
-----------------------------------------------
-----------------------
Upon loading the Intel(R) PRO/Wireless 2915ABG Driver for Linux, a
message stating the detected geography code and the number of 802.11
......@@ -326,27 +363,42 @@ channels supported by the card will be displayed in the log.
The geography code corresponds to a regulatory domain as shown in the
table below.
Supported channels
Code Geography 802.11bg 802.11a
--- Restricted 11 0
ZZF Custom US/Canada 11 8
ZZD Rest of World 13 0
ZZA Custom USA & Europe & High 11 13
ZZB Custom NA & Europe 11 13
ZZC Custom Japan 11 4
ZZM Custom 11 0
ZZE Europe 13 19
ZZJ Custom Japan 14 4
ZZR Rest of World 14 0
ZZH High Band 13 4
ZZG Custom Europe 13 4
ZZK Europe 13 24
ZZL Europe 11 13
+------+----------------------------+--------------------+
| | | Supported channels |
| Code | Geography +----------+---------+
| | | 802.11bg | 802.11a |
+======+============================+==========+=========+
| --- | Restricted | 11 | 0 |
+------+----------------------------+----------+---------+
| ZZF | Custom US/Canada | 11 | 8 |
+------+----------------------------+----------+---------+
| ZZD | Rest of World | 13 | 0 |
+------+----------------------------+----------+---------+
| ZZA | Custom USA & Europe & High | 11 | 13 |
+------+----------------------------+----------+---------+
| ZZB | Custom NA & Europe | 11 | 13 |
+------+----------------------------+----------+---------+
| ZZC | Custom Japan | 11 | 4 |
+------+----------------------------+----------+---------+
| ZZM | Custom | 11 | 0 |
+------+----------------------------+----------+---------+
| ZZE | Europe | 13 | 19 |
+------+----------------------------+----------+---------+
| ZZJ | Custom Japan | 14 | 4 |
+------+----------------------------+----------+---------+
| ZZR | Rest of World | 14 | 0 |
+------+----------------------------+----------+---------+
| ZZH | High Band | 13 | 4 |
+------+----------------------------+----------+---------+
| ZZG | Custom Europe | 13 | 4 |
+------+----------------------------+----------+---------+
| ZZK | Europe | 13 | 24 |
+------+----------------------------+----------+---------+
| ZZL | Europe | 11 | 13 |
+------+----------------------------+----------+---------+
2. Ad-Hoc Networking
-----------------------------------------------
=====================
When using a device in an Ad-Hoc network, it is useful to understand the
sequence and requirements for the driver to be able to create, join, or
......@@ -357,13 +409,13 @@ have a consistent experience while using the driver as a member of an
Ad-Hoc network.
2.1. Joining an Ad-Hoc Network
-----------------------------------------------
------------------------------
The easiest way to get onto an Ad-Hoc network is to join one that
already exists.
2.2. Creating an Ad-Hoc Network
-----------------------------------------------
-------------------------------
An Ad-Hoc networks is created using the syntax of the Wireless tool.
......@@ -371,21 +423,21 @@ For Example:
iwconfig eth1 mode ad-hoc essid testing channel 2
2.3. Merging Ad-Hoc Networks
-----------------------------------------------
----------------------------
3. Interaction with Wireless Tools
-----------------------------------------------
==================================
3.1 iwconfig mode
-----------------------------------------------
-----------------
When configuring the mode of the adapter, all run-time configured parameters
are reset to the value used when the module was loaded. This includes
channels, rates, ESSID, etc.
3.2 iwconfig sens
-----------------------------------------------
-----------------
The 'iwconfig ethX sens XX' command will not set the signal sensitivity
threshold, as described in iwconfig documentation, but rather the number
......@@ -395,7 +447,7 @@ threshold to 3 times the given value.
4. About the Version Numbers
-----------------------------------------------
=============================
Due to the nature of open source development projects, there are
frequently changes being incorporated that have not gone through
......@@ -422,7 +474,7 @@ The major version number will be incremented when significant changes
are made to the driver. Currently, there are no major changes planned.
5. Firmware installation
----------------------------------------------
========================
The driver requires a firmware image, download it and extract the
files under /lib/firmware (or wherever your hotplug's firmware.agent
......@@ -434,7 +486,7 @@ The firmware can be downloaded from the following URL:
6. Support
-----------------------------------------------
==========
For direct support of the 1.0.0 version, you can contact
http://supportmail.intel.com, or you can use the open source project
......@@ -446,9 +498,9 @@ For general information and support, go to:
7. License
-----------------------------------------------
==========
Copyright(c) 2003 - 2006 Intel Corporation. All rights reserved.
Copyright |copy| 2003 - 2006 Intel Corporation. All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as
......@@ -467,6 +519,8 @@ For general information and support, go to:
file called LICENSE.
Contact Information:
James P. Ketrenos <ipw2100-admin@linux.intel.com>
Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
MAINTAINERS
View file @ c81f1957
......@@ -8743,7 +8743,7 @@ M: Stanislav Yakovlev <stas.yakovlev@gmail.com>
L: linux-wireless@vger.kernel.org
S: Maintained
F: Documentation/networking/device_drivers/intel/ipw2100.rst
F: Documentation/networking/device_drivers/intel/ipw2200.txt
F: Documentation/networking/device_drivers/intel/ipw2200.rst
F: drivers/net/wireless/intel/ipw2x00/
INTEL PSTATE DRIVER
......
drivers/net/wireless/intel/ipw2x00/Kconfig
View file @ c81f1957
......@@ -78,7 +78,7 @@ config IPW2200
A driver for the Intel PRO/Wireless 2200BG and 2915ABG Network
Connection adapters.
See <file:Documentation/networking/device_drivers/intel/ipw2200.txt>
See <file:Documentation/networking/device_drivers/intel/ipw2200.rst>
for information on the capabilities currently enabled in this
driver and for tips for debugging issues and problems.
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7