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: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Mauro Carvalho Chehab
committed by
David S. Miller
David S. Miller
parent
9de1fcdf36
commit
aac86c887e
@@ -67,6 +67,7 @@ Contents:
|
|||||||
ila
|
ila
|
||||||
ipddp
|
ipddp
|
||||||
ip_dynaddr
|
ip_dynaddr
|
||||||
|
iphase
|
||||||
|
|
||||||
.. only:: subproject and html
|
.. only:: subproject and html
|
||||||
|
|
||||||
|
|||||||
@@ -1,27 +1,35 @@
|
|||||||
|
.. 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).
|
||||||
- UBR, ABR and CBR service categories are supported.
|
- UBR, ABR and CBR service categories are supported.
|
||||||
- Only AAL5 is supported.
|
- Only AAL5 is supported.
|
||||||
- Supports setting of PCR on the VCs.
|
- Supports setting of PCR on the VCs.
|
||||||
- Multiple adapters in a system are supported.
|
- Multiple adapters in a system are supported.
|
||||||
- All variants of Interphase ATM PCI (i)Chip adapter cards are supported,
|
- All variants of Interphase ATM PCI (i)Chip adapter cards are supported,
|
||||||
including x575 (OC3, control memory 128K , 512K and packet memory 128K,
|
including x575 (OC3, control memory 128K , 512K and packet memory 128K,
|
||||||
512K and 1M), x525 (UTP25) and x531 (DS3 and E3). See
|
512K and 1M), x525 (UTP25) and x531 (DS3 and E3). See
|
||||||
http://www.iphase.com/
|
http://www.iphase.com/
|
||||||
for details.
|
for details.
|
||||||
- Only x86 platforms are supported.
|
- Only x86 platforms are supported.
|
||||||
@@ -29,128 +37,155 @@ 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.
|
||||||
d. Connect each adapter to a port on an ATM switch. The green 'Link'
|
d. Connect each adapter to a port on an ATM switch. The green 'Link'
|
||||||
LED on the front panel of the adapter will be on if the adapter is
|
LED on the front panel of the adapter will be on if the adapter is
|
||||||
connected to the switch properly when the system is powered up.
|
connected to the switch properly when the system is powered up.
|
||||||
e. Power on and boot the system.
|
e. Power on and boot the system.
|
||||||
|
|
||||||
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 )
|
||||||
|
|
||||||
You can also check the system log file /var/log/messages for messages
|
You can also check the system log file /var/log/messages for messages
|
||||||
related to the ATM driver.
|
related to the ATM driver.
|
||||||
|
|
||||||
5. Ia Driver Configuration
|
5. Ia Driver Configuration
|
||||||
|
|
||||||
5.1 Configuration of adapter buffers
|
5.1 Configuration of adapter buffers
|
||||||
The (i)Chip boards have 3 different packet RAM size variants: 128K, 512K and
|
The (i)Chip boards have 3 different packet RAM size variants: 128K, 512K and
|
||||||
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
|
========= ======= ====== ====== ====== ====== ======
|
||||||
RAM size size size size size cnt cnt
|
Total Rx RAM Tx RAM Rx Buf Tx Buf Rx buf Tx buf
|
||||||
-------- ------ ------ ------ ------ ------ ------
|
RAM size size size size size cnt cnt
|
||||||
128K 64K 64K 10K 10K 6 6
|
========= ======= ====== ====== ====== ====== ======
|
||||||
512K 256K 256K 10K 10K 25 25
|
128K 64K 64K 10K 10K 6 6
|
||||||
1M 512K 512K 10K 10K 51 51
|
512K 256K 256K 10K 10K 25 25
|
||||||
|
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> \
|
|
||||||
IA_TX_BUF=<TX_CNT> IA_TX_BUF_SZ=<TX_SIZE>
|
|
||||||
Where:
|
|
||||||
RX_CNT = number of receive buffers in the range (1-128)
|
|
||||||
RX_SIZE = size of receive 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.
|
insmod <IA_DIR>/ia.o IA_RX_BUF=<RX_CNT> IA_RX_BUF_SZ=<RX_SIZE> \
|
||||||
2. Care should be taken so that the memory required for the
|
IA_TX_BUF=<TX_CNT> IA_TX_BUF_SZ=<TX_SIZE>
|
||||||
transmit and receive buffers is less than or equal to the
|
|
||||||
total adapter packet memory.
|
Where:
|
||||||
|
|
||||||
|
- RX_CNT = number of receive buffers in the range (1-128)
|
||||||
|
- RX_SIZE = size of receive 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.
|
||||||
|
2. Care should be taken so that the memory required for the
|
||||||
|
transmit and receive buffers is less than or equal to the
|
||||||
|
total adapter packet memory.
|
||||||
|
|
||||||
5.2 Turn on ia debug trace
|
5.2 Turn on ia debug trace
|
||||||
|
|
||||||
When the ia driver is built with the CONFIG_ATM_IA_DEBUG flag, the driver
|
When the ia driver is built with the CONFIG_ATM_IA_DEBUG flag, the driver
|
||||||
can provide more debug trace if needed. There is a bit mask variable,
|
can provide more debug trace if needed. There is a bit mask variable,
|
||||||
IADebugFlag, which controls the output of the traces. You can find the bit
|
IADebugFlag, which controls the output of the traces. You can find the bit
|
||||||
map of the IADebugFlag in iphase.h.
|
map of the IADebugFlag in iphase.h.
|
||||||
The debug trace can be turn on through the insmod command line option, for
|
The debug trace can be turn on through the insmod command line option, for
|
||||||
example, "insmod iphase.o IADebugFlag=0xffffffff" can turn on all the debug
|
example, "insmod iphase.o IADebugFlag=0xffffffff" can turn on all the debug
|
||||||
traces together with loading the driver.
|
traces together with loading the driver.
|
||||||
|
|
||||||
6. Ia Driver Test Using ttcp_atm and PVC
|
6. Ia Driver Test Using ttcp_atm and PVC
|
||||||
|
|
||||||
For the PVC setup, the test machines can either be connected back-to-back or
|
For the PVC setup, the test machines can either be connected back-to-back or
|
||||||
through a switch. If connected through the switch, the switch must be
|
through a switch. If connected through the switch, the switch must be
|
||||||
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:
|
|
||||||
ttcp_atm -r -a -s 0.100
|
At the test machine intended to receive data, type::
|
||||||
At the other test machine, type:
|
|
||||||
ttcp_atm -t -a -s 0.100 -n 10000
|
ttcp_atm -r -a -s 0.100
|
||||||
|
|
||||||
|
At the other test machine, type::
|
||||||
|
|
||||||
|
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:
|
|
||||||
-Pabr:max_pcr=<xxx>
|
It is the same as the UBR testing, but with an extra command option::
|
||||||
where:
|
|
||||||
xxx = the maximum peak cell rate, from 170 - 353207.
|
-Pabr:max_pcr=<xxx>
|
||||||
This option must be set on both the machines.
|
|
||||||
|
where:
|
||||||
|
|
||||||
|
xxx = the maximum peak cell rate, from 170 - 353207.
|
||||||
|
|
||||||
|
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:
|
|
||||||
-Pcbr:max_pcr=<xxx>
|
It is the same as the UBR testing, but with an extra command option::
|
||||||
where:
|
|
||||||
xxx = the maximum peak cell rate, from 170 - 353207.
|
-Pcbr:max_pcr=<xxx>
|
||||||
This option may only be set on the transmit machine.
|
|
||||||
|
where:
|
||||||
|
|
||||||
|
xxx = the maximum peak cell rate, from 170 - 353207.
|
||||||
|
|
||||||
|
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
|
||||||
E-Mail: intouch@iphase.com
|
E-Mail: intouch@iphase.com
|
||||||
Europe: Telephone: 33 (0)1 41 15 44 00
|
Europe: Telephone: 33 (0)1 41 15 44 00
|
||||||
Fax: 33 (0)1 41 15 12 13
|
Fax: 33 (0)1 41 15 12 13
|
||||||
@@ -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
|
||||||
|
|||||||
Reference in New Issue
Block a user