Moved private USER definitions to a new user_private.h header, and
[wine] / dlls / winaspi / winescsi.h
1 /*
2  * Copyright (C) 2000 David Elliott <dfe@infinite-internet.net>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19 #ifndef __WINESCSI_H__
20 #define __WINESCSI_H__
21
22 #ifdef linux
23 /* Copy of info from 2.2.x kernel */
24 #define SG_MAX_SENSE 16   /* too little, unlikely to change in 2.2.x */
25
26 #define SG_NEXT_CMD_LEN 0x2283  /* override SCSI command length with given
27                    number on the next write() on this file descriptor */
28
29 struct sg_header
30 {
31     int pack_len;    /* [o] reply_len (ie useless), ignored as input */
32     int reply_len;   /* [i] max length of expected reply (inc. sg_header) */
33     int pack_id;     /* [io] id number of packet (use ints >= 0) */
34     int result;      /* [o] 0==ok, else (+ve) Unix errno (best ignored) */
35     unsigned int twelve_byte:1;
36         /* [i] Force 12 byte command length for group 6 & 7 commands  */
37     unsigned int target_status:5;   /* [o] scsi status from target */
38     unsigned int host_status:8;     /* [o] host status (see "DID" codes) */
39     unsigned int driver_status:8;   /* [o] driver status+suggestion */
40     unsigned int other_flags:10;    /* unused */
41     unsigned char sense_buffer[SG_MAX_SENSE]; /* [o] Output in 3 cases:
42            when target_status is CHECK_CONDITION or
43            when target_status is COMMAND_TERMINATED or
44            when (driver_status & DRIVER_SENSE) is true. */
45 };      /* This structure is 36 bytes long on i386 */
46
47 #define SCSI_OFF sizeof(struct sg_header)
48
49 #define SG_SET_TIMEOUT  0x2201
50 #define SG_GET_TIMEOUT  0x2202
51 #define SCSI_DEFAULT_TIMEOUT 6000*5 /* 5 minutes */
52 #endif
53
54
55 /* RegKey used for SCSI info under HKEY_DYN_DATA */
56 #define KEYNAME_SCSI "WineScsi"
57 #define KEYNAME_SCSI_CONTROLLERMAP "ControllerMap"
58
59 /* Function prototypes from dlls/wnaspi32/aspi.c */
60 void
61 SCSI_Init();
62
63 int
64 ASPI_GetNumControllers();
65
66 int
67 SCSI_OpenDevice( int h, int c, int t, int d );
68
69 int
70 SCSI_LinuxSetTimeout( int fd, int timeout );
71
72 #ifdef linux
73 BOOL
74 SCSI_LinuxDeviceIo( int fd,
75                 struct sg_header * lpvInBuffer, DWORD cbInBuffer,
76                 struct sg_header * lpvOutBuffer, DWORD cbOutBuffer,
77                 LPDWORD lpcbBytesReturned );
78
79 void
80 SCSI_Fix_CMD_LEN( int fd, int cmd, int len );
81 #endif
82
83 BOOL
84 SCSI_GetDeviceName(int h, int c, int t, int d, LPSTR devstr, LPDWORD lpcbData);
85
86 DWORD
87 ASPI_GetHCforController( int controller );
88
89 /*** This is where we throw some miscellaneous crap ***/
90
91 #define ASPI_POSTING(prb) (prb->SRB_Flags & 0x1)
92
93 /* WNASPI32/WINASPI defs */
94 #define HOST_TO_TARGET(prb) (((prb->SRB_Flags>>3) & 0x3) == 0x2)
95 #define TARGET_TO_HOST(prb) (((prb->SRB_Flags>>3) & 0x3) == 0x1)
96 #define NO_DATA_TRANSFERRED(prb) (((prb->SRB_Flags>>3) & 0x3) == 0x3)
97
98
99 #define INQUIRY_VENDOR          8
100
101 #define MUSTEK_SCSI_AREA_AND_WINDOWS 0x04
102 #define MUSTEK_SCSI_READ_SCANNED_DATA 0x08
103 #define MUSTEK_SCSI_GET_IMAGE_STATUS 0x0f
104 #define MUSTEK_SCSI_ADF_AND_BACKTRACE 0x10
105 #define MUSTEK_SCSI_CCD_DISTANCE 0x11
106 #define MUSTEK_SCSI_START_STOP 0x1b
107
108
109 #define INQURIY_CMDLEN 6
110 #define INQURIY_REPLY_LEN 96
111 #define INQUIRY_VENDOR 8
112
113 #define SENSE_BUFFER(prb) (&prb->CDBByte[prb->SRB_CDBLen])
114
115 /* Just a container for seeing what devices are open */
116 struct ASPI_DEVICE_INFO {
117     struct ASPI_DEVICE_INFO *   next;
118     int                         fd;
119     int                         hostId;
120     int                         target;
121     int                         lun;
122 };
123
124 typedef struct ASPI_DEVICE_INFO ASPI_DEVICE_INFO;
125
126 /*** End Miscellaneous crap ***/
127
128 #endif /* #ifndef __WINESCSI_H */