libata.h 56 KB

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