1.. SPDX-License-Identifier: GPL-2.0
2
3==================================
4ATM (i)Chip IA Linux Driver Source
5==================================
6
7			      READ ME FIRST
8
9--------------------------------------------------------------------------------
10
11		     Read This Before You Begin!
12
13--------------------------------------------------------------------------------
14
15Description
16===========
17
18This is the README file for the Interphase PCI ATM (i)Chip IA Linux driver
19source release.
20
21The features and limitations of this driver are as follows:
22
23    - A single VPI (VPI value of 0) is supported.
24    - Supports 4K VCs for the server board (with 512K control memory) and 1K
25      VCs for the client board (with 128K control memory).
26    - UBR, ABR and CBR service categories are supported.
27    - Only AAL5 is supported.
28    - Supports setting of PCR on the VCs.
29    - Multiple adapters in a system are supported.
30    - All variants of Interphase ATM PCI (i)Chip adapter cards are supported,
31      including x575 (OC3, control memory 128K , 512K and packet memory 128K,
32      512K and 1M), x525 (UTP25) and x531 (DS3 and E3). See
33      http://www.iphase.com/
34      for details.
35    - Only x86 platforms are supported.
36    - SMP is supported.
37
38
39Before You Start
40================
41
42
43Installation
44------------
45
461. Installing the adapters in the system
47
48   To install the ATM adapters in the system, follow the steps below.
49
50       a. Login as root.
51       b. Shut down the system and power off the system.
52       c. Install one or more ATM adapters in the system.
53       d. Connect each adapter to a port on an ATM switch. The green 'Link'
54	  LED on the front panel of the adapter will be on if the adapter is
55	  connected to the switch properly when the system is powered up.
56       e. Power on and boot the system.
57
582. [ Removed ]
59
603. Rebuild kernel with ABR support
61
62   [ a. and b. removed ]
63
64    c. Reconfigure the kernel, choose the Interphase ia driver through "make
65       menuconfig" or "make xconfig".
66    d. Rebuild the kernel, loadable modules and the atm tools.
67    e. Install the new built kernel and modules and reboot.
68
694. Load the adapter hardware driver (ia driver) if it is built as a module
70
71       a. Login as root.
72       b. Change directory to /lib/modules/<kernel-version>/atm.
73       c. Run "insmod suni.o;insmod iphase.o"
74	  The yellow 'status' LED on the front panel of the adapter will blink
75	  while the driver is loaded in the system.
76       d. To verify that the 'ia' driver is loaded successfully, run the
77	  following command::
78
79	      cat /proc/atm/devices
80
81	  If the driver is loaded successfully, the output of the command will
82	  be similar to the following lines::
83
84	      Itf Type    ESI/"MAC"addr AAL(TX,err,RX,err,drop) ...
85	      0   ia      xxxxxxxxx  0 ( 0 0 0 0 0 )  5 ( 0 0 0 0 0 )
86
87	  You can also check the system log file /var/log/messages for messages
88	  related to the ATM driver.
89
905. Ia Driver Configuration
91
925.1 Configuration of adapter buffers
93    The (i)Chip boards have 3 different packet RAM size variants: 128K, 512K and
94    1M. The RAM size decides the number of buffers and buffer size. The default
95    size and number of buffers are set as following:
96
97	=========  =======  ======   ======   ======   ======   ======
98	 Total     Rx RAM   Tx RAM   Rx Buf   Tx Buf   Rx buf   Tx buf
99	 RAM size  size     size     size     size     cnt      cnt
100	=========  =======  ======   ======   ======   ======   ======
101	   128K      64K      64K      10K      10K       6        6
102	   512K     256K     256K      10K      10K      25       25
103	     1M     512K     512K      10K      10K      51       51
104	=========  =======  ======   ======   ======   ======   ======
105
106       These setting should work well in most environments, but can be
107       changed by typing the following command::
108
109	   insmod <IA_DIR>/ia.o IA_RX_BUF=<RX_CNT> IA_RX_BUF_SZ=<RX_SIZE> \
110		   IA_TX_BUF=<TX_CNT> IA_TX_BUF_SZ=<TX_SIZE>
111
112       Where:
113
114	    - RX_CNT = number of receive buffers in the range (1-128)
115	    - RX_SIZE = size of receive buffers in the range (48-64K)
116	    - TX_CNT = number of transmit buffers in the range (1-128)
117	    - TX_SIZE = size of transmit buffers in the range (48-64K)
118
119	    1. Transmit and receive buffer size must be a multiple of 4.
120	    2. Care should be taken so that the memory required for the
121	       transmit and receive buffers is less than or equal to the
122	       total adapter packet memory.
123
1245.2 Turn on ia debug trace
125
126    When the ia driver is built with the CONFIG_ATM_IA_DEBUG flag, the driver
127    can provide more debug trace if needed. There is a bit mask variable,
128    IADebugFlag, which controls the output of the traces. You can find the bit
129    map of the IADebugFlag in iphase.h.
130    The debug trace can be turn on through the insmod command line option, for
131    example, "insmod iphase.o IADebugFlag=0xffffffff" can turn on all the debug
132    traces together with loading the driver.
133
1346. Ia Driver Test Using ttcp_atm and PVC
135
136   For the PVC setup, the test machines can either be connected back-to-back or
137   through a switch. If connected through the switch, the switch must be
138   configured for the PVC(s).
139
140   a. For UBR test:
141
142      At the test machine intended to receive data, type::
143
144	 ttcp_atm -r -a -s 0.100
145
146      At the other test machine, type::
147
148	 ttcp_atm -t -a -s 0.100 -n 10000
149
150      Run "ttcp_atm -h" to display more options of the ttcp_atm tool.
151   b. For ABR test:
152
153      It is the same as the UBR testing, but with an extra command option::
154
155	 -Pabr:max_pcr=<xxx>
156
157      where:
158
159	     xxx = the maximum peak cell rate, from 170 - 353207.
160
161      This option must be set on both the machines.
162
163   c. For CBR test:
164
165      It is the same as the UBR testing, but with an extra command option::
166
167	 -Pcbr:max_pcr=<xxx>
168
169      where:
170
171	     xxx = the maximum peak cell rate, from 170 - 353207.
172
173      This option may only be set on the transmit machine.
174
175
176Outstanding Issues
177==================
178
179
180
181Contact Information
182-------------------
183
184::
185
186     Customer Support:
187	 United States:	Telephone:	(214) 654-5555
188			Fax:		(214) 654-5500
189			E-Mail:		intouch@iphase.com
190	 Europe:	Telephone:	33 (0)1 41 15 44 00
191			Fax:		33 (0)1 41 15 12 13
192     World Wide Web:	http://www.iphase.com
193     Anonymous FTP:	ftp.iphase.com
194