ata.h 33 KB

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