libata.h 42 KB

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