ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / Documentation / computone.txt
1
2 Computone Intelliport II/Plus Multiport Serial Driver
3 -----------------------------------------------------
4
5 Release Notes For Linux Kernel 2.2 and higher.
6 These notes are for the drivers which have already been integrated into the
7 kernel and have been tested on Linux kernels 2.0, 2.2, 2.3, and 2.4.
8
9 Version: 1.2.14
10 Date: 11/01/2001
11 Historical Author: Andrew Manison <amanison@america.net>
12 Primary Author: Doug McNash
13 Support: support@computone.com
14 Fixes and Updates: Mike Warfield <mhw@wittsend.com>
15
16 This file assumes that you are using the Computone drivers which are
17 integrated into the kernel sources.  For updating the drivers or installing
18 drivers into kernels which do not already have Computone drivers, please
19 refer to the instructions in the README.computone file in the driver patch.
20
21
22 1. INTRODUCTION
23
24 This driver supports the entire family of Intelliport II/Plus controllers
25 with the exception of the MicroChannel controllers.  It does not support
26 products previous to the Intelliport II.
27
28 This driver was developed on the v2.0.x Linux tree and has been tested up
29 to v2.4.14; it will probably not work with earlier v1.X kernels,.
30
31
32 2. QUICK INSTALLATION
33
34 Hardware - If you have an ISA card, find a free interrupt and io port. 
35                    List those in use with `cat /proc/interrupts` and 
36                    `cat /proc/ioports`.  Set the card dip switches to a free 
37                    address.  You may need to configure your BIOS to reserve an
38                    irq for an ISA card.  PCI and EISA parameters are set
39                    automagically.  Insert card into computer with the power off 
40                    before or after drivers installation.
41
42         Note the hardware address from the Computone ISA cards installed into
43                 the system.  These are required for editing ip2.c or editing
44                 /etc/modprobe.conf, or for specification on the modprobe
45                 command line.
46
47         Note that the /etc/modules.conf should be used for older (pre-2.6)
48                 kernels.
49
50 Software -
51
52 Module installation:
53
54 a) Determine free irq/address to use if any (configure BIOS if need be)
55 b) Run "make config" or "make menuconfig" or "make xconfig"
56    Select (m) module for CONFIG_COMPUTONE under character
57    devices.  CONFIG_PCI and CONFIG_MODULES also may need to be set.
58 c) Set address on ISA cards then:
59    edit /usr/src/linux/drivers/char/ip2.c if needed 
60         or
61    edit /etc/modprobe.conf if needed (module).
62         or both to match this setting.
63 d) Run "make modules"
64 e) Run "make modules_install"
65 f) Run "/sbin/depmod -a"
66 g) install driver using `modprobe ip2 <options>` (options listed below)
67 h) run ip2mkdev (either the script below or the binary version)
68
69
70 Kernel installation:
71
72 a) Determine free irq/address to use if any (configure BIOS if need be)
73 b) Run "make config" or "make menuconfig" or "make xconfig"
74    Select (y) kernel for CONFIG_COMPUTONE under character
75    devices.  CONFIG_PCI may need to be set if you have PCI bus.
76 c) Set address on ISA cards then:
77            edit /usr/src/linux/drivers/char/ip2.c  
78            (Optional - may be specified on kernel command line now)
79 d) Run "make zImage" or whatever target you prefer.
80 e) mv /usr/src/linux/arch/i386/boot/zImage to /boot.
81 f) Add new config for this kernel into /etc/lilo.conf, run "lilo"
82         or copy to a floppy disk and boot from that floppy disk.
83 g) Reboot using this kernel
84 h) run ip2mkdev (either the script below or the binary version)
85
86 Kernel command line options:
87
88 When compiling the driver into the kernel, io and irq may be
89 compiled into the driver by editing ip2.c and setting the values for
90 io and irq in the appropriate array.  An alternative is to specify
91 a command line parameter to the kernel at boot up.
92
93         ip2=io0,irq0,io1,irq1,io2,irq2,io3,irq3
94
95 Note that this order is very different from the specifications for the
96 modload parameters which have separate IRQ and IO specifiers.
97
98 The io port also selects PCI (1) and EISA (2) boards.
99
100         io=0    No board
101         io=1    PCI board
102         io=2    EISA board
103         else    ISA board io address
104
105 You only need to specify the boards which are present.
106
107         Examples:
108
109                 2 PCI boards:
110
111                         ip2=1,0,1,0
112
113                 1 ISA board at 0x310 irq 5:
114
115                         ip2=0x310,5
116
117 This can be added to and "append" option in lilo.conf similar to this:
118
119         append="ip2=1,0,1,0"
120
121
122 3. INSTALLATION
123
124 Previously, the driver sources were packaged with a set of patch files
125 to update the character drivers' makefile and configuration file, and other 
126 kernel source files. A build script (ip2build) was included which applies 
127 the patches if needed, and build any utilities needed.
128 What you receive may be a single patch file in conventional kernel
129 patch format build script. That form can also be applied by
130 running patch -p1 < ThePatchFile.  Otherwise run ip2build.
131  
132 The driver can be installed as a module (recommended) or built into the 
133 kernel. This is selected as for other drivers through the `make config`
134 command from the root of the Linux source tree. If the driver is built 
135 into the kernel you will need to edit the file ip2.c to match the boards 
136 you are installing. See that file for instructions. If the driver is 
137 installed as a module the configuration can also be specified on the
138 modprobe command line as follows:
139
140         modprobe ip2 irq=irq1,irq2,irq3,irq4 io=addr1,addr2,addr3,addr4
141
142 where irqnum is one of the valid Intelliport II interrupts (3,4,5,7,10,11,
143 12,15) and addr1-4 are the base addresses for up to four controllers. If 
144 the irqs are not specified the driver uses the default in ip2.c (which 
145 selects polled mode). If no base addresses are specified the defaults in 
146 ip2.c are used. If you are autoloading the driver module with kerneld or
147 kmod the base addresses and interrupt number must also be set in ip2.c
148 and recompile or just insert and options line in /etc/modprobe.conf or both.
149 The options line is equivalent to the command line and takes precidence over 
150 what is in ip2.c. 
151
152 /etc/modprobe.conf sample:
153         options ip2 io=1,0x328 irq=1,10
154         alias char-major-71 ip2
155         alias char-major-72 ip2
156         alias char-major-73 ip2
157
158 The equivalent in ip2.c:
159
160 static int io[IP2_MAX_BOARDS]= { 1, 0x328, 0, 0 };
161 static int irq[IP2_MAX_BOARDS] = { 1, 10, -1, -1 }; 
162
163 The equivalent for the kernel command line (in lilo.conf):
164
165         append="ip2=1,1,0x328,10"
166
167
168 Note:   Both io and irq should be updated to reflect YOUR system.  An "io"
169         address of 1 or 2 indicates a PCI or EISA card in the board table.              The PCI or EISA irq will be assigned automatically.
170
171 Specifying an invalid or in-use irq will default the driver into
172 running in polled mode for that card.  If all irq entries are 0 then
173 all cards will operate in polled mode.
174
175 If you select the driver as part of the kernel run :
176
177         make zlilo (or whatever you do to create a bootable kernel)
178
179 If you selected a module run :
180
181         make modules && make modules_install
182
183 The utility ip2mkdev (see 5 and 7 below) creates all the device nodes
184 required by the driver.  For a device to be created it must be configured
185 in the driver and the board must be installed. Only devices corresponding
186 to real IntelliPort II ports are created. With multiple boards and expansion
187 boxes this will leave gaps in the sequence of device names. ip2mkdev uses
188 Linux tty naming conventions: ttyF0 - ttyF255 for normal devices, and
189 cuf0 - cuf255 for callout devices.
190
191 If you are using devfs, existing devices are automatically created within
192 the devfs name space.  Normal devices will be tts/F0 - tts/F255 and callout
193 devices will be cua/F0 - cua/F255.  With devfs installed, ip2mkdev will
194 create symbolic links in /dev from the old conventional names to the newer
195 devfs names as follows:
196
197         /dev/ip2ipl[n]  -> /dev/ip2/ipl[n]      n = 0 - 3
198         /dev/ip2stat[n] -> /dev/ip2/stat[n]     n = 0 - 3
199         /dev/ttyF[n]    -> /dev/tts/F[n]        n = 0 - 255
200         /dev/cuf[n]     -> /dev/cua/F[n]        n = 0 - 255
201
202 Only devices for existing ports and boards will be created.
203
204 IMPORTANT NOTE:  The naming convention used for devfs by this driver
205 was changed from 1.2.12 to 1.2.13.  The old naming convention was to
206 use ttf/%d for the tty device and cuf/%d for the cua device.  That
207 has been changed to conform to an agreed-upon standard of placing
208 all the tty devices under tts.  The device names are now tts/F%d for
209 the tty device and cua/F%d for the cua devices.  If you were using
210 the older devfs names, you must update for the newer convention.
211
212 You do not need to run ip2mkdev if you are using devfs and only want to
213 use the devfs native device names.
214
215
216 4. USING THE DRIVERS
217
218 As noted above, the driver implements the ports in accordance with Linux
219 conventions, and the devices should be interchangeable with the standard
220 serial devices. (This is a key point for problem reporting: please make
221 sure that what you are trying do works on the ttySx/cuax ports first; then 
222 tell us what went wrong with the ip2 ports!)
223
224 Higher speeds can be obtained using the setserial utility which remaps 
225 38,400 bps (extb) to 57,600 bps, 115,200 bps, or a custom speed. 
226 Intelliport II installations using the PowerPort expansion module can
227 use the custom speed setting to select the highest speeds: 153,600 bps,
228 230,400 bps, 307,200 bps, 460,800bps and 921,600 bps. The base for
229 custom baud rate configuration is fixed at 921,600 for cards/expansion
230 modules with ST654's and 115200 for those with Cirrus CD1400's.  This
231 corresponds to the maximum bit rates those chips are capable.  
232 For example if the baud base is 921600 and the baud divisor is 18 then
233 the custom rate is 921600/18 = 51200 bps.  See the setserial man page for
234 complete details. Of course if stty accepts the higher rates now you can
235 use that as well as the standard ioctls().
236
237
238 5. ip2mkdev and assorted utilities...
239
240 Several utilities, including the source for a binary ip2mkdev utility are
241 available under .../drivers/char/ip2.  These can be build by changing to
242 that directory and typing "make" after the kernel has be built.  If you do
243 not wish to compile the binary utilities, the shell script below can be
244 cut out and run as "ip2mkdev" to create the necessary device files.  To
245 use the ip2mkdev script, you must have procfs enabled and the proc file
246 system mounted on /proc.
247
248 You do not need to run ip2mkdev if you are using devfs and only want to
249 use the devfs native device names.
250
251
252 6. DEVFS
253
254 DEVFS is the DEVice File System available as an add on package for the
255 2.2.x kernels and available as a configuration option in 2.3.46 and higher.
256 Devfs allows for the automatic creation and management of device names
257 under control of the device drivers themselves.  The Devfs namespace is
258 hierarchical and reduces the clutter present in the normal flat /dev
259 namespace.  Devfs names and conventional device names may be intermixed.
260 A userspace daemon, devfsd, exists to allow for automatic creation and
261 management of symbolic links from the devfs name space to the conventional
262 names.  More details on devfs can be found on the DEVFS home site at
263 <http://www.atnf.csiro.au/~rgooch/linux/> or in the file kernel
264 documentation files, .../linux/Documentation/filesystems/devfs/README.
265
266 If you are using devfs, existing devices are automatically created within
267 the devfs name space.  Normal devices will be tts/F0 - tts/F255 and callout
268 devices will be cua/F0 - cua/F255.  With devfs installed, ip2mkdev will
269 create symbolic links in /dev from the old conventional names to the newer
270 devfs names as follows:
271
272         /dev/ip2ipl[n]  -> /dev/ip2/ipl[n]      n = 0 - 3
273         /dev/ip2stat[n] -> /dev/ip2/stat[n]     n = 0 - 3
274         /dev/ttyF[n]    -> /dev/tts/F[n]        n = 0 - 255
275         /dev/cuf[n]     -> /dev/cua/F[n]        n = 0 - 255
276
277 Only devices for existing ports and boards will be created.
278
279 IMPORTANT NOTE:  The naming convention used for devfs by this driver
280 was changed from 1.2.12 to 1.2.13.  The old naming convention was to
281 use ttf/%d for the tty device and cuf/%d for the cua device.  That
282 has been changed to conform to an agreed-upon standard of placing
283 all the tty devices under tts.  The device names are now tts/F%d for
284 the tty device and cua/F%d for the cua devices.  If you were using
285 the older devfs names, you must update for the newer convention.
286
287 You do not need to run ip2mkdev if you are using devfs and only want to
288 use the devfs native device names.
289  
290
291 7. NOTES
292
293 This is a release version of the driver, but it is impossible to test it
294 in all configurations of Linux. If there is any anomalous behaviour that 
295 does not match the standard serial port's behaviour please let us know.
296
297
298 8. ip2mkdev shell script
299
300 Previously, this script was simply attached here.  It is now attached as a
301 shar archive to make it easier to extract the script from the documentation.
302 To create the ip2mkdev shell script change to a convenient directory (/tmp
303 works just fine) and run the following command:
304
305         unshar /usr/src/linux/Documentation/computone.txt
306                 (This file)
307
308 You should now have a file ip2mkdev in your current working directory with
309 permissions set to execute.  Running that script with then create the
310 necessary devices for the Computone boards, interfaces, and ports which
311 are present on you system at the time it is run.
312
313
314 #!/bin/sh
315 # This is a shell archive (produced by GNU sharutils 4.2.1).
316 # To extract the files from this archive, save it to some FILE, remove
317 # everything before the `!/bin/sh' line above, then type `sh FILE'.
318 #
319 # Made on 2001-10-29 10:32 EST by <mhw@alcove.wittsend.com>.
320 # Source directory was `/home2/src/tmp'.
321 #
322 # Existing files will *not* be overwritten unless `-c' is specified.
323 #
324 # This shar contains:
325 # length mode       name
326 # ------ ---------- ------------------------------------------
327 #   4251 -rwxr-xr-x ip2mkdev
328 #
329 save_IFS="${IFS}"
330 IFS="${IFS}:"
331 gettext_dir=FAILED
332 locale_dir=FAILED
333 first_param="$1"
334 for dir in $PATH
335 do
336   if test "$gettext_dir" = FAILED && test -f $dir/gettext \
337      && ($dir/gettext --version >/dev/null 2>&1)
338   then
339     set `$dir/gettext --version 2>&1`
340     if test "$3" = GNU
341     then
342       gettext_dir=$dir
343     fi
344   fi
345   if test "$locale_dir" = FAILED && test -f $dir/shar \
346      && ($dir/shar --print-text-domain-dir >/dev/null 2>&1)
347   then
348     locale_dir=`$dir/shar --print-text-domain-dir`
349   fi
350 done
351 IFS="$save_IFS"
352 if test "$locale_dir" = FAILED || test "$gettext_dir" = FAILED
353 then
354   echo=echo
355 else
356   TEXTDOMAINDIR=$locale_dir
357   export TEXTDOMAINDIR
358   TEXTDOMAIN=sharutils
359   export TEXTDOMAIN
360   echo="$gettext_dir/gettext -s"
361 fi
362 if touch -am -t 200112312359.59 $$.touch >/dev/null 2>&1 && test ! -f 200112312359.59 -a -f $$.touch; then
363   shar_touch='touch -am -t $1$2$3$4$5$6.$7 "$8"'
364 elif touch -am 123123592001.59 $$.touch >/dev/null 2>&1 && test ! -f 123123592001.59 -a ! -f 123123592001.5 -a -f $$.touch; then
365   shar_touch='touch -am $3$4$5$6$1$2.$7 "$8"'
366 elif touch -am 1231235901 $$.touch >/dev/null 2>&1 && test ! -f 1231235901 -a -f $$.touch; then
367   shar_touch='touch -am $3$4$5$6$2 "$8"'
368 else
369   shar_touch=:
370   echo
371   $echo 'WARNING: not restoring timestamps.  Consider getting and'
372   $echo "installing GNU \`touch', distributed in GNU File Utilities..."
373   echo
374 fi
375 rm -f 200112312359.59 123123592001.59 123123592001.5 1231235901 $$.touch
376 #
377 if mkdir _sh17581; then
378   $echo 'x -' 'creating lock directory'
379 else
380   $echo 'failed to create lock directory'
381   exit 1
382 fi
383 # ============= ip2mkdev ==============
384 if test -f 'ip2mkdev' && test "$first_param" != -c; then
385   $echo 'x -' SKIPPING 'ip2mkdev' '(file already exists)'
386 else
387   $echo 'x -' extracting 'ip2mkdev' '(text)'
388   sed 's/^X//' << 'SHAR_EOF' > 'ip2mkdev' &&
389 #!/bin/sh -
390 #
391 #       ip2mkdev
392 #
393 #       Make or remove devices as needed for Computone Intelliport drivers
394 #
395 #       First rule!  If the dev file exists and you need it, don't mess
396 #       with it.  That prevents us from screwing up open ttys, ownership
397 #       and permissions on a running system!
398 #
399 #       This script will NOT remove devices that no longer exist if their
400 #       board or interface box has been removed.  If you want to get rid
401 #       of them, you can manually do an "rm -f /dev/ttyF* /dev/cuaf*"
402 #       before running this script.  Running this script will then recreate
403 #       all the valid devices.
404 #
405 #       Michael H. Warfield
406 #       /\/\|=mhw=|\/\/
407 #       mhw@wittsend.com
408 #
409 #       Updated 10/29/2000 for version 1.2.13 naming convention
410 #               under devfs.    /\/\|=mhw=|\/\/
411 #
412 #       Updated 03/09/2000 for devfs support in ip2 drivers. /\/\|=mhw=|\/\/
413 #
414 X
415 if test -d /dev/ip2 ; then
416 #       This is devfs mode...  We don't do anything except create symlinks
417 #       from the real devices to the old names!
418 X       cd /dev
419 X       echo "Creating symbolic links to devfs devices"
420 X       for i in `ls ip2` ; do
421 X               if test ! -L ip2$i ; then
422 X                       # Remove it incase it wasn't a symlink (old device)
423 X                       rm -f ip2$i
424 X                       ln -s ip2/$i ip2$i
425 X               fi
426 X       done
427 X       for i in `( cd tts ; ls F* )` ; do
428 X               if test ! -L tty$i ; then
429 X                       # Remove it incase it wasn't a symlink (old device)
430 X                       rm -f tty$i
431 X                       ln -s tts/$i tty$i
432 X               fi
433 X       done
434 X       for i in `( cd cua ; ls F* )` ; do
435 X               DEVNUMBER=`expr $i : 'F\(.*\)'`
436 X               if test ! -L cuf$DEVNUMBER ; then
437 X                       # Remove it incase it wasn't a symlink (old device)
438 X                       rm -f cuf$DEVNUMBER
439 X                       ln -s cua/$i cuf$DEVNUMBER
440 X               fi
441 X       done
442 X       exit 0
443 fi
444 X
445 if test ! -f /proc/tty/drivers
446 then
447 X       echo "\
448 Unable to check driver status.
449 Make sure proc file system is mounted."
450 X
451 X       exit 255
452 fi
453 X
454 if test ! -f /proc/tty/driver/ip2
455 then
456 X       echo "\
457 Unable to locate ip2 proc file.
458 Attempting to load driver"
459 X
460 X       if /sbin/insmod ip2
461 X       then
462 X               if test ! -f /proc/tty/driver/ip2
463 X               then
464 X                       echo "\
465 Unable to locate ip2 proc file after loading driver.
466 Driver initialization failure or driver version error.
467 "
468 X               exit 255
469 X               fi
470 X       else
471 X               echo "Unable to load ip2 driver."
472 X               exit 255
473 X       fi
474 fi
475 X
476 # Ok...  So we got the driver loaded and we can locate the procfs files.
477 # Next we need our major numbers.
478 X
479 TTYMAJOR=`sed -e '/^ip2/!d' -e '/\/dev\/tt/!d' -e 's/.*tt[^     ]*[     ]*\([0-9]*\)[   ]*.*/\1/' < /proc/tty/drivers`
480 CUAMAJOR=`sed -e '/^ip2/!d' -e '/\/dev\/cu/!d' -e 's/.*cu[^     ]*[     ]*\([0-9]*\)[   ]*.*/\1/' < /proc/tty/drivers`
481 BRDMAJOR=`sed -e '/^Driver: /!d' -e 's/.*IMajor=\([0-9]*\)[     ]*.*/\1/' < /proc/tty/driver/ip2`
482 X
483 echo "\
484 TTYMAJOR = $TTYMAJOR
485 CUAMAJOR = $CUAMAJOR
486 BRDMAJOR = $BRDMAJOR
487 "
488 X
489 # Ok...  Now we should know our major numbers, if appropriate...
490 # Now we need our boards and start the device loops.
491 X
492 grep '^Board [0-9]:' /proc/tty/driver/ip2 | while read token number type alltherest
493 do
494 X       # The test for blank "type" will catch the stats lead-in lines
495 X       # if they exist in the file
496 X       if test "$type" = "vacant" -o "$type" = "Vacant" -o "$type" = ""
497 X       then
498 X               continue
499 X       fi
500 X
501 X       BOARDNO=`expr "$number" : '\([0-9]\):'`
502 X       PORTS=`expr "$alltherest" : '.*ports=\([0-9]*\)' | tr ',' ' '`
503 X       MINORS=`expr "$alltherest" : '.*minors=\([0-9,]*\)' | tr ',' ' '`
504 X
505 X       if test "$BOARDNO" = "" -o "$PORTS" = ""
506 X       then
507 #       This may be a bug.  We should at least get this much information
508 X               echo "Unable to process board line"
509 X               continue
510 X       fi
511 X
512 X       if test "$MINORS" = ""
513 X       then
514 #       Silently skip this one.  This board seems to have no boxes
515 X               continue
516 X       fi
517 X
518 X       echo "board $BOARDNO: $type ports = $PORTS; port numbers = $MINORS"
519 X
520 X       if test "$BRDMAJOR" != ""
521 X       then
522 X               BRDMINOR=`expr $BOARDNO \* 4`
523 X               STSMINOR=`expr $BRDMINOR + 1`
524 X               if test ! -c /dev/ip2ipl$BOARDNO ; then
525 X                       mknod /dev/ip2ipl$BOARDNO c $BRDMAJOR $BRDMINOR
526 X               fi
527 X               if test ! -c /dev/ip2stat$BOARDNO ; then
528 X                       mknod /dev/ip2stat$BOARDNO c $BRDMAJOR $STSMINOR
529 X               fi
530 X       fi
531 X
532 X       if test "$TTYMAJOR" != ""
533 X       then
534 X               PORTNO=$BOARDBASE
535 X
536 X               for PORTNO in $MINORS
537 X               do
538 X                       if test ! -c /dev/ttyF$PORTNO ; then
539 X                               # We got the hardware but no device - make it
540 X                               mknod /dev/ttyF$PORTNO c $TTYMAJOR $PORTNO
541 X                       fi      
542 X               done
543 X       fi
544 X
545 X       if test "$CUAMAJOR" != ""
546 X       then
547 X               PORTNO=$BOARDBASE
548 X
549 X               for PORTNO in $MINORS
550 X               do
551 X                       if test ! -c /dev/cuf$PORTNO ; then
552 X                               # We got the hardware but no device - make it
553 X                               mknod /dev/cuf$PORTNO c $CUAMAJOR $PORTNO
554 X                       fi      
555 X               done
556 X       fi
557 done
558 X
559 Xexit 0
560 SHAR_EOF
561   (set 20 01 10 29 10 32 01 'ip2mkdev'; eval "$shar_touch") &&
562   chmod 0755 'ip2mkdev' ||
563   $echo 'restore of' 'ip2mkdev' 'failed'
564   if ( md5sum --help 2>&1 | grep 'sage: md5sum \[' ) >/dev/null 2>&1 \
565   && ( md5sum --version 2>&1 | grep -v 'textutils 1.12' ) >/dev/null; then
566     md5sum -c << SHAR_EOF >/dev/null 2>&1 \
567     || $echo 'ip2mkdev:' 'MD5 check failed'
568 cb5717134509f38bad9fde6b1f79b4a4  ip2mkdev
569 SHAR_EOF
570   else
571     shar_count="`LC_ALL= LC_CTYPE= LANG= wc -c < 'ip2mkdev'`"
572     test 4251 -eq "$shar_count" ||
573     $echo 'ip2mkdev:' 'original size' '4251,' 'current size' "$shar_count!"
574   fi
575 fi
576 rm -fr _sh17581
577 exit 0