libata.h 37 KB

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