Commit cf7eba49 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller
Browse files

docs: networking: device drivers: convert intel/ipw2100.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 dc67e91e

Documentation/networking/device_drivers/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -39,6 +39,7 @@ Contents: 
   dlink/dl2k

   freescale/dpaa

   freescale/gianfar

   intel/ipw2100



.. only::  subproject and html

Documentation/networking/device_drivers/intel/ipw2100.txt→Documentation/networking/device_drivers/intel/ipw2100.rst

+135 −105
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0

.. include:: <isonum.txt>



Intel(R) PRO/Wireless 2100 Driver for Linux in support of:

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

Intel(R) PRO/Wireless 2100 Driver for Linux

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



Intel(R) PRO/Wireless 2100 Network Connection

Support for:



Copyright (C) 2003-2006, Intel Corporation

- Intel(R) PRO/Wireless 2100 Network Connection



Copyright |copy| 2003-2006, Intel Corporation



README.ipw2100



Version: git-1.1.5

Date   : January 25, 2006

:Version: git-1.1.5

:Date:    January 25, 2006



.. Index



Index

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

    0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER

    1. Introduction

    2. Release git-1.1.5 Current Features
@@ -25,7 +31,7 @@ Index 




0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER

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

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



Important Notice FOR ALL USERS OR DISTRIBUTORS!!!!
@@ -75,7 +81,7 @@ obtain a tested driver from Intel Customer Support at: 
http://www.intel.com/support/wireless/sb/CS-006408.htm



1. Introduction

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

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



This document provides a brief overview of the features supported by the

IPW2100 driver project.  The main project website, where the latest
@@ -89,7 +95,8 @@ for the driver project. 




2. Release git-1.1.5 Current Supported Features

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

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



- Managed (BSS) and Ad-Hoc (IBSS)

- WEP (shared key and open)

- Wireless Tools support
@@ -105,11 +112,11 @@ performed on a given feature. 




3. Command Line Parameters

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

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



If the driver is built as a module, the following optional parameters are used

by entering them on the command line with the modprobe command using this

syntax:

syntax::



	modprobe ipw2100 [<option>=<VAL1><,VAL2>...]
@@ -119,61 +126,76 @@ For example, to disable the radio on driver loading, enter: 


The ipw2100 driver supports the following module parameters:



Name		Value		Example:

debug		0x0-0xffffffff	debug=1024

mode		0,1,2		mode=1   /* AdHoc */

channel		int		channel=3 /* Only valid in AdHoc or Monitor */

associate	boolean		associate=0 /* Do NOT auto associate */

disable		boolean		disable=1 /* Do not power the HW */

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

Name		Value		Example       Meaning

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

debug		0x0-0xffffffff	debug=1024    Debug level set to 1024

mode		0,1,2		mode=1        AdHoc

channel		int		channel=3     Only valid in AdHoc or Monitor

associate	boolean		associate=0   Do NOT auto associate

disable		boolean		disable=1     Do not power the HW

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





4. Sysfs Helper Files

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

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

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



There are several ways to control the behavior of the driver.  Many of the

general capabilities are exposed through the Wireless Tools (iwconfig).  There

are a few capabilities that are exposed through entries in the Linux Sysfs.





----- Driver Level ------

**Driver Level**



For the driver level files, look in /sys/bus/pci/drivers/ipw2100/



  debug_level

	

	This controls the same global as the 'debug' module parameter.  For

	information on the various debugging levels available, run the 'dvals'

	script found in the driver source directory.



	NOTE:  'debug_level' is only enabled if CONFIG_IPW2100_DEBUG is turn

	       on.

	.. note::



----- Device Level ------

For the device level files look in

	      'debug_level' is only enabled if CONFIG_IPW2100_DEBUG is turn on.



**Device Level**



For the device level files look in::



	/sys/bus/pci/drivers/ipw2100/{PCI-ID}/



For example:

For example::



	/sys/bus/pci/drivers/ipw2100/0000:02:01.0



For the device level files, see /sys/bus/pci/drivers/ipw2100:



  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)

	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

	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)

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



	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

	   based RF kill from ON -> OFF -> ON, the radio will NOT come back on





5. Radio Kill Switch

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

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



Most laptops provide the ability for the user to physically disable the radio.

Some vendors have implemented this as a physical switch that requires no

software to turn the radio off and on.  On other laptops, however, the switch
@@ -186,7 +208,8 @@ on your system. 




6. Dynamic Firmware

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

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



As the firmware is licensed under a restricted use license, it can not be

included within the kernel sources.  To enable the IPW2100 you will need a

firmware image to load into the wireless NIC's processors.
@@ -197,16 +220,19 @@ See INSTALL for instructions on installing the firmware. 




7. Power Management

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

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



The IPW2100 supports the configuration of the Power Save Protocol

through a private wireless extension interface.  The IPW2100 supports

the following different modes:



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

	off	No power management.  Radio is always on.

	on	Automatic power management

	1-5	Different levels of power management.  The higher the

		number the greater the power savings, but with an impact to

		packet latencies.

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



Power management works by powering down the radio after a certain

interval of time has passed where no packets are passed through the
@@ -220,12 +246,13 @@ any buffered packets. If you have an AP that does not correctly support 
the PSP protocol you may experience packet loss or very poor performance

while power management is enabled.  If this is the case, you will need

to try and find a firmware update for your AP, or disable power

management (via `iwconfig eth1 power off`)

management (via ``iwconfig eth1 power off``)



To configure the power level on the IPW2100 you use a combination of

iwconfig and iwpriv.  iwconfig is used to turn power management on, off,

and set it to auto.



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

	iwconfig eth1 power off    Disables radio power down

	iwconfig eth1 power on     Enables radio power management to

				   last set level (defaults to AUTO)
@@ -235,8 +262,9 @@ and set it to auto. 
	iwpriv eth1 set_power 1-5  Set the power level as specified,

				   enabling power management if not

				   previously enabled.

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



You can view the current power level setting via:

You can view the current power level setting via::



	iwpriv eth1 get_power
@@ -250,7 +278,7 @@ level if `iwconfig eth1 power on` is invoked. 




8. Support

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

==========



For general development information and support,

go to:
@@ -267,9 +295,9 @@ For installation support on the ipw2100 1.1.0 driver on Linux kernels 
    http://supportmail.intel.com



9. 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
@@ -288,6 +316,8 @@ For installation support on the ipw2100 1.1.0 driver on Linux kernels 
  file called LICENSE.



  License Contact Information:



  James P. Ketrenos <ipw2100-admin@linux.intel.com>



  Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -8742,7 +8742,7 @@ INTEL PRO/WIRELESS 2100, 2200BG, 2915ABG NETWORK CONNECTION SUPPORT 
M:	Stanislav Yakovlev <stas.yakovlev@gmail.com>

L:	linux-wireless@vger.kernel.org

S:	Maintained

F:	Documentation/networking/device_drivers/intel/ipw2100.txt

F:	Documentation/networking/device_drivers/intel/ipw2100.rst

F:	Documentation/networking/device_drivers/intel/ipw2200.txt

F:	drivers/net/wireless/intel/ipw2x00/
































drivers/net/wireless/intel/ipw2x00/Kconfig



+1
−1






























Original line number
Diff line number
Diff line







@@ -16,7 +16,7 @@ config IPW2100







	  A driver for the Intel PRO/Wireless 2100 Network









	  Connection 802.11b wireless network adapter.



















	  See <file:Documentation/networking/device_drivers/intel/ipw2100.txt>









	  See <file:Documentation/networking/device_drivers/intel/ipw2100.rst>









	  for information on the capabilities currently enabled in this driver









	  and for tips for debugging issues and problems.










































drivers/net/wireless/intel/ipw2x00/ipw2100.c



+1
−1






























Original line number
Diff line number
Diff line







@@ -8352,7 +8352,7 @@ static int ipw2100_mod_firmware_load(struct ipw2100_fw *fw)







	if (IPW2100_FW_MAJOR(h->version) != IPW2100_FW_MAJOR_VERSION) {









		printk(KERN_WARNING DRV_NAME ": Firmware image not compatible "









		       "(detected version id of %u). "









		       "See Documentation/networking/device_drivers/intel/ipw2100.txt\n",









		       "See Documentation/networking/device_drivers/intel/ipw2100.rst\n",









		       h->version);









		return 1;









	}