Documentation/driver-api/serial/moxa-smartio.rst

   1 =============================================================
   2 MOXA Smartio/Industio Family Device Driver Installation Guide
   3 =============================================================
   4
   5 Copyright (C) 2008, Moxa Inc.
   6 Copyright (C) 2021, Jiri Slaby
   7
   8 .. Content
   9
  10    1. Introduction
  11    2. System Requirement
  12    3. Installation
  13       3.1 Hardware installation
  14       3.2 Device naming convention
  15    4. Utilities
  16    5. Setserial
  17    6. Troubleshooting
  18
  19 1. Introduction
  20 ^^^^^^^^^^^^^^^
  21
  22    The Smartio/Industio/UPCI family Linux driver supports following multiport
  23    boards:
  24
  25     - 2 ports multiport board
  26         CP-102U, CP-102UL, CP-102UF
  27         CP-132U-I, CP-132UL,
  28         CP-132, CP-132I, CP132S, CP-132IS,
  29         (CP-102, CP-102S)
  30
  31     - 4 ports multiport board
  32         CP-104EL,
  33         CP-104UL, CP-104JU,
  34         CP-134U, CP-134U-I,
  35         C104H/PCI, C104HS/PCI,
  36         CP-114, CP-114I, CP-114S, CP-114IS, CP-114UL,
  37         (C114HI, CT-114I),
  38         POS-104UL,
  39         CB-114,
  40         CB-134I
  41
  42     - 8 ports multiport board
  43         CP-118EL, CP-168EL,
  44         CP-118U, CP-168U,
  45         C168H/PCI,
  46         CB-108
  47
  48    If a compatibility problem occurs, please contact Moxa at
  49    support@moxa.com.tw.
  50
  51    In addition to device driver, useful utilities are also provided in this
  52    version. They are:
  53
  54     - msdiag
  55                  Diagnostic program for displaying installed Moxa
  56                  Smartio/Industio boards.
  57     - msmon
  58                  Monitor program to observe data count and line status signals.
  59     - msterm     A simple terminal program which is useful in testing serial
  60                  ports.
  61
  62    All the drivers and utilities are published in form of source code under
  63    GNU General Public License in this version. Please refer to GNU General
  64    Public License announcement in each source code file for more detail.
  65
  66    In Moxa's Web sites, you may always find the latest driver at
  67    https://www.moxa.com/.
  68
  69    This version of driver can be installed as a Loadable Module (Module driver)
  70    or built-in into kernel (Static driver). Before you install the driver,
  71    please refer to hardware installation procedure in the User's Manual.
  72
  73    We assume the user should be familiar with following documents:
  74
  75    - Serial-HOWTO
  76    - Kernel-HOWTO
  77
  78 2. System Requirement
  79 ^^^^^^^^^^^^^^^^^^^^^
  80
  81    - Maximum 4 boards can be installed in combination
  82
  83 3. Installation
  84 ^^^^^^^^^^^^^^^
  85
  86 3.1 Hardware installation
  87 =========================
  88
  89 PCI/UPCI board
  90 --------------
  91
  92    You may need to adjust IRQ usage in BIOS to avoid IRQ conflict with other
  93    ISA devices. Please refer to hardware installation procedure in User's
  94    Manual in advance.
  95
  96 PCI IRQ Sharing
  97 ---------------
  98
  99    Each port within the same multiport board shares the same IRQ. Up to
 100    4 Moxa Smartio/Industio PCI Family multiport boards can be installed
 101    together on one system and they can share the same IRQ.
 102
 103
 104
 105 3.2 Device naming convention
 106 ============================
 107
 108    The device node is named "ttyMxx".
 109
 110 Device naming when more than 2 boards installed
 111 -----------------------------------------------
 112
 113    Naming convention for each Smartio/Industio multiport board is
 114    pre-defined as below.
 115
 116    ============ ===============
 117    Board Num.   Device node
 118    1st board    ttyM0  - ttyM7
 119    2nd board    ttyM8  - ttyM15
 120    3rd board    ttyM16 - ttyM23
 121    4th board    ttyM24 - ttyM31
 122    ============ ===============
 123
 124 4. Utilities
 125 ^^^^^^^^^^^^
 126
 127    There are 3 utilities contained in this driver. They are msdiag, msmon and
 128    msterm. These 3 utilities are released in form of source code. They should
 129    be compiled into executable file and copied into /usr/bin.
 130
 131 msdiag - Diagnostic
 132 ===================
 133
 134    This utility provides the function to display what Moxa Smartio/Industio
 135    board was found by the driver in the system.
 136
 137 msmon - Port Monitoring
 138 =======================
 139
 140    This utility gives the user a quick view about all the MOXA ports'
 141    activities. One can easily learn each port's total received/transmitted
 142    (Rx/Tx) character count since the time when the monitoring is started.
 143
 144    Rx/Tx throughputs per second are also reported in interval basis (e.g.
 145    the last 5 seconds) and in average basis (since the time the monitoring
 146    is started). You can reset all ports' count by <HOME> key. <+> <->
 147    (plus/minus) keys to change the displaying time interval. Press <ENTER>
 148    on the port, that cursor stay, to view the port's communication
 149    parameters, signal status, and input/output queue.
 150
 151 msterm - Terminal Emulation
 152 ===========================
 153
 154    This utility provides data sending and receiving ability of all tty ports,
 155    especially for MOXA ports. It is quite useful for testing simple
 156    application, for example, sending AT command to a modem connected to the
 157    port or used as a terminal for login purpose. Note that this is only a
 158    dumb terminal emulation without handling full screen operation.
 159
 160 5. Setserial
 161 ^^^^^^^^^^^^
 162
 163    Supported Setserial parameters are listed as below.
 164
 165    ============== =============================================================
 166    uart           set UART type(16450 --> disable FIFO, 16550A --> enable FIFO)
 167    close_delay    set the amount of time (in 1/100 of a second) that DTR
 168                   should be kept low while being closed.
 169    closing_wait   set the amount of time (in 1/100 of a second) that the
 170                   serial port should wait for data to be drained while
 171                   being closed, before the receiver is disabled.
 172    spd_hi         Use 57.6kb when the application requests 38.4kb.
 173    spd_vhi        Use 115.2kb when the application requests 38.4kb.
 174    spd_shi        Use 230.4kb when the application requests 38.4kb.
 175    spd_warp       Use 460.8kb when the application requests 38.4kb.
 176    spd_normal     Use 38.4kb when the application requests 38.4kb.
 177    spd_cust       Use the custom divisor to set the speed when the
 178                   application requests 38.4kb.
 179    divisor        This option sets the custom division.
 180    baud_base      This option sets the base baud rate.
 181    ============== =============================================================
 182
 183 6. Troubleshooting
 184 ^^^^^^^^^^^^^^^^^^
 185
 186    The boot time error messages and solutions are stated as clearly as
 187    possible. If all the possible solutions fail, please contact our technical
 188    support team to get more help.
 189
 190
 191    Error msg:
 192               More than 4 Moxa Smartio/Industio family boards found. Fifth board
 193               and after are ignored.
 194
 195    Solution:
 196    To avoid this problem, please unplug fifth and after board, because Moxa
 197    driver supports up to 4 boards.