libata.h 37 KB

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