libata.h 56 KB

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