blob: 3b2d737e6176cacdef08122fdf7006ac844f8a65 [file] [log] [blame]
wdenkfe8c2802002-11-03 00:38:21 +00001/*
2 * (C) Copyright 2000
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
5 * See file CREDITS for list of people who contributed to this
6 * project.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (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,
21 * MA 02111-1307 USA
22 */
23
24/*
25 * Most of the following information was derived from the document
26 * "Information Technology - AT Attachment-3 Interface (ATA-3)"
27 * which can be found at:
28 * http://www.dt.wdc.com/ata/ata-3/ata3r5v.zip
29 * ftp://poctok.iae.nsk.su/pub/asm/Documents/IDE/ATA3R5V.ZIP
30 * ftp://ftp.fee.vutbr.cz/pub/doc/io/ata/ata-3/ata3r5v.zip
31 */
32
33#ifndef _ATA_H
34#define _ATA_H
35
Steven A. Falco9571b842008-08-15 15:29:12 -040036#include <libata.h>
37
wdenkfe8c2802002-11-03 00:38:21 +000038/* Register addressing depends on the hardware design; for instance,
39 * 8-bit (register) and 16-bit (data) accesses might use different
40 * address spaces. This is implemented by the following definitions.
41 */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020042#ifndef CONFIG_SYS_ATA_STRIDE
43#define CONFIG_SYS_ATA_STRIDE 1
wdenk9fd5e312003-12-07 23:55:12 +000044#endif
wdenkfe8c2802002-11-03 00:38:21 +000045
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020046#define ATA_IO_DATA(x) (CONFIG_SYS_ATA_DATA_OFFSET+((x) * CONFIG_SYS_ATA_STRIDE))
47#define ATA_IO_REG(x) (CONFIG_SYS_ATA_REG_OFFSET +((x) * CONFIG_SYS_ATA_STRIDE))
48#define ATA_IO_ALT(x) (CONFIG_SYS_ATA_ALT_OFFSET +((x) * CONFIG_SYS_ATA_STRIDE))
wdenkfe8c2802002-11-03 00:38:21 +000049
50/*
51 * I/O Register Descriptions
52 */
53#define ATA_DATA_REG ATA_IO_DATA(0)
54#define ATA_ERROR_REG ATA_IO_REG(1)
55#define ATA_SECT_CNT ATA_IO_REG(2)
56#define ATA_SECT_NUM ATA_IO_REG(3)
57#define ATA_CYL_LOW ATA_IO_REG(4)
58#define ATA_CYL_HIGH ATA_IO_REG(5)
59#define ATA_DEV_HD ATA_IO_REG(6)
60#define ATA_COMMAND ATA_IO_REG(7)
wdenka522fa02004-01-04 22:51:12 +000061#define ATA_DATA_EVEN ATA_IO_REG(8)
62#define ATA_DATA_ODD ATA_IO_REG(9)
wdenkfe8c2802002-11-03 00:38:21 +000063#define ATA_STATUS ATA_COMMAND
64#define ATA_DEV_CTL ATA_IO_ALT(6)
65#define ATA_LBA_LOW ATA_SECT_NUM
66#define ATA_LBA_MID ATA_CYL_LOW
67#define ATA_LBA_HIGH ATA_CYL_HIGH
68#define ATA_LBA_SEL ATA_DEV_CTL
69
70/*
71 * Status register bits
72 */
73#define ATA_STAT_BUSY 0x80 /* Device Busy */
74#define ATA_STAT_READY 0x40 /* Device Ready */
75#define ATA_STAT_FAULT 0x20 /* Device Fault */
76#define ATA_STAT_SEEK 0x10 /* Device Seek Complete */
77#define ATA_STAT_DRQ 0x08 /* Data Request (ready) */
78#define ATA_STAT_CORR 0x04 /* Corrected Data Error */
79#define ATA_STAT_INDEX 0x02 /* Vendor specific */
80#define ATA_STAT_ERR 0x01 /* Error */
81
82/*
83 * Device / Head Register Bits
84 */
Reinhard Arlt2b224602011-11-10 08:51:57 +000085#ifndef ATA_DEVICE
wdenkfe8c2802002-11-03 00:38:21 +000086#define ATA_DEVICE(x) ((x & 1)<<4)
Reinhard Arlt2b224602011-11-10 08:51:57 +000087#endif /* ATA_DEVICE */
wdenkfe8c2802002-11-03 00:38:21 +000088#define ATA_LBA 0xE0
89
90/*
91 * ATA Commands (only mandatory commands listed here)
92 */
93#define ATA_CMD_READ 0x20 /* Read Sectors (with retries) */
94#define ATA_CMD_READN 0x21 /* Read Sectors ( no retries) */
95#define ATA_CMD_WRITE 0x30 /* Write Sectores (with retries)*/
96#define ATA_CMD_WRITEN 0x31 /* Write Sectors ( no retries)*/
97#define ATA_CMD_VRFY 0x40 /* Read Verify (with retries) */
98#define ATA_CMD_VRFYN 0x41 /* Read verify ( no retries) */
99#define ATA_CMD_SEEK 0x70 /* Seek */
100#define ATA_CMD_DIAG 0x90 /* Execute Device Diagnostic */
101#define ATA_CMD_INIT 0x91 /* Initialize Device Parameters */
102#define ATA_CMD_RD_MULT 0xC4 /* Read Multiple */
103#define ATA_CMD_WR_MULT 0xC5 /* Write Multiple */
104#define ATA_CMD_SETMULT 0xC6 /* Set Multiple Mode */
105#define ATA_CMD_RD_DMA 0xC8 /* Read DMA (with retries) */
106#define ATA_CMD_RD_DMAN 0xC9 /* Read DMS ( no retries) */
107#define ATA_CMD_WR_DMA 0xCA /* Write DMA (with retries) */
108#define ATA_CMD_WR_DMAN 0xCB /* Write DMA ( no retires) */
109#define ATA_CMD_IDENT 0xEC /* Identify Device */
110#define ATA_CMD_SETF 0xEF /* Set Features */
111#define ATA_CMD_CHK_PWR 0xE5 /* Check Power Mode */
112
wdenkc40b2952004-03-13 23:29:43 +0000113#define ATA_CMD_READ_EXT 0x24 /* Read Sectors (with retries) with 48bit addressing */
114#define ATA_CMD_WRITE_EXT 0x34 /* Write Sectores (with retries) with 48bit addressing */
115#define ATA_CMD_VRFY_EXT 0x42 /* Read Verify (with retries) with 48bit addressing */
116
wdenkfe8c2802002-11-03 00:38:21 +0000117/*
118 * ATAPI Commands
119 */
120#define ATAPI_CMD_IDENT 0xA1 /* Identify AT Atachment Packed Interface Device */
121#define ATAPI_CMD_PACKET 0xA0 /* Packed Command */
122
123
124#define ATAPI_CMD_INQUIRY 0x12
125#define ATAPI_CMD_REQ_SENSE 0x03
126#define ATAPI_CMD_READ_CAP 0x25
127#define ATAPI_CMD_START_STOP 0x1B
128#define ATAPI_CMD_READ_12 0xA8
129
130
131#define ATA_GET_ERR() inb(ATA_STATUS)
132#define ATA_GET_STAT() inb(ATA_STATUS)
133#define ATA_OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
134#define ATA_BAD_R_STAT (ATA_STAT_BUSY | ATA_STAT_ERR)
135#define ATA_BAD_W_STAT (ATA_BAD_R_STAT | ATA_STAT_FAULT)
136#define ATA_BAD_STAT (ATA_BAD_R_STAT | ATA_STAT_DRQ)
137#define ATA_DRIVE_READY (ATA_READY_STAT | ATA_STAT_SEEK)
138#define ATA_DATA_READY (ATA_STAT_DRQ)
139
140#define ATA_BLOCKSIZE 512 /* bytes */
141#define ATA_BLOCKSHIFT 9 /* 2 ^ ATA_BLOCKSIZESHIFT = 512 */
142#define ATA_SECTORWORDS (512 / sizeof(unsigned long))
143
144#ifndef ATA_RESET_TIME
145#define ATA_RESET_TIME 60 /* spec allows up to 31 seconds */
146#endif
147
148/* ------------------------------------------------------------------------- */
149
150/*
151 * structure returned by ATA_CMD_IDENT, as per ANSI ATA2 rev.2f spec
152 */
153typedef struct hd_driveid {
154 unsigned short config; /* lots of obsolete bit flags */
155 unsigned short cyls; /* "physical" cyls */
156 unsigned short reserved2; /* reserved (word 2) */
157 unsigned short heads; /* "physical" heads */
158 unsigned short track_bytes; /* unformatted bytes per track */
159 unsigned short sector_bytes; /* unformatted bytes per sector */
160 unsigned short sectors; /* "physical" sectors per track */
161 unsigned short vendor0; /* vendor unique */
162 unsigned short vendor1; /* vendor unique */
163 unsigned short vendor2; /* vendor unique */
164 unsigned char serial_no[20]; /* 0 = not_specified */
165 unsigned short buf_type;
166 unsigned short buf_size; /* 512 byte increments; 0 = not_specified */
167 unsigned short ecc_bytes; /* for r/w long cmds; 0 = not_specified */
168 unsigned char fw_rev[8]; /* 0 = not_specified */
169 unsigned char model[40]; /* 0 = not_specified */
170 unsigned char max_multsect; /* 0=not_implemented */
171 unsigned char vendor3; /* vendor unique */
172 unsigned short dword_io; /* 0=not_implemented; 1=implemented */
173 unsigned char vendor4; /* vendor unique */
174 unsigned char capability; /* bits 0:DMA 1:LBA 2:IORDYsw 3:IORDYsup*/
175 unsigned short reserved50; /* reserved (word 50) */
176 unsigned char vendor5; /* vendor unique */
177 unsigned char tPIO; /* 0=slow, 1=medium, 2=fast */
178 unsigned char vendor6; /* vendor unique */
179 unsigned char tDMA; /* 0=slow, 1=medium, 2=fast */
180 unsigned short field_valid; /* bits 0:cur_ok 1:eide_ok */
181 unsigned short cur_cyls; /* logical cylinders */
182 unsigned short cur_heads; /* logical heads */
183 unsigned short cur_sectors; /* logical sectors per track */
184 unsigned short cur_capacity0; /* logical total sectors on drive */
185 unsigned short cur_capacity1; /* (2 words, misaligned int) */
186 unsigned char multsect; /* current multiple sector count */
187 unsigned char multsect_valid; /* when (bit0==1) multsect is ok */
188 unsigned int lba_capacity; /* total number of sectors */
189 unsigned short dma_1word; /* single-word dma info */
190 unsigned short dma_mword; /* multiple-word dma info */
191 unsigned short eide_pio_modes; /* bits 0:mode3 1:mode4 */
192 unsigned short eide_dma_min; /* min mword dma cycle time (ns) */
193 unsigned short eide_dma_time; /* recommended mword dma cycle time (ns) */
194 unsigned short eide_pio; /* min cycle time (ns), no IORDY */
195 unsigned short eide_pio_iordy; /* min cycle time (ns), with IORDY */
196 unsigned short words69_70[2]; /* reserved words 69-70 */
197 unsigned short words71_74[4]; /* reserved words 71-74 */
198 unsigned short queue_depth; /* */
199 unsigned short words76_79[4]; /* reserved words 76-79 */
200 unsigned short major_rev_num; /* */
201 unsigned short minor_rev_num; /* */
202 unsigned short command_set_1; /* bits 0:Smart 1:Security 2:Removable 3:PM */
wdenkc40b2952004-03-13 23:29:43 +0000203 unsigned short command_set_2; /* bits 14:Smart Enabled 13:0 zero 10:lba48 support*/
wdenkfe8c2802002-11-03 00:38:21 +0000204 unsigned short cfsse; /* command set-feature supported extensions */
205 unsigned short cfs_enable_1; /* command set-feature enabled */
206 unsigned short cfs_enable_2; /* command set-feature enabled */
207 unsigned short csf_default; /* command set-feature default */
208 unsigned short dma_ultra; /* */
209 unsigned short word89; /* reserved (word 89) */
210 unsigned short word90; /* reserved (word 90) */
211 unsigned short CurAPMvalues; /* current APM values */
212 unsigned short word92; /* reserved (word 92) */
213 unsigned short hw_config; /* hardware config */
wdenkc40b2952004-03-13 23:29:43 +0000214 unsigned short words94_99[6];/* reserved words 94-99 */
wdenk42dfe7a2004-03-14 22:25:36 +0000215 /*unsigned long long lba48_capacity; /--* 4 16bit values containing lba 48 total number of sectors */
wdenkc40b2952004-03-13 23:29:43 +0000216 unsigned short lba48_capacity[4]; /* 4 16bit values containing lba 48 total number of sectors */
217 unsigned short words104_125[22];/* reserved words 104-125 */
wdenkfe8c2802002-11-03 00:38:21 +0000218 unsigned short last_lun; /* reserved (word 126) */
219 unsigned short word127; /* reserved (word 127) */
220 unsigned short dlf; /* device lock function
221 * 15:9 reserved
222 * 8 security level 1:max 0:high
223 * 7:6 reserved
224 * 5 enhanced erase
225 * 4 expire
226 * 3 frozen
227 * 2 locked
228 * 1 en/disabled
229 * 0 capability
230 */
231 unsigned short csfo; /* current set features options
232 * 15:4 reserved
233 * 3 auto reassign
234 * 2 reverting
235 * 1 read-look-ahead
236 * 0 write cache
237 */
238 unsigned short words130_155[26];/* reserved vendor words 130-155 */
239 unsigned short word156;
240 unsigned short words157_159[3];/* reserved vendor words 157-159 */
Steven A. Falco36c2d302008-08-15 15:34:10 -0400241 unsigned short words160_162[3];/* reserved words 160-162 */
242 unsigned short cf_advanced_caps;
243 unsigned short words164_255[92];/* reserved words 164-255 */
wdenkfe8c2802002-11-03 00:38:21 +0000244} hd_driveid_t;
245
246
247/*
248 * PIO Mode Configuration
249 *
250 * See ATA-3 (AT Attachment-3 Interface) documentation, Figure 14 / Table 21
251 */
252
253typedef struct {
254 unsigned int t_setup; /* Setup Time in [ns] or clocks */
255 unsigned int t_length; /* Length Time in [ns] or clocks */
256 unsigned int t_hold; /* Hold Time in [ns] or clocks */
257}
258pio_config_t;
259
260#define IDE_MAX_PIO_MODE 4 /* max suppurted PIO mode */
261
262/* ------------------------------------------------------------------------- */
263
264#endif /* _ATA_H */