libata.h 38 KB

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