libata.h 37 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250
  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. #define 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 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 = 7,
  198. ATA_BITS_MWDMA = 5,
  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 port_flags;
  310. unsigned long _host_flags;
  311. void __iomem *mmio_base;
  312. void *private_data;
  313. /* port_info for the secondary port. Together with irq2, it's
  314. * used to implement non-uniform secondary port. Currently,
  315. * the only user is ata_piix combined mode. This workaround
  316. * will be removed together with ata_probe_ent when init model
  317. * is updated.
  318. */
  319. const struct ata_port_info *pinfo2;
  320. };
  321. struct ata_host {
  322. spinlock_t lock;
  323. struct device *dev;
  324. unsigned long irq;
  325. unsigned long irq2;
  326. void __iomem *mmio_base;
  327. unsigned int n_ports;
  328. void *private_data;
  329. const struct ata_port_operations *ops;
  330. unsigned long flags;
  331. int simplex_claimed; /* Keep seperate in case we
  332. ever need to do this locked */
  333. struct ata_port *ports[0];
  334. };
  335. struct ata_queued_cmd {
  336. struct ata_port *ap;
  337. struct ata_device *dev;
  338. struct scsi_cmnd *scsicmd;
  339. void (*scsidone)(struct scsi_cmnd *);
  340. struct ata_taskfile tf;
  341. u8 cdb[ATAPI_CDB_LEN];
  342. unsigned long flags; /* ATA_QCFLAG_xxx */
  343. unsigned int tag;
  344. unsigned int n_elem;
  345. unsigned int orig_n_elem;
  346. int dma_dir;
  347. unsigned int pad_len;
  348. unsigned int nsect;
  349. unsigned int cursect;
  350. unsigned int nbytes;
  351. unsigned int curbytes;
  352. unsigned int cursg;
  353. unsigned int cursg_ofs;
  354. struct scatterlist sgent;
  355. struct scatterlist pad_sgent;
  356. void *buf_virt;
  357. /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
  358. struct scatterlist *__sg;
  359. unsigned int err_mask;
  360. struct ata_taskfile result_tf;
  361. ata_qc_cb_t complete_fn;
  362. void *private_data;
  363. };
  364. struct ata_port_stats {
  365. unsigned long unhandled_irq;
  366. unsigned long idle_irq;
  367. unsigned long rw_reqbuf;
  368. };
  369. struct ata_ering_entry {
  370. int is_io;
  371. unsigned int err_mask;
  372. u64 timestamp;
  373. };
  374. struct ata_ering {
  375. int cursor;
  376. struct ata_ering_entry ring[ATA_ERING_SIZE];
  377. };
  378. struct ata_device {
  379. struct ata_port *ap;
  380. unsigned int devno; /* 0 or 1 */
  381. unsigned long flags; /* ATA_DFLAG_xxx */
  382. struct scsi_device *sdev; /* attached SCSI device */
  383. /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
  384. u64 n_sectors; /* size of device, if ATA */
  385. unsigned int class; /* ATA_DEV_xxx */
  386. u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
  387. u8 pio_mode;
  388. u8 dma_mode;
  389. u8 xfer_mode;
  390. unsigned int xfer_shift; /* ATA_SHIFT_xxx */
  391. unsigned int multi_count; /* sectors count for
  392. READ/WRITE MULTIPLE */
  393. unsigned int max_sectors; /* per-device max sectors */
  394. unsigned int cdb_len;
  395. /* per-dev xfer mask */
  396. unsigned int pio_mask;
  397. unsigned int mwdma_mask;
  398. unsigned int udma_mask;
  399. /* for CHS addressing */
  400. u16 cylinders; /* Number of cylinders */
  401. u16 heads; /* Number of heads */
  402. u16 sectors; /* Number of sectors per track */
  403. /* error history */
  404. struct ata_ering ering;
  405. };
  406. /* Offset into struct ata_device. Fields above it are maintained
  407. * acress device init. Fields below are zeroed.
  408. */
  409. #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
  410. struct ata_eh_info {
  411. struct ata_device *dev; /* offending device */
  412. u32 serror; /* SError from LLDD */
  413. unsigned int err_mask; /* port-wide err_mask */
  414. unsigned int action; /* ATA_EH_* action mask */
  415. unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
  416. unsigned int flags; /* ATA_EHI_* flags */
  417. unsigned long hotplug_timestamp;
  418. unsigned int probe_mask;
  419. char desc[ATA_EH_DESC_LEN];
  420. int desc_len;
  421. };
  422. struct ata_eh_context {
  423. struct ata_eh_info i;
  424. int tries[ATA_MAX_DEVICES];
  425. unsigned int classes[ATA_MAX_DEVICES];
  426. unsigned int did_probe_mask;
  427. };
  428. struct ata_port {
  429. struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
  430. const struct ata_port_operations *ops;
  431. spinlock_t *lock;
  432. unsigned long flags; /* ATA_FLAG_xxx */
  433. unsigned int pflags; /* ATA_PFLAG_xxx */
  434. unsigned int id; /* unique id req'd by scsi midlyr */
  435. unsigned int port_no; /* unique port #; from zero */
  436. struct ata_prd *prd; /* our SG list */
  437. dma_addr_t prd_dma; /* and its DMA mapping */
  438. void *pad; /* array of DMA pad buffers */
  439. dma_addr_t pad_dma;
  440. struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
  441. u8 ctl; /* cache of ATA control register */
  442. u8 last_ctl; /* Cache last written value */
  443. unsigned int pio_mask;
  444. unsigned int mwdma_mask;
  445. unsigned int udma_mask;
  446. unsigned int cbl; /* cable type; ATA_CBL_xxx */
  447. unsigned int hw_sata_spd_limit;
  448. unsigned int sata_spd_limit; /* SATA PHY speed limit */
  449. /* record runtime error info, protected by host lock */
  450. struct ata_eh_info eh_info;
  451. /* EH context owned by EH */
  452. struct ata_eh_context eh_context;
  453. struct ata_device device[ATA_MAX_DEVICES];
  454. struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
  455. unsigned long qc_allocated;
  456. unsigned int qc_active;
  457. unsigned int active_tag;
  458. u32 sactive;
  459. struct ata_port_stats stats;
  460. struct ata_host *host;
  461. struct device *dev;
  462. struct work_struct port_task;
  463. struct work_struct hotplug_task;
  464. struct work_struct scsi_rescan_task;
  465. unsigned int hsm_task_state;
  466. u32 msg_enable;
  467. struct list_head eh_done_q;
  468. wait_queue_head_t eh_wait_q;
  469. pm_message_t pm_mesg;
  470. int *pm_result;
  471. void *private_data;
  472. u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
  473. };
  474. struct ata_port_operations {
  475. void (*port_disable) (struct ata_port *);
  476. void (*dev_config) (struct ata_port *, struct ata_device *);
  477. void (*set_piomode) (struct ata_port *, struct ata_device *);
  478. void (*set_dmamode) (struct ata_port *, struct ata_device *);
  479. unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
  480. void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
  481. void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
  482. void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
  483. u8 (*check_status)(struct ata_port *ap);
  484. u8 (*check_altstatus)(struct ata_port *ap);
  485. void (*dev_select)(struct ata_port *ap, unsigned int device);
  486. void (*phy_reset) (struct ata_port *ap); /* obsolete */
  487. void (*set_mode) (struct ata_port *ap);
  488. void (*post_set_mode) (struct ata_port *ap);
  489. int (*check_atapi_dma) (struct ata_queued_cmd *qc);
  490. void (*bmdma_setup) (struct ata_queued_cmd *qc);
  491. void (*bmdma_start) (struct ata_queued_cmd *qc);
  492. void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
  493. void (*qc_prep) (struct ata_queued_cmd *qc);
  494. unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
  495. /* Error handlers. ->error_handler overrides ->eng_timeout and
  496. * indicates that new-style EH is in place.
  497. */
  498. void (*eng_timeout) (struct ata_port *ap); /* obsolete */
  499. void (*freeze) (struct ata_port *ap);
  500. void (*thaw) (struct ata_port *ap);
  501. void (*error_handler) (struct ata_port *ap);
  502. void (*post_internal_cmd) (struct ata_queued_cmd *qc);
  503. irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
  504. void (*irq_clear) (struct ata_port *);
  505. u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
  506. void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
  507. u32 val);
  508. int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
  509. int (*port_resume) (struct ata_port *ap);
  510. int (*port_start) (struct ata_port *ap);
  511. void (*port_stop) (struct ata_port *ap);
  512. void (*host_stop) (struct ata_host *host);
  513. void (*bmdma_stop) (struct ata_queued_cmd *qc);
  514. u8 (*bmdma_status) (struct ata_port *ap);
  515. };
  516. struct ata_port_info {
  517. struct scsi_host_template *sht;
  518. unsigned long flags;
  519. unsigned long pio_mask;
  520. unsigned long mwdma_mask;
  521. unsigned long udma_mask;
  522. const struct ata_port_operations *port_ops;
  523. void *private_data;
  524. };
  525. struct ata_timing {
  526. unsigned short mode; /* ATA mode */
  527. unsigned short setup; /* t1 */
  528. unsigned short act8b; /* t2 for 8-bit I/O */
  529. unsigned short rec8b; /* t2i for 8-bit I/O */
  530. unsigned short cyc8b; /* t0 for 8-bit I/O */
  531. unsigned short active; /* t2 or tD */
  532. unsigned short recover; /* t2i or tK */
  533. unsigned short cycle; /* t0 */
  534. unsigned short udma; /* t2CYCTYP/2 */
  535. };
  536. #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
  537. extern const unsigned long sata_deb_timing_normal[];
  538. extern const unsigned long sata_deb_timing_hotplug[];
  539. extern const unsigned long sata_deb_timing_long[];
  540. extern const struct ata_port_operations ata_dummy_port_ops;
  541. static inline const unsigned long *
  542. sata_ehc_deb_timing(struct ata_eh_context *ehc)
  543. {
  544. if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
  545. return sata_deb_timing_hotplug;
  546. else
  547. return sata_deb_timing_normal;
  548. }
  549. static inline int ata_port_is_dummy(struct ata_port *ap)
  550. {
  551. return ap->ops == &ata_dummy_port_ops;
  552. }
  553. extern void ata_port_probe(struct ata_port *);
  554. extern void __sata_phy_reset(struct ata_port *ap);
  555. extern void sata_phy_reset(struct ata_port *ap);
  556. extern void ata_bus_reset(struct ata_port *ap);
  557. extern int sata_set_spd(struct ata_port *ap);
  558. extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
  559. extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
  560. extern int ata_std_prereset(struct ata_port *ap);
  561. extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
  562. extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
  563. extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
  564. extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
  565. extern void ata_port_disable(struct ata_port *);
  566. extern void ata_std_ports(struct ata_ioports *ioaddr);
  567. #ifdef CONFIG_PCI
  568. extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
  569. unsigned int n_ports);
  570. extern void ata_pci_remove_one (struct pci_dev *pdev);
  571. extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
  572. extern void ata_pci_device_do_resume(struct pci_dev *pdev);
  573. extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
  574. extern int ata_pci_device_resume(struct pci_dev *pdev);
  575. extern int ata_pci_clear_simplex(struct pci_dev *pdev);
  576. #endif /* CONFIG_PCI */
  577. extern int ata_device_add(const struct ata_probe_ent *ent);
  578. extern void ata_port_detach(struct ata_port *ap);
  579. extern void ata_host_init(struct ata_host *, struct device *,
  580. unsigned long, const struct ata_port_operations *);
  581. extern void ata_host_remove(struct ata_host *host);
  582. extern int ata_scsi_detect(struct scsi_host_template *sht);
  583. extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
  584. extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
  585. extern int ata_scsi_release(struct Scsi_Host *host);
  586. extern void ata_sas_port_destroy(struct ata_port *);
  587. extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
  588. struct ata_port_info *, struct Scsi_Host *);
  589. extern int ata_sas_port_init(struct ata_port *);
  590. extern int ata_sas_port_start(struct ata_port *ap);
  591. extern void ata_sas_port_stop(struct ata_port *ap);
  592. extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
  593. extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
  594. struct ata_port *ap);
  595. extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
  596. extern int sata_scr_valid(struct ata_port *ap);
  597. extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
  598. extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
  599. extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
  600. extern int ata_port_online(struct ata_port *ap);
  601. extern int ata_port_offline(struct ata_port *ap);
  602. extern int ata_scsi_device_resume(struct scsi_device *);
  603. extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
  604. extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
  605. extern void ata_host_resume(struct ata_host *host);
  606. extern int ata_ratelimit(void);
  607. extern unsigned int ata_busy_sleep(struct ata_port *ap,
  608. unsigned long timeout_pat,
  609. unsigned long timeout);
  610. extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
  611. void *data, unsigned long delay);
  612. extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
  613. unsigned long interval_msec,
  614. unsigned long timeout_msec);
  615. /*
  616. * Default driver ops implementations
  617. */
  618. extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
  619. extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
  620. extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
  621. extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
  622. extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
  623. extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
  624. extern u8 ata_check_status(struct ata_port *ap);
  625. extern u8 ata_altstatus(struct ata_port *ap);
  626. extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
  627. extern int ata_port_start (struct ata_port *ap);
  628. extern void ata_port_stop (struct ata_port *ap);
  629. extern void ata_host_stop (struct ata_host *host);
  630. extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
  631. extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
  632. unsigned int buflen, int write_data);
  633. extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
  634. unsigned int buflen, int write_data);
  635. extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
  636. unsigned int buflen, int write_data);
  637. extern void ata_qc_prep(struct ata_queued_cmd *qc);
  638. extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
  639. extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
  640. extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
  641. unsigned int buflen);
  642. extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
  643. unsigned int n_elem);
  644. extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
  645. extern void ata_id_string(const u16 *id, unsigned char *s,
  646. unsigned int ofs, unsigned int len);
  647. extern void ata_id_c_string(const u16 *id, unsigned char *s,
  648. unsigned int ofs, unsigned int len);
  649. extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
  650. extern void ata_bmdma_start (struct ata_queued_cmd *qc);
  651. extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
  652. extern u8 ata_bmdma_status(struct ata_port *ap);
  653. extern void ata_bmdma_irq_clear(struct ata_port *ap);
  654. extern void ata_bmdma_freeze(struct ata_port *ap);
  655. extern void ata_bmdma_thaw(struct ata_port *ap);
  656. extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  657. ata_reset_fn_t softreset,
  658. ata_reset_fn_t hardreset,
  659. ata_postreset_fn_t postreset);
  660. extern void ata_bmdma_error_handler(struct ata_port *ap);
  661. extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
  662. extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
  663. u8 status, int in_wq);
  664. extern void ata_qc_complete(struct ata_queued_cmd *qc);
  665. extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
  666. void (*finish_qc)(struct ata_queued_cmd *));
  667. extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
  668. void (*done)(struct scsi_cmnd *));
  669. extern int ata_std_bios_param(struct scsi_device *sdev,
  670. struct block_device *bdev,
  671. sector_t capacity, int geom[]);
  672. extern int ata_scsi_slave_config(struct scsi_device *sdev);
  673. extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
  674. extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
  675. int queue_depth);
  676. extern struct ata_device *ata_dev_pair(struct ata_device *adev);
  677. /*
  678. * Timing helpers
  679. */
  680. extern unsigned int ata_pio_need_iordy(const struct ata_device *);
  681. extern int ata_timing_compute(struct ata_device *, unsigned short,
  682. struct ata_timing *, int, int);
  683. extern void ata_timing_merge(const struct ata_timing *,
  684. const struct ata_timing *, struct ata_timing *,
  685. unsigned int);
  686. enum {
  687. ATA_TIMING_SETUP = (1 << 0),
  688. ATA_TIMING_ACT8B = (1 << 1),
  689. ATA_TIMING_REC8B = (1 << 2),
  690. ATA_TIMING_CYC8B = (1 << 3),
  691. ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
  692. ATA_TIMING_CYC8B,
  693. ATA_TIMING_ACTIVE = (1 << 4),
  694. ATA_TIMING_RECOVER = (1 << 5),
  695. ATA_TIMING_CYCLE = (1 << 6),
  696. ATA_TIMING_UDMA = (1 << 7),
  697. ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
  698. ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
  699. ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
  700. ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
  701. };
  702. #ifdef CONFIG_PCI
  703. struct pci_bits {
  704. unsigned int reg; /* PCI config register to read */
  705. unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
  706. unsigned long mask;
  707. unsigned long val;
  708. };
  709. extern void ata_pci_host_stop (struct ata_host *host);
  710. extern struct ata_probe_ent *
  711. ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
  712. extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
  713. extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
  714. #endif /* CONFIG_PCI */
  715. /*
  716. * EH
  717. */
  718. extern void ata_eng_timeout(struct ata_port *ap);
  719. extern void ata_port_schedule_eh(struct ata_port *ap);
  720. extern int ata_port_abort(struct ata_port *ap);
  721. extern int ata_port_freeze(struct ata_port *ap);
  722. extern void ata_eh_freeze_port(struct ata_port *ap);
  723. extern void ata_eh_thaw_port(struct ata_port *ap);
  724. extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
  725. extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
  726. extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  727. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  728. ata_postreset_fn_t postreset);
  729. /*
  730. * printk helpers
  731. */
  732. #define ata_port_printk(ap, lv, fmt, args...) \
  733. printk(lv"ata%u: "fmt, (ap)->id , ##args)
  734. #define ata_dev_printk(dev, lv, fmt, args...) \
  735. printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
  736. /*
  737. * ata_eh_info helpers
  738. */
  739. #define ata_ehi_push_desc(ehi, fmt, args...) do { \
  740. (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
  741. ATA_EH_DESC_LEN - (ehi)->desc_len, \
  742. fmt , ##args); \
  743. } while (0)
  744. #define ata_ehi_clear_desc(ehi) do { \
  745. (ehi)->desc[0] = '\0'; \
  746. (ehi)->desc_len = 0; \
  747. } while (0)
  748. static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
  749. {
  750. if (ehi->flags & ATA_EHI_HOTPLUGGED)
  751. return;
  752. ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
  753. ehi->hotplug_timestamp = jiffies;
  754. ehi->action |= ATA_EH_SOFTRESET;
  755. ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
  756. }
  757. static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
  758. {
  759. __ata_ehi_hotplugged(ehi);
  760. ehi->err_mask |= AC_ERR_ATA_BUS;
  761. }
  762. /*
  763. * qc helpers
  764. */
  765. static inline int
  766. ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
  767. {
  768. if (sg == &qc->pad_sgent)
  769. return 1;
  770. if (qc->pad_len)
  771. return 0;
  772. if (((sg - qc->__sg) + 1) == qc->n_elem)
  773. return 1;
  774. return 0;
  775. }
  776. static inline struct scatterlist *
  777. ata_qc_first_sg(struct ata_queued_cmd *qc)
  778. {
  779. if (qc->n_elem)
  780. return qc->__sg;
  781. if (qc->pad_len)
  782. return &qc->pad_sgent;
  783. return NULL;
  784. }
  785. static inline struct scatterlist *
  786. ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
  787. {
  788. if (sg == &qc->pad_sgent)
  789. return NULL;
  790. if (++sg - qc->__sg < qc->n_elem)
  791. return sg;
  792. if (qc->pad_len)
  793. return &qc->pad_sgent;
  794. return NULL;
  795. }
  796. #define ata_for_each_sg(sg, qc) \
  797. for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
  798. static inline unsigned int ata_tag_valid(unsigned int tag)
  799. {
  800. return (tag < ATA_MAX_QUEUE) ? 1 : 0;
  801. }
  802. static inline unsigned int ata_tag_internal(unsigned int tag)
  803. {
  804. return tag == ATA_MAX_QUEUE - 1;
  805. }
  806. /*
  807. * device helpers
  808. */
  809. static inline unsigned int ata_class_enabled(unsigned int class)
  810. {
  811. return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
  812. }
  813. static inline unsigned int ata_class_disabled(unsigned int class)
  814. {
  815. return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
  816. }
  817. static inline unsigned int ata_class_absent(unsigned int class)
  818. {
  819. return !ata_class_enabled(class) && !ata_class_disabled(class);
  820. }
  821. static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
  822. {
  823. return ata_class_enabled(dev->class);
  824. }
  825. static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
  826. {
  827. return ata_class_disabled(dev->class);
  828. }
  829. static inline unsigned int ata_dev_absent(const struct ata_device *dev)
  830. {
  831. return ata_class_absent(dev->class);
  832. }
  833. static inline unsigned int ata_dev_ready(const struct ata_device *dev)
  834. {
  835. return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
  836. }
  837. /*
  838. * port helpers
  839. */
  840. static inline int ata_port_max_devices(const struct ata_port *ap)
  841. {
  842. if (ap->flags & ATA_FLAG_SLAVE_POSS)
  843. return 2;
  844. return 1;
  845. }
  846. static inline u8 ata_chk_status(struct ata_port *ap)
  847. {
  848. return ap->ops->check_status(ap);
  849. }
  850. /**
  851. * ata_pause - Flush writes and pause 400 nanoseconds.
  852. * @ap: Port to wait for.
  853. *
  854. * LOCKING:
  855. * Inherited from caller.
  856. */
  857. static inline void ata_pause(struct ata_port *ap)
  858. {
  859. ata_altstatus(ap);
  860. ndelay(400);
  861. }
  862. /**
  863. * ata_busy_wait - Wait for a port status register
  864. * @ap: Port to wait for.
  865. *
  866. * Waits up to max*10 microseconds for the selected bits in the port's
  867. * status register to be cleared.
  868. * Returns final value of status register.
  869. *
  870. * LOCKING:
  871. * Inherited from caller.
  872. */
  873. static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
  874. unsigned int max)
  875. {
  876. u8 status;
  877. do {
  878. udelay(10);
  879. status = ata_chk_status(ap);
  880. max--;
  881. } while ((status & bits) && (max > 0));
  882. return status;
  883. }
  884. /**
  885. * ata_wait_idle - Wait for a port to be idle.
  886. * @ap: Port to wait for.
  887. *
  888. * Waits up to 10ms for port's BUSY and DRQ signals to clear.
  889. * Returns final value of status register.
  890. *
  891. * LOCKING:
  892. * Inherited from caller.
  893. */
  894. static inline u8 ata_wait_idle(struct ata_port *ap)
  895. {
  896. u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
  897. if (status & (ATA_BUSY | ATA_DRQ)) {
  898. unsigned long l = ap->ioaddr.status_addr;
  899. if (ata_msg_warn(ap))
  900. printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
  901. status, l);
  902. }
  903. return status;
  904. }
  905. static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
  906. {
  907. qc->tf.ctl |= ATA_NIEN;
  908. }
  909. static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
  910. unsigned int tag)
  911. {
  912. if (likely(ata_tag_valid(tag)))
  913. return &ap->qcmd[tag];
  914. return NULL;
  915. }
  916. static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
  917. unsigned int tag)
  918. {
  919. struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
  920. if (unlikely(!qc) || !ap->ops->error_handler)
  921. return qc;
  922. if ((qc->flags & (ATA_QCFLAG_ACTIVE |
  923. ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
  924. return qc;
  925. return NULL;
  926. }
  927. static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
  928. {
  929. memset(tf, 0, sizeof(*tf));
  930. tf->ctl = dev->ap->ctl;
  931. if (dev->devno == 0)
  932. tf->device = ATA_DEVICE_OBS;
  933. else
  934. tf->device = ATA_DEVICE_OBS | ATA_DEV1;
  935. }
  936. static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
  937. {
  938. qc->__sg = NULL;
  939. qc->flags = 0;
  940. qc->cursect = qc->cursg = qc->cursg_ofs = 0;
  941. qc->nsect = 0;
  942. qc->nbytes = qc->curbytes = 0;
  943. qc->err_mask = 0;
  944. ata_tf_init(qc->dev, &qc->tf);
  945. /* init result_tf such that it indicates normal completion */
  946. qc->result_tf.command = ATA_DRDY;
  947. qc->result_tf.feature = 0;
  948. }
  949. /**
  950. * ata_irq_on - Enable interrupts on a port.
  951. * @ap: Port on which interrupts are enabled.
  952. *
  953. * Enable interrupts on a legacy IDE device using MMIO or PIO,
  954. * wait for idle, clear any pending interrupts.
  955. *
  956. * LOCKING:
  957. * Inherited from caller.
  958. */
  959. static inline u8 ata_irq_on(struct ata_port *ap)
  960. {
  961. struct ata_ioports *ioaddr = &ap->ioaddr;
  962. u8 tmp;
  963. ap->ctl &= ~ATA_NIEN;
  964. ap->last_ctl = ap->ctl;
  965. if (ap->flags & ATA_FLAG_MMIO)
  966. writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
  967. else
  968. outb(ap->ctl, ioaddr->ctl_addr);
  969. tmp = ata_wait_idle(ap);
  970. ap->ops->irq_clear(ap);
  971. return tmp;
  972. }
  973. /**
  974. * ata_irq_ack - Acknowledge a device interrupt.
  975. * @ap: Port on which interrupts are enabled.
  976. *
  977. * Wait up to 10 ms for legacy IDE device to become idle (BUSY
  978. * or BUSY+DRQ clear). Obtain dma status and port status from
  979. * device. Clear the interrupt. Return port status.
  980. *
  981. * LOCKING:
  982. */
  983. static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
  984. {
  985. unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
  986. u8 host_stat, post_stat, status;
  987. status = ata_busy_wait(ap, bits, 1000);
  988. if (status & bits)
  989. if (ata_msg_err(ap))
  990. printk(KERN_ERR "abnormal status 0x%X\n", status);
  991. /* get controller status; clear intr, err bits */
  992. if (ap->flags & ATA_FLAG_MMIO) {
  993. void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
  994. host_stat = readb(mmio + ATA_DMA_STATUS);
  995. writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
  996. mmio + ATA_DMA_STATUS);
  997. post_stat = readb(mmio + ATA_DMA_STATUS);
  998. } else {
  999. host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
  1000. outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
  1001. ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
  1002. post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
  1003. }
  1004. if (ata_msg_intr(ap))
  1005. printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
  1006. __FUNCTION__,
  1007. host_stat, post_stat, status);
  1008. return status;
  1009. }
  1010. static inline int ata_try_flush_cache(const struct ata_device *dev)
  1011. {
  1012. return ata_id_wcache_enabled(dev->id) ||
  1013. ata_id_has_flush(dev->id) ||
  1014. ata_id_has_flush_ext(dev->id);
  1015. }
  1016. static inline unsigned int ac_err_mask(u8 status)
  1017. {
  1018. if (status & (ATA_BUSY | ATA_DRQ))
  1019. return AC_ERR_HSM;
  1020. if (status & (ATA_ERR | ATA_DF))
  1021. return AC_ERR_DEV;
  1022. return 0;
  1023. }
  1024. static inline unsigned int __ac_err_mask(u8 status)
  1025. {
  1026. unsigned int mask = ac_err_mask(status);
  1027. if (mask == 0)
  1028. return AC_ERR_OTHER;
  1029. return mask;
  1030. }
  1031. static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
  1032. {
  1033. ap->pad_dma = 0;
  1034. ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
  1035. &ap->pad_dma, GFP_KERNEL);
  1036. return (ap->pad == NULL) ? -ENOMEM : 0;
  1037. }
  1038. static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
  1039. {
  1040. dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
  1041. }
  1042. static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
  1043. {
  1044. return (struct ata_port *) &host->hostdata[0];
  1045. }
  1046. #endif /* __LINUX_LIBATA_H__ */