Commit c76c2230 authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'net-ReST-convert'

Mauro Carvalho Chehab says:

====================
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/


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

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 790ab249 b9dd2bea
Loading
Loading
Loading
Loading
+5 −5
Original line number Diff line number Diff line
@@ -356,7 +356,7 @@
			      shot down by NMI

	autoconf=	[IPV6]
			See Documentation/networking/ipv6.txt.
			See Documentation/networking/ipv6.rst.

	show_lapic=	[APIC,X86] Advanced Programmable Interrupt Controller
			Limit apic dumping. The parameter defines the maximal
@@ -831,7 +831,7 @@

	decnet.addr=	[HW,NET]
			Format: <area>[,<node>]
			See also Documentation/networking/decnet.txt.
			See also Documentation/networking/decnet.rst.

	default_hugepagesz=
			[same as hugepagesz=] The size of the default
@@ -872,7 +872,7 @@
			miss to occur.

	disable=	[IPV6]
			See Documentation/networking/ipv6.txt.
			See Documentation/networking/ipv6.rst.

	hardened_usercopy=
                        [KNL] Under CONFIG_HARDENED_USERCOPY, whether
@@ -912,7 +912,7 @@
			to workaround buggy firmware.

	disable_ipv6=	[IPV6]
			See Documentation/networking/ipv6.txt.
			See Documentation/networking/ipv6.rst.

	disable_mtrr_cleanup [X86]
			The kernel tries to adjust MTRR layout from continuous
@@ -4910,7 +4910,7 @@
			Set the number of tcp_metrics_hash slots.
			Default value is 8192 or 16384 depending on total
			ram pages. This is used to specify the TCP metrics
			cache size. See Documentation/networking/ip-sysctl.txt
			cache size. See Documentation/networking/ip-sysctl.rst
			"tcp_no_metrics_save" section for more details.

	tdfx=		[HW,DRM]
+2 −2
Original line number Diff line number Diff line
@@ -353,8 +353,8 @@ socket's buffer. It will not take effect unless PF_UNIX flag is specified.

3. /proc/sys/net/ipv4 - IPV4 settings
-------------------------------------
Please see: Documentation/networking/ip-sysctl.txt and ipvs-sysctl.txt for
descriptions of these entries.
Please see: Documentation/networking/ip-sysctl.rst and
Documentation/admin-guide/sysctl/net.rst for descriptions of these entries.


4. Appletalk
+2 −2
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ Filter) facility, with a focus on the extended BPF version (eBPF).

This kernel side documentation is still work in progress.  The main
textual documentation is (for historical reasons) described in
`Documentation/networking/filter.txt`_, which describe both classical
`Documentation/networking/filter.rst`_, which describe both classical
and extended BPF instruction-set.
The Cilium project also maintains a `BPF and XDP Reference Guide`_
that goes into great technical depth about the BPF Architecture.
@@ -59,7 +59,7 @@ Testing and debugging BPF


.. Links:
.. _Documentation/networking/filter.txt: ../networking/filter.txt
.. _Documentation/networking/filter.rst: ../networking/filter.txt
.. _man-pages: https://www.kernel.org/doc/man-pages/
.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/
+31 −15
Original line number Diff line number Diff line
.. SPDX-License-Identifier: GPL-2.0

==============
6pack Protocol
==============

This is the 6pack-mini-HOWTO, written by

Andreas Könsgen DG3KQ
Internet: ajk@comnets.uni-bremen.de
AMPR-net: dg3kq@db0pra.ampr.org
AX.25:    dg3kq@db0ach.#nrw.deu.eu

:Internet: ajk@comnets.uni-bremen.de
:AMPR-net: dg3kq@db0pra.ampr.org
:AX.25:    dg3kq@db0ach.#nrw.deu.eu

Last update: April 7, 1998

1. What is 6pack, and what are the advantages to KISS?
======================================================

6pack is a transmission protocol for data exchange between the PC and
the TNC over a serial line. It can be used as an alternative to KISS.

6pack has two major advantages:

- The PC is given full control over the radio
  channel. Special control data is exchanged between the PC and the TNC so
  that the PC knows at any time if the TNC is receiving data, if a TNC
@@ -36,6 +45,7 @@ More details about 6pack are described in the file 6pack.ps that is located
in the doc directory of the AX.25 utilities package.

2. Who has developed the 6pack protocol?
========================================

The 6pack protocol has been developed by Ekki Plicht DF4OR, Henning Rech
DF9IC and Gunter Jost DK7WJ. A driver for 6pack, written by Gunter Jost and
@@ -44,12 +54,14 @@ They have also written a firmware for TNCs to perform the 6pack
protocol (see section 4 below).

3. Where can I get the latest version of 6pack for LinuX?
=========================================================

At the moment, the 6pack stuff can obtained via anonymous ftp from
db0bm.automation.fh-aachen.de. In the directory /incoming/dg3kq,
there is a file named 6pack.tgz.

4. Preparing the TNC for 6pack operation
========================================

To be able to use 6pack, a special firmware for the TNC is needed. The EPROM
of a newly bought TNC does not contain 6pack, so you will have to
@@ -75,12 +87,14 @@ and the status LED are lit for about a second if the firmware initialises
the TNC correctly.

5. Building and installing the 6pack driver
===========================================

The driver has been tested with kernel version 2.1.90. Use with older
kernels may lead to a compilation error because the interface to a kernel
function has been changed in the 2.1.8x kernels.

How to turn on 6pack support:
=============================

- In the linux kernel configuration program, select the code maturity level
  options menu and turn on the prompting for development drivers.
@@ -94,13 +108,13 @@ To use the driver, the kissattach program delivered with the AX.25 utilities
has to be modified.

- Do a cd to the directory that holds the kissattach sources. Edit the
  kissattach.c file. At the top, insert the following lines:
  kissattach.c file. At the top, insert the following lines::

    #ifndef N_6PACK
    #define N_6PACK (N_AX25+1)
    #endif

  Then find the line
  Then find the line:

    int disc = N_AX25;

@@ -109,6 +123,7 @@ has to be modified.
- Recompile kissattach. Rename it to spattach to avoid confusions.

Installing the driver:
----------------------

- Do an insmod 6pack. Look at your /var/log/messages file to check if the
  module has printed its initialization message.
@@ -138,6 +153,7 @@ from the PC to the TNC over the serial line, the status LED if data is
sent to the PC.

6. Known problems
=================

When testing the driver with 2.0.3x kernels and
operating with data rates on the radio channel of 9600 Baud or higher,
+56 −33
Original line number Diff line number Diff line
.. SPDX-License-Identifier: GPL-2.0

.. include:: <isonum.txt>

=======================================
Altera Triple-Speed Ethernet MAC driver
=======================================

Copyright (C) 2008-2014 Altera Corporation
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

5) Debug Information
--------------------------
 - 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
====================

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:

Loading