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

Last change on this file since 185 was 178, checked in by David Azarewicz, 9 years ago

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