ata.h 10 KB

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