libata.h 43 KB

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