Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
David S. Miller
e9a5475e 6f22789d

+52 -28
+1
Documentation/networking/device_drivers/index.rst
··· 49 49 smsc/smc9 50 50 ti/cpsw_switchdev 51 51 ti/cpsw 52 + ti/tlan 52 53 53 54 .. only:: subproject and html 54 55
+48 -25
Documentation/networking/device_drivers/ti/tlan.txt Documentation/networking/device_drivers/ti/tlan.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ===================== 4 + TLAN driver for Linux 5 + ===================== 6 + 7 + :Version: 1.14a 8 + 1 9 (C) 1997-1998 Caldera, Inc. 10 + 2 11 (C) 1998 James Banks 12 + 3 13 (C) 1999-2001 Torben Mathiasen <tmm@image.dk, torben.mathiasen@compaq.com> 4 14 5 15 For driver information/updates visit http://www.compaq.com 6 16 7 17 8 - TLAN driver for Linux, version 1.14a 9 - README 10 18 11 19 12 - I. Supported Devices. 20 + 21 + I. Supported Devices 22 + ==================== 13 23 14 24 Only PCI devices will work with this driver. 15 25 16 26 Supported: 27 + 28 + ========= ========= =========================================== 17 29 Vendor ID Device ID Name 30 + ========= ========= =========================================== 18 31 0e11 ae32 Compaq Netelligent 10/100 TX PCI UTP 19 32 0e11 ae34 Compaq Netelligent 10 T PCI UTP 20 33 0e11 ae35 Compaq Integrated NetFlex 3/P ··· 38 25 0e11 b030 Compaq Netelligent 10/100 TX UTP 39 26 0e11 f130 Compaq NetFlex 3/P 40 27 0e11 f150 Compaq NetFlex 3/P 41 - 108d 0012 Olicom OC-2325 28 + 108d 0012 Olicom OC-2325 42 29 108d 0013 Olicom OC-2183 43 - 108d 0014 Olicom OC-2326 30 + 108d 0014 Olicom OC-2326 31 + ========= ========= =========================================== 44 32 45 33 46 34 Caveats: 47 - 35 + 48 36 I am not sure if 100BaseTX daughterboards (for those cards which 49 37 support such things) will work. I haven't had any solid evidence 50 38 either way. ··· 55 41 56 42 The "Netelligent 10 T/2 PCI UTP/Coax" (b012) device is untested, 57 43 but I do not expect any problems. 58 - 59 44 60 - II. Driver Options 45 + 46 + II. Driver Options 47 + ================== 48 + 61 49 1. You can append debug=x to the end of the insmod line to get 62 - debug messages, where x is a bit field where the bits mean 50 + debug messages, where x is a bit field where the bits mean 63 51 the following: 64 - 52 + 53 + ==== ===================================== 65 54 0x01 Turn on general debugging messages. 66 55 0x02 Turn on receive debugging messages. 67 56 0x04 Turn on transmit debugging messages. 68 57 0x08 Turn on list debugging messages. 58 + ==== ===================================== 69 59 70 60 2. You can append aui=1 to the end of the insmod line to cause 71 - the adapter to use the AUI interface instead of the 10 Base T 72 - interface. This is also what to do if you want to use the BNC 61 + the adapter to use the AUI interface instead of the 10 Base T 62 + interface. This is also what to do if you want to use the BNC 73 63 connector on a TLAN based device. (Setting this option on a 74 64 device that does not have an AUI/BNC connector will probably 75 65 cause it to not function correctly.) ··· 88 70 89 71 5. You have to use speed=X duplex=Y together now. If you just 90 72 do "insmod tlan.o speed=100" the driver will do Auto-Neg. 91 - To force a 10Mbps Half-Duplex link do "insmod tlan.o speed=10 73 + To force a 10Mbps Half-Duplex link do "insmod tlan.o speed=10 92 74 duplex=1". 93 75 94 76 6. If the driver is built into the kernel, you can use the 3rd 95 77 and 4th parameters to set aui and debug respectively. For 96 - example: 78 + example:: 97 79 98 - ether=0,0,0x1,0x7,eth0 80 + ether=0,0,0x1,0x7,eth0 99 81 100 82 This sets aui to 0x1 and debug to 0x7, assuming eth0 is a 101 83 supported TLAN device. 102 84 103 85 The bits in the third byte are assigned as follows: 104 86 105 - 0x01 = aui 106 - 0x02 = use half duplex 107 - 0x04 = use full duplex 108 - 0x08 = use 10BaseT 109 - 0x10 = use 100BaseTx 87 + ==== =============== 88 + 0x01 aui 89 + 0x02 use half duplex 90 + 0x04 use full duplex 91 + 0x08 use 10BaseT 92 + 0x10 use 100BaseTx 93 + ==== =============== 110 94 111 95 You also need to set both speed and duplex settings when forcing 112 - speeds with kernel-parameters. 96 + speeds with kernel-parameters. 113 97 ether=0,0,0x12,0,eth0 will force link to 100Mbps Half-Duplex. 114 98 115 99 7. If you have more than one tlan adapter in your system, you can 116 100 use the above options on a per adapter basis. To force a 100Mbit/HD 117 - link with your eth1 adapter use: 118 - 119 - insmod tlan speed=0,100 duplex=0,1 101 + link with your eth1 adapter use:: 102 + 103 + insmod tlan speed=0,100 duplex=0,1 120 104 121 105 Now eth0 will use auto-neg and eth1 will be forced to 100Mbit/HD. 122 106 Note that the tlan driver supports a maximum of 8 adapters. 123 107 124 108 125 - III. Things to try if you have problems. 109 + III. Things to try if you have problems 110 + ======================================= 111 + 126 112 1. Make sure your card's PCI id is among those listed in 127 113 section I, above. 128 114 2. Make sure routing is correct. ··· 135 113 136 114 There is also a tlan mailing list which you can join by sending "subscribe tlan" 137 115 in the body of an email to majordomo@vuser.vu.union.edu. 116 + 138 117 There is also a tlan website at http://www.compaq.com 139 118
+1 -1
MAINTAINERS
··· 16971 16971 L: tlan-devel@lists.sourceforge.net (subscribers-only) 16972 16972 S: Maintained 16973 16973 W: http://sourceforge.net/projects/tlan/ 16974 - F: Documentation/networking/device_drivers/ti/tlan.txt 16974 + F: Documentation/networking/device_drivers/ti/tlan.rst 16975 16975 F: drivers/net/ethernet/ti/tlan.* 16976 16976 16977 16977 TM6000 VIDEO4LINUX DRIVER
+1 -1
drivers/net/ethernet/ti/Kconfig
··· 138 138 139 139 Devices currently supported by this driver are Compaq Netelligent, 140 140 Compaq NetFlex and Olicom cards. Please read the file 141 - <file:Documentation/networking/device_drivers/ti/tlan.txt> 141 + <file:Documentation/networking/device_drivers/ti/tlan.rst> 142 142 for more details. 143 143 144 144 To compile this driver as a module, choose M here. The module
+1 -1
drivers/net/ethernet/ti/tlan.c
··· 70 70 MODULE_LICENSE("GPL"); 71 71 72 72 /* Turn on debugging. 73 - * See Documentation/networking/device_drivers/ti/tlan.txt for details 73 + * See Documentation/networking/device_drivers/ti/tlan.rst for details 74 74 */ 75 75 static int debug; 76 76 module_param(debug, int, 0);