libata.h 37 KB

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