libata.h 41 KB

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