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