computone.txt 17 KB

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