ata.h 9.7 KB

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