Documentation: update broken web addresses.
[linux-3.10.git] / Documentation / scsi / NinjaSCSI.txt
1
2          WorkBiT NinjaSCSI-3/32Bi driver for Linux
3
4 1. Comment
5  This is Workbit corp.'s(http://www.workbit.co.jp/) NinjaSCSI-3
6 for Linux.
7
8 2. My Linux environment
9 Linux kernel: 2.4.7 / 2.2.19
10 pcmcia-cs:    3.1.27
11 gcc:          gcc-2.95.4
12 PC card:      I-O data PCSC-F (NinjaSCSI-3)
13               I-O data CBSC-II in 16 bit mode (NinjaSCSI-32Bi)
14 SCSI device:  I-O data CDPS-PX24 (CD-ROM drive)
15               Media Intelligent MMO-640GT (Optical disk drive)
16
17 3. Install
18 [1] Check your PC card is true "NinjaSCSI-3" card.
19     If you installed pcmcia-cs already, pcmcia reports your card as UNKNOWN
20     card, and write ["WBT", "NinjaSCSI-3", "R1.0"] or some other string to
21     your console or log file.
22     You can also use "cardctl" program (this program is in pcmcia-cs source
23     code) to get more info.
24
25 # cat /var/log/messages
26 ...
27 Jan  2 03:45:06 lindberg cardmgr[78]: unsupported card in socket 1
28 Jan  2 03:45:06 lindberg cardmgr[78]:   product info: "WBT", "NinjaSCSI-3", "R1.0"
29 ...
30 # cardctl ident
31 Socket 0:
32   no product info available
33 Socket 1:
34   product info: "IO DATA", "CBSC16       ", "1"
35
36
37 [2] Get the Linux kernel source, and extract it to /usr/src.
38     Because the NinjaSCSI driver requires some SCSI header files in Linux 
39     kernel source, I recommend rebuilding your kernel; this eliminates 
40     some versioning problems.
41 $ cd /usr/src
42 $ tar -zxvf linux-x.x.x.tar.gz
43 $ cd linux
44 $ make config
45 ...
46
47 [3] If you use this driver with Kernel 2.2, unpack pcmcia-cs in some directory
48     and make & install. This driver requires the pcmcia-cs header file.
49 $ cd /usr/src
50 $ tar zxvf cs-pcmcia-cs-3.x.x.tar.gz
51 ...
52
53 [4] Extract this driver's archive somewhere, and edit Makefile, then do make.
54 $ tar -zxvf nsp_cs-x.x.tar.gz
55 $ cd nsp_cs-x.x
56 $ emacs Makefile
57 ...
58 $ make
59
60 [5] Copy nsp_cs.ko to suitable place, like /lib/modules/<Kernel version>/pcmcia/ .
61
62 [6] Add these lines to /etc/pcmcia/config .
63     If you use pcmcia-cs-3.1.8 or later, we can use "nsp_cs.conf" file.
64     So, you don't need to edit file. Just copy to /etc/pcmcia/ .
65
66 -------------------------------------
67 device "nsp_cs"
68   class "scsi" module "nsp_cs"
69
70 card "WorkBit NinjaSCSI-3"
71   version "WBT", "NinjaSCSI-3", "R1.0"
72   bind "nsp_cs"
73
74 card "WorkBit NinjaSCSI-32Bi (16bit)"
75   version "WORKBIT", "UltraNinja-16", "1"
76   bind "nsp_cs"
77
78 # OEM
79 card "WorkBit NinjaSCSI-32Bi (16bit) / IO-DATA"
80   version "IO DATA", "CBSC16       ", "1"
81   bind "nsp_cs"
82
83 # OEM
84 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-1"
85   version "KME    ", "SCSI-CARD-001", "1"
86   bind "nsp_cs"
87 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-2"
88   version "KME    ", "SCSI-CARD-002", "1"
89   bind "nsp_cs"
90 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-3"
91   version "KME    ", "SCSI-CARD-003", "1"
92   bind "nsp_cs"
93 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-4"
94   version "KME    ", "SCSI-CARD-004", "1"
95   bind "nsp_cs"
96 -------------------------------------
97
98 [7] Start (or restart) pcmcia-cs.
99 # /etc/rc.d/rc.pcmcia start        (BSD style)
100 or
101 # /etc/init.d/pcmcia start         (SYSV style)
102
103
104 4. History
105 See README.nin_cs .
106
107 5. Caution
108  If you eject card when doing some operation for your SCSI device or suspend
109 your computer, you encount some *BAD* error like disk crash.
110  It works good when I using this driver right way. But I'm not guarantee
111 your data. Please backup your data when you use this driver.
112
113 6. Known Bugs
114  In 2.4 kernel, you can't use 640MB Optical disk. This error comes from
115 high level SCSI driver.
116
117 7. Testing
118  Please send me some reports(bug reports etc..) of this software.
119 When you send report, please tell me these or more.
120         card name
121         kernel version
122         your SCSI device name(hard drive, CD-ROM, etc...)
123
124 8. Copyright
125  See GPL.
126
127
128 2001/08/08 yokota@netlab.is.tsukuba.ac.jp <YOKOTA Hiroshi>