libata.h 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347
  1. /*
  2. * Copyright 2003-2005 Red Hat, Inc. All rights reserved.
  3. * Copyright 2003-2005 Jeff Garzik
  4. *
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2, or (at your option)
  9. * any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; see the file COPYING. If not, write to
  18. * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19. *
  20. *
  21. * libata documentation is available via 'make {ps|pdf}docs',
  22. * as Documentation/DocBook/libata.*
  23. *
  24. */
  25. #ifndef __LINUX_LIBATA_H__
  26. #define __LINUX_LIBATA_H__
  27. #include <linux/delay.h>
  28. #include <linux/interrupt.h>
  29. #include <linux/pci.h>
  30. #include <linux/dma-mapping.h>
  31. #include <asm/scatterlist.h>
  32. #include <linux/io.h>
  33. #include <linux/ata.h>
  34. #include <linux/workqueue.h>
  35. #include <scsi/scsi_host.h>
  36. #include <linux/acpi.h>
  37. /*
  38. * Define if arch has non-standard setup. This is a _PCI_ standard
  39. * not a legacy or ISA standard.
  40. */
  41. #ifdef CONFIG_ATA_NONSTANDARD
  42. #include <asm/libata-portmap.h>
  43. #else
  44. #include <asm-generic/libata-portmap.h>
  45. #endif
  46. /*
  47. * compile-time options: to be removed as soon as all the drivers are
  48. * converted to the new debugging mechanism
  49. */
  50. #undef ATA_DEBUG /* debugging output */
  51. #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
  52. #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
  53. #undef ATA_NDEBUG /* define to disable quick runtime checks */
  54. /* note: prints function name for you */
  55. #ifdef ATA_DEBUG
  56. #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  57. #ifdef ATA_VERBOSE_DEBUG
  58. #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  59. #else
  60. #define VPRINTK(fmt, args...)
  61. #endif /* ATA_VERBOSE_DEBUG */
  62. #else
  63. #define DPRINTK(fmt, args...)
  64. #define VPRINTK(fmt, args...)
  65. #endif /* ATA_DEBUG */
  66. #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
  67. /* NEW: debug levels */
  68. #define HAVE_LIBATA_MSG 1
  69. enum {
  70. ATA_MSG_DRV = 0x0001,
  71. ATA_MSG_INFO = 0x0002,
  72. ATA_MSG_PROBE = 0x0004,
  73. ATA_MSG_WARN = 0x0008,
  74. ATA_MSG_MALLOC = 0x0010,
  75. ATA_MSG_CTL = 0x0020,
  76. ATA_MSG_INTR = 0x0040,
  77. ATA_MSG_ERR = 0x0080,
  78. };
  79. #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
  80. #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
  81. #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
  82. #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
  83. #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  84. #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
  85. #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
  86. #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
  87. static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
  88. {
  89. if (dval < 0 || dval >= (sizeof(u32) * 8))
  90. return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
  91. if (!dval)
  92. return 0;
  93. return (1 << dval) - 1;
  94. }
  95. /* defines only for the constants which don't work well as enums */
  96. #define ATA_TAG_POISON 0xfafbfcfdU
  97. /* move to PCI layer? */
  98. static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
  99. {
  100. return &pdev->dev;
  101. }
  102. enum {
  103. /* various global constants */
  104. LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
  105. LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
  106. ATA_MAX_PORTS = 8,
  107. ATA_DEF_QUEUE = 1,
  108. /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
  109. ATA_MAX_QUEUE = 32,
  110. ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
  111. ATA_MAX_BUS = 2,
  112. ATA_DEF_BUSY_WAIT = 10000,
  113. ATA_SHORT_PAUSE = (HZ >> 6) + 1,
  114. ATA_SHT_EMULATED = 1,
  115. ATA_SHT_CMD_PER_LUN = 1,
  116. ATA_SHT_THIS_ID = -1,
  117. ATA_SHT_USE_CLUSTERING = 1,
  118. /* struct ata_device stuff */
  119. ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
  120. ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
  121. ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
  122. ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
  123. ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
  124. ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
  125. ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
  126. ATA_DFLAG_AN = (1 << 7), /* device supports AN */
  127. ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
  128. ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
  129. ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
  130. ATA_DFLAG_SPUNDOWN = (1 << 14), /* XXX: for spindown_compat */
  131. ATA_DFLAG_INIT_MASK = (1 << 16) - 1,
  132. ATA_DFLAG_DETACH = (1 << 16),
  133. ATA_DFLAG_DETACHED = (1 << 17),
  134. ATA_DEV_UNKNOWN = 0, /* unknown device */
  135. ATA_DEV_ATA = 1, /* ATA device */
  136. ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
  137. ATA_DEV_ATAPI = 3, /* ATAPI device */
  138. ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
  139. ATA_DEV_PMP = 5, /* SATA port multiplier */
  140. ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
  141. ATA_DEV_SEMB = 7, /* SEMB */
  142. ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
  143. ATA_DEV_NONE = 9, /* no device */
  144. /* struct ata_link flags */
  145. ATA_LFLAG_HRST_TO_RESUME = (1 << 0), /* hardreset to resume link */
  146. ATA_LFLAG_SKIP_D2H_BSY = (1 << 1), /* can't wait for the first D2H
  147. * Register FIS clearing BSY */
  148. ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
  149. ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
  150. ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
  151. ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
  152. ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
  153. /* struct ata_port flags */
  154. ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
  155. /* (doesn't imply presence) */
  156. ATA_FLAG_SATA = (1 << 1),
  157. ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
  158. ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
  159. ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
  160. ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
  161. ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
  162. ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
  163. ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
  164. ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
  165. * doesn't handle PIO interrupts */
  166. ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
  167. ATA_FLAG_DEBUGMSG = (1 << 13),
  168. ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
  169. ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
  170. ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
  171. ATA_FLAG_AN = (1 << 18), /* controller supports AN */
  172. ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
  173. /* The following flag belongs to ap->pflags but is kept in
  174. * ap->flags because it's referenced in many LLDs and will be
  175. * removed in not-too-distant future.
  176. */
  177. ATA_FLAG_DISABLED = (1 << 23), /* port is disabled, ignore it */
  178. /* bits 24:31 of ap->flags are reserved for LLD specific flags */
  179. /* struct ata_port pflags */
  180. ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
  181. ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
  182. ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
  183. ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
  184. ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
  185. ATA_PFLAG_UNLOADING = (1 << 5), /* module is unloading */
  186. ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
  187. ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
  188. ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
  189. ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
  190. ATA_PFLAG_GTM_VALID = (1 << 19), /* acpi_gtm data valid */
  191. /* struct ata_queued_cmd flags */
  192. ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
  193. ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
  194. ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
  195. ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
  196. ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
  197. ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
  198. ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
  199. ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
  200. ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
  201. ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
  202. /* host set flags */
  203. ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
  204. ATA_HOST_STARTED = (1 << 1), /* Host started */
  205. /* bits 24:31 of host->flags are reserved for LLD specific flags */
  206. /* various lengths of time */
  207. ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
  208. ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
  209. ATA_TMOUT_INTERNAL = 30 * HZ,
  210. ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
  211. /* ATA bus states */
  212. BUS_UNKNOWN = 0,
  213. BUS_DMA = 1,
  214. BUS_IDLE = 2,
  215. BUS_NOINTR = 3,
  216. BUS_NODATA = 4,
  217. BUS_TIMER = 5,
  218. BUS_PIO = 6,
  219. BUS_EDD = 7,
  220. BUS_IDENTIFY = 8,
  221. BUS_PACKET = 9,
  222. /* SATA port states */
  223. PORT_UNKNOWN = 0,
  224. PORT_ENABLED = 1,
  225. PORT_DISABLED = 2,
  226. /* encoding various smaller bitmaps into a single
  227. * unsigned int bitmap
  228. */
  229. ATA_BITS_PIO = 7,
  230. ATA_BITS_MWDMA = 5,
  231. ATA_BITS_UDMA = 8,
  232. ATA_SHIFT_PIO = 0,
  233. ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
  234. ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
  235. ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
  236. ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
  237. ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
  238. /* size of buffer to pad xfers ending on unaligned boundaries */
  239. ATA_DMA_PAD_SZ = 4,
  240. ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
  241. /* ering size */
  242. ATA_ERING_SIZE = 32,
  243. /* return values for ->qc_defer */
  244. ATA_DEFER_LINK = 1,
  245. ATA_DEFER_PORT = 2,
  246. /* desc_len for ata_eh_info and context */
  247. ATA_EH_DESC_LEN = 80,
  248. /* reset / recovery action types */
  249. ATA_EH_REVALIDATE = (1 << 0),
  250. ATA_EH_SOFTRESET = (1 << 1),
  251. ATA_EH_HARDRESET = (1 << 2),
  252. ATA_EH_RESET_MASK = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
  253. ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE,
  254. /* ata_eh_info->flags */
  255. ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
  256. ATA_EHI_RESUME_LINK = (1 << 1), /* resume link (reset modifier) */
  257. ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
  258. ATA_EHI_QUIET = (1 << 3), /* be quiet */
  259. ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
  260. ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
  261. ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
  262. ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
  263. ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
  264. ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
  265. ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
  266. /* max tries if error condition is still set after ->error_handler */
  267. ATA_EH_MAX_TRIES = 5,
  268. /* how hard are we gonna try to probe/recover devices */
  269. ATA_PROBE_MAX_TRIES = 3,
  270. ATA_EH_DEV_TRIES = 3,
  271. ATA_EH_PMP_TRIES = 5,
  272. ATA_EH_PMP_LINK_TRIES = 3,
  273. SATA_PMP_SCR_TIMEOUT = 250,
  274. /* Horkage types. May be set by libata or controller on drives
  275. (some horkage may be drive/controller pair dependant */
  276. ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
  277. ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
  278. ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
  279. ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
  280. ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
  281. };
  282. enum hsm_task_states {
  283. HSM_ST_IDLE, /* no command on going */
  284. HSM_ST_FIRST, /* (waiting the device to)
  285. write CDB or first data block */
  286. HSM_ST, /* (waiting the device to) transfer data */
  287. HSM_ST_LAST, /* (waiting the device to) complete command */
  288. HSM_ST_ERR, /* error */
  289. };
  290. enum ata_completion_errors {
  291. AC_ERR_DEV = (1 << 0), /* device reported error */
  292. AC_ERR_HSM = (1 << 1), /* host state machine violation */
  293. AC_ERR_TIMEOUT = (1 << 2), /* timeout */
  294. AC_ERR_MEDIA = (1 << 3), /* media error */
  295. AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
  296. AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
  297. AC_ERR_SYSTEM = (1 << 6), /* system error */
  298. AC_ERR_INVALID = (1 << 7), /* invalid argument */
  299. AC_ERR_OTHER = (1 << 8), /* unknown */
  300. AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
  301. AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
  302. };
  303. /* forward declarations */
  304. struct scsi_device;
  305. struct ata_port_operations;
  306. struct ata_port;
  307. struct ata_link;
  308. struct ata_queued_cmd;
  309. /* typedefs */
  310. typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
  311. typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
  312. typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
  313. unsigned long deadline);
  314. typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
  315. struct ata_ioports {
  316. void __iomem *cmd_addr;
  317. void __iomem *data_addr;
  318. void __iomem *error_addr;
  319. void __iomem *feature_addr;
  320. void __iomem *nsect_addr;
  321. void __iomem *lbal_addr;
  322. void __iomem *lbam_addr;
  323. void __iomem *lbah_addr;
  324. void __iomem *device_addr;
  325. void __iomem *status_addr;
  326. void __iomem *command_addr;
  327. void __iomem *altstatus_addr;
  328. void __iomem *ctl_addr;
  329. void __iomem *bmdma_addr;
  330. void __iomem *scr_addr;
  331. };
  332. struct ata_host {
  333. spinlock_t lock;
  334. struct device *dev;
  335. void __iomem * const *iomap;
  336. unsigned int n_ports;
  337. void *private_data;
  338. const struct ata_port_operations *ops;
  339. unsigned long flags;
  340. #ifdef CONFIG_ATA_ACPI
  341. acpi_handle acpi_handle;
  342. #endif
  343. struct ata_port *simplex_claimed; /* channel owning the DMA */
  344. struct ata_port *ports[0];
  345. };
  346. struct ata_queued_cmd {
  347. struct ata_port *ap;
  348. struct ata_device *dev;
  349. struct scsi_cmnd *scsicmd;
  350. void (*scsidone)(struct scsi_cmnd *);
  351. struct ata_taskfile tf;
  352. u8 cdb[ATAPI_CDB_LEN];
  353. unsigned long flags; /* ATA_QCFLAG_xxx */
  354. unsigned int tag;
  355. unsigned int n_elem;
  356. unsigned int orig_n_elem;
  357. int dma_dir;
  358. unsigned int pad_len;
  359. unsigned int sect_size;
  360. unsigned int nbytes;
  361. unsigned int curbytes;
  362. unsigned int cursg;
  363. unsigned int cursg_ofs;
  364. struct scatterlist sgent;
  365. struct scatterlist pad_sgent;
  366. void *buf_virt;
  367. /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
  368. struct scatterlist *__sg;
  369. unsigned int err_mask;
  370. struct ata_taskfile result_tf;
  371. ata_qc_cb_t complete_fn;
  372. void *private_data;
  373. void *lldd_task;
  374. };
  375. struct ata_port_stats {
  376. unsigned long unhandled_irq;
  377. unsigned long idle_irq;
  378. unsigned long rw_reqbuf;
  379. };
  380. struct ata_ering_entry {
  381. int is_io;
  382. unsigned int err_mask;
  383. u64 timestamp;
  384. };
  385. struct ata_ering {
  386. int cursor;
  387. struct ata_ering_entry ring[ATA_ERING_SIZE];
  388. };
  389. struct ata_device {
  390. struct ata_link *link;
  391. unsigned int devno; /* 0 or 1 */
  392. unsigned long flags; /* ATA_DFLAG_xxx */
  393. unsigned int horkage; /* List of broken features */
  394. struct scsi_device *sdev; /* attached SCSI device */
  395. #ifdef CONFIG_ATA_ACPI
  396. acpi_handle acpi_handle;
  397. #endif
  398. /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
  399. u64 n_sectors; /* size of device, if ATA */
  400. unsigned int class; /* ATA_DEV_xxx */
  401. union {
  402. u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
  403. u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
  404. };
  405. u8 pio_mode;
  406. u8 dma_mode;
  407. u8 xfer_mode;
  408. unsigned int xfer_shift; /* ATA_SHIFT_xxx */
  409. unsigned int multi_count; /* sectors count for
  410. READ/WRITE MULTIPLE */
  411. unsigned int max_sectors; /* per-device max sectors */
  412. unsigned int cdb_len;
  413. /* per-dev xfer mask */
  414. unsigned int pio_mask;
  415. unsigned int mwdma_mask;
  416. unsigned int udma_mask;
  417. /* for CHS addressing */
  418. u16 cylinders; /* Number of cylinders */
  419. u16 heads; /* Number of heads */
  420. u16 sectors; /* Number of sectors per track */
  421. /* error history */
  422. struct ata_ering ering;
  423. int spdn_cnt;
  424. };
  425. /* Offset into struct ata_device. Fields above it are maintained
  426. * acress device init. Fields below are zeroed.
  427. */
  428. #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
  429. struct ata_eh_info {
  430. struct ata_device *dev; /* offending device */
  431. u32 serror; /* SError from LLDD */
  432. unsigned int err_mask; /* port-wide err_mask */
  433. unsigned int action; /* ATA_EH_* action mask */
  434. unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
  435. unsigned int flags; /* ATA_EHI_* flags */
  436. unsigned int probe_mask;
  437. char desc[ATA_EH_DESC_LEN];
  438. int desc_len;
  439. };
  440. struct ata_eh_context {
  441. struct ata_eh_info i;
  442. int tries[ATA_MAX_DEVICES];
  443. unsigned int classes[ATA_MAX_DEVICES];
  444. unsigned int did_probe_mask;
  445. };
  446. struct ata_acpi_drive
  447. {
  448. u32 pio;
  449. u32 dma;
  450. } __packed;
  451. struct ata_acpi_gtm {
  452. struct ata_acpi_drive drive[2];
  453. u32 flags;
  454. } __packed;
  455. struct ata_link {
  456. struct ata_port *ap;
  457. int pmp; /* port multiplier port # */
  458. unsigned int active_tag; /* active tag on this link */
  459. u32 sactive; /* active NCQ commands */
  460. unsigned int flags; /* ATA_LFLAG_xxx */
  461. unsigned int hw_sata_spd_limit;
  462. unsigned int sata_spd_limit;
  463. unsigned int sata_spd; /* current SATA PHY speed */
  464. /* record runtime error info, protected by host_set lock */
  465. struct ata_eh_info eh_info;
  466. /* EH context */
  467. struct ata_eh_context eh_context;
  468. struct ata_device device[ATA_MAX_DEVICES];
  469. };
  470. struct ata_port {
  471. struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
  472. const struct ata_port_operations *ops;
  473. spinlock_t *lock;
  474. unsigned long flags; /* ATA_FLAG_xxx */
  475. unsigned int pflags; /* ATA_PFLAG_xxx */
  476. unsigned int print_id; /* user visible unique port ID */
  477. unsigned int port_no; /* 0 based port no. inside the host */
  478. struct ata_prd *prd; /* our SG list */
  479. dma_addr_t prd_dma; /* and its DMA mapping */
  480. void *pad; /* array of DMA pad buffers */
  481. dma_addr_t pad_dma;
  482. struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
  483. u8 ctl; /* cache of ATA control register */
  484. u8 last_ctl; /* Cache last written value */
  485. unsigned int pio_mask;
  486. unsigned int mwdma_mask;
  487. unsigned int udma_mask;
  488. unsigned int cbl; /* cable type; ATA_CBL_xxx */
  489. struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
  490. unsigned long qc_allocated;
  491. unsigned int qc_active;
  492. int nr_active_links; /* #links with active qcs */
  493. struct ata_link link; /* host default link */
  494. int nr_pmp_links; /* nr of available PMP links */
  495. struct ata_link *pmp_link; /* array of PMP links */
  496. struct ata_link *excl_link; /* for PMP qc exclusion */
  497. struct ata_port_stats stats;
  498. struct ata_host *host;
  499. struct device *dev;
  500. void *port_task_data;
  501. struct delayed_work port_task;
  502. struct delayed_work hotplug_task;
  503. struct work_struct scsi_rescan_task;
  504. unsigned int hsm_task_state;
  505. u32 msg_enable;
  506. struct list_head eh_done_q;
  507. wait_queue_head_t eh_wait_q;
  508. int eh_tries;
  509. pm_message_t pm_mesg;
  510. int *pm_result;
  511. struct timer_list fastdrain_timer;
  512. unsigned long fastdrain_cnt;
  513. void *private_data;
  514. #ifdef CONFIG_ATA_ACPI
  515. acpi_handle acpi_handle;
  516. struct ata_acpi_gtm acpi_gtm;
  517. #endif
  518. u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
  519. };
  520. struct ata_port_operations {
  521. void (*dev_config) (struct ata_device *);
  522. void (*set_piomode) (struct ata_port *, struct ata_device *);
  523. void (*set_dmamode) (struct ata_port *, struct ata_device *);
  524. unsigned long (*mode_filter) (struct ata_device *, unsigned long);
  525. void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
  526. void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
  527. void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
  528. u8 (*check_status)(struct ata_port *ap);
  529. u8 (*check_altstatus)(struct ata_port *ap);
  530. void (*dev_select)(struct ata_port *ap, unsigned int device);
  531. void (*phy_reset) (struct ata_port *ap); /* obsolete */
  532. int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
  533. int (*cable_detect) (struct ata_port *ap);
  534. int (*check_atapi_dma) (struct ata_queued_cmd *qc);
  535. void (*bmdma_setup) (struct ata_queued_cmd *qc);
  536. void (*bmdma_start) (struct ata_queued_cmd *qc);
  537. void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
  538. int (*qc_defer) (struct ata_queued_cmd *qc);
  539. void (*qc_prep) (struct ata_queued_cmd *qc);
  540. unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
  541. /* port multiplier */
  542. void (*pmp_attach) (struct ata_port *ap);
  543. void (*pmp_detach) (struct ata_port *ap);
  544. int (*pmp_read) (struct ata_device *dev, int pmp, int reg, u32 *r_val);
  545. int (*pmp_write) (struct ata_device *dev, int pmp, int reg, u32 val);
  546. /* Error handlers. ->error_handler overrides ->eng_timeout and
  547. * indicates that new-style EH is in place.
  548. */
  549. void (*eng_timeout) (struct ata_port *ap); /* obsolete */
  550. void (*freeze) (struct ata_port *ap);
  551. void (*thaw) (struct ata_port *ap);
  552. void (*error_handler) (struct ata_port *ap);
  553. void (*post_internal_cmd) (struct ata_queued_cmd *qc);
  554. irq_handler_t irq_handler;
  555. void (*irq_clear) (struct ata_port *);
  556. u8 (*irq_on) (struct ata_port *);
  557. int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
  558. int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
  559. int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
  560. int (*port_resume) (struct ata_port *ap);
  561. int (*port_start) (struct ata_port *ap);
  562. void (*port_stop) (struct ata_port *ap);
  563. void (*host_stop) (struct ata_host *host);
  564. void (*bmdma_stop) (struct ata_queued_cmd *qc);
  565. u8 (*bmdma_status) (struct ata_port *ap);
  566. };
  567. struct ata_port_info {
  568. struct scsi_host_template *sht;
  569. unsigned long flags;
  570. unsigned long link_flags;
  571. unsigned long pio_mask;
  572. unsigned long mwdma_mask;
  573. unsigned long udma_mask;
  574. const struct ata_port_operations *port_ops;
  575. irq_handler_t irq_handler;
  576. void *private_data;
  577. };
  578. struct ata_timing {
  579. unsigned short mode; /* ATA mode */
  580. unsigned short setup; /* t1 */
  581. unsigned short act8b; /* t2 for 8-bit I/O */
  582. unsigned short rec8b; /* t2i for 8-bit I/O */
  583. unsigned short cyc8b; /* t0 for 8-bit I/O */
  584. unsigned short active; /* t2 or tD */
  585. unsigned short recover; /* t2i or tK */
  586. unsigned short cycle; /* t0 */
  587. unsigned short udma; /* t2CYCTYP/2 */
  588. };
  589. #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
  590. extern const unsigned long sata_deb_timing_normal[];
  591. extern const unsigned long sata_deb_timing_hotplug[];
  592. extern const unsigned long sata_deb_timing_long[];
  593. extern const struct ata_port_operations ata_dummy_port_ops;
  594. extern const struct ata_port_info ata_dummy_port_info;
  595. static inline const unsigned long *
  596. sata_ehc_deb_timing(struct ata_eh_context *ehc)
  597. {
  598. if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
  599. return sata_deb_timing_hotplug;
  600. else
  601. return sata_deb_timing_normal;
  602. }
  603. static inline int ata_port_is_dummy(struct ata_port *ap)
  604. {
  605. return ap->ops == &ata_dummy_port_ops;
  606. }
  607. extern void sata_print_link_status(struct ata_link *link);
  608. extern void ata_port_probe(struct ata_port *);
  609. extern void __sata_phy_reset(struct ata_port *ap);
  610. extern void sata_phy_reset(struct ata_port *ap);
  611. extern void ata_bus_reset(struct ata_port *ap);
  612. extern int sata_set_spd(struct ata_link *link);
  613. extern int sata_link_debounce(struct ata_link *link,
  614. const unsigned long *params, unsigned long deadline);
  615. extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
  616. unsigned long deadline);
  617. extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
  618. extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
  619. unsigned long deadline);
  620. extern int sata_link_hardreset(struct ata_link *link,
  621. const unsigned long *timing, unsigned long deadline);
  622. extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
  623. unsigned long deadline);
  624. extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
  625. extern void ata_port_disable(struct ata_port *);
  626. extern void ata_std_ports(struct ata_ioports *ioaddr);
  627. #ifdef CONFIG_PCI
  628. extern int ata_pci_init_one (struct pci_dev *pdev,
  629. const struct ata_port_info * const * ppi);
  630. extern void ata_pci_remove_one (struct pci_dev *pdev);
  631. #ifdef CONFIG_PM
  632. extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
  633. extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
  634. extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
  635. extern int ata_pci_device_resume(struct pci_dev *pdev);
  636. #endif
  637. extern int ata_pci_clear_simplex(struct pci_dev *pdev);
  638. #endif /* CONFIG_PCI */
  639. extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
  640. extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
  641. const struct ata_port_info * const * ppi, int n_ports);
  642. extern int ata_host_start(struct ata_host *host);
  643. extern int ata_host_register(struct ata_host *host,
  644. struct scsi_host_template *sht);
  645. extern int ata_host_activate(struct ata_host *host, int irq,
  646. irq_handler_t irq_handler, unsigned long irq_flags,
  647. struct scsi_host_template *sht);
  648. extern void ata_host_detach(struct ata_host *host);
  649. extern void ata_host_init(struct ata_host *, struct device *,
  650. unsigned long, const struct ata_port_operations *);
  651. extern int ata_scsi_detect(struct scsi_host_template *sht);
  652. extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
  653. extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
  654. extern void ata_scsi_media_change_notify(struct ata_device *atadev);
  655. extern void ata_sas_port_destroy(struct ata_port *);
  656. extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
  657. struct ata_port_info *, struct Scsi_Host *);
  658. extern int ata_sas_port_init(struct ata_port *);
  659. extern int ata_sas_port_start(struct ata_port *ap);
  660. extern void ata_sas_port_stop(struct ata_port *ap);
  661. extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
  662. extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
  663. struct ata_port *ap);
  664. extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
  665. extern int sata_scr_valid(struct ata_link *link);
  666. extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
  667. extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
  668. extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
  669. extern int ata_link_online(struct ata_link *link);
  670. extern int ata_link_offline(struct ata_link *link);
  671. #ifdef CONFIG_PM
  672. extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
  673. extern void ata_host_resume(struct ata_host *host);
  674. #endif
  675. extern int ata_ratelimit(void);
  676. extern int ata_busy_sleep(struct ata_port *ap,
  677. unsigned long timeout_pat, unsigned long timeout);
  678. extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
  679. extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
  680. void *data, unsigned long delay);
  681. extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
  682. unsigned long interval_msec,
  683. unsigned long timeout_msec);
  684. extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
  685. u8 *r_err);
  686. /*
  687. * Default driver ops implementations
  688. */
  689. extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
  690. extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
  691. extern void ata_tf_to_fis(const struct ata_taskfile *tf,
  692. u8 pmp, int is_cmd, u8 *fis);
  693. extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
  694. extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
  695. extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
  696. extern u8 ata_check_status(struct ata_port *ap);
  697. extern u8 ata_altstatus(struct ata_port *ap);
  698. extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
  699. extern int ata_port_start (struct ata_port *ap);
  700. extern int ata_sff_port_start (struct ata_port *ap);
  701. extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
  702. extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
  703. unsigned int buflen, int write_data);
  704. extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
  705. unsigned int buflen, int write_data);
  706. extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
  707. extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
  708. extern void ata_qc_prep(struct ata_queued_cmd *qc);
  709. extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
  710. extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
  711. extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
  712. unsigned int buflen);
  713. extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
  714. unsigned int n_elem);
  715. extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
  716. extern void ata_dev_disable(struct ata_device *adev);
  717. extern void ata_id_string(const u16 *id, unsigned char *s,
  718. unsigned int ofs, unsigned int len);
  719. extern void ata_id_c_string(const u16 *id, unsigned char *s,
  720. unsigned int ofs, unsigned int len);
  721. extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
  722. extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
  723. extern void ata_bmdma_start (struct ata_queued_cmd *qc);
  724. extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
  725. extern u8 ata_bmdma_status(struct ata_port *ap);
  726. extern void ata_bmdma_irq_clear(struct ata_port *ap);
  727. extern void ata_bmdma_freeze(struct ata_port *ap);
  728. extern void ata_bmdma_thaw(struct ata_port *ap);
  729. extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  730. ata_reset_fn_t softreset,
  731. ata_reset_fn_t hardreset,
  732. ata_postreset_fn_t postreset);
  733. extern void ata_bmdma_error_handler(struct ata_port *ap);
  734. extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
  735. extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
  736. u8 status, int in_wq);
  737. extern void ata_qc_complete(struct ata_queued_cmd *qc);
  738. extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
  739. void (*finish_qc)(struct ata_queued_cmd *));
  740. extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
  741. void (*done)(struct scsi_cmnd *));
  742. extern int ata_std_bios_param(struct scsi_device *sdev,
  743. struct block_device *bdev,
  744. sector_t capacity, int geom[]);
  745. extern int ata_scsi_slave_config(struct scsi_device *sdev);
  746. extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
  747. extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
  748. int queue_depth);
  749. extern struct ata_device *ata_dev_pair(struct ata_device *adev);
  750. extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
  751. extern u8 ata_irq_on(struct ata_port *ap);
  752. extern int ata_cable_40wire(struct ata_port *ap);
  753. extern int ata_cable_80wire(struct ata_port *ap);
  754. extern int ata_cable_sata(struct ata_port *ap);
  755. extern int ata_cable_unknown(struct ata_port *ap);
  756. /*
  757. * Timing helpers
  758. */
  759. extern unsigned int ata_pio_need_iordy(const struct ata_device *);
  760. extern int ata_timing_compute(struct ata_device *, unsigned short,
  761. struct ata_timing *, int, int);
  762. extern void ata_timing_merge(const struct ata_timing *,
  763. const struct ata_timing *, struct ata_timing *,
  764. unsigned int);
  765. enum {
  766. ATA_TIMING_SETUP = (1 << 0),
  767. ATA_TIMING_ACT8B = (1 << 1),
  768. ATA_TIMING_REC8B = (1 << 2),
  769. ATA_TIMING_CYC8B = (1 << 3),
  770. ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
  771. ATA_TIMING_CYC8B,
  772. ATA_TIMING_ACTIVE = (1 << 4),
  773. ATA_TIMING_RECOVER = (1 << 5),
  774. ATA_TIMING_CYCLE = (1 << 6),
  775. ATA_TIMING_UDMA = (1 << 7),
  776. ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
  777. ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
  778. ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
  779. ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
  780. };
  781. /* libata-acpi.c */
  782. #ifdef CONFIG_ATA_ACPI
  783. extern int ata_acpi_cbl_80wire(struct ata_port *ap);
  784. #else
  785. static inline int ata_acpi_cbl_80wire(struct ata_port *ap) { return 0; }
  786. #endif
  787. #ifdef CONFIG_PCI
  788. struct pci_bits {
  789. unsigned int reg; /* PCI config register to read */
  790. unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
  791. unsigned long mask;
  792. unsigned long val;
  793. };
  794. extern int ata_pci_init_sff_host(struct ata_host *host);
  795. extern int ata_pci_init_bmdma(struct ata_host *host);
  796. extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
  797. const struct ata_port_info * const * ppi,
  798. struct ata_host **r_host);
  799. extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
  800. extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
  801. #endif /* CONFIG_PCI */
  802. /*
  803. * EH
  804. */
  805. extern void ata_eng_timeout(struct ata_port *ap);
  806. extern void ata_port_schedule_eh(struct ata_port *ap);
  807. extern int ata_link_abort(struct ata_link *link);
  808. extern int ata_port_abort(struct ata_port *ap);
  809. extern int ata_port_freeze(struct ata_port *ap);
  810. extern void ata_eh_freeze_port(struct ata_port *ap);
  811. extern void ata_eh_thaw_port(struct ata_port *ap);
  812. extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
  813. extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
  814. extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  815. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  816. ata_postreset_fn_t postreset);
  817. /*
  818. * printk helpers
  819. */
  820. #define ata_port_printk(ap, lv, fmt, args...) \
  821. printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
  822. #define ata_link_printk(link, lv, fmt, args...) do { \
  823. if ((link)->ap->nr_pmp_links) \
  824. printk(lv"ata%u.%02u: "fmt, (link)->ap->print_id, \
  825. (link)->pmp , ##args); \
  826. else \
  827. printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args); \
  828. } while(0)
  829. #define ata_dev_printk(dev, lv, fmt, args...) \
  830. printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, \
  831. (dev)->link->pmp + (dev)->devno , ##args)
  832. /*
  833. * ata_eh_info helpers
  834. */
  835. extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
  836. __attribute__ ((format (printf, 2, 3)));
  837. extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
  838. __attribute__ ((format (printf, 2, 3)));
  839. extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
  840. static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
  841. {
  842. ehi->flags |= ATA_EHI_RESUME_LINK;
  843. ehi->action |= ATA_EH_SOFTRESET;
  844. ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
  845. }
  846. static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
  847. {
  848. ata_ehi_schedule_probe(ehi);
  849. ehi->flags |= ATA_EHI_HOTPLUGGED;
  850. ehi->err_mask |= AC_ERR_ATA_BUS;
  851. }
  852. /*
  853. * port description helpers
  854. */
  855. extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
  856. __attribute__ ((format (printf, 2, 3)));
  857. #ifdef CONFIG_PCI
  858. extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
  859. const char *name);
  860. #endif
  861. /*
  862. * qc helpers
  863. */
  864. static inline int
  865. ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
  866. {
  867. if (sg == &qc->pad_sgent)
  868. return 1;
  869. if (qc->pad_len)
  870. return 0;
  871. if (((sg - qc->__sg) + 1) == qc->n_elem)
  872. return 1;
  873. return 0;
  874. }
  875. static inline struct scatterlist *
  876. ata_qc_first_sg(struct ata_queued_cmd *qc)
  877. {
  878. if (qc->n_elem)
  879. return qc->__sg;
  880. if (qc->pad_len)
  881. return &qc->pad_sgent;
  882. return NULL;
  883. }
  884. static inline struct scatterlist *
  885. ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
  886. {
  887. if (sg == &qc->pad_sgent)
  888. return NULL;
  889. if (++sg - qc->__sg < qc->n_elem)
  890. return sg;
  891. if (qc->pad_len)
  892. return &qc->pad_sgent;
  893. return NULL;
  894. }
  895. #define ata_for_each_sg(sg, qc) \
  896. for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
  897. static inline unsigned int ata_tag_valid(unsigned int tag)
  898. {
  899. return (tag < ATA_MAX_QUEUE) ? 1 : 0;
  900. }
  901. static inline unsigned int ata_tag_internal(unsigned int tag)
  902. {
  903. return tag == ATA_MAX_QUEUE - 1;
  904. }
  905. /*
  906. * device helpers
  907. */
  908. static inline unsigned int ata_class_enabled(unsigned int class)
  909. {
  910. return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
  911. class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
  912. }
  913. static inline unsigned int ata_class_disabled(unsigned int class)
  914. {
  915. return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
  916. class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
  917. }
  918. static inline unsigned int ata_class_absent(unsigned int class)
  919. {
  920. return !ata_class_enabled(class) && !ata_class_disabled(class);
  921. }
  922. static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
  923. {
  924. return ata_class_enabled(dev->class);
  925. }
  926. static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
  927. {
  928. return ata_class_disabled(dev->class);
  929. }
  930. static inline unsigned int ata_dev_absent(const struct ata_device *dev)
  931. {
  932. return ata_class_absent(dev->class);
  933. }
  934. /*
  935. * link helpers
  936. */
  937. static inline int ata_is_host_link(const struct ata_link *link)
  938. {
  939. return link == &link->ap->link;
  940. }
  941. static inline int ata_link_max_devices(const struct ata_link *link)
  942. {
  943. if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
  944. return 2;
  945. return 1;
  946. }
  947. static inline int ata_link_active(struct ata_link *link)
  948. {
  949. return ata_tag_valid(link->active_tag) || link->sactive;
  950. }
  951. static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
  952. {
  953. if (ap->nr_pmp_links)
  954. return ap->pmp_link;
  955. return &ap->link;
  956. }
  957. static inline struct ata_link *ata_port_next_link(struct ata_link *link)
  958. {
  959. struct ata_port *ap = link->ap;
  960. if (link == &ap->link) {
  961. if (!ap->nr_pmp_links)
  962. return NULL;
  963. return ap->pmp_link;
  964. }
  965. if (++link - ap->pmp_link < ap->nr_pmp_links)
  966. return link;
  967. return NULL;
  968. }
  969. #define __ata_port_for_each_link(lk, ap) \
  970. for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
  971. #define ata_port_for_each_link(link, ap) \
  972. for ((link) = ata_port_first_link(ap); (link); \
  973. (link) = ata_port_next_link(link))
  974. #define ata_link_for_each_dev(dev, link) \
  975. for ((dev) = (link)->device; \
  976. (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
  977. (dev)++)
  978. #define ata_link_for_each_dev_reverse(dev, link) \
  979. for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
  980. (dev) >= (link)->device || ((dev) = NULL); (dev)--)
  981. static inline u8 ata_chk_status(struct ata_port *ap)
  982. {
  983. return ap->ops->check_status(ap);
  984. }
  985. /**
  986. * ata_ncq_enabled - Test whether NCQ is enabled
  987. * @dev: ATA device to test for
  988. *
  989. * LOCKING:
  990. * spin_lock_irqsave(host lock)
  991. *
  992. * RETURNS:
  993. * 1 if NCQ is enabled for @dev, 0 otherwise.
  994. */
  995. static inline int ata_ncq_enabled(struct ata_device *dev)
  996. {
  997. return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
  998. ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
  999. }
  1000. /**
  1001. * ata_pause - Flush writes and pause 400 nanoseconds.
  1002. * @ap: Port to wait for.
  1003. *
  1004. * LOCKING:
  1005. * Inherited from caller.
  1006. */
  1007. static inline void ata_pause(struct ata_port *ap)
  1008. {
  1009. ata_altstatus(ap);
  1010. ndelay(400);
  1011. }
  1012. /**
  1013. * ata_busy_wait - Wait for a port status register
  1014. * @ap: Port to wait for.
  1015. * @bits: bits that must be clear
  1016. * @max: number of 10uS waits to perform
  1017. *
  1018. * Waits up to max*10 microseconds for the selected bits in the port's
  1019. * status register to be cleared.
  1020. * Returns final value of status register.
  1021. *
  1022. * LOCKING:
  1023. * Inherited from caller.
  1024. */
  1025. static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
  1026. unsigned int max)
  1027. {
  1028. u8 status;
  1029. do {
  1030. udelay(10);
  1031. status = ata_chk_status(ap);
  1032. max--;
  1033. } while (status != 0xff && (status & bits) && (max > 0));
  1034. return status;
  1035. }
  1036. /**
  1037. * ata_wait_idle - Wait for a port to be idle.
  1038. * @ap: Port to wait for.
  1039. *
  1040. * Waits up to 10ms for port's BUSY and DRQ signals to clear.
  1041. * Returns final value of status register.
  1042. *
  1043. * LOCKING:
  1044. * Inherited from caller.
  1045. */
  1046. static inline u8 ata_wait_idle(struct ata_port *ap)
  1047. {
  1048. u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
  1049. #ifdef ATA_DEBUG
  1050. if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
  1051. ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
  1052. status);
  1053. #endif
  1054. return status;
  1055. }
  1056. static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
  1057. {
  1058. qc->tf.ctl |= ATA_NIEN;
  1059. }
  1060. static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
  1061. unsigned int tag)
  1062. {
  1063. if (likely(ata_tag_valid(tag)))
  1064. return &ap->qcmd[tag];
  1065. return NULL;
  1066. }
  1067. static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
  1068. unsigned int tag)
  1069. {
  1070. struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
  1071. if (unlikely(!qc) || !ap->ops->error_handler)
  1072. return qc;
  1073. if ((qc->flags & (ATA_QCFLAG_ACTIVE |
  1074. ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
  1075. return qc;
  1076. return NULL;
  1077. }
  1078. static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
  1079. {
  1080. memset(tf, 0, sizeof(*tf));
  1081. tf->ctl = dev->link->ap->ctl;
  1082. if (dev->devno == 0)
  1083. tf->device = ATA_DEVICE_OBS;
  1084. else
  1085. tf->device = ATA_DEVICE_OBS | ATA_DEV1;
  1086. }
  1087. static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
  1088. {
  1089. qc->dma_dir = DMA_NONE;
  1090. qc->__sg = NULL;
  1091. qc->flags = 0;
  1092. qc->cursg = qc->cursg_ofs = 0;
  1093. qc->nbytes = qc->curbytes = 0;
  1094. qc->n_elem = 0;
  1095. qc->err_mask = 0;
  1096. qc->pad_len = 0;
  1097. qc->sect_size = ATA_SECT_SIZE;
  1098. ata_tf_init(qc->dev, &qc->tf);
  1099. /* init result_tf such that it indicates normal completion */
  1100. qc->result_tf.command = ATA_DRDY;
  1101. qc->result_tf.feature = 0;
  1102. }
  1103. static inline int ata_try_flush_cache(const struct ata_device *dev)
  1104. {
  1105. return ata_id_wcache_enabled(dev->id) ||
  1106. ata_id_has_flush(dev->id) ||
  1107. ata_id_has_flush_ext(dev->id);
  1108. }
  1109. static inline unsigned int ac_err_mask(u8 status)
  1110. {
  1111. if (status & (ATA_BUSY | ATA_DRQ))
  1112. return AC_ERR_HSM;
  1113. if (status & (ATA_ERR | ATA_DF))
  1114. return AC_ERR_DEV;
  1115. return 0;
  1116. }
  1117. static inline unsigned int __ac_err_mask(u8 status)
  1118. {
  1119. unsigned int mask = ac_err_mask(status);
  1120. if (mask == 0)
  1121. return AC_ERR_OTHER;
  1122. return mask;
  1123. }
  1124. static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
  1125. {
  1126. ap->pad_dma = 0;
  1127. ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
  1128. &ap->pad_dma, GFP_KERNEL);
  1129. return (ap->pad == NULL) ? -ENOMEM : 0;
  1130. }
  1131. static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
  1132. {
  1133. dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
  1134. }
  1135. static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
  1136. {
  1137. return *(struct ata_port **)&host->hostdata[0];
  1138. }
  1139. #endif /* __LINUX_LIBATA_H__ */