mmc.h 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright 2008,2010 Freescale Semiconductor, Inc
  4. * Andy Fleming
  5. *
  6. * Based (loosely) on the Linux code
  7. */
  8. #ifndef _MMC_H_
  9. #define _MMC_H_
  10. #include <linux/bitops.h>
  11. #include <linux/list.h>
  12. #include <linux/sizes.h>
  13. #include <linux/compiler.h>
  14. #include <linux/dma-direction.h>
  15. #include <part.h>
  16. struct bd_info;
  17. #if CONFIG_IS_ENABLED(MMC_HS200_SUPPORT)
  18. #define MMC_SUPPORTS_TUNING
  19. #endif
  20. #if CONFIG_IS_ENABLED(MMC_UHS_SUPPORT)
  21. #define MMC_SUPPORTS_TUNING
  22. #endif
  23. /* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
  24. #define SD_VERSION_SD (1U << 31)
  25. #define MMC_VERSION_MMC (1U << 30)
  26. #define MAKE_SDMMC_VERSION(a, b, c) \
  27. ((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c))
  28. #define MAKE_SD_VERSION(a, b, c) \
  29. (SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c))
  30. #define MAKE_MMC_VERSION(a, b, c) \
  31. (MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c))
  32. #define EXTRACT_SDMMC_MAJOR_VERSION(x) \
  33. (((u32)(x) >> 16) & 0xff)
  34. #define EXTRACT_SDMMC_MINOR_VERSION(x) \
  35. (((u32)(x) >> 8) & 0xff)
  36. #define EXTRACT_SDMMC_CHANGE_VERSION(x) \
  37. ((u32)(x) & 0xff)
  38. #define SD_VERSION_3 MAKE_SD_VERSION(3, 0, 0)
  39. #define SD_VERSION_2 MAKE_SD_VERSION(2, 0, 0)
  40. #define SD_VERSION_1_0 MAKE_SD_VERSION(1, 0, 0)
  41. #define SD_VERSION_1_10 MAKE_SD_VERSION(1, 10, 0)
  42. #define MMC_VERSION_UNKNOWN MAKE_MMC_VERSION(0, 0, 0)
  43. #define MMC_VERSION_1_2 MAKE_MMC_VERSION(1, 2, 0)
  44. #define MMC_VERSION_1_4 MAKE_MMC_VERSION(1, 4, 0)
  45. #define MMC_VERSION_2_2 MAKE_MMC_VERSION(2, 2, 0)
  46. #define MMC_VERSION_3 MAKE_MMC_VERSION(3, 0, 0)
  47. #define MMC_VERSION_4 MAKE_MMC_VERSION(4, 0, 0)
  48. #define MMC_VERSION_4_1 MAKE_MMC_VERSION(4, 1, 0)
  49. #define MMC_VERSION_4_2 MAKE_MMC_VERSION(4, 2, 0)
  50. #define MMC_VERSION_4_3 MAKE_MMC_VERSION(4, 3, 0)
  51. #define MMC_VERSION_4_4 MAKE_MMC_VERSION(4, 4, 0)
  52. #define MMC_VERSION_4_41 MAKE_MMC_VERSION(4, 4, 1)
  53. #define MMC_VERSION_4_5 MAKE_MMC_VERSION(4, 5, 0)
  54. #define MMC_VERSION_5_0 MAKE_MMC_VERSION(5, 0, 0)
  55. #define MMC_VERSION_5_1 MAKE_MMC_VERSION(5, 1, 0)
  56. #define MMC_CAP(mode) (1 << mode)
  57. #define MMC_MODE_HS (MMC_CAP(MMC_HS) | MMC_CAP(SD_HS))
  58. #define MMC_MODE_HS_52MHz MMC_CAP(MMC_HS_52)
  59. #define MMC_MODE_DDR_52MHz MMC_CAP(MMC_DDR_52)
  60. #define MMC_MODE_HS200 MMC_CAP(MMC_HS_200)
  61. #define MMC_MODE_HS400 MMC_CAP(MMC_HS_400)
  62. #define MMC_MODE_HS400_ES MMC_CAP(MMC_HS_400_ES)
  63. #define MMC_CAP_NONREMOVABLE BIT(14)
  64. #define MMC_CAP_NEEDS_POLL BIT(15)
  65. #define MMC_CAP_CD_ACTIVE_HIGH BIT(16)
  66. #define MMC_MODE_8BIT BIT(30)
  67. #define MMC_MODE_4BIT BIT(29)
  68. #define MMC_MODE_1BIT BIT(28)
  69. #define MMC_MODE_SPI BIT(27)
  70. #define SD_DATA_4BIT 0x00040000
  71. #define IS_SD(x) ((x)->version & SD_VERSION_SD)
  72. #define IS_MMC(x) ((x)->version & MMC_VERSION_MMC)
  73. #define MMC_DATA_READ 1
  74. #define MMC_DATA_WRITE 2
  75. #define MMC_CMD_GO_IDLE_STATE 0
  76. #define MMC_CMD_SEND_OP_COND 1
  77. #define MMC_CMD_ALL_SEND_CID 2
  78. #define MMC_CMD_SET_RELATIVE_ADDR 3
  79. #define MMC_CMD_SET_DSR 4
  80. #define MMC_CMD_SWITCH 6
  81. #define MMC_CMD_SELECT_CARD 7
  82. #define MMC_CMD_SEND_EXT_CSD 8
  83. #define MMC_CMD_SEND_CSD 9
  84. #define MMC_CMD_SEND_CID 10
  85. #define MMC_CMD_STOP_TRANSMISSION 12
  86. #define MMC_CMD_SEND_STATUS 13
  87. #define MMC_CMD_SET_BLOCKLEN 16
  88. #define MMC_CMD_READ_SINGLE_BLOCK 17
  89. #define MMC_CMD_READ_MULTIPLE_BLOCK 18
  90. #define MMC_CMD_SEND_TUNING_BLOCK 19
  91. #define MMC_CMD_SEND_TUNING_BLOCK_HS200 21
  92. #define MMC_CMD_SET_BLOCK_COUNT 23
  93. #define MMC_CMD_WRITE_SINGLE_BLOCK 24
  94. #define MMC_CMD_WRITE_MULTIPLE_BLOCK 25
  95. #define MMC_CMD_ERASE_GROUP_START 35
  96. #define MMC_CMD_ERASE_GROUP_END 36
  97. #define MMC_CMD_ERASE 38
  98. #define MMC_CMD_APP_CMD 55
  99. #define MMC_CMD_SPI_READ_OCR 58
  100. #define MMC_CMD_SPI_CRC_ON_OFF 59
  101. #define MMC_CMD_RES_MAN 62
  102. #define MMC_CMD62_ARG1 0xefac62ec
  103. #define MMC_CMD62_ARG2 0xcbaea7
  104. #define SD_CMD_SEND_RELATIVE_ADDR 3
  105. #define SD_CMD_SWITCH_FUNC 6
  106. #define SD_CMD_SEND_IF_COND 8
  107. #define SD_CMD_SWITCH_UHS18V 11
  108. #define SD_CMD_APP_SET_BUS_WIDTH 6
  109. #define SD_CMD_APP_SD_STATUS 13
  110. #define SD_CMD_ERASE_WR_BLK_START 32
  111. #define SD_CMD_ERASE_WR_BLK_END 33
  112. #define SD_CMD_APP_SEND_OP_COND 41
  113. #define SD_CMD_APP_SEND_SCR 51
  114. static inline bool mmc_is_tuning_cmd(uint cmdidx)
  115. {
  116. if ((cmdidx == MMC_CMD_SEND_TUNING_BLOCK_HS200) ||
  117. (cmdidx == MMC_CMD_SEND_TUNING_BLOCK))
  118. return true;
  119. return false;
  120. }
  121. /* SCR definitions in different words */
  122. #define SD_HIGHSPEED_BUSY 0x00020000
  123. #define SD_HIGHSPEED_SUPPORTED 0x00020000
  124. #define UHS_SDR12_BUS_SPEED 0
  125. #define HIGH_SPEED_BUS_SPEED 1
  126. #define UHS_SDR25_BUS_SPEED 1
  127. #define UHS_SDR50_BUS_SPEED 2
  128. #define UHS_SDR104_BUS_SPEED 3
  129. #define UHS_DDR50_BUS_SPEED 4
  130. #define SD_MODE_UHS_SDR12 BIT(UHS_SDR12_BUS_SPEED)
  131. #define SD_MODE_UHS_SDR25 BIT(UHS_SDR25_BUS_SPEED)
  132. #define SD_MODE_UHS_SDR50 BIT(UHS_SDR50_BUS_SPEED)
  133. #define SD_MODE_UHS_SDR104 BIT(UHS_SDR104_BUS_SPEED)
  134. #define SD_MODE_UHS_DDR50 BIT(UHS_DDR50_BUS_SPEED)
  135. #define OCR_BUSY 0x80000000
  136. #define OCR_HCS 0x40000000
  137. #define OCR_S18R 0x1000000
  138. #define OCR_VOLTAGE_MASK 0x007FFF80
  139. #define OCR_ACCESS_MODE 0x60000000
  140. #define MMC_ERASE_ARG 0x00000000
  141. #define MMC_SECURE_ERASE_ARG 0x80000000
  142. #define MMC_TRIM_ARG 0x00000001
  143. #define MMC_DISCARD_ARG 0x00000003
  144. #define MMC_SECURE_TRIM1_ARG 0x80000001
  145. #define MMC_SECURE_TRIM2_ARG 0x80008000
  146. #define MMC_STATUS_MASK (~0x0206BF7F)
  147. #define MMC_STATUS_SWITCH_ERROR (1 << 7)
  148. #define MMC_STATUS_RDY_FOR_DATA (1 << 8)
  149. #define MMC_STATUS_CURR_STATE (0xf << 9)
  150. #define MMC_STATUS_ERROR (1 << 19)
  151. #define MMC_STATE_PRG (7 << 9)
  152. #define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
  153. #define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
  154. #define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
  155. #define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
  156. #define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
  157. #define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
  158. #define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
  159. #define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
  160. #define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
  161. #define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
  162. #define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
  163. #define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
  164. #define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
  165. #define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
  166. #define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
  167. #define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
  168. #define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
  169. #define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
  170. #define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits in EXT_CSD byte
  171. addressed by index which are
  172. 1 in value field */
  173. #define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits in EXT_CSD byte
  174. addressed by index, which are
  175. 1 in value field */
  176. #define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target byte to value */
  177. #define SD_SWITCH_CHECK 0
  178. #define SD_SWITCH_SWITCH 1
  179. /*
  180. * EXT_CSD fields
  181. */
  182. #define EXT_CSD_ENH_START_ADDR 136 /* R/W */
  183. #define EXT_CSD_ENH_SIZE_MULT 140 /* R/W */
  184. #define EXT_CSD_GP_SIZE_MULT 143 /* R/W */
  185. #define EXT_CSD_PARTITION_SETTING 155 /* R/W */
  186. #define EXT_CSD_PARTITIONS_ATTRIBUTE 156 /* R/W */
  187. #define EXT_CSD_MAX_ENH_SIZE_MULT 157 /* R */
  188. #define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */
  189. #define EXT_CSD_RST_N_FUNCTION 162 /* R/W */
  190. #define EXT_CSD_BKOPS_EN 163 /* R/W & R/W/E */
  191. #define EXT_CSD_WR_REL_PARAM 166 /* R */
  192. #define EXT_CSD_WR_REL_SET 167 /* R/W */
  193. #define EXT_CSD_RPMB_MULT 168 /* RO */
  194. #define EXT_CSD_USER_WP 171 /* R/W & R/W/C_P & R/W/E_P */
  195. #define EXT_CSD_BOOT_WP 173 /* R/W & R/W/C_P */
  196. #define EXT_CSD_BOOT_WP_STATUS 174 /* R */
  197. #define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
  198. #define EXT_CSD_BOOT_BUS_WIDTH 177
  199. #define EXT_CSD_PART_CONF 179 /* R/W */
  200. #define EXT_CSD_BUS_WIDTH 183 /* R/W */
  201. #define EXT_CSD_STROBE_SUPPORT 184 /* R/W */
  202. #define EXT_CSD_HS_TIMING 185 /* R/W */
  203. #define EXT_CSD_REV 192 /* RO */
  204. #define EXT_CSD_CARD_TYPE 196 /* RO */
  205. #define EXT_CSD_PART_SWITCH_TIME 199 /* RO */
  206. #define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
  207. #define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */
  208. #define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
  209. #define EXT_CSD_BOOT_MULT 226 /* RO */
  210. #define EXT_CSD_GENERIC_CMD6_TIME 248 /* RO */
  211. #define EXT_CSD_BKOPS_SUPPORT 502 /* RO */
  212. /*
  213. * EXT_CSD field definitions
  214. */
  215. #define EXT_CSD_CMD_SET_NORMAL (1 << 0)
  216. #define EXT_CSD_CMD_SET_SECURE (1 << 1)
  217. #define EXT_CSD_CMD_SET_CPSECURE (1 << 2)
  218. #define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */
  219. #define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */
  220. #define EXT_CSD_CARD_TYPE_DDR_1_8V (1 << 2)
  221. #define EXT_CSD_CARD_TYPE_DDR_1_2V (1 << 3)
  222. #define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \
  223. | EXT_CSD_CARD_TYPE_DDR_1_2V)
  224. #define EXT_CSD_CARD_TYPE_HS200_1_8V BIT(4) /* Card can run at 200MHz */
  225. /* SDR mode @1.8V I/O */
  226. #define EXT_CSD_CARD_TYPE_HS200_1_2V BIT(5) /* Card can run at 200MHz */
  227. /* SDR mode @1.2V I/O */
  228. #define EXT_CSD_CARD_TYPE_HS200 (EXT_CSD_CARD_TYPE_HS200_1_8V | \
  229. EXT_CSD_CARD_TYPE_HS200_1_2V)
  230. #define EXT_CSD_CARD_TYPE_HS400_1_8V BIT(6)
  231. #define EXT_CSD_CARD_TYPE_HS400_1_2V BIT(7)
  232. #define EXT_CSD_CARD_TYPE_HS400 (EXT_CSD_CARD_TYPE_HS400_1_8V | \
  233. EXT_CSD_CARD_TYPE_HS400_1_2V)
  234. #define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
  235. #define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
  236. #define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
  237. #define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */
  238. #define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */
  239. #define EXT_CSD_DDR_FLAG BIT(2) /* Flag for DDR mode */
  240. #define EXT_CSD_BUS_WIDTH_STROBE BIT(7) /* Enhanced strobe mode */
  241. #define EXT_CSD_TIMING_LEGACY 0 /* no high speed */
  242. #define EXT_CSD_TIMING_HS 1 /* HS */
  243. #define EXT_CSD_TIMING_HS200 2 /* HS200 */
  244. #define EXT_CSD_TIMING_HS400 3 /* HS400 */
  245. #define EXT_CSD_DRV_STR_SHIFT 4 /* Driver Strength shift */
  246. #define EXT_CSD_BOOT_ACK_ENABLE (1 << 6)
  247. #define EXT_CSD_BOOT_PARTITION_ENABLE (1 << 3)
  248. #define EXT_CSD_PARTITION_ACCESS_ENABLE (1 << 0)
  249. #define EXT_CSD_PARTITION_ACCESS_DISABLE (0 << 0)
  250. #define EXT_CSD_BOOT_ACK(x) (x << 6)
  251. #define EXT_CSD_BOOT_PART_NUM(x) (x << 3)
  252. #define EXT_CSD_PARTITION_ACCESS(x) (x << 0)
  253. #define EXT_CSD_EXTRACT_BOOT_ACK(x) (((x) >> 6) & 0x1)
  254. #define EXT_CSD_EXTRACT_BOOT_PART(x) (((x) >> 3) & 0x7)
  255. #define EXT_CSD_EXTRACT_PARTITION_ACCESS(x) ((x) & 0x7)
  256. #define EXT_CSD_BOOT_BUS_WIDTH_MODE(x) (x << 3)
  257. #define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2)
  258. #define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x)
  259. #define EXT_CSD_PARTITION_SETTING_COMPLETED (1 << 0)
  260. #define EXT_CSD_ENH_USR (1 << 0) /* user data area is enhanced */
  261. #define EXT_CSD_ENH_GP(x) (1 << ((x)+1)) /* GP part (x+1) is enhanced */
  262. #define EXT_CSD_HS_CTRL_REL (1 << 0) /* host controlled WR_REL_SET */
  263. #define EXT_CSD_WR_DATA_REL_USR (1 << 0) /* user data area WR_REL */
  264. #define EXT_CSD_WR_DATA_REL_GP(x) (1 << ((x)+1)) /* GP part (x+1) WR_REL */
  265. #define R1_ILLEGAL_COMMAND (1 << 22)
  266. #define R1_APP_CMD (1 << 5)
  267. #define MMC_RSP_PRESENT (1 << 0)
  268. #define MMC_RSP_136 (1 << 1) /* 136 bit response */
  269. #define MMC_RSP_CRC (1 << 2) /* expect valid crc */
  270. #define MMC_RSP_BUSY (1 << 3) /* card may send busy */
  271. #define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
  272. #define MMC_RSP_NONE (0)
  273. #define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
  274. #define MMC_RSP_R1b (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
  275. MMC_RSP_BUSY)
  276. #define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
  277. #define MMC_RSP_R3 (MMC_RSP_PRESENT)
  278. #define MMC_RSP_R4 (MMC_RSP_PRESENT)
  279. #define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
  280. #define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
  281. #define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
  282. #define MMCPART_NOAVAILABLE (0xff)
  283. #define PART_ACCESS_MASK (0x7)
  284. #define PART_SUPPORT (0x1)
  285. #define ENHNCD_SUPPORT (0x2)
  286. #define PART_ENH_ATTRIB (0x1f)
  287. #define MMC_QUIRK_RETRY_SEND_CID BIT(0)
  288. #define MMC_QUIRK_RETRY_SET_BLOCKLEN BIT(1)
  289. #define MMC_QUIRK_RETRY_APP_CMD BIT(2)
  290. enum mmc_voltage {
  291. MMC_SIGNAL_VOLTAGE_000 = 0,
  292. MMC_SIGNAL_VOLTAGE_120 = 1,
  293. MMC_SIGNAL_VOLTAGE_180 = 2,
  294. MMC_SIGNAL_VOLTAGE_330 = 4,
  295. };
  296. #define MMC_ALL_SIGNAL_VOLTAGE (MMC_SIGNAL_VOLTAGE_120 |\
  297. MMC_SIGNAL_VOLTAGE_180 |\
  298. MMC_SIGNAL_VOLTAGE_330)
  299. /* Maximum block size for MMC */
  300. #define MMC_MAX_BLOCK_LEN 512
  301. /* The number of MMC physical partitions. These consist of:
  302. * boot partitions (2), general purpose partitions (4) in MMC v4.4.
  303. */
  304. #define MMC_NUM_BOOT_PARTITION 2
  305. #define MMC_PART_RPMB 3 /* RPMB partition number */
  306. /* Driver model support */
  307. /**
  308. * struct mmc_uclass_priv - Holds information about a device used by the uclass
  309. */
  310. struct mmc_uclass_priv {
  311. struct mmc *mmc;
  312. };
  313. /**
  314. * mmc_get_mmc_dev() - get the MMC struct pointer for a device
  315. *
  316. * Provided that the device is already probed and ready for use, this value
  317. * will be available.
  318. *
  319. * @dev: Device
  320. * @return associated mmc struct pointer if available, else NULL
  321. */
  322. struct mmc *mmc_get_mmc_dev(const struct udevice *dev);
  323. /* End of driver model support */
  324. struct mmc_cid {
  325. unsigned long psn;
  326. unsigned short oid;
  327. unsigned char mid;
  328. unsigned char prv;
  329. unsigned char mdt;
  330. char pnm[7];
  331. };
  332. struct mmc_cmd {
  333. ushort cmdidx;
  334. uint resp_type;
  335. uint cmdarg;
  336. uint response[4];
  337. };
  338. struct mmc_data {
  339. union {
  340. char *dest;
  341. const char *src; /* src buffers don't get written to */
  342. };
  343. uint flags;
  344. uint blocks;
  345. uint blocksize;
  346. };
  347. /* forward decl. */
  348. struct mmc;
  349. #if CONFIG_IS_ENABLED(DM_MMC)
  350. struct dm_mmc_ops {
  351. /**
  352. * deferred_probe() - Some configurations that need to be deferred
  353. * to just before enumerating the device
  354. *
  355. * @dev: Device to init
  356. * @return 0 if Ok, -ve if error
  357. */
  358. int (*deferred_probe)(struct udevice *dev);
  359. /**
  360. * send_cmd() - Send a command to the MMC device
  361. *
  362. * @dev: Device to receive the command
  363. * @cmd: Command to send
  364. * @data: Additional data to send/receive
  365. * @return 0 if OK, -ve on error
  366. */
  367. int (*send_cmd)(struct udevice *dev, struct mmc_cmd *cmd,
  368. struct mmc_data *data);
  369. /**
  370. * set_ios() - Set the I/O speed/width for an MMC device
  371. *
  372. * @dev: Device to update
  373. * @return 0 if OK, -ve on error
  374. */
  375. int (*set_ios)(struct udevice *dev);
  376. /**
  377. * get_cd() - See whether a card is present
  378. *
  379. * @dev: Device to check
  380. * @return 0 if not present, 1 if present, -ve on error
  381. */
  382. int (*get_cd)(struct udevice *dev);
  383. /**
  384. * get_wp() - See whether a card has write-protect enabled
  385. *
  386. * @dev: Device to check
  387. * @return 0 if write-enabled, 1 if write-protected, -ve on error
  388. */
  389. int (*get_wp)(struct udevice *dev);
  390. #ifdef MMC_SUPPORTS_TUNING
  391. /**
  392. * execute_tuning() - Start the tuning process
  393. *
  394. * @dev: Device to start the tuning
  395. * @opcode: Command opcode to send
  396. * @return 0 if OK, -ve on error
  397. */
  398. int (*execute_tuning)(struct udevice *dev, uint opcode);
  399. #endif
  400. /**
  401. * wait_dat0() - wait until dat0 is in the target state
  402. * (CLK must be running during the wait)
  403. *
  404. * @dev: Device to check
  405. * @state: target state
  406. * @timeout_us: timeout in us
  407. * @return 0 if dat0 is in the target state, -ve on error
  408. */
  409. int (*wait_dat0)(struct udevice *dev, int state, int timeout_us);
  410. #if CONFIG_IS_ENABLED(MMC_HS400_ES_SUPPORT)
  411. /* set_enhanced_strobe() - set HS400 enhanced strobe */
  412. int (*set_enhanced_strobe)(struct udevice *dev);
  413. #endif
  414. /**
  415. * host_power_cycle - host specific tasks in power cycle sequence
  416. * Called between mmc_power_off() and
  417. * mmc_power_on()
  418. *
  419. * @dev: Device to check
  420. * @return 0 if not present, 1 if present, -ve on error
  421. */
  422. int (*host_power_cycle)(struct udevice *dev);
  423. /**
  424. * get_b_max - get maximum length of single transfer
  425. * Called before reading blocks from the card,
  426. * useful for system which have e.g. DMA limits
  427. * on various memory ranges.
  428. *
  429. * @dev: Device to check
  430. * @dst: Destination buffer in memory
  431. * @blkcnt: Total number of blocks in this transfer
  432. * @return maximum number of blocks for this transfer
  433. */
  434. int (*get_b_max)(struct udevice *dev, void *dst, lbaint_t blkcnt);
  435. };
  436. #define mmc_get_ops(dev) ((struct dm_mmc_ops *)(dev)->driver->ops)
  437. int dm_mmc_send_cmd(struct udevice *dev, struct mmc_cmd *cmd,
  438. struct mmc_data *data);
  439. int dm_mmc_set_ios(struct udevice *dev);
  440. int dm_mmc_get_cd(struct udevice *dev);
  441. int dm_mmc_get_wp(struct udevice *dev);
  442. int dm_mmc_execute_tuning(struct udevice *dev, uint opcode);
  443. int dm_mmc_wait_dat0(struct udevice *dev, int state, int timeout_us);
  444. int dm_mmc_host_power_cycle(struct udevice *dev);
  445. int dm_mmc_deferred_probe(struct udevice *dev);
  446. int dm_mmc_get_b_max(struct udevice *dev, void *dst, lbaint_t blkcnt);
  447. /* Transition functions for compatibility */
  448. int mmc_set_ios(struct mmc *mmc);
  449. int mmc_getcd(struct mmc *mmc);
  450. int mmc_getwp(struct mmc *mmc);
  451. int mmc_execute_tuning(struct mmc *mmc, uint opcode);
  452. int mmc_wait_dat0(struct mmc *mmc, int state, int timeout_us);
  453. int mmc_set_enhanced_strobe(struct mmc *mmc);
  454. int mmc_host_power_cycle(struct mmc *mmc);
  455. int mmc_deferred_probe(struct mmc *mmc);
  456. int mmc_get_b_max(struct mmc *mmc, void *dst, lbaint_t blkcnt);
  457. #else
  458. struct mmc_ops {
  459. int (*send_cmd)(struct mmc *mmc,
  460. struct mmc_cmd *cmd, struct mmc_data *data);
  461. int (*set_ios)(struct mmc *mmc);
  462. int (*init)(struct mmc *mmc);
  463. int (*getcd)(struct mmc *mmc);
  464. int (*getwp)(struct mmc *mmc);
  465. int (*host_power_cycle)(struct mmc *mmc);
  466. int (*get_b_max)(struct mmc *mmc, void *dst, lbaint_t blkcnt);
  467. };
  468. #endif
  469. struct mmc_config {
  470. const char *name;
  471. #if !CONFIG_IS_ENABLED(DM_MMC)
  472. const struct mmc_ops *ops;
  473. #endif
  474. uint host_caps;
  475. uint voltages;
  476. uint f_min;
  477. uint f_max;
  478. uint b_max;
  479. unsigned char part_type;
  480. };
  481. struct sd_ssr {
  482. unsigned int au; /* In sectors */
  483. unsigned int erase_timeout; /* In milliseconds */
  484. unsigned int erase_offset; /* In milliseconds */
  485. };
  486. enum bus_mode {
  487. MMC_LEGACY,
  488. MMC_HS,
  489. SD_HS,
  490. MMC_HS_52,
  491. MMC_DDR_52,
  492. UHS_SDR12,
  493. UHS_SDR25,
  494. UHS_SDR50,
  495. UHS_DDR50,
  496. UHS_SDR104,
  497. MMC_HS_200,
  498. MMC_HS_400,
  499. MMC_HS_400_ES,
  500. MMC_MODES_END
  501. };
  502. const char *mmc_mode_name(enum bus_mode mode);
  503. void mmc_dump_capabilities(const char *text, uint caps);
  504. static inline bool mmc_is_mode_ddr(enum bus_mode mode)
  505. {
  506. if (mode == MMC_DDR_52)
  507. return true;
  508. #if CONFIG_IS_ENABLED(MMC_UHS_SUPPORT)
  509. else if (mode == UHS_DDR50)
  510. return true;
  511. #endif
  512. #if CONFIG_IS_ENABLED(MMC_HS400_SUPPORT)
  513. else if (mode == MMC_HS_400)
  514. return true;
  515. #endif
  516. #if CONFIG_IS_ENABLED(MMC_HS400_ES_SUPPORT)
  517. else if (mode == MMC_HS_400_ES)
  518. return true;
  519. #endif
  520. else
  521. return false;
  522. }
  523. #define UHS_CAPS (MMC_CAP(UHS_SDR12) | MMC_CAP(UHS_SDR25) | \
  524. MMC_CAP(UHS_SDR50) | MMC_CAP(UHS_SDR104) | \
  525. MMC_CAP(UHS_DDR50))
  526. static inline bool supports_uhs(uint caps)
  527. {
  528. #if CONFIG_IS_ENABLED(MMC_UHS_SUPPORT)
  529. return (caps & UHS_CAPS) ? true : false;
  530. #else
  531. return false;
  532. #endif
  533. }
  534. /*
  535. * With CONFIG_DM_MMC enabled, struct mmc can be accessed from the MMC device
  536. * with mmc_get_mmc_dev().
  537. *
  538. * TODO struct mmc should be in mmc_private but it's hard to fix right now
  539. */
  540. struct mmc {
  541. #if !CONFIG_IS_ENABLED(BLK)
  542. struct list_head link;
  543. #endif
  544. const struct mmc_config *cfg; /* provided configuration */
  545. uint version;
  546. void *priv;
  547. uint has_init;
  548. int high_capacity;
  549. bool clk_disable; /* true if the clock can be turned off */
  550. uint bus_width;
  551. uint clock;
  552. uint saved_clock;
  553. enum mmc_voltage signal_voltage;
  554. uint card_caps;
  555. uint host_caps;
  556. uint ocr;
  557. uint dsr;
  558. uint dsr_imp;
  559. uint scr[2];
  560. uint csd[4];
  561. uint cid[4];
  562. ushort rca;
  563. u8 part_support;
  564. u8 part_attr;
  565. u8 wr_rel_set;
  566. u8 part_config;
  567. u8 gen_cmd6_time; /* units: 10 ms */
  568. u8 part_switch_time; /* units: 10 ms */
  569. uint tran_speed;
  570. uint legacy_speed; /* speed for the legacy mode provided by the card */
  571. uint read_bl_len;
  572. #if CONFIG_IS_ENABLED(MMC_WRITE)
  573. uint write_bl_len;
  574. uint erase_grp_size; /* in 512-byte sectors */
  575. #endif
  576. #if CONFIG_IS_ENABLED(MMC_HW_PARTITIONING)
  577. uint hc_wp_grp_size; /* in 512-byte sectors */
  578. #endif
  579. #if CONFIG_IS_ENABLED(MMC_WRITE)
  580. struct sd_ssr ssr; /* SD status register */
  581. #endif
  582. u64 capacity;
  583. u64 capacity_user;
  584. u64 capacity_boot;
  585. u64 capacity_rpmb;
  586. u64 capacity_gp[4];
  587. #ifndef CONFIG_SPL_BUILD
  588. u64 enh_user_start;
  589. u64 enh_user_size;
  590. #endif
  591. #if !CONFIG_IS_ENABLED(BLK)
  592. struct blk_desc block_dev;
  593. #endif
  594. char op_cond_pending; /* 1 if we are waiting on an op_cond command */
  595. char init_in_progress; /* 1 if we have done mmc_start_init() */
  596. char preinit; /* start init as early as possible */
  597. int ddr_mode;
  598. #if CONFIG_IS_ENABLED(DM_MMC)
  599. struct udevice *dev; /* Device for this MMC controller */
  600. #if CONFIG_IS_ENABLED(DM_REGULATOR)
  601. struct udevice *vmmc_supply; /* Main voltage regulator (Vcc)*/
  602. struct udevice *vqmmc_supply; /* IO voltage regulator (Vccq)*/
  603. #endif
  604. #endif
  605. u8 *ext_csd;
  606. u32 cardtype; /* cardtype read from the MMC */
  607. enum mmc_voltage current_voltage;
  608. enum bus_mode selected_mode; /* mode currently used */
  609. enum bus_mode best_mode; /* best mode is the supported mode with the
  610. * highest bandwidth. It may not always be the
  611. * operating mode due to limitations when
  612. * accessing the boot partitions
  613. */
  614. u32 quirks;
  615. };
  616. struct mmc_hwpart_conf {
  617. struct {
  618. uint enh_start; /* in 512-byte sectors */
  619. uint enh_size; /* in 512-byte sectors, if 0 no enh area */
  620. unsigned wr_rel_change : 1;
  621. unsigned wr_rel_set : 1;
  622. } user;
  623. struct {
  624. uint size; /* in 512-byte sectors */
  625. unsigned enhanced : 1;
  626. unsigned wr_rel_change : 1;
  627. unsigned wr_rel_set : 1;
  628. } gp_part[4];
  629. };
  630. enum mmc_hwpart_conf_mode {
  631. MMC_HWPART_CONF_CHECK,
  632. MMC_HWPART_CONF_SET,
  633. MMC_HWPART_CONF_COMPLETE,
  634. };
  635. struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
  636. /**
  637. * mmc_bind() - Set up a new MMC device ready for probing
  638. *
  639. * A child block device is bound with the IF_TYPE_MMC interface type. This
  640. * allows the device to be used with CONFIG_BLK
  641. *
  642. * @dev: MMC device to set up
  643. * @mmc: MMC struct
  644. * @cfg: MMC configuration
  645. * @return 0 if OK, -ve on error
  646. */
  647. int mmc_bind(struct udevice *dev, struct mmc *mmc,
  648. const struct mmc_config *cfg);
  649. void mmc_destroy(struct mmc *mmc);
  650. /**
  651. * mmc_unbind() - Unbind a MMC device's child block device
  652. *
  653. * @dev: MMC device
  654. * @return 0 if OK, -ve on error
  655. */
  656. int mmc_unbind(struct udevice *dev);
  657. int mmc_initialize(struct bd_info *bis);
  658. int mmc_init_device(int num);
  659. int mmc_init(struct mmc *mmc);
  660. int mmc_send_tuning(struct mmc *mmc, u32 opcode, int *cmd_error);
  661. #if CONFIG_IS_ENABLED(MMC_UHS_SUPPORT) || \
  662. CONFIG_IS_ENABLED(MMC_HS200_SUPPORT) || \
  663. CONFIG_IS_ENABLED(MMC_HS400_SUPPORT)
  664. int mmc_deinit(struct mmc *mmc);
  665. #endif
  666. /**
  667. * mmc_of_parse() - Parse the device tree to get the capabilities of the host
  668. *
  669. * @dev: MMC device
  670. * @cfg: MMC configuration
  671. * @return 0 if OK, -ve on error
  672. */
  673. int mmc_of_parse(struct udevice *dev, struct mmc_config *cfg);
  674. int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
  675. /**
  676. * mmc_voltage_to_mv() - Convert a mmc_voltage in mV
  677. *
  678. * @voltage: The mmc_voltage to convert
  679. * @return the value in mV if OK, -EINVAL on error (invalid mmc_voltage value)
  680. */
  681. int mmc_voltage_to_mv(enum mmc_voltage voltage);
  682. /**
  683. * mmc_set_clock() - change the bus clock
  684. * @mmc: MMC struct
  685. * @clock: bus frequency in Hz
  686. * @disable: flag indicating if the clock must on or off
  687. * @return 0 if OK, -ve on error
  688. */
  689. int mmc_set_clock(struct mmc *mmc, uint clock, bool disable);
  690. #define MMC_CLK_ENABLE false
  691. #define MMC_CLK_DISABLE true
  692. struct mmc *find_mmc_device(int dev_num);
  693. int mmc_set_dev(int dev_num);
  694. void print_mmc_devices(char separator);
  695. /**
  696. * get_mmc_num() - get the total MMC device number
  697. *
  698. * @return 0 if there is no MMC device, else the number of devices
  699. */
  700. int get_mmc_num(void);
  701. int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
  702. int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
  703. enum mmc_hwpart_conf_mode mode);
  704. #if !CONFIG_IS_ENABLED(DM_MMC)
  705. int mmc_getcd(struct mmc *mmc);
  706. int board_mmc_getcd(struct mmc *mmc);
  707. int mmc_getwp(struct mmc *mmc);
  708. int board_mmc_getwp(struct mmc *mmc);
  709. #endif
  710. int mmc_set_dsr(struct mmc *mmc, u16 val);
  711. /* Function to change the size of boot partition and rpmb partitions */
  712. int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
  713. unsigned long rpmbsize);
  714. /* Function to modify the PARTITION_CONFIG field of EXT_CSD */
  715. int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
  716. /* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
  717. int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
  718. /* Function to modify the RST_n_FUNCTION field of EXT_CSD */
  719. int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
  720. /* Functions to read / write the RPMB partition */
  721. int mmc_rpmb_set_key(struct mmc *mmc, void *key);
  722. int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
  723. int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
  724. unsigned short cnt, unsigned char *key);
  725. int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
  726. unsigned short cnt, unsigned char *key);
  727. /**
  728. * mmc_rpmb_route_frames() - route RPMB data frames
  729. * @mmc Pointer to a MMC device struct
  730. * @req Request data frames
  731. * @reqlen Length of data frames in bytes
  732. * @rsp Supplied buffer for response data frames
  733. * @rsplen Length of supplied buffer for response data frames
  734. *
  735. * The RPMB data frames are routed to/from some external entity, for
  736. * example a Trusted Exectuion Environment in an arm TrustZone protected
  737. * secure world. It's expected that it's the external entity who is in
  738. * control of the RPMB key.
  739. *
  740. * Returns 0 on success, < 0 on error.
  741. */
  742. int mmc_rpmb_route_frames(struct mmc *mmc, void *req, unsigned long reqlen,
  743. void *rsp, unsigned long rsplen);
  744. #ifdef CONFIG_CMD_BKOPS_ENABLE
  745. int mmc_set_bkops_enable(struct mmc *mmc);
  746. #endif
  747. /**
  748. * Start device initialization and return immediately; it does not block on
  749. * polling OCR (operation condition register) status. Useful for checking
  750. * the presence of SD/eMMC when no card detect logic is available.
  751. *
  752. * @param mmc Pointer to a MMC device struct
  753. * @return 0 on success, <0 on error.
  754. */
  755. int mmc_get_op_cond(struct mmc *mmc);
  756. /**
  757. * Start device initialization and return immediately; it does not block on
  758. * polling OCR (operation condition register) status. Then you should call
  759. * mmc_init, which would block on polling OCR status and complete the device
  760. * initializatin.
  761. *
  762. * @param mmc Pointer to a MMC device struct
  763. * @return 0 on success, <0 on error.
  764. */
  765. int mmc_start_init(struct mmc *mmc);
  766. /**
  767. * Set preinit flag of mmc device.
  768. *
  769. * This will cause the device to be pre-inited during mmc_initialize(),
  770. * which may save boot time if the device is not accessed until later.
  771. * Some eMMC devices take 200-300ms to init, but unfortunately they
  772. * must be sent a series of commands to even get them to start preparing
  773. * for operation.
  774. *
  775. * @param mmc Pointer to a MMC device struct
  776. * @param preinit preinit flag value
  777. */
  778. void mmc_set_preinit(struct mmc *mmc, int preinit);
  779. #ifdef CONFIG_MMC_SPI
  780. #define mmc_host_is_spi(mmc) ((mmc)->cfg->host_caps & MMC_MODE_SPI)
  781. #else
  782. #define mmc_host_is_spi(mmc) 0
  783. #endif
  784. #define mmc_dev(x) ((x)->dev)
  785. void board_mmc_power_init(void);
  786. int board_mmc_init(struct bd_info *bis);
  787. int cpu_mmc_init(struct bd_info *bis);
  788. int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
  789. # ifdef CONFIG_SYS_MMC_ENV_PART
  790. extern uint mmc_get_env_part(struct mmc *mmc);
  791. # endif
  792. int mmc_get_env_dev(void);
  793. /* Minimum partition switch timeout in units of 10-milliseconds */
  794. #define MMC_MIN_PART_SWITCH_TIME 30 /* 300 ms */
  795. /* Set block count limit because of 16 bit register limit on some hardware*/
  796. #ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
  797. #define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
  798. #endif
  799. /**
  800. * mmc_get_blk_desc() - Get the block descriptor for an MMC device
  801. *
  802. * @mmc: MMC device
  803. * @return block device if found, else NULL
  804. */
  805. struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);
  806. /**
  807. * mmc_send_ext_csd() - read the extended CSD register
  808. *
  809. * @mmc: MMC device
  810. * @ext_csd a cache aligned buffer of length MMC_MAX_BLOCK_LEN allocated by
  811. * the caller, e.g. using
  812. * ALLOC_CACHE_ALIGN_BUFFER(u8, ext_csd, MMC_MAX_BLOCK_LEN)
  813. * Return: 0 for success
  814. */
  815. int mmc_send_ext_csd(struct mmc *mmc, u8 *ext_csd);
  816. /**
  817. * mmc_boot_wp() - power on write protect boot partitions
  818. *
  819. * The boot partitions are write protected until the next power cycle.
  820. *
  821. * Return: 0 for success
  822. */
  823. int mmc_boot_wp(struct mmc *mmc);
  824. static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data)
  825. {
  826. return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
  827. }
  828. #endif /* _MMC_H_ */