libata.h 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013
  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/io.h>
  32. #include <linux/ata.h>
  33. #include <linux/workqueue.h>
  34. #include <scsi/scsi_host.h>
  35. /*
  36. * compile-time options: to be removed as soon as all the drivers are
  37. * converted to the new debugging mechanism
  38. */
  39. #undef ATA_DEBUG /* debugging output */
  40. #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
  41. #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
  42. #undef ATA_NDEBUG /* define to disable quick runtime checks */
  43. #undef ATA_ENABLE_PATA /* define to enable PATA support in some
  44. * low-level drivers */
  45. /* note: prints function name for you */
  46. #ifdef ATA_DEBUG
  47. #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  48. #ifdef ATA_VERBOSE_DEBUG
  49. #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  50. #else
  51. #define VPRINTK(fmt, args...)
  52. #endif /* ATA_VERBOSE_DEBUG */
  53. #else
  54. #define DPRINTK(fmt, args...)
  55. #define VPRINTK(fmt, args...)
  56. #endif /* ATA_DEBUG */
  57. #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  58. /* NEW: debug levels */
  59. #define HAVE_LIBATA_MSG 1
  60. enum {
  61. ATA_MSG_DRV = 0x0001,
  62. ATA_MSG_INFO = 0x0002,
  63. ATA_MSG_PROBE = 0x0004,
  64. ATA_MSG_WARN = 0x0008,
  65. ATA_MSG_MALLOC = 0x0010,
  66. ATA_MSG_CTL = 0x0020,
  67. ATA_MSG_INTR = 0x0040,
  68. ATA_MSG_ERR = 0x0080,
  69. };
  70. #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
  71. #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
  72. #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
  73. #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
  74. #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  75. #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
  76. #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
  77. #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
  78. static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
  79. {
  80. if (dval < 0 || dval >= (sizeof(u32) * 8))
  81. return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
  82. if (!dval)
  83. return 0;
  84. return (1 << dval) - 1;
  85. }
  86. /* defines only for the constants which don't work well as enums */
  87. #define ATA_TAG_POISON 0xfafbfcfdU
  88. /* move to PCI layer? */
  89. static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
  90. {
  91. return &pdev->dev;
  92. }
  93. enum {
  94. /* various global constants */
  95. LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
  96. ATA_MAX_PORTS = 8,
  97. ATA_DEF_QUEUE = 1,
  98. /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
  99. ATA_MAX_QUEUE = 2,
  100. ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
  101. ATA_MAX_SECTORS = 200, /* FIXME */
  102. ATA_MAX_BUS = 2,
  103. ATA_DEF_BUSY_WAIT = 10000,
  104. ATA_SHORT_PAUSE = (HZ >> 6) + 1,
  105. ATA_SHT_EMULATED = 1,
  106. ATA_SHT_CMD_PER_LUN = 1,
  107. ATA_SHT_THIS_ID = -1,
  108. ATA_SHT_USE_CLUSTERING = 1,
  109. /* struct ata_device stuff */
  110. ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
  111. ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
  112. ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
  113. ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
  114. ATA_DEV_UNKNOWN = 0, /* unknown device */
  115. ATA_DEV_ATA = 1, /* ATA device */
  116. ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
  117. ATA_DEV_ATAPI = 3, /* ATAPI device */
  118. ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
  119. ATA_DEV_NONE = 5, /* no device */
  120. /* struct ata_port flags */
  121. ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
  122. /* (doesn't imply presence) */
  123. ATA_FLAG_SATA = (1 << 1),
  124. ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
  125. ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
  126. ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
  127. ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
  128. ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
  129. ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
  130. ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
  131. ATA_FLAG_IRQ_MASK = (1 << 9), /* Mask IRQ in PIO xfers */
  132. ATA_FLAG_NOINTR = (1 << 13), /* FIXME: Remove this once
  133. * proper HSM is in place. */
  134. ATA_FLAG_DEBUGMSG = (1 << 14),
  135. ATA_FLAG_FLUSH_PORT_TASK = (1 << 15), /* flush port task */
  136. ATA_FLAG_EH_PENDING = (1 << 16), /* EH pending */
  137. ATA_FLAG_FROZEN = (1 << 17), /* port is frozen */
  138. ATA_FLAG_DISABLED = (1 << 22), /* port is disabled, ignore it */
  139. ATA_FLAG_SUSPENDED = (1 << 23), /* port is suspended (power) */
  140. /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
  141. /* struct ata_queued_cmd flags */
  142. ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
  143. ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
  144. ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
  145. ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
  146. ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
  147. ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
  148. ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
  149. ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
  150. ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
  151. /* host set flags */
  152. ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
  153. /* various lengths of time */
  154. ATA_TMOUT_PIO = 30 * HZ,
  155. ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
  156. ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
  157. ATA_TMOUT_CDB = 30 * HZ,
  158. ATA_TMOUT_CDB_QUICK = 5 * HZ,
  159. ATA_TMOUT_INTERNAL = 30 * HZ,
  160. ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
  161. /* ATA bus states */
  162. BUS_UNKNOWN = 0,
  163. BUS_DMA = 1,
  164. BUS_IDLE = 2,
  165. BUS_NOINTR = 3,
  166. BUS_NODATA = 4,
  167. BUS_TIMER = 5,
  168. BUS_PIO = 6,
  169. BUS_EDD = 7,
  170. BUS_IDENTIFY = 8,
  171. BUS_PACKET = 9,
  172. /* SATA port states */
  173. PORT_UNKNOWN = 0,
  174. PORT_ENABLED = 1,
  175. PORT_DISABLED = 2,
  176. /* encoding various smaller bitmaps into a single
  177. * unsigned int bitmap
  178. */
  179. ATA_BITS_PIO = 5,
  180. ATA_BITS_MWDMA = 3,
  181. ATA_BITS_UDMA = 8,
  182. ATA_SHIFT_PIO = 0,
  183. ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
  184. ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
  185. ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
  186. ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
  187. ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
  188. /* size of buffer to pad xfers ending on unaligned boundaries */
  189. ATA_DMA_PAD_SZ = 4,
  190. ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
  191. /* masks for port functions */
  192. ATA_PORT_PRIMARY = (1 << 0),
  193. ATA_PORT_SECONDARY = (1 << 1),
  194. /* how hard are we gonna try to probe/recover devices */
  195. ATA_PROBE_MAX_TRIES = 3,
  196. };
  197. enum hsm_task_states {
  198. HSM_ST_UNKNOWN,
  199. HSM_ST_IDLE,
  200. HSM_ST_POLL,
  201. HSM_ST_TMOUT,
  202. HSM_ST,
  203. HSM_ST_LAST,
  204. HSM_ST_LAST_POLL,
  205. HSM_ST_ERR,
  206. };
  207. enum ata_completion_errors {
  208. AC_ERR_DEV = (1 << 0), /* device reported error */
  209. AC_ERR_HSM = (1 << 1), /* host state machine violation */
  210. AC_ERR_TIMEOUT = (1 << 2), /* timeout */
  211. AC_ERR_MEDIA = (1 << 3), /* media error */
  212. AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
  213. AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
  214. AC_ERR_SYSTEM = (1 << 6), /* system error */
  215. AC_ERR_INVALID = (1 << 7), /* invalid argument */
  216. AC_ERR_OTHER = (1 << 8), /* unknown */
  217. };
  218. /* forward declarations */
  219. struct scsi_device;
  220. struct ata_port_operations;
  221. struct ata_port;
  222. struct ata_queued_cmd;
  223. /* typedefs */
  224. typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
  225. typedef void (*ata_probeinit_fn_t)(struct ata_port *);
  226. typedef int (*ata_reset_fn_t)(struct ata_port *, unsigned int *);
  227. typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
  228. struct ata_ioports {
  229. unsigned long cmd_addr;
  230. unsigned long data_addr;
  231. unsigned long error_addr;
  232. unsigned long feature_addr;
  233. unsigned long nsect_addr;
  234. unsigned long lbal_addr;
  235. unsigned long lbam_addr;
  236. unsigned long lbah_addr;
  237. unsigned long device_addr;
  238. unsigned long status_addr;
  239. unsigned long command_addr;
  240. unsigned long altstatus_addr;
  241. unsigned long ctl_addr;
  242. unsigned long bmdma_addr;
  243. unsigned long scr_addr;
  244. };
  245. struct ata_probe_ent {
  246. struct list_head node;
  247. struct device *dev;
  248. const struct ata_port_operations *port_ops;
  249. struct scsi_host_template *sht;
  250. struct ata_ioports port[ATA_MAX_PORTS];
  251. unsigned int n_ports;
  252. unsigned int hard_port_no;
  253. unsigned int pio_mask;
  254. unsigned int mwdma_mask;
  255. unsigned int udma_mask;
  256. unsigned int legacy_mode;
  257. unsigned long irq;
  258. unsigned int irq_flags;
  259. unsigned long host_flags;
  260. unsigned long host_set_flags;
  261. void __iomem *mmio_base;
  262. void *private_data;
  263. };
  264. struct ata_host_set {
  265. spinlock_t lock;
  266. struct device *dev;
  267. unsigned long irq;
  268. void __iomem *mmio_base;
  269. unsigned int n_ports;
  270. void *private_data;
  271. const struct ata_port_operations *ops;
  272. unsigned long flags;
  273. int simplex_claimed; /* Keep seperate in case we
  274. ever need to do this locked */
  275. struct ata_port * ports[0];
  276. };
  277. struct ata_queued_cmd {
  278. struct ata_port *ap;
  279. struct ata_device *dev;
  280. struct scsi_cmnd *scsicmd;
  281. void (*scsidone)(struct scsi_cmnd *);
  282. struct ata_taskfile tf;
  283. u8 cdb[ATAPI_CDB_LEN];
  284. unsigned long flags; /* ATA_QCFLAG_xxx */
  285. unsigned int tag;
  286. unsigned int n_elem;
  287. unsigned int orig_n_elem;
  288. int dma_dir;
  289. unsigned int pad_len;
  290. unsigned int nsect;
  291. unsigned int cursect;
  292. unsigned int nbytes;
  293. unsigned int curbytes;
  294. unsigned int cursg;
  295. unsigned int cursg_ofs;
  296. struct scatterlist sgent;
  297. struct scatterlist pad_sgent;
  298. void *buf_virt;
  299. /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
  300. struct scatterlist *__sg;
  301. unsigned int err_mask;
  302. struct ata_taskfile result_tf;
  303. ata_qc_cb_t complete_fn;
  304. void *private_data;
  305. };
  306. struct ata_host_stats {
  307. unsigned long unhandled_irq;
  308. unsigned long idle_irq;
  309. unsigned long rw_reqbuf;
  310. };
  311. struct ata_device {
  312. struct ata_port *ap;
  313. u64 n_sectors; /* size of device, if ATA */
  314. unsigned long flags; /* ATA_DFLAG_xxx */
  315. unsigned int class; /* ATA_DEV_xxx */
  316. unsigned int devno; /* 0 or 1 */
  317. u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
  318. u8 pio_mode;
  319. u8 dma_mode;
  320. u8 xfer_mode;
  321. unsigned int xfer_shift; /* ATA_SHIFT_xxx */
  322. unsigned int multi_count; /* sectors count for
  323. READ/WRITE MULTIPLE */
  324. unsigned int max_sectors; /* per-device max sectors */
  325. unsigned int cdb_len;
  326. /* per-dev xfer mask */
  327. unsigned int pio_mask;
  328. unsigned int mwdma_mask;
  329. unsigned int udma_mask;
  330. /* for CHS addressing */
  331. u16 cylinders; /* Number of cylinders */
  332. u16 heads; /* Number of heads */
  333. u16 sectors; /* Number of sectors per track */
  334. };
  335. struct ata_port {
  336. struct Scsi_Host *host; /* our co-allocated scsi host */
  337. const struct ata_port_operations *ops;
  338. unsigned long flags; /* ATA_FLAG_xxx */
  339. unsigned int id; /* unique id req'd by scsi midlyr */
  340. unsigned int port_no; /* unique port #; from zero */
  341. unsigned int hard_port_no; /* hardware port #; from zero */
  342. struct ata_prd *prd; /* our SG list */
  343. dma_addr_t prd_dma; /* and its DMA mapping */
  344. void *pad; /* array of DMA pad buffers */
  345. dma_addr_t pad_dma;
  346. struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
  347. u8 ctl; /* cache of ATA control register */
  348. u8 last_ctl; /* Cache last written value */
  349. unsigned int pio_mask;
  350. unsigned int mwdma_mask;
  351. unsigned int udma_mask;
  352. unsigned int cbl; /* cable type; ATA_CBL_xxx */
  353. unsigned int sata_spd_limit; /* SATA PHY speed limit */
  354. struct ata_device device[ATA_MAX_DEVICES];
  355. struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
  356. unsigned long qactive;
  357. unsigned int active_tag;
  358. struct ata_host_stats stats;
  359. struct ata_host_set *host_set;
  360. struct device *dev;
  361. struct work_struct port_task;
  362. unsigned int hsm_task_state;
  363. unsigned long pio_task_timeout;
  364. u32 msg_enable;
  365. struct list_head eh_done_q;
  366. void *private_data;
  367. u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
  368. };
  369. struct ata_port_operations {
  370. void (*port_disable) (struct ata_port *);
  371. void (*dev_config) (struct ata_port *, struct ata_device *);
  372. void (*set_piomode) (struct ata_port *, struct ata_device *);
  373. void (*set_dmamode) (struct ata_port *, struct ata_device *);
  374. unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
  375. void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
  376. void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
  377. void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
  378. u8 (*check_status)(struct ata_port *ap);
  379. u8 (*check_altstatus)(struct ata_port *ap);
  380. void (*dev_select)(struct ata_port *ap, unsigned int device);
  381. void (*phy_reset) (struct ata_port *ap); /* obsolete */
  382. void (*set_mode) (struct ata_port *ap);
  383. int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
  384. void (*post_set_mode) (struct ata_port *ap);
  385. int (*check_atapi_dma) (struct ata_queued_cmd *qc);
  386. void (*bmdma_setup) (struct ata_queued_cmd *qc);
  387. void (*bmdma_start) (struct ata_queued_cmd *qc);
  388. void (*qc_prep) (struct ata_queued_cmd *qc);
  389. unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
  390. /* Error handlers. ->error_handler overrides ->eng_timeout and
  391. * indicates that new-style EH is in place.
  392. */
  393. void (*eng_timeout) (struct ata_port *ap); /* obsolete */
  394. void (*freeze) (struct ata_port *ap);
  395. void (*thaw) (struct ata_port *ap);
  396. void (*error_handler) (struct ata_port *ap);
  397. void (*post_internal_cmd) (struct ata_queued_cmd *qc);
  398. irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
  399. void (*irq_clear) (struct ata_port *);
  400. u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
  401. void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
  402. u32 val);
  403. int (*port_start) (struct ata_port *ap);
  404. void (*port_stop) (struct ata_port *ap);
  405. void (*host_stop) (struct ata_host_set *host_set);
  406. void (*bmdma_stop) (struct ata_queued_cmd *qc);
  407. u8 (*bmdma_status) (struct ata_port *ap);
  408. };
  409. struct ata_port_info {
  410. struct scsi_host_template *sht;
  411. unsigned long host_flags;
  412. unsigned long pio_mask;
  413. unsigned long mwdma_mask;
  414. unsigned long udma_mask;
  415. const struct ata_port_operations *port_ops;
  416. void *private_data;
  417. };
  418. struct ata_timing {
  419. unsigned short mode; /* ATA mode */
  420. unsigned short setup; /* t1 */
  421. unsigned short act8b; /* t2 for 8-bit I/O */
  422. unsigned short rec8b; /* t2i for 8-bit I/O */
  423. unsigned short cyc8b; /* t0 for 8-bit I/O */
  424. unsigned short active; /* t2 or tD */
  425. unsigned short recover; /* t2i or tK */
  426. unsigned short cycle; /* t0 */
  427. unsigned short udma; /* t2CYCTYP/2 */
  428. };
  429. #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
  430. extern void ata_port_probe(struct ata_port *);
  431. extern void __sata_phy_reset(struct ata_port *ap);
  432. extern void sata_phy_reset(struct ata_port *ap);
  433. extern void ata_bus_reset(struct ata_port *ap);
  434. extern int sata_set_spd(struct ata_port *ap);
  435. extern int ata_drive_probe_reset(struct ata_port *ap,
  436. ata_probeinit_fn_t probeinit,
  437. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  438. ata_postreset_fn_t postreset, unsigned int *classes);
  439. extern void ata_std_probeinit(struct ata_port *ap);
  440. extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
  441. extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
  442. extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
  443. extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
  444. extern void ata_port_disable(struct ata_port *);
  445. extern void ata_std_ports(struct ata_ioports *ioaddr);
  446. #ifdef CONFIG_PCI
  447. extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
  448. unsigned int n_ports);
  449. extern void ata_pci_remove_one (struct pci_dev *pdev);
  450. extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
  451. extern int ata_pci_device_resume(struct pci_dev *pdev);
  452. extern int ata_pci_clear_simplex(struct pci_dev *pdev);
  453. #endif /* CONFIG_PCI */
  454. extern int ata_device_add(const struct ata_probe_ent *ent);
  455. extern void ata_host_set_remove(struct ata_host_set *host_set);
  456. extern int ata_scsi_detect(struct scsi_host_template *sht);
  457. extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
  458. extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
  459. extern int ata_scsi_release(struct Scsi_Host *host);
  460. extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
  461. extern int sata_scr_valid(struct ata_port *ap);
  462. extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
  463. extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
  464. extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
  465. extern int ata_port_online(struct ata_port *ap);
  466. extern int ata_port_offline(struct ata_port *ap);
  467. extern int ata_scsi_device_resume(struct scsi_device *);
  468. extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
  469. extern int ata_device_resume(struct ata_device *);
  470. extern int ata_device_suspend(struct ata_device *, pm_message_t state);
  471. extern int ata_ratelimit(void);
  472. extern unsigned int ata_busy_sleep(struct ata_port *ap,
  473. unsigned long timeout_pat,
  474. unsigned long timeout);
  475. extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
  476. void *data, unsigned long delay);
  477. extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
  478. unsigned long interval_msec,
  479. unsigned long timeout_msec);
  480. /*
  481. * Default driver ops implementations
  482. */
  483. extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
  484. extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
  485. extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
  486. extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
  487. extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
  488. extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
  489. extern u8 ata_check_status(struct ata_port *ap);
  490. extern u8 ata_altstatus(struct ata_port *ap);
  491. extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
  492. extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
  493. extern int ata_port_start (struct ata_port *ap);
  494. extern void ata_port_stop (struct ata_port *ap);
  495. extern void ata_host_stop (struct ata_host_set *host_set);
  496. extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
  497. extern void ata_qc_prep(struct ata_queued_cmd *qc);
  498. extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
  499. extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
  500. extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
  501. unsigned int buflen);
  502. extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
  503. unsigned int n_elem);
  504. extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
  505. extern void ata_id_string(const u16 *id, unsigned char *s,
  506. unsigned int ofs, unsigned int len);
  507. extern void ata_id_c_string(const u16 *id, unsigned char *s,
  508. unsigned int ofs, unsigned int len);
  509. extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
  510. extern void ata_bmdma_start (struct ata_queued_cmd *qc);
  511. extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
  512. extern u8 ata_bmdma_status(struct ata_port *ap);
  513. extern void ata_bmdma_irq_clear(struct ata_port *ap);
  514. extern void __ata_qc_complete(struct ata_queued_cmd *qc);
  515. extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
  516. void (*done)(struct scsi_cmnd *));
  517. extern int ata_std_bios_param(struct scsi_device *sdev,
  518. struct block_device *bdev,
  519. sector_t capacity, int geom[]);
  520. extern int ata_scsi_slave_config(struct scsi_device *sdev);
  521. extern struct ata_device *ata_dev_pair(struct ata_device *adev);
  522. /*
  523. * Timing helpers
  524. */
  525. extern unsigned int ata_pio_need_iordy(const struct ata_device *);
  526. extern int ata_timing_compute(struct ata_device *, unsigned short,
  527. struct ata_timing *, int, int);
  528. extern void ata_timing_merge(const struct ata_timing *,
  529. const struct ata_timing *, struct ata_timing *,
  530. unsigned int);
  531. enum {
  532. ATA_TIMING_SETUP = (1 << 0),
  533. ATA_TIMING_ACT8B = (1 << 1),
  534. ATA_TIMING_REC8B = (1 << 2),
  535. ATA_TIMING_CYC8B = (1 << 3),
  536. ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
  537. ATA_TIMING_CYC8B,
  538. ATA_TIMING_ACTIVE = (1 << 4),
  539. ATA_TIMING_RECOVER = (1 << 5),
  540. ATA_TIMING_CYCLE = (1 << 6),
  541. ATA_TIMING_UDMA = (1 << 7),
  542. ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
  543. ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
  544. ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
  545. ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
  546. };
  547. #ifdef CONFIG_PCI
  548. struct pci_bits {
  549. unsigned int reg; /* PCI config register to read */
  550. unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
  551. unsigned long mask;
  552. unsigned long val;
  553. };
  554. extern void ata_pci_host_stop (struct ata_host_set *host_set);
  555. extern struct ata_probe_ent *
  556. ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
  557. extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
  558. extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
  559. #endif /* CONFIG_PCI */
  560. /*
  561. * EH
  562. */
  563. extern void ata_eng_timeout(struct ata_port *ap);
  564. extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
  565. extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
  566. /*
  567. * printk helpers
  568. */
  569. #define ata_port_printk(ap, lv, fmt, args...) \
  570. printk(lv"ata%u: "fmt, (ap)->id , ##args)
  571. #define ata_dev_printk(dev, lv, fmt, args...) \
  572. printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
  573. /*
  574. * qc helpers
  575. */
  576. static inline int
  577. ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
  578. {
  579. if (sg == &qc->pad_sgent)
  580. return 1;
  581. if (qc->pad_len)
  582. return 0;
  583. if (((sg - qc->__sg) + 1) == qc->n_elem)
  584. return 1;
  585. return 0;
  586. }
  587. static inline struct scatterlist *
  588. ata_qc_first_sg(struct ata_queued_cmd *qc)
  589. {
  590. if (qc->n_elem)
  591. return qc->__sg;
  592. if (qc->pad_len)
  593. return &qc->pad_sgent;
  594. return NULL;
  595. }
  596. static inline struct scatterlist *
  597. ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
  598. {
  599. if (sg == &qc->pad_sgent)
  600. return NULL;
  601. if (++sg - qc->__sg < qc->n_elem)
  602. return sg;
  603. if (qc->pad_len)
  604. return &qc->pad_sgent;
  605. return NULL;
  606. }
  607. #define ata_for_each_sg(sg, qc) \
  608. for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
  609. static inline unsigned int ata_tag_valid(unsigned int tag)
  610. {
  611. return (tag < ATA_MAX_QUEUE) ? 1 : 0;
  612. }
  613. static inline unsigned int ata_tag_internal(unsigned int tag)
  614. {
  615. return tag == ATA_MAX_QUEUE - 1;
  616. }
  617. static inline unsigned int ata_class_enabled(unsigned int class)
  618. {
  619. return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
  620. }
  621. static inline unsigned int ata_class_disabled(unsigned int class)
  622. {
  623. return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
  624. }
  625. static inline unsigned int ata_class_absent(unsigned int class)
  626. {
  627. return !ata_class_enabled(class) && !ata_class_disabled(class);
  628. }
  629. static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
  630. {
  631. return ata_class_enabled(dev->class);
  632. }
  633. static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
  634. {
  635. return ata_class_disabled(dev->class);
  636. }
  637. static inline unsigned int ata_dev_absent(const struct ata_device *dev)
  638. {
  639. return ata_class_absent(dev->class);
  640. }
  641. static inline u8 ata_chk_status(struct ata_port *ap)
  642. {
  643. return ap->ops->check_status(ap);
  644. }
  645. /**
  646. * ata_pause - Flush writes and pause 400 nanoseconds.
  647. * @ap: Port to wait for.
  648. *
  649. * LOCKING:
  650. * Inherited from caller.
  651. */
  652. static inline void ata_pause(struct ata_port *ap)
  653. {
  654. ata_altstatus(ap);
  655. ndelay(400);
  656. }
  657. /**
  658. * ata_busy_wait - Wait for a port status register
  659. * @ap: Port to wait for.
  660. *
  661. * Waits up to max*10 microseconds for the selected bits in the port's
  662. * status register to be cleared.
  663. * Returns final value of status register.
  664. *
  665. * LOCKING:
  666. * Inherited from caller.
  667. */
  668. static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
  669. unsigned int max)
  670. {
  671. u8 status;
  672. do {
  673. udelay(10);
  674. status = ata_chk_status(ap);
  675. max--;
  676. } while ((status & bits) && (max > 0));
  677. return status;
  678. }
  679. /**
  680. * ata_wait_idle - Wait for a port to be idle.
  681. * @ap: Port to wait for.
  682. *
  683. * Waits up to 10ms for port's BUSY and DRQ signals to clear.
  684. * Returns final value of status register.
  685. *
  686. * LOCKING:
  687. * Inherited from caller.
  688. */
  689. static inline u8 ata_wait_idle(struct ata_port *ap)
  690. {
  691. u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
  692. if (status & (ATA_BUSY | ATA_DRQ)) {
  693. unsigned long l = ap->ioaddr.status_addr;
  694. if (ata_msg_warn(ap))
  695. printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
  696. status, l);
  697. }
  698. return status;
  699. }
  700. static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
  701. {
  702. qc->tf.ctl |= ATA_NIEN;
  703. }
  704. static inline struct ata_queued_cmd *ata_qc_from_tag (struct ata_port *ap,
  705. unsigned int tag)
  706. {
  707. if (likely(ata_tag_valid(tag)))
  708. return &ap->qcmd[tag];
  709. return NULL;
  710. }
  711. static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
  712. {
  713. memset(tf, 0, sizeof(*tf));
  714. tf->ctl = dev->ap->ctl;
  715. if (dev->devno == 0)
  716. tf->device = ATA_DEVICE_OBS;
  717. else
  718. tf->device = ATA_DEVICE_OBS | ATA_DEV1;
  719. }
  720. static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
  721. {
  722. qc->__sg = NULL;
  723. qc->flags = 0;
  724. qc->cursect = qc->cursg = qc->cursg_ofs = 0;
  725. qc->nsect = 0;
  726. qc->nbytes = qc->curbytes = 0;
  727. qc->err_mask = 0;
  728. ata_tf_init(qc->dev, &qc->tf);
  729. /* init result_tf such that it indicates normal completion */
  730. qc->result_tf.command = ATA_DRDY;
  731. qc->result_tf.feature = 0;
  732. }
  733. /**
  734. * ata_qc_complete - Complete an active ATA command
  735. * @qc: Command to complete
  736. * @err_mask: ATA Status register contents
  737. *
  738. * Indicate to the mid and upper layers that an ATA
  739. * command has completed, with either an ok or not-ok status.
  740. *
  741. * LOCKING:
  742. * spin_lock_irqsave(host_set lock)
  743. */
  744. static inline void ata_qc_complete(struct ata_queued_cmd *qc)
  745. {
  746. struct ata_port *ap = qc->ap;
  747. if (unlikely(qc->flags & ATA_QCFLAG_EH_SCHEDULED))
  748. return;
  749. /* read result TF if failed or requested */
  750. if (qc->err_mask || qc->flags & ATA_QCFLAG_RESULT_TF)
  751. ap->ops->tf_read(ap, &qc->result_tf);
  752. __ata_qc_complete(qc);
  753. }
  754. /**
  755. * ata_irq_on - Enable interrupts on a port.
  756. * @ap: Port on which interrupts are enabled.
  757. *
  758. * Enable interrupts on a legacy IDE device using MMIO or PIO,
  759. * wait for idle, clear any pending interrupts.
  760. *
  761. * LOCKING:
  762. * Inherited from caller.
  763. */
  764. static inline u8 ata_irq_on(struct ata_port *ap)
  765. {
  766. struct ata_ioports *ioaddr = &ap->ioaddr;
  767. u8 tmp;
  768. ap->ctl &= ~ATA_NIEN;
  769. ap->last_ctl = ap->ctl;
  770. if (ap->flags & ATA_FLAG_MMIO)
  771. writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
  772. else
  773. outb(ap->ctl, ioaddr->ctl_addr);
  774. tmp = ata_wait_idle(ap);
  775. ap->ops->irq_clear(ap);
  776. return tmp;
  777. }
  778. /**
  779. * ata_irq_ack - Acknowledge a device interrupt.
  780. * @ap: Port on which interrupts are enabled.
  781. *
  782. * Wait up to 10 ms for legacy IDE device to become idle (BUSY
  783. * or BUSY+DRQ clear). Obtain dma status and port status from
  784. * device. Clear the interrupt. Return port status.
  785. *
  786. * LOCKING:
  787. */
  788. static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
  789. {
  790. unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
  791. u8 host_stat, post_stat, status;
  792. status = ata_busy_wait(ap, bits, 1000);
  793. if (status & bits)
  794. if (ata_msg_err(ap))
  795. printk(KERN_ERR "abnormal status 0x%X\n", status);
  796. /* get controller status; clear intr, err bits */
  797. if (ap->flags & ATA_FLAG_MMIO) {
  798. void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
  799. host_stat = readb(mmio + ATA_DMA_STATUS);
  800. writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
  801. mmio + ATA_DMA_STATUS);
  802. post_stat = readb(mmio + ATA_DMA_STATUS);
  803. } else {
  804. host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
  805. outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
  806. ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
  807. post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
  808. }
  809. if (ata_msg_intr(ap))
  810. printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
  811. __FUNCTION__,
  812. host_stat, post_stat, status);
  813. return status;
  814. }
  815. static inline int ata_try_flush_cache(const struct ata_device *dev)
  816. {
  817. return ata_id_wcache_enabled(dev->id) ||
  818. ata_id_has_flush(dev->id) ||
  819. ata_id_has_flush_ext(dev->id);
  820. }
  821. static inline unsigned int ac_err_mask(u8 status)
  822. {
  823. if (status & ATA_BUSY)
  824. return AC_ERR_HSM;
  825. if (status & (ATA_ERR | ATA_DF))
  826. return AC_ERR_DEV;
  827. return 0;
  828. }
  829. static inline unsigned int __ac_err_mask(u8 status)
  830. {
  831. unsigned int mask = ac_err_mask(status);
  832. if (mask == 0)
  833. return AC_ERR_OTHER;
  834. return mask;
  835. }
  836. static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
  837. {
  838. ap->pad_dma = 0;
  839. ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
  840. &ap->pad_dma, GFP_KERNEL);
  841. return (ap->pad == NULL) ? -ENOMEM : 0;
  842. }
  843. static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
  844. {
  845. dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
  846. }
  847. static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
  848. {
  849. return (struct ata_port *) &host->hostdata[0];
  850. }
  851. #endif /* __LINUX_LIBATA_H__ */