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