aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/serial/rocket.txt
diff options
context:
space:
mode:
authorRandy Dunlap <randy.dunlap@oracle.com>2008-11-13 16:33:24 -0500
committerRandy Dunlap <randy.dunlap@oracle.com>2008-11-14 12:28:53 -0500
commit31c00fc15ebd35c1647775dbfc167a15d46657fd (patch)
tree6d8ff2a6607c94a791ccc56fd8eb625e4fdcc01a /Documentation/serial/rocket.txt
parent3edac25f2e8ac8c2a84904c140e1aeb434e73e75 (diff)
Create/use more directory structure in the Documentation/ tree.
Create Documentation/blockdev/ sub-directory and populate it. Populate the Documentation/serial/ sub-directory. Move MSI-HOWTO.txt to Documentation/PCI/. Move ioctl-number.txt to Documentation/ioctl/. Update all relevant 00-INDEX files. Update all relevant Kconfig files and source files. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Diffstat (limited to 'Documentation/serial/rocket.txt')
-rw-r--r--Documentation/serial/rocket.txt189
1 files changed, 189 insertions, 0 deletions
diff --git a/Documentation/serial/rocket.txt b/Documentation/serial/rocket.txt
new file mode 100644
index 000000000000..1d8582990435
--- /dev/null
+++ b/Documentation/serial/rocket.txt
@@ -0,0 +1,189 @@
1Comtrol(tm) RocketPort(R)/RocketModem(TM) Series
2Device Driver for the Linux Operating System
3
4=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
5
6PRODUCT OVERVIEW
7----------------
8
9This driver provides a loadable kernel driver for the Comtrol RocketPort
10and RocketModem PCI boards. These boards provide, 2, 4, 8, 16, or 32
11high-speed serial ports or modems. This driver supports up to a combination
12of four RocketPort or RocketModems boards in one machine simultaneously.
13This file assumes that you are using the RocketPort driver which is
14integrated into the kernel sources.
15
16The driver can also be installed as an external module using the usual
17"make;make install" routine. This external module driver, obtainable
18from the Comtrol website listed below, is useful for updating the driver
19or installing it into kernels which do not have the driver configured
20into them. Installations instructions for the external module
21are in the included README and HW_INSTALL files.
22
23RocketPort ISA and RocketModem II PCI boards currently are only supported by
24this driver in module form.
25
26The RocketPort ISA board requires I/O ports to be configured by the DIP
27switches on the board. See the section "ISA Rocketport Boards" below for
28information on how to set the DIP switches.
29
30You pass the I/O port to the driver using the following module parameters:
31
32board1 : I/O port for the first ISA board
33board2 : I/O port for the second ISA board
34board3 : I/O port for the third ISA board
35board4 : I/O port for the fourth ISA board
36
37There is a set of utilities and scripts provided with the external driver
38( downloadable from http://www.comtrol.com ) that ease the configuration and
39setup of the ISA cards.
40
41The RocketModem II PCI boards require firmware to be loaded into the card
42before it will function. The driver has only been tested as a module for this
43board.
44
45=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
46
47INSTALLATION PROCEDURES
48-----------------------
49
50RocketPort/RocketModem PCI cards require no driver configuration, they are
51automatically detected and configured.
52
53The RocketPort driver can be installed as a module (recommended) or built
54into the kernel. This is selected, as for other drivers, through the `make config`
55command from the root of the Linux source tree during the kernel build process.
56
57The RocketPort/RocketModem serial ports installed by this driver are assigned
58device major number 46, and will be named /dev/ttyRx, where x is the port number
59starting at zero (ex. /dev/ttyR0, /devttyR1, ...). If you have multiple cards
60installed in the system, the mapping of port names to serial ports is displayed
61in the system log at /var/log/messages.
62
63If installed as a module, the module must be loaded. This can be done
64manually by entering "modprobe rocket". To have the module loaded automatically
65upon system boot, edit the /etc/modprobe.conf file and add the line
66"alias char-major-46 rocket".
67
68In order to use the ports, their device names (nodes) must be created with mknod.
69This is only required once, the system will retain the names once created. To
70create the RocketPort/RocketModem device names, use the command
71"mknod /dev/ttyRx c 46 x" where x is the port number starting at zero. For example:
72
73>mknod /dev/ttyR0 c 46 0
74>mknod /dev/ttyR1 c 46 1
75>mknod /dev/ttyR2 c 46 2
76
77The Linux script MAKEDEV will create the first 16 ttyRx device names (nodes)
78for you:
79
80>/dev/MAKEDEV ttyR
81
82=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
83
84ISA Rocketport Boards
85---------------------
86
87You must assign and configure the I/O addresses used by the ISA Rocketport
88card before installing and using it. This is done by setting a set of DIP
89switches on the Rocketport board.
90
91
92SETTING THE I/O ADDRESS
93-----------------------
94
95Before installing RocketPort(R) or RocketPort RA boards, you must find
96a range of I/O addresses for it to use. The first RocketPort card
97requires a 68-byte contiguous block of I/O addresses, starting at one
98of the following: 0x100h, 0x140h, 0x180h, 0x200h, 0x240h, 0x280h,
990x300h, 0x340h, 0x380h. This I/O address must be reflected in the DIP
100switches of *all* of the Rocketport cards.
101
102The second, third, and fourth RocketPort cards require a 64-byte
103contiguous block of I/O addresses, starting at one of the following
104I/O addresses: 0x100h, 0x140h, 0x180h, 0x1C0h, 0x200h, 0x240h, 0x280h,
1050x2C0h, 0x300h, 0x340h, 0x380h, 0x3C0h. The I/O address used by the
106second, third, and fourth Rocketport cards (if present) are set via
107software control. The DIP switch settings for the I/O address must be
108set to the value of the first Rocketport cards.
109
110In order to distinguish each of the card from the others, each card
111must have a unique board ID set on the dip switches. The first
112Rocketport board must be set with the DIP switches corresponding to
113the first board, the second board must be set with the DIP switches
114corresponding to the second board, etc. IMPORTANT: The board ID is
115the only place where the DIP switch settings should differ between the
116various Rocketport boards in a system.
117
118The I/O address range used by any of the RocketPort cards must not
119conflict with any other cards in the system, including other
120RocketPort cards. Below, you will find a list of commonly used I/O
121address ranges which may be in use by other devices in your system.
122On a Linux system, "cat /proc/ioports" will also be helpful in
123identifying what I/O addresses are being used by devices on your
124system.
125
126Remember, the FIRST RocketPort uses 68 I/O addresses. So, if you set it
127for 0x100, it will occupy 0x100 to 0x143. This would mean that you
128CAN NOT set the second, third or fourth board for address 0x140 since
129the first 4 bytes of that range are used by the first board. You would
130need to set the second, third, or fourth board to one of the next available
131blocks such as 0x180.
132
133=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
134
135RocketPort and RocketPort RA SW1 Settings:
136
137 +-------------------------------+
138 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
139 +-------+-------+---------------+
140 | Unused| Card | I/O Port Block|
141 +-------------------------------+
142
143DIP Switches DIP Switches
1447 8 6 5
145=================== ===================
146On On UNUSED, MUST BE ON. On On First Card <==== Default
147 On Off Second Card
148 Off On Third Card
149 Off Off Fourth Card
150
151DIP Switches I/O Address Range
1524 3 2 1 Used by the First Card
153=====================================
154On Off On Off 100-143
155On Off Off On 140-183
156On Off Off Off 180-1C3 <==== Default
157Off On On Off 200-243
158Off On Off On 240-283
159Off On Off Off 280-2C3
160Off Off On Off 300-343
161Off Off Off On 340-383
162Off Off Off Off 380-3C3
163
164=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
165
166REPORTING BUGS
167--------------
168
169For technical support, please provide the following
170information: Driver version, kernel release, distribution of
171kernel, and type of board you are using. Error messages and log
172printouts port configuration details are especially helpful.
173
174USA
175 Phone: (612) 494-4100
176 FAX: (612) 494-4199
177 email: support@comtrol.com
178
179Comtrol Europe
180 Phone: +44 (0) 1 869 323-220
181 FAX: +44 (0) 1 869 323-211
182 email: support@comtrol.co.uk
183
184Web: http://www.comtrol.com
185FTP: ftp.comtrol.com
186
187=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
188
189