libata.h 37 KB

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