e35d91941d124bdc4e3afa1f44c11bc602ebf122
[oweals/u-boot.git] / include / ata.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2000
4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5  */
6
7 /*
8  * Most of the following information was derived from the document
9  * "Information Technology - AT Attachment-3 Interface (ATA-3)"
10  * which can be found at:
11  * http://www.dt.wdc.com/ata/ata-3/ata3r5v.zip
12  * ftp://poctok.iae.nsk.su/pub/asm/Documents/IDE/ATA3R5V.ZIP
13  * ftp://ftp.fee.vutbr.cz/pub/doc/io/ata/ata-3/ata3r5v.zip
14  */
15
16 #ifndef _ATA_H
17 #define _ATA_H
18
19 #include <libata.h>
20
21 /* Register addressing depends on the hardware design; for instance,
22  * 8-bit (register) and 16-bit (data) accesses might use different
23  * address spaces. This is implemented by the following definitions.
24  */
25 #ifndef CONFIG_SYS_ATA_STRIDE
26 #define CONFIG_SYS_ATA_STRIDE   1
27 #endif
28
29 #define ATA_IO_DATA(x)  (CONFIG_SYS_ATA_DATA_OFFSET+((x) * CONFIG_SYS_ATA_STRIDE))
30 #define ATA_IO_REG(x)   (CONFIG_SYS_ATA_REG_OFFSET +((x) * CONFIG_SYS_ATA_STRIDE))
31 #define ATA_IO_ALT(x)   (CONFIG_SYS_ATA_ALT_OFFSET +((x) * CONFIG_SYS_ATA_STRIDE))
32
33 /*
34  * I/O Register Descriptions
35  */
36 #define ATA_DATA_REG    ATA_IO_DATA(0)
37 #define ATA_ERROR_REG   ATA_IO_REG(1)
38 #define ATA_SECT_CNT    ATA_IO_REG(2)
39 #define ATA_SECT_NUM    ATA_IO_REG(3)
40 #define ATA_CYL_LOW     ATA_IO_REG(4)
41 #define ATA_CYL_HIGH    ATA_IO_REG(5)
42 #define ATA_DEV_HD      ATA_IO_REG(6)
43 #define ATA_COMMAND     ATA_IO_REG(7)
44 #define ATA_DATA_EVEN   ATA_IO_REG(8)
45 #define ATA_DATA_ODD    ATA_IO_REG(9)
46 #define ATA_STATUS      ATA_COMMAND
47 #define ATA_DEV_CTL     ATA_IO_ALT(6)
48 #define ATA_LBA_LOW     ATA_SECT_NUM
49 #define ATA_LBA_MID     ATA_CYL_LOW
50 #define ATA_LBA_HIGH    ATA_CYL_HIGH
51 #define ATA_LBA_SEL     ATA_DEV_CTL
52
53 /*
54  * Status register bits
55  */
56 #define ATA_STAT_BUSY   0x80    /* Device Busy                  */
57 #define ATA_STAT_READY  0x40    /* Device Ready                 */
58 #define ATA_STAT_FAULT  0x20    /* Device Fault                 */
59 #define ATA_STAT_SEEK   0x10    /* Device Seek Complete         */
60 #define ATA_STAT_DRQ    0x08    /* Data Request (ready)         */
61 #define ATA_STAT_CORR   0x04    /* Corrected Data Error         */
62 #define ATA_STAT_INDEX  0x02    /* Vendor specific              */
63 #define ATA_STAT_ERR    0x01    /* Error                        */
64
65 /*
66  * Device / Head Register Bits
67  */
68 #ifndef ATA_DEVICE
69 #define ATA_DEVICE(x)   ((x & 1)<<4)
70 #endif /* ATA_DEVICE */
71 #define ATA_LBA         0xE0
72
73 /*
74  * ATAPI Commands
75  */
76 #define ATAPI_CMD_INQUIRY 0x12
77 #define ATAPI_CMD_REQ_SENSE 0x03
78 #define ATAPI_CMD_READ_CAP 0x25
79 #define ATAPI_CMD_START_STOP 0x1B
80 #define ATAPI_CMD_READ_12 0xA8
81
82
83 #define ATA_GET_ERR()   inb(ATA_STATUS)
84 #define ATA_GET_STAT()  inb(ATA_STATUS)
85 #define ATA_OK_STAT(stat,good,bad)      (((stat)&((good)|(bad)))==(good))
86 #define ATA_BAD_R_STAT  (ATA_STAT_BUSY  | ATA_STAT_ERR)
87 #define ATA_BAD_W_STAT  (ATA_BAD_R_STAT | ATA_STAT_FAULT)
88 #define ATA_BAD_STAT    (ATA_BAD_R_STAT | ATA_STAT_DRQ)
89 #define ATA_DRIVE_READY (ATA_READY_STAT | ATA_STAT_SEEK)
90 #define ATA_DATA_READY  (ATA_STAT_DRQ)
91
92 #define ATA_BLOCKSIZE   512     /* bytes */
93 #define ATA_BLOCKSHIFT  9       /* 2 ^ ATA_BLOCKSIZESHIFT = 512 */
94 #define ATA_SECTORWORDS (512 / sizeof(uint32_t))
95
96 #ifndef ATA_RESET_TIME
97 #define ATA_RESET_TIME  60      /* spec allows up to 31 seconds */
98 #endif
99
100 /* ------------------------------------------------------------------------- */
101
102 /*
103  * structure returned by ATA_CMD_IDENT, as per ANSI ATA2 rev.2f spec
104  */
105 typedef struct hd_driveid {
106         unsigned short  config;         /* lots of obsolete bit flags */
107         unsigned short  cyls;           /* "physical" cyls */
108         unsigned short  reserved2;      /* reserved (word 2) */
109         unsigned short  heads;          /* "physical" heads */
110         unsigned short  track_bytes;    /* unformatted bytes per track */
111         unsigned short  sector_bytes;   /* unformatted bytes per sector */
112         unsigned short  sectors;        /* "physical" sectors per track */
113         unsigned short  vendor0;        /* vendor unique */
114         unsigned short  vendor1;        /* vendor unique */
115         unsigned short  vendor2;        /* vendor unique */
116         unsigned char   serial_no[20];  /* 0 = not_specified */
117         unsigned short  buf_type;
118         unsigned short  buf_size;       /* 512 byte increments; 0 = not_specified */
119         unsigned short  ecc_bytes;      /* for r/w long cmds; 0 = not_specified */
120         unsigned char   fw_rev[8];      /* 0 = not_specified */
121         unsigned char   model[40];      /* 0 = not_specified */
122         unsigned char   max_multsect;   /* 0=not_implemented */
123         unsigned char   vendor3;        /* vendor unique */
124         unsigned short  dword_io;       /* 0=not_implemented; 1=implemented */
125         unsigned char   vendor4;        /* vendor unique */
126         unsigned char   capability;     /* bits 0:DMA 1:LBA 2:IORDYsw 3:IORDYsup*/
127         unsigned short  reserved50;     /* reserved (word 50) */
128         unsigned char   vendor5;        /* vendor unique */
129         unsigned char   tPIO;           /* 0=slow, 1=medium, 2=fast */
130         unsigned char   vendor6;        /* vendor unique */
131         unsigned char   tDMA;           /* 0=slow, 1=medium, 2=fast */
132         unsigned short  field_valid;    /* bits 0:cur_ok 1:eide_ok */
133         unsigned short  cur_cyls;       /* logical cylinders */
134         unsigned short  cur_heads;      /* logical heads */
135         unsigned short  cur_sectors;    /* logical sectors per track */
136         unsigned short  cur_capacity0;  /* logical total sectors on drive */
137         unsigned short  cur_capacity1;  /*  (2 words, misaligned int)     */
138         unsigned char   multsect;       /* current multiple sector count */
139         unsigned char   multsect_valid; /* when (bit0==1) multsect is ok */
140         unsigned int    lba_capacity;   /* total number of sectors */
141         unsigned short  dma_1word;      /* single-word dma info */
142         unsigned short  dma_mword;      /* multiple-word dma info */
143         unsigned short  eide_pio_modes; /* bits 0:mode3 1:mode4 */
144         unsigned short  eide_dma_min;   /* min mword dma cycle time (ns) */
145         unsigned short  eide_dma_time;  /* recommended mword dma cycle time (ns) */
146         unsigned short  eide_pio;       /* min cycle time (ns), no IORDY  */
147         unsigned short  eide_pio_iordy; /* min cycle time (ns), with IORDY */
148         unsigned short  words69_70[2];  /* reserved words 69-70 */
149         unsigned short  words71_74[4];  /* reserved words 71-74 */
150         unsigned short  queue_depth;    /*  */
151         unsigned short  words76_79[4];  /* reserved words 76-79 */
152         unsigned short  major_rev_num;  /*  */
153         unsigned short  minor_rev_num;  /*  */
154         unsigned short  command_set_1;  /* bits 0:Smart 1:Security 2:Removable 3:PM */
155         unsigned short  command_set_2;  /* bits 14:Smart Enabled 13:0 zero 10:lba48 support*/
156         unsigned short  cfsse;          /* command set-feature supported extensions */
157         unsigned short  cfs_enable_1;   /* command set-feature enabled */
158         unsigned short  cfs_enable_2;   /* command set-feature enabled */
159         unsigned short  csf_default;    /* command set-feature default */
160         unsigned short  dma_ultra;      /*  */
161         unsigned short  word89;         /* reserved (word 89) */
162         unsigned short  word90;         /* reserved (word 90) */
163         unsigned short  CurAPMvalues;   /* current APM values */
164         unsigned short  word92;         /* reserved (word 92) */
165         unsigned short  hw_config;      /* hardware config */
166         unsigned short  words94_99[6];/* reserved words 94-99 */
167         /*unsigned long long  lba48_capacity; /--* 4 16bit values containing lba 48 total number of sectors */
168         unsigned short  lba48_capacity[4]; /* 4 16bit values containing lba 48 total number of sectors */
169         unsigned short  words104_125[22];/* reserved words 104-125 */
170         unsigned short  last_lun;       /* reserved (word 126) */
171         unsigned short  word127;        /* reserved (word 127) */
172         unsigned short  dlf;            /* device lock function
173                                          * 15:9 reserved
174                                          * 8    security level 1:max 0:high
175                                          * 7:6  reserved
176                                          * 5    enhanced erase
177                                          * 4    expire
178                                          * 3    frozen
179                                          * 2    locked
180                                          * 1    en/disabled
181                                          * 0    capability
182                                          */
183         unsigned short  csfo;           /* current set features options
184                                          * 15:4 reserved
185                                          * 3    auto reassign
186                                          * 2    reverting
187                                          * 1    read-look-ahead
188                                          * 0    write cache
189                                          */
190         unsigned short  words130_155[26];/* reserved vendor words 130-155 */
191         unsigned short  word156;
192         unsigned short  words157_159[3];/* reserved vendor words 157-159 */
193         unsigned short  words160_162[3];/* reserved words 160-162 */
194         unsigned short  cf_advanced_caps;
195         unsigned short  words164_255[92];/* reserved words 164-255 */
196 } hd_driveid_t;
197
198
199 /*
200  * PIO Mode Configuration
201  *
202  * See ATA-3 (AT Attachment-3 Interface) documentation, Figure 14 / Table 21
203  */
204
205 typedef struct {
206         unsigned int    t_setup;        /* Setup  Time in [ns] or clocks        */
207         unsigned int    t_length;       /* Length Time in [ns] or clocks        */
208         unsigned int    t_hold;         /* Hold   Time in [ns] or clocks        */
209 }
210 pio_config_t;
211
212 #define IDE_MAX_PIO_MODE        4       /* max suppurted PIO mode               */
213
214 /* ------------------------------------------------------------------------- */
215
216 #endif /* _ATA_H */