libata.h 59 KB

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