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

docs: networking: convert skfp.txt to ReST

- add SPDX header;
- use copyright symbol;
- add a document title;
- adjust titles and chapters, adding proper markups;
- comment out text-only TOC from html/pdf output;
- 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
fe3dfe41 d6c48bc6

+99 -65
+1
Documentation/networking/index.rst
··· 103 103 sctp 104 104 secid 105 105 seg6-sysctl 106 + skfp 106 107 107 108 .. only:: subproject and html 108 109
+97 -64
Documentation/networking/skfp.txt Documentation/networking/skfp.rst
··· 1 - (C)Copyright 1998-2000 SysKonnect, 2 - =========================================================================== 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + .. include:: <isonum.txt> 4 + 5 + ======================== 6 + SysKonnect driver - SKFP 7 + ======================== 8 + 9 + |copy| Copyright 1998-2000 SysKonnect, 3 10 4 11 skfp.txt created 11-May-2000 5 12 6 13 Readme File for skfp.o v2.06 7 14 8 15 9 - This file contains 10 - (1) OVERVIEW 11 - (2) SUPPORTED ADAPTERS 12 - (3) GENERAL INFORMATION 13 - (4) INSTALLATION 14 - (5) INCLUSION OF THE ADAPTER IN SYSTEM START 15 - (6) TROUBLESHOOTING 16 - (7) FUNCTION OF THE ADAPTER LEDS 17 - (8) HISTORY 16 + .. This file contains 18 17 19 - =========================================================================== 20 - 18 + (1) OVERVIEW 19 + (2) SUPPORTED ADAPTERS 20 + (3) GENERAL INFORMATION 21 + (4) INSTALLATION 22 + (5) INCLUSION OF THE ADAPTER IN SYSTEM START 23 + (6) TROUBLESHOOTING 24 + (7) FUNCTION OF THE ADAPTER LEDS 25 + (8) HISTORY 21 26 22 27 23 - (1) OVERVIEW 24 - ============ 28 + 1. Overview 29 + =========== 25 30 26 31 This README explains how to use the driver 'skfp' for Linux with your 27 32 network adapter. 28 33 29 34 Chapter 2: Contains a list of all network adapters that are supported by 30 - this driver. 35 + this driver. 31 36 32 - Chapter 3: Gives some general information. 37 + Chapter 3: 38 + Gives some general information. 33 39 34 40 Chapter 4: Describes common problems and solutions. 35 41 ··· 43 37 44 38 Chapter 6: History of development. 45 39 46 - *** 47 40 48 - 49 - (2) SUPPORTED ADAPTERS 50 - ====================== 41 + 2. Supported adapters 42 + ===================== 51 43 52 44 The network driver 'skfp' supports the following network adapters: 53 45 SysKonnect adapters: 46 + 54 47 - SK-5521 (SK-NET FDDI-UP) 55 48 - SK-5522 (SK-NET FDDI-UP DAS) 56 49 - SK-5541 (SK-NET FDDI-FP) ··· 60 55 - SK-5841 (SK-NET FDDI-FP64) 61 56 - SK-5843 (SK-NET FDDI-LP64) 62 57 - SK-5844 (SK-NET FDDI-LP64 DAS) 58 + 63 59 Compaq adapters (not tested): 60 + 64 61 - Netelligent 100 FDDI DAS Fibre SC 65 62 - Netelligent 100 FDDI SAS Fibre SC 66 63 - Netelligent 100 FDDI DAS UTP 67 64 - Netelligent 100 FDDI SAS UTP 68 65 - Netelligent 100 FDDI SAS Fibre MIC 69 - *** 70 66 71 67 72 - (3) GENERAL INFORMATION 73 - ======================= 68 + 3. General Information 69 + ====================== 74 70 75 71 From v2.01 on, the driver is integrated in the linux kernel sources. 76 72 Therefore, the installation is the same as for any other adapter 77 73 supported by the kernel. 74 + 78 75 Refer to the manual of your distribution about the installation 79 76 of network adapters. 77 + 80 78 Makes my life much easier :-) 81 - *** 82 79 83 - 84 - (4) TROUBLESHOOTING 85 - =================== 80 + 4. Troubleshooting 81 + ================== 86 82 87 83 If you run into problems during installation, check those items: 88 84 89 - Problem: The FDDI adapter cannot be found by the driver. 90 - Reason: Look in /proc/pci for the following entry: 91 - 'FDDI network controller: SysKonnect SK-FDDI-PCI ...' 85 + Problem: 86 + The FDDI adapter cannot be found by the driver. 87 + 88 + Reason: 89 + Look in /proc/pci for the following entry: 90 + 91 + 'FDDI network controller: SysKonnect SK-FDDI-PCI ...' 92 + 92 93 If this entry exists, then the FDDI adapter has been 93 94 found by the system and should be able to be used. 95 + 94 96 If this entry does not exist or if the file '/proc/pci' 95 97 is not there, then you may have a hardware problem or PCI 96 98 support may not be enabled in your kernel. 99 + 97 100 The adapter can be checked using the diagnostic program 98 101 which is available from the SysKonnect web site: 102 + 99 103 www.syskonnect.de 104 + 100 105 Some COMPAQ machines have a problem with PCI under 101 106 Linux. This is described in the 'PCI howto' document 102 107 (included in some distributions or available from the 103 108 www, e.g. at 'www.linux.org') and no workaround is available. 104 109 105 - Problem: You want to use your computer as a router between 106 - multiple IP subnetworks (using multiple adapters), but 110 + Problem: 111 + You want to use your computer as a router between 112 + multiple IP subnetworks (using multiple adapters), but 107 113 you cannot reach computers in other subnetworks. 108 - Reason: Either the router's kernel is not configured for IP 114 + 115 + Reason: 116 + Either the router's kernel is not configured for IP 109 117 forwarding or there is a problem with the routing table 110 118 and gateway configuration in at least one of the 111 119 computers. 112 120 113 121 If your problem is not listed here, please contact our 114 - technical support for help. 115 - You can send email to: 116 - linux@syskonnect.de 122 + technical support for help. 123 + 124 + You can send email to: linux@syskonnect.de 125 + 117 126 When contacting our technical support, 118 127 please ensure that the following information is available: 128 + 119 129 - System Manufacturer and Model 120 130 - Boards in your system 121 131 - Distribution 122 132 - Kernel version 123 133 124 - *** 134 + 135 + 5. Function of the Adapter LEDs 136 + =============================== 137 + 138 + The functionality of the LED's on the FDDI network adapters was 139 + changed in SMT version v2.82. With this new SMT version, the yellow 140 + LED works as a ring operational indicator. An active yellow LED 141 + indicates that the ring is down. The green LED on the adapter now 142 + works as a link indicator where an active GREEN LED indicates that 143 + the respective port has a physical connection. 144 + 145 + With versions of SMT prior to v2.82 a ring up was indicated if the 146 + yellow LED was off while the green LED(s) showed the connection 147 + status of the adapter. During a ring down the green LED was off and 148 + the yellow LED was on. 149 + 150 + All implementations indicate that a driver is not loaded if 151 + all LEDs are off. 125 152 126 153 127 - (5) FUNCTION OF THE ADAPTER LEDS 128 - ================================ 129 - 130 - The functionality of the LED's on the FDDI network adapters was 131 - changed in SMT version v2.82. With this new SMT version, the yellow 132 - LED works as a ring operational indicator. An active yellow LED 133 - indicates that the ring is down. The green LED on the adapter now 134 - works as a link indicator where an active GREEN LED indicates that 135 - the respective port has a physical connection. 136 - 137 - With versions of SMT prior to v2.82 a ring up was indicated if the 138 - yellow LED was off while the green LED(s) showed the connection 139 - status of the adapter. During a ring down the green LED was off and 140 - the yellow LED was on. 141 - 142 - All implementations indicate that a driver is not loaded if 143 - all LEDs are off. 144 - 145 - *** 146 - 147 - 148 - (6) HISTORY 149 - =========== 154 + 6. History 155 + ========== 150 156 151 157 v2.06 (20000511) (In-Kernel version) 152 158 New features: 159 + 153 160 - 64 bit support 154 161 - new pci dma interface 155 162 - in kernel 2.3.99 156 163 157 164 v2.05 (20000217) (In-Kernel version) 158 165 New features: 166 + 159 167 - Changes for 2.3.45 kernel 160 168 161 169 v2.04 (20000207) (Standalone version) 162 170 New features: 171 + 163 172 - Added rx/tx byte counter 164 173 165 174 v2.03 (20000111) (Standalone version) 166 175 Problems fixed: 176 + 167 177 - Fixed printk statements from v2.02 168 178 169 179 v2.02 (991215) (Standalone version) 170 180 Problems fixed: 181 + 171 182 - Removed unnecessary output 172 183 - Fixed path for "printver.sh" in makefile 173 184 174 185 v2.01 (991122) (In-Kernel version) 175 186 New features: 187 + 176 188 - Integration in Linux kernel sources 177 189 - Support for memory mapped I/O. 178 190 179 191 v2.00 (991112) 180 192 New features: 193 + 181 194 - Full source released under GPL 182 195 183 196 v1.05 (991023) 184 197 Problems fixed: 198 + 185 199 - Compilation with kernel version 2.2.13 failed 186 200 187 201 v1.04 (990427) 188 202 Changes: 203 + 189 204 - New SMT module included, changing LED functionality 205 + 190 206 Problems fixed: 207 + 191 208 - Synchronization on SMP machines was buggy 192 209 193 210 v1.03 (990325) 194 211 Problems fixed: 212 + 195 213 - Interrupt routing on SMP machines could be incorrect 196 214 197 215 v1.02 (990310) 198 216 New features: 217 + 199 218 - Support for kernel versions 2.2.x added 200 219 - Kernel patch instead of private duplicate of kernel functions 201 220 202 221 v1.01 (980812) 203 222 Problems fixed: 223 + 204 224 Connection hangup with telnet 205 225 Slow telnet connection 206 226 207 227 v1.00 beta 01 (980507) 208 228 New features: 229 + 209 230 None. 231 + 210 232 Problems fixed: 233 + 211 234 None. 235 + 212 236 Known limitations: 213 - - tar archive instead of standard package format (rpm). 237 + 238 + - tar archive instead of standard package format (rpm). 214 239 - FDDI statistic is empty. 215 240 - not tested with 2.1.xx kernels 216 241 - integration in kernel not tested ··· 251 216 - does not work on some COMPAQ machines. See the PCI howto 252 217 document for details about this problem. 253 218 - data corruption with kernel versions below 2.0.33. 254 - 255 - *** End of information file ***
+1 -1
drivers/net/fddi/Kconfig
··· 77 77 - Netelligent 100 FDDI SAS UTP 78 78 - Netelligent 100 FDDI SAS Fibre MIC 79 79 80 - Read <file:Documentation/networking/skfp.txt> for information about 80 + Read <file:Documentation/networking/skfp.rst> for information about 81 81 the driver. 82 82 83 83 Questions concerning this driver can be addressed to: