libata.h 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790
  1. /*
  2. * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
  3. * Copyright 2003-2005 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. */
  25. #ifndef __LINUX_LIBATA_H__
  26. #define __LINUX_LIBATA_H__
  27. #include <linux/delay.h>
  28. #include <linux/jiffies.h>
  29. #include <linux/interrupt.h>
  30. #include <linux/dma-mapping.h>
  31. #include <linux/scatterlist.h>
  32. #include <linux/io.h>
  33. #include <linux/ata.h>
  34. #include <linux/workqueue.h>
  35. #include <scsi/scsi_host.h>
  36. #include <linux/acpi.h>
  37. #include <linux/cdrom.h>
  38. #include <linux/sched.h>
  39. /*
  40. * Define if arch has non-standard setup. This is a _PCI_ standard
  41. * not a legacy or ISA standard.
  42. */
  43. #ifdef CONFIG_ATA_NONSTANDARD
  44. #include <asm/libata-portmap.h>
  45. #else
  46. #include <asm-generic/libata-portmap.h>
  47. #endif
  48. /*
  49. * compile-time options: to be removed as soon as all the drivers are
  50. * converted to the new debugging mechanism
  51. */
  52. #undef ATA_DEBUG /* debugging output */
  53. #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
  54. #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
  55. #undef ATA_NDEBUG /* define to disable quick runtime checks */
  56. /* note: prints function name for you */
  57. #ifdef ATA_DEBUG
  58. #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  59. #ifdef ATA_VERBOSE_DEBUG
  60. #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  61. #else
  62. #define VPRINTK(fmt, args...)
  63. #endif /* ATA_VERBOSE_DEBUG */
  64. #else
  65. #define DPRINTK(fmt, args...)
  66. #define VPRINTK(fmt, args...)
  67. #endif /* ATA_DEBUG */
  68. #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  69. #define ata_print_version_once(dev, version) \
  70. ({ \
  71. static bool __print_once; \
  72. \
  73. if (!__print_once) { \
  74. __print_once = true; \
  75. ata_print_version(dev, version); \
  76. } \
  77. })
  78. /* NEW: debug levels */
  79. #define HAVE_LIBATA_MSG 1
  80. enum {
  81. ATA_MSG_DRV = 0x0001,
  82. ATA_MSG_INFO = 0x0002,
  83. ATA_MSG_PROBE = 0x0004,
  84. ATA_MSG_WARN = 0x0008,
  85. ATA_MSG_MALLOC = 0x0010,
  86. ATA_MSG_CTL = 0x0020,
  87. ATA_MSG_INTR = 0x0040,
  88. ATA_MSG_ERR = 0x0080,
  89. };
  90. #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
  91. #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
  92. #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
  93. #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
  94. #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  95. #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
  96. #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
  97. #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
  98. static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
  99. {
  100. if (dval < 0 || dval >= (sizeof(u32) * 8))
  101. return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
  102. if (!dval)
  103. return 0;
  104. return (1 << dval) - 1;
  105. }
  106. /* defines only for the constants which don't work well as enums */
  107. #define ATA_TAG_POISON 0xfafbfcfdU
  108. enum {
  109. /* various global constants */
  110. LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
  111. LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
  112. ATA_DEF_QUEUE = 1,
  113. /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
  114. ATA_MAX_QUEUE = 32,
  115. ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
  116. ATA_SHORT_PAUSE = 16,
  117. ATAPI_MAX_DRAIN = 16 << 10,
  118. ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
  119. ATA_SHT_EMULATED = 1,
  120. ATA_SHT_CMD_PER_LUN = 1,
  121. ATA_SHT_THIS_ID = -1,
  122. ATA_SHT_USE_CLUSTERING = 1,
  123. /* struct ata_device stuff */
  124. ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
  125. ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
  126. ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
  127. ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
  128. ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
  129. ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
  130. ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
  131. ATA_DFLAG_AN = (1 << 7), /* AN configured */
  132. ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
  133. ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
  134. ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
  135. ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
  136. ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
  137. ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
  138. ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
  139. ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
  140. ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
  141. ATA_DFLAG_DETACH = (1 << 24),
  142. ATA_DFLAG_DETACHED = (1 << 25),
  143. ATA_DEV_UNKNOWN = 0, /* unknown device */
  144. ATA_DEV_ATA = 1, /* ATA device */
  145. ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
  146. ATA_DEV_ATAPI = 3, /* ATAPI device */
  147. ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
  148. ATA_DEV_PMP = 5, /* SATA port multiplier */
  149. ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
  150. ATA_DEV_SEMB = 7, /* SEMB */
  151. ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
  152. ATA_DEV_NONE = 9, /* no device */
  153. /* struct ata_link flags */
  154. ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
  155. ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
  156. ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
  157. ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
  158. ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
  159. ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
  160. ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
  161. ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
  162. ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
  163. /* struct ata_port flags */
  164. ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
  165. /* (doesn't imply presence) */
  166. ATA_FLAG_SATA = (1 << 1),
  167. ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
  168. ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
  169. ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
  170. ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
  171. * doesn't handle PIO interrupts */
  172. ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
  173. ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
  174. ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
  175. ATA_FLAG_DEBUGMSG = (1 << 13),
  176. ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
  177. ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
  178. ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
  179. ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
  180. ATA_FLAG_AN = (1 << 18), /* controller supports AN */
  181. ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
  182. ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
  183. * management */
  184. ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
  185. * led */
  186. ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
  187. /* bits 24:31 of ap->flags are reserved for LLD specific flags */
  188. /* struct ata_port pflags */
  189. ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
  190. ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
  191. ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
  192. ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
  193. ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
  194. ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
  195. ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
  196. ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
  197. ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
  198. ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
  199. ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
  200. ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
  201. ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
  202. ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
  203. ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
  204. /* struct ata_queued_cmd flags */
  205. ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
  206. ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
  207. ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
  208. ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
  209. ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
  210. ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
  211. ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
  212. ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
  213. ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
  214. ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
  215. /* host set flags */
  216. ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
  217. ATA_HOST_STARTED = (1 << 1), /* Host started */
  218. ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
  219. ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
  220. /* bits 24:31 of host->flags are reserved for LLD specific flags */
  221. /* various lengths of time */
  222. ATA_TMOUT_BOOT = 30000, /* heuristic */
  223. ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
  224. ATA_TMOUT_INTERNAL_QUICK = 5000,
  225. ATA_TMOUT_MAX_PARK = 30000,
  226. /*
  227. * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
  228. * is too much without parallel probing. Use 2s if parallel
  229. * probing is available, 800ms otherwise.
  230. */
  231. ATA_TMOUT_FF_WAIT_LONG = 2000,
  232. ATA_TMOUT_FF_WAIT = 800,
  233. /* Spec mandates to wait for ">= 2ms" before checking status
  234. * after reset. We wait 150ms, because that was the magic
  235. * delay used for ATAPI devices in Hale Landis's ATADRVR, for
  236. * the period of time between when the ATA command register is
  237. * written, and then status is checked. Because waiting for
  238. * "a while" before checking status is fine, post SRST, we
  239. * perform this magic delay here as well.
  240. *
  241. * Old drivers/ide uses the 2mS rule and then waits for ready.
  242. */
  243. ATA_WAIT_AFTER_RESET = 150,
  244. /* If PMP is supported, we have to do follow-up SRST. As some
  245. * PMPs don't send D2H Reg FIS after hardreset, LLDs are
  246. * advised to wait only for the following duration before
  247. * doing SRST.
  248. */
  249. ATA_TMOUT_PMP_SRST_WAIT = 5000,
  250. /* ATA bus states */
  251. BUS_UNKNOWN = 0,
  252. BUS_DMA = 1,
  253. BUS_IDLE = 2,
  254. BUS_NOINTR = 3,
  255. BUS_NODATA = 4,
  256. BUS_TIMER = 5,
  257. BUS_PIO = 6,
  258. BUS_EDD = 7,
  259. BUS_IDENTIFY = 8,
  260. BUS_PACKET = 9,
  261. /* SATA port states */
  262. PORT_UNKNOWN = 0,
  263. PORT_ENABLED = 1,
  264. PORT_DISABLED = 2,
  265. /* encoding various smaller bitmaps into a single
  266. * unsigned long bitmap
  267. */
  268. ATA_NR_PIO_MODES = 7,
  269. ATA_NR_MWDMA_MODES = 5,
  270. ATA_NR_UDMA_MODES = 8,
  271. ATA_SHIFT_PIO = 0,
  272. ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
  273. ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
  274. /* size of buffer to pad xfers ending on unaligned boundaries */
  275. ATA_DMA_PAD_SZ = 4,
  276. /* ering size */
  277. ATA_ERING_SIZE = 32,
  278. /* return values for ->qc_defer */
  279. ATA_DEFER_LINK = 1,
  280. ATA_DEFER_PORT = 2,
  281. /* desc_len for ata_eh_info and context */
  282. ATA_EH_DESC_LEN = 80,
  283. /* reset / recovery action types */
  284. ATA_EH_REVALIDATE = (1 << 0),
  285. ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
  286. ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
  287. ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
  288. ATA_EH_ENABLE_LINK = (1 << 3),
  289. ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
  290. ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
  291. ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
  292. ATA_EH_ENABLE_LINK,
  293. /* ata_eh_info->flags */
  294. ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
  295. ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
  296. ATA_EHI_QUIET = (1 << 3), /* be quiet */
  297. ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
  298. ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
  299. ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
  300. ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
  301. ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
  302. ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
  303. ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
  304. /* mask of flags to transfer *to* the slave link */
  305. ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
  306. /* max tries if error condition is still set after ->error_handler */
  307. ATA_EH_MAX_TRIES = 5,
  308. /* sometimes resuming a link requires several retries */
  309. ATA_LINK_RESUME_TRIES = 5,
  310. /* how hard are we gonna try to probe/recover devices */
  311. ATA_PROBE_MAX_TRIES = 3,
  312. ATA_EH_DEV_TRIES = 3,
  313. ATA_EH_PMP_TRIES = 5,
  314. ATA_EH_PMP_LINK_TRIES = 3,
  315. SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
  316. /* This should match the actual table size of
  317. * ata_eh_cmd_timeout_table in libata-eh.c.
  318. */
  319. ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
  320. /* Horkage types. May be set by libata or controller on drives
  321. (some horkage may be drive/controller pair dependent */
  322. ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
  323. ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
  324. ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
  325. ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
  326. ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
  327. ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
  328. ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
  329. ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
  330. ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
  331. ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
  332. ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
  333. not multiple of 16 bytes */
  334. ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
  335. ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
  336. ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
  337. ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
  338. ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
  339. /* DMA mask for user DMA control: User visible values; DO NOT
  340. renumber */
  341. ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
  342. ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
  343. ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
  344. /* ATAPI command types */
  345. ATAPI_READ = 0, /* READs */
  346. ATAPI_WRITE = 1, /* WRITEs */
  347. ATAPI_READ_CD = 2, /* READ CD [MSF] */
  348. ATAPI_PASS_THRU = 3, /* SAT pass-thru */
  349. ATAPI_MISC = 4, /* the rest */
  350. /* Timing constants */
  351. ATA_TIMING_SETUP = (1 << 0),
  352. ATA_TIMING_ACT8B = (1 << 1),
  353. ATA_TIMING_REC8B = (1 << 2),
  354. ATA_TIMING_CYC8B = (1 << 3),
  355. ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
  356. ATA_TIMING_CYC8B,
  357. ATA_TIMING_ACTIVE = (1 << 4),
  358. ATA_TIMING_RECOVER = (1 << 5),
  359. ATA_TIMING_DMACK_HOLD = (1 << 6),
  360. ATA_TIMING_CYCLE = (1 << 7),
  361. ATA_TIMING_UDMA = (1 << 8),
  362. ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
  363. ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
  364. ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
  365. ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
  366. ATA_TIMING_UDMA,
  367. /* ACPI constants */
  368. ATA_ACPI_FILTER_SETXFER = 1 << 0,
  369. ATA_ACPI_FILTER_LOCK = 1 << 1,
  370. ATA_ACPI_FILTER_DIPM = 1 << 2,
  371. ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
  372. ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
  373. ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
  374. ATA_ACPI_FILTER_LOCK |
  375. ATA_ACPI_FILTER_DIPM,
  376. };
  377. enum ata_xfer_mask {
  378. ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
  379. << ATA_SHIFT_PIO,
  380. ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
  381. << ATA_SHIFT_MWDMA,
  382. ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
  383. << ATA_SHIFT_UDMA,
  384. };
  385. enum hsm_task_states {
  386. HSM_ST_IDLE, /* no command on going */
  387. HSM_ST_FIRST, /* (waiting the device to)
  388. write CDB or first data block */
  389. HSM_ST, /* (waiting the device to) transfer data */
  390. HSM_ST_LAST, /* (waiting the device to) complete command */
  391. HSM_ST_ERR, /* error */
  392. };
  393. enum ata_completion_errors {
  394. AC_ERR_DEV = (1 << 0), /* device reported error */
  395. AC_ERR_HSM = (1 << 1), /* host state machine violation */
  396. AC_ERR_TIMEOUT = (1 << 2), /* timeout */
  397. AC_ERR_MEDIA = (1 << 3), /* media error */
  398. AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
  399. AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
  400. AC_ERR_SYSTEM = (1 << 6), /* system error */
  401. AC_ERR_INVALID = (1 << 7), /* invalid argument */
  402. AC_ERR_OTHER = (1 << 8), /* unknown */
  403. AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
  404. AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
  405. };
  406. /*
  407. * Link power management policy: If you alter this, you also need to
  408. * alter libata-scsi.c (for the ascii descriptions)
  409. */
  410. enum ata_lpm_policy {
  411. ATA_LPM_UNKNOWN,
  412. ATA_LPM_MAX_POWER,
  413. ATA_LPM_MED_POWER,
  414. ATA_LPM_MIN_POWER,
  415. };
  416. enum ata_lpm_hints {
  417. ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
  418. ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
  419. };
  420. /* forward declarations */
  421. struct scsi_device;
  422. struct ata_port_operations;
  423. struct ata_port;
  424. struct ata_link;
  425. struct ata_queued_cmd;
  426. /* typedefs */
  427. typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
  428. typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
  429. typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
  430. unsigned long deadline);
  431. typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
  432. extern struct device_attribute dev_attr_link_power_management_policy;
  433. extern struct device_attribute dev_attr_unload_heads;
  434. extern struct device_attribute dev_attr_em_message_type;
  435. extern struct device_attribute dev_attr_em_message;
  436. extern struct device_attribute dev_attr_sw_activity;
  437. enum sw_activity {
  438. OFF,
  439. BLINK_ON,
  440. BLINK_OFF,
  441. };
  442. #ifdef CONFIG_ATA_SFF
  443. struct ata_ioports {
  444. void __iomem *cmd_addr;
  445. void __iomem *data_addr;
  446. void __iomem *error_addr;
  447. void __iomem *feature_addr;
  448. void __iomem *nsect_addr;
  449. void __iomem *lbal_addr;
  450. void __iomem *lbam_addr;
  451. void __iomem *lbah_addr;
  452. void __iomem *device_addr;
  453. void __iomem *status_addr;
  454. void __iomem *command_addr;
  455. void __iomem *altstatus_addr;
  456. void __iomem *ctl_addr;
  457. #ifdef CONFIG_ATA_BMDMA
  458. void __iomem *bmdma_addr;
  459. #endif /* CONFIG_ATA_BMDMA */
  460. void __iomem *scr_addr;
  461. };
  462. #endif /* CONFIG_ATA_SFF */
  463. struct ata_host {
  464. spinlock_t lock;
  465. struct device *dev;
  466. void __iomem * const *iomap;
  467. unsigned int n_ports;
  468. void *private_data;
  469. struct ata_port_operations *ops;
  470. unsigned long flags;
  471. struct mutex eh_mutex;
  472. struct task_struct *eh_owner;
  473. #ifdef CONFIG_ATA_ACPI
  474. acpi_handle acpi_handle;
  475. #endif
  476. struct ata_port *simplex_claimed; /* channel owning the DMA */
  477. struct ata_port *ports[0];
  478. };
  479. struct ata_queued_cmd {
  480. struct ata_port *ap;
  481. struct ata_device *dev;
  482. struct scsi_cmnd *scsicmd;
  483. void (*scsidone)(struct scsi_cmnd *);
  484. struct ata_taskfile tf;
  485. u8 cdb[ATAPI_CDB_LEN];
  486. unsigned long flags; /* ATA_QCFLAG_xxx */
  487. unsigned int tag;
  488. unsigned int n_elem;
  489. unsigned int orig_n_elem;
  490. int dma_dir;
  491. unsigned int sect_size;
  492. unsigned int nbytes;
  493. unsigned int extrabytes;
  494. unsigned int curbytes;
  495. struct scatterlist sgent;
  496. struct scatterlist *sg;
  497. struct scatterlist *cursg;
  498. unsigned int cursg_ofs;
  499. unsigned int err_mask;
  500. struct ata_taskfile result_tf;
  501. ata_qc_cb_t complete_fn;
  502. void *private_data;
  503. void *lldd_task;
  504. };
  505. struct ata_port_stats {
  506. unsigned long unhandled_irq;
  507. unsigned long idle_irq;
  508. unsigned long rw_reqbuf;
  509. };
  510. struct ata_ering_entry {
  511. unsigned int eflags;
  512. unsigned int err_mask;
  513. u64 timestamp;
  514. };
  515. struct ata_ering {
  516. int cursor;
  517. struct ata_ering_entry ring[ATA_ERING_SIZE];
  518. };
  519. struct ata_device {
  520. struct ata_link *link;
  521. unsigned int devno; /* 0 or 1 */
  522. unsigned int horkage; /* List of broken features */
  523. unsigned long flags; /* ATA_DFLAG_xxx */
  524. struct scsi_device *sdev; /* attached SCSI device */
  525. void *private_data;
  526. #ifdef CONFIG_ATA_ACPI
  527. acpi_handle acpi_handle;
  528. union acpi_object *gtf_cache;
  529. unsigned int gtf_filter;
  530. #endif
  531. struct device tdev;
  532. /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
  533. u64 n_sectors; /* size of device, if ATA */
  534. u64 n_native_sectors; /* native size, if ATA */
  535. unsigned int class; /* ATA_DEV_xxx */
  536. unsigned long unpark_deadline;
  537. u8 pio_mode;
  538. u8 dma_mode;
  539. u8 xfer_mode;
  540. unsigned int xfer_shift; /* ATA_SHIFT_xxx */
  541. unsigned int multi_count; /* sectors count for
  542. READ/WRITE MULTIPLE */
  543. unsigned int max_sectors; /* per-device max sectors */
  544. unsigned int cdb_len;
  545. /* per-dev xfer mask */
  546. unsigned long pio_mask;
  547. unsigned long mwdma_mask;
  548. unsigned long udma_mask;
  549. /* for CHS addressing */
  550. u16 cylinders; /* Number of cylinders */
  551. u16 heads; /* Number of heads */
  552. u16 sectors; /* Number of sectors per track */
  553. union {
  554. u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
  555. u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
  556. };
  557. /* error history */
  558. int spdn_cnt;
  559. /* ering is CLEAR_END, read comment above CLEAR_END */
  560. struct ata_ering ering;
  561. };
  562. /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
  563. * cleared to zero on ata_dev_init().
  564. */
  565. #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
  566. #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
  567. struct ata_eh_info {
  568. struct ata_device *dev; /* offending device */
  569. u32 serror; /* SError from LLDD */
  570. unsigned int err_mask; /* port-wide err_mask */
  571. unsigned int action; /* ATA_EH_* action mask */
  572. unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
  573. unsigned int flags; /* ATA_EHI_* flags */
  574. unsigned int probe_mask;
  575. char desc[ATA_EH_DESC_LEN];
  576. int desc_len;
  577. };
  578. struct ata_eh_context {
  579. struct ata_eh_info i;
  580. int tries[ATA_MAX_DEVICES];
  581. int cmd_timeout_idx[ATA_MAX_DEVICES]
  582. [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
  583. unsigned int classes[ATA_MAX_DEVICES];
  584. unsigned int did_probe_mask;
  585. unsigned int unloaded_mask;
  586. unsigned int saved_ncq_enabled;
  587. u8 saved_xfer_mode[ATA_MAX_DEVICES];
  588. /* timestamp for the last reset attempt or success */
  589. unsigned long last_reset;
  590. };
  591. struct ata_acpi_drive
  592. {
  593. u32 pio;
  594. u32 dma;
  595. } __packed;
  596. struct ata_acpi_gtm {
  597. struct ata_acpi_drive drive[2];
  598. u32 flags;
  599. } __packed;
  600. struct ata_link {
  601. struct ata_port *ap;
  602. int pmp; /* port multiplier port # */
  603. struct device tdev;
  604. unsigned int active_tag; /* active tag on this link */
  605. u32 sactive; /* active NCQ commands */
  606. unsigned int flags; /* ATA_LFLAG_xxx */
  607. u32 saved_scontrol; /* SControl on probe */
  608. unsigned int hw_sata_spd_limit;
  609. unsigned int sata_spd_limit;
  610. unsigned int sata_spd; /* current SATA PHY speed */
  611. enum ata_lpm_policy lpm_policy;
  612. /* record runtime error info, protected by host_set lock */
  613. struct ata_eh_info eh_info;
  614. /* EH context */
  615. struct ata_eh_context eh_context;
  616. struct ata_device device[ATA_MAX_DEVICES];
  617. };
  618. #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
  619. #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
  620. struct ata_port {
  621. struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
  622. struct ata_port_operations *ops;
  623. spinlock_t *lock;
  624. /* Flags owned by the EH context. Only EH should touch these once the
  625. port is active */
  626. unsigned long flags; /* ATA_FLAG_xxx */
  627. /* Flags that change dynamically, protected by ap->lock */
  628. unsigned int pflags; /* ATA_PFLAG_xxx */
  629. unsigned int print_id; /* user visible unique port ID */
  630. unsigned int port_no; /* 0 based port no. inside the host */
  631. #ifdef CONFIG_ATA_SFF
  632. struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
  633. u8 ctl; /* cache of ATA control register */
  634. u8 last_ctl; /* Cache last written value */
  635. struct ata_link* sff_pio_task_link; /* link currently used */
  636. struct delayed_work sff_pio_task;
  637. #ifdef CONFIG_ATA_BMDMA
  638. struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
  639. dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
  640. #endif /* CONFIG_ATA_BMDMA */
  641. #endif /* CONFIG_ATA_SFF */
  642. unsigned int pio_mask;
  643. unsigned int mwdma_mask;
  644. unsigned int udma_mask;
  645. unsigned int cbl; /* cable type; ATA_CBL_xxx */
  646. struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
  647. unsigned long qc_allocated;
  648. unsigned int qc_active;
  649. int nr_active_links; /* #links with active qcs */
  650. struct ata_link link; /* host default link */
  651. struct ata_link *slave_link; /* see ata_slave_link_init() */
  652. int nr_pmp_links; /* nr of available PMP links */
  653. struct ata_link *pmp_link; /* array of PMP links */
  654. struct ata_link *excl_link; /* for PMP qc exclusion */
  655. struct ata_port_stats stats;
  656. struct ata_host *host;
  657. struct device *dev;
  658. struct device tdev;
  659. struct mutex scsi_scan_mutex;
  660. struct delayed_work hotplug_task;
  661. struct work_struct scsi_rescan_task;
  662. unsigned int hsm_task_state;
  663. u32 msg_enable;
  664. struct list_head eh_done_q;
  665. wait_queue_head_t eh_wait_q;
  666. int eh_tries;
  667. struct completion park_req_pending;
  668. pm_message_t pm_mesg;
  669. int *pm_result;
  670. enum ata_lpm_policy target_lpm_policy;
  671. struct timer_list fastdrain_timer;
  672. unsigned long fastdrain_cnt;
  673. int em_message_type;
  674. void *private_data;
  675. #ifdef CONFIG_ATA_ACPI
  676. acpi_handle acpi_handle;
  677. struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
  678. #endif
  679. /* owned by EH */
  680. u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
  681. };
  682. /* The following initializer overrides a method to NULL whether one of
  683. * its parent has the method defined or not. This is equivalent to
  684. * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
  685. * expression and thus can't be used as an initializer.
  686. */
  687. #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
  688. struct ata_port_operations {
  689. /*
  690. * Command execution
  691. */
  692. int (*qc_defer)(struct ata_queued_cmd *qc);
  693. int (*check_atapi_dma)(struct ata_queued_cmd *qc);
  694. void (*qc_prep)(struct ata_queued_cmd *qc);
  695. unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
  696. bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
  697. /*
  698. * Configuration and exception handling
  699. */
  700. int (*cable_detect)(struct ata_port *ap);
  701. unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
  702. void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
  703. void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
  704. int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
  705. unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
  706. void (*dev_config)(struct ata_device *dev);
  707. void (*freeze)(struct ata_port *ap);
  708. void (*thaw)(struct ata_port *ap);
  709. ata_prereset_fn_t prereset;
  710. ata_reset_fn_t softreset;
  711. ata_reset_fn_t hardreset;
  712. ata_postreset_fn_t postreset;
  713. ata_prereset_fn_t pmp_prereset;
  714. ata_reset_fn_t pmp_softreset;
  715. ata_reset_fn_t pmp_hardreset;
  716. ata_postreset_fn_t pmp_postreset;
  717. void (*error_handler)(struct ata_port *ap);
  718. void (*lost_interrupt)(struct ata_port *ap);
  719. void (*post_internal_cmd)(struct ata_queued_cmd *qc);
  720. void (*sched_eh)(struct ata_port *ap);
  721. void (*end_eh)(struct ata_port *ap);
  722. /*
  723. * Optional features
  724. */
  725. int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
  726. int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
  727. void (*pmp_attach)(struct ata_port *ap);
  728. void (*pmp_detach)(struct ata_port *ap);
  729. int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
  730. unsigned hints);
  731. /*
  732. * Start, stop, suspend and resume
  733. */
  734. int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
  735. int (*port_resume)(struct ata_port *ap);
  736. int (*port_start)(struct ata_port *ap);
  737. void (*port_stop)(struct ata_port *ap);
  738. void (*host_stop)(struct ata_host *host);
  739. #ifdef CONFIG_ATA_SFF
  740. /*
  741. * SFF / taskfile oriented ops
  742. */
  743. void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
  744. void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
  745. u8 (*sff_check_status)(struct ata_port *ap);
  746. u8 (*sff_check_altstatus)(struct ata_port *ap);
  747. void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
  748. void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
  749. void (*sff_exec_command)(struct ata_port *ap,
  750. const struct ata_taskfile *tf);
  751. unsigned int (*sff_data_xfer)(struct ata_device *dev,
  752. unsigned char *buf, unsigned int buflen, int rw);
  753. void (*sff_irq_on)(struct ata_port *);
  754. bool (*sff_irq_check)(struct ata_port *);
  755. void (*sff_irq_clear)(struct ata_port *);
  756. void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
  757. #ifdef CONFIG_ATA_BMDMA
  758. void (*bmdma_setup)(struct ata_queued_cmd *qc);
  759. void (*bmdma_start)(struct ata_queued_cmd *qc);
  760. void (*bmdma_stop)(struct ata_queued_cmd *qc);
  761. u8 (*bmdma_status)(struct ata_port *ap);
  762. #endif /* CONFIG_ATA_BMDMA */
  763. #endif /* CONFIG_ATA_SFF */
  764. ssize_t (*em_show)(struct ata_port *ap, char *buf);
  765. ssize_t (*em_store)(struct ata_port *ap, const char *message,
  766. size_t size);
  767. ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
  768. ssize_t (*sw_activity_store)(struct ata_device *dev,
  769. enum sw_activity val);
  770. /*
  771. * Obsolete
  772. */
  773. void (*phy_reset)(struct ata_port *ap);
  774. void (*eng_timeout)(struct ata_port *ap);
  775. /*
  776. * ->inherits must be the last field and all the preceding
  777. * fields must be pointers.
  778. */
  779. const struct ata_port_operations *inherits;
  780. };
  781. struct ata_port_info {
  782. unsigned long flags;
  783. unsigned long link_flags;
  784. unsigned long pio_mask;
  785. unsigned long mwdma_mask;
  786. unsigned long udma_mask;
  787. struct ata_port_operations *port_ops;
  788. void *private_data;
  789. };
  790. struct ata_timing {
  791. unsigned short mode; /* ATA mode */
  792. unsigned short setup; /* t1 */
  793. unsigned short act8b; /* t2 for 8-bit I/O */
  794. unsigned short rec8b; /* t2i for 8-bit I/O */
  795. unsigned short cyc8b; /* t0 for 8-bit I/O */
  796. unsigned short active; /* t2 or tD */
  797. unsigned short recover; /* t2i or tK */
  798. unsigned short dmack_hold; /* tj */
  799. unsigned short cycle; /* t0 */
  800. unsigned short udma; /* t2CYCTYP/2 */
  801. };
  802. /*
  803. * Core layer - drivers/ata/libata-core.c
  804. */
  805. extern const unsigned long sata_deb_timing_normal[];
  806. extern const unsigned long sata_deb_timing_hotplug[];
  807. extern const unsigned long sata_deb_timing_long[];
  808. extern struct ata_port_operations ata_dummy_port_ops;
  809. extern const struct ata_port_info ata_dummy_port_info;
  810. static inline const unsigned long *
  811. sata_ehc_deb_timing(struct ata_eh_context *ehc)
  812. {
  813. if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
  814. return sata_deb_timing_hotplug;
  815. else
  816. return sata_deb_timing_normal;
  817. }
  818. static inline int ata_port_is_dummy(struct ata_port *ap)
  819. {
  820. return ap->ops == &ata_dummy_port_ops;
  821. }
  822. extern int sata_set_spd(struct ata_link *link);
  823. extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
  824. extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
  825. int (*check_ready)(struct ata_link *link));
  826. extern int sata_link_debounce(struct ata_link *link,
  827. const unsigned long *params, unsigned long deadline);
  828. extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
  829. unsigned long deadline);
  830. extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
  831. bool spm_wakeup);
  832. extern int sata_link_hardreset(struct ata_link *link,
  833. const unsigned long *timing, unsigned long deadline,
  834. bool *online, int (*check_ready)(struct ata_link *));
  835. extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
  836. unsigned long deadline);
  837. extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
  838. extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
  839. extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
  840. const struct ata_port_info * const * ppi, int n_ports);
  841. extern int ata_slave_link_init(struct ata_port *ap);
  842. extern int ata_host_start(struct ata_host *host);
  843. extern int ata_host_register(struct ata_host *host,
  844. struct scsi_host_template *sht);
  845. extern int ata_host_activate(struct ata_host *host, int irq,
  846. irq_handler_t irq_handler, unsigned long irq_flags,
  847. struct scsi_host_template *sht);
  848. extern void ata_host_detach(struct ata_host *host);
  849. extern void ata_host_init(struct ata_host *, struct device *,
  850. unsigned long, struct ata_port_operations *);
  851. extern int ata_scsi_detect(struct scsi_host_template *sht);
  852. extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
  853. extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
  854. extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
  855. int cmd, void __user *arg);
  856. extern void ata_sas_port_destroy(struct ata_port *);
  857. extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
  858. struct ata_port_info *, struct Scsi_Host *);
  859. extern void ata_sas_async_probe(struct ata_port *ap);
  860. extern int ata_sas_sync_probe(struct ata_port *ap);
  861. extern int ata_sas_port_init(struct ata_port *);
  862. extern int ata_sas_port_start(struct ata_port *ap);
  863. extern void ata_sas_port_stop(struct ata_port *ap);
  864. extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
  865. extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
  866. extern int sata_scr_valid(struct ata_link *link);
  867. extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
  868. extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
  869. extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
  870. extern bool ata_link_online(struct ata_link *link);
  871. extern bool ata_link_offline(struct ata_link *link);
  872. #ifdef CONFIG_PM
  873. extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
  874. extern void ata_host_resume(struct ata_host *host);
  875. #endif
  876. extern int ata_ratelimit(void);
  877. extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
  878. extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
  879. u32 val, unsigned long interval, unsigned long timeout);
  880. extern int atapi_cmd_type(u8 opcode);
  881. extern void ata_tf_to_fis(const struct ata_taskfile *tf,
  882. u8 pmp, int is_cmd, u8 *fis);
  883. extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
  884. extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
  885. unsigned long mwdma_mask, unsigned long udma_mask);
  886. extern void ata_unpack_xfermask(unsigned long xfer_mask,
  887. unsigned long *pio_mask, unsigned long *mwdma_mask,
  888. unsigned long *udma_mask);
  889. extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
  890. extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
  891. extern int ata_xfer_mode2shift(unsigned long xfer_mode);
  892. extern const char *ata_mode_string(unsigned long xfer_mask);
  893. extern unsigned long ata_id_xfermask(const u16 *id);
  894. extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
  895. extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
  896. extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
  897. unsigned int n_elem);
  898. extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
  899. extern void ata_dev_disable(struct ata_device *adev);
  900. extern void ata_id_string(const u16 *id, unsigned char *s,
  901. unsigned int ofs, unsigned int len);
  902. extern void ata_id_c_string(const u16 *id, unsigned char *s,
  903. unsigned int ofs, unsigned int len);
  904. extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
  905. struct ata_taskfile *tf, u16 *id);
  906. extern void ata_qc_complete(struct ata_queued_cmd *qc);
  907. extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
  908. extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
  909. extern int ata_std_bios_param(struct scsi_device *sdev,
  910. struct block_device *bdev,
  911. sector_t capacity, int geom[]);
  912. extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
  913. extern int ata_scsi_slave_config(struct scsi_device *sdev);
  914. extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
  915. extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
  916. int queue_depth, int reason);
  917. extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
  918. int queue_depth, int reason);
  919. extern struct ata_device *ata_dev_pair(struct ata_device *adev);
  920. extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
  921. extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
  922. extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
  923. extern int ata_cable_40wire(struct ata_port *ap);
  924. extern int ata_cable_80wire(struct ata_port *ap);
  925. extern int ata_cable_sata(struct ata_port *ap);
  926. extern int ata_cable_ignore(struct ata_port *ap);
  927. extern int ata_cable_unknown(struct ata_port *ap);
  928. /* Timing helpers */
  929. extern unsigned int ata_pio_need_iordy(const struct ata_device *);
  930. extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
  931. extern int ata_timing_compute(struct ata_device *, unsigned short,
  932. struct ata_timing *, int, int);
  933. extern void ata_timing_merge(const struct ata_timing *,
  934. const struct ata_timing *, struct ata_timing *,
  935. unsigned int);
  936. extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
  937. /* PCI */
  938. #ifdef CONFIG_PCI
  939. struct pci_dev;
  940. struct pci_bits {
  941. unsigned int reg; /* PCI config register to read */
  942. unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
  943. unsigned long mask;
  944. unsigned long val;
  945. };
  946. extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
  947. extern void ata_pci_remove_one(struct pci_dev *pdev);
  948. #ifdef CONFIG_PM
  949. extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
  950. extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
  951. extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
  952. extern int ata_pci_device_resume(struct pci_dev *pdev);
  953. #endif /* CONFIG_PM */
  954. #endif /* CONFIG_PCI */
  955. /*
  956. * ACPI - drivers/ata/libata-acpi.c
  957. */
  958. #ifdef CONFIG_ATA_ACPI
  959. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  960. {
  961. if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
  962. return &ap->__acpi_init_gtm;
  963. return NULL;
  964. }
  965. int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
  966. int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
  967. unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
  968. const struct ata_acpi_gtm *gtm);
  969. int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
  970. #else
  971. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  972. {
  973. return NULL;
  974. }
  975. static inline int ata_acpi_stm(const struct ata_port *ap,
  976. struct ata_acpi_gtm *stm)
  977. {
  978. return -ENOSYS;
  979. }
  980. static inline int ata_acpi_gtm(const struct ata_port *ap,
  981. struct ata_acpi_gtm *stm)
  982. {
  983. return -ENOSYS;
  984. }
  985. static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
  986. const struct ata_acpi_gtm *gtm)
  987. {
  988. return 0;
  989. }
  990. static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
  991. const struct ata_acpi_gtm *gtm)
  992. {
  993. return 0;
  994. }
  995. #endif
  996. /*
  997. * EH - drivers/ata/libata-eh.c
  998. */
  999. extern void ata_port_schedule_eh(struct ata_port *ap);
  1000. extern void ata_port_wait_eh(struct ata_port *ap);
  1001. extern int ata_link_abort(struct ata_link *link);
  1002. extern int ata_port_abort(struct ata_port *ap);
  1003. extern int ata_port_freeze(struct ata_port *ap);
  1004. extern int sata_async_notification(struct ata_port *ap);
  1005. extern void ata_eh_freeze_port(struct ata_port *ap);
  1006. extern void ata_eh_thaw_port(struct ata_port *ap);
  1007. extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
  1008. extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
  1009. extern void ata_eh_analyze_ncq_error(struct ata_link *link);
  1010. extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  1011. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  1012. ata_postreset_fn_t postreset);
  1013. extern void ata_std_error_handler(struct ata_port *ap);
  1014. extern void ata_std_sched_eh(struct ata_port *ap);
  1015. extern void ata_std_end_eh(struct ata_port *ap);
  1016. extern int ata_link_nr_enabled(struct ata_link *link);
  1017. /*
  1018. * Base operations to inherit from and initializers for sht
  1019. *
  1020. * Operations
  1021. *
  1022. * base : Common to all libata drivers.
  1023. * sata : SATA controllers w/ native interface.
  1024. * pmp : SATA controllers w/ PMP support.
  1025. * sff : SFF ATA controllers w/o BMDMA support.
  1026. * bmdma : SFF ATA controllers w/ BMDMA support.
  1027. *
  1028. * sht initializers
  1029. *
  1030. * BASE : Common to all libata drivers. The user must set
  1031. * sg_tablesize and dma_boundary.
  1032. * PIO : SFF ATA controllers w/ only PIO support.
  1033. * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
  1034. * dma_boundary are set to BMDMA limits.
  1035. * NCQ : SATA controllers supporting NCQ. The user must set
  1036. * sg_tablesize, dma_boundary and can_queue.
  1037. */
  1038. extern const struct ata_port_operations ata_base_port_ops;
  1039. extern const struct ata_port_operations sata_port_ops;
  1040. extern struct device_attribute *ata_common_sdev_attrs[];
  1041. #define ATA_BASE_SHT(drv_name) \
  1042. .module = THIS_MODULE, \
  1043. .name = drv_name, \
  1044. .ioctl = ata_scsi_ioctl, \
  1045. .queuecommand = ata_scsi_queuecmd, \
  1046. .can_queue = ATA_DEF_QUEUE, \
  1047. .this_id = ATA_SHT_THIS_ID, \
  1048. .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
  1049. .emulated = ATA_SHT_EMULATED, \
  1050. .use_clustering = ATA_SHT_USE_CLUSTERING, \
  1051. .proc_name = drv_name, \
  1052. .slave_configure = ata_scsi_slave_config, \
  1053. .slave_destroy = ata_scsi_slave_destroy, \
  1054. .bios_param = ata_std_bios_param, \
  1055. .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
  1056. .sdev_attrs = ata_common_sdev_attrs
  1057. #define ATA_NCQ_SHT(drv_name) \
  1058. ATA_BASE_SHT(drv_name), \
  1059. .change_queue_depth = ata_scsi_change_queue_depth
  1060. /*
  1061. * PMP helpers
  1062. */
  1063. #ifdef CONFIG_SATA_PMP
  1064. static inline bool sata_pmp_supported(struct ata_port *ap)
  1065. {
  1066. return ap->flags & ATA_FLAG_PMP;
  1067. }
  1068. static inline bool sata_pmp_attached(struct ata_port *ap)
  1069. {
  1070. return ap->nr_pmp_links != 0;
  1071. }
  1072. static inline int ata_is_host_link(const struct ata_link *link)
  1073. {
  1074. return link == &link->ap->link || link == link->ap->slave_link;
  1075. }
  1076. #else /* CONFIG_SATA_PMP */
  1077. static inline bool sata_pmp_supported(struct ata_port *ap)
  1078. {
  1079. return false;
  1080. }
  1081. static inline bool sata_pmp_attached(struct ata_port *ap)
  1082. {
  1083. return false;
  1084. }
  1085. static inline int ata_is_host_link(const struct ata_link *link)
  1086. {
  1087. return 1;
  1088. }
  1089. #endif /* CONFIG_SATA_PMP */
  1090. static inline int sata_srst_pmp(struct ata_link *link)
  1091. {
  1092. if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
  1093. return SATA_PMP_CTRL_PORT;
  1094. return link->pmp;
  1095. }
  1096. /*
  1097. * printk helpers
  1098. */
  1099. __printf(3, 4)
  1100. int ata_port_printk(const struct ata_port *ap, const char *level,
  1101. const char *fmt, ...);
  1102. __printf(3, 4)
  1103. int ata_link_printk(const struct ata_link *link, const char *level,
  1104. const char *fmt, ...);
  1105. __printf(3, 4)
  1106. int ata_dev_printk(const struct ata_device *dev, const char *level,
  1107. const char *fmt, ...);
  1108. #define ata_port_err(ap, fmt, ...) \
  1109. ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
  1110. #define ata_port_warn(ap, fmt, ...) \
  1111. ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
  1112. #define ata_port_notice(ap, fmt, ...) \
  1113. ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
  1114. #define ata_port_info(ap, fmt, ...) \
  1115. ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
  1116. #define ata_port_dbg(ap, fmt, ...) \
  1117. ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
  1118. #define ata_link_err(link, fmt, ...) \
  1119. ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
  1120. #define ata_link_warn(link, fmt, ...) \
  1121. ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
  1122. #define ata_link_notice(link, fmt, ...) \
  1123. ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
  1124. #define ata_link_info(link, fmt, ...) \
  1125. ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
  1126. #define ata_link_dbg(link, fmt, ...) \
  1127. ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
  1128. #define ata_dev_err(dev, fmt, ...) \
  1129. ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
  1130. #define ata_dev_warn(dev, fmt, ...) \
  1131. ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
  1132. #define ata_dev_notice(dev, fmt, ...) \
  1133. ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
  1134. #define ata_dev_info(dev, fmt, ...) \
  1135. ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
  1136. #define ata_dev_dbg(dev, fmt, ...) \
  1137. ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
  1138. void ata_print_version(const struct device *dev, const char *version);
  1139. /*
  1140. * ata_eh_info helpers
  1141. */
  1142. extern __printf(2, 3)
  1143. void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
  1144. extern __printf(2, 3)
  1145. void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
  1146. extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
  1147. static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
  1148. {
  1149. ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
  1150. ehi->flags |= ATA_EHI_HOTPLUGGED;
  1151. ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
  1152. ehi->err_mask |= AC_ERR_ATA_BUS;
  1153. }
  1154. /*
  1155. * port description helpers
  1156. */
  1157. extern __printf(2, 3)
  1158. void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
  1159. #ifdef CONFIG_PCI
  1160. extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
  1161. const char *name);
  1162. #endif
  1163. static inline unsigned int ata_tag_valid(unsigned int tag)
  1164. {
  1165. return (tag < ATA_MAX_QUEUE) ? 1 : 0;
  1166. }
  1167. static inline unsigned int ata_tag_internal(unsigned int tag)
  1168. {
  1169. return tag == ATA_TAG_INTERNAL;
  1170. }
  1171. /*
  1172. * device helpers
  1173. */
  1174. static inline unsigned int ata_class_enabled(unsigned int class)
  1175. {
  1176. return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
  1177. class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
  1178. }
  1179. static inline unsigned int ata_class_disabled(unsigned int class)
  1180. {
  1181. return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
  1182. class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
  1183. }
  1184. static inline unsigned int ata_class_absent(unsigned int class)
  1185. {
  1186. return !ata_class_enabled(class) && !ata_class_disabled(class);
  1187. }
  1188. static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
  1189. {
  1190. return ata_class_enabled(dev->class);
  1191. }
  1192. static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
  1193. {
  1194. return ata_class_disabled(dev->class);
  1195. }
  1196. static inline unsigned int ata_dev_absent(const struct ata_device *dev)
  1197. {
  1198. return ata_class_absent(dev->class);
  1199. }
  1200. /*
  1201. * link helpers
  1202. */
  1203. static inline int ata_link_max_devices(const struct ata_link *link)
  1204. {
  1205. if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
  1206. return 2;
  1207. return 1;
  1208. }
  1209. static inline int ata_link_active(struct ata_link *link)
  1210. {
  1211. return ata_tag_valid(link->active_tag) || link->sactive;
  1212. }
  1213. /*
  1214. * Iterators
  1215. *
  1216. * ATA_LITER_* constants are used to select link iteration mode and
  1217. * ATA_DITER_* device iteration mode.
  1218. *
  1219. * For a custom iteration directly using ata_{link|dev}_next(), if
  1220. * @link or @dev, respectively, is NULL, the first element is
  1221. * returned. @dev and @link can be any valid device or link and the
  1222. * next element according to the iteration mode will be returned.
  1223. * After the last element, NULL is returned.
  1224. */
  1225. enum ata_link_iter_mode {
  1226. ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
  1227. * host link. no slave link */
  1228. ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
  1229. ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
  1230. * slave link still comes after host link */
  1231. };
  1232. enum ata_dev_iter_mode {
  1233. ATA_DITER_ENABLED,
  1234. ATA_DITER_ENABLED_REVERSE,
  1235. ATA_DITER_ALL,
  1236. ATA_DITER_ALL_REVERSE,
  1237. };
  1238. extern struct ata_link *ata_link_next(struct ata_link *link,
  1239. struct ata_port *ap,
  1240. enum ata_link_iter_mode mode);
  1241. extern struct ata_device *ata_dev_next(struct ata_device *dev,
  1242. struct ata_link *link,
  1243. enum ata_dev_iter_mode mode);
  1244. /*
  1245. * Shortcut notation for iterations
  1246. *
  1247. * ata_for_each_link() iterates over each link of @ap according to
  1248. * @mode. @link points to the current link in the loop. @link is
  1249. * NULL after loop termination. ata_for_each_dev() works the same way
  1250. * except that it iterates over each device of @link.
  1251. *
  1252. * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
  1253. * specified when using the following shorthand notations. Only the
  1254. * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
  1255. * specified. This not only increases brevity but also makes it
  1256. * impossible to use ATA_LITER_* for device iteration or vice-versa.
  1257. */
  1258. #define ata_for_each_link(link, ap, mode) \
  1259. for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
  1260. (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
  1261. #define ata_for_each_dev(dev, link, mode) \
  1262. for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
  1263. (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
  1264. /**
  1265. * ata_ncq_enabled - Test whether NCQ is enabled
  1266. * @dev: ATA device to test for
  1267. *
  1268. * LOCKING:
  1269. * spin_lock_irqsave(host lock)
  1270. *
  1271. * RETURNS:
  1272. * 1 if NCQ is enabled for @dev, 0 otherwise.
  1273. */
  1274. static inline int ata_ncq_enabled(struct ata_device *dev)
  1275. {
  1276. return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
  1277. ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
  1278. }
  1279. static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
  1280. {
  1281. qc->tf.ctl |= ATA_NIEN;
  1282. }
  1283. static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
  1284. unsigned int tag)
  1285. {
  1286. if (likely(ata_tag_valid(tag)))
  1287. return &ap->qcmd[tag];
  1288. return NULL;
  1289. }
  1290. static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
  1291. unsigned int tag)
  1292. {
  1293. struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
  1294. if (unlikely(!qc) || !ap->ops->error_handler)
  1295. return qc;
  1296. if ((qc->flags & (ATA_QCFLAG_ACTIVE |
  1297. ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
  1298. return qc;
  1299. return NULL;
  1300. }
  1301. static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
  1302. {
  1303. return qc->nbytes - min(qc->extrabytes, qc->nbytes);
  1304. }
  1305. static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
  1306. {
  1307. memset(tf, 0, sizeof(*tf));
  1308. #ifdef CONFIG_ATA_SFF
  1309. tf->ctl = dev->link->ap->ctl;
  1310. #else
  1311. tf->ctl = ATA_DEVCTL_OBS;
  1312. #endif
  1313. if (dev->devno == 0)
  1314. tf->device = ATA_DEVICE_OBS;
  1315. else
  1316. tf->device = ATA_DEVICE_OBS | ATA_DEV1;
  1317. }
  1318. static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
  1319. {
  1320. qc->dma_dir = DMA_NONE;
  1321. qc->sg = NULL;
  1322. qc->flags = 0;
  1323. qc->cursg = NULL;
  1324. qc->cursg_ofs = 0;
  1325. qc->nbytes = qc->extrabytes = qc->curbytes = 0;
  1326. qc->n_elem = 0;
  1327. qc->err_mask = 0;
  1328. qc->sect_size = ATA_SECT_SIZE;
  1329. ata_tf_init(qc->dev, &qc->tf);
  1330. /* init result_tf such that it indicates normal completion */
  1331. qc->result_tf.command = ATA_DRDY;
  1332. qc->result_tf.feature = 0;
  1333. }
  1334. static inline int ata_try_flush_cache(const struct ata_device *dev)
  1335. {
  1336. return ata_id_wcache_enabled(dev->id) ||
  1337. ata_id_has_flush(dev->id) ||
  1338. ata_id_has_flush_ext(dev->id);
  1339. }
  1340. static inline unsigned int ac_err_mask(u8 status)
  1341. {
  1342. if (status & (ATA_BUSY | ATA_DRQ))
  1343. return AC_ERR_HSM;
  1344. if (status & (ATA_ERR | ATA_DF))
  1345. return AC_ERR_DEV;
  1346. return 0;
  1347. }
  1348. static inline unsigned int __ac_err_mask(u8 status)
  1349. {
  1350. unsigned int mask = ac_err_mask(status);
  1351. if (mask == 0)
  1352. return AC_ERR_OTHER;
  1353. return mask;
  1354. }
  1355. static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
  1356. {
  1357. return *(struct ata_port **)&host->hostdata[0];
  1358. }
  1359. static inline int ata_check_ready(u8 status)
  1360. {
  1361. if (!(status & ATA_BUSY))
  1362. return 1;
  1363. /* 0xff indicates either no device or device not ready */
  1364. if (status == 0xff)
  1365. return -ENODEV;
  1366. return 0;
  1367. }
  1368. static inline unsigned long ata_deadline(unsigned long from_jiffies,
  1369. unsigned long timeout_msecs)
  1370. {
  1371. return from_jiffies + msecs_to_jiffies(timeout_msecs);
  1372. }
  1373. /* Don't open code these in drivers as there are traps. Firstly the range may
  1374. change in future hardware and specs, secondly 0xFF means 'no DMA' but is
  1375. > UDMA_0. Dyma ddreigiau */
  1376. static inline int ata_using_mwdma(struct ata_device *adev)
  1377. {
  1378. if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
  1379. return 1;
  1380. return 0;
  1381. }
  1382. static inline int ata_using_udma(struct ata_device *adev)
  1383. {
  1384. if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
  1385. return 1;
  1386. return 0;
  1387. }
  1388. static inline int ata_dma_enabled(struct ata_device *adev)
  1389. {
  1390. return (adev->dma_mode == 0xFF ? 0 : 1);
  1391. }
  1392. /**************************************************************************
  1393. * PMP - drivers/ata/libata-pmp.c
  1394. */
  1395. #ifdef CONFIG_SATA_PMP
  1396. extern const struct ata_port_operations sata_pmp_port_ops;
  1397. extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
  1398. extern void sata_pmp_error_handler(struct ata_port *ap);
  1399. #else /* CONFIG_SATA_PMP */
  1400. #define sata_pmp_port_ops sata_port_ops
  1401. #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
  1402. #define sata_pmp_error_handler ata_std_error_handler
  1403. #endif /* CONFIG_SATA_PMP */
  1404. /**************************************************************************
  1405. * SFF - drivers/ata/libata-sff.c
  1406. */
  1407. #ifdef CONFIG_ATA_SFF
  1408. extern const struct ata_port_operations ata_sff_port_ops;
  1409. extern const struct ata_port_operations ata_bmdma32_port_ops;
  1410. /* PIO only, sg_tablesize and dma_boundary limits can be removed */
  1411. #define ATA_PIO_SHT(drv_name) \
  1412. ATA_BASE_SHT(drv_name), \
  1413. .sg_tablesize = LIBATA_MAX_PRD, \
  1414. .dma_boundary = ATA_DMA_BOUNDARY
  1415. extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
  1416. extern u8 ata_sff_check_status(struct ata_port *ap);
  1417. extern void ata_sff_pause(struct ata_port *ap);
  1418. extern void ata_sff_dma_pause(struct ata_port *ap);
  1419. extern int ata_sff_busy_sleep(struct ata_port *ap,
  1420. unsigned long timeout_pat, unsigned long timeout);
  1421. extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
  1422. extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
  1423. extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
  1424. extern void ata_sff_exec_command(struct ata_port *ap,
  1425. const struct ata_taskfile *tf);
  1426. extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
  1427. unsigned char *buf, unsigned int buflen, int rw);
  1428. extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
  1429. unsigned char *buf, unsigned int buflen, int rw);
  1430. extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
  1431. unsigned char *buf, unsigned int buflen, int rw);
  1432. extern void ata_sff_irq_on(struct ata_port *ap);
  1433. extern void ata_sff_irq_clear(struct ata_port *ap);
  1434. extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
  1435. u8 status, int in_wq);
  1436. extern void ata_sff_queue_work(struct work_struct *work);
  1437. extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
  1438. unsigned long delay);
  1439. extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
  1440. extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
  1441. extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
  1442. extern unsigned int ata_sff_port_intr(struct ata_port *ap,
  1443. struct ata_queued_cmd *qc);
  1444. extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
  1445. extern void ata_sff_lost_interrupt(struct ata_port *ap);
  1446. extern void ata_sff_freeze(struct ata_port *ap);
  1447. extern void ata_sff_thaw(struct ata_port *ap);
  1448. extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
  1449. extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
  1450. u8 *r_err);
  1451. extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
  1452. unsigned long deadline);
  1453. extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
  1454. unsigned long deadline);
  1455. extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
  1456. unsigned long deadline);
  1457. extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
  1458. extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
  1459. extern void ata_sff_error_handler(struct ata_port *ap);
  1460. extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
  1461. #ifdef CONFIG_PCI
  1462. extern int ata_pci_sff_init_host(struct ata_host *host);
  1463. extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
  1464. const struct ata_port_info * const * ppi,
  1465. struct ata_host **r_host);
  1466. extern int ata_pci_sff_activate_host(struct ata_host *host,
  1467. irq_handler_t irq_handler,
  1468. struct scsi_host_template *sht);
  1469. extern int ata_pci_sff_init_one(struct pci_dev *pdev,
  1470. const struct ata_port_info * const * ppi,
  1471. struct scsi_host_template *sht, void *host_priv, int hflags);
  1472. #endif /* CONFIG_PCI */
  1473. #ifdef CONFIG_ATA_BMDMA
  1474. extern const struct ata_port_operations ata_bmdma_port_ops;
  1475. #define ATA_BMDMA_SHT(drv_name) \
  1476. ATA_BASE_SHT(drv_name), \
  1477. .sg_tablesize = LIBATA_MAX_PRD, \
  1478. .dma_boundary = ATA_DMA_BOUNDARY
  1479. extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
  1480. extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
  1481. extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
  1482. extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
  1483. struct ata_queued_cmd *qc);
  1484. extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
  1485. extern void ata_bmdma_error_handler(struct ata_port *ap);
  1486. extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
  1487. extern void ata_bmdma_irq_clear(struct ata_port *ap);
  1488. extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
  1489. extern void ata_bmdma_start(struct ata_queued_cmd *qc);
  1490. extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
  1491. extern u8 ata_bmdma_status(struct ata_port *ap);
  1492. extern int ata_bmdma_port_start(struct ata_port *ap);
  1493. extern int ata_bmdma_port_start32(struct ata_port *ap);
  1494. #ifdef CONFIG_PCI
  1495. extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
  1496. extern void ata_pci_bmdma_init(struct ata_host *host);
  1497. extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
  1498. const struct ata_port_info * const * ppi,
  1499. struct ata_host **r_host);
  1500. extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
  1501. const struct ata_port_info * const * ppi,
  1502. struct scsi_host_template *sht,
  1503. void *host_priv, int hflags);
  1504. #endif /* CONFIG_PCI */
  1505. #endif /* CONFIG_ATA_BMDMA */
  1506. /**
  1507. * ata_sff_busy_wait - Wait for a port status register
  1508. * @ap: Port to wait for.
  1509. * @bits: bits that must be clear
  1510. * @max: number of 10uS waits to perform
  1511. *
  1512. * Waits up to max*10 microseconds for the selected bits in the port's
  1513. * status register to be cleared.
  1514. * Returns final value of status register.
  1515. *
  1516. * LOCKING:
  1517. * Inherited from caller.
  1518. */
  1519. static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
  1520. unsigned int max)
  1521. {
  1522. u8 status;
  1523. do {
  1524. udelay(10);
  1525. status = ap->ops->sff_check_status(ap);
  1526. max--;
  1527. } while (status != 0xff && (status & bits) && (max > 0));
  1528. return status;
  1529. }
  1530. /**
  1531. * ata_wait_idle - Wait for a port to be idle.
  1532. * @ap: Port to wait for.
  1533. *
  1534. * Waits up to 10ms for port's BUSY and DRQ signals to clear.
  1535. * Returns final value of status register.
  1536. *
  1537. * LOCKING:
  1538. * Inherited from caller.
  1539. */
  1540. static inline u8 ata_wait_idle(struct ata_port *ap)
  1541. {
  1542. u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
  1543. #ifdef ATA_DEBUG
  1544. if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
  1545. ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
  1546. status);
  1547. #endif
  1548. return status;
  1549. }
  1550. #endif /* CONFIG_ATA_SFF */
  1551. #endif /* __LINUX_LIBATA_H__ */