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

docs: networking: device drivers: convert dec/de4x5.txt to ReST

- add SPDX header;
- add a document title;
- 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 b6671d71 e1ddedb5

+60 -48
+58 -47
Documentation/networking/device_drivers/dec/de4x5.txt Documentation/networking/device_drivers/dec/de4x5.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + =================================== 4 + DEC EtherWORKS Ethernet De4x5 cards 5 + =================================== 6 + 1 7 Originally, this driver was written for the Digital Equipment 2 8 Corporation series of EtherWORKS Ethernet cards: 3 9 4 - DE425 TP/COAX EISA 5 - DE434 TP PCI 6 - DE435 TP/COAX/AUI PCI 7 - DE450 TP/COAX/AUI PCI 8 - DE500 10/100 PCI Fasternet 10 + - DE425 TP/COAX EISA 11 + - DE434 TP PCI 12 + - DE435 TP/COAX/AUI PCI 13 + - DE450 TP/COAX/AUI PCI 14 + - DE500 10/100 PCI Fasternet 9 15 10 16 but it will now attempt to support all cards which conform to the 11 17 Digital Semiconductor SROM Specification. The driver currently 12 18 recognises the following chips: 13 19 14 - DC21040 (no SROM) 15 - DC21041[A] 16 - DC21140[A] 17 - DC21142 18 - DC21143 20 + - DC21040 (no SROM) 21 + - DC21041[A] 22 + - DC21140[A] 23 + - DC21142 24 + - DC21143 19 25 20 26 So far the driver is known to work with the following cards: 21 27 22 - KINGSTON 23 - Linksys 24 - ZNYX342 25 - SMC8432 26 - SMC9332 (w/new SROM) 27 - ZNYX31[45] 28 - ZNYX346 10/100 4 port (can act as a 10/100 bridge!) 28 + - KINGSTON 29 + - Linksys 30 + - ZNYX342 31 + - SMC8432 32 + - SMC9332 (w/new SROM) 33 + - ZNYX31[45] 34 + - ZNYX346 10/100 4 port (can act as a 10/100 bridge!) 29 35 30 36 The driver has been tested on a relatively busy network using the DE425, 31 37 DE434, DE435 and DE500 cards and benchmarked with 'ttcp': it transferred 32 - 16M of data to a DECstation 5000/200 as follows: 38 + 16M of data to a DECstation 5000/200 as follows:: 33 39 34 - TCP UDP 35 - TX RX TX RX 36 - DE425 1030k 997k 1170k 1128k 37 - DE434 1063k 995k 1170k 1125k 38 - DE435 1063k 995k 1170k 1125k 39 - DE500 1063k 998k 1170k 1125k in 10Mb/s mode 40 + TCP UDP 41 + TX RX TX RX 42 + DE425 1030k 997k 1170k 1128k 43 + DE434 1063k 995k 1170k 1125k 44 + DE435 1063k 995k 1170k 1125k 45 + DE500 1063k 998k 1170k 1125k in 10Mb/s mode 40 46 41 47 All values are typical (in kBytes/sec) from a sample of 4 for each 42 48 measurement. Their error is +/-20k on a quiet (private) network and also 43 49 depend on what load the CPU has. 44 50 45 - ========================================================================= 51 + ---------------------------------------------------------------------------- 46 52 47 53 The ability to load this driver as a loadable module has been included 48 54 and used extensively during the driver development (to save those long ··· 61 55 62 56 0) have a copy of the loadable modules code installed on your system. 63 57 1) copy de4x5.c from the /linux/drivers/net directory to your favourite 64 - temporary directory. 58 + temporary directory. 65 59 2) for fixed autoprobes (not recommended), edit the source code near 66 - line 5594 to reflect the I/O address you're using, or assign these when 67 - loading by: 60 + line 5594 to reflect the I/O address you're using, or assign these when 61 + loading by:: 68 62 69 - insmod de4x5 io=0xghh where g = bus number 70 - hh = device number 63 + insmod de4x5 io=0xghh where g = bus number 64 + hh = device number 71 65 72 - NB: autoprobing for modules is now supported by default. You may just 73 - use: 66 + .. note:: 74 67 75 - insmod de4x5 68 + autoprobing for modules is now supported by default. You may just 69 + use:: 76 70 77 - to load all available boards. For a specific board, still use 71 + insmod de4x5 72 + 73 + to load all available boards. For a specific board, still use 78 74 the 'io=?' above. 79 75 3) compile de4x5.c, but include -DMODULE in the command line to ensure 80 - that the correct bits are compiled (see end of source code). 76 + that the correct bits are compiled (see end of source code). 81 77 4) if you are wanting to add a new card, goto 5. Otherwise, recompile a 82 - kernel with the de4x5 configuration turned off and reboot. 78 + kernel with the de4x5 configuration turned off and reboot. 83 79 5) insmod de4x5 [io=0xghh] 84 - 6) run the net startup bits for your new eth?? interface(s) manually 85 - (usually /etc/rc.inet[12] at boot time). 80 + 6) run the net startup bits for your new eth?? interface(s) manually 81 + (usually /etc/rc.inet[12] at boot time). 86 82 7) enjoy! 87 83 88 - To unload a module, turn off the associated interface(s) 84 + To unload a module, turn off the associated interface(s) 89 85 'ifconfig eth?? down' then 'rmmod de4x5'. 90 86 91 87 Automedia detection is included so that in principle you can disconnect ··· 98 90 By default, the driver will now autodetect any DECchip based card. 99 91 Should you have a need to restrict the driver to DIGITAL only cards, you 100 92 can compile with a DEC_ONLY define, or if loading as a module, use the 101 - 'dec_only=1' parameter. 93 + 'dec_only=1' parameter. 102 94 103 95 I've changed the timing routines to use the kernel timer and scheduling 104 96 functions so that the hangs and other assorted problems that occurred ··· 166 158 either at the end of the parameter list or with another board name. The 167 159 following parameters are allowed: 168 160 169 - fdx for full duplex 170 - autosense to set the media/speed; with the following 171 - sub-parameters: 161 + ========= =============================================== 162 + fdx for full duplex 163 + autosense to set the media/speed; with the following 164 + sub-parameters: 172 165 TP, TP_NW, BNC, AUI, BNC_AUI, 100Mb, 10Mb, AUTO 166 + ========= =============================================== 173 167 174 168 Case sensitivity is important for the sub-parameters. They *must* be 175 - upper case. Examples: 169 + upper case. Examples:: 176 170 177 - insmod de4x5 args='eth1:fdx autosense=BNC eth0:autosense=100Mb'. 171 + insmod de4x5 args='eth1:fdx autosense=BNC eth0:autosense=100Mb'. 178 172 179 - For a compiled in driver, in linux/drivers/net/CONFIG, place e.g. 180 - DE4X5_OPTS = -DDE4X5_PARM='"eth0:fdx autosense=AUI eth2:autosense=TP"' 173 + For a compiled in driver, in linux/drivers/net/CONFIG, place e.g.:: 174 + 175 + DE4X5_OPTS = -DDE4X5_PARM='"eth0:fdx autosense=AUI eth2:autosense=TP"' 181 176 182 177 Yes, I know full duplex isn't permissible on BNC or AUI; they're just 183 178 examples. By default, full duplex is turned off and AUTO is the default
+1
Documentation/networking/device_drivers/index.rst
··· 34 34 chelsio/cxgb 35 35 cirrus/cs89x0 36 36 davicom/dm9000 37 + dec/de4x5 37 38 38 39 .. only:: subproject and html 39 40
+1 -1
drivers/net/ethernet/dec/tulip/Kconfig
··· 114 114 These include the DE425, DE434, DE435, DE450 and DE500 models. If 115 115 you have a network card of this type, say Y. More specific 116 116 information is contained in 117 - <file:Documentation/networking/device_drivers/dec/de4x5.txt>. 117 + <file:Documentation/networking/device_drivers/dec/de4x5.rst>. 118 118 119 119 To compile this driver as a module, choose M here. The module will 120 120 be called de4x5.