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