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