docs: networking: device drivers: convert ti/tlan.txt to ReST

- add SPDX header;
- adjust titles and chapters, adding proper markups;
- mark tables as such;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Mauro Carvalho Chehab
2020-05-01 16:44:56 +02:00
committed by David S. Miller
parent 6f22789da7
commit e9a5475e73
5 changed files with 52 additions and 28 deletions

View File

@@ -49,6 +49,7 @@ Contents:
smsc/smc9 smsc/smc9
ti/cpsw_switchdev ti/cpsw_switchdev
ti/cpsw ti/cpsw
ti/tlan
.. only:: subproject and html .. only:: subproject and html

View File

@@ -1,20 +1,33 @@
.. SPDX-License-Identifier: GPL-2.0
=====================
TLAN driver for Linux
=====================
:Version: 1.14a
(C) 1997-1998 Caldera, Inc. (C) 1997-1998 Caldera, Inc.
(C) 1998 James Banks (C) 1998 James Banks
(C) 1999-2001 Torben Mathiasen <tmm@image.dk, torben.mathiasen@compaq.com> (C) 1999-2001 Torben Mathiasen <tmm@image.dk, torben.mathiasen@compaq.com>
For driver information/updates visit http://www.compaq.com For driver information/updates visit http://www.compaq.com
TLAN driver for Linux, version 1.14a
README
I. Supported Devices.
I. Supported Devices
====================
Only PCI devices will work with this driver. Only PCI devices will work with this driver.
Supported: Supported:
========= ========= ===========================================
Vendor ID Device ID Name Vendor ID Device ID Name
========= ========= ===========================================
0e11 ae32 Compaq Netelligent 10/100 TX PCI UTP 0e11 ae32 Compaq Netelligent 10/100 TX PCI UTP
0e11 ae34 Compaq Netelligent 10 T PCI UTP 0e11 ae34 Compaq Netelligent 10 T PCI UTP
0e11 ae35 Compaq Integrated NetFlex 3/P 0e11 ae35 Compaq Integrated NetFlex 3/P
@@ -28,6 +41,7 @@ I. Supported Devices.
108d 0012 Olicom OC-2325 108d 0012 Olicom OC-2325
108d 0013 Olicom OC-2183 108d 0013 Olicom OC-2183
108d 0014 Olicom OC-2326 108d 0014 Olicom OC-2326
========= ========= ===========================================
Caveats: Caveats:
@@ -43,19 +57,23 @@ I. Supported Devices.
but I do not expect any problems. but I do not expect any problems.
II. Driver Options II. Driver Options
==================
1. You can append debug=x to the end of the insmod line to get 1. You can append debug=x to the end of the insmod line to get
debug messages, where x is a bit field where the bits mean debug messages, where x is a bit field where the bits mean
the following: the following:
==== =====================================
0x01 Turn on general debugging messages. 0x01 Turn on general debugging messages.
0x02 Turn on receive debugging messages. 0x02 Turn on receive debugging messages.
0x04 Turn on transmit debugging messages. 0x04 Turn on transmit debugging messages.
0x08 Turn on list debugging messages. 0x08 Turn on list debugging messages.
==== =====================================
2. You can append aui=1 to the end of the insmod line to cause 2. You can append aui=1 to the end of the insmod line to cause
the adapter to use the AUI interface instead of the 10 Base T the adapter to use the AUI interface instead of the 10 Base T
interface. This is also what to do if you want to use the BNC interface. This is also what to do if you want to use the BNC
connector on a TLAN based device. (Setting this option on a connector on a TLAN based device. (Setting this option on a
device that does not have an AUI/BNC connector will probably device that does not have an AUI/BNC connector will probably
cause it to not function correctly.) cause it to not function correctly.)
@@ -75,20 +93,22 @@ II. Driver Options
6. If the driver is built into the kernel, you can use the 3rd 6. If the driver is built into the kernel, you can use the 3rd
and 4th parameters to set aui and debug respectively. For and 4th parameters to set aui and debug respectively. For
example: example::
ether=0,0,0x1,0x7,eth0 ether=0,0,0x1,0x7,eth0
This sets aui to 0x1 and debug to 0x7, assuming eth0 is a This sets aui to 0x1 and debug to 0x7, assuming eth0 is a
supported TLAN device. supported TLAN device.
The bits in the third byte are assigned as follows: The bits in the third byte are assigned as follows:
0x01 = aui ==== ===============
0x02 = use half duplex 0x01 aui
0x04 = use full duplex 0x02 use half duplex
0x08 = use 10BaseT 0x04 use full duplex
0x10 = use 100BaseTx 0x08 use 10BaseT
0x10 use 100BaseTx
==== ===============
You also need to set both speed and duplex settings when forcing You also need to set both speed and duplex settings when forcing
speeds with kernel-parameters. speeds with kernel-parameters.
@@ -96,15 +116,17 @@ II. Driver Options
7. If you have more than one tlan adapter in your system, you can 7. If you have more than one tlan adapter in your system, you can
use the above options on a per adapter basis. To force a 100Mbit/HD use the above options on a per adapter basis. To force a 100Mbit/HD
link with your eth1 adapter use: link with your eth1 adapter use::
insmod tlan speed=0,100 duplex=0,1 insmod tlan speed=0,100 duplex=0,1
Now eth0 will use auto-neg and eth1 will be forced to 100Mbit/HD. Now eth0 will use auto-neg and eth1 will be forced to 100Mbit/HD.
Note that the tlan driver supports a maximum of 8 adapters. Note that the tlan driver supports a maximum of 8 adapters.
III. Things to try if you have problems. III. Things to try if you have problems
=======================================
1. Make sure your card's PCI id is among those listed in 1. Make sure your card's PCI id is among those listed in
section I, above. section I, above.
2. Make sure routing is correct. 2. Make sure routing is correct.
@@ -113,5 +135,6 @@ III. Things to try if you have problems.
There is also a tlan mailing list which you can join by sending "subscribe tlan" There is also a tlan mailing list which you can join by sending "subscribe tlan"
in the body of an email to majordomo@vuser.vu.union.edu. in the body of an email to majordomo@vuser.vu.union.edu.
There is also a tlan website at http://www.compaq.com There is also a tlan website at http://www.compaq.com

View File

@@ -16971,7 +16971,7 @@ M: Samuel Chessman <chessman@tux.org>
L: tlan-devel@lists.sourceforge.net (subscribers-only) L: tlan-devel@lists.sourceforge.net (subscribers-only)
S: Maintained S: Maintained
W: http://sourceforge.net/projects/tlan/ W: http://sourceforge.net/projects/tlan/
F: Documentation/networking/device_drivers/ti/tlan.txt F: Documentation/networking/device_drivers/ti/tlan.rst
F: drivers/net/ethernet/ti/tlan.* F: drivers/net/ethernet/ti/tlan.*
TM6000 VIDEO4LINUX DRIVER TM6000 VIDEO4LINUX DRIVER

View File

@@ -138,7 +138,7 @@ config TLAN
Devices currently supported by this driver are Compaq Netelligent, Devices currently supported by this driver are Compaq Netelligent,
Compaq NetFlex and Olicom cards. Please read the file Compaq NetFlex and Olicom cards. Please read the file
<file:Documentation/networking/device_drivers/ti/tlan.txt> <file:Documentation/networking/device_drivers/ti/tlan.rst>
for more details. for more details.
To compile this driver as a module, choose M here. The module To compile this driver as a module, choose M here. The module

View File

@@ -70,7 +70,7 @@ MODULE_DESCRIPTION("Driver for TI ThunderLAN based ethernet PCI adapters");
MODULE_LICENSE("GPL"); MODULE_LICENSE("GPL");
/* Turn on debugging. /* Turn on debugging.
* See Documentation/networking/device_drivers/ti/tlan.txt for details * See Documentation/networking/device_drivers/ti/tlan.rst for details
*/ */
static int debug; static int debug;
module_param(debug, int, 0); module_param(debug, int, 0);