libata.h 58 KB

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