Release 980614
[wine] / documentation / aspi
1 This file describes setting up the Windows ASPI interface.
2
3 Warning/Warning/Warning!!!!!!
4 =============================
5 THIS MAY TRASH YOUR SYSTEM IF USED INCORRECTLY
6 THIS MAY TRASH YOUR SYSTEM IF USED CORRECTLY
7
8 Now that I have said that. ASPI is a direct link to SCSI devices from
9 windows programs. ASPI just forwards the SCSI commands that programs send
10 to it to the SCSI bus.
11
12 If you use the wrong scsi device in your setup file, you can send
13 completely bogus commands to the wrong device - An example would be
14 formatting your hard drives (assuming the device gave you permission -
15 if you're running as root, all bets are off).
16
17 Cookbook for setting up scanner: (At least how mine is to work)
18 ================================
19
20 Windows requirements:
21 =====================
22 0) The scanner software needs to use the "Adaptec" compatible drivers
23 (ASPI). At least with Mustek, they allow you the choice of using
24 the builtin card or the "Adaptec (AHA)" compatible drivers. This will not
25 work any other way.
26 Software that accesses the scanner via a DOS ASPI driver (e.g. ASPI2DOS)
27 is supported, too. [AM]
28
29 1) You probably need a real windows install of the software to set the
30 LUN's/SCSI id's up correctly. I'm not exactly sure.
31
32 LINUX requirements:
33 ============================================================
34 0) Your scsi card must be supported under linux. This will not work with
35 an unknown scsi card.
36
37 1) Compile generic scsi drivers into your kernel.
38
39 2) Linux by default uses smaller scsi buffers than Windows. There is a
40 kernel build define SG_BIG_BUFF (in sg.h) that is by default set too low.
41 The SANE project recommends 130560 and this seems to work just fine. This
42 does require a kernel rebuild.
43
44 3) Make the devices for the scanner (generic scsi devices) - look at the scsi
45 programming how-to for device numbering.
46
47 4) I would recommend making the scanner device writable by a group.
48 I made a group called "scanner" and added myself to it. Running as root
49 increases your risk of sending bad scsi commands to the wrong device. With
50 a regular user, you are better protected.
51
52 5) Add a scsi device entry for your particular scanner to wine.conf.
53 The format is [scsi cCtTdD] where C=controller, T=target, D=LUN
54
55 ex. I set mine up as  controller 0, Target 6, LUN 0.
56 [scsi c0t6d0]
57 Device=/dev/sgi
58
59 Yours will vary with your particular SCSI setup.
60
61
62 General Information:
63 ====================
64 The mustek scanner I have was shipped with a package "ipplus". This
65 program uses the TWAIN driver specification to access scanners.
66
67                             (TWAIN MANAGER)
68 ipplus.exe <---> (TWAIN INTERFACE) <---> (TWAIN DATA SOURCE . ASPI) -> WINASPI
69
70 NOTES/BUGS:
71 ===========
72 The biggest is that it only works under linux at the moment.
73 The ASPI code was only tested using a Mustek 800SP with a Buslogic
74 controller under Linux.
75 The ASPI code has only been tested with:
76 - a Mustek 800SP with a Buslogic controller under Linux [BM]
77 - a Siemens Nixdorf 9036 with Adaptec AVA-1505 under Linux
78   accessed via DOSASPI.
79   Note that I had color problems, though (barely readable result). [AM]
80
81 I make no warranty to the aspi code. It makes my scanner work. Your scanner
82 may explode. I have no way of determining this. I take zero responsibility!
83
84
85 Bruce Milner
86 Additions by Andreas Mohr