2020-04-27 22:09:53

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 00/38] net: manually convert files to ReST format - part 1

There are very few documents upstream that aren't converted upstream.

This series convert part of the networking text files into ReST.
It is part of a bigger set of patches, which were split on parts,
in order to make reviewing task easier.

The full series (including those ones) are at:

https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs

And the documents, converted to HTML via the building system
are at:

https://www.infradead.org/~mchehab/kernel_docs/networking/


Mauro Carvalho Chehab (38):
docs: networking: convert caif files to ReST
docs: networking: convert 6pack.txt to ReST
docs: networking: convert altera_tse.txt to ReST
docs: networking: convert arcnet-hardware.txt to ReST
docs: networking: convert arcnet.txt to ReST
docs: networking: convert atm.txt to ReST
docs: networking: convert ax25.txt to ReST
docs: networking: convert baycom.txt to ReST
docs: networking: convert bonding.txt to ReST
docs: networking: convert cdc_mbim.txt to ReST
docs: networking: convert cops.txt to ReST
docs: networking: convert cxacru.txt to ReST
docs: networking: convert dccp.txt to ReST
docs: networking: convert dctcp.txt to ReST
docs: networking: convert decnet.txt to ReST
docs: networking: convert defza.txt to ReST
docs: networking: convert dns_resolver.txt to ReST
docs: networking: convert driver.txt to ReST
docs: networking: convert eql.txt to ReST
docs: networking: convert fib_trie.txt to ReST
docs: networking: convert filter.txt to ReST
docs: networking: convert fore200e.txt to ReST
docs: networking: convert framerelay.txt to ReST
docs: networking: convert generic-hdlc.txt to ReST
docs: networking: convert generic_netlink.txt to ReST
docs: networking: convert gen_stats.txt to ReST
docs: networking: convert gtp.txt to ReST
docs: networking: convert hinic.txt to ReST
docs: networking: convert ila.txt to ReST
docs: networking: convert ipddp.txt to ReST
docs: networking: convert ip_dynaddr.txt to ReST
docs: networking: convert iphase.txt to ReST
docs: networking: convert ipsec.txt to ReST
docs: networking: convert ip-sysctl.txt to ReST
docs: networking: convert ipv6.txt to ReST
docs: networking: convert ipvlan.txt to ReST
docs: networking: convert ipvs-sysctl.txt to ReST
docs: networking: convert kcm.txt to ReST

.../admin-guide/kernel-parameters.txt | 10 +-
Documentation/admin-guide/sysctl/net.rst | 4 +-
Documentation/bpf/index.rst | 4 +-
.../networking/{6pack.txt => 6pack.rst} | 46 +-
.../{altera_tse.txt => altera_tse.rst} | 87 +-
...rcnet-hardware.txt => arcnet-hardware.rst} | 2169 +++++++++--------
.../networking/{arcnet.txt => arcnet.rst} | 348 +--
Documentation/networking/{atm.txt => atm.rst} | 6 +
.../networking/{ax25.txt => ax25.rst} | 6 +
.../networking/{baycom.txt => baycom.rst} | 110 +-
.../networking/{bonding.txt => bonding.rst} | 1275 +++++-----
Documentation/networking/caif/caif.rst | 2 -
Documentation/networking/caif/index.rst | 13 +
.../caif/{Linux-CAIF.txt => linux_caif.rst} | 54 +-
Documentation/networking/caif/spi_porting.rst | 229 ++
Documentation/networking/caif/spi_porting.txt | 208 --
.../networking/{cdc_mbim.txt => cdc_mbim.rst} | 76 +-
Documentation/networking/cops.rst | 80 +
Documentation/networking/cops.txt | 63 -
.../networking/{cxacru.txt => cxacru.rst} | 86 +-
.../networking/{dccp.txt => dccp.rst} | 39 +-
.../networking/{dctcp.txt => dctcp.rst} | 14 +-
.../networking/{decnet.txt => decnet.rst} | 77 +-
.../networking/{defza.txt => defza.rst} | 8 +-
.../networking/device_drivers/intel/e100.rst | 2 +-
.../networking/device_drivers/intel/ixgb.rst | 2 +-
.../{dns_resolver.txt => dns_resolver.rst} | 52 +-
.../networking/{driver.txt => driver.rst} | 22 +-
Documentation/networking/{eql.txt => eql.rst} | 445 ++--
.../networking/{fib_trie.txt => fib_trie.rst} | 16 +-
.../networking/{filter.txt => filter.rst} | 850 ++++---
.../networking/{fore200e.txt => fore200e.rst} | 8 +-
.../{framerelay.txt => framerelay.rst} | 21 +-
.../{gen_stats.txt => gen_stats.rst} | 98 +-
.../{generic-hdlc.txt => generic-hdlc.rst} | 86 +-
...eneric_netlink.txt => generic_netlink.rst} | 6 +
Documentation/networking/{gtp.txt => gtp.rst} | 95 +-
.../networking/{hinic.txt => hinic.rst} | 5 +-
Documentation/networking/{ila.txt => ila.rst} | 81 +-
Documentation/networking/index.rst | 38 +
.../{ip-sysctl.txt => ip-sysctl.rst} | 829 ++++---
.../{ip_dynaddr.txt => ip_dynaddr.rst} | 29 +-
.../networking/{ipddp.txt => ipddp.rst} | 13 +-
.../networking/{iphase.txt => iphase.rst} | 185 +-
.../networking/{ipsec.txt => ipsec.rst} | 14 +-
.../networking/{ipv6.txt => ipv6.rst} | 8 +-
.../networking/{ipvlan.txt => ipvlan.rst} | 159 +-
.../{ipvs-sysctl.txt => ipvs-sysctl.rst} | 180 +-
Documentation/networking/{kcm.txt => kcm.rst} | 83 +-
Documentation/networking/ltpc.txt | 2 +-
Documentation/networking/packet_mmap.txt | 2 +-
Documentation/networking/snmp_counter.rst | 2 +-
MAINTAINERS | 8 +-
drivers/atm/Kconfig | 4 +-
drivers/net/Kconfig | 4 +-
drivers/net/appletalk/Kconfig | 6 +-
drivers/net/arcnet/Kconfig | 6 +-
drivers/net/caif/Kconfig | 2 +-
drivers/net/hamradio/Kconfig | 10 +-
drivers/net/wan/Kconfig | 4 +-
net/Kconfig | 2 +-
net/atm/Kconfig | 2 +-
net/ax25/Kconfig | 6 +-
net/ceph/Kconfig | 2 +-
net/core/gen_stats.c | 2 +-
net/decnet/Kconfig | 4 +-
net/dns_resolver/Kconfig | 2 +-
net/dns_resolver/dns_key.c | 2 +-
net/dns_resolver/dns_query.c | 2 +-
net/ipv4/Kconfig | 2 +-
net/ipv4/icmp.c | 2 +-
net/ipv6/Kconfig | 2 +-
tools/bpf/bpf_asm.c | 2 +-
tools/bpf/bpf_dbg.c | 2 +-
74 files changed, 4656 insertions(+), 3769 deletions(-)
rename Documentation/networking/{6pack.txt => 6pack.rst} (90%)
rename Documentation/networking/{altera_tse.txt => altera_tse.rst} (85%)
rename Documentation/networking/{arcnet-hardware.txt => arcnet-hardware.rst} (66%)
rename Documentation/networking/{arcnet.txt => arcnet.rst} (76%)
rename Documentation/networking/{atm.txt => atm.rst} (89%)
rename Documentation/networking/{ax25.txt => ax25.rst} (91%)
rename Documentation/networking/{baycom.txt => baycom.rst} (58%)
rename Documentation/networking/{bonding.txt => bonding.rst} (75%)
create mode 100644 Documentation/networking/caif/index.rst
rename Documentation/networking/caif/{Linux-CAIF.txt => linux_caif.rst} (90%)
create mode 100644 Documentation/networking/caif/spi_porting.rst
delete mode 100644 Documentation/networking/caif/spi_porting.txt
rename Documentation/networking/{cdc_mbim.txt => cdc_mbim.rst} (88%)
create mode 100644 Documentation/networking/cops.rst
delete mode 100644 Documentation/networking/cops.txt
rename Documentation/networking/{cxacru.txt => cxacru.rst} (66%)
rename Documentation/networking/{dccp.txt => dccp.rst} (94%)
rename Documentation/networking/{dctcp.txt => dctcp.rst} (89%)
rename Documentation/networking/{decnet.txt => decnet.rst} (87%)
rename Documentation/networking/{defza.txt => defza.rst} (91%)
rename Documentation/networking/{dns_resolver.txt => dns_resolver.rst} (89%)
rename Documentation/networking/{driver.txt => driver.rst} (85%)
rename Documentation/networking/{eql.txt => eql.rst} (62%)
rename Documentation/networking/{fib_trie.txt => fib_trie.rst} (96%)
rename Documentation/networking/{filter.txt => filter.rst} (77%)
rename Documentation/networking/{fore200e.txt => fore200e.rst} (94%)
rename Documentation/networking/{framerelay.txt => framerelay.rst} (93%)
rename Documentation/networking/{gen_stats.txt => gen_stats.rst} (60%)
rename Documentation/networking/{generic-hdlc.txt => generic-hdlc.rst} (75%)
rename Documentation/networking/{generic_netlink.txt => generic_netlink.rst} (64%)
rename Documentation/networking/{gtp.txt => gtp.rst} (79%)
rename Documentation/networking/{hinic.txt => hinic.rst} (97%)
rename Documentation/networking/{ila.txt => ila.rst} (82%)
rename Documentation/networking/{ip-sysctl.txt => ip-sysctl.rst} (83%)
rename Documentation/networking/{ip_dynaddr.txt => ip_dynaddr.rst} (65%)
rename Documentation/networking/{ipddp.txt => ipddp.rst} (89%)
rename Documentation/networking/{iphase.txt => iphase.rst} (50%)
rename Documentation/networking/{ipsec.txt => ipsec.rst} (90%)
rename Documentation/networking/{ipv6.txt => ipv6.rst} (93%)
rename Documentation/networking/{ipvlan.txt => ipvlan.rst} (54%)
rename Documentation/networking/{ipvs-sysctl.txt => ipvs-sysctl.rst} (62%)
rename Documentation/networking/{kcm.txt => kcm.rst} (84%)

--
2.25.4



2020-04-27 22:10:03

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 11/38] docs: networking: convert cops.txt to ReST

- add SPDX header;
- adjust titles and chapters, adding proper markups;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/networking/cops.rst | 80 ++++++++++++++++++++++++++++++
Documentation/networking/cops.txt | 63 -----------------------
Documentation/networking/index.rst | 1 +
drivers/net/appletalk/Kconfig | 2 +-
4 files changed, 82 insertions(+), 64 deletions(-)
create mode 100644 Documentation/networking/cops.rst
delete mode 100644 Documentation/networking/cops.txt

diff --git a/Documentation/networking/cops.rst b/Documentation/networking/cops.rst
new file mode 100644
index 000000000000..964ba80599a9
--- /dev/null
+++ b/Documentation/networking/cops.rst
@@ -0,0 +1,80 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+========================================
+The COPS LocalTalk Linux driver (cops.c)
+========================================
+
+By Jay Schulist <[email protected]>
+
+This driver has two modes and they are: Dayna mode and Tangent mode.
+Each mode corresponds with the type of card. It has been found
+that there are 2 main types of cards and all other cards are
+the same and just have different names or only have minor differences
+such as more IO ports. As this driver is tested it will
+become more clear exactly what cards are supported.
+
+Right now these cards are known to work with the COPS driver. The
+LT-200 cards work in a somewhat more limited capacity than the
+DL200 cards, which work very well and are in use by many people.
+
+TANGENT driver mode:
+ - Tangent ATB-II, Novell NL-1000, Daystar Digital LT-200
+
+DAYNA driver mode:
+ - Dayna DL2000/DaynaTalk PC (Half Length), COPS LT-95,
+ - Farallon PhoneNET PC III, Farallon PhoneNET PC II
+
+Other cards possibly supported mode unknown though:
+ - Dayna DL2000 (Full length)
+
+The COPS driver defaults to using Dayna mode. To change the driver's
+mode if you built a driver with dual support use board_type=1 or
+board_type=2 for Dayna or Tangent with insmod.
+
+Operation/loading of the driver
+===============================
+
+Use modprobe like this: /sbin/modprobe cops.o (IO #) (IRQ #)
+If you do not specify any options the driver will try and use the IO = 0x240,
+IRQ = 5. As of right now I would only use IRQ 5 for the card, if autoprobing.
+
+To load multiple COPS driver Localtalk cards you can do one of the following::
+
+ insmod cops io=0x240 irq=5
+ insmod -o cops2 cops io=0x260 irq=3
+
+Or in lilo.conf put something like this::
+
+ append="ether=5,0x240,lt0 ether=3,0x260,lt1"
+
+Then bring up the interface with ifconfig. It will look something like this::
+
+ lt0 Link encap:UNSPEC HWaddr 00-00-00-00-00-00-00-F7-00-00-00-00-00-00-00-00
+ inet addr:192.168.1.2 Bcast:192.168.1.255 Mask:255.255.255.0
+ UP BROADCAST RUNNING NOARP MULTICAST MTU:600 Metric:1
+ RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+ TX packets:0 errors:0 dropped:0 overruns:0 carrier:0 coll:0
+
+Netatalk Configuration
+======================
+
+You will need to configure atalkd with something like the following to make
+it work with the cops.c driver.
+
+* For single LTalk card use::
+
+ dummy -seed -phase 2 -net 2000 -addr 2000.10 -zone "1033"
+ lt0 -seed -phase 1 -net 1000 -addr 1000.50 -zone "1033"
+
+* For multiple cards, Ethernet and LocalTalk::
+
+ eth0 -seed -phase 2 -net 3000 -addr 3000.20 -zone "1033"
+ lt0 -seed -phase 1 -net 1000 -addr 1000.50 -zone "1033"
+
+* For multiple LocalTalk cards, and an Ethernet card.
+
+* Order seems to matter here, Ethernet last::
+
+ lt0 -seed -phase 1 -net 1000 -addr 1000.10 -zone "LocalTalk1"
+ lt1 -seed -phase 1 -net 2000 -addr 2000.20 -zone "LocalTalk2"
+ eth0 -seed -phase 2 -net 3000 -addr 3000.30 -zone "EtherTalk"
diff --git a/Documentation/networking/cops.txt b/Documentation/networking/cops.txt
deleted file mode 100644
index 3e344b448e07..000000000000
--- a/Documentation/networking/cops.txt
+++ /dev/null
@@ -1,63 +0,0 @@
-Text File for the COPS LocalTalk Linux driver (cops.c).
- By Jay Schulist <[email protected]>
-
-This driver has two modes and they are: Dayna mode and Tangent mode.
-Each mode corresponds with the type of card. It has been found
-that there are 2 main types of cards and all other cards are
-the same and just have different names or only have minor differences
-such as more IO ports. As this driver is tested it will
-become more clear exactly what cards are supported.
-
-Right now these cards are known to work with the COPS driver. The
-LT-200 cards work in a somewhat more limited capacity than the
-DL200 cards, which work very well and are in use by many people.
-
-TANGENT driver mode:
- Tangent ATB-II, Novell NL-1000, Daystar Digital LT-200
-DAYNA driver mode:
- Dayna DL2000/DaynaTalk PC (Half Length), COPS LT-95,
- Farallon PhoneNET PC III, Farallon PhoneNET PC II
-Other cards possibly supported mode unknown though:
- Dayna DL2000 (Full length)
-
-The COPS driver defaults to using Dayna mode. To change the driver's
-mode if you built a driver with dual support use board_type=1 or
-board_type=2 for Dayna or Tangent with insmod.
-
-** Operation/loading of the driver.
-Use modprobe like this: /sbin/modprobe cops.o (IO #) (IRQ #)
-If you do not specify any options the driver will try and use the IO = 0x240,
-IRQ = 5. As of right now I would only use IRQ 5 for the card, if autoprobing.
-
-To load multiple COPS driver Localtalk cards you can do one of the following.
-
-insmod cops io=0x240 irq=5
-insmod -o cops2 cops io=0x260 irq=3
-
-Or in lilo.conf put something like this:
- append="ether=5,0x240,lt0 ether=3,0x260,lt1"
-
-Then bring up the interface with ifconfig. It will look something like this:
-lt0 Link encap:UNSPEC HWaddr 00-00-00-00-00-00-00-F7-00-00-00-00-00-00-00-00
- inet addr:192.168.1.2 Bcast:192.168.1.255 Mask:255.255.255.0
- UP BROADCAST RUNNING NOARP MULTICAST MTU:600 Metric:1
- RX packets:0 errors:0 dropped:0 overruns:0 frame:0
- TX packets:0 errors:0 dropped:0 overruns:0 carrier:0 coll:0
-
-** Netatalk Configuration
-You will need to configure atalkd with something like the following to make
-it work with the cops.c driver.
-
-* For single LTalk card use.
-dummy -seed -phase 2 -net 2000 -addr 2000.10 -zone "1033"
-lt0 -seed -phase 1 -net 1000 -addr 1000.50 -zone "1033"
-
-* For multiple cards, Ethernet and LocalTalk.
-eth0 -seed -phase 2 -net 3000 -addr 3000.20 -zone "1033"
-lt0 -seed -phase 1 -net 1000 -addr 1000.50 -zone "1033"
-
-* For multiple LocalTalk cards, and an Ethernet card.
-* Order seems to matter here, Ethernet last.
-lt0 -seed -phase 1 -net 1000 -addr 1000.10 -zone "LocalTalk1"
-lt1 -seed -phase 1 -net 2000 -addr 2000.20 -zone "LocalTalk2"
-eth0 -seed -phase 2 -net 3000 -addr 3000.30 -zone "EtherTalk"
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index 55802abd65a0..7b596810d479 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -46,6 +46,7 @@ Contents:
baycom
bonding
cdc_mbim
+ cops

.. only:: subproject and html

diff --git a/drivers/net/appletalk/Kconfig b/drivers/net/appletalk/Kconfig
index af509b05ac5c..d4e51c048f62 100644
--- a/drivers/net/appletalk/Kconfig
+++ b/drivers/net/appletalk/Kconfig
@@ -59,7 +59,7 @@ config COPS
package. This driver is experimental, which means that it may not
work. This driver will only work if you choose "AppleTalk DDP"
networking support, above.
- Please read the file <file:Documentation/networking/cops.txt>.
+ Please read the file <file:Documentation/networking/cops.rst>.

config COPS_DAYNA
bool "Dayna firmware support"
--
2.25.4

2020-04-27 22:10:51

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 03/38] docs: networking: convert altera_tse.txt to ReST

- add SPDX header;
- use copyright symbol;
- adjust titles and chapters, adding proper markups;
- mark lists as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
.../{altera_tse.txt => altera_tse.rst} | 87 ++++++++++++-------
Documentation/networking/index.rst | 1 +
2 files changed, 56 insertions(+), 32 deletions(-)
rename Documentation/networking/{altera_tse.txt => altera_tse.rst} (85%)

diff --git a/Documentation/networking/altera_tse.txt b/Documentation/networking/altera_tse.rst
similarity index 85%
rename from Documentation/networking/altera_tse.txt
rename to Documentation/networking/altera_tse.rst
index 50b8589d12fd..7a7040072e58 100644
--- a/Documentation/networking/altera_tse.txt
+++ b/Documentation/networking/altera_tse.rst
@@ -1,6 +1,12 @@
- Altera Triple-Speed Ethernet MAC driver
+.. SPDX-License-Identifier: GPL-2.0

-Copyright (C) 2008-2014 Altera Corporation
+.. include:: <isonum.txt>
+
+=======================================
+Altera Triple-Speed Ethernet MAC driver
+=======================================
+
+Copyright |copy| 2008-2014 Altera Corporation

This is the driver for the Altera Triple-Speed Ethernet (TSE) controllers
using the SGDMA and MSGDMA soft DMA IP components. The driver uses the
@@ -46,23 +52,33 @@ Jumbo frames are not supported at this time.
The driver limits PHY operations to 10/100Mbps, and has not yet been fully
tested for 1Gbps. This support will be added in a future maintenance update.

-1) Kernel Configuration
+1. Kernel Configuration
+=======================
+
The kernel configuration option is ALTERA_TSE:
+
Device Drivers ---> Network device support ---> Ethernet driver support --->
Altera Triple-Speed Ethernet MAC support (ALTERA_TSE)

-2) Driver parameters list:
- debug: message level (0: no output, 16: all);
- dma_rx_num: Number of descriptors in the RX list (default is 64);
- dma_tx_num: Number of descriptors in the TX list (default is 64).
+2. Driver parameters list
+=========================
+
+ - debug: message level (0: no output, 16: all);
+ - dma_rx_num: Number of descriptors in the RX list (default is 64);
+ - dma_tx_num: Number of descriptors in the TX list (default is 64).
+
+3. Command line options
+=======================
+
+Driver parameters can be also passed in command line by using::

-3) Command line options
-Driver parameters can be also passed in command line by using:
altera_tse=dma_rx_num:128,dma_tx_num:512

-4) Driver information and notes
+4. Driver information and notes
+===============================

-4.1) Transmit process
+4.1. Transmit process
+---------------------
When the driver's transmit routine is called by the kernel, it sets up a
transmit descriptor by calling the underlying DMA transmit routine (SGDMA or
MSGDMA), and initiates a transmit operation. Once the transmit is complete, an
@@ -70,7 +86,8 @@ interrupt is driven by the transmit DMA logic. The driver handles the transmit
completion in the context of the interrupt handling chain by recycling
resource required to send and track the requested transmit operation.

-4.2) Receive process
+4.2. Receive process
+--------------------
The driver will post receive buffers to the receive DMA logic during driver
initialization. Receive buffers may or may not be queued depending upon the
underlying DMA logic (MSGDMA is able queue receive buffers, SGDMA is not able
@@ -79,34 +96,39 @@ received, the DMA logic generates an interrupt. The driver handles a receive
interrupt by obtaining the DMA receive logic status, reaping receive
completions until no more receive completions are available.

-4.3) Interrupt Mitigation
+4.3. Interrupt Mitigation
+-------------------------
The driver is able to mitigate the number of its DMA interrupts
using NAPI for receive operations. Interrupt mitigation is not yet supported
for transmit operations, but will be added in a future maintenance release.

4.4) Ethtool support
+--------------------
Ethtool is supported. Driver statistics and internal errors can be taken using:
ethtool -S ethX command. It is possible to dump registers etc.

4.5) PHY Support
+----------------
The driver is compatible with PAL to work with PHY and GPHY devices.

4.7) List of source files:
- o Kconfig
- o Makefile
- o altera_tse_main.c: main network device driver
- o altera_tse_ethtool.c: ethtool support
- o altera_tse.h: private driver structure and common definitions
- o altera_msgdma.h: MSGDMA implementation function definitions
- o altera_sgdma.h: SGDMA implementation function definitions
- o altera_msgdma.c: MSGDMA implementation
- o altera_sgdma.c: SGDMA implementation
- o altera_sgdmahw.h: SGDMA register and descriptor definitions
- o altera_msgdmahw.h: MSGDMA register and descriptor definitions
- o altera_utils.c: Driver utility functions
- o altera_utils.h: Driver utility function definitions
+--------------------------
+ - Kconfig
+ - Makefile
+ - altera_tse_main.c: main network device driver
+ - altera_tse_ethtool.c: ethtool support
+ - altera_tse.h: private driver structure and common definitions
+ - altera_msgdma.h: MSGDMA implementation function definitions
+ - altera_sgdma.h: SGDMA implementation function definitions
+ - altera_msgdma.c: MSGDMA implementation
+ - altera_sgdma.c: SGDMA implementation
+ - altera_sgdmahw.h: SGDMA register and descriptor definitions
+ - altera_msgdmahw.h: MSGDMA register and descriptor definitions
+ - altera_utils.c: Driver utility functions
+ - altera_utils.h: Driver utility function definitions

-5) Debug Information
+5. Debug Information
+====================

The driver exports debug information such as internal statistics,
debug information, MAC and DMA registers etc.
@@ -118,17 +140,18 @@ or sees the MAC registers: e.g. using: ethtool -d ethX
The developer can also use the "debug" module parameter to get
further debug information.

-6) Statistics Support
+6. Statistics Support
+=====================

The controller and driver support a mix of IEEE standard defined statistics,
RFC defined statistics, and driver or Altera defined statistics. The four
specifications containing the standard definitions for these statistics are
as follows:

- o IEEE 802.3-2012 - IEEE Standard for Ethernet.
- o RFC 2863 found at http://www.rfc-editor.org/rfc/rfc2863.txt.
- o RFC 2819 found at http://www.rfc-editor.org/rfc/rfc2819.txt.
- o Altera Triple Speed Ethernet User Guide, found at http://www.altera.com
+ - IEEE 802.3-2012 - IEEE Standard for Ethernet.
+ - RFC 2863 found at http://www.rfc-editor.org/rfc/rfc2863.txt.
+ - RFC 2819 found at http://www.rfc-editor.org/rfc/rfc2819.txt.
+ - Altera Triple Speed Ethernet User Guide, found at http://www.altera.com

The statistics supported by the TSE and the device driver are as follows:

diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index dc37fc8d5bee..96ffad845fd9 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -38,6 +38,7 @@ Contents:
nfc
6lowpan
6pack
+ altera_tse

.. only:: subproject and html

--
2.25.4

2020-04-28 20:13:44

by David Miller

[permalink] [raw]
Subject: Re: [PATCH 00/38] net: manually convert files to ReST format - part 1

From: Mauro Carvalho Chehab <[email protected]>
Date: Tue, 28 Apr 2020 00:01:15 +0200

> There are very few documents upstream that aren't converted upstream.
>
> This series convert part of the networking text files into ReST.
> It is part of a bigger set of patches, which were split on parts,
> in order to make reviewing task easier.
>
> The full series (including those ones) are at:
>
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
>
> And the documents, converted to HTML via the building system
> are at:
>
> https://www.infradead.org/~mchehab/kernel_docs/networking/

These look good as far as I can tell.

Jon, do you mind if I merge this via the networking tree?

Thanks.

2020-04-28 20:17:10

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH 00/38] net: manually convert files to ReST format - part 1

On Tue, 28 Apr 2020 13:11:43 -0700 (PDT)
David Miller <[email protected]> wrote:

> Jon, do you mind if I merge this via the networking tree?

Not at all, that's what I was expecting you would do.

Thanks,

jon

2020-04-28 21:42:50

by David Miller

[permalink] [raw]
Subject: Re: [PATCH 00/38] net: manually convert files to ReST format - part 1

From: Mauro Carvalho Chehab <[email protected]>
Date: Tue, 28 Apr 2020 00:01:15 +0200

> There are very few documents upstream that aren't converted upstream.
>
> This series convert part of the networking text files into ReST.
> It is part of a bigger set of patches, which were split on parts,
> in order to make reviewing task easier.
>
> The full series (including those ones) are at:
>
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=net-docs
>
> And the documents, converted to HTML via the building system
> are at:
>
> https://www.infradead.org/~mchehab/kernel_docs/networking/

Series applied to net-next, thank you.