libata.h 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728
  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_NO_RECOVERY = (1 << 4), /* no recovery */
  293. ATA_EHI_DID_SOFTRESET = (1 << 16), /* already soft-reset this port */
  294. ATA_EHI_DID_HARDRESET = (1 << 17), /* already soft-reset this port */
  295. ATA_EHI_PRINTINFO = (1 << 18), /* print configuration info */
  296. ATA_EHI_SETMODE = (1 << 19), /* configure transfer mode */
  297. ATA_EHI_POST_SETMODE = (1 << 20), /* revaildating after setmode */
  298. ATA_EHI_DID_RESET = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
  299. /* mask of flags to transfer *to* the slave link */
  300. ATA_EHI_TO_SLAVE_MASK = ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET,
  301. /* max tries if error condition is still set after ->error_handler */
  302. ATA_EH_MAX_TRIES = 5,
  303. /* sometimes resuming a link requires several retries */
  304. ATA_LINK_RESUME_TRIES = 5,
  305. /* how hard are we gonna try to probe/recover devices */
  306. ATA_PROBE_MAX_TRIES = 3,
  307. ATA_EH_DEV_TRIES = 3,
  308. ATA_EH_PMP_TRIES = 5,
  309. ATA_EH_PMP_LINK_TRIES = 3,
  310. SATA_PMP_RW_TIMEOUT = 3000, /* PMP read/write timeout */
  311. /* This should match the actual table size of
  312. * ata_eh_cmd_timeout_table in libata-eh.c.
  313. */
  314. ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 6,
  315. /* Horkage types. May be set by libata or controller on drives
  316. (some horkage may be drive/controller pair dependant */
  317. ATA_HORKAGE_DIAGNOSTIC = (1 << 0), /* Failed boot diag */
  318. ATA_HORKAGE_NODMA = (1 << 1), /* DMA problems */
  319. ATA_HORKAGE_NONCQ = (1 << 2), /* Don't use NCQ */
  320. ATA_HORKAGE_MAX_SEC_128 = (1 << 3), /* Limit max sects to 128 */
  321. ATA_HORKAGE_BROKEN_HPA = (1 << 4), /* Broken HPA */
  322. ATA_HORKAGE_DISABLE = (1 << 5), /* Disable it */
  323. ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
  324. ATA_HORKAGE_IPM = (1 << 7), /* Link PM problems */
  325. ATA_HORKAGE_IVB = (1 << 8), /* cbl det validity bit bugs */
  326. ATA_HORKAGE_STUCK_ERR = (1 << 9), /* stuck ERR on next PACKET */
  327. ATA_HORKAGE_BRIDGE_OK = (1 << 10), /* no bridge limits */
  328. ATA_HORKAGE_ATAPI_MOD16_DMA = (1 << 11), /* use ATAPI DMA for commands
  329. not multiple of 16 bytes */
  330. ATA_HORKAGE_FIRMWARE_WARN = (1 << 12), /* firmware update warning */
  331. ATA_HORKAGE_1_5_GBPS = (1 << 13), /* force 1.5 Gbps */
  332. ATA_HORKAGE_NOSETXFER = (1 << 14), /* skip SETXFER, SATA only */
  333. ATA_HORKAGE_BROKEN_FPDMA_AA = (1 << 15), /* skip AA */
  334. ATA_HORKAGE_DUMP_ID = (1 << 16), /* dump IDENTIFY data */
  335. /* DMA mask for user DMA control: User visible values; DO NOT
  336. renumber */
  337. ATA_DMA_MASK_ATA = (1 << 0), /* DMA on ATA Disk */
  338. ATA_DMA_MASK_ATAPI = (1 << 1), /* DMA on ATAPI */
  339. ATA_DMA_MASK_CFA = (1 << 2), /* DMA on CF Card */
  340. /* ATAPI command types */
  341. ATAPI_READ = 0, /* READs */
  342. ATAPI_WRITE = 1, /* WRITEs */
  343. ATAPI_READ_CD = 2, /* READ CD [MSF] */
  344. ATAPI_PASS_THRU = 3, /* SAT pass-thru */
  345. ATAPI_MISC = 4, /* the rest */
  346. /* Timing constants */
  347. ATA_TIMING_SETUP = (1 << 0),
  348. ATA_TIMING_ACT8B = (1 << 1),
  349. ATA_TIMING_REC8B = (1 << 2),
  350. ATA_TIMING_CYC8B = (1 << 3),
  351. ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
  352. ATA_TIMING_CYC8B,
  353. ATA_TIMING_ACTIVE = (1 << 4),
  354. ATA_TIMING_RECOVER = (1 << 5),
  355. ATA_TIMING_DMACK_HOLD = (1 << 6),
  356. ATA_TIMING_CYCLE = (1 << 7),
  357. ATA_TIMING_UDMA = (1 << 8),
  358. ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
  359. ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
  360. ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
  361. ATA_TIMING_DMACK_HOLD | ATA_TIMING_CYCLE |
  362. ATA_TIMING_UDMA,
  363. /* ACPI constants */
  364. ATA_ACPI_FILTER_SETXFER = 1 << 0,
  365. ATA_ACPI_FILTER_LOCK = 1 << 1,
  366. ATA_ACPI_FILTER_DIPM = 1 << 2,
  367. ATA_ACPI_FILTER_FPDMA_OFFSET = 1 << 3, /* FPDMA non-zero offset */
  368. ATA_ACPI_FILTER_FPDMA_AA = 1 << 4, /* FPDMA auto activate */
  369. ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
  370. ATA_ACPI_FILTER_LOCK |
  371. ATA_ACPI_FILTER_DIPM,
  372. };
  373. enum ata_xfer_mask {
  374. ATA_MASK_PIO = ((1LU << ATA_NR_PIO_MODES) - 1)
  375. << ATA_SHIFT_PIO,
  376. ATA_MASK_MWDMA = ((1LU << ATA_NR_MWDMA_MODES) - 1)
  377. << ATA_SHIFT_MWDMA,
  378. ATA_MASK_UDMA = ((1LU << ATA_NR_UDMA_MODES) - 1)
  379. << ATA_SHIFT_UDMA,
  380. };
  381. enum hsm_task_states {
  382. HSM_ST_IDLE, /* no command on going */
  383. HSM_ST_FIRST, /* (waiting the device to)
  384. write CDB or first data block */
  385. HSM_ST, /* (waiting the device to) transfer data */
  386. HSM_ST_LAST, /* (waiting the device to) complete command */
  387. HSM_ST_ERR, /* error */
  388. };
  389. enum ata_completion_errors {
  390. AC_ERR_DEV = (1 << 0), /* device reported error */
  391. AC_ERR_HSM = (1 << 1), /* host state machine violation */
  392. AC_ERR_TIMEOUT = (1 << 2), /* timeout */
  393. AC_ERR_MEDIA = (1 << 3), /* media error */
  394. AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
  395. AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
  396. AC_ERR_SYSTEM = (1 << 6), /* system error */
  397. AC_ERR_INVALID = (1 << 7), /* invalid argument */
  398. AC_ERR_OTHER = (1 << 8), /* unknown */
  399. AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
  400. AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
  401. };
  402. /* forward declarations */
  403. struct scsi_device;
  404. struct ata_port_operations;
  405. struct ata_port;
  406. struct ata_link;
  407. struct ata_queued_cmd;
  408. /* typedefs */
  409. typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
  410. typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
  411. typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
  412. unsigned long deadline);
  413. typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
  414. /*
  415. * host pm policy: If you alter this, you also need to alter libata-scsi.c
  416. * (for the ascii descriptions)
  417. */
  418. enum link_pm {
  419. NOT_AVAILABLE,
  420. MIN_POWER,
  421. MAX_PERFORMANCE,
  422. MEDIUM_POWER,
  423. };
  424. extern struct device_attribute dev_attr_link_power_management_policy;
  425. extern struct device_attribute dev_attr_unload_heads;
  426. extern struct device_attribute dev_attr_em_message_type;
  427. extern struct device_attribute dev_attr_em_message;
  428. extern struct device_attribute dev_attr_sw_activity;
  429. enum sw_activity {
  430. OFF,
  431. BLINK_ON,
  432. BLINK_OFF,
  433. };
  434. #ifdef CONFIG_ATA_SFF
  435. struct ata_ioports {
  436. void __iomem *cmd_addr;
  437. void __iomem *data_addr;
  438. void __iomem *error_addr;
  439. void __iomem *feature_addr;
  440. void __iomem *nsect_addr;
  441. void __iomem *lbal_addr;
  442. void __iomem *lbam_addr;
  443. void __iomem *lbah_addr;
  444. void __iomem *device_addr;
  445. void __iomem *status_addr;
  446. void __iomem *command_addr;
  447. void __iomem *altstatus_addr;
  448. void __iomem *ctl_addr;
  449. #ifdef CONFIG_ATA_BMDMA
  450. void __iomem *bmdma_addr;
  451. #endif /* CONFIG_ATA_BMDMA */
  452. void __iomem *scr_addr;
  453. };
  454. #endif /* CONFIG_ATA_SFF */
  455. struct ata_host {
  456. spinlock_t lock;
  457. struct device *dev;
  458. void __iomem * const *iomap;
  459. unsigned int n_ports;
  460. void *private_data;
  461. struct ata_port_operations *ops;
  462. unsigned long flags;
  463. #ifdef CONFIG_ATA_ACPI
  464. acpi_handle acpi_handle;
  465. #endif
  466. struct ata_port *simplex_claimed; /* channel owning the DMA */
  467. struct ata_port *ports[0];
  468. };
  469. struct ata_queued_cmd {
  470. struct ata_port *ap;
  471. struct ata_device *dev;
  472. struct scsi_cmnd *scsicmd;
  473. void (*scsidone)(struct scsi_cmnd *);
  474. struct ata_taskfile tf;
  475. u8 cdb[ATAPI_CDB_LEN];
  476. unsigned long flags; /* ATA_QCFLAG_xxx */
  477. unsigned int tag;
  478. unsigned int n_elem;
  479. unsigned int orig_n_elem;
  480. int dma_dir;
  481. unsigned int sect_size;
  482. unsigned int nbytes;
  483. unsigned int extrabytes;
  484. unsigned int curbytes;
  485. struct scatterlist *cursg;
  486. unsigned int cursg_ofs;
  487. struct scatterlist sgent;
  488. struct scatterlist *sg;
  489. unsigned int err_mask;
  490. struct ata_taskfile result_tf;
  491. ata_qc_cb_t complete_fn;
  492. void *private_data;
  493. void *lldd_task;
  494. };
  495. struct ata_port_stats {
  496. unsigned long unhandled_irq;
  497. unsigned long idle_irq;
  498. unsigned long rw_reqbuf;
  499. };
  500. struct ata_ering_entry {
  501. unsigned int eflags;
  502. unsigned int err_mask;
  503. u64 timestamp;
  504. };
  505. struct ata_ering {
  506. int cursor;
  507. struct ata_ering_entry ring[ATA_ERING_SIZE];
  508. };
  509. struct ata_device {
  510. struct ata_link *link;
  511. unsigned int devno; /* 0 or 1 */
  512. unsigned int horkage; /* List of broken features */
  513. unsigned long flags; /* ATA_DFLAG_xxx */
  514. struct scsi_device *sdev; /* attached SCSI device */
  515. void *private_data;
  516. #ifdef CONFIG_ATA_ACPI
  517. acpi_handle acpi_handle;
  518. union acpi_object *gtf_cache;
  519. unsigned int gtf_filter;
  520. #endif
  521. struct device tdev;
  522. /* n_sector is CLEAR_BEGIN, read comment above CLEAR_BEGIN */
  523. u64 n_sectors; /* size of device, if ATA */
  524. u64 n_native_sectors; /* native size, if ATA */
  525. unsigned int class; /* ATA_DEV_xxx */
  526. unsigned long unpark_deadline;
  527. u8 pio_mode;
  528. u8 dma_mode;
  529. u8 xfer_mode;
  530. unsigned int xfer_shift; /* ATA_SHIFT_xxx */
  531. unsigned int multi_count; /* sectors count for
  532. READ/WRITE MULTIPLE */
  533. unsigned int max_sectors; /* per-device max sectors */
  534. unsigned int cdb_len;
  535. /* per-dev xfer mask */
  536. unsigned long pio_mask;
  537. unsigned long mwdma_mask;
  538. unsigned long udma_mask;
  539. /* for CHS addressing */
  540. u16 cylinders; /* Number of cylinders */
  541. u16 heads; /* Number of heads */
  542. u16 sectors; /* Number of sectors per track */
  543. union {
  544. u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
  545. u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
  546. };
  547. /* error history */
  548. int spdn_cnt;
  549. /* ering is CLEAR_END, read comment above CLEAR_END */
  550. struct ata_ering ering;
  551. };
  552. /* Fields between ATA_DEVICE_CLEAR_BEGIN and ATA_DEVICE_CLEAR_END are
  553. * cleared to zero on ata_dev_init().
  554. */
  555. #define ATA_DEVICE_CLEAR_BEGIN offsetof(struct ata_device, n_sectors)
  556. #define ATA_DEVICE_CLEAR_END offsetof(struct ata_device, ering)
  557. struct ata_eh_info {
  558. struct ata_device *dev; /* offending device */
  559. u32 serror; /* SError from LLDD */
  560. unsigned int err_mask; /* port-wide err_mask */
  561. unsigned int action; /* ATA_EH_* action mask */
  562. unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
  563. unsigned int flags; /* ATA_EHI_* flags */
  564. unsigned int probe_mask;
  565. char desc[ATA_EH_DESC_LEN];
  566. int desc_len;
  567. };
  568. struct ata_eh_context {
  569. struct ata_eh_info i;
  570. int tries[ATA_MAX_DEVICES];
  571. int cmd_timeout_idx[ATA_MAX_DEVICES]
  572. [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
  573. unsigned int classes[ATA_MAX_DEVICES];
  574. unsigned int did_probe_mask;
  575. unsigned int unloaded_mask;
  576. unsigned int saved_ncq_enabled;
  577. u8 saved_xfer_mode[ATA_MAX_DEVICES];
  578. /* timestamp for the last reset attempt or success */
  579. unsigned long last_reset;
  580. };
  581. struct ata_acpi_drive
  582. {
  583. u32 pio;
  584. u32 dma;
  585. } __packed;
  586. struct ata_acpi_gtm {
  587. struct ata_acpi_drive drive[2];
  588. u32 flags;
  589. } __packed;
  590. struct ata_link {
  591. struct ata_port *ap;
  592. int pmp; /* port multiplier port # */
  593. struct device tdev;
  594. unsigned int active_tag; /* active tag on this link */
  595. u32 sactive; /* active NCQ commands */
  596. unsigned int flags; /* ATA_LFLAG_xxx */
  597. u32 saved_scontrol; /* SControl on probe */
  598. unsigned int hw_sata_spd_limit;
  599. unsigned int sata_spd_limit;
  600. unsigned int sata_spd; /* current SATA PHY speed */
  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 link_pm pm_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 (*enable_pm)(struct ata_port *ap, enum link_pm policy);
  717. void (*disable_pm)(struct ata_port *ap);
  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_hardreset(struct ata_link *link,
  818. const unsigned long *timing, unsigned long deadline,
  819. bool *online, int (*check_ready)(struct ata_link *));
  820. extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
  821. unsigned long deadline);
  822. extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
  823. extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
  824. extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
  825. const struct ata_port_info * const * ppi, int n_ports);
  826. extern int ata_slave_link_init(struct ata_port *ap);
  827. extern int ata_host_start(struct ata_host *host);
  828. extern int ata_host_register(struct ata_host *host,
  829. struct scsi_host_template *sht);
  830. extern int ata_host_activate(struct ata_host *host, int irq,
  831. irq_handler_t irq_handler, unsigned long irq_flags,
  832. struct scsi_host_template *sht);
  833. extern void ata_host_detach(struct ata_host *host);
  834. extern void ata_host_init(struct ata_host *, struct device *,
  835. unsigned long, struct ata_port_operations *);
  836. extern int ata_scsi_detect(struct scsi_host_template *sht);
  837. extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
  838. extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
  839. extern int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *dev,
  840. int cmd, void __user *arg);
  841. extern void ata_sas_port_destroy(struct ata_port *);
  842. extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
  843. struct ata_port_info *, struct Scsi_Host *);
  844. extern int ata_sas_port_init(struct ata_port *);
  845. extern int ata_sas_port_start(struct ata_port *ap);
  846. extern void ata_sas_port_stop(struct ata_port *ap);
  847. extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
  848. extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
  849. struct ata_port *ap);
  850. extern int sata_scr_valid(struct ata_link *link);
  851. extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
  852. extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
  853. extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
  854. extern bool ata_link_online(struct ata_link *link);
  855. extern bool ata_link_offline(struct ata_link *link);
  856. #ifdef CONFIG_PM
  857. extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
  858. extern void ata_host_resume(struct ata_host *host);
  859. #endif
  860. extern int ata_ratelimit(void);
  861. extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
  862. unsigned long interval, unsigned long timeout);
  863. extern int atapi_cmd_type(u8 opcode);
  864. extern void ata_tf_to_fis(const struct ata_taskfile *tf,
  865. u8 pmp, int is_cmd, u8 *fis);
  866. extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
  867. extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
  868. unsigned long mwdma_mask, unsigned long udma_mask);
  869. extern void ata_unpack_xfermask(unsigned long xfer_mask,
  870. unsigned long *pio_mask, unsigned long *mwdma_mask,
  871. unsigned long *udma_mask);
  872. extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
  873. extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
  874. extern int ata_xfer_mode2shift(unsigned long xfer_mode);
  875. extern const char *ata_mode_string(unsigned long xfer_mask);
  876. extern unsigned long ata_id_xfermask(const u16 *id);
  877. extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
  878. extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
  879. extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
  880. unsigned int n_elem);
  881. extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
  882. extern void ata_dev_disable(struct ata_device *adev);
  883. extern void ata_id_string(const u16 *id, unsigned char *s,
  884. unsigned int ofs, unsigned int len);
  885. extern void ata_id_c_string(const u16 *id, unsigned char *s,
  886. unsigned int ofs, unsigned int len);
  887. extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
  888. struct ata_taskfile *tf, u16 *id);
  889. extern void ata_qc_complete(struct ata_queued_cmd *qc);
  890. extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
  891. extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
  892. void (*done)(struct scsi_cmnd *));
  893. extern int ata_std_bios_param(struct scsi_device *sdev,
  894. struct block_device *bdev,
  895. sector_t capacity, int geom[]);
  896. extern void ata_scsi_unlock_native_capacity(struct scsi_device *sdev);
  897. extern int ata_scsi_slave_config(struct scsi_device *sdev);
  898. extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
  899. extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
  900. int queue_depth, int reason);
  901. extern struct ata_device *ata_dev_pair(struct ata_device *adev);
  902. extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
  903. extern int ata_cable_40wire(struct ata_port *ap);
  904. extern int ata_cable_80wire(struct ata_port *ap);
  905. extern int ata_cable_sata(struct ata_port *ap);
  906. extern int ata_cable_ignore(struct ata_port *ap);
  907. extern int ata_cable_unknown(struct ata_port *ap);
  908. /* Timing helpers */
  909. extern unsigned int ata_pio_need_iordy(const struct ata_device *);
  910. extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
  911. extern int ata_timing_compute(struct ata_device *, unsigned short,
  912. struct ata_timing *, int, int);
  913. extern void ata_timing_merge(const struct ata_timing *,
  914. const struct ata_timing *, struct ata_timing *,
  915. unsigned int);
  916. extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
  917. /* PCI */
  918. #ifdef CONFIG_PCI
  919. struct pci_dev;
  920. struct pci_bits {
  921. unsigned int reg; /* PCI config register to read */
  922. unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
  923. unsigned long mask;
  924. unsigned long val;
  925. };
  926. extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
  927. extern void ata_pci_remove_one(struct pci_dev *pdev);
  928. #ifdef CONFIG_PM
  929. extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
  930. extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
  931. extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
  932. extern int ata_pci_device_resume(struct pci_dev *pdev);
  933. #endif /* CONFIG_PM */
  934. #endif /* CONFIG_PCI */
  935. /*
  936. * ACPI - drivers/ata/libata-acpi.c
  937. */
  938. #ifdef CONFIG_ATA_ACPI
  939. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  940. {
  941. if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
  942. return &ap->__acpi_init_gtm;
  943. return NULL;
  944. }
  945. int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
  946. int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
  947. unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
  948. const struct ata_acpi_gtm *gtm);
  949. int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
  950. #else
  951. static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
  952. {
  953. return NULL;
  954. }
  955. static inline int ata_acpi_stm(const struct ata_port *ap,
  956. struct ata_acpi_gtm *stm)
  957. {
  958. return -ENOSYS;
  959. }
  960. static inline int ata_acpi_gtm(const struct ata_port *ap,
  961. struct ata_acpi_gtm *stm)
  962. {
  963. return -ENOSYS;
  964. }
  965. static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
  966. const struct ata_acpi_gtm *gtm)
  967. {
  968. return 0;
  969. }
  970. static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
  971. const struct ata_acpi_gtm *gtm)
  972. {
  973. return 0;
  974. }
  975. #endif
  976. /*
  977. * EH - drivers/ata/libata-eh.c
  978. */
  979. extern void ata_port_schedule_eh(struct ata_port *ap);
  980. extern int ata_link_abort(struct ata_link *link);
  981. extern int ata_port_abort(struct ata_port *ap);
  982. extern int ata_port_freeze(struct ata_port *ap);
  983. extern int sata_async_notification(struct ata_port *ap);
  984. extern void ata_eh_freeze_port(struct ata_port *ap);
  985. extern void ata_eh_thaw_port(struct ata_port *ap);
  986. extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
  987. extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
  988. extern void ata_eh_analyze_ncq_error(struct ata_link *link);
  989. extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
  990. ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
  991. ata_postreset_fn_t postreset);
  992. extern void ata_std_error_handler(struct ata_port *ap);
  993. /*
  994. * Base operations to inherit from and initializers for sht
  995. *
  996. * Operations
  997. *
  998. * base : Common to all libata drivers.
  999. * sata : SATA controllers w/ native interface.
  1000. * pmp : SATA controllers w/ PMP support.
  1001. * sff : SFF ATA controllers w/o BMDMA support.
  1002. * bmdma : SFF ATA controllers w/ BMDMA support.
  1003. *
  1004. * sht initializers
  1005. *
  1006. * BASE : Common to all libata drivers. The user must set
  1007. * sg_tablesize and dma_boundary.
  1008. * PIO : SFF ATA controllers w/ only PIO support.
  1009. * BMDMA : SFF ATA controllers w/ BMDMA support. sg_tablesize and
  1010. * dma_boundary are set to BMDMA limits.
  1011. * NCQ : SATA controllers supporting NCQ. The user must set
  1012. * sg_tablesize, dma_boundary and can_queue.
  1013. */
  1014. extern const struct ata_port_operations ata_base_port_ops;
  1015. extern const struct ata_port_operations sata_port_ops;
  1016. extern struct device_attribute *ata_common_sdev_attrs[];
  1017. #define ATA_BASE_SHT(drv_name) \
  1018. .module = THIS_MODULE, \
  1019. .name = drv_name, \
  1020. .ioctl = ata_scsi_ioctl, \
  1021. .queuecommand = ata_scsi_queuecmd, \
  1022. .can_queue = ATA_DEF_QUEUE, \
  1023. .this_id = ATA_SHT_THIS_ID, \
  1024. .cmd_per_lun = ATA_SHT_CMD_PER_LUN, \
  1025. .emulated = ATA_SHT_EMULATED, \
  1026. .use_clustering = ATA_SHT_USE_CLUSTERING, \
  1027. .proc_name = drv_name, \
  1028. .slave_configure = ata_scsi_slave_config, \
  1029. .slave_destroy = ata_scsi_slave_destroy, \
  1030. .bios_param = ata_std_bios_param, \
  1031. .unlock_native_capacity = ata_scsi_unlock_native_capacity, \
  1032. .sdev_attrs = ata_common_sdev_attrs
  1033. #define ATA_NCQ_SHT(drv_name) \
  1034. ATA_BASE_SHT(drv_name), \
  1035. .change_queue_depth = ata_scsi_change_queue_depth
  1036. /*
  1037. * PMP helpers
  1038. */
  1039. #ifdef CONFIG_SATA_PMP
  1040. static inline bool sata_pmp_supported(struct ata_port *ap)
  1041. {
  1042. return ap->flags & ATA_FLAG_PMP;
  1043. }
  1044. static inline bool sata_pmp_attached(struct ata_port *ap)
  1045. {
  1046. return ap->nr_pmp_links != 0;
  1047. }
  1048. static inline int ata_is_host_link(const struct ata_link *link)
  1049. {
  1050. return link == &link->ap->link || link == link->ap->slave_link;
  1051. }
  1052. #else /* CONFIG_SATA_PMP */
  1053. static inline bool sata_pmp_supported(struct ata_port *ap)
  1054. {
  1055. return false;
  1056. }
  1057. static inline bool sata_pmp_attached(struct ata_port *ap)
  1058. {
  1059. return false;
  1060. }
  1061. static inline int ata_is_host_link(const struct ata_link *link)
  1062. {
  1063. return 1;
  1064. }
  1065. #endif /* CONFIG_SATA_PMP */
  1066. static inline int sata_srst_pmp(struct ata_link *link)
  1067. {
  1068. if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
  1069. return SATA_PMP_CTRL_PORT;
  1070. return link->pmp;
  1071. }
  1072. /*
  1073. * printk helpers
  1074. */
  1075. #define ata_port_printk(ap, lv, fmt, args...) \
  1076. printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
  1077. #define ata_link_printk(link, lv, fmt, args...) do { \
  1078. if (sata_pmp_attached((link)->ap) || (link)->ap->slave_link) \
  1079. printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id, \
  1080. (link)->pmp , ##args); \
  1081. else \
  1082. printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
  1083. } while(0)
  1084. #define ata_dev_printk(dev, lv, fmt, args...) \
  1085. printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id, \
  1086. (dev)->link->pmp + (dev)->devno , ##args)
  1087. /*
  1088. * ata_eh_info helpers
  1089. */
  1090. extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
  1091. __attribute__ ((format (printf, 2, 3)));
  1092. extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
  1093. __attribute__ ((format (printf, 2, 3)));
  1094. extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
  1095. static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
  1096. {
  1097. ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
  1098. ehi->flags |= ATA_EHI_HOTPLUGGED;
  1099. ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
  1100. ehi->err_mask |= AC_ERR_ATA_BUS;
  1101. }
  1102. /*
  1103. * port description helpers
  1104. */
  1105. extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
  1106. __attribute__ ((format (printf, 2, 3)));
  1107. #ifdef CONFIG_PCI
  1108. extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
  1109. const char *name);
  1110. #endif
  1111. static inline unsigned int ata_tag_valid(unsigned int tag)
  1112. {
  1113. return (tag < ATA_MAX_QUEUE) ? 1 : 0;
  1114. }
  1115. static inline unsigned int ata_tag_internal(unsigned int tag)
  1116. {
  1117. return tag == ATA_TAG_INTERNAL;
  1118. }
  1119. /*
  1120. * device helpers
  1121. */
  1122. static inline unsigned int ata_class_enabled(unsigned int class)
  1123. {
  1124. return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
  1125. class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
  1126. }
  1127. static inline unsigned int ata_class_disabled(unsigned int class)
  1128. {
  1129. return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
  1130. class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
  1131. }
  1132. static inline unsigned int ata_class_absent(unsigned int class)
  1133. {
  1134. return !ata_class_enabled(class) && !ata_class_disabled(class);
  1135. }
  1136. static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
  1137. {
  1138. return ata_class_enabled(dev->class);
  1139. }
  1140. static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
  1141. {
  1142. return ata_class_disabled(dev->class);
  1143. }
  1144. static inline unsigned int ata_dev_absent(const struct ata_device *dev)
  1145. {
  1146. return ata_class_absent(dev->class);
  1147. }
  1148. /*
  1149. * link helpers
  1150. */
  1151. static inline int ata_link_max_devices(const struct ata_link *link)
  1152. {
  1153. if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
  1154. return 2;
  1155. return 1;
  1156. }
  1157. static inline int ata_link_active(struct ata_link *link)
  1158. {
  1159. return ata_tag_valid(link->active_tag) || link->sactive;
  1160. }
  1161. /*
  1162. * Iterators
  1163. *
  1164. * ATA_LITER_* constants are used to select link iteration mode and
  1165. * ATA_DITER_* device iteration mode.
  1166. *
  1167. * For a custom iteration directly using ata_{link|dev}_next(), if
  1168. * @link or @dev, respectively, is NULL, the first element is
  1169. * returned. @dev and @link can be any valid device or link and the
  1170. * next element according to the iteration mode will be returned.
  1171. * After the last element, NULL is returned.
  1172. */
  1173. enum ata_link_iter_mode {
  1174. ATA_LITER_EDGE, /* if present, PMP links only; otherwise,
  1175. * host link. no slave link */
  1176. ATA_LITER_HOST_FIRST, /* host link followed by PMP or slave links */
  1177. ATA_LITER_PMP_FIRST, /* PMP links followed by host link,
  1178. * slave link still comes after host link */
  1179. };
  1180. enum ata_dev_iter_mode {
  1181. ATA_DITER_ENABLED,
  1182. ATA_DITER_ENABLED_REVERSE,
  1183. ATA_DITER_ALL,
  1184. ATA_DITER_ALL_REVERSE,
  1185. };
  1186. extern struct ata_link *ata_link_next(struct ata_link *link,
  1187. struct ata_port *ap,
  1188. enum ata_link_iter_mode mode);
  1189. extern struct ata_device *ata_dev_next(struct ata_device *dev,
  1190. struct ata_link *link,
  1191. enum ata_dev_iter_mode mode);
  1192. /*
  1193. * Shortcut notation for iterations
  1194. *
  1195. * ata_for_each_link() iterates over each link of @ap according to
  1196. * @mode. @link points to the current link in the loop. @link is
  1197. * NULL after loop termination. ata_for_each_dev() works the same way
  1198. * except that it iterates over each device of @link.
  1199. *
  1200. * Note that the mode prefixes ATA_{L|D}ITER_ shouldn't need to be
  1201. * specified when using the following shorthand notations. Only the
  1202. * mode itself (EDGE, HOST_FIRST, ENABLED, etc...) should be
  1203. * specified. This not only increases brevity but also makes it
  1204. * impossible to use ATA_LITER_* for device iteration or vice-versa.
  1205. */
  1206. #define ata_for_each_link(link, ap, mode) \
  1207. for ((link) = ata_link_next(NULL, (ap), ATA_LITER_##mode); (link); \
  1208. (link) = ata_link_next((link), (ap), ATA_LITER_##mode))
  1209. #define ata_for_each_dev(dev, link, mode) \
  1210. for ((dev) = ata_dev_next(NULL, (link), ATA_DITER_##mode); (dev); \
  1211. (dev) = ata_dev_next((dev), (link), ATA_DITER_##mode))
  1212. /**
  1213. * ata_ncq_enabled - Test whether NCQ is enabled
  1214. * @dev: ATA device to test for
  1215. *
  1216. * LOCKING:
  1217. * spin_lock_irqsave(host lock)
  1218. *
  1219. * RETURNS:
  1220. * 1 if NCQ is enabled for @dev, 0 otherwise.
  1221. */
  1222. static inline int ata_ncq_enabled(struct ata_device *dev)
  1223. {
  1224. return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
  1225. ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
  1226. }
  1227. static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
  1228. {
  1229. qc->tf.ctl |= ATA_NIEN;
  1230. }
  1231. static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
  1232. unsigned int tag)
  1233. {
  1234. if (likely(ata_tag_valid(tag)))
  1235. return &ap->qcmd[tag];
  1236. return NULL;
  1237. }
  1238. static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
  1239. unsigned int tag)
  1240. {
  1241. struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
  1242. if (unlikely(!qc) || !ap->ops->error_handler)
  1243. return qc;
  1244. if ((qc->flags & (ATA_QCFLAG_ACTIVE |
  1245. ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
  1246. return qc;
  1247. return NULL;
  1248. }
  1249. static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
  1250. {
  1251. return qc->nbytes - min(qc->extrabytes, qc->nbytes);
  1252. }
  1253. static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
  1254. {
  1255. memset(tf, 0, sizeof(*tf));
  1256. #ifdef CONFIG_ATA_SFF
  1257. tf->ctl = dev->link->ap->ctl;
  1258. #else
  1259. tf->ctl = ATA_DEVCTL_OBS;
  1260. #endif
  1261. if (dev->devno == 0)
  1262. tf->device = ATA_DEVICE_OBS;
  1263. else
  1264. tf->device = ATA_DEVICE_OBS | ATA_DEV1;
  1265. }
  1266. static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
  1267. {
  1268. qc->dma_dir = DMA_NONE;
  1269. qc->sg = NULL;
  1270. qc->flags = 0;
  1271. qc->cursg = NULL;
  1272. qc->cursg_ofs = 0;
  1273. qc->nbytes = qc->extrabytes = qc->curbytes = 0;
  1274. qc->n_elem = 0;
  1275. qc->err_mask = 0;
  1276. qc->sect_size = ATA_SECT_SIZE;
  1277. ata_tf_init(qc->dev, &qc->tf);
  1278. /* init result_tf such that it indicates normal completion */
  1279. qc->result_tf.command = ATA_DRDY;
  1280. qc->result_tf.feature = 0;
  1281. }
  1282. static inline int ata_try_flush_cache(const struct ata_device *dev)
  1283. {
  1284. return ata_id_wcache_enabled(dev->id) ||
  1285. ata_id_has_flush(dev->id) ||
  1286. ata_id_has_flush_ext(dev->id);
  1287. }
  1288. static inline unsigned int ac_err_mask(u8 status)
  1289. {
  1290. if (status & (ATA_BUSY | ATA_DRQ))
  1291. return AC_ERR_HSM;
  1292. if (status & (ATA_ERR | ATA_DF))
  1293. return AC_ERR_DEV;
  1294. return 0;
  1295. }
  1296. static inline unsigned int __ac_err_mask(u8 status)
  1297. {
  1298. unsigned int mask = ac_err_mask(status);
  1299. if (mask == 0)
  1300. return AC_ERR_OTHER;
  1301. return mask;
  1302. }
  1303. static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
  1304. {
  1305. return *(struct ata_port **)&host->hostdata[0];
  1306. }
  1307. static inline int ata_check_ready(u8 status)
  1308. {
  1309. if (!(status & ATA_BUSY))
  1310. return 1;
  1311. /* 0xff indicates either no device or device not ready */
  1312. if (status == 0xff)
  1313. return -ENODEV;
  1314. return 0;
  1315. }
  1316. static inline unsigned long ata_deadline(unsigned long from_jiffies,
  1317. unsigned long timeout_msecs)
  1318. {
  1319. return from_jiffies + msecs_to_jiffies(timeout_msecs);
  1320. }
  1321. /* Don't open code these in drivers as there are traps. Firstly the range may
  1322. change in future hardware and specs, secondly 0xFF means 'no DMA' but is
  1323. > UDMA_0. Dyma ddreigiau */
  1324. static inline int ata_using_mwdma(struct ata_device *adev)
  1325. {
  1326. if (adev->dma_mode >= XFER_MW_DMA_0 && adev->dma_mode <= XFER_MW_DMA_4)
  1327. return 1;
  1328. return 0;
  1329. }
  1330. static inline int ata_using_udma(struct ata_device *adev)
  1331. {
  1332. if (adev->dma_mode >= XFER_UDMA_0 && adev->dma_mode <= XFER_UDMA_7)
  1333. return 1;
  1334. return 0;
  1335. }
  1336. static inline int ata_dma_enabled(struct ata_device *adev)
  1337. {
  1338. return (adev->dma_mode == 0xFF ? 0 : 1);
  1339. }
  1340. /**************************************************************************
  1341. * PMP - drivers/ata/libata-pmp.c
  1342. */
  1343. #ifdef CONFIG_SATA_PMP
  1344. extern const struct ata_port_operations sata_pmp_port_ops;
  1345. extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
  1346. extern void sata_pmp_error_handler(struct ata_port *ap);
  1347. #else /* CONFIG_SATA_PMP */
  1348. #define sata_pmp_port_ops sata_port_ops
  1349. #define sata_pmp_qc_defer_cmd_switch ata_std_qc_defer
  1350. #define sata_pmp_error_handler ata_std_error_handler
  1351. #endif /* CONFIG_SATA_PMP */
  1352. /**************************************************************************
  1353. * SFF - drivers/ata/libata-sff.c
  1354. */
  1355. #ifdef CONFIG_ATA_SFF
  1356. extern const struct ata_port_operations ata_sff_port_ops;
  1357. extern const struct ata_port_operations ata_bmdma32_port_ops;
  1358. /* PIO only, sg_tablesize and dma_boundary limits can be removed */
  1359. #define ATA_PIO_SHT(drv_name) \
  1360. ATA_BASE_SHT(drv_name), \
  1361. .sg_tablesize = LIBATA_MAX_PRD, \
  1362. .dma_boundary = ATA_DMA_BOUNDARY
  1363. extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
  1364. extern u8 ata_sff_check_status(struct ata_port *ap);
  1365. extern void ata_sff_pause(struct ata_port *ap);
  1366. extern void ata_sff_dma_pause(struct ata_port *ap);
  1367. extern int ata_sff_busy_sleep(struct ata_port *ap,
  1368. unsigned long timeout_pat, unsigned long timeout);
  1369. extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
  1370. extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
  1371. extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
  1372. extern void ata_sff_exec_command(struct ata_port *ap,
  1373. const struct ata_taskfile *tf);
  1374. extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
  1375. unsigned char *buf, unsigned int buflen, int rw);
  1376. extern unsigned int ata_sff_data_xfer32(struct ata_device *dev,
  1377. unsigned char *buf, unsigned int buflen, int rw);
  1378. extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
  1379. unsigned char *buf, unsigned int buflen, int rw);
  1380. extern void ata_sff_irq_on(struct ata_port *ap);
  1381. extern void ata_sff_irq_clear(struct ata_port *ap);
  1382. extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
  1383. u8 status, int in_wq);
  1384. extern void ata_sff_queue_pio_task(struct ata_link *link, unsigned long delay);
  1385. extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
  1386. extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
  1387. extern unsigned int ata_sff_port_intr(struct ata_port *ap,
  1388. struct ata_queued_cmd *qc);
  1389. extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
  1390. extern void ata_sff_lost_interrupt(struct ata_port *ap);
  1391. extern void ata_sff_freeze(struct ata_port *ap);
  1392. extern void ata_sff_thaw(struct ata_port *ap);
  1393. extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
  1394. extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
  1395. u8 *r_err);
  1396. extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
  1397. unsigned long deadline);
  1398. extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
  1399. unsigned long deadline);
  1400. extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
  1401. unsigned long deadline);
  1402. extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
  1403. extern void ata_sff_drain_fifo(struct ata_queued_cmd *qc);
  1404. extern void ata_sff_error_handler(struct ata_port *ap);
  1405. extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
  1406. #ifdef CONFIG_PCI
  1407. extern int ata_pci_sff_init_host(struct ata_host *host);
  1408. extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
  1409. const struct ata_port_info * const * ppi,
  1410. struct ata_host **r_host);
  1411. extern int ata_pci_sff_activate_host(struct ata_host *host,
  1412. irq_handler_t irq_handler,
  1413. struct scsi_host_template *sht);
  1414. extern int ata_pci_sff_init_one(struct pci_dev *pdev,
  1415. const struct ata_port_info * const * ppi,
  1416. struct scsi_host_template *sht, void *host_priv, int hflags);
  1417. #endif /* CONFIG_PCI */
  1418. #ifdef CONFIG_ATA_BMDMA
  1419. extern const struct ata_port_operations ata_bmdma_port_ops;
  1420. #define ATA_BMDMA_SHT(drv_name) \
  1421. ATA_BASE_SHT(drv_name), \
  1422. .sg_tablesize = LIBATA_MAX_PRD, \
  1423. .dma_boundary = ATA_DMA_BOUNDARY
  1424. extern void ata_bmdma_qc_prep(struct ata_queued_cmd *qc);
  1425. extern unsigned int ata_bmdma_qc_issue(struct ata_queued_cmd *qc);
  1426. extern void ata_bmdma_dumb_qc_prep(struct ata_queued_cmd *qc);
  1427. extern unsigned int ata_bmdma_port_intr(struct ata_port *ap,
  1428. struct ata_queued_cmd *qc);
  1429. extern irqreturn_t ata_bmdma_interrupt(int irq, void *dev_instance);
  1430. extern void ata_bmdma_error_handler(struct ata_port *ap);
  1431. extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
  1432. extern void ata_bmdma_irq_clear(struct ata_port *ap);
  1433. extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
  1434. extern void ata_bmdma_start(struct ata_queued_cmd *qc);
  1435. extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
  1436. extern u8 ata_bmdma_status(struct ata_port *ap);
  1437. extern int ata_bmdma_port_start(struct ata_port *ap);
  1438. extern int ata_bmdma_port_start32(struct ata_port *ap);
  1439. #ifdef CONFIG_PCI
  1440. extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
  1441. extern void ata_pci_bmdma_init(struct ata_host *host);
  1442. extern int ata_pci_bmdma_prepare_host(struct pci_dev *pdev,
  1443. const struct ata_port_info * const * ppi,
  1444. struct ata_host **r_host);
  1445. extern int ata_pci_bmdma_init_one(struct pci_dev *pdev,
  1446. const struct ata_port_info * const * ppi,
  1447. struct scsi_host_template *sht,
  1448. void *host_priv, int hflags);
  1449. #endif /* CONFIG_PCI */
  1450. #endif /* CONFIG_ATA_BMDMA */
  1451. /**
  1452. * ata_sff_busy_wait - Wait for a port status register
  1453. * @ap: Port to wait for.
  1454. * @bits: bits that must be clear
  1455. * @max: number of 10uS waits to perform
  1456. *
  1457. * Waits up to max*10 microseconds for the selected bits in the port's
  1458. * status register to be cleared.
  1459. * Returns final value of status register.
  1460. *
  1461. * LOCKING:
  1462. * Inherited from caller.
  1463. */
  1464. static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
  1465. unsigned int max)
  1466. {
  1467. u8 status;
  1468. do {
  1469. udelay(10);
  1470. status = ap->ops->sff_check_status(ap);
  1471. max--;
  1472. } while (status != 0xff && (status & bits) && (max > 0));
  1473. return status;
  1474. }
  1475. /**
  1476. * ata_wait_idle - Wait for a port to be idle.
  1477. * @ap: Port to wait for.
  1478. *
  1479. * Waits up to 10ms for port's BUSY and DRQ signals to clear.
  1480. * Returns final value of status register.
  1481. *
  1482. * LOCKING:
  1483. * Inherited from caller.
  1484. */
  1485. static inline u8 ata_wait_idle(struct ata_port *ap)
  1486. {
  1487. u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
  1488. #ifdef ATA_DEBUG
  1489. if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
  1490. ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
  1491. status);
  1492. #endif
  1493. return status;
  1494. }
  1495. #endif /* CONFIG_ATA_SFF */
  1496. #endif /* __LINUX_LIBATA_H__ */