ata.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  1. /*
  2. * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
  3. * Copyright 2003-2004 Jeff Garzik
  4. *
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2, or (at your option)
  9. * any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; see the file COPYING. If not, write to
  18. * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19. *
  20. *
  21. * libata documentation is available via 'make {ps|pdf}docs',
  22. * as Documentation/DocBook/libata.*
  23. *
  24. * Hardware documentation available from http://www.t13.org/
  25. *
  26. */
  27. #ifndef __LINUX_ATA_H__
  28. #define __LINUX_ATA_H__
  29. #include <linux/types.h>
  30. /* defines only for the constants which don't work well as enums */
  31. #define ATA_DMA_BOUNDARY 0xffffUL
  32. #define ATA_DMA_MASK 0xffffffffULL
  33. enum {
  34. /* various global constants */
  35. ATA_MAX_DEVICES = 2, /* per bus/port */
  36. ATA_MAX_PRD = 256, /* we could make these 256/256 */
  37. ATA_SECT_SIZE = 512,
  38. ATA_MAX_SECTORS_128 = 128,
  39. ATA_MAX_SECTORS = 256,
  40. ATA_MAX_SECTORS_LBA48 = 65535,/* TODO: 65536? */
  41. ATA_ID_WORDS = 256,
  42. ATA_ID_SERNO = 10,
  43. ATA_ID_FW_REV = 23,
  44. ATA_ID_PROD = 27,
  45. ATA_ID_OLD_PIO_MODES = 51,
  46. ATA_ID_FIELD_VALID = 53,
  47. ATA_ID_MWDMA_MODES = 63,
  48. ATA_ID_PIO_MODES = 64,
  49. ATA_ID_EIDE_DMA_MIN = 65,
  50. ATA_ID_EIDE_PIO = 67,
  51. ATA_ID_EIDE_PIO_IORDY = 68,
  52. ATA_ID_UDMA_MODES = 88,
  53. ATA_ID_MAJOR_VER = 80,
  54. ATA_ID_PIO4 = (1 << 1),
  55. ATA_ID_SERNO_LEN = 20,
  56. ATA_ID_FW_REV_LEN = 8,
  57. ATA_ID_PROD_LEN = 40,
  58. ATA_PCI_CTL_OFS = 2,
  59. ATA_UDMA0 = (1 << 0),
  60. ATA_UDMA1 = ATA_UDMA0 | (1 << 1),
  61. ATA_UDMA2 = ATA_UDMA1 | (1 << 2),
  62. ATA_UDMA3 = ATA_UDMA2 | (1 << 3),
  63. ATA_UDMA4 = ATA_UDMA3 | (1 << 4),
  64. ATA_UDMA5 = ATA_UDMA4 | (1 << 5),
  65. ATA_UDMA6 = ATA_UDMA5 | (1 << 6),
  66. ATA_UDMA7 = ATA_UDMA6 | (1 << 7),
  67. /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
  68. ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
  69. /* DMA-related */
  70. ATA_PRD_SZ = 8,
  71. ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
  72. ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
  73. ATA_DMA_TABLE_OFS = 4,
  74. ATA_DMA_STATUS = 2,
  75. ATA_DMA_CMD = 0,
  76. ATA_DMA_WR = (1 << 3),
  77. ATA_DMA_START = (1 << 0),
  78. ATA_DMA_INTR = (1 << 2),
  79. ATA_DMA_ERR = (1 << 1),
  80. ATA_DMA_ACTIVE = (1 << 0),
  81. /* bits in ATA command block registers */
  82. ATA_HOB = (1 << 7), /* LBA48 selector */
  83. ATA_NIEN = (1 << 1), /* disable-irq flag */
  84. ATA_LBA = (1 << 6), /* LBA28 selector */
  85. ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
  86. ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */
  87. ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
  88. ATA_BUSY = (1 << 7), /* BSY status bit */
  89. ATA_DRDY = (1 << 6), /* device ready */
  90. ATA_DF = (1 << 5), /* device fault */
  91. ATA_DRQ = (1 << 3), /* data request i/o */
  92. ATA_ERR = (1 << 0), /* have an error */
  93. ATA_SRST = (1 << 2), /* software reset */
  94. ATA_ICRC = (1 << 7), /* interface CRC error */
  95. ATA_UNC = (1 << 6), /* uncorrectable media error */
  96. ATA_IDNF = (1 << 4), /* ID not found */
  97. ATA_ABORTED = (1 << 2), /* command aborted */
  98. /* ATA command block registers */
  99. ATA_REG_DATA = 0x00,
  100. ATA_REG_ERR = 0x01,
  101. ATA_REG_NSECT = 0x02,
  102. ATA_REG_LBAL = 0x03,
  103. ATA_REG_LBAM = 0x04,
  104. ATA_REG_LBAH = 0x05,
  105. ATA_REG_DEVICE = 0x06,
  106. ATA_REG_STATUS = 0x07,
  107. ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
  108. ATA_REG_CMD = ATA_REG_STATUS,
  109. ATA_REG_BYTEL = ATA_REG_LBAM,
  110. ATA_REG_BYTEH = ATA_REG_LBAH,
  111. ATA_REG_DEVSEL = ATA_REG_DEVICE,
  112. ATA_REG_IRQ = ATA_REG_NSECT,
  113. /* ATA device commands */
  114. ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
  115. ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
  116. ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
  117. ATA_CMD_EDD = 0x90, /* execute device diagnostic */
  118. ATA_CMD_FLUSH = 0xE7,
  119. ATA_CMD_FLUSH_EXT = 0xEA,
  120. ATA_CMD_ID_ATA = 0xEC,
  121. ATA_CMD_ID_ATAPI = 0xA1,
  122. ATA_CMD_READ = 0xC8,
  123. ATA_CMD_READ_EXT = 0x25,
  124. ATA_CMD_WRITE = 0xCA,
  125. ATA_CMD_WRITE_EXT = 0x35,
  126. ATA_CMD_WRITE_FUA_EXT = 0x3D,
  127. ATA_CMD_FPDMA_READ = 0x60,
  128. ATA_CMD_FPDMA_WRITE = 0x61,
  129. ATA_CMD_PIO_READ = 0x20,
  130. ATA_CMD_PIO_READ_EXT = 0x24,
  131. ATA_CMD_PIO_WRITE = 0x30,
  132. ATA_CMD_PIO_WRITE_EXT = 0x34,
  133. ATA_CMD_READ_MULTI = 0xC4,
  134. ATA_CMD_READ_MULTI_EXT = 0x29,
  135. ATA_CMD_WRITE_MULTI = 0xC5,
  136. ATA_CMD_WRITE_MULTI_EXT = 0x39,
  137. ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
  138. ATA_CMD_SET_FEATURES = 0xEF,
  139. ATA_CMD_PACKET = 0xA0,
  140. ATA_CMD_VERIFY = 0x40,
  141. ATA_CMD_VERIFY_EXT = 0x42,
  142. ATA_CMD_STANDBYNOW1 = 0xE0,
  143. ATA_CMD_IDLEIMMEDIATE = 0xE1,
  144. ATA_CMD_INIT_DEV_PARAMS = 0x91,
  145. ATA_CMD_READ_NATIVE_MAX = 0xF8,
  146. ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
  147. ATA_CMD_READ_LOG_EXT = 0x2f,
  148. /* READ_LOG_EXT pages */
  149. ATA_LOG_SATA_NCQ = 0x10,
  150. /* SETFEATURES stuff */
  151. SETFEATURES_XFER = 0x03,
  152. XFER_UDMA_7 = 0x47,
  153. XFER_UDMA_6 = 0x46,
  154. XFER_UDMA_5 = 0x45,
  155. XFER_UDMA_4 = 0x44,
  156. XFER_UDMA_3 = 0x43,
  157. XFER_UDMA_2 = 0x42,
  158. XFER_UDMA_1 = 0x41,
  159. XFER_UDMA_0 = 0x40,
  160. XFER_MW_DMA_4 = 0x24, /* CFA only */
  161. XFER_MW_DMA_3 = 0x23, /* CFA only */
  162. XFER_MW_DMA_2 = 0x22,
  163. XFER_MW_DMA_1 = 0x21,
  164. XFER_MW_DMA_0 = 0x20,
  165. XFER_SW_DMA_2 = 0x12,
  166. XFER_SW_DMA_1 = 0x11,
  167. XFER_SW_DMA_0 = 0x10,
  168. XFER_PIO_6 = 0x0E, /* CFA only */
  169. XFER_PIO_5 = 0x0D, /* CFA only */
  170. XFER_PIO_4 = 0x0C,
  171. XFER_PIO_3 = 0x0B,
  172. XFER_PIO_2 = 0x0A,
  173. XFER_PIO_1 = 0x09,
  174. XFER_PIO_0 = 0x08,
  175. XFER_PIO_SLOW = 0x00,
  176. SETFEATURES_WC_ON = 0x02, /* Enable write cache */
  177. SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
  178. /* ATAPI stuff */
  179. ATAPI_PKT_DMA = (1 << 0),
  180. ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
  181. 0=to device, 1=to host */
  182. ATAPI_CDB_LEN = 16,
  183. /* cable types */
  184. ATA_CBL_NONE = 0,
  185. ATA_CBL_PATA40 = 1,
  186. ATA_CBL_PATA80 = 2,
  187. ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */
  188. ATA_CBL_PATA_UNK = 4,
  189. ATA_CBL_SATA = 5,
  190. /* SATA Status and Control Registers */
  191. SCR_STATUS = 0,
  192. SCR_ERROR = 1,
  193. SCR_CONTROL = 2,
  194. SCR_ACTIVE = 3,
  195. SCR_NOTIFICATION = 4,
  196. /* SError bits */
  197. SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
  198. SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
  199. SERR_DATA = (1 << 8), /* unrecovered data error */
  200. SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
  201. SERR_PROTOCOL = (1 << 10), /* protocol violation */
  202. SERR_INTERNAL = (1 << 11), /* host internal error */
  203. SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
  204. SERR_DEV_XCHG = (1 << 26), /* device exchanged */
  205. /* struct ata_taskfile flags */
  206. ATA_TFLAG_LBA48 = (1 << 0), /* enable 48-bit LBA and "HOB" */
  207. ATA_TFLAG_ISADDR = (1 << 1), /* enable r/w to nsect/lba regs */
  208. ATA_TFLAG_DEVICE = (1 << 2), /* enable r/w to device reg */
  209. ATA_TFLAG_WRITE = (1 << 3), /* data dir: host->dev==1 (write) */
  210. ATA_TFLAG_LBA = (1 << 4), /* enable LBA */
  211. ATA_TFLAG_FUA = (1 << 5), /* enable FUA */
  212. ATA_TFLAG_POLLING = (1 << 6), /* set nIEN to 1 and use polling */
  213. };
  214. enum ata_tf_protocols {
  215. /* ATA taskfile protocols */
  216. ATA_PROT_UNKNOWN, /* unknown/invalid */
  217. ATA_PROT_NODATA, /* no data */
  218. ATA_PROT_PIO, /* PIO single sector */
  219. ATA_PROT_DMA, /* DMA */
  220. ATA_PROT_NCQ, /* NCQ */
  221. ATA_PROT_ATAPI, /* packet command, PIO data xfer*/
  222. ATA_PROT_ATAPI_NODATA, /* packet command, no data */
  223. ATA_PROT_ATAPI_DMA, /* packet command with special DMA sauce */
  224. };
  225. enum ata_ioctls {
  226. ATA_IOC_GET_IO32 = 0x309,
  227. ATA_IOC_SET_IO32 = 0x324,
  228. };
  229. /* core structures */
  230. struct ata_prd {
  231. u32 addr;
  232. u32 flags_len;
  233. };
  234. struct ata_taskfile {
  235. unsigned long flags; /* ATA_TFLAG_xxx */
  236. u8 protocol; /* ATA_PROT_xxx */
  237. u8 ctl; /* control reg */
  238. u8 hob_feature; /* additional data */
  239. u8 hob_nsect; /* to support LBA48 */
  240. u8 hob_lbal;
  241. u8 hob_lbam;
  242. u8 hob_lbah;
  243. u8 feature;
  244. u8 nsect;
  245. u8 lbal;
  246. u8 lbam;
  247. u8 lbah;
  248. u8 device;
  249. u8 command; /* IO operation */
  250. };
  251. #define ata_id_is_ata(id) (((id)[0] & (1 << 15)) == 0)
  252. #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
  253. #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
  254. #define ata_id_hpa_enabled(id) ((id)[85] & (1 << 10))
  255. #define ata_id_has_fua(id) ((id)[84] & (1 << 6))
  256. #define ata_id_has_flush(id) ((id)[83] & (1 << 12))
  257. #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
  258. #define ata_id_has_lba48(id) ((id)[83] & (1 << 10))
  259. #define ata_id_has_hpa(id) ((id)[82] & (1 << 10))
  260. #define ata_id_has_wcache(id) ((id)[82] & (1 << 5))
  261. #define ata_id_has_pm(id) ((id)[82] & (1 << 3))
  262. #define ata_id_has_lba(id) ((id)[49] & (1 << 9))
  263. #define ata_id_has_dma(id) ((id)[49] & (1 << 8))
  264. #define ata_id_has_ncq(id) ((id)[76] & (1 << 8))
  265. #define ata_id_queue_depth(id) (((id)[75] & 0x1f) + 1)
  266. #define ata_id_removeable(id) ((id)[0] & (1 << 7))
  267. #define ata_id_has_dword_io(id) ((id)[50] & (1 << 0))
  268. #define ata_id_iordy_disable(id) ((id)[49] & (1 << 10))
  269. #define ata_id_has_iordy(id) ((id)[49] & (1 << 9))
  270. #define ata_id_u32(id,n) \
  271. (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
  272. #define ata_id_u64(id,n) \
  273. ( ((u64) (id)[(n) + 3] << 48) | \
  274. ((u64) (id)[(n) + 2] << 32) | \
  275. ((u64) (id)[(n) + 1] << 16) | \
  276. ((u64) (id)[(n) + 0]) )
  277. #define ata_id_cdb_intr(id) (((id)[0] & 0x60) == 0x20)
  278. static inline unsigned int ata_id_major_version(const u16 *id)
  279. {
  280. unsigned int mver;
  281. if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
  282. return 0;
  283. for (mver = 14; mver >= 1; mver--)
  284. if (id[ATA_ID_MAJOR_VER] & (1 << mver))
  285. break;
  286. return mver;
  287. }
  288. static inline int ata_id_is_sata(const u16 *id)
  289. {
  290. return ata_id_major_version(id) >= 5 && id[93] == 0;
  291. }
  292. static inline int ata_id_current_chs_valid(const u16 *id)
  293. {
  294. /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
  295. has not been issued to the device then the values of
  296. id[54] to id[56] are vendor specific. */
  297. return (id[53] & 0x01) && /* Current translation valid */
  298. id[54] && /* cylinders in current translation */
  299. id[55] && /* heads in current translation */
  300. id[55] <= 16 &&
  301. id[56]; /* sectors in current translation */
  302. }
  303. static inline int ata_id_is_cfa(const u16 *id)
  304. {
  305. u16 v = id[0];
  306. if (v == 0x848A) /* Standard CF */
  307. return 1;
  308. /* Could be CF hiding as standard ATA */
  309. if (ata_id_major_version(id) >= 3 && id[82] != 0xFFFF &&
  310. (id[82] & ( 1 << 2)))
  311. return 1;
  312. return 0;
  313. }
  314. static inline int ata_drive_40wire(const u16 *dev_id)
  315. {
  316. if (ata_id_is_sata(dev_id))
  317. return 0; /* SATA */
  318. if ((dev_id[93] & 0xE000) == 0x6000)
  319. return 0; /* 80 wire */
  320. return 1;
  321. }
  322. static inline int atapi_cdb_len(const u16 *dev_id)
  323. {
  324. u16 tmp = dev_id[0] & 0x3;
  325. switch (tmp) {
  326. case 0: return 12;
  327. case 1: return 16;
  328. default: return -1;
  329. }
  330. }
  331. static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
  332. {
  333. return (tf->protocol == ATA_PROT_ATAPI) ||
  334. (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
  335. (tf->protocol == ATA_PROT_ATAPI_DMA);
  336. }
  337. static inline int is_multi_taskfile(struct ata_taskfile *tf)
  338. {
  339. return (tf->command == ATA_CMD_READ_MULTI) ||
  340. (tf->command == ATA_CMD_WRITE_MULTI) ||
  341. (tf->command == ATA_CMD_READ_MULTI_EXT) ||
  342. (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
  343. (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
  344. }
  345. static inline int ata_ok(u8 status)
  346. {
  347. return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
  348. == ATA_DRDY);
  349. }
  350. static inline int lba_28_ok(u64 block, u32 n_block)
  351. {
  352. /* check the ending block number */
  353. return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
  354. }
  355. static inline int lba_48_ok(u64 block, u32 n_block)
  356. {
  357. /* check the ending block number */
  358. return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
  359. }
  360. #endif /* __LINUX_ATA_H__ */