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

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent e1ddedb5

Documentation/networking/device_drivers/dec/de4x5.txt→Documentation/networking/device_drivers/dec/de4x5.rst

+58 −47
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



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

DEC EtherWORKS Ethernet De4x5 cards

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



    Originally,   this  driver  was    written  for the  Digital   Equipment

    Corporation series of EtherWORKS Ethernet cards:



        DE425 TP/COAX EISA

	DE434 TP PCI

	DE435 TP/COAX/AUI PCI

	DE450 TP/COAX/AUI PCI

	DE500 10/100 PCI Fasternet

	 - DE425 TP/COAX EISA

	 - DE434 TP PCI

	 - DE435 TP/COAX/AUI PCI

	 - DE450 TP/COAX/AUI PCI

	 - DE500 10/100 PCI Fasternet



    but it  will  now attempt  to  support all  cards which   conform to the

    Digital Semiconductor   SROM   Specification.    The  driver   currently

    recognises the following chips:



        DC21040  (no SROM) 

	DC21041[A]  

	DC21140[A] 

	DC21142 

	DC21143 

	 - DC21040  (no SROM)

	 - DC21041[A]

	 - DC21140[A]

	 - DC21142

	 - DC21143



    So far the driver is known to work with the following cards:



        KINGSTON

	Linksys

	ZNYX342

	SMC8432

	SMC9332 (w/new SROM)

	ZNYX31[45]

	ZNYX346 10/100 4 port (can act as a 10/100 bridge!) 

	 - KINGSTON

	 - Linksys

	 - ZNYX342

	 - SMC8432

	 - SMC9332 (w/new SROM)

	 - ZNYX31[45]

	 - ZNYX346 10/100 4 port (can act as a 10/100 bridge!)



    The driver has been tested on a relatively busy network using the DE425,

    DE434, DE435 and DE500 cards and benchmarked with 'ttcp': it transferred

    16M of data to a DECstation 5000/200 as follows:

    16M of data to a DECstation 5000/200 as follows::



		  TCP           UDP

	       TX     RX     TX     RX
@@ -42,7 +48,7 @@ 
    measurement. Their error is +/-20k on a quiet (private) network and also

    depend on what load the CPU has.



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

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



    The ability to load this  driver as a loadable  module has been included

    and used extensively  during the driver development  (to save those long
@@ -58,13 +64,15 @@ 
       temporary directory.

    2) for fixed  autoprobes (not  recommended),  edit the source code  near

       line 5594 to reflect the I/O address  you're using, or assign these when

    loading by:

       loading by::



		   insmod de4x5 io=0xghh           where g = bus number

							hh = device number



       NB: autoprobing for modules is now supported by default. You may just

           use:

       .. note::



	   autoprobing for modules is now supported by default. You may just

	   use::



		   insmod de4x5
@@ -158,17 +166,20 @@ 
    either at the end of the parameter list or with another board name.  The

    following parameters are allowed:



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

	    fdx        for full duplex

	    autosense  to set the media/speed; with the following

		       sub-parameters:

		       TP, TP_NW, BNC, AUI, BNC_AUI, 100Mb, 10Mb, AUTO

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



    Case sensitivity is important  for  the sub-parameters. They *must*   be

    upper case. Examples:

    upper case. Examples::



	insmod de4x5 args='eth1:fdx autosense=BNC eth0:autosense=100Mb'.



    For a compiled in driver, in linux/drivers/net/CONFIG, place e.g.

    For a compiled in driver, in linux/drivers/net/CONFIG, place e.g.::



	DE4X5_OPTS = -DDE4X5_PARM='"eth0:fdx autosense=AUI eth2:autosense=TP"'



    Yes,  I know full duplex  isn't permissible on BNC  or AUI; they're just

Documentation/networking/device_drivers/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -34,6 +34,7 @@ Contents: 
   chelsio/cxgb

   cirrus/cs89x0

   davicom/dm9000

   dec/de4x5



.. only::  subproject and html

drivers/net/ethernet/dec/tulip/Kconfig

+1 −1
Original line number Diff line number Diff line
@@ -114,7 +114,7 @@ config DE4X5 
	  These include the DE425, DE434, DE435, DE450 and DE500 models.  If

	  you have a network card of this type, say Y.  More specific

	  information is contained in

	  <file:Documentation/networking/device_drivers/dec/de4x5.txt>.

	  <file:Documentation/networking/device_drivers/dec/de4x5.rst>.



	  To compile this driver as a module, choose M here. The module will

	  be called de4x5.

CRA Git | Maintained and supported by SUSTech CRA and CCSE