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

docs: networking: device drivers: convert 3com/vortex.txt to ReST 



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

Documentation/networking/device_drivers/3com/vortex.txt→Documentation/networking/device_drivers/3com/vortex.rst

+120 −107
Original line number Diff line number Diff line 
Documentation/networking/device_drivers/3com/vortex.txt

.. SPDX-License-Identifier: GPL-2.0



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

3Com Vortex device driver

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



Documentation/networking/device_drivers/3com/vortex.rst



Andrew Morton



30 April 2000
@@ -11,9 +19,9 @@ The driver was written by Donald Becker <becker@scyld.com> 
Don is no longer the prime maintainer of this version of the driver.

Please report problems to one or more of:



  Andrew Morton

  Netdev mailing list <netdev@vger.kernel.org>

  Linux kernel mailing list <linux-kernel@vger.kernel.org>

- Andrew Morton

- Netdev mailing list <netdev@vger.kernel.org>

- Linux kernel mailing list <linux-kernel@vger.kernel.org>



Please note the 'Reporting and Diagnosing Problems' section at the end

of this file.
@@ -24,56 +32,56 @@ Since kernel 2.3.99-pre6, this driver incorporates the support for the 


This driver supports the following hardware:



	3c590 Vortex 10Mbps

	3c592 EISA 10Mbps Demon/Vortex

	3c597 EISA Fast Demon/Vortex

	3c595 Vortex 100baseTx

	3c595 Vortex 100baseT4

	3c595 Vortex 100base-MII

	3c900 Boomerang 10baseT

	3c900 Boomerang 10Mbps Combo

	3c900 Cyclone 10Mbps TPO

	3c900 Cyclone 10Mbps Combo

	3c900 Cyclone 10Mbps TPC

	3c900B-FL Cyclone 10base-FL

	3c905 Boomerang 100baseTx

	3c905 Boomerang 100baseT4

	3c905B Cyclone 100baseTx

	3c905B Cyclone 10/100/BNC

	3c905B-FX Cyclone 100baseFx

	3c905C Tornado

	3c920B-EMB-WNM (ATI Radeon 9100 IGP)

	3c980 Cyclone

	3c980C Python-T

	3cSOHO100-TX Hurricane

	3c555 Laptop Hurricane

	3c556 Laptop Tornado

	3c556B Laptop Hurricane

	3c575 [Megahertz] 10/100 LAN  CardBus

	3c575 Boomerang CardBus

	3CCFE575BT Cyclone CardBus

	3CCFE575CT Tornado CardBus

	3CCFE656 Cyclone CardBus

	3CCFEM656B Cyclone+Winmodem CardBus

	3CXFEM656C Tornado+Winmodem CardBus

	3c450 HomePNA Tornado

	3c920 Tornado

	3c982 Hydra Dual Port A

	3c982 Hydra Dual Port B

	3c905B-T4

	3c920B-EMB-WNM Tornado

	- 3c590 Vortex 10Mbps

	- 3c592 EISA 10Mbps Demon/Vortex

	- 3c597 EISA Fast Demon/Vortex

	- 3c595 Vortex 100baseTx

	- 3c595 Vortex 100baseT4

	- 3c595 Vortex 100base-MII

	- 3c900 Boomerang 10baseT

	- 3c900 Boomerang 10Mbps Combo

	- 3c900 Cyclone 10Mbps TPO

	- 3c900 Cyclone 10Mbps Combo

	- 3c900 Cyclone 10Mbps TPC

	- 3c900B-FL Cyclone 10base-FL

	- 3c905 Boomerang 100baseTx

	- 3c905 Boomerang 100baseT4

	- 3c905B Cyclone 100baseTx

	- 3c905B Cyclone 10/100/BNC

	- 3c905B-FX Cyclone 100baseFx

	- 3c905C Tornado

	- 3c920B-EMB-WNM (ATI Radeon 9100 IGP)

	- 3c980 Cyclone

	- 3c980C Python-T

	- 3cSOHO100-TX Hurricane

	- 3c555 Laptop Hurricane

	- 3c556 Laptop Tornado

	- 3c556B Laptop Hurricane

	- 3c575 [Megahertz] 10/100 LAN  CardBus

	- 3c575 Boomerang CardBus

	- 3CCFE575BT Cyclone CardBus

	- 3CCFE575CT Tornado CardBus

	- 3CCFE656 Cyclone CardBus

	- 3CCFEM656B Cyclone+Winmodem CardBus

	- 3CXFEM656C Tornado+Winmodem CardBus

	- 3c450 HomePNA Tornado

	- 3c920 Tornado

	- 3c982 Hydra Dual Port A

	- 3c982 Hydra Dual Port B

	- 3c905B-T4

	- 3c920B-EMB-WNM Tornado



Module parameters

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



There are several parameters which may be provided to the driver when

its module is loaded.  These are usually placed in /etc/modprobe.d/*.conf

configuration files.  Example:

its module is loaded.  These are usually placed in ``/etc/modprobe.d/*.conf``

configuration files.  Example::



    options 3c59x debug=3 rx_copybreak=300



If you are using the PCMCIA tools (cardmgr) then the options may be

placed in /etc/pcmcia/config.opts:

placed in /etc/pcmcia/config.opts::



    module "3c59x" opts "debug=3 rx_copybreak=300"
@@ -89,7 +97,7 @@ options=N1,N2,N3,... 


  Each number in the list provides an option to the corresponding

  network card.  So if you have two 3c905's and you wish to provide

  them with option 0x204 you would use:

  them with option 0x204 you would use::



    options=0x204,0x204
@@ -97,6 +105,8 @@ options=N1,N2,N3,... 
  have the following meanings:



  Possible media type settings



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

	0	10baseT

	1	10Mbs AUI

	2	undefined
@@ -108,17 +118,20 @@ options=N1,N2,N3,... 
	8       Autonegotiate

	9       External MII

	10      Use default setting from EEPROM

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



  When generating a value for the 'options' setting, the above media

  selection values may be OR'ed (or added to) the following:



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

  0x8000  Set driver debugging level to 7

  0x4000  Set driver debugging level to 2

  0x0400  Enable Wake-on-LAN

  0x0200  Force full duplex mode.

  0x0010  Bus-master enable bit (Old Vortex cards only)

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



  For example:

  For example::



    insmod 3c59x options=0x204
@@ -127,14 +140,14 @@ options=N1,N2,N3,... 


global_options=N



  Sets the `options' parameter for all 3c59x NICs in the machine. 

  Entries in the `options' array above will override any setting of

  Sets the ``options`` parameter for all 3c59x NICs in the machine.

  Entries in the ``options`` array above will override any setting of

  this.



full_duplex=N1,N2,N3...



  Similar to bit 9 of 'options'.  Forces the corresponding card into

  full-duplex mode.  Please use this in preference to the `options'

  full-duplex mode.  Please use this in preference to the ``options``

  parameter.



  In fact, please don't use this at all! You're better off getting
@@ -143,7 +156,7 @@ full_duplex=N1,N2,N3... 
global_full_duplex=N1



  Sets full duplex mode for all 3c59x NICs in the machine.  Entries

  in the `full_duplex' array above will override any setting of this.

  in the ``full_duplex`` array above will override any setting of this.



flow_ctrl=N1,N2,N3...
@@ -196,11 +209,11 @@ hw_checksums=N1,N2,N3,... 


  This module parameter has been provided so you can override this

  decision.  If you think that Tx checksums are causing a problem, you

  may disable the feature with `hw_checksums=0'.

  may disable the feature with ``hw_checksums=0``.



  If you think your NIC should be performing Tx checksumming and the

  driver isn't enabling it, you can force the use of hardware Tx

  checksumming with `hw_checksums=1'.

  checksumming with ``hw_checksums=1``.



  The driver drops a message in the logfiles to indicate whether or

  not it is using hardware scatter/gather and hardware Tx checksums.
@@ -210,8 +223,8 @@ hw_checksums=N1,N2,N3,... 
  decrease in throughput for send().  There is no effect upon receive

  efficiency.



compaq_ioaddr=N

compaq_irq=N

compaq_ioaddr=N,

compaq_irq=N,

compaq_device_id=N



  "Variables to work-around the Compaq PCI BIOS32 problem"....
@@ -227,7 +240,7 @@ watchdog=N 
enable_wol=N1,N2,N3,...



  Enable Wake-on-LAN support for the relevant interface.  Donald

  Becker's `ether-wake' application may be used to wake suspended

  Becker's ``ether-wake`` application may be used to wake suspended

  machines.



  Also enables the NIC's power management support.
@@ -235,7 +248,7 @@ enable_wol=N1,N2,N3,... 
global_enable_wol=N



  Sets enable_wol mode for all 3c59x NICs in the machine.  Entries in

  the `enable_wol' array above will override any setting of this.

  the ``enable_wol`` array above will override any setting of this.



Media selection

---------------
@@ -325,7 +338,7 @@ Autonegotiation notes 


  Cisco switches    (Jeff Busch <jbusch@deja.com>)



    My "standard config" for ports to which PC's/servers connect directly:

    My "standard config" for ports to which PC's/servers connect directly::



	interface FastEthernet0/N

	description machinename
@@ -368,9 +381,9 @@ steps you should take: 


  But for most problems it is useful to provide the following:



   o Kernel version, driver version

   - Kernel version, driver version



   o A copy of the banner message which the driver generates when

   - A copy of the banner message which the driver generates when

     it is initialised.  For example:



     eth0: 3Com PCI 3c905C Tornado at 0xa400,  00:50:da:6a:88:f0, IRQ 19
@@ -378,12 +391,12 @@ steps you should take: 
     MII transceiver found at address 24, status 782d.

     Enabling bus-master transmits and whole-frame receives.



     NOTE: You must provide the `debug=2' modprobe option to generate

     a full detection message.  Please do this:

     NOTE: You must provide the ``debug=2`` modprobe option to generate

     a full detection message.  Please do this::



	modprobe 3c59x debug=2



   o If it is a PCI device, the relevant output from 'lspci -vx', eg:

   - If it is a PCI device, the relevant output from 'lspci -vx', eg::



       00:09.0 Ethernet controller: 3Com Corporation 3c905C-TX [Fast Etherlink] (rev 74)

	       Subsystem: 3Com Corporation: Unknown device 9200
@@ -397,29 +410,29 @@ steps you should take: 
       20: 00 00 00 00 00 00 00 00 00 00 00 00 b7 10 00 10

       30: 00 00 00 00 dc 00 00 00 00 00 00 00 05 01 0a 0a



   o A description of the environment: 10baseT? 100baseT?

   - A description of the environment: 10baseT? 100baseT?

     full/half duplex? switched or hubbed?



   o Any additional module parameters which you may be providing to the driver.

   - Any additional module parameters which you may be providing to the driver.



   o Any kernel logs which are produced.  The more the merrier. 

   - Any kernel logs which are produced.  The more the merrier.

     If this is a large file and you are sending your report to a

     mailing list, mention that you have the logfile, but don't send

     it.  If you're reporting direct to the maintainer then just send

     it.



     To ensure that all kernel logs are available, add the

     following line to /etc/syslog.conf:

     following line to /etc/syslog.conf::



	 kern.* /var/log/messages



     Then restart syslogd with:

     Then restart syslogd with::



	 /etc/rc.d/init.d/syslog restart



     (The above may vary, depending upon which Linux distribution you use).



    o If your problem is reproducible then that's great.  Try the

    - If your problem is reproducible then that's great.  Try the

      following:



      1) Increase the debug level.  Usually this is done via:

Documentation/networking/device_drivers/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -28,6 +28,7 @@ Contents: 
   pensando/ionic

   stmicro/stmmac

   3com/3c509

   3com/vortex



.. only::  subproject and html

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -147,7 +147,7 @@ Maintainers List 
M:	Steffen Klassert <klassert@kernel.org>

L:	netdev@vger.kernel.org

S:	Odd Fixes

F:	Documentation/networking/device_drivers/3com/vortex.txt

F:	Documentation/networking/device_drivers/3com/vortex.rst

F:	drivers/net/ethernet/3com/3c59x.c









3CR990 NETWORK DRIVER
































drivers/net/ethernet/3com/3c59x.c



+2
−2






























Original line number
Diff line number
Diff line







@@ -1149,7 +1149,7 @@ static int vortex_probe1(struct device *gendev, void __iomem *ioaddr, int irq,

















	print_info = (vortex_debug > 1);









	if (print_info)









		pr_info("See Documentation/networking/device_drivers/3com/vortex.txt\n");









		pr_info("See Documentation/networking/device_drivers/3com/vortex.rst\n");



















	pr_info("%s: 3Com %s %s at %p.\n",









	       print_name,








@@ -1954,7 +1954,7 @@ vortex_error(struct net_device *dev, int status)







				   dev->name, tx_status);









			if (tx_status == 0x82) {









				pr_err("Probably a duplex mismatch.  See "









						"Documentation/networking/device_drivers/3com/vortex.txt\n");









						"Documentation/networking/device_drivers/3com/vortex.rst\n");









			}









			dump_tx_ring(dev);









		}
































drivers/net/ethernet/3com/Kconfig



+1
−1






























Original line number
Diff line number
Diff line







@@ -76,7 +76,7 @@ config VORTEX







	  "Hurricane" (3c555/3cSOHO)                           PCI



















	  If you have such a card, say Y here.  More specific information is in









	  <file:Documentation/networking/device_drivers/3com/vortex.txt> and









	  <file:Documentation/networking/device_drivers/3com/vortex.rst> and









	  in the comments at the beginning of









	  <file:drivers/net/ethernet/3com/3c59x.c>.












































































CRA Git | Maintained and supported by SUSTech CRA and CCSE