http://downloads.netgear.com/files/GPL/GPL_Source_V361j_DM111PSP_series_consumer_rele...
[bcm963xx.git] / kernel / linux / Documentation / rocket.txt
1 Comtrol(tm) RocketPort(R)/RocketModem(TM) Series 
2 Device Driver for the Linux Operating System
3
4 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
5
6 PRODUCT OVERVIEW
7 ----------------
8
9 This driver provides a loadable kernel driver for the Comtrol RocketPort
10 and RocketModem PCI boards. These boards provide, 2, 4, 8, 16, or 32 
11 high-speed serial ports or modems.  This driver supports up to a combination
12 of four RocketPort or RocketModems boards in one machine simultaneously.
13 This file assumes that you are using the RocketPort driver which is
14 integrated into the kernel sources.  
15
16 The driver can also be installed as an external module using the usual 
17 "make;make install" routine.  This external module driver, obtainable 
18 from the Comtrol website listed below, is useful for updating the driver
19 or installing it into kernels which do not have the driver configured
20 into them.  Installations instructions for the external module
21 are in the included README and HW_INSTALL files.
22
23 RocketPort ISA and RocketModem II PCI boards are also supported by this
24 driver, but must use the external module driver for configuration reasons.  
25
26 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
27
28 INSTALLATION PROCEDURES
29 -----------------------
30
31 RocketPort/RocketModem PCI cards require no driver configuration, they are 
32 automatically detected and configured.
33
34 The RocketPort driver can be installed as a module (recommended) or built 
35 into the kernel. This is selected, as for other drivers, through the `make config`
36 command from the root of the Linux source tree during the kernel build process. 
37
38 The RocketPort/RocketModem serial ports installed by this driver are assigned
39 device major number 46, and will be named /dev/ttyRx, where x is the port number 
40 starting at zero (ex. /dev/ttyR0, /devttyR1, ...).  If you have multiple cards
41 installed in the system, the mapping of port names to serial ports is displayed
42 in the system log at /var/log/messages.
43
44 If installed as a module, the module must be loaded.  This can be done
45 manually by entering "modprobe rocket".  To have the module loaded automatically
46 upon system boot, edit the /etc/modprobe.conf file and add the line
47 "alias char-major-46 rocket".
48
49 In order to use the ports, their device names (nodes) must be created with mknod.
50 This is only required once, the system will retain the names once created.  To 
51 create the RocketPort/RocketModem device names, use the command 
52 "mknod /dev/ttyRx c 46 x" where x is the port number starting at zero.  For example:
53
54 >mknod /dev/ttyR0 c 46 0
55 >mknod /dev/ttyR1 c 46 1
56 >mknod /dev/ttyR2 c 46 2  
57
58 The Linux script MAKEDEV will create the first 16 ttyRx device names (nodes) for you:
59
60 >/dev/MAKEDEV ttyR
61
62 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
63
64 REPORTING BUGS
65 --------------
66
67 For technical support, please provide the following
68 information: Driver version, kernel release, distribution of
69 kernel, and type of board you are using. Error messages and log
70 printouts port configuration details are especially helpful.
71
72 USA
73     Phone: (612) 494-4100
74       FAX: (612) 494-4199
75     email: support@comtrol.com
76
77 Comtrol Europe
78     Phone: +44 (0) 1 869 323-220
79       FAX: +44 (0) 1 869 323-211
80     email: support@comtrol.co.uk
81
82 Web:    http://www.comtrol.com
83 FTP:    ftp.comtrol.com
84
85 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
86
87