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

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

Documentation/networking/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -67,6 +67,7 @@ Contents: 
   ila

   ipddp

   ip_dynaddr

   iphase



.. only::  subproject and html

Documentation/networking/iphase.txt→Documentation/networking/iphase.rst

+111 −76
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



                              READ ME FISRT

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

ATM (i)Chip IA Linux Driver Source

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



			      READ ME FISRT



--------------------------------------------------------------------------------



		     Read This Before You Begin!



--------------------------------------------------------------------------------



Description

-----------

===========



This is the README file for the Interphase PCI ATM (i)Chip IA Linux driver

source release.



The features and limitations of this driver are as follows:



    - A single VPI (VPI value of 0) is supported.

    - Supports 4K VCs for the server board (with 512K control memory) and 1K

      VCs for the client board (with 128K control memory).
@@ -29,14 +37,16 @@ The features and limitations of this driver are as follows: 




Before You Start

---------------- 

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





Installation

------------



1. Installing the adapters in the system



   To install the ATM adapters in the system, follow the steps below.



       a. Login as root.

       b. Shut down the system and power off the system.

       c. Install one or more ATM adapters in the system.
@@ -48,25 +58,28 @@ Installation 
2. [ Removed ]



3. Rebuild kernel with ABR support



   [ a. and b. removed ]



    c. Reconfigure the kernel, choose the Interphase ia driver through "make

       menuconfig" or "make xconfig".

    d. Rebuild the kernel, loadable modules and the atm tools.

    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



       a. Login as root.

       b. Change directory to /lib/modules/<kernel-version>/atm.

       c. Run "insmod suni.o;insmod iphase.o"

	  The yellow 'status' LED on the front panel of the adapter will blink

	  while the driver is loaded in the system.

       d. To verify that the 'ia' driver is loaded successfully, run the

          following command:

	  following command::



	      cat /proc/atm/devices



	  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) ...

	      0   ia      xxxxxxxxx  0 ( 0 0 0 0 0 )  5 ( 0 0 0 0 0 )
@@ -81,23 +94,27 @@ Installation 
    1M. The RAM size decides the number of buffers and buffer size. The default

    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

         --------  ------   ------   ------   ------   ------   ------

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

	   128K      64K      64K      10K      10K       6        6

	   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

       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)



	    - 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
@@ -121,33 +138,51 @@ Installation 
   configured for the PVC(s).



   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

      At the other test machine, type:



      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.

   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>



      where:



	     xxx = the maximum peak cell rate, from 170 - 353207.



      This option must be set on both the machines.



   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>



      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

-------------------



::



     Customer Support:

	 United States:	Telephone:	(214) 654-5555

			Fax:		(214) 654-5500

drivers/atm/Kconfig

+1 −1
Original line number Diff line number Diff line
@@ -306,7 +306,7 @@ config ATM_IA 
	  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.



	  See the file <file:Documentation/networking/iphase.txt> for further

	  See the file <file:Documentation/networking/iphase.rst> for further

	  details.



config ATM_IA_DEBUG