readme.txt

ＭＯＸＡ卡的多串口卡ＬＩＮＵＸ下测试工具

=============================================================================
          MOXA Smartio/Industio Family Device Driver Installation Guide
		    for Linux Kernel 2.2.x and 2.0.3x and 2.4.x
	       Copyright (C) 2001, Moxa Technologies Co, Ltd.
=============================================================================
Date: 08/28/2001

Content

0. Note
1. Introduction
2. System Requirement
3. Installation
   3.1 Hardware installation
   3.2 Driver files   
   3.3 Device naming convention
   3.4 Module driver configuration   
   3.5 Static driver configuration for Linux kernel 2.2.14 or above,
       include 2.4.x.
   3.6 Static driver configuration for Linux kernel 2.0.3x, and 
       2.2.14 before.
   3.7 Custom configuration
   3.8 Verify driver installation
4. Utilities
5. Setserial
6. Troubleshooting

-----------------------------------------------------------------------------
0. Note

   0.1 For Linux kernel 2.2.14 or above user.
      The Moxa Smartio/Industio driver is ready in the Linux kernel  
      version 2.2.14 or above. But to use this built-in driver, you still need 
      more utilities which downloaded from Moxa ftp or CD-ROM. We suggest you 
      backup this built-in driver (/usr/src/linux/drivers/char/mxser.c) and 
      use the driver downloaded from Moxa or CD-ROM.
      
      We will describe this topic in this document.
      
      
   0.2 Installation step summary.   
   
      Hardware installation:
      	Refer to the "3.1 Hardware installation".
      	
      Software/driver installation:	   	
        0.2.1 Extract the Moxa driver: Refer to the "3.2 Driver files".
        
        0.2.2 There are two methods to install Moxa driver: module & static. If 
          you want to use module method, refer to the "3.4 Module driver
          configuration". If you want to use static method, refer to the
          "3.5 & 3.6 Static driver configuration".

-----------------------------------------------------------------------------
1. Introduction

   The Smartio/Industio family Linux driver supports following multiport 
   boards.

    -C102 series, CI-132 series, CP-132 series 2 ports multiport board.
    -C104P/H/HS, CI-104J series, C104H/PCI series, CI-134 series, 
     CP-114 series, CT-114I 4 ports multiport board.
    -C168P/H/HS, C168H/PCI 8 ports multiport board.

   This driver and installation procedure have been developed upon Linux Kernel
   2.2.5 and compatible to 2.0.3x and 2.4.x. This driver supports Intel x86 
   hardware platform. In order to maintain compatibility, this version
   has also been properly tested with RedHat, OpenLinux, TurboLinux and
   S.u.S.E Linux. However, if compatibility problem occurs, please contact
   Moxa at [e-mail].

   In addition to device driver, useful utilities are also provided in this
   version. They are
    - msdiag     Diagnostic program for displaying installed Moxa 
                 Smartio/Industio boards.
    - msmon      Monitor program to observe data count and line status signals.
    - msterm     A simple terminal program which is useful in testing serial
	         ports.
    - io-irq.exe Configuration program to setup ISA boards. Please note that
                 this program can only be executed under DOS.

   All the drivers and utilities are published in form of source code under
   GNU General Public License in this version. Please refer to GNU General
   Public License announcement in each source code file for more detail.

   In Moxa's ftp sites, you may always find latest driver at
   ftp://ftp.moxa.com  or ftp://ftp.moxa.com.tw.

   This version of driver can be installed as Loadable Module (Module driver)
   or built-in into kernel (Static driver). You may refer to following
   installation procedure for suitable one. Before you install the driver,
   please refer to hardware installation procedure in the User's Manual.

   We assume the user should be familiar with following documents.
   - Serial-HOWTO
   - Kernel-HOWTO

-----------------------------------------------------------------------------
2. System Requirement
   - Hardware platform: Intel x86 machine
   - Kernel version: 2.0.3x or 2.2.x or 2.4.x
   - gcc version 2.72 or later
   - Maximum 4 boards can be installed in combination

-----------------------------------------------------------------------------
3. Installation

   3.1 Hardware installation
   3.2 Driver files   
   3.3 Device naming convention
   3.4 Module driver configuration   
   3.5 Static driver configuration for Linux kernel 2.2.14 or above,
       include 2.4.x.
   3.6 Static driver configuration for Linux kernel 2.0.3x, and 
       2.2.14 before.
   3.7 Custom configuration
   3.8 Verify driver installation
       
             
   3.1 Hardware installation

       There are two types of buses, ISA and PCI, for Smartio/Industio 
       family multiport board.

       ISA board
       ---------
       You'll have to configure CAP address, I/O address, Interrupt Vector
       as well as IRQ before installing this driver. Please refer to hardware
       installation procedure in User's Manual before proceed any further.
       Please make sure the JP1 is open after the ISA board is set properly.

       PCI board
       ---------
       You may need to adjust IRQ usage in BIOS to avoid from IRQ conflict
       with other ISA devices. Please refer to hardware installation
       procedure in User's Manual in advance.

       PCI IRQ Sharing
       -----------
       Each port within the same multiport board shares the same IRQ. Up to
       4 Moxa Smartio/Industio PCI Family multiport boards can be installed 
       together on one system and they can share the same IRQ.


   3.2 Driver files

       The driver file may be obtained from ftp, CD-ROM or floppy disk. The
       first step, anyway, is to copy driver file "mxser.tgz" into specified
       directory. e.g. /moxa. The execute commands as below.

       # cd / 
       # mkdir moxa 		
       # cd /moxa
       # tar xvf /dev/fd0 
       
       or
       
       # cd /
       # mkdir moxa
       # cd /moxa
       # cp /mnt/cdrom/<driver directory>/mxser.tgz .
       # tar xvfz mxser.tgz


   3.3 Device naming convention
   
       You may find all the driver and utilities files in /moxa/mxser.
       Following installation procedure depends on the model you'd like to
       run the driver. If you prefer module driver, please refer to 3.4.
       If static driver is required, please refer to 3.5 & 3.6.

       Dialin and callout port
       -----------------------
       This driver remains traditional serial device properties. There are
       two special file name for each serial port. One is dial-in port
       which is named "ttyMxx". For callout port, the naming convention
       is "cumxx".

       Device naming when more than 2 boards installed
       -----------------------------------------------
       Naming convention for each Smartio/Industio multiport board is 
       pre-defined as below.

       Board Num.	 Dial-in Port	      Callout port
       1st board	ttyM0  - ttyM7	      cum0  - cum7
       2nd board	ttyM8  - ttyM15       cum8  - cum15
       3rd board	ttyM16 - ttyM23       cum16 - cum23
       4th board	ttyM24 - ttym31       cum24 - cum31

       Board sequence
       --------------
       This driver will activate ISA boards according to the parameter set
       in the driver. After all specified ISA board activated, PCI board
       will be installed in the system automatically driven.
       Therefore the board number is sorted by the CAP address of ISA boards.
       For PCI boards, their sequence will be after ISA boards and C168H/PCI
       has higher priority than C104H/PCI boards.

   3.4 Module driver configuration
       Module driver is easiest way to install. If you prefer static driver
       installation, please skip this paragraph.
       

       ------------- Prepare to use the MOXA driver--------------------  
       3.4.1 Create tty device with correct major number
          Before using MOXA driver, your system must have the tty devices 
          which are created with driver's major number. We offer one shell
          script "msmknod" to simplify the procedure. 
          This step is only needed to be executed once. But you still
          need to do this procedure when:
          a. You change the driver's major number. Please refer the "3.7"
             section.
          b. Your total installed MOXA boards number is changed. Maybe you 
             add/delete one MOXA board.
          c. You want to change the tty name. This needs to modify the 
             shell script "msmknod"

          The procedure is:
	  # cd /moxa/mxser/driver
	  # ./msmknod

          This shell script will require the major number for dial-in 
          device and callout device to create tty device. You also need 
          to specify the total installed MOXA board number. Default major 
          numbers for dial-in device and callout device are 30, 35. If
          you need to change to other number, please refer section "3.7"
          for more detailed procedure.
          Msmknod will delete any special files occupying the same device 
          naming.
          
       3.4.2 Build the MOXA driver and utilities
          Before using the MOXA driver and utilities, you need compile the
          all the source code. This step is only need to be executed once.
          But you still re-compile the source code if you modify the source
          code. For example, if you change the driver's major number (see 
          "3.7" section), then you need to do this step again.
                    
          Find "Makefile" in /moxa/mxser, then run

	  # make clean; make install

	  The driver files "mxser.o" and utilities will be properly compiled
	  and copied to system directories respectively. 
          
       ------------- Load MOXA driver--------------------  
       3.4.3 Load the MOXA driver  

	  # insmod mxser <argument>

	  will activate the module driver. You may run "lsmod" to check
	  if "mxser.o" is activated. If the MOXA board is ISA board, the 
          <argument> is needed. Please refer to section "3.4.5" for more
          information.
 
 
       ------------- Load MOXA driver on boot --------------------  
       3.4.4 For the above description, you may manually execute "insmod mxser" 
          to activate this driver and run "rmmod mxser" to remove it. 
          However, it's better to have a boot time configuration to 
          eliminate manual operation. Boot time configuration can be 
          achieved by rc file. We offer one "rc.mxser" file to simplify 
          the procedure under "moxa/mxser/driver". 
          
          But if you use ISA board, please modify the "insmod ..." command 
          to add the argument (see "3.4.5" section). After modifying the 
          rc.mxser, please try to execute "/moxa/mxser/driver/rc.mxser" 
          manually to make sure the modification is ok. If any error 
          encountered, please try to modify again. If the modification is 
          completed, follow the below step.
	  
	  Run following command for setting rc files.

	  # cd /moxa/mxser/driver
	  # cp ./rc.mxser /etc/rc.d
	  # cd /etc/rc.d

	  Check "rc.serial" is existed or not. If "rc.serial" doesn't exist, 
	  create it by vi, run "chmod 755 rc.serial" to change the permission.
	  Add "/etc/rc.d/rc.mxser" in last line, 

          Reboot and check if moxa.o activated by "lsmod" command.

       3.4.5. If you'd like to drive Smartio/Industio ISA boards in the system, 
          you'll have to add parameter to specify CAP address of given 
	  board while activating "mxser.o". The format for parameters are 
	  as follows.

	  insmod mxser ioaddr=0x???,0x???,0x???,0x???
				|      |     |	  |
				|      |     |	  +- 4th ISA board
				|      |     +------ 3rd ISA board
				|      +------------ 2nd ISA board
				+------------------- 1st ISA board

   3.5 Static driver configuration for Linux kernel 2.2.14 or above,
       include 2.4.x.
       
       Note: To use static driver, you must install the linux kernel
             source package.