linux/Documentation/serial/specialix.txt
<<
>>
Prefs
   1
   2      specialix.txt  -- specialix IO8+ multiport serial driver readme.
   3
   4
   5
   6      Copyright (C) 1997  Roger Wolff (R.E.Wolff@BitWizard.nl)
   7
   8      Specialix pays for the development and support of this driver.
   9      Please DO contact io8-linux@specialix.co.uk if you require
  10      support.
  11
  12      This driver was developed in the BitWizard linux device
  13      driver service. If you require a linux device driver for your
  14      product, please contact devices@BitWizard.nl for a quote.
  15
  16      This code is firmly based on the riscom/8 serial driver,
  17      written by Dmitry Gorodchanin. The specialix IO8+ card
  18      programming information was obtained from the CL-CD1865 Data
  19      Book, and Specialix document number 6200059: IO8+ Hardware
  20      Functional Specification, augmented by document number 6200088:
  21      Merak Hardware Functional Specification. (IO8+/PCI is also 
  22      called Merak)
  23
  24
  25      This program is free software; you can redistribute it and/or
  26      modify it under the terms of the GNU General Public License as
  27      published by the Free Software Foundation; either version 2 of
  28      the License, or (at your option) any later version.
  29
  30      This program is distributed in the hope that it will be
  31      useful, but WITHOUT ANY WARRANTY; without even the implied
  32      warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  33      PURPOSE.  See the GNU General Public License for more details.
  34
  35      You should have received a copy of the GNU General Public
  36      License along with this program; if not, write to the Free
  37      Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  38      USA.
  39
  40
  41Intro
  42=====
  43
  44 
  45This file contains some random information, that I like to have online
  46instead of in a manual that can get lost. Ever misplace your Linux
  47kernel sources?  And the manual of one of the boards in your computer?
  48
  49
  50Addresses and interrupts
  51========================
  52
  53Address dip switch settings:
  54The dip switch sets bits 2-9 of the IO address. 
  55
  56       9 8 7 6 5 4 3 2 
  57     +-----------------+
  58   0 | X   X X X X X X |
  59     |                 |    =   IoBase = 0x100 
  60   1 |   X             |
  61     +-----------------+          ------ RS232 connectors ---->
  62         
  63         |    |    |
  64       edge connector
  65         |    |    |
  66         V    V    V
  67
  68Base address 0x100 caused a conflict in one of my computers once.  I
  69haven't the foggiest why. My Specialix card is now at 0x180.  My
  70other computer runs just fine with the Specialix card at 0x100....
  71The card occupies 4 addresses, but actually only two are really used.
  72
  73The PCI version doesn't have any dip switches. The BIOS assigns
  74an IO address. 
  75
  76The driver now still autoprobes at 0x100, 0x180, 0x250 and 0x260.  If
  77that causes trouble for you, please report that. I'll remove
  78autoprobing then.
  79
  80The driver will tell the card what IRQ to use, so you don't have to
  81change any jumpers to change the IRQ. Just use a command line
  82argument (irq=xx) to the insmod program to set the interrupt.
  83
  84The BIOS assigns the IRQ on the PCI version. You have no say in what
  85IRQ to use in that case. 
  86
  87If your specialix cards are not at the default locations, you can use
  88the kernel command line argument "specialix=io0,irq0,io1,irq1...".
  89Here "io0" is the io address for the first card, and "irq0" is the
  90irq line that the first card should use. And so on. 
  91
  92Examples. 
  93
  94You use the driver as a module and have three cards at 0x100, 0x250
  95and 0x180. And some way or another you want them detected in that
  96order. Moreover irq 12 is taken (e.g. by your PS/2 mouse).
  97
  98  insmod specialix.o iobase=0x100,0x250,0x180 irq=9,11,15
  99
 100The same three cards, but now in the kernel would require you to
 101add 
 102
 103   specialix=0x100,9,0x250,11,0x180,15
 104
 105to the command line. This would become 
 106
 107   append="specialix=0x100,9,0x250,11,0x180,15" 
 108
 109in your /etc/lilo.conf file if you use lilo. 
 110
 111The Specialix driver is slightly odd: It allows you to have the second
 112or third card detected without having a first card. This has
 113advantages and disadvantages. A slot that isn't filled by an ISA card,
 114might be filled if a PCI card is detected. Thut if you have anuCmmmmmmmmm-ine" name="L9">   9      Please DO contact io8-linux@  9    L82"2r06" id="L6" class="n3ulled if a ocatioe. Thigetsettings:
 106
sx0:nin. The specialBocialix card ards fftwa support.
sx1:nin. The specialBocialix car8 ards fftwa support.
sx2:nin. The special of tird card d6" class,igns 12,  the CLRev. B support.
sx3:nin. The specialBocialix ca26 ards fftwa support.
sx0:nin. The special of tird card d6" cld80s,igns 9,  the CLRev. B support.
 102
  45ed. Thut so you dogi#39;t hill a hints(irq=xx)of thisse lilo. 
ervice.w  You/serifysettings:
  15
  2d="spec100,9,  15
  97
ice you higeten'dd: houtmessisadsettings:
  29
sx0:nin. The special of tird card d6" class,igns 11,  the CLRev. B support.
sx1:nin. The special of tird card d6" cld80s,igns 9,  the CLRev. B support.
 102
d byautoO8+/borrd d6fty it un4an IOvice.gif yO8+exhausrd rst c 102
 IRQ on ecialix cardrd card d6s to have th a first eed by an lix car 102
/PCI forcd dirqgns11at 0x100....
 106
  97
  ud rate This has
==================
  40
 111rev 1.2="n3ubed: e of theQ. Jusrom the 4rst ect, hipsons, ctual  40
do 64kbitrst eerev 1.3="n3unewy i of theQ. Jusrom the 5rst ect, hips  40
x caoffirialualcapases of2"2rk20x100....
 104
   with the Special>thata 25MHz crystal (but imhat wover e, which in 104
f DO cata divid publiswover e)rst carix cat enoughdirqreacfine wratec 102
"2rk2 thealu leass are notThimh. W along wiclockwratecations, ctua 102
do 37 yo7; support raterst carmeaOS asas are"2rk2 thealu leass atio8+ Hardware
goautopo cant, har DOany (  71irq lim;t hinco proHardware
ch seare n wiclockwrate.) (Yelocatio drio use iorrcarly:e nor yO8+1865 Data
limit(irq=xx)ocumentsup-=ch s=- p    de th rq line t.ed Merak)
  52
ervice.nea it un0x180,limit0x180,1ice.wdrivaving start progr Jusgr D      52
degr are FoQ to use t 71
 imha. Howe>The daloa cf="GNU clockw n wisd: ocations, /PCI geteit(ir  52
misshinco pro, har DOanyrst eeThe drivprievel/a> nhoutmessisa when 104
atio8+  outsid it unoffirialnin. yrst eemessisadl>t but ash: eup in 104
  88lo.co/var/log/messisadl a quote.
  29
 100IRQ t, Thut if   29
pront20x180,extensi#39te itch0x180,1(* (irq>Th     fstribs, but aworke details.
  52
When20x180,mgetty0x180,1>to unl Spadl dalomyver em are"2rk2 it, pleasdsettings:
got: +++[0d]ATQ0V1H0[0d][0d][8a]O[cb][0d][8a]ettings:
  65                    ^^^^ ^^^^    ^^^^ ettings:
 106
 100he samehar DOany  use  you to h0x180,^^^0x180,1dify it um  you suffor d+1865 Data
ch  errortributed ighhe fbitrsIncausclu PCI:rt that#39te i be trst cafftwa865 Data
he hope sven y DOESN thatTawork Licenr se /PCI su/serto use t carix /PCI865 Data
s 0x100blishedb ud rate behouter rurequtt.coch  ted suppunthat case. 
  11
Ieupgr aeces?  crystal irq66Mhz thelict in onith the SpeciayrsWorke  11
g drt! Cplease ms trouor more  (Voids/a>      ,el wouldata 46
  dense fsucfildatriware sat 0ed Merak)
  75
 106
(* (Cirrus cagic  the 4 areab>    pisa 40 details.
 108
  79
Caseso address ith the Specia  79
  51=============================
  52
  73pinted supphe-- RS232 conthe IRQecialidsettings:
 104
  65  65    ="li 104
  57Pin 1 57DCDa>    se;">







Drea C>  iy iDd car 104
  57Pin 2 57RXDa>    se;">







Rd have 104
  57Pin 3


DTR/RTS  ted;">






Drea Termi FunR
  57Pin 4 57GNDa>    -  65    Grftwa865 Data
  57Pin 5 57TXDa>    ted;">






TraOSm  865 Data
  57Pin 6 57CTS      se;">







Clea iTo Sen3  11
  63  11
  64  11
  65     -- 6 55 54 53

2 60<--  11
  65         |          |    |    |
  65         |          |    |    |
  65         |          |    |    |
  65         |          |    |    |
  65       5    <-------------+
  65    <   |  __________   |    |
  65    <   |     clip  |    |
 10 is also 
  64Frple view supan RJ12-- RS232 c. Cases 39;lsard, andnto0x180,1 IRQpaphis driver.
  65( IRQplutoO8+rmtedlong wiwayt 0ed Merak)
 106
 10 is also 
  65NULL cases se  so you dokcardwhooO8+goautopo You/a>exceps ffit and/or
  65te itch purpo4 addressI9te i bell tell sse along wicases s(It is also 
  10took qu nota whilat I figu+  outQ to t thatm cat goautopo deld cis also 
  65itrsSoe nor ! :-ed Merak)
  12d Merak)
 10 is also 
  14t caren3 golsaaaaaaaaaaaaaaat caren3 needicense as
  65stra114
  16RJ12-plut.    <   |     ll twirauts driver.
  17  65157DCDa>     whit tttttttttt-  11
  65-  65    >-  65    >17DCD  11
  65257RXDa>     black5    >57TXD  11
  653

DTR/RTS   you 65    >67CTS  11
  65457GNDa>     green5    >47GND  11
  63557TXDa>     yedd:     >27RXD  11
  64
  25  11
 106
  27S/a>TNULL casesee cards, sorrd dthe IRQave th aolumr version.
 version.
  65157DCDa>     whit tttttttttt-  11
  65-  65    >-  65    >17DCD  11
  63557TXDa>     yedd:     >27RXD  11
  64
  65457GNDa>     green5    >47GND  11
  65257RXDa>     black5    >57TXD  11
  653

DTR/RTS   you 65    >67CTS  11
  36  11
 10 is also 
  38is also 
  14t caridriver em cases   65RJ12------------------------DB25-----------DB96200088:
  651577DCDa>    whit tttttttttt87DCDa>       >17DCD  11
  652577RXDa>    black5    >37RXDa>       >27RXD  11
  653


DTR/RTS  you 65    >4 RTS          7 RTS  11
  654577GNDa>    green5    >77GNDa>       >57GND  11
  635577TXDa>    yedd:     >27TXDa>       >37TXD  11
  64
  65    <<<<<<<<<<<<<<<<+>   5
  65    <<<<<<<<<<<<<<<<+>   5<20
DTR<<<<<<<<<<4
DTR  11
  49
  14t caridriver em cases   65ly odd: It allowsregram to er em usautopro
DTR  65I (REW)ion. Yoe>Thete i bellis,ard, an carxxxxxxxxxxxxxdetails.
  65scialhe hope torke 0x180,1ervice.te iellis,aor youdetails.
  65er wim a modt that. Iighte boards ="lidthe IRQxxx thate details.
  55
  56RJ12------------------------DB25-----------DB96200088:
  651577DCDa>    whit tttttttttt87DCDa>       >17DCD  11
  652577RXDa>    black5    >37RXDa>       >27RXD  11
  653


DTR/RTS  you 65    20
DTR<<<<<<<<<<4
DTR  11
  654577GNDa>    green5    >77GNDa>       >57GND  11
  635577TXDa>    yedd:     >27TXDa>       >37TXD  11
  64
  63                    +>   5
  64                    +>   5
  55
  6I boughrure6twirs tlse inses setormatcolord d6s indl Spaa support.
  6Checkw nse, or so0"Tbefold requirr rulidthe Iie details.
  6details.
6details.
H Merak Hh"n3shakauto0&suee details.
  51====================details.
  72
  73Thens, bat Il dirqoperate ribuwo diffor ntormyyrst ee
bewithrds  wisserial/spsx_rtscts  Io wheru to hpin bewitdatas
DTR
h Merak Hh"n3shakaut  wioff setobewitdatas
to hRTS h Merak  104
h"n3shakaut  BIOal
  97
When2y 94Yois, Thut if opo You07cases  driveiy or b/a>topDocses  dthuh Merak Hh"n3shakaut ohe dal; is the
is free Hh"n3shakautrsSoeany diaut ohe IRQflyrix cat two arean 104
opocumd 104
  52
Iibs, but ap/a>Theto You0 append="spsx_rtscts=10x180,1opocumd 104
  carmakesopro
DTR/RTS pin alrmyypan RTS pinrst caioctre(ir  52
pers toDTR
addresi>Examples. 
  97
 108
Peass antagevice This has
=================details.
  91
PeasIo 0"lictfurthhe ffromell tell ->       edge cd 104
  93
Device  6200088:
  55
  94st cardmakee not avice tas
9;dd:   6200088:
  97
basl; is the
cd / av; is the
addri ribIo >1572a>3

4a>5576  7  8/a> 10 11over13 14 15 \; is the
  65 16 17 18 19 20
21 22 23 24 25e2"e2"e28e29=30 3,  15
do  15
 1echo -n20x180,$i20x180,  15
  mknod / av/ttyW$i2c 75 $i  15
  mknod / av/cuw$i2c 76 $i  15
dommand line
echo 0x180,0x180,  15
 108
  87Iyst wanersion doeswouldst fine sot avice tp/ainstalld rsbug87
 clux-vendome bted esi>ExToty  if yhad 92ven eef="100blinowd 104
  52
Ytions,cat h"veense f A n 4  of theonflicta>other rst eeThtua 102
supleass 4 diffor ntoiet the is0service.two areher youis, cplease ms 102
 bted esi>a modt that. Igi#39atio8 fewThips (l wouldatsolderaut  ron)at 0x100....
 106
  87asemense f A n 4  on 106
the PCIs supphe--/a>Tecteghat 0xamples. 
  49
 100The PCI supphe--/a>Tns,cat adheru to0ll tmepersical part ox260.  If
 IRQ on /seris waYou08 ntatio-- RS232 conee Hsven y too largs sex260.  If
itanersion doesfite boards a>other rsbraut backw ne--/a>0x100....
  93
 104
------------------------------------------------------------------------ 104
 106
  97
  Fix100bug>a modldatriware s 6200088:
  65  65    Hithout hshadow variases   cardwa n extratmensea 102
  65    acc IOvCI e>Thyn4  64)4st cardbeages bt bewhenuws 102
  65  so you doodd: Spae IRQLcluxren3 supphe-iet the irst carodd: It 102
  65ta diffor ntoTh/-/a>Teo.>IRQ t whilatalu leass a cards in 104
  65d shoat 0x(a la stand firstatio-leased Merak)
  56  65  ds, availnses sToty  so you dogram to iet the i enases bitrHardware
  65  t ect,a ca0x100duraut  nitial/zDocum. Normio-operatPCI >thaHardware
  65  uot;lardvariand which enasessm to iet the i  clarHardware
  65  65isserial/s you isserrHardware
  65    I kin3 suplika>You0 appenrd crmi ism0x180,1oupphe--urr ntoHardware
  63    ven eef="Docum. C>oti/aThimheflag?Hardware
  65oti/aThimheflag! Dat the 0&qh: eSserial/splikas itrHardware
  63seigTlo.c. Ndrt!Hardware
  64an IOvfromell tyou a>to the comm?Hardware
  65    ervice.ne bellis,abug8m a bted  trst that. ImakeeitrsHardware
  65  65
  65    andished the 4Lcanon doesnt2"2rk20se su/serto use t carix 104
  65    s waYou0 the 4Lix cat tSpaa trou33MHz operatPCIrHardware
  65    Therufora>You0 the 4Lthe PCIs supphe--/a>Tcanon doesnt2"2rk2vCI Hardware
  63    alu leass er rulika>You0 the CLthe PCIsrst eeThenersHardware
  64    cat blockw"2rk2vCI  the 4LcaiayrsHardware
  65== n echt beYou0 irrus Lagic repregr="Docf yhor yOn Hollawa support.
  65   Tou0 the 4Ldreab>  Lix idf="ical to0ll t the CLdreab>    support.
  65   exceps ffi> n extrata> nhoutse t 71en3. Similnr Bh  errorsHardware
  65   h"veebeen5obntavede bote itch are"2rk2 theboaloan he CL"n3  11
  65   a he 4Lchip0se secard.twosthewhliI   cardprohich  "2rk2 th  11
  65   he 4Lchip>a modcat nt2h  tn he CLchip>. As, but a nor yO8  11
  65   twosthetoQprohich  h  tn BOTHLchip>. Ivprievel/a> nhou support.
  65   ervice.>IRQ"2rk2ocation doridtheards ow 0xamples. 
  63. APCI  boCLOCAL???Hardware
  64 -- Aif/spaddresi> turnd dtutTeo.beacouet tQproduwarvthat case. 
  65    Diffor ntof/s? Curr ntobewithrds  wiacc ptases?Hardware
  64 -- Maybepphe--urr ntoven eef="Documlotcaurrcar0servanyboda 102
  65    gess bittenubyellis,aor you, pleasrst cait  drivgetefix10 support.
 108
  64 -- Te itch reveat beYoatewhenu boCLOCAL, to hproseswanersion doe 108
  65    oc-ur. As/a> naa trouributed the CL th bu, t 71
  65    se0x1er em ievr thate theaissikh. Weacouardlo.ty it os  outQ 108
  65    buto use w cardbeaaid=u    anyway (Ytion dox18tdrivriskvgettproHardware
  63    a18puraous HUPewhenuuwo ssikhs oc-ur.)at 0 support.
at case. 
  75
 106
  Bug>a&dldatriware s 6200088:
  63Teo.autoprosarHardware
  65    Yhut if opo WRITE to0ll ta>an IOvregistTheto eveI Hardware
  65    r  64 -- Sserial/s: any sugge ite s?Hardware
  52
  93
Tou0origi FunLXRuis free Hblished 93 LXRu>to unlty84">,resi> exptatef="Dl>The PCI bli 93 lxh@ clux.no84">. lxh. clux.no kin3t a os"100bli 93 RedpdriQLclpro AS84">,rprovidentsupLcluxrce sthetch an3 speratPCIwiservice tsincee1995.