ata.h 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
  4. * Copyright 2003-2004 Jeff Garzik
  5. *
  6. * libata documentation is available via 'make {ps|pdf}docs',
  7. * as Documentation/driver-api/libata.rst
  8. *
  9. * Hardware documentation available from http://www.t13.org/
  10. */
  11. #ifndef __LINUX_ATA_H__
  12. #define __LINUX_ATA_H__
  13. #include <linux/bits.h>
  14. #include <linux/string.h>
  15. #include <linux/types.h>
  16. #include <asm/byteorder.h>
  17. /* defines only for the constants which don't work well as enums */
  18. #define ATA_DMA_BOUNDARY 0xffffUL
  19. #define ATA_DMA_MASK 0xffffffffULL
  20. enum {
  21. /* various global constants */
  22. ATA_MAX_DEVICES = 2, /* per bus/port */
  23. ATA_MAX_PRD = 256, /* we could make these 256/256 */
  24. ATA_SECT_SIZE = 512,
  25. ATA_MAX_SECTORS_128 = 128,
  26. ATA_MAX_SECTORS = 256,
  27. ATA_MAX_SECTORS_1024 = 1024,
  28. ATA_MAX_SECTORS_LBA48 = 65535,/* avoid count to be 0000h */
  29. ATA_MAX_SECTORS_TAPE = 65535,
  30. ATA_MAX_TRIM_RNUM = 64, /* 512-byte payload / (6-byte LBA + 2-byte range per entry) */
  31. ATA_ID_WORDS = 256,
  32. ATA_ID_CONFIG = 0,
  33. ATA_ID_CYLS = 1,
  34. ATA_ID_HEADS = 3,
  35. ATA_ID_SECTORS = 6,
  36. ATA_ID_SERNO = 10,
  37. ATA_ID_BUF_SIZE = 21,
  38. ATA_ID_FW_REV = 23,
  39. ATA_ID_PROD = 27,
  40. ATA_ID_MAX_MULTSECT = 47,
  41. ATA_ID_DWORD_IO = 48, /* before ATA-8 */
  42. ATA_ID_TRUSTED = 48, /* ATA-8 and later */
  43. ATA_ID_CAPABILITY = 49,
  44. ATA_ID_OLD_PIO_MODES = 51,
  45. ATA_ID_OLD_DMA_MODES = 52,
  46. ATA_ID_FIELD_VALID = 53,
  47. ATA_ID_CUR_CYLS = 54,
  48. ATA_ID_CUR_HEADS = 55,
  49. ATA_ID_CUR_SECTORS = 56,
  50. ATA_ID_MULTSECT = 59,
  51. ATA_ID_LBA_CAPACITY = 60,
  52. ATA_ID_SWDMA_MODES = 62,
  53. ATA_ID_MWDMA_MODES = 63,
  54. ATA_ID_PIO_MODES = 64,
  55. ATA_ID_EIDE_DMA_MIN = 65,
  56. ATA_ID_EIDE_DMA_TIME = 66,
  57. ATA_ID_EIDE_PIO = 67,
  58. ATA_ID_EIDE_PIO_IORDY = 68,
  59. ATA_ID_ADDITIONAL_SUPP = 69,
  60. ATA_ID_QUEUE_DEPTH = 75,
  61. ATA_ID_SATA_CAPABILITY = 76,
  62. ATA_ID_SATA_CAPABILITY_2 = 77,
  63. ATA_ID_FEATURE_SUPP = 78,
  64. ATA_ID_MAJOR_VER = 80,
  65. ATA_ID_COMMAND_SET_1 = 82,
  66. ATA_ID_COMMAND_SET_2 = 83,
  67. ATA_ID_CFSSE = 84,
  68. ATA_ID_CFS_ENABLE_1 = 85,
  69. ATA_ID_CFS_ENABLE_2 = 86,
  70. ATA_ID_CSF_DEFAULT = 87,
  71. ATA_ID_UDMA_MODES = 88,
  72. ATA_ID_HW_CONFIG = 93,
  73. ATA_ID_SPG = 98,
  74. ATA_ID_LBA_CAPACITY_2 = 100,
  75. ATA_ID_SECTOR_SIZE = 106,
  76. ATA_ID_WWN = 108,
  77. ATA_ID_LOGICAL_SECTOR_SIZE = 117, /* and 118 */
  78. ATA_ID_COMMAND_SET_3 = 119,
  79. ATA_ID_COMMAND_SET_4 = 120,
  80. ATA_ID_LAST_LUN = 126,
  81. ATA_ID_DLF = 128,
  82. ATA_ID_CSFO = 129,
  83. ATA_ID_CFA_POWER = 160,
  84. ATA_ID_CFA_KEY_MGMT = 162,
  85. ATA_ID_CFA_MODES = 163,
  86. ATA_ID_DATA_SET_MGMT = 169,
  87. ATA_ID_SCT_CMD_XPORT = 206,
  88. ATA_ID_ROT_SPEED = 217,
  89. ATA_ID_PIO4 = (1 << 1),
  90. ATA_ID_SERNO_LEN = 20,
  91. ATA_ID_FW_REV_LEN = 8,
  92. ATA_ID_PROD_LEN = 40,
  93. ATA_ID_WWN_LEN = 8,
  94. ATA_PCI_CTL_OFS = 2,
  95. ATA_PIO0 = (1 << 0),
  96. ATA_PIO1 = ATA_PIO0 | (1 << 1),
  97. ATA_PIO2 = ATA_PIO1 | (1 << 2),
  98. ATA_PIO3 = ATA_PIO2 | (1 << 3),
  99. ATA_PIO4 = ATA_PIO3 | (1 << 4),
  100. ATA_PIO5 = ATA_PIO4 | (1 << 5),
  101. ATA_PIO6 = ATA_PIO5 | (1 << 6),
  102. ATA_PIO4_ONLY = (1 << 4),
  103. ATA_SWDMA0 = (1 << 0),
  104. ATA_SWDMA1 = ATA_SWDMA0 | (1 << 1),
  105. ATA_SWDMA2 = ATA_SWDMA1 | (1 << 2),
  106. ATA_SWDMA2_ONLY = (1 << 2),
  107. ATA_MWDMA0 = (1 << 0),
  108. ATA_MWDMA1 = ATA_MWDMA0 | (1 << 1),
  109. ATA_MWDMA2 = ATA_MWDMA1 | (1 << 2),
  110. ATA_MWDMA3 = ATA_MWDMA2 | (1 << 3),
  111. ATA_MWDMA4 = ATA_MWDMA3 | (1 << 4),
  112. ATA_MWDMA12_ONLY = (1 << 1) | (1 << 2),
  113. ATA_MWDMA2_ONLY = (1 << 2),
  114. ATA_UDMA0 = (1 << 0),
  115. ATA_UDMA1 = ATA_UDMA0 | (1 << 1),
  116. ATA_UDMA2 = ATA_UDMA1 | (1 << 2),
  117. ATA_UDMA3 = ATA_UDMA2 | (1 << 3),
  118. ATA_UDMA4 = ATA_UDMA3 | (1 << 4),
  119. ATA_UDMA5 = ATA_UDMA4 | (1 << 5),
  120. ATA_UDMA6 = ATA_UDMA5 | (1 << 6),
  121. ATA_UDMA7 = ATA_UDMA6 | (1 << 7),
  122. /* ATA_UDMA7 is just for completeness... doesn't exist (yet?). */
  123. ATA_UDMA24_ONLY = (1 << 2) | (1 << 4),
  124. ATA_UDMA_MASK_40C = ATA_UDMA2, /* udma0-2 */
  125. /* DMA-related */
  126. ATA_PRD_SZ = 8,
  127. ATA_PRD_TBL_SZ = (ATA_MAX_PRD * ATA_PRD_SZ),
  128. ATA_PRD_EOT = (1 << 31), /* end-of-table flag */
  129. ATA_DMA_TABLE_OFS = 4,
  130. ATA_DMA_STATUS = 2,
  131. ATA_DMA_CMD = 0,
  132. ATA_DMA_WR = (1 << 3),
  133. ATA_DMA_START = (1 << 0),
  134. ATA_DMA_INTR = (1 << 2),
  135. ATA_DMA_ERR = (1 << 1),
  136. ATA_DMA_ACTIVE = (1 << 0),
  137. /* bits in ATA command block registers */
  138. ATA_HOB = (1 << 7), /* LBA48 selector */
  139. ATA_NIEN = (1 << 1), /* disable-irq flag */
  140. ATA_LBA = (1 << 6), /* LBA28 selector */
  141. ATA_DEV1 = (1 << 4), /* Select Device 1 (slave) */
  142. ATA_DEVICE_OBS = (1 << 7) | (1 << 5), /* obs bits in dev reg */
  143. ATA_DEVCTL_OBS = (1 << 3), /* obsolete bit in devctl reg */
  144. ATA_BUSY = (1 << 7), /* BSY status bit */
  145. ATA_DRDY = (1 << 6), /* device ready */
  146. ATA_DF = (1 << 5), /* device fault */
  147. ATA_DSC = (1 << 4), /* drive seek complete */
  148. ATA_DRQ = (1 << 3), /* data request i/o */
  149. ATA_CORR = (1 << 2), /* corrected data error */
  150. ATA_SENSE = (1 << 1), /* sense code available */
  151. ATA_ERR = (1 << 0), /* have an error */
  152. ATA_SRST = (1 << 2), /* software reset */
  153. ATA_ICRC = (1 << 7), /* interface CRC error */
  154. ATA_BBK = ATA_ICRC, /* pre-EIDE: block marked bad */
  155. ATA_UNC = (1 << 6), /* uncorrectable media error */
  156. ATA_MC = (1 << 5), /* media changed */
  157. ATA_IDNF = (1 << 4), /* ID not found */
  158. ATA_MCR = (1 << 3), /* media change requested */
  159. ATA_ABORTED = (1 << 2), /* command aborted */
  160. ATA_TRK0NF = (1 << 1), /* track 0 not found */
  161. ATA_AMNF = (1 << 0), /* address mark not found */
  162. ATAPI_LFS = 0xF0, /* last failed sense */
  163. ATAPI_EOM = ATA_TRK0NF, /* end of media */
  164. ATAPI_ILI = ATA_AMNF, /* illegal length indication */
  165. ATAPI_IO = (1 << 1),
  166. ATAPI_COD = (1 << 0),
  167. /* ATA command block registers */
  168. ATA_REG_DATA = 0x00,
  169. ATA_REG_ERR = 0x01,
  170. ATA_REG_NSECT = 0x02,
  171. ATA_REG_LBAL = 0x03,
  172. ATA_REG_LBAM = 0x04,
  173. ATA_REG_LBAH = 0x05,
  174. ATA_REG_DEVICE = 0x06,
  175. ATA_REG_STATUS = 0x07,
  176. ATA_REG_FEATURE = ATA_REG_ERR, /* and their aliases */
  177. ATA_REG_CMD = ATA_REG_STATUS,
  178. ATA_REG_BYTEL = ATA_REG_LBAM,
  179. ATA_REG_BYTEH = ATA_REG_LBAH,
  180. ATA_REG_DEVSEL = ATA_REG_DEVICE,
  181. ATA_REG_IRQ = ATA_REG_NSECT,
  182. /* ATA device commands */
  183. ATA_CMD_DEV_RESET = 0x08, /* ATAPI device reset */
  184. ATA_CMD_CHK_POWER = 0xE5, /* check power mode */
  185. ATA_CMD_STANDBY = 0xE2, /* place in standby power mode */
  186. ATA_CMD_IDLE = 0xE3, /* place in idle power mode */
  187. ATA_CMD_EDD = 0x90, /* execute device diagnostic */
  188. ATA_CMD_DOWNLOAD_MICRO = 0x92,
  189. ATA_CMD_DOWNLOAD_MICRO_DMA = 0x93,
  190. ATA_CMD_NOP = 0x00,
  191. ATA_CMD_FLUSH = 0xE7,
  192. ATA_CMD_FLUSH_EXT = 0xEA,
  193. ATA_CMD_ID_ATA = 0xEC,
  194. ATA_CMD_ID_ATAPI = 0xA1,
  195. ATA_CMD_SERVICE = 0xA2,
  196. ATA_CMD_READ = 0xC8,
  197. ATA_CMD_READ_EXT = 0x25,
  198. ATA_CMD_READ_QUEUED = 0x26,
  199. ATA_CMD_READ_STREAM_EXT = 0x2B,
  200. ATA_CMD_READ_STREAM_DMA_EXT = 0x2A,
  201. ATA_CMD_WRITE = 0xCA,
  202. ATA_CMD_WRITE_EXT = 0x35,
  203. ATA_CMD_WRITE_QUEUED = 0x36,
  204. ATA_CMD_WRITE_STREAM_EXT = 0x3B,
  205. ATA_CMD_WRITE_STREAM_DMA_EXT = 0x3A,
  206. ATA_CMD_WRITE_FUA_EXT = 0x3D,
  207. ATA_CMD_WRITE_QUEUED_FUA_EXT = 0x3E,
  208. ATA_CMD_FPDMA_READ = 0x60,
  209. ATA_CMD_FPDMA_WRITE = 0x61,
  210. ATA_CMD_NCQ_NON_DATA = 0x63,
  211. ATA_CMD_FPDMA_SEND = 0x64,
  212. ATA_CMD_FPDMA_RECV = 0x65,
  213. ATA_CMD_PIO_READ = 0x20,
  214. ATA_CMD_PIO_READ_EXT = 0x24,
  215. ATA_CMD_PIO_WRITE = 0x30,
  216. ATA_CMD_PIO_WRITE_EXT = 0x34,
  217. ATA_CMD_READ_MULTI = 0xC4,
  218. ATA_CMD_READ_MULTI_EXT = 0x29,
  219. ATA_CMD_WRITE_MULTI = 0xC5,
  220. ATA_CMD_WRITE_MULTI_EXT = 0x39,
  221. ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
  222. ATA_CMD_SET_FEATURES = 0xEF,
  223. ATA_CMD_SET_MULTI = 0xC6,
  224. ATA_CMD_PACKET = 0xA0,
  225. ATA_CMD_VERIFY = 0x40,
  226. ATA_CMD_VERIFY_EXT = 0x42,
  227. ATA_CMD_WRITE_UNCORR_EXT = 0x45,
  228. ATA_CMD_STANDBYNOW1 = 0xE0,
  229. ATA_CMD_IDLEIMMEDIATE = 0xE1,
  230. ATA_CMD_SLEEP = 0xE6,
  231. ATA_CMD_INIT_DEV_PARAMS = 0x91,
  232. ATA_CMD_READ_NATIVE_MAX = 0xF8,
  233. ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
  234. ATA_CMD_SET_MAX = 0xF9,
  235. ATA_CMD_SET_MAX_EXT = 0x37,
  236. ATA_CMD_READ_LOG_EXT = 0x2F,
  237. ATA_CMD_WRITE_LOG_EXT = 0x3F,
  238. ATA_CMD_READ_LOG_DMA_EXT = 0x47,
  239. ATA_CMD_WRITE_LOG_DMA_EXT = 0x57,
  240. ATA_CMD_TRUSTED_NONDATA = 0x5B,
  241. ATA_CMD_TRUSTED_RCV = 0x5C,
  242. ATA_CMD_TRUSTED_RCV_DMA = 0x5D,
  243. ATA_CMD_TRUSTED_SND = 0x5E,
  244. ATA_CMD_TRUSTED_SND_DMA = 0x5F,
  245. ATA_CMD_PMP_READ = 0xE4,
  246. ATA_CMD_PMP_READ_DMA = 0xE9,
  247. ATA_CMD_PMP_WRITE = 0xE8,
  248. ATA_CMD_PMP_WRITE_DMA = 0xEB,
  249. ATA_CMD_CONF_OVERLAY = 0xB1,
  250. ATA_CMD_SEC_SET_PASS = 0xF1,
  251. ATA_CMD_SEC_UNLOCK = 0xF2,
  252. ATA_CMD_SEC_ERASE_PREP = 0xF3,
  253. ATA_CMD_SEC_ERASE_UNIT = 0xF4,
  254. ATA_CMD_SEC_FREEZE_LOCK = 0xF5,
  255. ATA_CMD_SEC_DISABLE_PASS = 0xF6,
  256. ATA_CMD_CONFIG_STREAM = 0x51,
  257. ATA_CMD_SMART = 0xB0,
  258. ATA_CMD_MEDIA_LOCK = 0xDE,
  259. ATA_CMD_MEDIA_UNLOCK = 0xDF,
  260. ATA_CMD_DSM = 0x06,
  261. ATA_CMD_CHK_MED_CRD_TYP = 0xD1,
  262. ATA_CMD_CFA_REQ_EXT_ERR = 0x03,
  263. ATA_CMD_CFA_WRITE_NE = 0x38,
  264. ATA_CMD_CFA_TRANS_SECT = 0x87,
  265. ATA_CMD_CFA_ERASE = 0xC0,
  266. ATA_CMD_CFA_WRITE_MULT_NE = 0xCD,
  267. ATA_CMD_REQ_SENSE_DATA = 0x0B,
  268. ATA_CMD_SANITIZE_DEVICE = 0xB4,
  269. ATA_CMD_ZAC_MGMT_IN = 0x4A,
  270. ATA_CMD_ZAC_MGMT_OUT = 0x9F,
  271. /* marked obsolete in the ATA/ATAPI-7 spec */
  272. ATA_CMD_RESTORE = 0x10,
  273. /* Subcmds for ATA_CMD_FPDMA_RECV */
  274. ATA_SUBCMD_FPDMA_RECV_RD_LOG_DMA_EXT = 0x01,
  275. ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN = 0x02,
  276. /* Subcmds for ATA_CMD_FPDMA_SEND */
  277. ATA_SUBCMD_FPDMA_SEND_DSM = 0x00,
  278. ATA_SUBCMD_FPDMA_SEND_WR_LOG_DMA_EXT = 0x02,
  279. /* Subcmds for ATA_CMD_NCQ_NON_DATA */
  280. ATA_SUBCMD_NCQ_NON_DATA_ABORT_QUEUE = 0x00,
  281. ATA_SUBCMD_NCQ_NON_DATA_SET_FEATURES = 0x05,
  282. ATA_SUBCMD_NCQ_NON_DATA_ZERO_EXT = 0x06,
  283. ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT = 0x07,
  284. /* Subcmds for ATA_CMD_ZAC_MGMT_IN */
  285. ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES = 0x00,
  286. /* Subcmds for ATA_CMD_ZAC_MGMT_OUT */
  287. ATA_SUBCMD_ZAC_MGMT_OUT_CLOSE_ZONE = 0x01,
  288. ATA_SUBCMD_ZAC_MGMT_OUT_FINISH_ZONE = 0x02,
  289. ATA_SUBCMD_ZAC_MGMT_OUT_OPEN_ZONE = 0x03,
  290. ATA_SUBCMD_ZAC_MGMT_OUT_RESET_WRITE_POINTER = 0x04,
  291. /* READ_LOG_EXT pages */
  292. ATA_LOG_DIRECTORY = 0x0,
  293. ATA_LOG_SATA_NCQ = 0x10,
  294. ATA_LOG_NCQ_NON_DATA = 0x12,
  295. ATA_LOG_NCQ_SEND_RECV = 0x13,
  296. ATA_LOG_IDENTIFY_DEVICE = 0x30,
  297. ATA_LOG_CONCURRENT_POSITIONING_RANGES = 0x47,
  298. /* Identify device log pages: */
  299. ATA_LOG_SECURITY = 0x06,
  300. ATA_LOG_SATA_SETTINGS = 0x08,
  301. ATA_LOG_ZONED_INFORMATION = 0x09,
  302. /* Identify device SATA settings log:*/
  303. ATA_LOG_DEVSLP_OFFSET = 0x30,
  304. ATA_LOG_DEVSLP_SIZE = 0x08,
  305. ATA_LOG_DEVSLP_MDAT = 0x00,
  306. ATA_LOG_DEVSLP_MDAT_MASK = 0x1F,
  307. ATA_LOG_DEVSLP_DETO = 0x01,
  308. ATA_LOG_DEVSLP_VALID = 0x07,
  309. ATA_LOG_DEVSLP_VALID_MASK = 0x80,
  310. ATA_LOG_NCQ_PRIO_OFFSET = 0x09,
  311. /* NCQ send and receive log */
  312. ATA_LOG_NCQ_SEND_RECV_SUBCMDS_OFFSET = 0x00,
  313. ATA_LOG_NCQ_SEND_RECV_SUBCMDS_DSM = (1 << 0),
  314. ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET = 0x04,
  315. ATA_LOG_NCQ_SEND_RECV_DSM_TRIM = (1 << 0),
  316. ATA_LOG_NCQ_SEND_RECV_RD_LOG_OFFSET = 0x08,
  317. ATA_LOG_NCQ_SEND_RECV_RD_LOG_SUPPORTED = (1 << 0),
  318. ATA_LOG_NCQ_SEND_RECV_WR_LOG_OFFSET = 0x0C,
  319. ATA_LOG_NCQ_SEND_RECV_WR_LOG_SUPPORTED = (1 << 0),
  320. ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OFFSET = 0x10,
  321. ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_OUT_SUPPORTED = (1 << 0),
  322. ATA_LOG_NCQ_SEND_RECV_ZAC_MGMT_IN_SUPPORTED = (1 << 1),
  323. ATA_LOG_NCQ_SEND_RECV_SIZE = 0x14,
  324. /* NCQ Non-Data log */
  325. ATA_LOG_NCQ_NON_DATA_SUBCMDS_OFFSET = 0x00,
  326. ATA_LOG_NCQ_NON_DATA_ABORT_OFFSET = 0x00,
  327. ATA_LOG_NCQ_NON_DATA_ABORT_NCQ = (1 << 0),
  328. ATA_LOG_NCQ_NON_DATA_ABORT_ALL = (1 << 1),
  329. ATA_LOG_NCQ_NON_DATA_ABORT_STREAMING = (1 << 2),
  330. ATA_LOG_NCQ_NON_DATA_ABORT_NON_STREAMING = (1 << 3),
  331. ATA_LOG_NCQ_NON_DATA_ABORT_SELECTED = (1 << 4),
  332. ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OFFSET = 0x1C,
  333. ATA_LOG_NCQ_NON_DATA_ZAC_MGMT_OUT = (1 << 0),
  334. ATA_LOG_NCQ_NON_DATA_SIZE = 0x40,
  335. /* READ/WRITE LONG (obsolete) */
  336. ATA_CMD_READ_LONG = 0x22,
  337. ATA_CMD_READ_LONG_ONCE = 0x23,
  338. ATA_CMD_WRITE_LONG = 0x32,
  339. ATA_CMD_WRITE_LONG_ONCE = 0x33,
  340. /* SETFEATURES stuff */
  341. SETFEATURES_XFER = 0x03,
  342. XFER_UDMA_7 = 0x47,
  343. XFER_UDMA_6 = 0x46,
  344. XFER_UDMA_5 = 0x45,
  345. XFER_UDMA_4 = 0x44,
  346. XFER_UDMA_3 = 0x43,
  347. XFER_UDMA_2 = 0x42,
  348. XFER_UDMA_1 = 0x41,
  349. XFER_UDMA_0 = 0x40,
  350. XFER_MW_DMA_4 = 0x24, /* CFA only */
  351. XFER_MW_DMA_3 = 0x23, /* CFA only */
  352. XFER_MW_DMA_2 = 0x22,
  353. XFER_MW_DMA_1 = 0x21,
  354. XFER_MW_DMA_0 = 0x20,
  355. XFER_SW_DMA_2 = 0x12,
  356. XFER_SW_DMA_1 = 0x11,
  357. XFER_SW_DMA_0 = 0x10,
  358. XFER_PIO_6 = 0x0E, /* CFA only */
  359. XFER_PIO_5 = 0x0D, /* CFA only */
  360. XFER_PIO_4 = 0x0C,
  361. XFER_PIO_3 = 0x0B,
  362. XFER_PIO_2 = 0x0A,
  363. XFER_PIO_1 = 0x09,
  364. XFER_PIO_0 = 0x08,
  365. XFER_PIO_SLOW = 0x00,
  366. SETFEATURES_WC_ON = 0x02, /* Enable write cache */
  367. SETFEATURES_WC_OFF = 0x82, /* Disable write cache */
  368. SETFEATURES_RA_ON = 0xaa, /* Enable read look-ahead */
  369. SETFEATURES_RA_OFF = 0x55, /* Disable read look-ahead */
  370. /* Enable/Disable Automatic Acoustic Management */
  371. SETFEATURES_AAM_ON = 0x42,
  372. SETFEATURES_AAM_OFF = 0xC2,
  373. SETFEATURES_SPINUP = 0x07, /* Spin-up drive */
  374. SETFEATURES_SPINUP_TIMEOUT = 30000, /* 30s timeout for drive spin-up from PUIS */
  375. SETFEATURES_SATA_ENABLE = 0x10, /* Enable use of SATA feature */
  376. SETFEATURES_SATA_DISABLE = 0x90, /* Disable use of SATA feature */
  377. /* SETFEATURE Sector counts for SATA features */
  378. SATA_FPDMA_OFFSET = 0x01, /* FPDMA non-zero buffer offsets */
  379. SATA_FPDMA_AA = 0x02, /* FPDMA Setup FIS Auto-Activate */
  380. SATA_DIPM = 0x03, /* Device Initiated Power Management */
  381. SATA_FPDMA_IN_ORDER = 0x04, /* FPDMA in-order data delivery */
  382. SATA_AN = 0x05, /* Asynchronous Notification */
  383. SATA_SSP = 0x06, /* Software Settings Preservation */
  384. SATA_DEVSLP = 0x09, /* Device Sleep */
  385. SETFEATURE_SENSE_DATA = 0xC3, /* Sense Data Reporting feature */
  386. /* feature values for SET_MAX */
  387. ATA_SET_MAX_ADDR = 0x00,
  388. ATA_SET_MAX_PASSWD = 0x01,
  389. ATA_SET_MAX_LOCK = 0x02,
  390. ATA_SET_MAX_UNLOCK = 0x03,
  391. ATA_SET_MAX_FREEZE_LOCK = 0x04,
  392. ATA_SET_MAX_PASSWD_DMA = 0x05,
  393. ATA_SET_MAX_UNLOCK_DMA = 0x06,
  394. /* feature values for DEVICE CONFIGURATION OVERLAY */
  395. ATA_DCO_RESTORE = 0xC0,
  396. ATA_DCO_FREEZE_LOCK = 0xC1,
  397. ATA_DCO_IDENTIFY = 0xC2,
  398. ATA_DCO_SET = 0xC3,
  399. /* feature values for SMART */
  400. ATA_SMART_ENABLE = 0xD8,
  401. ATA_SMART_READ_VALUES = 0xD0,
  402. ATA_SMART_READ_THRESHOLDS = 0xD1,
  403. /* feature values for Data Set Management */
  404. ATA_DSM_TRIM = 0x01,
  405. /* password used in LBA Mid / LBA High for executing SMART commands */
  406. ATA_SMART_LBAM_PASS = 0x4F,
  407. ATA_SMART_LBAH_PASS = 0xC2,
  408. /* ATAPI stuff */
  409. ATAPI_PKT_DMA = (1 << 0),
  410. ATAPI_DMADIR = (1 << 2), /* ATAPI data dir:
  411. 0=to device, 1=to host */
  412. ATAPI_CDB_LEN = 16,
  413. /* PMP stuff */
  414. SATA_PMP_MAX_PORTS = 15,
  415. SATA_PMP_CTRL_PORT = 15,
  416. SATA_PMP_GSCR_DWORDS = 128,
  417. SATA_PMP_GSCR_PROD_ID = 0,
  418. SATA_PMP_GSCR_REV = 1,
  419. SATA_PMP_GSCR_PORT_INFO = 2,
  420. SATA_PMP_GSCR_ERROR = 32,
  421. SATA_PMP_GSCR_ERROR_EN = 33,
  422. SATA_PMP_GSCR_FEAT = 64,
  423. SATA_PMP_GSCR_FEAT_EN = 96,
  424. SATA_PMP_PSCR_STATUS = 0,
  425. SATA_PMP_PSCR_ERROR = 1,
  426. SATA_PMP_PSCR_CONTROL = 2,
  427. SATA_PMP_FEAT_BIST = (1 << 0),
  428. SATA_PMP_FEAT_PMREQ = (1 << 1),
  429. SATA_PMP_FEAT_DYNSSC = (1 << 2),
  430. SATA_PMP_FEAT_NOTIFY = (1 << 3),
  431. /* cable types */
  432. ATA_CBL_NONE = 0,
  433. ATA_CBL_PATA40 = 1,
  434. ATA_CBL_PATA80 = 2,
  435. ATA_CBL_PATA40_SHORT = 3, /* 40 wire cable to high UDMA spec */
  436. ATA_CBL_PATA_UNK = 4, /* don't know, maybe 80c? */
  437. ATA_CBL_PATA_IGN = 5, /* don't know, ignore cable handling */
  438. ATA_CBL_SATA = 6,
  439. /* SATA Status and Control Registers */
  440. SCR_STATUS = 0,
  441. SCR_ERROR = 1,
  442. SCR_CONTROL = 2,
  443. SCR_ACTIVE = 3,
  444. SCR_NOTIFICATION = 4,
  445. /* SError bits */
  446. SERR_DATA_RECOVERED = (1 << 0), /* recovered data error */
  447. SERR_COMM_RECOVERED = (1 << 1), /* recovered comm failure */
  448. SERR_DATA = (1 << 8), /* unrecovered data error */
  449. SERR_PERSISTENT = (1 << 9), /* persistent data/comm error */
  450. SERR_PROTOCOL = (1 << 10), /* protocol violation */
  451. SERR_INTERNAL = (1 << 11), /* host internal error */
  452. SERR_PHYRDY_CHG = (1 << 16), /* PHY RDY changed */
  453. SERR_PHY_INT_ERR = (1 << 17), /* PHY internal error */
  454. SERR_COMM_WAKE = (1 << 18), /* Comm wake */
  455. SERR_10B_8B_ERR = (1 << 19), /* 10b to 8b decode error */
  456. SERR_DISPARITY = (1 << 20), /* Disparity */
  457. SERR_CRC = (1 << 21), /* CRC error */
  458. SERR_HANDSHAKE = (1 << 22), /* Handshake error */
  459. SERR_LINK_SEQ_ERR = (1 << 23), /* Link sequence error */
  460. SERR_TRANS_ST_ERROR = (1 << 24), /* Transport state trans. error */
  461. SERR_UNRECOG_FIS = (1 << 25), /* Unrecognized FIS */
  462. SERR_DEV_XCHG = (1 << 26), /* device exchanged */
  463. };
  464. enum ata_prot_flags {
  465. /* protocol flags */
  466. ATA_PROT_FLAG_PIO = (1 << 0), /* is PIO */
  467. ATA_PROT_FLAG_DMA = (1 << 1), /* is DMA */
  468. ATA_PROT_FLAG_NCQ = (1 << 2), /* is NCQ */
  469. ATA_PROT_FLAG_ATAPI = (1 << 3), /* is ATAPI */
  470. /* taskfile protocols */
  471. ATA_PROT_UNKNOWN = (u8)-1,
  472. ATA_PROT_NODATA = 0,
  473. ATA_PROT_PIO = ATA_PROT_FLAG_PIO,
  474. ATA_PROT_DMA = ATA_PROT_FLAG_DMA,
  475. ATA_PROT_NCQ_NODATA = ATA_PROT_FLAG_NCQ,
  476. ATA_PROT_NCQ = ATA_PROT_FLAG_DMA | ATA_PROT_FLAG_NCQ,
  477. ATAPI_PROT_NODATA = ATA_PROT_FLAG_ATAPI,
  478. ATAPI_PROT_PIO = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_PIO,
  479. ATAPI_PROT_DMA = ATA_PROT_FLAG_ATAPI | ATA_PROT_FLAG_DMA,
  480. };
  481. enum ata_ioctls {
  482. ATA_IOC_GET_IO32 = 0x309, /* HDIO_GET_32BIT */
  483. ATA_IOC_SET_IO32 = 0x324, /* HDIO_SET_32BIT */
  484. };
  485. /* core structures */
  486. struct ata_bmdma_prd {
  487. __le32 addr;
  488. __le32 flags_len;
  489. };
  490. /*
  491. * id tests
  492. */
  493. #define ata_id_is_ata(id) (((id)[ATA_ID_CONFIG] & (1 << 15)) == 0)
  494. #define ata_id_has_lba(id) ((id)[ATA_ID_CAPABILITY] & (1 << 9))
  495. #define ata_id_has_dma(id) ((id)[ATA_ID_CAPABILITY] & (1 << 8))
  496. #define ata_id_has_ncq(id) ((id)[ATA_ID_SATA_CAPABILITY] & (1 << 8))
  497. #define ata_id_queue_depth(id) (((id)[ATA_ID_QUEUE_DEPTH] & 0x1f) + 1)
  498. #define ata_id_removable(id) ((id)[ATA_ID_CONFIG] & (1 << 7))
  499. #define ata_id_has_atapi_AN(id) \
  500. ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
  501. ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
  502. ((id)[ATA_ID_FEATURE_SUPP] & (1 << 5)))
  503. #define ata_id_has_fpdma_aa(id) \
  504. ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
  505. ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
  506. ((id)[ATA_ID_FEATURE_SUPP] & (1 << 2)))
  507. #define ata_id_has_devslp(id) \
  508. ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
  509. ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
  510. ((id)[ATA_ID_FEATURE_SUPP] & (1 << 8)))
  511. #define ata_id_has_ncq_autosense(id) \
  512. ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
  513. ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
  514. ((id)[ATA_ID_FEATURE_SUPP] & (1 << 7)))
  515. #define ata_id_has_dipm(id) \
  516. ((((id)[ATA_ID_SATA_CAPABILITY] != 0x0000) && \
  517. ((id)[ATA_ID_SATA_CAPABILITY] != 0xffff)) && \
  518. ((id)[ATA_ID_FEATURE_SUPP] & (1 << 3)))
  519. #define ata_id_iordy_disable(id) ((id)[ATA_ID_CAPABILITY] & (1 << 10))
  520. #define ata_id_has_iordy(id) ((id)[ATA_ID_CAPABILITY] & (1 << 11))
  521. #define ata_id_u32(id,n) \
  522. (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
  523. #define ata_id_u64(id,n) \
  524. ( ((u64) (id)[(n) + 3] << 48) | \
  525. ((u64) (id)[(n) + 2] << 32) | \
  526. ((u64) (id)[(n) + 1] << 16) | \
  527. ((u64) (id)[(n) + 0]) )
  528. #define ata_id_cdb_intr(id) (((id)[ATA_ID_CONFIG] & 0x60) == 0x20)
  529. #define ata_id_has_da(id) ((id)[ATA_ID_SATA_CAPABILITY_2] & (1 << 4))
  530. static inline bool ata_id_has_hipm(const u16 *id)
  531. {
  532. u16 val = id[ATA_ID_SATA_CAPABILITY];
  533. if (val == 0 || val == 0xffff)
  534. return false;
  535. return val & (1 << 9);
  536. }
  537. static inline bool ata_id_has_fua(const u16 *id)
  538. {
  539. if ((id[ATA_ID_CFSSE] & 0xC000) != 0x4000)
  540. return false;
  541. return id[ATA_ID_CFSSE] & (1 << 6);
  542. }
  543. static inline bool ata_id_has_flush(const u16 *id)
  544. {
  545. if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
  546. return false;
  547. return id[ATA_ID_COMMAND_SET_2] & (1 << 12);
  548. }
  549. static inline bool ata_id_flush_enabled(const u16 *id)
  550. {
  551. if (ata_id_has_flush(id) == 0)
  552. return false;
  553. if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
  554. return false;
  555. return id[ATA_ID_CFS_ENABLE_2] & (1 << 12);
  556. }
  557. static inline bool ata_id_has_flush_ext(const u16 *id)
  558. {
  559. if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
  560. return false;
  561. return id[ATA_ID_COMMAND_SET_2] & (1 << 13);
  562. }
  563. static inline bool ata_id_flush_ext_enabled(const u16 *id)
  564. {
  565. if (ata_id_has_flush_ext(id) == 0)
  566. return false;
  567. if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
  568. return false;
  569. /*
  570. * some Maxtor disks have bit 13 defined incorrectly
  571. * so check bit 10 too
  572. */
  573. return (id[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400;
  574. }
  575. static inline u32 ata_id_logical_sector_size(const u16 *id)
  576. {
  577. /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
  578. * IDENTIFY DEVICE data, word 117-118.
  579. * 0xd000 ignores bit 13 (logical:physical > 1)
  580. */
  581. if ((id[ATA_ID_SECTOR_SIZE] & 0xd000) == 0x5000)
  582. return (((id[ATA_ID_LOGICAL_SECTOR_SIZE+1] << 16)
  583. + id[ATA_ID_LOGICAL_SECTOR_SIZE]) * sizeof(u16)) ;
  584. return ATA_SECT_SIZE;
  585. }
  586. static inline u8 ata_id_log2_per_physical_sector(const u16 *id)
  587. {
  588. /* T13/1699-D Revision 6a, Sep 6, 2008. Page 128.
  589. * IDENTIFY DEVICE data, word 106.
  590. * 0xe000 ignores bit 12 (logical sector > 512 bytes)
  591. */
  592. if ((id[ATA_ID_SECTOR_SIZE] & 0xe000) == 0x6000)
  593. return (id[ATA_ID_SECTOR_SIZE] & 0xf);
  594. return 0;
  595. }
  596. /* Offset of logical sectors relative to physical sectors.
  597. *
  598. * If device has more than one logical sector per physical sector
  599. * (aka 512 byte emulation), vendors might offset the "sector 0" address
  600. * so sector 63 is "naturally aligned" - e.g. FAT partition table.
  601. * This avoids Read/Mod/Write penalties when using FAT partition table
  602. * and updating "well aligned" (FS perspective) physical sectors on every
  603. * transaction.
  604. */
  605. static inline u16 ata_id_logical_sector_offset(const u16 *id,
  606. u8 log2_per_phys)
  607. {
  608. u16 word_209 = id[209];
  609. if ((log2_per_phys > 1) && (word_209 & 0xc000) == 0x4000) {
  610. u16 first = word_209 & 0x3fff;
  611. if (first > 0)
  612. return (1 << log2_per_phys) - first;
  613. }
  614. return 0;
  615. }
  616. static inline bool ata_id_has_lba48(const u16 *id)
  617. {
  618. if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
  619. return false;
  620. if (!ata_id_u64(id, ATA_ID_LBA_CAPACITY_2))
  621. return false;
  622. return id[ATA_ID_COMMAND_SET_2] & (1 << 10);
  623. }
  624. static inline bool ata_id_lba48_enabled(const u16 *id)
  625. {
  626. if (ata_id_has_lba48(id) == 0)
  627. return false;
  628. if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
  629. return false;
  630. return id[ATA_ID_CFS_ENABLE_2] & (1 << 10);
  631. }
  632. static inline bool ata_id_hpa_enabled(const u16 *id)
  633. {
  634. /* Yes children, word 83 valid bits cover word 82 data */
  635. if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
  636. return false;
  637. /* And 87 covers 85-87 */
  638. if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
  639. return false;
  640. /* Check command sets enabled as well as supported */
  641. if ((id[ATA_ID_CFS_ENABLE_1] & (1 << 10)) == 0)
  642. return false;
  643. return id[ATA_ID_COMMAND_SET_1] & (1 << 10);
  644. }
  645. static inline bool ata_id_has_wcache(const u16 *id)
  646. {
  647. /* Yes children, word 83 valid bits cover word 82 data */
  648. if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
  649. return false;
  650. return id[ATA_ID_COMMAND_SET_1] & (1 << 5);
  651. }
  652. static inline bool ata_id_has_pm(const u16 *id)
  653. {
  654. if ((id[ATA_ID_COMMAND_SET_2] & 0xC000) != 0x4000)
  655. return false;
  656. return id[ATA_ID_COMMAND_SET_1] & (1 << 3);
  657. }
  658. static inline bool ata_id_rahead_enabled(const u16 *id)
  659. {
  660. if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
  661. return false;
  662. return id[ATA_ID_CFS_ENABLE_1] & (1 << 6);
  663. }
  664. static inline bool ata_id_wcache_enabled(const u16 *id)
  665. {
  666. if ((id[ATA_ID_CSF_DEFAULT] & 0xC000) != 0x4000)
  667. return false;
  668. return id[ATA_ID_CFS_ENABLE_1] & (1 << 5);
  669. }
  670. static inline bool ata_id_has_read_log_dma_ext(const u16 *id)
  671. {
  672. /* Word 86 must have bit 15 set */
  673. if (!(id[ATA_ID_CFS_ENABLE_2] & (1 << 15)))
  674. return false;
  675. /* READ LOG DMA EXT support can be signaled either from word 119
  676. * or from word 120. The format is the same for both words: Bit
  677. * 15 must be cleared, bit 14 set and bit 3 set.
  678. */
  679. if ((id[ATA_ID_COMMAND_SET_3] & 0xC008) == 0x4008 ||
  680. (id[ATA_ID_COMMAND_SET_4] & 0xC008) == 0x4008)
  681. return true;
  682. return false;
  683. }
  684. static inline bool ata_id_has_sense_reporting(const u16 *id)
  685. {
  686. if (!(id[ATA_ID_CFS_ENABLE_2] & BIT(15)))
  687. return false;
  688. if ((id[ATA_ID_COMMAND_SET_3] & (BIT(15) | BIT(14))) != BIT(14))
  689. return false;
  690. return id[ATA_ID_COMMAND_SET_3] & BIT(6);
  691. }
  692. static inline bool ata_id_sense_reporting_enabled(const u16 *id)
  693. {
  694. if (!ata_id_has_sense_reporting(id))
  695. return false;
  696. /* ata_id_has_sense_reporting() == true, word 86 must have bit 15 set */
  697. if ((id[ATA_ID_COMMAND_SET_4] & (BIT(15) | BIT(14))) != BIT(14))
  698. return false;
  699. return id[ATA_ID_COMMAND_SET_4] & BIT(6);
  700. }
  701. /**
  702. *
  703. * Word: 206 - SCT Command Transport
  704. * 15:12 - Vendor Specific
  705. * 11:6 - Reserved
  706. * 5 - SCT Command Transport Data Tables supported
  707. * 4 - SCT Command Transport Features Control supported
  708. * 3 - SCT Command Transport Error Recovery Control supported
  709. * 2 - SCT Command Transport Write Same supported
  710. * 1 - SCT Command Transport Long Sector Access supported
  711. * 0 - SCT Command Transport supported
  712. */
  713. static inline bool ata_id_sct_data_tables(const u16 *id)
  714. {
  715. return id[ATA_ID_SCT_CMD_XPORT] & (1 << 5) ? true : false;
  716. }
  717. static inline bool ata_id_sct_features_ctrl(const u16 *id)
  718. {
  719. return id[ATA_ID_SCT_CMD_XPORT] & (1 << 4) ? true : false;
  720. }
  721. static inline bool ata_id_sct_error_recovery_ctrl(const u16 *id)
  722. {
  723. return id[ATA_ID_SCT_CMD_XPORT] & (1 << 3) ? true : false;
  724. }
  725. static inline bool ata_id_sct_long_sector_access(const u16 *id)
  726. {
  727. return id[ATA_ID_SCT_CMD_XPORT] & (1 << 1) ? true : false;
  728. }
  729. static inline bool ata_id_sct_supported(const u16 *id)
  730. {
  731. return id[ATA_ID_SCT_CMD_XPORT] & (1 << 0) ? true : false;
  732. }
  733. /**
  734. * ata_id_major_version - get ATA level of drive
  735. * @id: Identify data
  736. *
  737. * Caveats:
  738. * ATA-1 considers identify optional
  739. * ATA-2 introduces mandatory identify
  740. * ATA-3 introduces word 80 and accurate reporting
  741. *
  742. * The practical impact of this is that ata_id_major_version cannot
  743. * reliably report on drives below ATA3.
  744. */
  745. static inline unsigned int ata_id_major_version(const u16 *id)
  746. {
  747. unsigned int mver;
  748. if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
  749. return 0;
  750. for (mver = 14; mver >= 1; mver--)
  751. if (id[ATA_ID_MAJOR_VER] & (1 << mver))
  752. break;
  753. return mver;
  754. }
  755. static inline bool ata_id_is_sata(const u16 *id)
  756. {
  757. /*
  758. * See if word 93 is 0 AND drive is at least ATA-5 compatible
  759. * verifying that word 80 by casting it to a signed type --
  760. * this trick allows us to filter out the reserved values of
  761. * 0x0000 and 0xffff along with the earlier ATA revisions...
  762. */
  763. if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
  764. return true;
  765. return false;
  766. }
  767. static inline bool ata_id_has_tpm(const u16 *id)
  768. {
  769. /* The TPM bits are only valid on ATA8 */
  770. if (ata_id_major_version(id) < 8)
  771. return false;
  772. if ((id[48] & 0xC000) != 0x4000)
  773. return false;
  774. return id[48] & (1 << 0);
  775. }
  776. static inline bool ata_id_has_dword_io(const u16 *id)
  777. {
  778. /* ATA 8 reuses this flag for "trusted" computing */
  779. if (ata_id_major_version(id) > 7)
  780. return false;
  781. return id[ATA_ID_DWORD_IO] & (1 << 0);
  782. }
  783. static inline bool ata_id_has_trusted(const u16 *id)
  784. {
  785. if (ata_id_major_version(id) <= 7)
  786. return false;
  787. return id[ATA_ID_TRUSTED] & (1 << 0);
  788. }
  789. static inline bool ata_id_has_unload(const u16 *id)
  790. {
  791. if (ata_id_major_version(id) >= 7 &&
  792. (id[ATA_ID_CFSSE] & 0xC000) == 0x4000 &&
  793. id[ATA_ID_CFSSE] & (1 << 13))
  794. return true;
  795. return false;
  796. }
  797. static inline bool ata_id_has_wwn(const u16 *id)
  798. {
  799. return (id[ATA_ID_CSF_DEFAULT] & 0xC100) == 0x4100;
  800. }
  801. static inline int ata_id_form_factor(const u16 *id)
  802. {
  803. u16 val = id[168];
  804. if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
  805. return 0;
  806. val &= 0xf;
  807. if (val > 5)
  808. return 0;
  809. return val;
  810. }
  811. static inline int ata_id_rotation_rate(const u16 *id)
  812. {
  813. u16 val = id[217];
  814. if (ata_id_major_version(id) < 7 || val == 0 || val == 0xffff)
  815. return 0;
  816. if (val > 1 && val < 0x401)
  817. return 0;
  818. return val;
  819. }
  820. static inline bool ata_id_has_ncq_send_and_recv(const u16 *id)
  821. {
  822. return id[ATA_ID_SATA_CAPABILITY_2] & BIT(6);
  823. }
  824. static inline bool ata_id_has_ncq_non_data(const u16 *id)
  825. {
  826. return id[ATA_ID_SATA_CAPABILITY_2] & BIT(5);
  827. }
  828. static inline bool ata_id_has_ncq_prio(const u16 *id)
  829. {
  830. return id[ATA_ID_SATA_CAPABILITY] & BIT(12);
  831. }
  832. static inline bool ata_id_has_trim(const u16 *id)
  833. {
  834. if (ata_id_major_version(id) >= 7 &&
  835. (id[ATA_ID_DATA_SET_MGMT] & 1))
  836. return true;
  837. return false;
  838. }
  839. static inline bool ata_id_has_zero_after_trim(const u16 *id)
  840. {
  841. /* DSM supported, deterministic read, and read zero after trim set */
  842. if (ata_id_has_trim(id) &&
  843. (id[ATA_ID_ADDITIONAL_SUPP] & 0x4020) == 0x4020)
  844. return true;
  845. return false;
  846. }
  847. static inline bool ata_id_current_chs_valid(const u16 *id)
  848. {
  849. /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
  850. has not been issued to the device then the values of
  851. id[ATA_ID_CUR_CYLS] to id[ATA_ID_CUR_SECTORS] are vendor specific. */
  852. return (id[ATA_ID_FIELD_VALID] & 1) && /* Current translation valid */
  853. id[ATA_ID_CUR_CYLS] && /* cylinders in current translation */
  854. id[ATA_ID_CUR_HEADS] && /* heads in current translation */
  855. id[ATA_ID_CUR_HEADS] <= 16 &&
  856. id[ATA_ID_CUR_SECTORS]; /* sectors in current translation */
  857. }
  858. static inline bool ata_id_is_cfa(const u16 *id)
  859. {
  860. if ((id[ATA_ID_CONFIG] == 0x848A) || /* Traditional CF */
  861. (id[ATA_ID_CONFIG] == 0x844A)) /* Delkin Devices CF */
  862. return true;
  863. /*
  864. * CF specs don't require specific value in the word 0 anymore and yet
  865. * they forbid to report the ATA version in the word 80 and require the
  866. * CFA feature set support to be indicated in the word 83 in this case.
  867. * Unfortunately, some cards only follow either of this requirements,
  868. * and while those that don't indicate CFA feature support need some
  869. * sort of quirk list, it seems impractical for the ones that do...
  870. */
  871. return (id[ATA_ID_COMMAND_SET_2] & 0xC004) == 0x4004;
  872. }
  873. static inline bool ata_id_is_ssd(const u16 *id)
  874. {
  875. return id[ATA_ID_ROT_SPEED] == 0x01;
  876. }
  877. static inline u8 ata_id_zoned_cap(const u16 *id)
  878. {
  879. return (id[ATA_ID_ADDITIONAL_SUPP] & 0x3);
  880. }
  881. static inline bool ata_id_pio_need_iordy(const u16 *id, const u8 pio)
  882. {
  883. /* CF spec. r4.1 Table 22 says no IORDY on PIO5 and PIO6. */
  884. if (pio > 4 && ata_id_is_cfa(id))
  885. return false;
  886. /* For PIO3 and higher it is mandatory. */
  887. if (pio > 2)
  888. return true;
  889. /* Turn it on when possible. */
  890. return ata_id_has_iordy(id);
  891. }
  892. static inline bool ata_drive_40wire(const u16 *dev_id)
  893. {
  894. if (ata_id_is_sata(dev_id))
  895. return false; /* SATA */
  896. if ((dev_id[ATA_ID_HW_CONFIG] & 0xE000) == 0x6000)
  897. return false; /* 80 wire */
  898. return true;
  899. }
  900. static inline bool ata_drive_40wire_relaxed(const u16 *dev_id)
  901. {
  902. if ((dev_id[ATA_ID_HW_CONFIG] & 0x2000) == 0x2000)
  903. return false; /* 80 wire */
  904. return true;
  905. }
  906. static inline int atapi_cdb_len(const u16 *dev_id)
  907. {
  908. u16 tmp = dev_id[ATA_ID_CONFIG] & 0x3;
  909. switch (tmp) {
  910. case 0: return 12;
  911. case 1: return 16;
  912. default: return -1;
  913. }
  914. }
  915. static inline int atapi_command_packet_set(const u16 *dev_id)
  916. {
  917. return (dev_id[ATA_ID_CONFIG] >> 8) & 0x1f;
  918. }
  919. static inline bool atapi_id_dmadir(const u16 *dev_id)
  920. {
  921. return ata_id_major_version(dev_id) >= 7 && (dev_id[62] & 0x8000);
  922. }
  923. /*
  924. * ata_id_is_lba_capacity_ok() performs a sanity check on
  925. * the claimed LBA capacity value for the device.
  926. *
  927. * Returns 1 if LBA capacity looks sensible, 0 otherwise.
  928. *
  929. * It is called only once for each device.
  930. */
  931. static inline bool ata_id_is_lba_capacity_ok(u16 *id)
  932. {
  933. unsigned long lba_sects, chs_sects, head, tail;
  934. /* No non-LBA info .. so valid! */
  935. if (id[ATA_ID_CYLS] == 0)
  936. return true;
  937. lba_sects = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
  938. /*
  939. * The ATA spec tells large drives to return
  940. * C/H/S = 16383/16/63 independent of their size.
  941. * Some drives can be jumpered to use 15 heads instead of 16.
  942. * Some drives can be jumpered to use 4092 cyls instead of 16383.
  943. */
  944. if ((id[ATA_ID_CYLS] == 16383 ||
  945. (id[ATA_ID_CYLS] == 4092 && id[ATA_ID_CUR_CYLS] == 16383)) &&
  946. id[ATA_ID_SECTORS] == 63 &&
  947. (id[ATA_ID_HEADS] == 15 || id[ATA_ID_HEADS] == 16) &&
  948. (lba_sects >= 16383 * 63 * id[ATA_ID_HEADS]))
  949. return true;
  950. chs_sects = id[ATA_ID_CYLS] * id[ATA_ID_HEADS] * id[ATA_ID_SECTORS];
  951. /* perform a rough sanity check on lba_sects: within 10% is OK */
  952. if (lba_sects - chs_sects < chs_sects/10)
  953. return true;
  954. /* some drives have the word order reversed */
  955. head = (lba_sects >> 16) & 0xffff;
  956. tail = lba_sects & 0xffff;
  957. lba_sects = head | (tail << 16);
  958. if (lba_sects - chs_sects < chs_sects/10) {
  959. *(__le32 *)&id[ATA_ID_LBA_CAPACITY] = __cpu_to_le32(lba_sects);
  960. return true; /* LBA capacity is (now) good */
  961. }
  962. return false; /* LBA capacity value may be bad */
  963. }
  964. static inline void ata_id_to_hd_driveid(u16 *id)
  965. {
  966. #ifdef __BIG_ENDIAN
  967. /* accessed in struct hd_driveid as 8-bit values */
  968. id[ATA_ID_MAX_MULTSECT] = __cpu_to_le16(id[ATA_ID_MAX_MULTSECT]);
  969. id[ATA_ID_CAPABILITY] = __cpu_to_le16(id[ATA_ID_CAPABILITY]);
  970. id[ATA_ID_OLD_PIO_MODES] = __cpu_to_le16(id[ATA_ID_OLD_PIO_MODES]);
  971. id[ATA_ID_OLD_DMA_MODES] = __cpu_to_le16(id[ATA_ID_OLD_DMA_MODES]);
  972. id[ATA_ID_MULTSECT] = __cpu_to_le16(id[ATA_ID_MULTSECT]);
  973. /* as 32-bit values */
  974. *(u32 *)&id[ATA_ID_LBA_CAPACITY] = ata_id_u32(id, ATA_ID_LBA_CAPACITY);
  975. *(u32 *)&id[ATA_ID_SPG] = ata_id_u32(id, ATA_ID_SPG);
  976. /* as 64-bit value */
  977. *(u64 *)&id[ATA_ID_LBA_CAPACITY_2] =
  978. ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
  979. #endif
  980. }
  981. static inline bool ata_ok(u8 status)
  982. {
  983. return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
  984. == ATA_DRDY);
  985. }
  986. static inline bool lba_28_ok(u64 block, u32 n_block)
  987. {
  988. /* check the ending block number: must be LESS THAN 0x0fffffff */
  989. return ((block + n_block) < ((1 << 28) - 1)) && (n_block <= ATA_MAX_SECTORS);
  990. }
  991. static inline bool lba_48_ok(u64 block, u32 n_block)
  992. {
  993. /* check the ending block number */
  994. return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= ATA_MAX_SECTORS_LBA48);
  995. }
  996. #define sata_pmp_gscr_vendor(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
  997. #define sata_pmp_gscr_devid(gscr) ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
  998. #define sata_pmp_gscr_rev(gscr) (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
  999. #define sata_pmp_gscr_ports(gscr) ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
  1000. #endif /* __LINUX_ATA_H__ */