source: trunk/src/os2ahci/atapi.h@ 64

Last change on this file since 64 was 64, checked in by markus, 15 years ago

changed atapi command bits; ATAPI commands are still not working
File size: 7.4 KB
Line 
1/******************************************************************************
2 * atapi.h - ATAPI structures and macros for os2ahci driver
3 *
4 * Copyright (c) 2010 Christian Mueller, Markus Thielen.
5 * Parts copied from/inspired by the Linux AHCI driver;
6 * those parts are (c) Linux AHCI/ATA maintainers
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23/* -------------------------- macros and constants ------------------------- */
24
25/******************************************************************************
26 * macros to fill in ATAPI CDB values
27 */
28#define SET_CDB_16(_t, _v) (_t)[0] = (u8) ((_v) >> 8); \
29 (_t)[1] = (u8) (_v)
30#define SET_CDB_24(_t, _v) (_t)[0] = (u8) ((_v) >> 16); \
31 (_t)[1] = (u8) ((_v) >> 8); \
32 (_t)[2] = (u8) (_v)
33#define SET_CDB_32(_t, _v) (_t)[0] = (u8) ((_v) >> 24); \
34 (_t)[1] = (u8) ((_v) >> 16); \
35 (_t)[2] = (u8) ((_v) >> 8); \
36 (_t)[3] = (u8) (_v)
37
38#define GET_CDB_16(_f) ((u16) (_f)[0] << 8 | \
39 (u16) (_f)[1])
40#define GET_CDB_24(_f) ((u32) (_f)[0] << 16 | \
41 (u32) (_f)[1] << 8 | \
42 (u32) (_f)[2])
43#define GET_CDB_32(_f) ((u32) (_f)[0] << 24 | \
44 (u32) (_f)[1] << 16 | \
45 (u32) (_f)[2] << 24 | \
46 (u32) (_f)[3])
47
48
49/******************************************************************************
50 * ATAPI/MMC command codes (as far as relevant for us)
51 */
52#define ATAPI_CMD_READ_6 0x08
53#define ATAPI_CMD_READ_10 0x28
54#define ATAPI_CMD_READ_12 0xa8
55#define ATAPI_CMD_READ_16 0x88
56#define ATAPI_CMD_WRITE_6 0x0a
57#define ATAPI_CMD_WRITE_10 0x2a
58#define ATAPI_CMD_WRITE_12 0xaa
59#define ATAPI_CMD_WRITE_16 0x8a
60#define ATAPI_CMD_REQUEST_SENSE 0x03
61
62/******************************************************************************
63 * ATAPI command flag bits
64 */
65#define ATAPI_FLAG_FUA 0x80
66#define ATAPI_FLAG_DPO 0x10
67
68#define ATAPI_FEAT_DMA 0x0001
69#define ATAPI_FEAT_DMA_TO_HOST 0x0004
70
71#define ATAPI_LBA_DMA ((u32)0xffff << 8)
72
73/******************************************************************************
74 * ATAPI sense data
75 */
76#define ATAPI_SENSE_LEN 96
77
78#define ASENSE_NO_SENSE 0x00 /* no sense -> success */
79#define ASENSE_RECOVERED_ERROR 0x01 /* recovered error -> success */
80#define ASENSE_NOT_READY 0x02 /* device not ready */
81#define ASENSE_MEDIUM_ERROR 0x03 /* medium/CRC error */
82#define ASENSE_HARDWARE_ERROR 0x04 /* device error */
83#define ASENSE_ILLEGAL_REQUEST 0x05 /* invalid command/parameters issued */
84#define ASENSE_UNIT_ATTENTION 0x06 /* new medium */
85#define ASENSE_DATA_PROTECT 0x07 /* protected LBA */
86#define ASENSE_BLANK_CHECK 0x08 /* unformatted or write protected */
87#define ASENSE_VENDOR_SPECIFIC 0x09 /* vendor specific sense data */
88#define ASENSE_COPY_ABORTED 0x0a /* copy, ...command aborted */
89#define ASENSE_ABORTED_COMMAND 0x0b /* command has been aborted */
90#define ASENSE_EQUAL 0x0c
91#define ASENSE_VOLUME_OVERFLOW 0x0d /* out of space */
92#define ASENSE_MISCOMPARE 0x0e /* verification failed */
93#define ASENSE_RESERVED 0x0f
94
95/******************************************************************************
96 * macro to get sense key from ATAPI_SENSE_DATA pointer
97 */
98#define ATAPI_GET_SENSE(p_) (u8)(p_->sense.sense_key & 0x0f)
99
100/* ------------------------ typedefs and structures ------------------------ */
101
102/******************************************************************************
103 * ATAPI_SENSE_DATA - define layout of ATAPI sense data
104 */
105typedef union _ATAPI_SENSE_DATA {
106 struct {
107 u8 valid_respc; /* valid bit (bit 7), response code (bits 6:0) */
108 u8 segment; /* segment number (obsolete) */
109 u8 sense_key; /* some flags (bits 7:4), sense key (bits 3:0) */
110 u8 info[4]; /* information (?) */
111 u8 adl_len; /* additional sense info length */
112 u8 cmd_specific[4]; /* command specific stuff (ignored) */
113 u8 asc; /* additional sense code */
114 u8 ascq; /* additional sense code qualifier */
115 u8 fruc; /* field replaceable unit code */
116 u8 flags; /* vendor-specific flags */
117 u8 field_off[2]; /* offset to invalid field in parm list */
118 } sense;
119
120 u8 padding[ATAPI_SENSE_LEN]; /* pad to 64 bytes */
121
122} ATAPI_SENSE_DATA;
123
124/******************************************************************************
125 * ATAPI_CDB_10 - describes layout of generic 10 byte ATAPI command
126 */
127typedef struct _ATAPI_CDB_10 {
128 u8 cmd; /* SCSI/ATAPI command code */
129 u8 flags; /* flags (DPO, FUA) */
130 u8 lba[4]; /* logical block address */
131 u8 trans_len[2]; /* number of blocks to transfer */
132 u8 control; /* (nothing much) */
133} ATAPI_CDB_10;
134
135/******************************************************************************
136 * ATAPI_CDB_12 - describes layout of generic 12 byte ATAPI command
137 */
138typedef struct _ATAPI_CDB_12 {
139 u8 cmd; /* SCSI/ATAPI command code */
140 u8 flags; /* flags (DPO, FUA) */
141 u8 lba[4]; /* logical block address */
142 u8 trans_len[4]; /* number of blocks to transfer */
143 u8 reserved;
144 u8 control; /* (nothing much) */
145} ATAPI_CDB_12;
146
147/******************************************************************************Ü
148 * ATAPI_CDB_6 - describes 6 byte ATAPI command
149 */
150typedef struct _ATAPI_CDB_6 {
151 u8 cmd; /* command code */
152 u8 lun; /* SCSI lun (ignored) */
153 u8 resvd[2];
154 u8 trans_len; /* trasnfer length */
155 u8 control;
156} ATAPI_CDB_6;
157
158
159/* ---------------------------- global variables --------------------------- */
160
161/* -------------------------- function prototypes -------------------------- */
162
163extern int atapi_get_geometry (IORBH _far *iorb, int slot);
164extern int atapi_unit_ready (IORBH _far *iorb, int slot);
165extern int atapi_read (IORBH _far *iorb, int slot);
166extern int atapi_verify (IORBH _far *iorb, int slot);
167extern int atapi_write (IORBH _far *iorb, int slot);
168extern int atapi_execute_cdb (IORBH _far *iorb, int slot);
169extern int atapi_req_sense (IORBH _far *iorb, int slot);
170
Note: See TracBrowser for help on using the repository browser.