libata.h 67 KB

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