195e361cf40c5cf706fac6454d6f8595fdee05f9
[gpxe.git] / src / include / gpxe / ata.h
1 #ifndef _GPXE_ATA_H
2 #define _GPXE_ATA_H
3
4 #include <stdint.h>
5 #include <gpxe/blockdev.h>
6 #include <gpxe/uaccess.h>
7
8 /** @file
9  *
10  * ATA devices
11  *
12  */
13
14 /**
15  * An ATA Logical Block Address
16  *
17  * ATA controllers have three byte-wide registers for specifying the
18  * block address: LBA Low, LBA Mid and LBA High.  This allows for a
19  * 24-bit address.  Some devices support the "48-bit address feature
20  * set" (LBA48), in which case each of these byte-wide registers is
21  * actually a two-entry FIFO, and the "previous" byte pushed into the
22  * FIFO is used as the corresponding high-order byte.  So, to set up
23  * the 48-bit address 0x123456abcdef, you would issue
24  *
25  *     0x56 -> LBA Low register
26  *     0xef -> LBA Low register
27  *     0x34 -> LBA Mid register
28  *     0xcd -> LBA Mid register
29  *     0x12 -> LBA High register
30  *     0xab -> LBA High register
31  *
32  * This structure encapsulates this information by providing a single
33  * 64-bit integer in native byte order, unioned with bytes named so
34  * that the sequence becomes
35  *
36  *     low_prev  -> LBA Low register
37  *     low_cur   -> LBA Low register
38  *     mid_prev  -> LBA Mid register
39  *     mid_cur   -> LBA Mid register
40  *     high_prev -> LBA High register
41  *     high_cur  -> LBA High register
42  *
43  * Just to complicate matters further, in non-LBA48 mode it is
44  * possible to have a 28-bit address, in which case bits 27:24 must be
45  * written into the low four bits of the Device register.
46  */
47 union ata_lba {
48         /** LBA as a 64-bit integer in native-endian order */
49         uint64_t native;
50         /** ATA registers */
51         struct {
52 #if __BYTE_ORDER == __LITTLE_ENDIAN
53                 uint8_t low_cur;
54                 uint8_t mid_cur;
55                 uint8_t high_cur;
56                 uint8_t low_prev;
57                 uint8_t mid_prev;
58                 uint8_t high_prev;
59                 uint16_t pad;
60 #elif __BYTE_ORDER == __BIG_ENDIAN
61                 uint16_t pad;
62                 uint8_t high_prev;
63                 uint8_t mid_prev;
64                 uint8_t low_prev;
65                 uint8_t high_cur;
66                 uint8_t mid_cur;
67                 uint8_t low_cur;
68 #else
69 #error "I need a byte order"
70 #endif
71         } bytes;
72 };
73
74 /** An ATA 2-byte FIFO register */
75 union ata_fifo {
76         /** Value in native-endian order */
77         uint16_t native;
78         /** ATA registers */
79         struct {
80 #if __BYTE_ORDER == __LITTLE_ENDIAN
81                 uint8_t cur;
82                 uint8_t prev;
83 #elif __BYTE_ORDER == __BIG_ENDIAN
84                 uint8_t prev;
85                 uint8_t cur;
86 #else
87 #error "I need a byte order"
88 #endif
89         } bytes;
90 };
91
92 /** ATA command block */
93 struct ata_cb {
94         /** Logical block address */
95         union ata_lba lba;
96         /** Sector count */
97         union ata_fifo count;
98         /** Error/feature register */
99         union ata_fifo err_feat;
100         /** Device register */
101         uint8_t device;
102         /** Command/status register */
103         uint8_t cmd_stat;
104         /** LBA48 addressing flag */
105         int lba48;
106 };
107
108 /** Obsolete bits in the ATA device register */
109 #define ATA_DEV_OBSOLETE 0xa0
110
111 /** LBA flag in the ATA device register */
112 #define ATA_DEV_LBA 0x40
113
114 /** Slave ("device 1") flag in the ATA device register */
115 #define ATA_DEV_SLAVE 0x10
116
117 /** Master ("device 0") flag in the ATA device register */
118 #define ATA_DEV_MASTER 0x00
119
120 /** Mask of non-LBA portion of device register */
121 #define ATA_DEV_MASK 0xf0
122
123 /** "Read sectors" command */
124 #define ATA_CMD_READ 0x20
125
126 /** "Read sectors (ext)" command */
127 #define ATA_CMD_READ_EXT 0x24
128
129 /** "Write sectors" command */
130 #define ATA_CMD_WRITE 0x30
131
132 /** "Write sectors (ext)" command */
133 #define ATA_CMD_WRITE_EXT 0x34
134
135 /** "Identify" command */
136 #define ATA_CMD_IDENTIFY 0xec
137
138 /** An ATA command */
139 struct ata_command {
140         /** ATA command block */
141         struct ata_cb cb;
142         /** Data-out buffer (may be NULL) */
143         userptr_t data_out;
144         /** Data-out buffer length
145          *
146          * Must be zero if @c data_out is NULL
147          */
148         size_t data_out_len;
149         /** Data-in buffer (may be NULL) */
150         userptr_t data_in;
151         /** Data-in buffer length
152          *
153          * Must be zero if @c data_in is NULL
154          */
155         size_t data_in_len;
156 };
157
158 /**
159  * Structure returned by ATA IDENTIFY command
160  *
161  * This is a huge structure with many fields that we don't care about,
162  * so we implement only a few fields.
163  */
164 struct ata_identity {
165         uint16_t ignore_a[60]; /* words 0-59 */
166         uint32_t lba_sectors; /* words 60-61 */
167         uint16_t ignore_b[21]; /* words 62-82 */
168         uint16_t supports_lba48; /* word 83 */
169         uint16_t ignore_c[16]; /* words 84-99 */
170         uint64_t lba48_sectors; /* words 100-103 */
171         uint16_t ignore_d[152]; /* words 104-255 */
172 };
173
174 /** Supports LBA48 flag */
175 #define ATA_SUPPORTS_LBA48 ( 1 << 10 )
176
177 /** ATA sector size */
178 #define ATA_SECTOR_SIZE 512
179
180 /** An ATA device */
181 struct ata_device {
182         /** Block device interface */
183         struct block_device blockdev;
184         /** Device number
185          *
186          * Must be ATA_DEV_MASTER or ATA_DEV_SLAVE.
187          */
188         int device;
189         /** LBA48 extended addressing */
190         int lba48;
191         /**
192          * Issue ATA command
193          *
194          * @v ata               ATA device
195          * @v command           ATA command
196          * @ret rc              Return status code
197          */
198         int ( * command ) ( struct ata_device *ata,
199                             struct ata_command *command );
200 };
201
202 extern int init_atadev ( struct ata_device *ata );
203
204 #endif /* _GPXE_ATA_H */