more debug output
[linux-2.4.git] / Documentation / README.nsp_cs.eng
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.20 / 2.5.63
12 pcmcia-cs:    3.1.33
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/messgaes
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] Extract this driver's archive somewhere, and edit Makefile, then do make.
50 $ tar -zxvf nsp_cs-x.x.tar.gz
51 $ cd nsp_cs-x.x
52 $ emacs Makefile
53 ...
54 $ make
55
56 [4] Copy nsp_cs.o to suitable plase, like /lib/modules/<Kernel version>/pcmcia/ .
57
58 [5] Add these lines to /etc/pcmcia/config .
59     If you yse pcmcia-cs-3.1.8 or later, we can use "nsp_cs.conf" file.
60     So, you don't need to edit file. Just copy to /etc/pcmcia/ .
61
62 -------------------------------------
63 device "nsp_cs"
64   class "scsi" module "nsp_cs"
65
66 card "WorkBit NinjaSCSI-3"
67   version "WBT", "NinjaSCSI-3", "R1.0"
68   bind "nsp_cs"
69
70 card "WorkBit NinjaSCSI-32Bi (16bit)"
71   version "WORKBIT", "UltraNinja-16", "1"
72   bind "nsp_cs"
73
74 # OEM
75 card "WorkBit NinjaSCSI-32Bi (16bit) / IO-DATA"
76   version "IO DATA", "CBSC16       ", "1"
77   bind "nsp_cs"
78
79 # OEM
80 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-1"
81   version "KME    ", "SCSI-CARD-001", "1"
82   bind "nsp_cs"
83 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-2"
84   version "KME    ", "SCSI-CARD-002", "1"
85   bind "nsp_cs"
86 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-3"
87   version "KME    ", "SCSI-CARD-003", "1"
88   bind "nsp_cs"
89 card "WorkBit NinjaSCSI-32Bi (16bit) / KME-4"
90   version "KME    ", "SCSI-CARD-004", "1"
91   bind "nsp_cs"
92 -------------------------------------
93
94 [6] Start (or restart) pcmcia-cs.
95 # /etc/rc.d/rc.pcmcia start        (BSD style)
96 or
97 # /etc/init.d/pcmcia start         (SYSV style)
98
99
100 4. History
101 See README.nin_cs .
102
103 5. Caution
104  If you eject card when doing some operation for your SCSI device or suspend
105 your computer, you encount some *BAD* error like disk crash.
106  It works good when I using this driver right way. But I'm not guarantee
107 your data. Please backup your data when you use this driver.
108
109 6. Known Bugs
110  Many bugs in this driver. Be careful!
111
112 7. Testing
113  Please send me some reports(bug reports etc..) of this software.
114 When you send report, please tell me these or more.
115         card name
116         kernel version
117         your SCSI device name(hard drive, CD-ROM, etc...)
118
119 8. Copyright
120  See GPL.
121
122
123 2002/01/17 yokota@netlab.is.tsukuba.ac.jp <YOKOTA Hiroshi>