Commit aac86c88 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller

docs: networking: convert iphase.txt to ReST

- add SPDX header;
- adjust title using the proper markup;
- mark code blocks and literals as such;
- mark tables as such;
- mark lists as such;
- adjust identation, whitespaces and blank lines;
- 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 9de1fcdf
...@@ -67,6 +67,7 @@ Contents: ...@@ -67,6 +67,7 @@ Contents:
ila ila
ipddp ipddp
ip_dynaddr ip_dynaddr
iphase
.. only:: subproject and html .. only:: subproject and html
......
.. SPDX-License-Identifier: GPL-2.0
==================================
ATM (i)Chip IA Linux Driver Source
==================================
READ ME FISRT READ ME FISRT
ATM (i)Chip IA Linux Driver Source
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
Read This Before You Begin! Read This Before You Begin!
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
Description Description
----------- ===========
This is the README file for the Interphase PCI ATM (i)Chip IA Linux driver This is the README file for the Interphase PCI ATM (i)Chip IA Linux driver
source release. source release.
The features and limitations of this driver are as follows: The features and limitations of this driver are as follows:
- A single VPI (VPI value of 0) is supported. - A single VPI (VPI value of 0) is supported.
- Supports 4K VCs for the server board (with 512K control memory) and 1K - Supports 4K VCs for the server board (with 512K control memory) and 1K
VCs for the client board (with 128K control memory). VCs for the client board (with 128K control memory).
...@@ -29,14 +37,16 @@ The features and limitations of this driver are as follows: ...@@ -29,14 +37,16 @@ The features and limitations of this driver are as follows:
Before You Start Before You Start
---------------- ================
Installation Installation
------------ ------------
1. Installing the adapters in the system 1. Installing the adapters in the system
To install the ATM adapters in the system, follow the steps below. To install the ATM adapters in the system, follow the steps below.
a. Login as root. a. Login as root.
b. Shut down the system and power off the system. b. Shut down the system and power off the system.
c. Install one or more ATM adapters in the system. c. Install one or more ATM adapters in the system.
...@@ -48,25 +58,28 @@ Installation ...@@ -48,25 +58,28 @@ Installation
2. [ Removed ] 2. [ Removed ]
3. Rebuild kernel with ABR support 3. Rebuild kernel with ABR support
[ a. and b. removed ] [ a. and b. removed ]
c. Reconfigure the kernel, choose the Interphase ia driver through "make c. Reconfigure the kernel, choose the Interphase ia driver through "make
menuconfig" or "make xconfig". menuconfig" or "make xconfig".
d. Rebuild the kernel, loadable modules and the atm tools. d. Rebuild the kernel, loadable modules and the atm tools.
e. Install the new built kernel and modules and reboot. e. Install the new built kernel and modules and reboot.
4. Load the adapter hardware driver (ia driver) if it is built as a module 4. Load the adapter hardware driver (ia driver) if it is built as a module
a. Login as root. a. Login as root.
b. Change directory to /lib/modules/<kernel-version>/atm. b. Change directory to /lib/modules/<kernel-version>/atm.
c. Run "insmod suni.o;insmod iphase.o" c. Run "insmod suni.o;insmod iphase.o"
The yellow 'status' LED on the front panel of the adapter will blink The yellow 'status' LED on the front panel of the adapter will blink
while the driver is loaded in the system. while the driver is loaded in the system.
d. To verify that the 'ia' driver is loaded successfully, run the d. To verify that the 'ia' driver is loaded successfully, run the
following command: following command::
cat /proc/atm/devices cat /proc/atm/devices
If the driver is loaded successfully, the output of the command will If the driver is loaded successfully, the output of the command will
be similar to the following lines: be similar to the following lines::
Itf Type ESI/"MAC"addr AAL(TX,err,RX,err,drop) ... Itf Type ESI/"MAC"addr AAL(TX,err,RX,err,drop) ...
0 ia xxxxxxxxx 0 ( 0 0 0 0 0 ) 5 ( 0 0 0 0 0 ) 0 ia xxxxxxxxx 0 ( 0 0 0 0 0 ) 5 ( 0 0 0 0 0 )
...@@ -81,23 +94,27 @@ Installation ...@@ -81,23 +94,27 @@ Installation
1M. The RAM size decides the number of buffers and buffer size. The default 1M. The RAM size decides the number of buffers and buffer size. The default
size and number of buffers are set as following: size and number of buffers are set as following:
========= ======= ====== ====== ====== ====== ======
Total Rx RAM Tx RAM Rx Buf Tx Buf Rx buf Tx buf Total Rx RAM Tx RAM Rx Buf Tx Buf Rx buf Tx buf
RAM size size size size size cnt cnt RAM size size size size size cnt cnt
-------- ------ ------ ------ ------ ------ ------ ========= ======= ====== ====== ====== ====== ======
128K 64K 64K 10K 10K 6 6 128K 64K 64K 10K 10K 6 6
512K 256K 256K 10K 10K 25 25 512K 256K 256K 10K 10K 25 25
1M 512K 512K 10K 10K 51 51 1M 512K 512K 10K 10K 51 51
========= ======= ====== ====== ====== ====== ======
These setting should work well in most environments, but can be These setting should work well in most environments, but can be
changed by typing the following command: changed by typing the following command::
insmod <IA_DIR>/ia.o IA_RX_BUF=<RX_CNT> IA_RX_BUF_SZ=<RX_SIZE> \ insmod <IA_DIR>/ia.o IA_RX_BUF=<RX_CNT> IA_RX_BUF_SZ=<RX_SIZE> \
IA_TX_BUF=<TX_CNT> IA_TX_BUF_SZ=<TX_SIZE> IA_TX_BUF=<TX_CNT> IA_TX_BUF_SZ=<TX_SIZE>
Where: Where:
RX_CNT = number of receive buffers in the range (1-128)
RX_SIZE = size of receive buffers in the range (48-64K) - RX_CNT = number of receive buffers in the range (1-128)
TX_CNT = number of transmit buffers in the range (1-128) - RX_SIZE = size of receive buffers in the range (48-64K)
TX_SIZE = size of transmit buffers in the range (48-64K) - TX_CNT = number of transmit buffers in the range (1-128)
- TX_SIZE = size of transmit buffers in the range (48-64K)
1. Transmit and receive buffer size must be a multiple of 4. 1. Transmit and receive buffer size must be a multiple of 4.
2. Care should be taken so that the memory required for the 2. Care should be taken so that the memory required for the
...@@ -121,33 +138,51 @@ Installation ...@@ -121,33 +138,51 @@ Installation
configured for the PVC(s). configured for the PVC(s).
a. For UBR test: a. For UBR test:
At the test machine intended to receive data, type:
At the test machine intended to receive data, type::
ttcp_atm -r -a -s 0.100 ttcp_atm -r -a -s 0.100
At the other test machine, type:
At the other test machine, type::
ttcp_atm -t -a -s 0.100 -n 10000 ttcp_atm -t -a -s 0.100 -n 10000
Run "ttcp_atm -h" to display more options of the ttcp_atm tool. Run "ttcp_atm -h" to display more options of the ttcp_atm tool.
b. For ABR test: b. For ABR test:
It is the same as the UBR testing, but with an extra command option:
It is the same as the UBR testing, but with an extra command option::
-Pabr:max_pcr=<xxx> -Pabr:max_pcr=<xxx>
where: where:
xxx = the maximum peak cell rate, from 170 - 353207. xxx = the maximum peak cell rate, from 170 - 353207.
This option must be set on both the machines. This option must be set on both the machines.
c. For CBR test: c. For CBR test:
It is the same as the UBR testing, but with an extra command option:
It is the same as the UBR testing, but with an extra command option::
-Pcbr:max_pcr=<xxx> -Pcbr:max_pcr=<xxx>
where: where:
xxx = the maximum peak cell rate, from 170 - 353207. xxx = the maximum peak cell rate, from 170 - 353207.
This option may only be set on the transmit machine. This option may only be set on the transmit machine.
OUTSTANDING ISSUES Outstanding Issues
------------------ ==================
Contact Information Contact Information
------------------- -------------------
::
Customer Support: Customer Support:
United States: Telephone: (214) 654-5555 United States: Telephone: (214) 654-5555
Fax: (214) 654-5500 Fax: (214) 654-5500
......
...@@ -306,7 +306,7 @@ config ATM_IA ...@@ -306,7 +306,7 @@ config ATM_IA
for more info about the cards. Say Y (or M to compile as a module for more info about the cards. Say Y (or M to compile as a module
named iphase) here if you have one of these cards. named iphase) here if you have one of these cards.
See the file <file:Documentation/networking/iphase.txt> for further See the file <file:Documentation/networking/iphase.rst> for further
details. details.
config ATM_IA_DEBUG config ATM_IA_DEBUG
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment