libata.h 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442
  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/interrupt.h>
  29. #include <linux/dma-mapping.h>
  30. #include <linux/scatterlist.h>
  31. #include <linux/io.h>
  32. #include <linux/ata.h>
  33. #include <linux/workqueue.h>
  34. #include <scsi/scsi_host.h>
  35. #include <linux/acpi.h>
  36. /*
  37. * Define if arch has non-standard setup. This is a _PCI_ standard
  38. * not a legacy or ISA standard.
  39. */
  40. #ifdef CONFIG_ATA_NONSTANDARD
  41. #include <asm/libata-portmap.h>
  42. #else
  43. #include <asm-generic/libata-portmap.h>
  44. #endif
  45. /*
  46. * compile-time options: to be removed as soon as all the drivers are
  47. * converted to the new debugging mechanism
  48. */
  49. #undef ATA_DEBUG /* debugging output */
  50. #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
  51. #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
  52. #undef ATA_NDEBUG /* define to disable quick runtime checks */
  53. /* note: prints function name for you */
  54. #ifdef ATA_DEBUG
  55. #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  56. #ifdef ATA_VERBOSE_DEBUG
  57. #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  58. #else
  59. #define VPRINTK(fmt, args...)
  60. #endif /* ATA_VERBOSE_DEBUG */
  61. #else
  62. #define DPRINTK(fmt, args...)
  63. #define VPRINTK(fmt, args...)
  64. #endif /* ATA_DEBUG */
  65. #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  66. /* NEW: debug levels */
  67. #define HAVE_LIBATA_MSG 1
  68. enum {
  69. ATA_MSG_DRV = 0x0001,
  70. ATA_MSG_INFO = 0x0002,
  71. ATA_MSG_PROBE = 0x0004,
  72. ATA_MSG_WARN = 0x0008,
  73. ATA_MSG_MALLOC = 0x0010,
  74. ATA_MSG_CTL = 0x0020,
  75. ATA_MSG_INTR = 0x0040,
  76. ATA_MSG_ERR = 0x0080,
  77. };
  78. #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
  79. #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
  80. #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
  81. #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
  82. #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  83. #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
  84. #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
  85. #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
  86. static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
  87. {
  88. if (dval < 0 || dval >= (sizeof(u32) * 8))
  89. return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
  90. if (!dval)
  91. return 0;
  92. return (1 << dval) - 1;
  93. }
  94. /* defines only for the constants which don't work well as enums */
  95. #define ATA_TAG_POISON 0xfafbfcfdU
  96. enum {
  97. /* various global constants */
  98. LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
  99. LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
  100. ATA_MAX_PORTS = 8,
  101. ATA_DEF_QUEUE = 1,
  102. /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
  103. ATA_MAX_QUEUE = 32,
  104. ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
  105. ATA_MAX_BUS = 2,
  106. ATA_DEF_BUSY_WAIT = 10000,
  107. ATA_SHORT_PAUSE = (HZ >> 6) + 1,
  108. ATAPI_MAX_DRAIN = 16 << 10,
  109. ATA_SHT_EMULATED = 1,
  110. ATA_SHT_CMD_PER_LUN = 1,
  111. ATA_SHT_THIS_ID = -1,
  112. ATA_SHT_USE_CLUSTERING = 1,
  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_HIPM = (1 << 8), /* device supports HIPM */
  123. ATA_DFLAG_DIPM = (1 << 9), /* device supports DIPM */
  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_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
  128. ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
  129. ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
  130. ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
  131. ATA_DFLAG_DETACH = (1 << 24),
  132. ATA_DFLAG_DETACHED = (1 << 25),
  133. ATA_DEV_UNKNOWN = 0, /* unknown device */
  134. ATA_DEV_ATA = 1, /* ATA device */
  135. ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
  136. ATA_DEV_ATAPI = 3, /* ATAPI device */
  137. ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
  138. ATA_DEV_PMP = 5, /* SATA port multiplier */
  139. ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
  140. ATA_DEV_SEMB = 7, /* SEMB */
  141. ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
  142. ATA_DEV_NONE = 9, /* no device */
  143. /* struct ata_link flags */
  144. ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */
  145. ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H
  146. * Register FIS clearing BSY */
  147. ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
  148. ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
  149. ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
  150. ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
  151. ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
  152. ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
  153. /* struct ata_port flags */
  154. ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
  155. /* (doesn't imply presence) */
  156. ATA_FLAG_SATA = (1 << 1),
  157. ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
  158. ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
  159. ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
  160. ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
  161. ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
  162. ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
  163. ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
  164. ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
  165. * doesn't handle PIO interrupts */
  166. ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
  167. ATA_FLAG_DEBUGMSG = (1 << 13),
  168. ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
  169. ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
  170. ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
  171. ATA_FLAG_AN = (1 << 18), /* controller supports AN */
  172. ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
  173. ATA_FLAG_IPM = (1 << 20), /* driver can handle IPM */
  174. /* The following flag belongs to ap->pflags but is kept in
  175. * ap->flags because it's referenced in many LLDs and will be
  176. * removed in not-too-distant future.
  177. */
  178. ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
  179. /* bits 24:31 of ap->flags are reserved for LLD specific flags */
  180. /* struct ata_port pflags */
  181. ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
  182. ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
  183. ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
  184. ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
  185. ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
  186. ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
  187. ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
  188. ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
  189. ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
  190. ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
  191. ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
  192. ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
  193. /* struct ata_queued_cmd flags */
  194. ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
  195. ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
  196. ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
  197. ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
  198. ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
  199. ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
  200. ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
  201. ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
  202. ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
  203. ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
  204. ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
  205. /* host set flags */
  206. ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
  207. ATA_HOST_STARTED = (1 << 1), /* Host started */
  208. /* bits 24:31 of host->flags are reserved for LLD specific flags */
  209. /* various lengths of time */
  210. ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
  211. ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
  212. ATA_TMOUT_INTERNAL = 30 * HZ,
  213. ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
  214. /* FIXME: GoVault needs 2s but we can't afford that without
  215. * parallel probing. 800ms is enough for iVDR disk
  216. * HHD424020F7SV00. Increase to 2secs when parallel probing
  217. * is in place.
  218. */
  219. ATA_TMOUT_FF_WAIT = 4 * HZ / 5,
  220. /* ATA bus states */
  221. BUS_UNKNOWN = 0,
  222. BUS_DMA = 1,
  223. BUS_IDLE = 2,
  224. BUS_NOINTR = 3,
  225. BUS_NODATA = 4,
  226. BUS_TIMER = 5,
  227. BUS_PIO = 6,
  228. BUS_EDD = 7,
  229. BUS_IDENTIFY = 8,
  230. BUS_PACKET = 9,
  231. /* SATA port states */
  232. PORT_UNKNOWN = 0,
  233. PORT_ENABLED = 1,
  234. PORT_DISABLED = 2,
  235. /* encoding various smaller bitmaps into a single
  236. * unsigned long bitmap
  237. */
  238. ATA_NR_PIO_MODES = 7,
  239. ATA_NR_MWDMA_MODES = 5,
  240. ATA_NR_UDMA_MODES = 8,
  241. ATA_SHIFT_PIO = 0,
  242. ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
  243. ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
  244. /* size of buffer to pad xfers ending on unaligned boundaries */
  245. ATA_DMA_PAD_SZ = 4,
  246. ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
  247. /* ering size */
  248. ATA_ERING_SIZE = 32,
  249. /* return values for ->qc_defer */
  250. ATA_DEFER_LINK = 1,
  251. ATA_DEFER_PORT = 2,
  252. /* desc_len for ata_eh_info and context */
  253. ATA_EH_DESC_LEN = 80,
  254. /* reset / recovery action types */
  255. ATA_EH_REVALIDATE = (1 << 0),
  256. ATA_EH_SOFTRESET = (1 << 1),
  257. ATA_EH_HARDRESET = (1 << 2),
  258. ATA_EH_ENABLE_LINK = (1 << 3),
  259. ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
  260. ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
  261. /* ata_eh_info->flags */
  262. ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
  263. ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
  264. ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
  265. ATA_EHI_QUIET = (1 << 3), /* be quiet */
  266. ATA_EHI_LPM = (1 << 4), /* link power management action */
  267. ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
  268. ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
  269. ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
  270. ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
  271. ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
  272. ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
  273. ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
  274. /* max tries if error condition is still set after ->error_handler */
  275. ATA_EH_MAX_TRIES = 5,
  276. /* how hard are we gonna try to probe/recover devices */
  277. ATA_PROBE_MAX_TRIES = 3,
  278. ATA_EH_DEV_TRIES = 3,
  279. ATA_EH_PMP_TRIES = 5,
  280. ATA_EH_PMP_LINK_TRIES = 3,
  281. SATA_PMP_SCR_TIMEOUT = 250,
  282. /* Horkage types. May be set by libata or controller on drives
  283. (some horkage may be drive/controller pair dependant */
  284. ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
  285. ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
  286. ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
  287. ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
  288. ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
  289. ATA_HORKAGE_SKIP_PM = (1 << 5), /* Skip PM operations */
  290. ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
  291. ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
  292. ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
  293. ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
  294. /* DMA mask for user DMA control: User visible values; DO NOT
  295. renumber */
  296. ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
  297. ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
  298. ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
  299. };
  300. enum ata_xfer_mask {
  301. ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
  302. << ATA_SHIFT_PIO,
  303. ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
  304. << ATA_SHIFT_MWDMA,
  305. ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
  306. << ATA_SHIFT_UDMA,
  307. };
  308. enum hsm_task_states {
  309. HSM_ST_IDLE, /* no command on going */
  310. HSM_ST_FIRST, /* (waiting the device to)
  311. write CDB or first data block */
  312. HSM_ST, /* (waiting the device to) transfer data */
  313. HSM_ST_LAST, /* (waiting the device to) complete command */
  314. HSM_ST_ERR, /* error */
  315. };
  316. enum ata_completion_errors {
  317. AC_ERR_DEV = (1 << 0), /* device reported error */
  318. AC_ERR_HSM = (1 << 1), /* host state machine violation */
  319. AC_ERR_TIMEOUT = (1 << 2), /* timeout */
  320. AC_ERR_MEDIA = (1 << 3), /* media error */
  321. AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
  322. AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
  323. AC_ERR_SYSTEM = (1 << 6), /* system error */
  324. AC_ERR_INVALID = (1 << 7), /* invalid argument */
  325. AC_ERR_OTHER = (1 << 8), /* unknown */
  326. AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
  327. AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
  328. };
  329. /* forward declarations */
  330. struct scsi_device;
  331. struct ata_port_operations;
  332. struct ata_port;
  333. struct ata_link;
  334. struct ata_queued_cmd;
  335. /* typedefs */
  336. typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
  337. typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
  338. typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
  339. unsigned long deadline);
  340. typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
  341. /*
  342. * host pm policy: If you alter this, you also need to alter libata-scsi.c
  343. * (for the ascii descriptions)
  344. */
  345. enum link_pm {
  346. NOT_AVAILABLE,
  347. MIN_POWER,
  348. MAX_PERFORMANCE,
  349. MEDIUM_POWER,
  350. };
  351. extern struct class_device_attribute class_device_attr_link_power_management_policy;
  352. struct ata_ioports {
  353. void __iomem *cmd_addr;
  354. void __iomem *data_addr;
  355. void __iomem *error_addr;
  356. void __iomem *feature_addr;
  357. void __iomem *nsect_addr;
  358. void __iomem *lbal_addr;
  359. void __iomem *lbam_addr;
  360. void __iomem *lbah_addr;
  361. void __iomem *device_addr;
  362. void __iomem *status_addr;
  363. void __iomem *command_addr;
  364. void __iomem *altstatus_addr;
  365. void __iomem *ctl_addr;
  366. void __iomem *bmdma_addr;
  367. void __iomem *scr_addr;
  368. };
  369. struct ata_host {
  370. spinlock_t lock;
  371. struct device *dev;
  372. void __iomem * const *iomap;
  373. unsigned int n_ports;
  374. void *private_data;
  375. const struct ata_port_operations *ops;
  376. unsigned long flags;
  377. #ifdef CONFIG_ATA_ACPI
  378. acpi_handle acpi_handle;
  379. #endif
  380. struct ata_port *simplex_claimed; /* channel owning the DMA */
  381. struct ata_port *ports[0];
  382. };
  383. struct ata_queued_cmd {
  384. struct ata_port *ap;
  385. struct ata_device *dev;
  386. struct scsi_cmnd *scsicmd;
  387. void (*scsidone)(struct scsi_cmnd *);
  388. struct ata_taskfile tf;
  389. u8 cdb[ATAPI_CDB_LEN];
  390. unsigned long flags; /* ATA_QCFLAG_xxx */
  391. unsigned int tag;
  392. unsigned int n_elem;
  393. unsigned int n_iter;
  394. unsigned int orig_n_elem;
  395. int dma_dir;
  396. unsigned int pad_len;
  397. unsigned int sect_size;
  398. unsigned int nbytes;
  399. unsigned int curbytes;
  400. struct scatterlist *cursg;
  401. unsigned int cursg_ofs;
  402. struct scatterlist sgent;
  403. struct scatterlist pad_sgent;
  404. void *buf_virt;
  405. /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
  406. struct scatterlist *__sg;
  407. unsigned int err_mask;
  408. struct ata_taskfile result_tf;
  409. ata_qc_cb_t complete_fn;
  410. void *private_data;
  411. void *lldd_task;
  412. };
  413. struct ata_port_stats {
  414. unsigned long unhandled_irq;
  415. unsigned long idle_irq;
  416. unsigned long rw_reqbuf;
  417. };
  418. struct ata_ering_entry {
  419. unsigned int eflags;
  420. unsigned int err_mask;
  421. u64 timestamp;
  422. };
  423. struct ata_ering {
  424. int cursor;
  425. struct ata_ering_entry ring[ATA_ERING_SIZE];
  426. };
  427. struct ata_device {
  428. struct ata_link *link;
  429. unsigned int devno; /* 0 or 1 */
  430. unsigned long flags; /* ATA_DFLAG_xxx */
  431. unsigned int horkage; /* List of broken features */
  432. struct scsi_device *sdev; /* attached SCSI device */
  433. #ifdef CONFIG_ATA_ACPI
  434. acpi_handle acpi_handle;
  435. union acpi_object *gtf_cache;
  436. #endif
  437. /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
  438. u64 n_sectors; /* size of device, if ATA */
  439. unsigned int class; /* ATA_DEV_xxx */
  440. union {
  441. u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
  442. u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
  443. };
  444. u8 pio_mode;
  445. u8 dma_mode;
  446. u8 xfer_mode;
  447. unsigned int xfer_shift; /* ATA_SHIFT_xxx */
  448. unsigned int multi_count; /* sectors count for
  449. READ/WRITE MULTIPLE */
  450. unsigned int max_sectors; /* per-device max sectors */
  451. unsigned int cdb_len;
  452. /* per-dev xfer mask */
  453. unsigned long pio_mask;
  454. unsigned long mwdma_mask;
  455. unsigned long udma_mask;
  456. /* for CHS addressing */
  457. u16 cylinders; /* Number of cylinders */
  458. u16 heads; /* Number of heads */
  459. u16 sectors; /* Number of sectors per track */
  460. /* error history */
  461. struct ata_ering ering;
  462. int spdn_cnt;
  463. };
  464. /* Offset into struct ata_device. Fields above it are maintained
  465. * acress device init. Fields below are zeroed.
  466. */
  467. #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
  468. struct ata_eh_info {
  469. struct ata_device *dev; /* offending device */
  470. u32 serror; /* SError from LLDD */
  471. unsigned int err_mask; /* port-wide err_mask */
  472. unsigned int action; /* ATA_EH_* action mask */
  473. unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
  474. unsigned int flags; /* ATA_EHI_* flags */
  475. unsigned int probe_mask;
  476. char desc[ATA_EH_DESC_LEN];
  477. int desc_len;
  478. };
  479. struct ata_eh_context {
  480. struct ata_eh_info i;
  481. int tries[ATA_MAX_DEVICES];
  482. unsigned int classes[ATA_MAX_DEVICES];
  483. unsigned int did_probe_mask;
  484. unsigned int saved_ncq_enabled;
  485. u8 saved_xfer_mode[ATA_MAX_DEVICES];
  486. };
  487. struct ata_acpi_drive
  488. {
  489. u32 pio;
  490. u32 dma;
  491. } __packed;
  492. struct ata_acpi_gtm {
  493. struct ata_acpi_drive drive[2];
  494. u32 flags;
  495. } __packed;
  496. struct ata_link {
  497. struct ata_port *ap;
  498. int pmp; /* port multiplier port # */
  499. unsigned int active_tag; /* active tag on this link */
  500. u32 sactive; /* active NCQ commands */
  501. unsigned int flags; /* ATA_LFLAG_xxx */
  502. unsigned int hw_sata_spd_limit;
  503. unsigned int sata_spd_limit;
  504. unsigned int sata_spd; /* current SATA PHY speed */
  505. /* record runtime error info, protected by host_set lock */
  506. struct ata_eh_info eh_info;
  507. /* EH context */
  508. struct ata_eh_context eh_context;
  509. struct ata_device device[ATA_MAX_DEVICES];
  510. };
  511. struct ata_port {
  512. struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
  513. const struct ata_port_operations *ops;
  514. spinlock_t *lock;
  515. unsigned long flags; /* ATA_FLAG_xxx */
  516. unsigned int pflags; /* ATA_PFLAG_xxx */
  517. unsigned int print_id; /* user visible unique port ID */
  518. unsigned int port_no; /* 0 based port no. inside the host */
  519. struct ata_prd *prd; /* our SG list */
  520. dma_addr_t prd_dma; /* and its DMA mapping */
  521. void *pad; /* array of DMA pad buffers */
  522. dma_addr_t pad_dma;
  523. struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
  524. u8 ctl; /* cache of ATA control register */
  525. u8 last_ctl; /* Cache last written value */
  526. unsigned int pio_mask;
  527. unsigned int mwdma_mask;
  528. unsigned int udma_mask;
  529. unsigned int cbl; /* cable type; ATA_CBL_xxx */
  530. struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
  531. unsigned long qc_allocated;
  532. unsigned int qc_active;
  533. int nr_active_links; /* #links with active qcs */
  534. struct ata_link link; /* host default link */
  535. int nr_pmp_links; /* nr of available PMP links */
  536. struct ata_link *pmp_link; /* array of PMP links */
  537. struct ata_link *excl_link; /* for PMP qc exclusion */
  538. struct ata_port_stats stats;
  539. struct ata_host *host;
  540. struct device *dev;
  541. void *port_task_data;
  542. struct delayed_work port_task;
  543. struct delayed_work hotplug_task;
  544. struct work_struct scsi_rescan_task;
  545. unsigned int hsm_task_state;
  546. u32 msg_enable;
  547. struct list_head eh_done_q;
  548. wait_queue_head_t eh_wait_q;
  549. int eh_tries;
  550. pm_message_t pm_mesg;
  551. int *pm_result;
  552. enum link_pm pm_policy;
  553. struct timer_list fastdrain_timer;
  554. unsigned long fastdrain_cnt;
  555. void *private_data;
  556. #ifdef CONFIG_ATA_ACPI
  557. acpi_handle acpi_handle;
  558. struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
  559. #endif
  560. u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
  561. };
  562. struct ata_port_operations {
  563. void (*dev_config) (struct ata_device *);
  564. void (*set_piomode) (struct ata_port *, struct ata_device *);
  565. void (*set_dmamode) (struct ata_port *, struct ata_device *);
  566. unsigned long (*mode_filter) (struct ata_device *, unsigned long);
  567. void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
  568. void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
  569. void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
  570. u8 (*check_status)(struct ata_port *ap);
  571. u8 (*check_altstatus)(struct ata_port *ap);
  572. void (*dev_select)(struct ata_port *ap, unsigned int device);
  573. void (*phy_reset) (struct ata_port *ap); /* obsolete */
  574. int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
  575. int (*cable_detect) (struct ata_port *ap);
  576. int (*check_atapi_dma) (struct ata_queued_cmd *qc);
  577. void (*bmdma_setup) (struct ata_queued_cmd *qc);
  578. void (*bmdma_start) (struct ata_queued_cmd *qc);
  579. void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
  580. int (*qc_defer) (struct ata_queued_cmd *qc);
  581. void (*qc_prep) (struct ata_queued_cmd *qc);
  582. unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
  583. /* port multiplier */
  584. void (*pmp_attach) (struct ata_port *ap);
  585. void (*pmp_detach) (struct ata_port *ap);
  586. /* Error handlers. ->error_handler overrides ->eng_timeout and
  587. * indicates that new-style EH is in place.
  588. */
  589. void (*eng_timeout) (struct ata_port *ap); /* obsolete */
  590. void (*freeze) (struct ata_port *ap);
  591. void (*thaw) (struct ata_port *ap);
  592. void (*error_handler) (struct ata_port *ap);
  593. void (*post_internal_cmd) (struct ata_queued_cmd *qc);
  594. irq_handler_t irq_handler;
  595. void (*irq_clear) (struct ata_port *);
  596. u8 (*irq_on) (struct ata_port *);
  597. int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
  598. int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
  599. int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
  600. int (*port_resume) (struct ata_port *ap);
  601. int (*enable_pm) (struct ata_port *ap, enum link_pm policy);
  602. void (*disable_pm) (struct ata_port *ap);
  603. int (*port_start) (struct ata_port *ap);
  604. void (*port_stop) (struct ata_port *ap);
  605. void (*host_stop) (struct ata_host *host);
  606. void (*bmdma_stop) (struct ata_queued_cmd *qc);
  607. u8 (*bmdma_status) (struct ata_port *ap);
  608. };
  609. struct ata_port_info {
  610. struct scsi_host_template *sht;
  611. unsigned long flags;
  612. unsigned long link_flags;
  613. unsigned long pio_mask;
  614. unsigned long mwdma_mask;
  615. unsigned long udma_mask;
  616. const struct ata_port_operations *port_ops;
  617. irq_handler_t irq_handler;
  618. void *private_data;
  619. };
  620. struct ata_timing {
  621. unsigned short mode; /* ATA mode */
  622. unsigned short setup; /* t1 */
  623. unsigned short act8b; /* t2 for 8-bit I/O */
  624. unsigned short rec8b; /* t2i for 8-bit I/O */
  625. unsigned short cyc8b; /* t0 for 8-bit I/O */
  626. unsigned short active; /* t2 or tD */
  627. unsigned short recover; /* t2i or tK */
  628. unsigned short cycle; /* t0 */
  629. unsigned short udma; /* t2CYCTYP/2 */
  630. };
  631. #define FIT(v, vmin, vmax) max_t(short, min_t(short, v, vmax), vmin)
  632. extern const unsigned long sata_deb_timing_normal[];
  633. extern const unsigned long sata_deb_timing_hotplug[];
  634. extern const unsigned long sata_deb_timing_long[];
  635. extern const struct ata_port_operations ata_dummy_port_ops;
  636. extern const struct ata_port_info ata_dummy_port_info;
  637. static inline const unsigned long *
  638. sata_ehc_deb_timing(struct ata_eh_context *ehc)
  639. {
  640. if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
  641. return sata_deb_timing_hotplug;
  642. else
  643. return sata_deb_timing_normal;
  644. }
  645. static inline int ata_port_is_dummy(struct ata_port *ap)
  646. {
  647. return ap->ops == &ata_dummy_port_ops;
  648. }
  649. extern void sata_print_link_status(struct ata_link *link);
  650. extern void ata_port_probe(struct ata_port *);
  651. extern void ata_bus_reset(struct ata_port *ap);
  652. extern int sata_set_spd(struct ata_link *link);
  653. extern int sata_link_debounce(struct ata_link *link,
  654. const unsigned long *params, unsigned long deadline);
  655. extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
  656. unsigned long deadline);
  657. extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
  658. extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
  659. unsigned long deadline);
  660. extern int sata_link_hardreset(struct ata_link *link,
  661. const unsigned long *timing, unsigned long deadline);
  662. extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
  663. unsigned long deadline);
  664. extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
  665. extern void ata_port_disable(struct ata_port *);
  666. extern void ata_std_ports(struct ata_ioports *ioaddr);
  667. extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
  668. extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
  669. const struct ata_port_info * const * ppi, int n_ports);
  670. extern int ata_host_start(struct ata_host *host);
  671. extern int ata_host_register(struct ata_host *host,
  672. struct scsi_host_template *sht);
  673. extern int ata_host_activate(struct ata_host *host, int irq,
  674. irq_handler_t irq_handler, unsigned long irq_flags,
  675. struct scsi_host_template *sht);
  676. extern void ata_host_detach(struct ata_host *host);
  677. extern void ata_host_init(struct ata_host *, struct device *,
  678. unsigned long, const struct ata_port_operations *);
  679. extern int ata_scsi_detect(struct scsi_host_template *sht);
  680. extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
  681. extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
  682. extern void ata_sas_port_destroy(struct ata_port *);
  683. extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
  684. struct ata_port_info *, struct Scsi_Host *);
  685. extern int ata_sas_port_init(struct ata_port *);
  686. extern int ata_sas_port_start(struct ata_port *ap);
  687. extern void ata_sas_port_stop(struct ata_port *ap);
  688. extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
  689. extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
  690. struct ata_port *ap);
  691. extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
  692. extern int sata_scr_valid(struct ata_link *link);
  693. extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
  694. extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
  695. extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
  696. extern int ata_link_online(struct ata_link *link);
  697. extern int ata_link_offline(struct ata_link *link);
  698. #ifdef CONFIG_PM
  699. extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
  700. extern void ata_host_resume(struct ata_host *host);
  701. #endif
  702. extern int ata_ratelimit(void);
  703. extern int ata_busy_sleep(struct ata_port *ap,
  704. unsigned long timeout_pat, unsigned long timeout);
  705. extern void ata_wait_after_reset(struct ata_port *ap, unsigned long deadline);
  706. extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
  707. extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
  708. void *data, unsigned long delay);
  709. extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
  710. unsigned long interval_msec,
  711. unsigned long timeout_msec);
  712. extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
  713. u8 *r_err);
  714. /*
  715. * Default driver ops implementations
  716. */
  717. extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
  718. extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
  719. extern void ata_tf_to_fis(const struct ata_taskfile *tf,
  720. u8 pmp, int is_cmd, u8 *fis);
  721. extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
  722. extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
  723. unsigned long mwdma_mask, unsigned long udma_mask);
  724. extern void ata_unpack_xfermask(unsigned long xfer_mask,
  725. unsigned long *pio_mask, unsigned long *mwdma_mask,
  726. unsigned long *udma_mask);
  727. extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
  728. extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
  729. extern int ata_xfer_mode2shift(unsigned long xfer_mode);
  730. extern const char *ata_mode_string(unsigned long xfer_mask);
  731. extern unsigned long ata_id_xfermask(const u16 *id);
  732. extern void ata_noop_dev_select(struct ata_port *ap, unsigned int device);
  733. extern void ata_std_dev_select(struct ata_port *ap, unsigned int device);
  734. extern u8 ata_check_status(struct ata_port *ap);
  735. extern u8 ata_altstatus(struct ata_port *ap);
  736. extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
  737. extern int ata_port_start(struct ata_port *ap);
  738. extern int ata_sff_port_start(struct ata_port *ap);
  739. extern irqreturn_t ata_interrupt(int irq, void *dev_instance);
  740. extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
  741. unsigned int buflen, int write_data);
  742. extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
  743. unsigned int buflen, int write_data);
  744. extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
  745. extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
  746. extern void ata_qc_prep(struct ata_queued_cmd *qc);
  747. extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
  748. extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
  749. extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
  750. unsigned int buflen);
  751. extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
  752. unsigned int n_elem);
  753. extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
  754. extern void ata_dev_disable(struct ata_device *adev);
  755. extern void ata_id_string(const u16 *id, unsigned char *s,
  756. unsigned int ofs, unsigned int len);
  757. extern void ata_id_c_string(const u16 *id, unsigned char *s,
  758. unsigned int ofs, unsigned int len);
  759. extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
  760. extern void ata_bmdma_start(struct ata_queued_cmd *qc);
  761. extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
  762. extern u8 ata_bmdma_status(struct ata_port *ap);
  763. extern void ata_bmdma_irq_clear(struct ata_port *ap);
  764. extern void ata_bmdma_freeze(struct ata_port *ap);
  765. extern void ata_bmdma_thaw(struct ata_port *ap);
  766. extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  767. ata_reset_fn_t softreset,
  768. ata_reset_fn_t hardreset,
  769. ata_postreset_fn_t postreset);
  770. extern void ata_bmdma_error_handler(struct ata_port *ap);
  771. extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
  772. extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
  773. u8 status, int in_wq);
  774. extern void ata_qc_complete(struct ata_queued_cmd *qc);
  775. extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
  776. void (*finish_qc)(struct ata_queued_cmd *));
  777. extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
  778. void (*done)(struct scsi_cmnd *));
  779. extern int ata_std_bios_param(struct scsi_device *sdev,
  780. struct block_device *bdev,
  781. sector_t capacity, int geom[]);
  782. extern int ata_scsi_slave_config(struct scsi_device *sdev);
  783. extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
  784. extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
  785. int queue_depth);
  786. extern struct ata_device *ata_dev_pair(struct ata_device *adev);
  787. extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
  788. extern u8 ata_irq_on(struct ata_port *ap);
  789. extern int ata_cable_40wire(struct ata_port *ap);
  790. extern int ata_cable_80wire(struct ata_port *ap);
  791. extern int ata_cable_sata(struct ata_port *ap);
  792. extern int ata_cable_ignore(struct ata_port *ap);
  793. extern int ata_cable_unknown(struct ata_port *ap);
  794. /*
  795. * Timing helpers
  796. */
  797. extern unsigned int ata_pio_need_iordy(const struct ata_device *);
  798. extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
  799. extern int ata_timing_compute(struct ata_device *, unsigned short,
  800. struct ata_timing *, int, int);
  801. extern void ata_timing_merge(const struct ata_timing *,
  802. const struct ata_timing *, struct ata_timing *,
  803. unsigned int);
  804. extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
  805. enum {
  806. ATA_TIMING_SETUP = (1 << 0),
  807. ATA_TIMING_ACT8B = (1 << 1),
  808. ATA_TIMING_REC8B = (1 << 2),
  809. ATA_TIMING_CYC8B = (1 << 3),
  810. ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
  811. ATA_TIMING_CYC8B,
  812. ATA_TIMING_ACTIVE = (1 << 4),
  813. ATA_TIMING_RECOVER = (1 << 5),
  814. ATA_TIMING_CYCLE = (1 << 6),
  815. ATA_TIMING_UDMA = (1 << 7),
  816. ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
  817. ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
  818. ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
  819. ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
  820. };
  821. /* libata-acpi.c */
  822. #ifdef CONFIG_ATA_ACPI
  823. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  824. {
  825. if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
  826. return &ap->__acpi_init_gtm;
  827. return NULL;
  828. }
  829. extern int ata_acpi_cbl_80wire(struct ata_port *ap);
  830. int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
  831. int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
  832. unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
  833. const struct ata_acpi_gtm *gtm);
  834. #else
  835. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  836. {
  837. return NULL;
  838. }
  839. static inline int ata_acpi_cbl_80wire(struct ata_port *ap) { return 0; }
  840. static inline int ata_acpi_stm(const struct ata_port *ap,
  841. struct ata_acpi_gtm *stm)
  842. {
  843. return -ENOSYS;
  844. }
  845. static inline int ata_acpi_gtm(const struct ata_port *ap,
  846. struct ata_acpi_gtm *stm)
  847. {
  848. return -ENOSYS;
  849. }
  850. static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
  851. const struct ata_acpi_gtm *gtm)
  852. {
  853. return 0;
  854. }
  855. #endif
  856. #ifdef CONFIG_PCI
  857. struct pci_dev;
  858. extern int ata_pci_init_one(struct pci_dev *pdev,
  859. const struct ata_port_info * const * ppi);
  860. extern void ata_pci_remove_one(struct pci_dev *pdev);
  861. #ifdef CONFIG_PM
  862. extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
  863. extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
  864. extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
  865. extern int ata_pci_device_resume(struct pci_dev *pdev);
  866. #endif
  867. extern int ata_pci_clear_simplex(struct pci_dev *pdev);
  868. struct pci_bits {
  869. unsigned int reg; /* PCI config register to read */
  870. unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
  871. unsigned long mask;
  872. unsigned long val;
  873. };
  874. extern int ata_pci_init_sff_host(struct ata_host *host);
  875. extern int ata_pci_init_bmdma(struct ata_host *host);
  876. extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
  877. const struct ata_port_info * const * ppi,
  878. struct ata_host **r_host);
  879. extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
  880. extern unsigned long ata_pci_default_filter(struct ata_device *dev,
  881. unsigned long xfer_mask);
  882. #endif /* CONFIG_PCI */
  883. /*
  884. * PMP
  885. */
  886. extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
  887. extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline);
  888. extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
  889. unsigned long deadline);
  890. extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class);
  891. extern void sata_pmp_do_eh(struct ata_port *ap,
  892. ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
  893. ata_reset_fn_t hardreset, ata_postreset_fn_t postreset,
  894. ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset,
  895. ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset);
  896. /*
  897. * EH
  898. */
  899. extern void ata_port_schedule_eh(struct ata_port *ap);
  900. extern int ata_link_abort(struct ata_link *link);
  901. extern int ata_port_abort(struct ata_port *ap);
  902. extern int ata_port_freeze(struct ata_port *ap);
  903. extern int sata_async_notification(struct ata_port *ap);
  904. extern void ata_eh_freeze_port(struct ata_port *ap);
  905. extern void ata_eh_thaw_port(struct ata_port *ap);
  906. extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
  907. extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
  908. extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  909. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  910. ata_postreset_fn_t postreset);
  911. /*
  912. * printk helpers
  913. */
  914. #define ata_port_printk(ap, lv, fmt, args...) \
  915. printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
  916. #define ata_link_printk(link, lv, fmt, args...) do { \
  917. if ((link)->ap->nr_pmp_links) \
  918. printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
  919. (link)->pmp , ##args); \
  920. else \
  921. printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
  922. } while(0)
  923. #define ata_dev_printk(dev, lv, fmt, args...) \
  924. printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
  925. (dev)->link->pmp + (dev)->devno , ##args)
  926. /*
  927. * ata_eh_info helpers
  928. */
  929. extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
  930. __attribute__ ((format (printf, 2, 3)));
  931. extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
  932. __attribute__ ((format (printf, 2, 3)));
  933. extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
  934. static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
  935. {
  936. ehi->flags |= ATA_EHI_RESUME_LINK;
  937. ehi->action |= ATA_EH_SOFTRESET;
  938. ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
  939. }
  940. static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
  941. {
  942. ata_ehi_schedule_probe(ehi);
  943. ehi->flags |= ATA_EHI_HOTPLUGGED;
  944. ehi->action |= ATA_EH_ENABLE_LINK;
  945. ehi->err_mask |= AC_ERR_ATA_BUS;
  946. }
  947. /*
  948. * port description helpers
  949. */
  950. extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
  951. __attribute__ ((format (printf, 2, 3)));
  952. #ifdef CONFIG_PCI
  953. extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
  954. const char *name);
  955. #endif
  956. /*
  957. * qc helpers
  958. */
  959. static inline struct scatterlist *
  960. ata_qc_first_sg(struct ata_queued_cmd *qc)
  961. {
  962. qc->n_iter = 0;
  963. if (qc->n_elem)
  964. return qc->__sg;
  965. if (qc->pad_len)
  966. return &qc->pad_sgent;
  967. return NULL;
  968. }
  969. static inline struct scatterlist *
  970. ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
  971. {
  972. if (sg == &qc->pad_sgent)
  973. return NULL;
  974. if (++qc->n_iter < qc->n_elem)
  975. return sg_next(sg);
  976. if (qc->pad_len)
  977. return &qc->pad_sgent;
  978. return NULL;
  979. }
  980. #define ata_for_each_sg(sg, qc) \
  981. for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
  982. static inline unsigned int ata_tag_valid(unsigned int tag)
  983. {
  984. return (tag < ATA_MAX_QUEUE) ? 1 : 0;
  985. }
  986. static inline unsigned int ata_tag_internal(unsigned int tag)
  987. {
  988. return tag == ATA_MAX_QUEUE - 1;
  989. }
  990. /*
  991. * device helpers
  992. */
  993. static inline unsigned int ata_class_enabled(unsigned int class)
  994. {
  995. return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
  996. class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
  997. }
  998. static inline unsigned int ata_class_disabled(unsigned int class)
  999. {
  1000. return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
  1001. class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
  1002. }
  1003. static inline unsigned int ata_class_absent(unsigned int class)
  1004. {
  1005. return !ata_class_enabled(class) && !ata_class_disabled(class);
  1006. }
  1007. static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
  1008. {
  1009. return ata_class_enabled(dev->class);
  1010. }
  1011. static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
  1012. {
  1013. return ata_class_disabled(dev->class);
  1014. }
  1015. static inline unsigned int ata_dev_absent(const struct ata_device *dev)
  1016. {
  1017. return ata_class_absent(dev->class);
  1018. }
  1019. /*
  1020. * link helpers
  1021. */
  1022. static inline int ata_is_host_link(const struct ata_link *link)
  1023. {
  1024. return link == &link->ap->link;
  1025. }
  1026. static inline int ata_link_max_devices(const struct ata_link *link)
  1027. {
  1028. if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
  1029. return 2;
  1030. return 1;
  1031. }
  1032. static inline int ata_link_active(struct ata_link *link)
  1033. {
  1034. return ata_tag_valid(link->active_tag) || link->sactive;
  1035. }
  1036. static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
  1037. {
  1038. if (ap->nr_pmp_links)
  1039. return ap->pmp_link;
  1040. return &ap->link;
  1041. }
  1042. static inline struct ata_link *ata_port_next_link(struct ata_link *link)
  1043. {
  1044. struct ata_port *ap = link->ap;
  1045. if (link == &ap->link) {
  1046. if (!ap->nr_pmp_links)
  1047. return NULL;
  1048. return ap->pmp_link;
  1049. }
  1050. if (++link - ap->pmp_link < ap->nr_pmp_links)
  1051. return link;
  1052. return NULL;
  1053. }
  1054. #define __ata_port_for_each_link(lk, ap) \
  1055. for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
  1056. #define ata_port_for_each_link(link, ap) \
  1057. for ((link) = ata_port_first_link(ap); (link); \
  1058. (link) = ata_port_next_link(link))
  1059. #define ata_link_for_each_dev(dev, link) \
  1060. for ((dev) = (link)->device; \
  1061. (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
  1062. (dev)++)
  1063. #define ata_link_for_each_dev_reverse(dev, link) \
  1064. for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
  1065. (dev) >= (link)->device || ((dev) = NULL); (dev)--)
  1066. static inline u8 ata_chk_status(struct ata_port *ap)
  1067. {
  1068. return ap->ops->check_status(ap);
  1069. }
  1070. /**
  1071. * ata_ncq_enabled - Test whether NCQ is enabled
  1072. * @dev: ATA device to test for
  1073. *
  1074. * LOCKING:
  1075. * spin_lock_irqsave(host lock)
  1076. *
  1077. * RETURNS:
  1078. * 1 if NCQ is enabled for @dev, 0 otherwise.
  1079. */
  1080. static inline int ata_ncq_enabled(struct ata_device *dev)
  1081. {
  1082. return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
  1083. ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
  1084. }
  1085. /**
  1086. * ata_pause - Flush writes and pause 400 nanoseconds.
  1087. * @ap: Port to wait for.
  1088. *
  1089. * LOCKING:
  1090. * Inherited from caller.
  1091. */
  1092. static inline void ata_pause(struct ata_port *ap)
  1093. {
  1094. ata_altstatus(ap);
  1095. ndelay(400);
  1096. }
  1097. /**
  1098. * ata_busy_wait - Wait for a port status register
  1099. * @ap: Port to wait for.
  1100. * @bits: bits that must be clear
  1101. * @max: number of 10uS waits to perform
  1102. *
  1103. * Waits up to max*10 microseconds for the selected bits in the port's
  1104. * status register to be cleared.
  1105. * Returns final value of status register.
  1106. *
  1107. * LOCKING:
  1108. * Inherited from caller.
  1109. */
  1110. static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
  1111. unsigned int max)
  1112. {
  1113. u8 status;
  1114. do {
  1115. udelay(10);
  1116. status = ata_chk_status(ap);
  1117. max--;
  1118. } while (status != 0xff && (status & bits) && (max > 0));
  1119. return status;
  1120. }
  1121. /**
  1122. * ata_wait_idle - Wait for a port to be idle.
  1123. * @ap: Port to wait for.
  1124. *
  1125. * Waits up to 10ms for port's BUSY and DRQ signals to clear.
  1126. * Returns final value of status register.
  1127. *
  1128. * LOCKING:
  1129. * Inherited from caller.
  1130. */
  1131. static inline u8 ata_wait_idle(struct ata_port *ap)
  1132. {
  1133. u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
  1134. #ifdef ATA_DEBUG
  1135. if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
  1136. ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
  1137. status);
  1138. #endif
  1139. return status;
  1140. }
  1141. static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
  1142. {
  1143. qc->tf.ctl |= ATA_NIEN;
  1144. }
  1145. static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
  1146. unsigned int tag)
  1147. {
  1148. if (likely(ata_tag_valid(tag)))
  1149. return &ap->qcmd[tag];
  1150. return NULL;
  1151. }
  1152. static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
  1153. unsigned int tag)
  1154. {
  1155. struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
  1156. if (unlikely(!qc) || !ap->ops->error_handler)
  1157. return qc;
  1158. if ((qc->flags & (ATA_QCFLAG_ACTIVE |
  1159. ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
  1160. return qc;
  1161. return NULL;
  1162. }
  1163. static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
  1164. {
  1165. memset(tf, 0, sizeof(*tf));
  1166. tf->ctl = dev->link->ap->ctl;
  1167. if (dev->devno == 0)
  1168. tf->device = ATA_DEVICE_OBS;
  1169. else
  1170. tf->device = ATA_DEVICE_OBS | ATA_DEV1;
  1171. }
  1172. static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
  1173. {
  1174. qc->dma_dir = DMA_NONE;
  1175. qc->__sg = NULL;
  1176. qc->flags = 0;
  1177. qc->cursg = NULL;
  1178. qc->cursg_ofs = 0;
  1179. qc->nbytes = qc->curbytes = 0;
  1180. qc->n_elem = 0;
  1181. qc->n_iter = 0;
  1182. qc->err_mask = 0;
  1183. qc->pad_len = 0;
  1184. qc->sect_size = ATA_SECT_SIZE;
  1185. ata_tf_init(qc->dev, &qc->tf);
  1186. /* init result_tf such that it indicates normal completion */
  1187. qc->result_tf.command = ATA_DRDY;
  1188. qc->result_tf.feature = 0;
  1189. }
  1190. static inline int ata_try_flush_cache(const struct ata_device *dev)
  1191. {
  1192. return ata_id_wcache_enabled(dev->id) ||
  1193. ata_id_has_flush(dev->id) ||
  1194. ata_id_has_flush_ext(dev->id);
  1195. }
  1196. static inline unsigned int ac_err_mask(u8 status)
  1197. {
  1198. if (status & (ATA_BUSY | ATA_DRQ))
  1199. return AC_ERR_HSM;
  1200. if (status & (ATA_ERR | ATA_DF))
  1201. return AC_ERR_DEV;
  1202. return 0;
  1203. }
  1204. static inline unsigned int __ac_err_mask(u8 status)
  1205. {
  1206. unsigned int mask = ac_err_mask(status);
  1207. if (mask == 0)
  1208. return AC_ERR_OTHER;
  1209. return mask;
  1210. }
  1211. static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
  1212. {
  1213. ap->pad_dma = 0;
  1214. ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
  1215. &ap->pad_dma, GFP_KERNEL);
  1216. return (ap->pad == NULL) ? -ENOMEM : 0;
  1217. }
  1218. static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
  1219. {
  1220. dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
  1221. }
  1222. static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
  1223. {
  1224. return *(struct ata_port **)&host->hostdata[0];
  1225. }
  1226. #endif /* __LINUX_LIBATA_H__ */