sdhci.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  1. /*
  2. * linux/drivers/mmc/host/sdhci.h - Secure Digital Host Controller Interface driver
  3. *
  4. * Header file for Host Controller registers and I/O accessors.
  5. *
  6. * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2 of the License, or (at
  11. * your option) any later version.
  12. */
  13. #ifndef __SDHCI_HW_H
  14. #define __SDHCI_HW_H
  15. #include <linux/scatterlist.h>
  16. #include <linux/compiler.h>
  17. #include <linux/types.h>
  18. #include <linux/io.h>
  19. #include <linux/mmc/host.h>
  20. /*
  21. * Controller registers
  22. */
  23. #define SDHCI_DMA_ADDRESS 0x00
  24. #define SDHCI_ARGUMENT2 SDHCI_DMA_ADDRESS
  25. #define SDHCI_BLOCK_SIZE 0x04
  26. #define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))
  27. #define SDHCI_BLOCK_COUNT 0x06
  28. #define SDHCI_ARGUMENT 0x08
  29. #define SDHCI_TRANSFER_MODE 0x0C
  30. #define SDHCI_TRNS_DMA 0x01
  31. #define SDHCI_TRNS_BLK_CNT_EN 0x02
  32. #define SDHCI_TRNS_AUTO_CMD12 0x04
  33. #define SDHCI_TRNS_AUTO_CMD23 0x08
  34. #define SDHCI_TRNS_READ 0x10
  35. #define SDHCI_TRNS_MULTI 0x20
  36. #define SDHCI_COMMAND 0x0E
  37. #define SDHCI_CMD_RESP_MASK 0x03
  38. #define SDHCI_CMD_CRC 0x08
  39. #define SDHCI_CMD_INDEX 0x10
  40. #define SDHCI_CMD_DATA 0x20
  41. #define SDHCI_CMD_ABORTCMD 0xC0
  42. #define SDHCI_CMD_RESP_NONE 0x00
  43. #define SDHCI_CMD_RESP_LONG 0x01
  44. #define SDHCI_CMD_RESP_SHORT 0x02
  45. #define SDHCI_CMD_RESP_SHORT_BUSY 0x03
  46. #define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
  47. #define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
  48. #define SDHCI_RESPONSE 0x10
  49. #define SDHCI_BUFFER 0x20
  50. #define SDHCI_PRESENT_STATE 0x24
  51. #define SDHCI_CMD_INHIBIT 0x00000001
  52. #define SDHCI_DATA_INHIBIT 0x00000002
  53. #define SDHCI_DOING_WRITE 0x00000100
  54. #define SDHCI_DOING_READ 0x00000200
  55. #define SDHCI_SPACE_AVAILABLE 0x00000400
  56. #define SDHCI_DATA_AVAILABLE 0x00000800
  57. #define SDHCI_CARD_PRESENT 0x00010000
  58. #define SDHCI_WRITE_PROTECT 0x00080000
  59. #define SDHCI_DATA_LVL_MASK 0x00F00000
  60. #define SDHCI_DATA_LVL_SHIFT 20
  61. #define SDHCI_DATA_0_LVL_MASK 0x00100000
  62. #define SDHCI_HOST_CONTROL 0x28
  63. #define SDHCI_CTRL_LED 0x01
  64. #define SDHCI_CTRL_4BITBUS 0x02
  65. #define SDHCI_CTRL_HISPD 0x04
  66. #define SDHCI_CTRL_DMA_MASK 0x18
  67. #define SDHCI_CTRL_SDMA 0x00
  68. #define SDHCI_CTRL_ADMA1 0x08
  69. #define SDHCI_CTRL_ADMA32 0x10
  70. #define SDHCI_CTRL_ADMA64 0x18
  71. #define SDHCI_CTRL_8BITBUS 0x20
  72. #define SDHCI_POWER_CONTROL 0x29
  73. #define SDHCI_POWER_ON 0x01
  74. #define SDHCI_POWER_180 0x0A
  75. #define SDHCI_POWER_300 0x0C
  76. #define SDHCI_POWER_330 0x0E
  77. #define SDHCI_BLOCK_GAP_CONTROL 0x2A
  78. #define SDHCI_WAKE_UP_CONTROL 0x2B
  79. #define SDHCI_WAKE_ON_INT 0x01
  80. #define SDHCI_WAKE_ON_INSERT 0x02
  81. #define SDHCI_WAKE_ON_REMOVE 0x04
  82. #define SDHCI_CLOCK_CONTROL 0x2C
  83. #define SDHCI_DIVIDER_SHIFT 8
  84. #define SDHCI_DIVIDER_HI_SHIFT 6
  85. #define SDHCI_DIV_MASK 0xFF
  86. #define SDHCI_DIV_MASK_LEN 8
  87. #define SDHCI_DIV_HI_MASK 0x300
  88. #define SDHCI_PROG_CLOCK_MODE 0x0020
  89. #define SDHCI_CLOCK_CARD_EN 0x0004
  90. #define SDHCI_CLOCK_INT_STABLE 0x0002
  91. #define SDHCI_CLOCK_INT_EN 0x0001
  92. #define SDHCI_TIMEOUT_CONTROL 0x2E
  93. #define SDHCI_SOFTWARE_RESET 0x2F
  94. #define SDHCI_RESET_ALL 0x01
  95. #define SDHCI_RESET_CMD 0x02
  96. #define SDHCI_RESET_DATA 0x04
  97. #define SDHCI_INT_STATUS 0x30
  98. #define SDHCI_INT_ENABLE 0x34
  99. #define SDHCI_SIGNAL_ENABLE 0x38
  100. #define SDHCI_INT_RESPONSE 0x00000001
  101. #define SDHCI_INT_DATA_END 0x00000002
  102. #define SDHCI_INT_BLK_GAP 0x00000004
  103. #define SDHCI_INT_DMA_END 0x00000008
  104. #define SDHCI_INT_SPACE_AVAIL 0x00000010
  105. #define SDHCI_INT_DATA_AVAIL 0x00000020
  106. #define SDHCI_INT_CARD_INSERT 0x00000040
  107. #define SDHCI_INT_CARD_REMOVE 0x00000080
  108. #define SDHCI_INT_CARD_INT 0x00000100
  109. #define SDHCI_INT_ERROR 0x00008000
  110. #define SDHCI_INT_TIMEOUT 0x00010000
  111. #define SDHCI_INT_CRC 0x00020000
  112. #define SDHCI_INT_END_BIT 0x00040000
  113. #define SDHCI_INT_INDEX 0x00080000
  114. #define SDHCI_INT_DATA_TIMEOUT 0x00100000
  115. #define SDHCI_INT_DATA_CRC 0x00200000
  116. #define SDHCI_INT_DATA_END_BIT 0x00400000
  117. #define SDHCI_INT_BUS_POWER 0x00800000
  118. #define SDHCI_INT_ACMD12ERR 0x01000000
  119. #define SDHCI_INT_ADMA_ERROR 0x02000000
  120. #define SDHCI_INT_NORMAL_MASK 0x00007FFF
  121. #define SDHCI_INT_ERROR_MASK 0xFFFF8000
  122. #define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
  123. SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
  124. #define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
  125. SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
  126. SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
  127. SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR | \
  128. SDHCI_INT_BLK_GAP)
  129. #define SDHCI_INT_ALL_MASK ((unsigned int)-1)
  130. #define SDHCI_ACMD12_ERR 0x3C
  131. #define SDHCI_HOST_CONTROL2 0x3E
  132. #define SDHCI_CTRL_UHS_MASK 0x0007
  133. #define SDHCI_CTRL_UHS_SDR12 0x0000
  134. #define SDHCI_CTRL_UHS_SDR25 0x0001
  135. #define SDHCI_CTRL_UHS_SDR50 0x0002
  136. #define SDHCI_CTRL_UHS_SDR104 0x0003
  137. #define SDHCI_CTRL_UHS_DDR50 0x0004
  138. #define SDHCI_CTRL_HS400 0x0005 /* Non-standard */
  139. #define SDHCI_CTRL_VDD_180 0x0008
  140. #define SDHCI_CTRL_DRV_TYPE_MASK 0x0030
  141. #define SDHCI_CTRL_DRV_TYPE_B 0x0000
  142. #define SDHCI_CTRL_DRV_TYPE_A 0x0010
  143. #define SDHCI_CTRL_DRV_TYPE_C 0x0020
  144. #define SDHCI_CTRL_DRV_TYPE_D 0x0030
  145. #define SDHCI_CTRL_EXEC_TUNING 0x0040
  146. #define SDHCI_CTRL_TUNED_CLK 0x0080
  147. #define SDHCI_CTRL_PRESET_VAL_ENABLE 0x8000
  148. #define SDHCI_CAPABILITIES 0x40
  149. #define SDHCI_TIMEOUT_CLK_MASK 0x0000003F
  150. #define SDHCI_TIMEOUT_CLK_SHIFT 0
  151. #define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
  152. #define SDHCI_CLOCK_BASE_MASK 0x00003F00
  153. #define SDHCI_CLOCK_V3_BASE_MASK 0x0000FF00
  154. #define SDHCI_CLOCK_BASE_SHIFT 8
  155. #define SDHCI_MAX_BLOCK_MASK 0x00030000
  156. #define SDHCI_MAX_BLOCK_SHIFT 16
  157. #define SDHCI_CAN_DO_8BIT 0x00040000
  158. #define SDHCI_CAN_DO_ADMA2 0x00080000
  159. #define SDHCI_CAN_DO_ADMA1 0x00100000
  160. #define SDHCI_CAN_DO_HISPD 0x00200000
  161. #define SDHCI_CAN_DO_SDMA 0x00400000
  162. #define SDHCI_CAN_VDD_330 0x01000000
  163. #define SDHCI_CAN_VDD_300 0x02000000
  164. #define SDHCI_CAN_VDD_180 0x04000000
  165. #define SDHCI_CAN_64BIT 0x10000000
  166. #define SDHCI_SUPPORT_SDR50 0x00000001
  167. #define SDHCI_SUPPORT_SDR104 0x00000002
  168. #define SDHCI_SUPPORT_DDR50 0x00000004
  169. #define SDHCI_DRIVER_TYPE_A 0x00000010
  170. #define SDHCI_DRIVER_TYPE_C 0x00000020
  171. #define SDHCI_DRIVER_TYPE_D 0x00000040
  172. #define SDHCI_RETUNING_TIMER_COUNT_MASK 0x00000F00
  173. #define SDHCI_RETUNING_TIMER_COUNT_SHIFT 8
  174. #define SDHCI_USE_SDR50_TUNING 0x00002000
  175. #define SDHCI_RETUNING_MODE_MASK 0x0000C000
  176. #define SDHCI_RETUNING_MODE_SHIFT 14
  177. #define SDHCI_CLOCK_MUL_MASK 0x00FF0000
  178. #define SDHCI_CLOCK_MUL_SHIFT 16
  179. #define SDHCI_SUPPORT_HS400 0x80000000 /* Non-standard */
  180. #define SDHCI_CAPABILITIES_1 0x44
  181. #define SDHCI_MAX_CURRENT 0x48
  182. #define SDHCI_MAX_CURRENT_LIMIT 0xFF
  183. #define SDHCI_MAX_CURRENT_330_MASK 0x0000FF
  184. #define SDHCI_MAX_CURRENT_330_SHIFT 0
  185. #define SDHCI_MAX_CURRENT_300_MASK 0x00FF00
  186. #define SDHCI_MAX_CURRENT_300_SHIFT 8
  187. #define SDHCI_MAX_CURRENT_180_MASK 0xFF0000
  188. #define SDHCI_MAX_CURRENT_180_SHIFT 16
  189. #define SDHCI_MAX_CURRENT_MULTIPLIER 4
  190. /* 4C-4F reserved for more max current */
  191. #define SDHCI_SET_ACMD12_ERROR 0x50
  192. #define SDHCI_SET_INT_ERROR 0x52
  193. #define SDHCI_ADMA_ERROR 0x54
  194. /* 55-57 reserved */
  195. #define SDHCI_ADMA_ADDRESS 0x58
  196. #define SDHCI_ADMA_ADDRESS_HI 0x5C
  197. /* 60-FB reserved */
  198. #define SDHCI_PRESET_FOR_SDR12 0x66
  199. #define SDHCI_PRESET_FOR_SDR25 0x68
  200. #define SDHCI_PRESET_FOR_SDR50 0x6A
  201. #define SDHCI_PRESET_FOR_SDR104 0x6C
  202. #define SDHCI_PRESET_FOR_DDR50 0x6E
  203. #define SDHCI_PRESET_FOR_HS400 0x74 /* Non-standard */
  204. #define SDHCI_PRESET_DRV_MASK 0xC000
  205. #define SDHCI_PRESET_DRV_SHIFT 14
  206. #define SDHCI_PRESET_CLKGEN_SEL_MASK 0x400
  207. #define SDHCI_PRESET_CLKGEN_SEL_SHIFT 10
  208. #define SDHCI_PRESET_SDCLK_FREQ_MASK 0x3FF
  209. #define SDHCI_PRESET_SDCLK_FREQ_SHIFT 0
  210. #define SDHCI_SLOT_INT_STATUS 0xFC
  211. #define SDHCI_HOST_VERSION 0xFE
  212. #define SDHCI_VENDOR_VER_MASK 0xFF00
  213. #define SDHCI_VENDOR_VER_SHIFT 8
  214. #define SDHCI_SPEC_VER_MASK 0x00FF
  215. #define SDHCI_SPEC_VER_SHIFT 0
  216. #define SDHCI_SPEC_100 0
  217. #define SDHCI_SPEC_200 1
  218. #define SDHCI_SPEC_300 2
  219. /*
  220. * End of controller registers.
  221. */
  222. #define SDHCI_MAX_DIV_SPEC_200 256
  223. #define SDHCI_MAX_DIV_SPEC_300 2046
  224. /*
  225. * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
  226. */
  227. #define SDHCI_DEFAULT_BOUNDARY_SIZE (512 * 1024)
  228. #define SDHCI_DEFAULT_BOUNDARY_ARG (ilog2(SDHCI_DEFAULT_BOUNDARY_SIZE) - 12)
  229. /* ADMA2 32-bit DMA descriptor size */
  230. #define SDHCI_ADMA2_32_DESC_SZ 8
  231. /* ADMA2 32-bit DMA alignment */
  232. #define SDHCI_ADMA2_32_ALIGN 4
  233. /* ADMA2 32-bit descriptor */
  234. struct sdhci_adma2_32_desc {
  235. __le16 cmd;
  236. __le16 len;
  237. __le32 addr;
  238. } __packed __aligned(SDHCI_ADMA2_32_ALIGN);
  239. /* ADMA2 64-bit DMA descriptor size */
  240. #define SDHCI_ADMA2_64_DESC_SZ 12
  241. /* ADMA2 64-bit DMA alignment */
  242. #define SDHCI_ADMA2_64_ALIGN 8
  243. /*
  244. * ADMA2 64-bit descriptor. Note 12-byte descriptor can't always be 8-byte
  245. * aligned.
  246. */
  247. struct sdhci_adma2_64_desc {
  248. __le16 cmd;
  249. __le16 len;
  250. __le32 addr_lo;
  251. __le32 addr_hi;
  252. } __packed __aligned(4);
  253. #define ADMA2_TRAN_VALID 0x21
  254. #define ADMA2_NOP_END_VALID 0x3
  255. #define ADMA2_END 0x2
  256. /*
  257. * Maximum segments assuming a 512KiB maximum requisition size and a minimum
  258. * 4KiB page size.
  259. */
  260. #define SDHCI_MAX_SEGS 128
  261. enum sdhci_cookie {
  262. COOKIE_UNMAPPED,
  263. COOKIE_MAPPED,
  264. COOKIE_GIVEN,
  265. };
  266. struct sdhci_host {
  267. /* Data set by hardware interface driver */
  268. const char *hw_name; /* Hardware bus name */
  269. unsigned int quirks; /* Deviations from spec. */
  270. /* Controller doesn't honor resets unless we touch the clock register */
  271. #define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
  272. /* Controller has bad caps bits, but really supports DMA */
  273. #define SDHCI_QUIRK_FORCE_DMA (1<<1)
  274. /* Controller doesn't like to be reset when there is no card inserted. */
  275. #define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
  276. /* Controller doesn't like clearing the power reg before a change */
  277. #define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
  278. /* Controller has flaky internal state so reset it on each ios change */
  279. #define SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS (1<<4)
  280. /* Controller has an unusable DMA engine */
  281. #define SDHCI_QUIRK_BROKEN_DMA (1<<5)
  282. /* Controller has an unusable ADMA engine */
  283. #define SDHCI_QUIRK_BROKEN_ADMA (1<<6)
  284. /* Controller can only DMA from 32-bit aligned addresses */
  285. #define SDHCI_QUIRK_32BIT_DMA_ADDR (1<<7)
  286. /* Controller can only DMA chunk sizes that are a multiple of 32 bits */
  287. #define SDHCI_QUIRK_32BIT_DMA_SIZE (1<<8)
  288. /* Controller can only ADMA chunks that are a multiple of 32 bits */
  289. #define SDHCI_QUIRK_32BIT_ADMA_SIZE (1<<9)
  290. /* Controller needs to be reset after each request to stay stable */
  291. #define SDHCI_QUIRK_RESET_AFTER_REQUEST (1<<10)
  292. /* Controller needs voltage and power writes to happen separately */
  293. #define SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER (1<<11)
  294. /* Controller provides an incorrect timeout value for transfers */
  295. #define SDHCI_QUIRK_BROKEN_TIMEOUT_VAL (1<<12)
  296. /* Controller has an issue with buffer bits for small transfers */
  297. #define SDHCI_QUIRK_BROKEN_SMALL_PIO (1<<13)
  298. /* Controller does not provide transfer-complete interrupt when not busy */
  299. #define SDHCI_QUIRK_NO_BUSY_IRQ (1<<14)
  300. /* Controller has unreliable card detection */
  301. #define SDHCI_QUIRK_BROKEN_CARD_DETECTION (1<<15)
  302. /* Controller reports inverted write-protect state */
  303. #define SDHCI_QUIRK_INVERTED_WRITE_PROTECT (1<<16)
  304. /* Controller does not like fast PIO transfers */
  305. #define SDHCI_QUIRK_PIO_NEEDS_DELAY (1<<18)
  306. /* Controller has to be forced to use block size of 2048 bytes */
  307. #define SDHCI_QUIRK_FORCE_BLK_SZ_2048 (1<<20)
  308. /* Controller cannot do multi-block transfers */
  309. #define SDHCI_QUIRK_NO_MULTIBLOCK (1<<21)
  310. /* Controller can only handle 1-bit data transfers */
  311. #define SDHCI_QUIRK_FORCE_1_BIT_DATA (1<<22)
  312. /* Controller needs 10ms delay between applying power and clock */
  313. #define SDHCI_QUIRK_DELAY_AFTER_POWER (1<<23)
  314. /* Controller uses SDCLK instead of TMCLK for data timeouts */
  315. #define SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK (1<<24)
  316. /* Controller reports wrong base clock capability */
  317. #define SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN (1<<25)
  318. /* Controller cannot support End Attribute in NOP ADMA descriptor */
  319. #define SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC (1<<26)
  320. /* Controller is missing device caps. Use caps provided by host */
  321. #define SDHCI_QUIRK_MISSING_CAPS (1<<27)
  322. /* Controller uses Auto CMD12 command to stop the transfer */
  323. #define SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12 (1<<28)
  324. /* Controller doesn't have HISPD bit field in HI-SPEED SD card */
  325. #define SDHCI_QUIRK_NO_HISPD_BIT (1<<29)
  326. /* Controller treats ADMA descriptors with length 0000h incorrectly */
  327. #define SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC (1<<30)
  328. /* The read-only detection via SDHCI_PRESENT_STATE register is unstable */
  329. #define SDHCI_QUIRK_UNSTABLE_RO_DETECT (1<<31)
  330. unsigned int quirks2; /* More deviations from spec. */
  331. #define SDHCI_QUIRK2_HOST_OFF_CARD_ON (1<<0)
  332. #define SDHCI_QUIRK2_HOST_NO_CMD23 (1<<1)
  333. /* The system physically doesn't support 1.8v, even if the host does */
  334. #define SDHCI_QUIRK2_NO_1_8_V (1<<2)
  335. #define SDHCI_QUIRK2_PRESET_VALUE_BROKEN (1<<3)
  336. #define SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON (1<<4)
  337. /* Controller has a non-standard host control register */
  338. #define SDHCI_QUIRK2_BROKEN_HOST_CONTROL (1<<5)
  339. /* Controller does not support HS200 */
  340. #define SDHCI_QUIRK2_BROKEN_HS200 (1<<6)
  341. /* Controller does not support DDR50 */
  342. #define SDHCI_QUIRK2_BROKEN_DDR50 (1<<7)
  343. /* Stop command (CMD12) can set Transfer Complete when not using MMC_RSP_BUSY */
  344. #define SDHCI_QUIRK2_STOP_WITH_TC (1<<8)
  345. /* Controller does not support 64-bit DMA */
  346. #define SDHCI_QUIRK2_BROKEN_64_BIT_DMA (1<<9)
  347. /* need clear transfer mode register before send cmd */
  348. #define SDHCI_QUIRK2_CLEAR_TRANSFERMODE_REG_BEFORE_CMD (1<<10)
  349. /* Capability register bit-63 indicates HS400 support */
  350. #define SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400 (1<<11)
  351. /* forced tuned clock */
  352. #define SDHCI_QUIRK2_TUNING_WORK_AROUND (1<<12)
  353. /* disable the block count for single block transactions */
  354. #define SDHCI_QUIRK2_SUPPORT_SINGLE (1<<13)
  355. /* Controller broken with using ACMD23 */
  356. #define SDHCI_QUIRK2_ACMD23_BROKEN (1<<14)
  357. /* Broken Clock divider zero in controller */
  358. #define SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN (1<<15)
  359. int irq; /* Device IRQ */
  360. void __iomem *ioaddr; /* Mapped address */
  361. const struct sdhci_ops *ops; /* Low level hw interface */
  362. /* Internal data */
  363. struct mmc_host *mmc; /* MMC structure */
  364. u64 dma_mask; /* custom DMA mask */
  365. #if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
  366. struct led_classdev led; /* LED control */
  367. char led_name[32];
  368. #endif
  369. spinlock_t lock; /* Mutex */
  370. int flags; /* Host attributes */
  371. #define SDHCI_USE_SDMA (1<<0) /* Host is SDMA capable */
  372. #define SDHCI_USE_ADMA (1<<1) /* Host is ADMA capable */
  373. #define SDHCI_REQ_USE_DMA (1<<2) /* Use DMA for this req. */
  374. #define SDHCI_DEVICE_DEAD (1<<3) /* Device unresponsive */
  375. #define SDHCI_SDR50_NEEDS_TUNING (1<<4) /* SDR50 needs tuning */
  376. #define SDHCI_AUTO_CMD12 (1<<6) /* Auto CMD12 support */
  377. #define SDHCI_AUTO_CMD23 (1<<7) /* Auto CMD23 support */
  378. #define SDHCI_PV_ENABLED (1<<8) /* Preset value enabled */
  379. #define SDHCI_SDIO_IRQ_ENABLED (1<<9) /* SDIO irq enabled */
  380. #define SDHCI_SDR104_NEEDS_TUNING (1<<10) /* SDR104/HS200 needs tuning */
  381. #define SDHCI_USE_64_BIT_DMA (1<<12) /* Use 64-bit DMA */
  382. #define SDHCI_HS400_TUNING (1<<13) /* Tuning for HS400 */
  383. unsigned int version; /* SDHCI spec. version */
  384. unsigned int max_clk; /* Max possible freq (MHz) */
  385. unsigned int timeout_clk; /* Timeout freq (KHz) */
  386. unsigned int clk_mul; /* Clock Muliplier value */
  387. unsigned int clock; /* Current clock (MHz) */
  388. u8 pwr; /* Current voltage */
  389. bool runtime_suspended; /* Host is runtime suspended */
  390. bool bus_on; /* Bus power prevents runtime suspend */
  391. bool preset_enabled; /* Preset is enabled */
  392. struct mmc_request *mrq; /* Current request */
  393. struct mmc_command *cmd; /* Current command */
  394. struct mmc_data *data; /* Current data request */
  395. unsigned int data_early:1; /* Data finished before cmd */
  396. unsigned int busy_handle:1; /* Handling the order of Busy-end */
  397. struct sg_mapping_iter sg_miter; /* SG state for PIO */
  398. unsigned int blocks; /* remaining PIO blocks */
  399. int sg_count; /* Mapped sg entries */
  400. void *adma_table; /* ADMA descriptor table */
  401. void *align_buffer; /* Bounce buffer */
  402. size_t adma_table_sz; /* ADMA descriptor table size */
  403. size_t align_buffer_sz; /* Bounce buffer size */
  404. dma_addr_t adma_addr; /* Mapped ADMA descr. table */
  405. dma_addr_t align_addr; /* Mapped bounce buffer */
  406. unsigned int desc_sz; /* ADMA descriptor size */
  407. unsigned int align_sz; /* ADMA alignment */
  408. unsigned int align_mask; /* ADMA alignment mask */
  409. struct tasklet_struct finish_tasklet; /* Tasklet structures */
  410. struct timer_list timer; /* Timer for timeouts */
  411. u32 caps; /* Alternative CAPABILITY_0 */
  412. u32 caps1; /* Alternative CAPABILITY_1 */
  413. unsigned int ocr_avail_sdio; /* OCR bit masks */
  414. unsigned int ocr_avail_sd;
  415. unsigned int ocr_avail_mmc;
  416. u32 ocr_mask; /* available voltages */
  417. unsigned timing; /* Current timing */
  418. u32 thread_isr;
  419. /* cached registers */
  420. u32 ier;
  421. wait_queue_head_t buf_ready_int; /* Waitqueue for Buffer Read Ready interrupt */
  422. unsigned int tuning_done; /* Condition flag set when CMD19 succeeds */
  423. unsigned int tuning_count; /* Timer count for re-tuning */
  424. unsigned int tuning_mode; /* Re-tuning mode supported by host */
  425. #define SDHCI_TUNING_MODE_1 0
  426. unsigned long private[0] ____cacheline_aligned;
  427. };
  428. struct sdhci_ops {
  429. #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
  430. u32 (*read_l)(struct sdhci_host *host, int reg);
  431. u16 (*read_w)(struct sdhci_host *host, int reg);
  432. u8 (*read_b)(struct sdhci_host *host, int reg);
  433. void (*write_l)(struct sdhci_host *host, u32 val, int reg);
  434. void (*write_w)(struct sdhci_host *host, u16 val, int reg);
  435. void (*write_b)(struct sdhci_host *host, u8 val, int reg);
  436. #endif
  437. void (*set_clock)(struct sdhci_host *host, unsigned int clock);
  438. int (*enable_dma)(struct sdhci_host *host);
  439. unsigned int (*get_max_clock)(struct sdhci_host *host);
  440. unsigned int (*get_min_clock)(struct sdhci_host *host);
  441. unsigned int (*get_timeout_clock)(struct sdhci_host *host);
  442. unsigned int (*get_max_timeout_count)(struct sdhci_host *host);
  443. void (*set_timeout)(struct sdhci_host *host,
  444. struct mmc_command *cmd);
  445. void (*set_bus_width)(struct sdhci_host *host, int width);
  446. void (*platform_send_init_74_clocks)(struct sdhci_host *host,
  447. u8 power_mode);
  448. unsigned int (*get_ro)(struct sdhci_host *host);
  449. void (*reset)(struct sdhci_host *host, u8 mask);
  450. int (*platform_execute_tuning)(struct sdhci_host *host, u32 opcode);
  451. void (*set_uhs_signaling)(struct sdhci_host *host, unsigned int uhs);
  452. void (*hw_reset)(struct sdhci_host *host);
  453. void (*adma_workaround)(struct sdhci_host *host, u32 intmask);
  454. void (*platform_init)(struct sdhci_host *host);
  455. void (*card_event)(struct sdhci_host *host);
  456. void (*voltage_switch)(struct sdhci_host *host);
  457. int (*select_drive_strength)(struct sdhci_host *host,
  458. struct mmc_card *card,
  459. unsigned int max_dtr, int host_drv,
  460. int card_drv, int *drv_type);
  461. };
  462. #ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
  463. static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
  464. {
  465. if (unlikely(host->ops->write_l))
  466. host->ops->write_l(host, val, reg);
  467. else
  468. writel(val, host->ioaddr + reg);
  469. }
  470. static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
  471. {
  472. if (unlikely(host->ops->write_w))
  473. host->ops->write_w(host, val, reg);
  474. else
  475. writew(val, host->ioaddr + reg);
  476. }
  477. static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
  478. {
  479. if (unlikely(host->ops->write_b))
  480. host->ops->write_b(host, val, reg);
  481. else
  482. writeb(val, host->ioaddr + reg);
  483. }
  484. static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
  485. {
  486. if (unlikely(host->ops->read_l))
  487. return host->ops->read_l(host, reg);
  488. else
  489. return readl(host->ioaddr + reg);
  490. }
  491. static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
  492. {
  493. if (unlikely(host->ops->read_w))
  494. return host->ops->read_w(host, reg);
  495. else
  496. return readw(host->ioaddr + reg);
  497. }
  498. static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
  499. {
  500. if (unlikely(host->ops->read_b))
  501. return host->ops->read_b(host, reg);
  502. else
  503. return readb(host->ioaddr + reg);
  504. }
  505. #else
  506. static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
  507. {
  508. writel(val, host->ioaddr + reg);
  509. }
  510. static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
  511. {
  512. writew(val, host->ioaddr + reg);
  513. }
  514. static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
  515. {
  516. writeb(val, host->ioaddr + reg);
  517. }
  518. static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
  519. {
  520. return readl(host->ioaddr + reg);
  521. }
  522. static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
  523. {
  524. return readw(host->ioaddr + reg);
  525. }
  526. static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
  527. {
  528. return readb(host->ioaddr + reg);
  529. }
  530. #endif /* CONFIG_MMC_SDHCI_IO_ACCESSORS */
  531. extern struct sdhci_host *sdhci_alloc_host(struct device *dev,
  532. size_t priv_size);
  533. extern void sdhci_free_host(struct sdhci_host *host);
  534. static inline void *sdhci_priv(struct sdhci_host *host)
  535. {
  536. return (void *)host->private;
  537. }
  538. extern void sdhci_card_detect(struct sdhci_host *host);
  539. extern int sdhci_add_host(struct sdhci_host *host);
  540. extern void sdhci_remove_host(struct sdhci_host *host, int dead);
  541. extern void sdhci_send_command(struct sdhci_host *host,
  542. struct mmc_command *cmd);
  543. static inline bool sdhci_sdio_irq_enabled(struct sdhci_host *host)
  544. {
  545. return !!(host->flags & SDHCI_SDIO_IRQ_ENABLED);
  546. }
  547. void sdhci_set_clock(struct sdhci_host *host, unsigned int clock);
  548. void sdhci_set_bus_width(struct sdhci_host *host, int width);
  549. void sdhci_reset(struct sdhci_host *host, u8 mask);
  550. void sdhci_set_uhs_signaling(struct sdhci_host *host, unsigned timing);
  551. #ifdef CONFIG_PM
  552. extern int sdhci_suspend_host(struct sdhci_host *host);
  553. extern int sdhci_resume_host(struct sdhci_host *host);
  554. extern void sdhci_enable_irq_wakeups(struct sdhci_host *host);
  555. extern int sdhci_runtime_suspend_host(struct sdhci_host *host);
  556. extern int sdhci_runtime_resume_host(struct sdhci_host *host);
  557. #endif
  558. #endif /* __SDHCI_HW_H */