tmio_mmc.h 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. /*
  2. * Driver for the MMC / SD / SDIO cell found in:
  3. *
  4. * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
  5. *
  6. * Copyright (C) 2015-17 Renesas Electronics Corporation
  7. * Copyright (C) 2016-17 Sang Engineering, Wolfram Sang
  8. * Copyright (C) 2016-17 Horms Solutions, Simon Horman
  9. * Copyright (C) 2007 Ian Molton
  10. * Copyright (C) 2004 Ian Molton
  11. *
  12. * This program is free software; you can redistribute it and/or modify
  13. * it under the terms of the GNU General Public License version 2 as
  14. * published by the Free Software Foundation.
  15. *
  16. */
  17. #ifndef TMIO_MMC_H
  18. #define TMIO_MMC_H
  19. #include <linux/dmaengine.h>
  20. #include <linux/highmem.h>
  21. #include <linux/mutex.h>
  22. #include <linux/pagemap.h>
  23. #include <linux/scatterlist.h>
  24. #include <linux/spinlock.h>
  25. #include <linux/interrupt.h>
  26. #define CTL_SD_CMD 0x00
  27. #define CTL_ARG_REG 0x04
  28. #define CTL_STOP_INTERNAL_ACTION 0x08
  29. #define CTL_XFER_BLK_COUNT 0xa
  30. #define CTL_RESPONSE 0x0c
  31. /* driver merges STATUS and following STATUS2 */
  32. #define CTL_STATUS 0x1c
  33. /* driver merges IRQ_MASK and following IRQ_MASK2 */
  34. #define CTL_IRQ_MASK 0x20
  35. #define CTL_SD_CARD_CLK_CTL 0x24
  36. #define CTL_SD_XFER_LEN 0x26
  37. #define CTL_SD_MEM_CARD_OPT 0x28
  38. #define CTL_SD_ERROR_DETAIL_STATUS 0x2c
  39. #define CTL_SD_DATA_PORT 0x30
  40. #define CTL_TRANSACTION_CTL 0x34
  41. #define CTL_SDIO_STATUS 0x36
  42. #define CTL_SDIO_IRQ_MASK 0x38
  43. #define CTL_DMA_ENABLE 0xd8
  44. #define CTL_RESET_SD 0xe0
  45. #define CTL_VERSION 0xe2
  46. #define CTL_SDIF_MODE 0xe6
  47. #define CTL_SDIO_REGS 0x100
  48. #define CTL_CLK_AND_WAIT_CTL 0x138
  49. #define CTL_RESET_SDIO 0x1e0
  50. /* Definitions for values the CTL_STOP_INTERNAL_ACTION register can take */
  51. #define TMIO_STOP_STP BIT(0)
  52. #define TMIO_STOP_SEC BIT(8)
  53. /* Definitions for values the CTL_STATUS register can take */
  54. #define TMIO_STAT_CMDRESPEND BIT(0)
  55. #define TMIO_STAT_DATAEND BIT(2)
  56. #define TMIO_STAT_CARD_REMOVE BIT(3)
  57. #define TMIO_STAT_CARD_INSERT BIT(4)
  58. #define TMIO_STAT_SIGSTATE BIT(5)
  59. #define TMIO_STAT_WRPROTECT BIT(7)
  60. #define TMIO_STAT_CARD_REMOVE_A BIT(8)
  61. #define TMIO_STAT_CARD_INSERT_A BIT(9)
  62. #define TMIO_STAT_SIGSTATE_A BIT(10)
  63. /* These belong technically to CTL_STATUS2, but the driver merges them */
  64. #define TMIO_STAT_CMD_IDX_ERR BIT(16)
  65. #define TMIO_STAT_CRCFAIL BIT(17)
  66. #define TMIO_STAT_STOPBIT_ERR BIT(18)
  67. #define TMIO_STAT_DATATIMEOUT BIT(19)
  68. #define TMIO_STAT_RXOVERFLOW BIT(20)
  69. #define TMIO_STAT_TXUNDERRUN BIT(21)
  70. #define TMIO_STAT_CMDTIMEOUT BIT(22)
  71. #define TMIO_STAT_DAT0 BIT(23) /* only known on R-Car so far */
  72. #define TMIO_STAT_RXRDY BIT(24)
  73. #define TMIO_STAT_TXRQ BIT(25)
  74. #define TMIO_STAT_ILL_FUNC BIT(29) /* only when !TMIO_MMC_HAS_IDLE_WAIT */
  75. #define TMIO_STAT_SCLKDIVEN BIT(29) /* only when TMIO_MMC_HAS_IDLE_WAIT */
  76. #define TMIO_STAT_CMD_BUSY BIT(30)
  77. #define TMIO_STAT_ILL_ACCESS BIT(31)
  78. /* Definitions for values the CTL_SD_CARD_CLK_CTL register can take */
  79. #define CLK_CTL_DIV_MASK 0xff
  80. #define CLK_CTL_SCLKEN BIT(8)
  81. /* Definitions for values the CTL_SD_MEM_CARD_OPT register can take */
  82. #define CARD_OPT_WIDTH8 BIT(13)
  83. #define CARD_OPT_WIDTH BIT(15)
  84. /* Definitions for values the CTL_SDIO_STATUS register can take */
  85. #define TMIO_SDIO_STAT_IOIRQ 0x0001
  86. #define TMIO_SDIO_STAT_EXPUB52 0x4000
  87. #define TMIO_SDIO_STAT_EXWT 0x8000
  88. #define TMIO_SDIO_MASK_ALL 0xc007
  89. #define TMIO_SDIO_SETBITS_MASK 0x0006
  90. /* Definitions for values the CTL_DMA_ENABLE register can take */
  91. #define DMA_ENABLE_DMASDRW BIT(1)
  92. /* Define some IRQ masks */
  93. /* This is the mask used at reset by the chip */
  94. #define TMIO_MASK_ALL 0x837f031d
  95. #define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
  96. #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
  97. #define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
  98. TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
  99. #define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
  100. struct tmio_mmc_data;
  101. struct tmio_mmc_host;
  102. struct tmio_mmc_dma_ops {
  103. void (*start)(struct tmio_mmc_host *host, struct mmc_data *data);
  104. void (*enable)(struct tmio_mmc_host *host, bool enable);
  105. void (*request)(struct tmio_mmc_host *host,
  106. struct tmio_mmc_data *pdata);
  107. void (*release)(struct tmio_mmc_host *host);
  108. void (*abort)(struct tmio_mmc_host *host);
  109. void (*dataend)(struct tmio_mmc_host *host);
  110. };
  111. struct tmio_mmc_host {
  112. void __iomem *ctl;
  113. struct mmc_command *cmd;
  114. struct mmc_request *mrq;
  115. struct mmc_data *data;
  116. struct mmc_host *mmc;
  117. struct mmc_host_ops ops;
  118. /* Callbacks for clock / power control */
  119. void (*set_pwr)(struct platform_device *host, int state);
  120. void (*set_clk_div)(struct platform_device *host, int state);
  121. /* pio related stuff */
  122. struct scatterlist *sg_ptr;
  123. struct scatterlist *sg_orig;
  124. unsigned int sg_len;
  125. unsigned int sg_off;
  126. unsigned int bus_shift;
  127. struct platform_device *pdev;
  128. struct tmio_mmc_data *pdata;
  129. /* DMA support */
  130. bool force_pio;
  131. struct dma_chan *chan_rx;
  132. struct dma_chan *chan_tx;
  133. struct tasklet_struct dma_issue;
  134. struct scatterlist bounce_sg;
  135. u8 *bounce_buf;
  136. /* Track lost interrupts */
  137. struct delayed_work delayed_reset_work;
  138. struct work_struct done;
  139. /* Cache */
  140. u32 sdcard_irq_mask;
  141. u32 sdio_irq_mask;
  142. unsigned int clk_cache;
  143. spinlock_t lock; /* protect host private data */
  144. unsigned long last_req_ts;
  145. struct mutex ios_lock; /* protect set_ios() context */
  146. bool native_hotplug;
  147. bool sdio_irq_enabled;
  148. /* Mandatory callback */
  149. int (*clk_enable)(struct tmio_mmc_host *host);
  150. /* Optional callbacks */
  151. unsigned int (*clk_update)(struct tmio_mmc_host *host,
  152. unsigned int new_clock);
  153. void (*clk_disable)(struct tmio_mmc_host *host);
  154. int (*multi_io_quirk)(struct mmc_card *card,
  155. unsigned int direction, int blk_size);
  156. int (*write16_hook)(struct tmio_mmc_host *host, int addr);
  157. void (*hw_reset)(struct tmio_mmc_host *host);
  158. void (*prepare_tuning)(struct tmio_mmc_host *host, unsigned long tap);
  159. bool (*check_scc_error)(struct tmio_mmc_host *host);
  160. /*
  161. * Mandatory callback for tuning to occur which is optional for SDR50
  162. * and mandatory for SDR104.
  163. */
  164. unsigned int (*init_tuning)(struct tmio_mmc_host *host);
  165. int (*select_tuning)(struct tmio_mmc_host *host);
  166. /* Tuning values: 1 for success, 0 for failure */
  167. DECLARE_BITMAP(taps, BITS_PER_BYTE * sizeof(long));
  168. unsigned int tap_num;
  169. unsigned long tap_set;
  170. void (*prepare_hs400_tuning)(struct tmio_mmc_host *host);
  171. void (*hs400_downgrade)(struct tmio_mmc_host *host);
  172. void (*hs400_complete)(struct tmio_mmc_host *host);
  173. const struct tmio_mmc_dma_ops *dma_ops;
  174. };
  175. struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev,
  176. struct tmio_mmc_data *pdata);
  177. void tmio_mmc_host_free(struct tmio_mmc_host *host);
  178. int tmio_mmc_host_probe(struct tmio_mmc_host *host);
  179. void tmio_mmc_host_remove(struct tmio_mmc_host *host);
  180. void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
  181. void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
  182. void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
  183. irqreturn_t tmio_mmc_irq(int irq, void *devid);
  184. static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
  185. unsigned long *flags)
  186. {
  187. local_irq_save(*flags);
  188. return kmap_atomic(sg_page(sg)) + sg->offset;
  189. }
  190. static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
  191. unsigned long *flags, void *virt)
  192. {
  193. kunmap_atomic(virt - sg->offset);
  194. local_irq_restore(*flags);
  195. }
  196. #ifdef CONFIG_PM
  197. int tmio_mmc_host_runtime_suspend(struct device *dev);
  198. int tmio_mmc_host_runtime_resume(struct device *dev);
  199. #endif
  200. static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
  201. {
  202. return ioread16(host->ctl + (addr << host->bus_shift));
  203. }
  204. static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
  205. u16 *buf, int count)
  206. {
  207. ioread16_rep(host->ctl + (addr << host->bus_shift), buf, count);
  208. }
  209. static inline u32 sd_ctrl_read16_and_16_as_32(struct tmio_mmc_host *host,
  210. int addr)
  211. {
  212. return ioread16(host->ctl + (addr << host->bus_shift)) |
  213. ioread16(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
  214. }
  215. static inline void sd_ctrl_read32_rep(struct tmio_mmc_host *host, int addr,
  216. u32 *buf, int count)
  217. {
  218. ioread32_rep(host->ctl + (addr << host->bus_shift), buf, count);
  219. }
  220. static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr,
  221. u16 val)
  222. {
  223. /* If there is a hook and it returns non-zero then there
  224. * is an error and the write should be skipped
  225. */
  226. if (host->write16_hook && host->write16_hook(host, addr))
  227. return;
  228. iowrite16(val, host->ctl + (addr << host->bus_shift));
  229. }
  230. static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
  231. u16 *buf, int count)
  232. {
  233. iowrite16_rep(host->ctl + (addr << host->bus_shift), buf, count);
  234. }
  235. static inline void sd_ctrl_write32_as_16_and_16(struct tmio_mmc_host *host,
  236. int addr, u32 val)
  237. {
  238. iowrite16(val & 0xffff, host->ctl + (addr << host->bus_shift));
  239. iowrite16(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
  240. }
  241. static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
  242. {
  243. iowrite32(val, host->ctl + (addr << host->bus_shift));
  244. }
  245. static inline void sd_ctrl_write32_rep(struct tmio_mmc_host *host, int addr,
  246. const u32 *buf, int count)
  247. {
  248. iowrite32_rep(host->ctl + (addr << host->bus_shift), buf, count);
  249. }
  250. #endif