From 55f35cf79d68136ef6a2e39a232a86f4418e7df7 Mon Sep 17 00:00:00 2001 From: Jakub Kicinski Date: Fri, 26 Jun 2020 10:27:31 -0700 Subject: docs: networking: move FDDI drivers to the hw driver section Move docs for defza and skfp under device_drivers/fddi. Signed-off-by: Jakub Kicinski Signed-off-by: David S. Miller --- Documentation/networking/defza.rst | 63 ----- .../networking/device_drivers/fddi/defza.rst | 63 +++++ .../networking/device_drivers/fddi/index.rst | 19 ++ .../networking/device_drivers/fddi/skfp.rst | 253 +++++++++++++++++++++ Documentation/networking/device_drivers/index.rst | 1 + Documentation/networking/index.rst | 2 - Documentation/networking/skfp.rst | 253 --------------------- drivers/net/fddi/Kconfig | 4 +- 8 files changed, 338 insertions(+), 320 deletions(-) delete mode 100644 Documentation/networking/defza.rst create mode 100644 Documentation/networking/device_drivers/fddi/defza.rst create mode 100644 Documentation/networking/device_drivers/fddi/index.rst create mode 100644 Documentation/networking/device_drivers/fddi/skfp.rst delete mode 100644 Documentation/networking/skfp.rst diff --git a/Documentation/networking/defza.rst b/Documentation/networking/defza.rst deleted file mode 100644 index 73c2f793ea26..000000000000 --- a/Documentation/networking/defza.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0 - -===================================================== -Notes on the DEC FDDIcontroller 700 (DEFZA-xx) driver -===================================================== - -:Version: v.1.1.4 - - -DEC FDDIcontroller 700 is DEC's first-generation TURBOchannel FDDI -network card, designed in 1990 specifically for the DECstation 5000 -model 200 workstation. The board is a single attachment station and -it was manufactured in two variations, both of which are supported. - -First is the SAS MMF DEFZA-AA option, the original design implementing -the standard MMF-PMD, however with a pair of ST connectors rather than -the usual MIC connector. The other one is the SAS ThinWire/STP DEFZA-CA -option, denoted 700-C, with the network medium selectable by a switch -between the DEC proprietary ThinWire-PMD using a BNC connector and the -standard STP-PMD using a DE-9F connector. This option can interface to -a DECconcentrator 500 device and, in the case of the STP-PMD, also other -FDDI equipment and was designed to make it easier to transition from -existing IEEE 802.3 10BASE2 Ethernet and IEEE 802.5 Token Ring networks -by providing means to reuse existing cabling. - -This driver handles any number of cards installed in a single system. -They get fddi0, fddi1, etc. interface names assigned in the order of -increasing TURBOchannel slot numbers. - -The board only supports DMA on the receive side. Transmission involves -the use of PIO. As a result under a heavy transmission load there will -be a significant impact on system performance. - -The board supports a 64-entry CAM for matching destination addresses. -Two entries are preoccupied by the Directed Beacon and Ring Purger -multicast addresses and the rest is used as a multicast filter. An -all-multi mode is also supported for LLC frames and it is used if -requested explicitly or if the CAM overflows. The promiscuous mode -supports separate enables for LLC and SMT frames, but this driver -doesn't support changing them individually. - - -Known problems: - -None. - - -To do: - -5. MAC address change. The card does not support changing the Media - Access Controller's address registers but a similar effect can be - achieved by adding an alias to the CAM. There is no way to disable - matching against the original address though. - -7. Queueing incoming/outgoing SMT frames in the driver if the SMT - receive/RMC transmit ring is full. (?) - -8. Retrieving/reporting FDDI/SNMP stats. - - -Both success and failure reports are welcome. - -Maciej W. Rozycki diff --git a/Documentation/networking/device_drivers/fddi/defza.rst b/Documentation/networking/device_drivers/fddi/defza.rst new file mode 100644 index 000000000000..73c2f793ea26 --- /dev/null +++ b/Documentation/networking/device_drivers/fddi/defza.rst @@ -0,0 +1,63 @@ +.. SPDX-License-Identifier: GPL-2.0 + +===================================================== +Notes on the DEC FDDIcontroller 700 (DEFZA-xx) driver +===================================================== + +:Version: v.1.1.4 + + +DEC FDDIcontroller 700 is DEC's first-generation TURBOchannel FDDI +network card, designed in 1990 specifically for the DECstation 5000 +model 200 workstation. The board is a single attachment station and +it was manufactured in two variations, both of which are supported. + +First is the SAS MMF DEFZA-AA option, the original design implementing +the standard MMF-PMD, however with a pair of ST connectors rather than +the usual MIC connector. The other one is the SAS ThinWire/STP DEFZA-CA +option, denoted 700-C, with the network medium selectable by a switch +between the DEC proprietary ThinWire-PMD using a BNC connector and the +standard STP-PMD using a DE-9F connector. This option can interface to +a DECconcentrator 500 device and, in the case of the STP-PMD, also other +FDDI equipment and was designed to make it easier to transition from +existing IEEE 802.3 10BASE2 Ethernet and IEEE 802.5 Token Ring networks +by providing means to reuse existing cabling. + +This driver handles any number of cards installed in a single system. +They get fddi0, fddi1, etc. interface names assigned in the order of +increasing TURBOchannel slot numbers. + +The board only supports DMA on the receive side. Transmission involves +the use of PIO. As a result under a heavy transmission load there will +be a significant impact on system performance. + +The board supports a 64-entry CAM for matching destination addresses. +Two entries are preoccupied by the Directed Beacon and Ring Purger +multicast addresses and the rest is used as a multicast filter. An +all-multi mode is also supported for LLC frames and it is used if +requested explicitly or if the CAM overflows. The promiscuous mode +supports separate enables for LLC and SMT frames, but this driver +doesn't support changing them individually. + + +Known problems: + +None. + + +To do: + +5. MAC address change. The card does not support changing the Media + Access Controller's address registers but a similar effect can be + achieved by adding an alias to the CAM. There is no way to disable + matching against the original address though. + +7. Queueing incoming/outgoing SMT frames in the driver if the SMT + receive/RMC transmit ring is full. (?) + +8. Retrieving/reporting FDDI/SNMP stats. + + +Both success and failure reports are welcome. + +Maciej W. Rozycki diff --git a/Documentation/networking/device_drivers/fddi/index.rst b/Documentation/networking/device_drivers/fddi/index.rst new file mode 100644 index 000000000000..0b75294e6c8b --- /dev/null +++ b/Documentation/networking/device_drivers/fddi/index.rst @@ -0,0 +1,19 @@ +.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) + +Fiber Distributed Data Interface (FDDI) Device Drivers +====================================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + defza + skfp + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` diff --git a/Documentation/networking/device_drivers/fddi/skfp.rst b/Documentation/networking/device_drivers/fddi/skfp.rst new file mode 100644 index 000000000000..58f548105c1d --- /dev/null +++ b/Documentation/networking/device_drivers/fddi/skfp.rst @@ -0,0 +1,253 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. include:: + +======================== +SysKonnect driver - SKFP +======================== + +|copy| Copyright 1998-2000 SysKonnect, + +skfp.txt created 11-May-2000 + +Readme File for skfp.o v2.06 + + +.. This file contains + + (1) OVERVIEW + (2) SUPPORTED ADAPTERS + (3) GENERAL INFORMATION + (4) INSTALLATION + (5) INCLUSION OF THE ADAPTER IN SYSTEM START + (6) TROUBLESHOOTING + (7) FUNCTION OF THE ADAPTER LEDS + (8) HISTORY + + +1. Overview +=========== + +This README explains how to use the driver 'skfp' for Linux with your +network adapter. + +Chapter 2: Contains a list of all network adapters that are supported by +this driver. + +Chapter 3: + Gives some general information. + +Chapter 4: Describes common problems and solutions. + +Chapter 5: Shows the changed functionality of the adapter LEDs. + +Chapter 6: History of development. + + +2. Supported adapters +===================== + +The network driver 'skfp' supports the following network adapters: +SysKonnect adapters: + + - SK-5521 (SK-NET FDDI-UP) + - SK-5522 (SK-NET FDDI-UP DAS) + - SK-5541 (SK-NET FDDI-FP) + - SK-5543 (SK-NET FDDI-LP) + - SK-5544 (SK-NET FDDI-LP DAS) + - SK-5821 (SK-NET FDDI-UP64) + - SK-5822 (SK-NET FDDI-UP64 DAS) + - SK-5841 (SK-NET FDDI-FP64) + - SK-5843 (SK-NET FDDI-LP64) + - SK-5844 (SK-NET FDDI-LP64 DAS) + +Compaq adapters (not tested): + + - Netelligent 100 FDDI DAS Fibre SC + - Netelligent 100 FDDI SAS Fibre SC + - Netelligent 100 FDDI DAS UTP + - Netelligent 100 FDDI SAS UTP + - Netelligent 100 FDDI SAS Fibre MIC + + +3. General Information +====================== + +From v2.01 on, the driver is integrated in the linux kernel sources. +Therefore, the installation is the same as for any other adapter +supported by the kernel. + +Refer to the manual of your distribution about the installation +of network adapters. + +Makes my life much easier :-) + +4. Troubleshooting +================== + +If you run into problems during installation, check those items: + +Problem: + The FDDI adapter cannot be found by the driver. + +Reason: + Look in /proc/pci for the following entry: + + 'FDDI network controller: SysKonnect SK-FDDI-PCI ...' + + If this entry exists, then the FDDI adapter has been + found by the system and should be able to be used. + + If this entry does not exist or if the file '/proc/pci' + is not there, then you may have a hardware problem or PCI + support may not be enabled in your kernel. + + The adapter can be checked using the diagnostic program + which is available from the SysKonnect web site: + + www.syskonnect.de + + Some COMPAQ machines have a problem with PCI under + Linux. This is described in the 'PCI howto' document + (included in some distributions or available from the + www, e.g. at 'www.linux.org') and no workaround is available. + +Problem: + You want to use your computer as a router between + multiple IP subnetworks (using multiple adapters), but + you cannot reach computers in other subnetworks. + +Reason: + Either the router's kernel is not configured for IP + forwarding or there is a problem with the routing table + and gateway configuration in at least one of the + computers. + +If your problem is not listed here, please contact our +technical support for help. + +You can send email to: linux@syskonnect.de + +When contacting our technical support, +please ensure that the following information is available: + +- System Manufacturer and Model +- Boards in your system +- Distribution +- Kernel version + + +5. Function of the Adapter LEDs +=============================== + + The functionality of the LED's on the FDDI network adapters was + changed in SMT version v2.82. With this new SMT version, the yellow + LED works as a ring operational indicator. An active yellow LED + indicates that the ring is down. The green LED on the adapter now + works as a link indicator where an active GREEN LED indicates that + the respective port has a physical connection. + + With versions of SMT prior to v2.82 a ring up was indicated if the + yellow LED was off while the green LED(s) showed the connection + status of the adapter. During a ring down the green LED was off and + the yellow LED was on. + + All implementations indicate that a driver is not loaded if + all LEDs are off. + + +6. History +========== + +v2.06 (20000511) (In-Kernel version) + New features: + + - 64 bit support + - new pci dma interface + - in kernel 2.3.99 + +v2.05 (20000217) (In-Kernel version) + New features: + + - Changes for 2.3.45 kernel + +v2.04 (20000207) (Standalone version) + New features: + + - Added rx/tx byte counter + +v2.03 (20000111) (Standalone version) + Problems fixed: + + - Fixed printk statements from v2.02 + +v2.02 (991215) (Standalone version) + Problems fixed: + + - Removed unnecessary output + - Fixed path for "printver.sh" in makefile + +v2.01 (991122) (In-Kernel version) + New features: + + - Integration in Linux kernel sources + - Support for memory mapped I/O. + +v2.00 (991112) + New features: + + - Full source released under GPL + +v1.05 (991023) + Problems fixed: + + - Compilation with kernel version 2.2.13 failed + +v1.04 (990427) + Changes: + + - New SMT module included, changing LED functionality + + Problems fixed: + + - Synchronization on SMP machines was buggy + +v1.03 (990325) + Problems fixed: + + - Interrupt routing on SMP machines could be incorrect + +v1.02 (990310) + New features: + + - Support for kernel versions 2.2.x added + - Kernel patch instead of private duplicate of kernel functions + +v1.01 (980812) + Problems fixed: + + Connection hangup with telnet + Slow telnet connection + +v1.00 beta 01 (980507) + New features: + + None. + + Problems fixed: + + None. + + Known limitations: + + - tar archive instead of standard package format (rpm). + - FDDI statistic is empty. + - not tested with 2.1.xx kernels + - integration in kernel not tested + - not tested simultaneously with FDDI adapters from other vendors. + - only X86 processors supported. + - SBA (Synchronous Bandwidth Allocator) parameters can + not be configured. + - does not work on some COMPAQ machines. See the PCI howto + document for details about this problem. + - data corruption with kernel versions below 2.0.33. diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst index d6a73e4592e0..a3113ffd7a16 100644 --- a/Documentation/networking/device_drivers/index.rst +++ b/Documentation/networking/device_drivers/index.rst @@ -13,6 +13,7 @@ Contents: cable/index cellular/index ethernet/index + fddi/index hamradio/index wan/index wifi/index diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst index f48f1d19caff..c29496fff81c 100644 --- a/Documentation/networking/index.rst +++ b/Documentation/networking/index.rst @@ -47,7 +47,6 @@ Contents: dccp dctcp decnet - defza dns_resolver driver eql @@ -94,7 +93,6 @@ Contents: sctp secid seg6-sysctl - skfp strparser switchdev tc-actions-env-rules diff --git a/Documentation/networking/skfp.rst b/Documentation/networking/skfp.rst deleted file mode 100644 index 58f548105c1d..000000000000 --- a/Documentation/networking/skfp.rst +++ /dev/null @@ -1,253 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0 - -.. include:: - -======================== -SysKonnect driver - SKFP -======================== - -|copy| Copyright 1998-2000 SysKonnect, - -skfp.txt created 11-May-2000 - -Readme File for skfp.o v2.06 - - -.. This file contains - - (1) OVERVIEW - (2) SUPPORTED ADAPTERS - (3) GENERAL INFORMATION - (4) INSTALLATION - (5) INCLUSION OF THE ADAPTER IN SYSTEM START - (6) TROUBLESHOOTING - (7) FUNCTION OF THE ADAPTER LEDS - (8) HISTORY - - -1. Overview -=========== - -This README explains how to use the driver 'skfp' for Linux with your -network adapter. - -Chapter 2: Contains a list of all network adapters that are supported by -this driver. - -Chapter 3: - Gives some general information. - -Chapter 4: Describes common problems and solutions. - -Chapter 5: Shows the changed functionality of the adapter LEDs. - -Chapter 6: History of development. - - -2. Supported adapters -===================== - -The network driver 'skfp' supports the following network adapters: -SysKonnect adapters: - - - SK-5521 (SK-NET FDDI-UP) - - SK-5522 (SK-NET FDDI-UP DAS) - - SK-5541 (SK-NET FDDI-FP) - - SK-5543 (SK-NET FDDI-LP) - - SK-5544 (SK-NET FDDI-LP DAS) - - SK-5821 (SK-NET FDDI-UP64) - - SK-5822 (SK-NET FDDI-UP64 DAS) - - SK-5841 (SK-NET FDDI-FP64) - - SK-5843 (SK-NET FDDI-LP64) - - SK-5844 (SK-NET FDDI-LP64 DAS) - -Compaq adapters (not tested): - - - Netelligent 100 FDDI DAS Fibre SC - - Netelligent 100 FDDI SAS Fibre SC - - Netelligent 100 FDDI DAS UTP - - Netelligent 100 FDDI SAS UTP - - Netelligent 100 FDDI SAS Fibre MIC - - -3. General Information -====================== - -From v2.01 on, the driver is integrated in the linux kernel sources. -Therefore, the installation is the same as for any other adapter -supported by the kernel. - -Refer to the manual of your distribution about the installation -of network adapters. - -Makes my life much easier :-) - -4. Troubleshooting -================== - -If you run into problems during installation, check those items: - -Problem: - The FDDI adapter cannot be found by the driver. - -Reason: - Look in /proc/pci for the following entry: - - 'FDDI network controller: SysKonnect SK-FDDI-PCI ...' - - If this entry exists, then the FDDI adapter has been - found by the system and should be able to be used. - - If this entry does not exist or if the file '/proc/pci' - is not there, then you may have a hardware problem or PCI - support may not be enabled in your kernel. - - The adapter can be checked using the diagnostic program - which is available from the SysKonnect web site: - - www.syskonnect.de - - Some COMPAQ machines have a problem with PCI under - Linux. This is described in the 'PCI howto' document - (included in some distributions or available from the - www, e.g. at 'www.linux.org') and no workaround is available. - -Problem: - You want to use your computer as a router between - multiple IP subnetworks (using multiple adapters), but - you cannot reach computers in other subnetworks. - -Reason: - Either the router's kernel is not configured for IP - forwarding or there is a problem with the routing table - and gateway configuration in at least one of the - computers. - -If your problem is not listed here, please contact our -technical support for help. - -You can send email to: linux@syskonnect.de - -When contacting our technical support, -please ensure that the following information is available: - -- System Manufacturer and Model -- Boards in your system -- Distribution -- Kernel version - - -5. Function of the Adapter LEDs -=============================== - - The functionality of the LED's on the FDDI network adapters was - changed in SMT version v2.82. With this new SMT version, the yellow - LED works as a ring operational indicator. An active yellow LED - indicates that the ring is down. The green LED on the adapter now - works as a link indicator where an active GREEN LED indicates that - the respective port has a physical connection. - - With versions of SMT prior to v2.82 a ring up was indicated if the - yellow LED was off while the green LED(s) showed the connection - status of the adapter. During a ring down the green LED was off and - the yellow LED was on. - - All implementations indicate that a driver is not loaded if - all LEDs are off. - - -6. History -========== - -v2.06 (20000511) (In-Kernel version) - New features: - - - 64 bit support - - new pci dma interface - - in kernel 2.3.99 - -v2.05 (20000217) (In-Kernel version) - New features: - - - Changes for 2.3.45 kernel - -v2.04 (20000207) (Standalone version) - New features: - - - Added rx/tx byte counter - -v2.03 (20000111) (Standalone version) - Problems fixed: - - - Fixed printk statements from v2.02 - -v2.02 (991215) (Standalone version) - Problems fixed: - - - Removed unnecessary output - - Fixed path for "printver.sh" in makefile - -v2.01 (991122) (In-Kernel version) - New features: - - - Integration in Linux kernel sources - - Support for memory mapped I/O. - -v2.00 (991112) - New features: - - - Full source released under GPL - -v1.05 (991023) - Problems fixed: - - - Compilation with kernel version 2.2.13 failed - -v1.04 (990427) - Changes: - - - New SMT module included, changing LED functionality - - Problems fixed: - - - Synchronization on SMP machines was buggy - -v1.03 (990325) - Problems fixed: - - - Interrupt routing on SMP machines could be incorrect - -v1.02 (990310) - New features: - - - Support for kernel versions 2.2.x added - - Kernel patch instead of private duplicate of kernel functions - -v1.01 (980812) - Problems fixed: - - Connection hangup with telnet - Slow telnet connection - -v1.00 beta 01 (980507) - New features: - - None. - - Problems fixed: - - None. - - Known limitations: - - - tar archive instead of standard package format (rpm). - - FDDI statistic is empty. - - not tested with 2.1.xx kernels - - integration in kernel not tested - - not tested simultaneously with FDDI adapters from other vendors. - - only X86 processors supported. - - SBA (Synchronous Bandwidth Allocator) parameters can - not be configured. - - does not work on some COMPAQ machines. See the PCI howto - document for details about this problem. - - data corruption with kernel versions below 2.0.33. diff --git a/drivers/net/fddi/Kconfig b/drivers/net/fddi/Kconfig index 60cc7524520c..f722079dfb6a 100644 --- a/drivers/net/fddi/Kconfig +++ b/drivers/net/fddi/Kconfig @@ -77,8 +77,8 @@ config SKFP - Netelligent 100 FDDI SAS UTP - Netelligent 100 FDDI SAS Fibre MIC - Read for information about - the driver. + Read + for information about the driver. Questions concerning this driver can be addressed to: -- cgit