libata.h 43 KB

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