0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 ==================================
0004 ATM (i)Chip IA Linux Driver Source
0005 ==================================
0006
0007 READ ME FISRT
0008
0009 --------------------------------------------------------------------------------
0010
0011 Read This Before You Begin!
0012
0013 --------------------------------------------------------------------------------
0014
0015 Description
0016 ===========
0017
0018 This is the README file for the Interphase PCI ATM (i)Chip IA Linux driver
0019 source release.
0020
0021 The features and limitations of this driver are as follows:
0022
0023 - A single VPI (VPI value of 0) is supported.
0024 - Supports 4K VCs for the server board (with 512K control memory) and 1K
0025 VCs for the client board (with 128K control memory).
0026 - UBR, ABR and CBR service categories are supported.
0027 - Only AAL5 is supported.
0028 - Supports setting of PCR on the VCs.
0029 - Multiple adapters in a system are supported.
0030 - All variants of Interphase ATM PCI (i)Chip adapter cards are supported,
0031 including x575 (OC3, control memory 128K , 512K and packet memory 128K,
0032 512K and 1M), x525 (UTP25) and x531 (DS3 and E3). See
0033 http://www.iphase.com/
0034 for details.
0035 - Only x86 platforms are supported.
0036 - SMP is supported.
0037
0038
0039 Before You Start
0040 ================
0041
0042
0043 Installation
0044 ------------
0045
0046 1. Installing the adapters in the system
0047
0048 To install the ATM adapters in the system, follow the steps below.
0049
0050 a. Login as root.
0051 b. Shut down the system and power off the system.
0052 c. Install one or more ATM adapters in the system.
0053 d. Connect each adapter to a port on an ATM switch. The green 'Link'
0054 LED on the front panel of the adapter will be on if the adapter is
0055 connected to the switch properly when the system is powered up.
0056 e. Power on and boot the system.
0057
0058 2. [ Removed ]
0059
0060 3. Rebuild kernel with ABR support
0061
0062 [ a. and b. removed ]
0063
0064 c. Reconfigure the kernel, choose the Interphase ia driver through "make
0065 menuconfig" or "make xconfig".
0066 d. Rebuild the kernel, loadable modules and the atm tools.
0067 e. Install the new built kernel and modules and reboot.
0068
0069 4. Load the adapter hardware driver (ia driver) if it is built as a module
0070
0071 a. Login as root.
0072 b. Change directory to /lib/modules/<kernel-version>/atm.
0073 c. Run "insmod suni.o;insmod iphase.o"
0074 The yellow 'status' LED on the front panel of the adapter will blink
0075 while the driver is loaded in the system.
0076 d. To verify that the 'ia' driver is loaded successfully, run the
0077 following command::
0078
0079 cat /proc/atm/devices
0080
0081 If the driver is loaded successfully, the output of the command will
0082 be similar to the following lines::
0083
0084 Itf Type ESI/"MAC"addr AAL(TX,err,RX,err,drop) ...
0085 0 ia xxxxxxxxx 0 ( 0 0 0 0 0 ) 5 ( 0 0 0 0 0 )
0086
0087 You can also check the system log file /var/log/messages for messages
0088 related to the ATM driver.
0089
0090 5. Ia Driver Configuration
0091
0092 5.1 Configuration of adapter buffers
0093 The (i)Chip boards have 3 different packet RAM size variants: 128K, 512K and
0094 1M. The RAM size decides the number of buffers and buffer size. The default
0095 size and number of buffers are set as following:
0096
0097 ========= ======= ====== ====== ====== ====== ======
0098 Total Rx RAM Tx RAM Rx Buf Tx Buf Rx buf Tx buf
0099 RAM size size size size size cnt cnt
0100 ========= ======= ====== ====== ====== ====== ======
0101 128K 64K 64K 10K 10K 6 6
0102 512K 256K 256K 10K 10K 25 25
0103 1M 512K 512K 10K 10K 51 51
0104 ========= ======= ====== ====== ====== ====== ======
0105
0106 These setting should work well in most environments, but can be
0107 changed by typing the following command::
0108
0109 insmod <IA_DIR>/ia.o IA_RX_BUF=<RX_CNT> IA_RX_BUF_SZ=<RX_SIZE> \
0110 IA_TX_BUF=<TX_CNT> IA_TX_BUF_SZ=<TX_SIZE>
0111
0112 Where:
0113
0114 - RX_CNT = number of receive buffers in the range (1-128)
0115 - RX_SIZE = size of receive buffers in the range (48-64K)
0116 - TX_CNT = number of transmit buffers in the range (1-128)
0117 - TX_SIZE = size of transmit buffers in the range (48-64K)
0118
0119 1. Transmit and receive buffer size must be a multiple of 4.
0120 2. Care should be taken so that the memory required for the
0121 transmit and receive buffers is less than or equal to the
0122 total adapter packet memory.
0123
0124 5.2 Turn on ia debug trace
0125
0126 When the ia driver is built with the CONFIG_ATM_IA_DEBUG flag, the driver
0127 can provide more debug trace if needed. There is a bit mask variable,
0128 IADebugFlag, which controls the output of the traces. You can find the bit
0129 map of the IADebugFlag in iphase.h.
0130 The debug trace can be turn on through the insmod command line option, for
0131 example, "insmod iphase.o IADebugFlag=0xffffffff" can turn on all the debug
0132 traces together with loading the driver.
0133
0134 6. Ia Driver Test Using ttcp_atm and PVC
0135
0136 For the PVC setup, the test machines can either be connected back-to-back or
0137 through a switch. If connected through the switch, the switch must be
0138 configured for the PVC(s).
0139
0140 a. For UBR test:
0141
0142 At the test machine intended to receive data, type::
0143
0144 ttcp_atm -r -a -s 0.100
0145
0146 At the other test machine, type::
0147
0148 ttcp_atm -t -a -s 0.100 -n 10000
0149
0150 Run "ttcp_atm -h" to display more options of the ttcp_atm tool.
0151 b. For ABR test:
0152
0153 It is the same as the UBR testing, but with an extra command option::
0154
0155 -Pabr:max_pcr=<xxx>
0156
0157 where:
0158
0159 xxx = the maximum peak cell rate, from 170 - 353207.
0160
0161 This option must be set on both the machines.
0162
0163 c. For CBR test:
0164
0165 It is the same as the UBR testing, but with an extra command option::
0166
0167 -Pcbr:max_pcr=<xxx>
0168
0169 where:
0170
0171 xxx = the maximum peak cell rate, from 170 - 353207.
0172
0173 This option may only be set on the transmit machine.
0174
0175
0176 Outstanding Issues
0177 ==================
0178
0179
0180
0181 Contact Information
0182 -------------------
0183
0184 ::
0185
0186 Customer Support:
0187 United States: Telephone: (214) 654-5555
0188 Fax: (214) 654-5500
0189 E-Mail: intouch@iphase.com
0190 Europe: Telephone: 33 (0)1 41 15 44 00
0191 Fax: 33 (0)1 41 15 12 13
0192 World Wide Web: http://www.iphase.com
0193 Anonymous FTP: ftp.iphase.com
