libata.h 56 KB

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