libata.h 59 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801
  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/jiffies.h>
  29. #include <linux/interrupt.h>
  30. #include <linux/dma-mapping.h>
  31. #include <linux/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. #include <linux/cdrom.h>
  38. #include <linux/sched.h>
  39. /*
  40. * Define if arch has non-standard setup. This is a _PCI_ standard
  41. * not a legacy or ISA standard.
  42. */
  43. #ifdef CONFIG_ATA_NONSTANDARD
  44. #include <asm/libata-portmap.h>
  45. #else
  46. #include <asm-generic/libata-portmap.h>
  47. #endif
  48. /*
  49. * compile-time options: to be removed as soon as all the drivers are
  50. * converted to the new debugging mechanism
  51. */
  52. #undef ATA_DEBUG /* debugging output */
  53. #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
  54. #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
  55. #undef ATA_NDEBUG /* define to disable quick runtime checks */
  56. /* note: prints function name for you */
  57. #ifdef ATA_DEBUG
  58. #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  59. #ifdef ATA_VERBOSE_DEBUG
  60. #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  61. #else
  62. #define VPRINTK(fmt, args...)
  63. #endif /* ATA_VERBOSE_DEBUG */
  64. #else
  65. #define DPRINTK(fmt, args...)
  66. #define VPRINTK(fmt, args...)
  67. #endif /* ATA_DEBUG */
  68. #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
  69. #define ata_print_version_once(dev, version) \
  70. ({ \
  71. static bool __print_once; \
  72. \
  73. if (!__print_once) { \
  74. __print_once = true; \
  75. ata_print_version(dev, version); \
  76. } \
  77. })
  78. /* NEW: debug levels */
  79. #define HAVE_LIBATA_MSG 1
  80. enum {
  81. ATA_MSG_DRV = 0x0001,
  82. ATA_MSG_INFO = 0x0002,
  83. ATA_MSG_PROBE = 0x0004,
  84. ATA_MSG_WARN = 0x0008,
  85. ATA_MSG_MALLOC = 0x0010,
  86. ATA_MSG_CTL = 0x0020,
  87. ATA_MSG_INTR = 0x0040,
  88. ATA_MSG_ERR = 0x0080,
  89. };
  90. #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
  91. #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
  92. #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
  93. #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
  94. #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
  95. #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
  96. #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
  97. #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
  98. static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
  99. {
  100. if (dval < 0 || dval >= (sizeof(u32) * 8))
  101. return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
  102. if (!dval)
  103. return 0;
  104. return (1 << dval) - 1;
  105. }
  106. /* defines only for the constants which don't work well as enums */
  107. #define ATA_TAG_POISON 0xfafbfcfdU
  108. enum {
  109. /* various global constants */
  110. LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
  111. LIBATA_DUMB_MAX_PRD = ATA_MAX_PRD / 4, /* Worst case */
  112. ATA_DEF_QUEUE = 1,
  113. /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
  114. ATA_MAX_QUEUE = 32,
  115. ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
  116. ATA_SHORT_PAUSE = 16,
  117. ATAPI_MAX_DRAIN = 16 << 10,
  118. ATA_ALL_DEVICES = (1 << ATA_MAX_DEVICES) - 1,
  119. ATA_SHT_EMULATED = 1,
  120. ATA_SHT_CMD_PER_LUN = 1,
  121. ATA_SHT_THIS_ID = -1,
  122. ATA_SHT_USE_CLUSTERING = 1,
  123. /* struct ata_device stuff */
  124. ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
  125. ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
  126. ATA_DFLAG_CDB_INTR = (1 << 2), /* device asserts INTRQ when ready for CDB */
  127. ATA_DFLAG_NCQ = (1 << 3), /* device supports NCQ */
  128. ATA_DFLAG_FLUSH_EXT = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
  129. ATA_DFLAG_ACPI_PENDING = (1 << 5), /* ACPI resume action pending */
  130. ATA_DFLAG_ACPI_FAILED = (1 << 6), /* ACPI on devcfg has failed */
  131. ATA_DFLAG_AN = (1 << 7), /* AN configured */
  132. ATA_DFLAG_DMADIR = (1 << 10), /* device requires DMADIR */
  133. ATA_DFLAG_CFG_MASK = (1 << 12) - 1,
  134. ATA_DFLAG_PIO = (1 << 12), /* device limited to PIO mode */
  135. ATA_DFLAG_NCQ_OFF = (1 << 13), /* device limited to non-NCQ mode */
  136. ATA_DFLAG_SLEEPING = (1 << 15), /* device is sleeping */
  137. ATA_DFLAG_DUBIOUS_XFER = (1 << 16), /* data transfer not verified */
  138. ATA_DFLAG_NO_UNLOAD = (1 << 17), /* device doesn't support unload */
  139. ATA_DFLAG_UNLOCK_HPA = (1 << 18), /* unlock HPA */
  140. ATA_DFLAG_INIT_MASK = (1 << 24) - 1,
  141. ATA_DFLAG_DETACH = (1 << 24),
  142. ATA_DFLAG_DETACHED = (1 << 25),
  143. ATA_DFLAG_DA = (1 << 26), /* device supports Device Attention */
  144. ATA_DEV_UNKNOWN = 0, /* unknown device */
  145. ATA_DEV_ATA = 1, /* ATA device */
  146. ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
  147. ATA_DEV_ATAPI = 3, /* ATAPI device */
  148. ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
  149. ATA_DEV_PMP = 5, /* SATA port multiplier */
  150. ATA_DEV_PMP_UNSUP = 6, /* SATA port multiplier (unsupported) */
  151. ATA_DEV_SEMB = 7, /* SEMB */
  152. ATA_DEV_SEMB_UNSUP = 8, /* SEMB (unsupported) */
  153. ATA_DEV_NONE = 9, /* no device */
  154. /* struct ata_link flags */
  155. ATA_LFLAG_NO_HRST = (1 << 1), /* avoid hardreset */
  156. ATA_LFLAG_NO_SRST = (1 << 2), /* avoid softreset */
  157. ATA_LFLAG_ASSUME_ATA = (1 << 3), /* assume ATA class */
  158. ATA_LFLAG_ASSUME_SEMB = (1 << 4), /* assume SEMB class */
  159. ATA_LFLAG_ASSUME_CLASS = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
  160. ATA_LFLAG_NO_RETRY = (1 << 5), /* don't retry this link */
  161. ATA_LFLAG_DISABLED = (1 << 6), /* link is disabled */
  162. ATA_LFLAG_SW_ACTIVITY = (1 << 7), /* keep activity stats */
  163. ATA_LFLAG_NO_LPM = (1 << 8), /* disable LPM on this link */
  164. ATA_LFLAG_RST_ONCE = (1 << 9), /* limit recovery to one reset */
  165. /* struct ata_port flags */
  166. ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
  167. /* (doesn't imply presence) */
  168. ATA_FLAG_SATA = (1 << 1),
  169. ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
  170. ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
  171. ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
  172. ATA_FLAG_PIO_POLLING = (1 << 9), /* use polling PIO if LLD
  173. * doesn't handle PIO interrupts */
  174. ATA_FLAG_NCQ = (1 << 10), /* host supports NCQ */
  175. ATA_FLAG_NO_POWEROFF_SPINDOWN = (1 << 11), /* don't spindown before poweroff */
  176. ATA_FLAG_NO_HIBERNATE_SPINDOWN = (1 << 12), /* don't spindown before hibernation */
  177. ATA_FLAG_DEBUGMSG = (1 << 13),
  178. ATA_FLAG_FPDMA_AA = (1 << 14), /* driver supports Auto-Activate */
  179. ATA_FLAG_IGN_SIMPLEX = (1 << 15), /* ignore SIMPLEX */
  180. ATA_FLAG_NO_IORDY = (1 << 16), /* controller lacks iordy */
  181. ATA_FLAG_ACPI_SATA = (1 << 17), /* need native SATA ACPI layout */
  182. ATA_FLAG_AN = (1 << 18), /* controller supports AN */
  183. ATA_FLAG_PMP = (1 << 19), /* controller supports PMP */
  184. ATA_FLAG_EM = (1 << 21), /* driver supports enclosure
  185. * management */
  186. ATA_FLAG_SW_ACTIVITY = (1 << 22), /* driver supports sw activity
  187. * led */
  188. ATA_FLAG_NO_DIPM = (1 << 23), /* host not happy with DIPM */
  189. /* bits 24:31 of ap->flags are reserved for LLD specific flags */
  190. /* struct ata_port pflags */
  191. ATA_PFLAG_EH_PENDING = (1 << 0), /* EH pending */
  192. ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
  193. ATA_PFLAG_FROZEN = (1 << 2), /* port is frozen */
  194. ATA_PFLAG_RECOVERED = (1 << 3), /* recovery action performed */
  195. ATA_PFLAG_LOADING = (1 << 4), /* boot/loading probe */
  196. ATA_PFLAG_SCSI_HOTPLUG = (1 << 6), /* SCSI hotplug scheduled */
  197. ATA_PFLAG_INITIALIZING = (1 << 7), /* being initialized, don't touch */
  198. ATA_PFLAG_RESETTING = (1 << 8), /* reset in progress */
  199. ATA_PFLAG_UNLOADING = (1 << 9), /* driver is being unloaded */
  200. ATA_PFLAG_UNLOADED = (1 << 10), /* driver is unloaded */
  201. ATA_PFLAG_SUSPENDED = (1 << 17), /* port is suspended (power) */
  202. ATA_PFLAG_PM_PENDING = (1 << 18), /* PM operation pending */
  203. ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
  204. ATA_PFLAG_PIO32 = (1 << 20), /* 32bit PIO */
  205. ATA_PFLAG_PIO32CHANGE = (1 << 21), /* 32bit PIO can be turned on/off */
  206. /* struct ata_queued_cmd flags */
  207. ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
  208. ATA_QCFLAG_DMAMAP = (1 << 1), /* SG table is DMA mapped */
  209. ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
  210. ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
  211. ATA_QCFLAG_CLEAR_EXCL = (1 << 5), /* clear excl_link on completion */
  212. ATA_QCFLAG_QUIET = (1 << 6), /* don't report device error */
  213. ATA_QCFLAG_RETRY = (1 << 7), /* retry after failure */
  214. ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
  215. ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
  216. ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
  217. /* host set flags */
  218. ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host only */
  219. ATA_HOST_STARTED = (1 << 1), /* Host started */
  220. ATA_HOST_PARALLEL_SCAN = (1 << 2), /* Ports on this host can be scanned in parallel */
  221. ATA_HOST_IGNORE_ATA = (1 << 3), /* Ignore ATA devices on this host. */
  222. /* bits 24:31 of host->flags are reserved for LLD specific flags */
  223. /* various lengths of time */
  224. ATA_TMOUT_BOOT = 30000, /* heuristic */
  225. ATA_TMOUT_BOOT_QUICK = 7000, /* heuristic */
  226. ATA_TMOUT_INTERNAL_QUICK = 5000,
  227. ATA_TMOUT_MAX_PARK = 30000,
  228. /*
  229. * GoVault needs 2s and iVDR disk HHD424020F7SV00 800ms. 2s
  230. * is too much without parallel probing. Use 2s if parallel
  231. * probing is available, 800ms otherwise.
  232. */
  233. ATA_TMOUT_FF_WAIT_LONG = 2000,
  234. ATA_TMOUT_FF_WAIT = 800,
  235. /* Spec mandates to wait for ">= 2ms" before checking status
  236. * after reset. We wait 150ms, because that was the magic
  237. * delay used for ATAPI devices in Hale Landis's ATADRVR, for
  238. * the period of time between when the ATA command register is
  239. * written, and then status is checked. Because waiting for
  240. * "a while" before checking status is fine, post SRST, we
  241. * perform this magic delay here as well.
  242. *
  243. * Old drivers/ide uses the 2mS rule and then waits for ready.
  244. */
  245. ATA_WAIT_AFTER_RESET = 150,
  246. /* If PMP is supported, we have to do follow-up SRST. As some
  247. * PMPs don't send D2H Reg FIS after hardreset, LLDs are
  248. * advised to wait only for the following duration before
  249. * doing SRST.
  250. */
  251. ATA_TMOUT_PMP_SRST_WAIT = 5000,
  252. /* ATA bus states */
  253. BUS_UNKNOWN = 0,
  254. BUS_DMA = 1,
  255. BUS_IDLE = 2,
  256. BUS_NOINTR = 3,
  257. BUS_NODATA = 4,
  258. BUS_TIMER = 5,
  259. BUS_PIO = 6,
  260. BUS_EDD = 7,
  261. BUS_IDENTIFY = 8,
  262. BUS_PACKET = 9,
  263. /* SATA port states */
  264. PORT_UNKNOWN = 0,
  265. PORT_ENABLED = 1,
  266. PORT_DISABLED = 2,
  267. /* encoding various smaller bitmaps into a single
  268. * unsigned long bitmap
  269. */
  270. ATA_NR_PIO_MODES = 7,
  271. ATA_NR_MWDMA_MODES = 5,
  272. ATA_NR_UDMA_MODES = 8,
  273. ATA_SHIFT_PIO = 0,
  274. ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
  275. ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
  276. /* size of buffer to pad xfers ending on unaligned boundaries */
  277. ATA_DMA_PAD_SZ = 4,
  278. /* ering size */
  279. ATA_ERING_SIZE = 32,
  280. /* return values for ->qc_defer */
  281. ATA_DEFER_LINK = 1,
  282. ATA_DEFER_PORT = 2,
  283. /* desc_len for ata_eh_info and context */
  284. ATA_EH_DESC_LEN = 80,
  285. /* reset / recovery action types */
  286. ATA_EH_REVALIDATE = (1 << 0),
  287. ATA_EH_SOFTRESET = (1 << 1), /* meaningful only in ->prereset */
  288. ATA_EH_HARDRESET = (1 << 2), /* meaningful only in ->prereset */
  289. ATA_EH_RESET = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
  290. ATA_EH_ENABLE_LINK = (1 << 3),
  291. ATA_EH_PARK = (1 << 5), /* unload heads and stop I/O */
  292. ATA_EH_PERDEV_MASK = ATA_EH_REVALIDATE | ATA_EH_PARK,
  293. ATA_EH_ALL_ACTIONS = ATA_EH_REVALIDATE | ATA_EH_RESET |
  294. ATA_EH_ENABLE_LINK,
  295. /* ata_eh_info->flags */
  296. ATA_EHI_HOTPLUGGED = (1 << 0), /* could have been hotplugged */
  297. ATA_EHI_NO_AUTOPSY = (1 << 2), /* no autopsy */
  298. ATA_EHI_QUIET = (1 << 3), /* be quiet */
  299. ATA_EHI_NO_RECOVERY = (1 << 4), /* no recovery */
  300. ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
  301. ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
  302. ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
  303. ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
  304. ATA_EHI_POST_SETMODE = (1 << 20), /* revalidating after setmode */
  305. ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
  306. /* mask of flags to transfer *to* the slave link */
  307. ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
  308. /* max tries if error condition is still set after ->error_handler */
  309. ATA_EH_MAX_TRIES = 5,
  310. /* sometimes resuming a link requires several retries */
  311. ATA_LINK_RESUME_TRIES = 5,
  312. /* how hard are we gonna try to probe/recover devices */
  313. ATA_PROBE_MAX_TRIES = 3,
  314. ATA_EH_DEV_TRIES = 3,
  315. ATA_EH_PMP_TRIES = 5,
  316. ATA_EH_PMP_LINK_TRIES = 3,
  317. SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
  318. /* This should match the actual table size of
  319. * ata_eh_cmd_timeout_table in libata-eh.c.
  320. */
  321. ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
  322. /* Horkage types. May be set by libata or controller on drives
  323. (some horkage may be drive/controller pair dependent */
  324. ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
  325. ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
  326. ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
  327. ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
  328. ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
  329. ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
  330. ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
  331. ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
  332. ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
  333. ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
  334. ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
  335. not multiple of 16 bytes */
  336. ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
  337. ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
  338. ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
  339. ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
  340. ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
  341. /* DMA mask for user DMA control: User visible values; DO NOT
  342. renumber */
  343. ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
  344. ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
  345. ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
  346. /* ATAPI command types */
  347. ATAPI_READ = 0, /* READs */
  348. ATAPI_WRITE = 1, /* WRITEs */
  349. ATAPI_READ_CD = 2, /* READ CD [MSF] */
  350. ATAPI_PASS_THRU = 3, /* SAT pass-thru */
  351. ATAPI_MISC = 4, /* the rest */
  352. /* Timing constants */
  353. ATA_TIMING_SETUP = (1 << 0),
  354. ATA_TIMING_ACT8B = (1 << 1),
  355. ATA_TIMING_REC8B = (1 << 2),
  356. ATA_TIMING_CYC8B = (1 << 3),
  357. ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
  358. ATA_TIMING_CYC8B,
  359. ATA_TIMING_ACTIVE = (1 << 4),
  360. ATA_TIMING_RECOVER = (1 << 5),
  361. ATA_TIMING_DMACK_HOLD = (1 << 6),
  362. ATA_TIMING_CYCLE = (1 << 7),
  363. ATA_TIMING_UDMA = (1 << 8),
  364. ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
  365. ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
  366. ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
  367. ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
  368. ATA_TIMING_UDMA,
  369. /* ACPI constants */
  370. ATA_ACPI_FILTER_SETXFER = 1 << 0,
  371. ATA_ACPI_FILTER_LOCK = 1 << 1,
  372. ATA_ACPI_FILTER_DIPM = 1 << 2,
  373. ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
  374. ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
  375. ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
  376. ATA_ACPI_FILTER_LOCK |
  377. ATA_ACPI_FILTER_DIPM,
  378. };
  379. enum ata_xfer_mask {
  380. ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
  381. << ATA_SHIFT_PIO,
  382. ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
  383. << ATA_SHIFT_MWDMA,
  384. ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
  385. << ATA_SHIFT_UDMA,
  386. };
  387. enum hsm_task_states {
  388. HSM_ST_IDLE, /* no command on going */
  389. HSM_ST_FIRST, /* (waiting the device to)
  390. write CDB or first data block */
  391. HSM_ST, /* (waiting the device to) transfer data */
  392. HSM_ST_LAST, /* (waiting the device to) complete command */
  393. HSM_ST_ERR, /* error */
  394. };
  395. enum ata_completion_errors {
  396. AC_ERR_DEV = (1 << 0), /* device reported error */
  397. AC_ERR_HSM = (1 << 1), /* host state machine violation */
  398. AC_ERR_TIMEOUT = (1 << 2), /* timeout */
  399. AC_ERR_MEDIA = (1 << 3), /* media error */
  400. AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
  401. AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
  402. AC_ERR_SYSTEM = (1 << 6), /* system error */
  403. AC_ERR_INVALID = (1 << 7), /* invalid argument */
  404. AC_ERR_OTHER = (1 << 8), /* unknown */
  405. AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
  406. AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
  407. };
  408. /*
  409. * Link power management policy: If you alter this, you also need to
  410. * alter libata-scsi.c (for the ascii descriptions)
  411. */
  412. enum ata_lpm_policy {
  413. ATA_LPM_UNKNOWN,
  414. ATA_LPM_MAX_POWER,
  415. ATA_LPM_MED_POWER,
  416. ATA_LPM_MIN_POWER,
  417. };
  418. enum ata_lpm_hints {
  419. ATA_LPM_EMPTY = (1 << 0), /* port empty/probing */
  420. ATA_LPM_HIPM = (1 << 1), /* may use HIPM */
  421. };
  422. /* forward declarations */
  423. struct scsi_device;
  424. struct ata_port_operations;
  425. struct ata_port;
  426. struct ata_link;
  427. struct ata_queued_cmd;
  428. /* typedefs */
  429. typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
  430. typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
  431. typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
  432. unsigned long deadline);
  433. typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
  434. extern struct device_attribute dev_attr_link_power_management_policy;
  435. extern struct device_attribute dev_attr_unload_heads;
  436. extern struct device_attribute dev_attr_em_message_type;
  437. extern struct device_attribute dev_attr_em_message;
  438. extern struct device_attribute dev_attr_sw_activity;
  439. enum sw_activity {
  440. OFF,
  441. BLINK_ON,
  442. BLINK_OFF,
  443. };
  444. #ifdef CONFIG_ATA_SFF
  445. struct ata_ioports {
  446. void __iomem *cmd_addr;
  447. void __iomem *data_addr;
  448. void __iomem *error_addr;
  449. void __iomem *feature_addr;
  450. void __iomem *nsect_addr;
  451. void __iomem *lbal_addr;
  452. void __iomem *lbam_addr;
  453. void __iomem *lbah_addr;
  454. void __iomem *device_addr;
  455. void __iomem *status_addr;
  456. void __iomem *command_addr;
  457. void __iomem *altstatus_addr;
  458. void __iomem *ctl_addr;
  459. #ifdef CONFIG_ATA_BMDMA
  460. void __iomem *bmdma_addr;
  461. #endif /* CONFIG_ATA_BMDMA */
  462. void __iomem *scr_addr;
  463. };
  464. #endif /* CONFIG_ATA_SFF */
  465. struct ata_host {
  466. spinlock_t lock;
  467. struct device *dev;
  468. void __iomem * const *iomap;
  469. unsigned int n_ports;
  470. void *private_data;
  471. struct ata_port_operations *ops;
  472. unsigned long flags;
  473. struct mutex eh_mutex;
  474. struct task_struct *eh_owner;
  475. struct ata_port *simplex_claimed; /* channel owning the DMA */
  476. struct ata_port *ports[0];
  477. };
  478. struct ata_queued_cmd {
  479. struct ata_port *ap;
  480. struct ata_device *dev;
  481. struct scsi_cmnd *scsicmd;
  482. void (*scsidone)(struct scsi_cmnd *);
  483. struct ata_taskfile tf;
  484. u8 cdb[ATAPI_CDB_LEN];
  485. unsigned long flags; /* ATA_QCFLAG_xxx */
  486. unsigned int tag;
  487. unsigned int n_elem;
  488. unsigned int orig_n_elem;
  489. int dma_dir;
  490. unsigned int sect_size;
  491. unsigned int nbytes;
  492. unsigned int extrabytes;
  493. unsigned int curbytes;
  494. struct scatterlist sgent;
  495. struct scatterlist *sg;
  496. struct scatterlist *cursg;
  497. unsigned int cursg_ofs;
  498. unsigned int err_mask;
  499. struct ata_taskfile result_tf;
  500. ata_qc_cb_t complete_fn;
  501. void *private_data;
  502. void *lldd_task;
  503. };
  504. struct ata_port_stats {
  505. unsigned long unhandled_irq;
  506. unsigned long idle_irq;
  507. unsigned long rw_reqbuf;
  508. };
  509. struct ata_ering_entry {
  510. unsigned int eflags;
  511. unsigned int err_mask;
  512. u64 timestamp;
  513. };
  514. struct ata_ering {
  515. int cursor;
  516. struct ata_ering_entry ring[ATA_ERING_SIZE];
  517. };
  518. struct ata_device {
  519. struct ata_link *link;
  520. unsigned int devno; /* 0 or 1 */
  521. unsigned int horkage; /* List of broken features */
  522. unsigned long flags; /* ATA_DFLAG_xxx */
  523. struct scsi_device *sdev; /* attached SCSI device */
  524. void *private_data;
  525. #ifdef CONFIG_ATA_ACPI
  526. union acpi_object *gtf_cache;
  527. unsigned int gtf_filter;
  528. #endif
  529. struct device tdev;
  530. /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
  531. u64 n_sectors; /* size of device, if ATA */
  532. u64 n_native_sectors; /* native size, if ATA */
  533. unsigned int class; /* ATA_DEV_xxx */
  534. unsigned long unpark_deadline;
  535. u8 pio_mode;
  536. u8 dma_mode;
  537. u8 xfer_mode;
  538. unsigned int xfer_shift; /* ATA_SHIFT_xxx */
  539. unsigned int multi_count; /* sectors count for
  540. READ/WRITE MULTIPLE */
  541. unsigned int max_sectors; /* per-device max sectors */
  542. unsigned int cdb_len;
  543. /* per-dev xfer mask */
  544. unsigned long pio_mask;
  545. unsigned long mwdma_mask;
  546. unsigned long udma_mask;
  547. /* for CHS addressing */
  548. u16 cylinders; /* Number of cylinders */
  549. u16 heads; /* Number of heads */
  550. u16 sectors; /* Number of sectors per track */
  551. union {
  552. u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
  553. u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
  554. };
  555. /* error history */
  556. int spdn_cnt;
  557. /* ering is CLEAR_END, read comment above CLEAR_END */
  558. struct ata_ering ering;
  559. };
  560. /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
  561. * cleared to zero on ata_dev_init().
  562. */
  563. #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
  564. #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
  565. struct ata_eh_info {
  566. struct ata_device *dev; /* offending device */
  567. u32 serror; /* SError from LLDD */
  568. unsigned int err_mask; /* port-wide err_mask */
  569. unsigned int action; /* ATA_EH_* action mask */
  570. unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
  571. unsigned int flags; /* ATA_EHI_* flags */
  572. unsigned int probe_mask;
  573. char desc[ATA_EH_DESC_LEN];
  574. int desc_len;
  575. };
  576. struct ata_eh_context {
  577. struct ata_eh_info i;
  578. int tries[ATA_MAX_DEVICES];
  579. int cmd_timeout_idx[ATA_MAX_DEVICES]
  580. [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
  581. unsigned int classes[ATA_MAX_DEVICES];
  582. unsigned int did_probe_mask;
  583. unsigned int unloaded_mask;
  584. unsigned int saved_ncq_enabled;
  585. u8 saved_xfer_mode[ATA_MAX_DEVICES];
  586. /* timestamp for the last reset attempt or success */
  587. unsigned long last_reset;
  588. };
  589. struct ata_acpi_drive
  590. {
  591. u32 pio;
  592. u32 dma;
  593. } __packed;
  594. struct ata_acpi_gtm {
  595. struct ata_acpi_drive drive[2];
  596. u32 flags;
  597. } __packed;
  598. struct ata_link {
  599. struct ata_port *ap;
  600. int pmp; /* port multiplier port # */
  601. struct device tdev;
  602. unsigned int active_tag; /* active tag on this link */
  603. u32 sactive; /* active NCQ commands */
  604. unsigned int flags; /* ATA_LFLAG_xxx */
  605. u32 saved_scontrol; /* SControl on probe */
  606. unsigned int hw_sata_spd_limit;
  607. unsigned int sata_spd_limit;
  608. unsigned int sata_spd; /* current SATA PHY speed */
  609. enum ata_lpm_policy lpm_policy;
  610. /* record runtime error info, protected by host_set lock */
  611. struct ata_eh_info eh_info;
  612. /* EH context */
  613. struct ata_eh_context eh_context;
  614. struct ata_device device[ATA_MAX_DEVICES];
  615. };
  616. #define ATA_LINK_CLEAR_BEGIN offsetof(struct ata_link, active_tag)
  617. #define ATA_LINK_CLEAR_END offsetof(struct ata_link, device[0])
  618. struct ata_port {
  619. struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
  620. struct ata_port_operations *ops;
  621. spinlock_t *lock;
  622. /* Flags owned by the EH context. Only EH should touch these once the
  623. port is active */
  624. unsigned long flags; /* ATA_FLAG_xxx */
  625. /* Flags that change dynamically, protected by ap->lock */
  626. unsigned int pflags; /* ATA_PFLAG_xxx */
  627. unsigned int print_id; /* user visible unique port ID */
  628. unsigned int port_no; /* 0 based port no. inside the host */
  629. #ifdef CONFIG_ATA_SFF
  630. struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
  631. u8 ctl; /* cache of ATA control register */
  632. u8 last_ctl; /* Cache last written value */
  633. struct ata_link* sff_pio_task_link; /* link currently used */
  634. struct delayed_work sff_pio_task;
  635. #ifdef CONFIG_ATA_BMDMA
  636. struct ata_bmdma_prd *bmdma_prd; /* BMDMA SG list */
  637. dma_addr_t bmdma_prd_dma; /* and its DMA mapping */
  638. #endif /* CONFIG_ATA_BMDMA */
  639. #endif /* CONFIG_ATA_SFF */
  640. unsigned int pio_mask;
  641. unsigned int mwdma_mask;
  642. unsigned int udma_mask;
  643. unsigned int cbl; /* cable type; ATA_CBL_xxx */
  644. struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
  645. unsigned long qc_allocated;
  646. unsigned int qc_active;
  647. int nr_active_links; /* #links with active qcs */
  648. struct ata_link link; /* host default link */
  649. struct ata_link *slave_link; /* see ata_slave_link_init() */
  650. int nr_pmp_links; /* nr of available PMP links */
  651. struct ata_link *pmp_link; /* array of PMP links */
  652. struct ata_link *excl_link; /* for PMP qc exclusion */
  653. struct ata_port_stats stats;
  654. struct ata_host *host;
  655. struct device *dev;
  656. struct device tdev;
  657. struct mutex scsi_scan_mutex;
  658. struct delayed_work hotplug_task;
  659. struct work_struct scsi_rescan_task;
  660. unsigned int hsm_task_state;
  661. u32 msg_enable;
  662. struct list_head eh_done_q;
  663. wait_queue_head_t eh_wait_q;
  664. int eh_tries;
  665. struct completion park_req_pending;
  666. pm_message_t pm_mesg;
  667. int *pm_result;
  668. enum ata_lpm_policy target_lpm_policy;
  669. struct timer_list fastdrain_timer;
  670. unsigned long fastdrain_cnt;
  671. int em_message_type;
  672. void *private_data;
  673. #ifdef CONFIG_ATA_ACPI
  674. struct ata_acpi_gtm __acpi_init_gtm; /* use ata_acpi_init_gtm() */
  675. #endif
  676. /* owned by EH */
  677. u8 sector_buf[ATA_SECT_SIZE] ____cacheline_aligned;
  678. };
  679. /* The following initializer overrides a method to NULL whether one of
  680. * its parent has the method defined or not. This is equivalent to
  681. * ERR_PTR(-ENOENT). Unfortunately, ERR_PTR doesn't render a constant
  682. * expression and thus can't be used as an initializer.
  683. */
  684. #define ATA_OP_NULL (void *)(unsigned long)(-ENOENT)
  685. struct ata_port_operations {
  686. /*
  687. * Command execution
  688. */
  689. int (*qc_defer)(struct ata_queued_cmd *qc);
  690. int (*check_atapi_dma)(struct ata_queued_cmd *qc);
  691. void (*qc_prep)(struct ata_queued_cmd *qc);
  692. unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
  693. bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
  694. /*
  695. * Configuration and exception handling
  696. */
  697. int (*cable_detect)(struct ata_port *ap);
  698. unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
  699. void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
  700. void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
  701. int (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
  702. unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
  703. void (*dev_config)(struct ata_device *dev);
  704. void (*freeze)(struct ata_port *ap);
  705. void (*thaw)(struct ata_port *ap);
  706. ata_prereset_fn_t prereset;
  707. ata_reset_fn_t softreset;
  708. ata_reset_fn_t hardreset;
  709. ata_postreset_fn_t postreset;
  710. ata_prereset_fn_t pmp_prereset;
  711. ata_reset_fn_t pmp_softreset;
  712. ata_reset_fn_t pmp_hardreset;
  713. ata_postreset_fn_t pmp_postreset;
  714. void (*error_handler)(struct ata_port *ap);
  715. void (*lost_interrupt)(struct ata_port *ap);
  716. void (*post_internal_cmd)(struct ata_queued_cmd *qc);
  717. void (*sched_eh)(struct ata_port *ap);
  718. void (*end_eh)(struct ata_port *ap);
  719. /*
  720. * Optional features
  721. */
  722. int (*scr_read)(struct ata_link *link, unsigned int sc_reg, u32 *val);
  723. int (*scr_write)(struct ata_link *link, unsigned int sc_reg, u32 val);
  724. void (*pmp_attach)(struct ata_port *ap);
  725. void (*pmp_detach)(struct ata_port *ap);
  726. int (*set_lpm)(struct ata_link *link, enum ata_lpm_policy policy,
  727. unsigned hints);
  728. /*
  729. * Start, stop, suspend and resume
  730. */
  731. int (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
  732. int (*port_resume)(struct ata_port *ap);
  733. int (*port_start)(struct ata_port *ap);
  734. void (*port_stop)(struct ata_port *ap);
  735. void (*host_stop)(struct ata_host *host);
  736. #ifdef CONFIG_ATA_SFF
  737. /*
  738. * SFF / taskfile oriented ops
  739. */
  740. void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
  741. void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
  742. u8 (*sff_check_status)(struct ata_port *ap);
  743. u8 (*sff_check_altstatus)(struct ata_port *ap);
  744. void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
  745. void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
  746. void (*sff_exec_command)(struct ata_port *ap,
  747. const struct ata_taskfile *tf);
  748. unsigned int (*sff_data_xfer)(struct ata_device *dev,
  749. unsigned char *buf, unsigned int buflen, int rw);
  750. void (*sff_irq_on)(struct ata_port *);
  751. bool (*sff_irq_check)(struct ata_port *);
  752. void (*sff_irq_clear)(struct ata_port *);
  753. void (*sff_drain_fifo)(struct ata_queued_cmd *qc);
  754. #ifdef CONFIG_ATA_BMDMA
  755. void (*bmdma_setup)(struct ata_queued_cmd *qc);
  756. void (*bmdma_start)(struct ata_queued_cmd *qc);
  757. void (*bmdma_stop)(struct ata_queued_cmd *qc);
  758. u8 (*bmdma_status)(struct ata_port *ap);
  759. #endif /* CONFIG_ATA_BMDMA */
  760. #endif /* CONFIG_ATA_SFF */
  761. ssize_t (*em_show)(struct ata_port *ap, char *buf);
  762. ssize_t (*em_store)(struct ata_port *ap, const char *message,
  763. size_t size);
  764. ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
  765. ssize_t (*sw_activity_store)(struct ata_device *dev,
  766. enum sw_activity val);
  767. /*
  768. * Obsolete
  769. */
  770. void (*phy_reset)(struct ata_port *ap);
  771. void (*eng_timeout)(struct ata_port *ap);
  772. /*
  773. * ->inherits must be the last field and all the preceding
  774. * fields must be pointers.
  775. */
  776. const struct ata_port_operations *inherits;
  777. };
  778. struct ata_port_info {
  779. unsigned long flags;
  780. unsigned long link_flags;
  781. unsigned long pio_mask;
  782. unsigned long mwdma_mask;
  783. unsigned long udma_mask;
  784. struct ata_port_operations *port_ops;
  785. void *private_data;
  786. };
  787. struct ata_timing {
  788. unsigned short mode; /* ATA mode */
  789. unsigned short setup; /* t1 */
  790. unsigned short act8b; /* t2 for 8-bit I/O */
  791. unsigned short rec8b; /* t2i for 8-bit I/O */
  792. unsigned short cyc8b; /* t0 for 8-bit I/O */
  793. unsigned short active; /* t2 or tD */
  794. unsigned short recover; /* t2i or tK */
  795. unsigned short dmack_hold; /* tj */
  796. unsigned short cycle; /* t0 */
  797. unsigned short udma; /* t2CYCTYP/2 */
  798. };
  799. /*
  800. * Core layer - drivers/ata/libata-core.c
  801. */
  802. extern const unsigned long sata_deb_timing_normal[];
  803. extern const unsigned long sata_deb_timing_hotplug[];
  804. extern const unsigned long sata_deb_timing_long[];
  805. extern struct ata_port_operations ata_dummy_port_ops;
  806. extern const struct ata_port_info ata_dummy_port_info;
  807. static inline const unsigned long *
  808. sata_ehc_deb_timing(struct ata_eh_context *ehc)
  809. {
  810. if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
  811. return sata_deb_timing_hotplug;
  812. else
  813. return sata_deb_timing_normal;
  814. }
  815. static inline int ata_port_is_dummy(struct ata_port *ap)
  816. {
  817. return ap->ops == &ata_dummy_port_ops;
  818. }
  819. extern int sata_set_spd(struct ata_link *link);
  820. extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
  821. extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
  822. int (*check_ready)(struct ata_link *link));
  823. extern int sata_link_debounce(struct ata_link *link,
  824. const unsigned long *params, unsigned long deadline);
  825. extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
  826. unsigned long deadline);
  827. extern int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
  828. bool spm_wakeup);
  829. extern int sata_link_hardreset(struct ata_link *link,
  830. const unsigned long *timing, unsigned long deadline,
  831. bool *online, int (*check_ready)(struct ata_link *));
  832. extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
  833. unsigned long deadline);
  834. extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
  835. extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
  836. extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
  837. const struct ata_port_info * const * ppi, int n_ports);
  838. extern int ata_slave_link_init(struct ata_port *ap);
  839. extern int ata_host_start(struct ata_host *host);
  840. extern int ata_host_register(struct ata_host *host,
  841. struct scsi_host_template *sht);
  842. extern int ata_host_activate(struct ata_host *host, int irq,
  843. irq_handler_t irq_handler, unsigned long irq_flags,
  844. struct scsi_host_template *sht);
  845. extern void ata_host_detach(struct ata_host *host);
  846. extern void ata_host_init(struct ata_host *, struct device *,
  847. unsigned long, struct ata_port_operations *);
  848. extern int ata_scsi_detect(struct scsi_host_template *sht);
  849. extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
  850. extern int ata_scsi_queuecmd(struct Scsi_Host *h, struct scsi_cmnd *cmd);
  851. extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
  852. int cmd, void __user *arg);
  853. extern void ata_sas_port_destroy(struct ata_port *);
  854. extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
  855. struct ata_port_info *, struct Scsi_Host *);
  856. extern void ata_sas_async_probe(struct ata_port *ap);
  857. extern int ata_sas_sync_probe(struct ata_port *ap);
  858. extern int ata_sas_port_init(struct ata_port *);
  859. extern int ata_sas_port_start(struct ata_port *ap);
  860. extern void ata_sas_port_stop(struct ata_port *ap);
  861. extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
  862. extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap);
  863. extern int sata_scr_valid(struct ata_link *link);
  864. extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
  865. extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
  866. extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
  867. extern bool ata_link_online(struct ata_link *link);
  868. extern bool ata_link_offline(struct ata_link *link);
  869. #ifdef CONFIG_PM
  870. extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
  871. extern void ata_host_resume(struct ata_host *host);
  872. extern int ata_sas_port_async_suspend(struct ata_port *ap, int *async);
  873. extern int ata_sas_port_async_resume(struct ata_port *ap, int *async);
  874. #else
  875. static inline int ata_sas_port_async_suspend(struct ata_port *ap, int *async)
  876. {
  877. return 0;
  878. }
  879. static inline int ata_sas_port_async_resume(struct ata_port *ap, int *async)
  880. {
  881. return 0;
  882. }
  883. #endif
  884. extern int ata_ratelimit(void);
  885. extern void ata_msleep(struct ata_port *ap, unsigned int msecs);
  886. extern u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask,
  887. u32 val, unsigned long interval, unsigned long timeout);
  888. extern int atapi_cmd_type(u8 opcode);
  889. extern void ata_tf_to_fis(const struct ata_taskfile *tf,
  890. u8 pmp, int is_cmd, u8 *fis);
  891. extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
  892. extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
  893. unsigned long mwdma_mask, unsigned long udma_mask);
  894. extern void ata_unpack_xfermask(unsigned long xfer_mask,
  895. unsigned long *pio_mask, unsigned long *mwdma_mask,
  896. unsigned long *udma_mask);
  897. extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
  898. extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
  899. extern int ata_xfer_mode2shift(unsigned long xfer_mode);
  900. extern const char *ata_mode_string(unsigned long xfer_mask);
  901. extern unsigned long ata_id_xfermask(const u16 *id);
  902. extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
  903. extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
  904. extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
  905. unsigned int n_elem);
  906. extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
  907. extern void ata_dev_disable(struct ata_device *adev);
  908. extern void ata_id_string(const u16 *id, unsigned char *s,
  909. unsigned int ofs, unsigned int len);
  910. extern void ata_id_c_string(const u16 *id, unsigned char *s,
  911. unsigned int ofs, unsigned int len);
  912. extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
  913. struct ata_taskfile *tf, u16 *id);
  914. extern void ata_qc_complete(struct ata_queued_cmd *qc);
  915. extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
  916. extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd);
  917. extern int ata_std_bios_param(struct scsi_device *sdev,
  918. struct block_device *bdev,
  919. sector_t capacity, int geom[]);
  920. extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
  921. extern int ata_scsi_slave_config(struct scsi_device *sdev);
  922. extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
  923. extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
  924. int queue_depth, int reason);
  925. extern int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
  926. int queue_depth, int reason);
  927. extern struct ata_device *ata_dev_pair(struct ata_device *adev);
  928. extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
  929. extern void ata_scsi_port_error_handler(struct Scsi_Host *host, struct ata_port *ap);
  930. extern void ata_scsi_cmd_error_handler(struct Scsi_Host *host, struct ata_port *ap, struct list_head *eh_q);
  931. extern int ata_cable_40wire(struct ata_port *ap);
  932. extern int ata_cable_80wire(struct ata_port *ap);
  933. extern int ata_cable_sata(struct ata_port *ap);
  934. extern int ata_cable_ignore(struct ata_port *ap);
  935. extern int ata_cable_unknown(struct ata_port *ap);
  936. /* Timing helpers */
  937. extern unsigned int ata_pio_need_iordy(const struct ata_device *);
  938. extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
  939. extern int ata_timing_compute(struct ata_device *, unsigned short,
  940. struct ata_timing *, int, int);
  941. extern void ata_timing_merge(const struct ata_timing *,
  942. const struct ata_timing *, struct ata_timing *,
  943. unsigned int);
  944. extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
  945. /* PCI */
  946. #ifdef CONFIG_PCI
  947. struct pci_dev;
  948. struct pci_bits {
  949. unsigned int reg; /* PCI config register to read */
  950. unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
  951. unsigned long mask;
  952. unsigned long val;
  953. };
  954. extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
  955. extern void ata_pci_remove_one(struct pci_dev *pdev);
  956. #ifdef CONFIG_PM
  957. extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
  958. extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
  959. extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
  960. extern int ata_pci_device_resume(struct pci_dev *pdev);
  961. #endif /* CONFIG_PM */
  962. #endif /* CONFIG_PCI */
  963. /*
  964. * ACPI - drivers/ata/libata-acpi.c
  965. */
  966. #ifdef CONFIG_ATA_ACPI
  967. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  968. {
  969. if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
  970. return &ap->__acpi_init_gtm;
  971. return NULL;
  972. }
  973. int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
  974. int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
  975. unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
  976. const struct ata_acpi_gtm *gtm);
  977. acpi_handle ata_ap_acpi_handle(struct ata_port *ap);
  978. acpi_handle ata_dev_acpi_handle(struct ata_device *dev);
  979. int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
  980. #else
  981. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  982. {
  983. return NULL;
  984. }
  985. static inline int ata_acpi_stm(const struct ata_port *ap,
  986. struct ata_acpi_gtm *stm)
  987. {
  988. return -ENOSYS;
  989. }
  990. static inline int ata_acpi_gtm(const struct ata_port *ap,
  991. struct ata_acpi_gtm *stm)
  992. {
  993. return -ENOSYS;
  994. }
  995. static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
  996. const struct ata_acpi_gtm *gtm)
  997. {
  998. return 0;
  999. }
  1000. static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
  1001. const struct ata_acpi_gtm *gtm)
  1002. {
  1003. return 0;
  1004. }
  1005. #endif
  1006. /*
  1007. * EH - drivers/ata/libata-eh.c
  1008. */
  1009. extern void ata_port_schedule_eh(struct ata_port *ap);
  1010. extern void ata_port_wait_eh(struct ata_port *ap);
  1011. extern int ata_link_abort(struct ata_link *link);
  1012. extern int ata_port_abort(struct ata_port *ap);
  1013. extern int ata_port_freeze(struct ata_port *ap);
  1014. extern int sata_async_notification(struct ata_port *ap);
  1015. extern void ata_eh_freeze_port(struct ata_port *ap);
  1016. extern void ata_eh_thaw_port(struct ata_port *ap);
  1017. extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
  1018. extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
  1019. extern void ata_eh_analyze_ncq_error(struct ata_link *link);
  1020. extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  1021. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  1022. ata_postreset_fn_t postreset);
  1023. extern void ata_std_error_handler(struct ata_port *ap);
  1024. extern void ata_std_sched_eh(struct ata_port *ap);
  1025. extern void ata_std_end_eh(struct ata_port *ap);
  1026. extern int ata_link_nr_enabled(struct ata_link *link);
  1027. /*
  1028. * Base operations to inherit from and initializers for sht
  1029. *
  1030. * Operations
  1031. *
  1032. * base : Common to all libata drivers.
  1033. * sata : SATA controllers w/ native interface.
  1034. * pmp : SATA controllers w/ PMP support.
  1035. * sff : SFF ATA controllers w/o BMDMA support.
  1036. * bmdma : SFF ATA controllers w/ BMDMA support.
  1037. *
  1038. * sht initializers
  1039. *
  1040. * BASE : Common to all libata drivers. The user must set
  1041. * sg_tablesize and dma_boundary.
  1042. * PIO : SFF ATA controllers w/ only PIO support.
  1043. * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
  1044. * dma_boundary are set to BMDMA limits.
  1045. * NCQ : SATA controllers supporting NCQ. The user must set
  1046. * sg_tablesize, dma_boundary and can_queue.
  1047. */
  1048. extern const struct ata_port_operations ata_base_port_ops;
  1049. extern const struct ata_port_operations sata_port_ops;
  1050. extern struct device_attribute *ata_common_sdev_attrs[];
  1051. #define ATA_BASE_SHT(drv_name) \
  1052. .module = THIS_MODULE, \
  1053. .name = drv_name, \
  1054. .ioctl = ata_scsi_ioctl, \
  1055. .queuecommand = ata_scsi_queuecmd, \
  1056. .can_queue = ATA_DEF_QUEUE, \
  1057. .this_id = ATA_SHT_THIS_ID, \
  1058. .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
  1059. .emulated = ATA_SHT_EMULATED, \
  1060. .use_clustering = ATA_SHT_USE_CLUSTERING, \
  1061. .proc_name = drv_name, \
  1062. .slave_configure = ata_scsi_slave_config, \
  1063. .slave_destroy = ata_scsi_slave_destroy, \
  1064. .bios_param = ata_std_bios_param, \
  1065. .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
  1066. .sdev_attrs = ata_common_sdev_attrs
  1067. #define ATA_NCQ_SHT(drv_name) \
  1068. ATA_BASE_SHT(drv_name), \
  1069. .change_queue_depth = ata_scsi_change_queue_depth
  1070. /*
  1071. * PMP helpers
  1072. */
  1073. #ifdef CONFIG_SATA_PMP
  1074. static inline bool sata_pmp_supported(struct ata_port *ap)
  1075. {
  1076. return ap->flags & ATA_FLAG_PMP;
  1077. }
  1078. static inline bool sata_pmp_attached(struct ata_port *ap)
  1079. {
  1080. return ap->nr_pmp_links != 0;
  1081. }
  1082. static inline int ata_is_host_link(const struct ata_link *link)
  1083. {
  1084. return link == &link->ap->link || link == link->ap->slave_link;
  1085. }
  1086. #else /* CONFIG_SATA_PMP */
  1087. static inline bool sata_pmp_supported(struct ata_port *ap)
  1088. {
  1089. return false;
  1090. }
  1091. static inline bool sata_pmp_attached(struct ata_port *ap)
  1092. {
  1093. return false;
  1094. }
  1095. static inline int ata_is_host_link(const struct ata_link *link)
  1096. {
  1097. return 1;
  1098. }
  1099. #endif /* CONFIG_SATA_PMP */
  1100. static inline int sata_srst_pmp(struct ata_link *link)
  1101. {
  1102. if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
  1103. return SATA_PMP_CTRL_PORT;
  1104. return link->pmp;
  1105. }
  1106. /*
  1107. * printk helpers
  1108. */
  1109. __printf(3, 4)
  1110. int ata_port_printk(const struct ata_port *ap, const char *level,
  1111. const char *fmt, ...);
  1112. __printf(3, 4)
  1113. int ata_link_printk(const struct ata_link *link, const char *level,
  1114. const char *fmt, ...);
  1115. __printf(3, 4)
  1116. int ata_dev_printk(const struct ata_device *dev, const char *level,
  1117. const char *fmt, ...);
  1118. #define ata_port_err(ap, fmt, ...) \
  1119. ata_port_printk(ap, KERN_ERR, fmt, ##__VA_ARGS__)
  1120. #define ata_port_warn(ap, fmt, ...) \
  1121. ata_port_printk(ap, KERN_WARNING, fmt, ##__VA_ARGS__)
  1122. #define ata_port_notice(ap, fmt, ...) \
  1123. ata_port_printk(ap, KERN_NOTICE, fmt, ##__VA_ARGS__)
  1124. #define ata_port_info(ap, fmt, ...) \
  1125. ata_port_printk(ap, KERN_INFO, fmt, ##__VA_ARGS__)
  1126. #define ata_port_dbg(ap, fmt, ...) \
  1127. ata_port_printk(ap, KERN_DEBUG, fmt, ##__VA_ARGS__)
  1128. #define ata_link_err(link, fmt, ...) \
  1129. ata_link_printk(link, KERN_ERR, fmt, ##__VA_ARGS__)
  1130. #define ata_link_warn(link, fmt, ...) \
  1131. ata_link_printk(link, KERN_WARNING, fmt, ##__VA_ARGS__)
  1132. #define ata_link_notice(link, fmt, ...) \
  1133. ata_link_printk(link, KERN_NOTICE, fmt, ##__VA_ARGS__)
  1134. #define ata_link_info(link, fmt, ...) \
  1135. ata_link_printk(link, KERN_INFO, fmt, ##__VA_ARGS__)
  1136. #define ata_link_dbg(link, fmt, ...) \
  1137. ata_link_printk(link, KERN_DEBUG, fmt, ##__VA_ARGS__)
  1138. #define ata_dev_err(dev, fmt, ...) \
  1139. ata_dev_printk(dev, KERN_ERR, fmt, ##__VA_ARGS__)
  1140. #define ata_dev_warn(dev, fmt, ...) \
  1141. ata_dev_printk(dev, KERN_WARNING, fmt, ##__VA_ARGS__)
  1142. #define ata_dev_notice(dev, fmt, ...) \
  1143. ata_dev_printk(dev, KERN_NOTICE, fmt, ##__VA_ARGS__)
  1144. #define ata_dev_info(dev, fmt, ...) \
  1145. ata_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
  1146. #define ata_dev_dbg(dev, fmt, ...) \
  1147. ata_dev_printk(dev, KERN_DEBUG, fmt, ##__VA_ARGS__)
  1148. void ata_print_version(const struct device *dev, const char *version);
  1149. /*
  1150. * ata_eh_info helpers
  1151. */
  1152. extern __printf(2, 3)
  1153. void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
  1154. extern __printf(2, 3)
  1155. void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...);
  1156. extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
  1157. static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
  1158. {
  1159. ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
  1160. ehi->flags |= ATA_EHI_HOTPLUGGED;
  1161. ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
  1162. ehi->err_mask |= AC_ERR_ATA_BUS;
  1163. }
  1164. /*
  1165. * port description helpers
  1166. */
  1167. extern __printf(2, 3)
  1168. void ata_port_desc(struct ata_port *ap, const char *fmt, ...);
  1169. #ifdef CONFIG_PCI
  1170. extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
  1171. const char *name);
  1172. #endif
  1173. static inline unsigned int ata_tag_valid(unsigned int tag)
  1174. {
  1175. return (tag < ATA_MAX_QUEUE) ? 1 : 0;
  1176. }
  1177. static inline unsigned int ata_tag_internal(unsigned int tag)
  1178. {
  1179. return tag == ATA_TAG_INTERNAL;
  1180. }
  1181. /*
  1182. * device helpers
  1183. */
  1184. static inline unsigned int ata_class_enabled(unsigned int class)
  1185. {
  1186. return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
  1187. class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
  1188. }
  1189. static inline unsigned int ata_class_disabled(unsigned int class)
  1190. {
  1191. return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
  1192. class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
  1193. }
  1194. static inline unsigned int ata_class_absent(unsigned int class)
  1195. {
  1196. return !ata_class_enabled(class) && !ata_class_disabled(class);
  1197. }
  1198. static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
  1199. {
  1200. return ata_class_enabled(dev->class);
  1201. }
  1202. static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
  1203. {
  1204. return ata_class_disabled(dev->class);
  1205. }
  1206. static inline unsigned int ata_dev_absent(const struct ata_device *dev)
  1207. {
  1208. return ata_class_absent(dev->class);
  1209. }
  1210. /*
  1211. * link helpers
  1212. */
  1213. static inline int ata_link_max_devices(const struct ata_link *link)
  1214. {
  1215. if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
  1216. return 2;
  1217. return 1;
  1218. }
  1219. static inline int ata_link_active(struct ata_link *link)
  1220. {
  1221. return ata_tag_valid(link->active_tag) || link->sactive;
  1222. }
  1223. /*
  1224. * Iterators
  1225. *
  1226. * ATA_LITER_* constants are used to select link iteration mode and
  1227. * ATA_DITER_* device iteration mode.
  1228. *
  1229. * For a custom iteration directly using ata_{link|dev}_next(), if
  1230. * @link or @dev, respectively, is NULL, the first element is
  1231. * returned. @dev and @link can be any valid device or link and the
  1232. * next element according to the iteration mode will be returned.
  1233. * After the last element, NULL is returned.
  1234. */
  1235. enum ata_link_iter_mode {
  1236. ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
  1237. * host link. no slave link */
  1238. ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
  1239. ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
  1240. * slave link still comes after host link */
  1241. };
  1242. enum ata_dev_iter_mode {
  1243. ATA_DITER_ENABLED,
  1244. ATA_DITER_ENABLED_REVERSE,
  1245. ATA_DITER_ALL,
  1246. ATA_DITER_ALL_REVERSE,
  1247. };
  1248. extern struct ata_link *ata_link_next(struct ata_link *link,
  1249. struct ata_port *ap,
  1250. enum ata_link_iter_mode mode);
  1251. extern struct ata_device *ata_dev_next(struct ata_device *dev,
  1252. struct ata_link *link,
  1253. enum ata_dev_iter_mode mode);
  1254. /*
  1255. * Shortcut notation for iterations
  1256. *
  1257. * ata_for_each_link() iterates over each link of @ap according to
  1258. * @mode. @link points to the current link in the loop. @link is
  1259. * NULL after loop termination. ata_for_each_dev() works the same way
  1260. * except that it iterates over each device of @link.
  1261. *
  1262. * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
  1263. * specified when using the following shorthand notations. Only the
  1264. * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
  1265. * specified. This not only increases brevity but also makes it
  1266. * impossible to use ATA_LITER_* for device iteration or vice-versa.
  1267. */
  1268. #define ata_for_each_link(link, ap, mode) \
  1269. for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
  1270. (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
  1271. #define ata_for_each_dev(dev, link, mode) \
  1272. for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
  1273. (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
  1274. /**
  1275. * ata_ncq_enabled - Test whether NCQ is enabled
  1276. * @dev: ATA device to test for
  1277. *
  1278. * LOCKING:
  1279. * spin_lock_irqsave(host lock)
  1280. *
  1281. * RETURNS:
  1282. * 1 if NCQ is enabled for @dev, 0 otherwise.
  1283. */
  1284. static inline int ata_ncq_enabled(struct ata_device *dev)
  1285. {
  1286. return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
  1287. ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
  1288. }
  1289. static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
  1290. {
  1291. qc->tf.ctl |= ATA_NIEN;
  1292. }
  1293. static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
  1294. unsigned int tag)
  1295. {
  1296. if (likely(ata_tag_valid(tag)))
  1297. return &ap->qcmd[tag];
  1298. return NULL;
  1299. }
  1300. static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
  1301. unsigned int tag)
  1302. {
  1303. struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
  1304. if (unlikely(!qc) || !ap->ops->error_handler)
  1305. return qc;
  1306. if ((qc->flags & (ATA_QCFLAG_ACTIVE |
  1307. ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
  1308. return qc;
  1309. return NULL;
  1310. }
  1311. static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
  1312. {
  1313. return qc->nbytes - min(qc->extrabytes, qc->nbytes);
  1314. }
  1315. static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
  1316. {
  1317. memset(tf, 0, sizeof(*tf));
  1318. #ifdef CONFIG_ATA_SFF
  1319. tf->ctl = dev->link->ap->ctl;
  1320. #else
  1321. tf->ctl = ATA_DEVCTL_OBS;
  1322. #endif
  1323. if (dev->devno == 0)
  1324. tf->device = ATA_DEVICE_OBS;
  1325. else
  1326. tf->device = ATA_DEVICE_OBS | ATA_DEV1;
  1327. }
  1328. static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
  1329. {
  1330. qc->dma_dir = DMA_NONE;
  1331. qc->sg = NULL;
  1332. qc->flags = 0;
  1333. qc->cursg = NULL;
  1334. qc->cursg_ofs = 0;
  1335. qc->nbytes = qc->extrabytes = qc->curbytes = 0;
  1336. qc->n_elem = 0;
  1337. qc->err_mask = 0;
  1338. qc->sect_size = ATA_SECT_SIZE;
  1339. ata_tf_init(qc->dev, &qc->tf);
  1340. /* init result_tf such that it indicates normal completion */
  1341. qc->result_tf.command = ATA_DRDY;
  1342. qc->result_tf.feature = 0;
  1343. }
  1344. static inline int ata_try_flush_cache(const struct ata_device *dev)
  1345. {
  1346. return ata_id_wcache_enabled(dev->id) ||
  1347. ata_id_has_flush(dev->id) ||
  1348. ata_id_has_flush_ext(dev->id);
  1349. }
  1350. static inline unsigned int ac_err_mask(u8 status)
  1351. {
  1352. if (status & (ATA_BUSY | ATA_DRQ))
  1353. return AC_ERR_HSM;
  1354. if (status & (ATA_ERR | ATA_DF))
  1355. return AC_ERR_DEV;
  1356. return 0;
  1357. }
  1358. static inline unsigned int __ac_err_mask(u8 status)
  1359. {
  1360. unsigned int mask = ac_err_mask(status);
  1361. if (mask == 0)
  1362. return AC_ERR_OTHER;
  1363. return mask;
  1364. }
  1365. static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
  1366. {
  1367. return *(struct ata_port **)&host->hostdata[0];
  1368. }
  1369. static inline int ata_check_ready(u8 status)
  1370. {
  1371. if (!(status & ATA_BUSY))
  1372. return 1;
  1373. /* 0xff indicates either no device or device not ready */
  1374. if (status == 0xff)
  1375. return -ENODEV;
  1376. return 0;
  1377. }
  1378. static inline unsigned long ata_deadline(unsigned long from_jiffies,
  1379. unsigned long timeout_msecs)
  1380. {
  1381. return from_jiffies + msecs_to_jiffies(timeout_msecs);
  1382. }
  1383. /* Don't open code these in drivers as there are traps. Firstly the range may
  1384. change in future hardware and specs, secondly 0xFF means 'no DMA' but is
  1385. > UDMA_0. Dyma ddreigiau */
  1386. static inline int ata_using_mwdma(struct ata_device *adev)
  1387. {
  1388. if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
  1389. return 1;
  1390. return 0;
  1391. }
  1392. static inline int ata_using_udma(struct ata_device *adev)
  1393. {
  1394. if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
  1395. return 1;
  1396. return 0;
  1397. }
  1398. static inline int ata_dma_enabled(struct ata_device *adev)
  1399. {
  1400. return (adev->dma_mode == 0xFF ? 0 : 1);
  1401. }
  1402. /**************************************************************************
  1403. * PMP - drivers/ata/libata-pmp.c
  1404. */
  1405. #ifdef CONFIG_SATA_PMP
  1406. extern const struct ata_port_operations sata_pmp_port_ops;
  1407. extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
  1408. extern void sata_pmp_error_handler(struct ata_port *ap);
  1409. #else /* CONFIG_SATA_PMP */
  1410. #define sata_pmp_port_ops sata_port_ops
  1411. #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
  1412. #define sata_pmp_error_handler ata_std_error_handler
  1413. #endif /* CONFIG_SATA_PMP */
  1414. /**************************************************************************
  1415. * SFF - drivers/ata/libata-sff.c
  1416. */
  1417. #ifdef CONFIG_ATA_SFF
  1418. extern const struct ata_port_operations ata_sff_port_ops;
  1419. extern const struct ata_port_operations ata_bmdma32_port_ops;
  1420. /* PIO only, sg_tablesize and dma_boundary limits can be removed */
  1421. #define ATA_PIO_SHT(drv_name) \
  1422. ATA_BASE_SHT(drv_name), \
  1423. .sg_tablesize = LIBATA_MAX_PRD, \
  1424. .dma_boundary = ATA_DMA_BOUNDARY
  1425. extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
  1426. extern u8 ata_sff_check_status(struct ata_port *ap);
  1427. extern void ata_sff_pause(struct ata_port *ap);
  1428. extern void ata_sff_dma_pause(struct ata_port *ap);
  1429. extern int ata_sff_busy_sleep(struct ata_port *ap,
  1430. unsigned long timeout_pat, unsigned long timeout);
  1431. extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
  1432. extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
  1433. extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
  1434. extern void ata_sff_exec_command(struct ata_port *ap,
  1435. const struct ata_taskfile *tf);
  1436. extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
  1437. unsigned char *buf, unsigned int buflen, int rw);
  1438. extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
  1439. unsigned char *buf, unsigned int buflen, int rw);
  1440. extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
  1441. unsigned char *buf, unsigned int buflen, int rw);
  1442. extern void ata_sff_irq_on(struct ata_port *ap);
  1443. extern void ata_sff_irq_clear(struct ata_port *ap);
  1444. extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
  1445. u8 status, int in_wq);
  1446. extern void ata_sff_queue_work(struct work_struct *work);
  1447. extern void ata_sff_queue_delayed_work(struct delayed_work *dwork,
  1448. unsigned long delay);
  1449. extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
  1450. extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
  1451. extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
  1452. extern unsigned int ata_sff_port_intr(struct ata_port *ap,
  1453. struct ata_queued_cmd *qc);
  1454. extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
  1455. extern void ata_sff_lost_interrupt(struct ata_port *ap);
  1456. extern void ata_sff_freeze(struct ata_port *ap);
  1457. extern void ata_sff_thaw(struct ata_port *ap);
  1458. extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
  1459. extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
  1460. u8 *r_err);
  1461. extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
  1462. unsigned long deadline);
  1463. extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
  1464. unsigned long deadline);
  1465. extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
  1466. unsigned long deadline);
  1467. extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
  1468. extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
  1469. extern void ata_sff_error_handler(struct ata_port *ap);
  1470. extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
  1471. #ifdef CONFIG_PCI
  1472. extern int ata_pci_sff_init_host(struct ata_host *host);
  1473. extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
  1474. const struct ata_port_info * const * ppi,
  1475. struct ata_host **r_host);
  1476. extern int ata_pci_sff_activate_host(struct ata_host *host,
  1477. irq_handler_t irq_handler,
  1478. struct scsi_host_template *sht);
  1479. extern int ata_pci_sff_init_one(struct pci_dev *pdev,
  1480. const struct ata_port_info * const * ppi,
  1481. struct scsi_host_template *sht, void *host_priv, int hflags);
  1482. #endif /* CONFIG_PCI */
  1483. #ifdef CONFIG_ATA_BMDMA
  1484. extern const struct ata_port_operations ata_bmdma_port_ops;
  1485. #define ATA_BMDMA_SHT(drv_name) \
  1486. ATA_BASE_SHT(drv_name), \
  1487. .sg_tablesize = LIBATA_MAX_PRD, \
  1488. .dma_boundary = ATA_DMA_BOUNDARY
  1489. extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
  1490. extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
  1491. extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
  1492. extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
  1493. struct ata_queued_cmd *qc);
  1494. extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
  1495. extern void ata_bmdma_error_handler(struct ata_port *ap);
  1496. extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
  1497. extern void ata_bmdma_irq_clear(struct ata_port *ap);
  1498. extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
  1499. extern void ata_bmdma_start(struct ata_queued_cmd *qc);
  1500. extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
  1501. extern u8 ata_bmdma_status(struct ata_port *ap);
  1502. extern int ata_bmdma_port_start(struct ata_port *ap);
  1503. extern int ata_bmdma_port_start32(struct ata_port *ap);
  1504. #ifdef CONFIG_PCI
  1505. extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
  1506. extern void ata_pci_bmdma_init(struct ata_host *host);
  1507. extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
  1508. const struct ata_port_info * const * ppi,
  1509. struct ata_host **r_host);
  1510. extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
  1511. const struct ata_port_info * const * ppi,
  1512. struct scsi_host_template *sht,
  1513. void *host_priv, int hflags);
  1514. #endif /* CONFIG_PCI */
  1515. #endif /* CONFIG_ATA_BMDMA */
  1516. /**
  1517. * ata_sff_busy_wait - Wait for a port status register
  1518. * @ap: Port to wait for.
  1519. * @bits: bits that must be clear
  1520. * @max: number of 10uS waits to perform
  1521. *
  1522. * Waits up to max*10 microseconds for the selected bits in the port's
  1523. * status register to be cleared.
  1524. * Returns final value of status register.
  1525. *
  1526. * LOCKING:
  1527. * Inherited from caller.
  1528. */
  1529. static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
  1530. unsigned int max)
  1531. {
  1532. u8 status;
  1533. do {
  1534. udelay(10);
  1535. status = ap->ops->sff_check_status(ap);
  1536. max--;
  1537. } while (status != 0xff && (status & bits) && (max > 0));
  1538. return status;
  1539. }
  1540. /**
  1541. * ata_wait_idle - Wait for a port to be idle.
  1542. * @ap: Port to wait for.
  1543. *
  1544. * Waits up to 10ms for port's BUSY and DRQ signals to clear.
  1545. * Returns final value of status register.
  1546. *
  1547. * LOCKING:
  1548. * Inherited from caller.
  1549. */
  1550. static inline u8 ata_wait_idle(struct ata_port *ap)
  1551. {
  1552. u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
  1553. #ifdef ATA_DEBUG
  1554. if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
  1555. ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
  1556. status);
  1557. #endif
  1558. return status;
  1559. }
  1560. #endif /* CONFIG_ATA_SFF */
  1561. #endif /* __LINUX_LIBATA_H__ */