drivers/mmc/host/tmio_mmc.h

   1 /*
   2  * linux/drivers/mmc/host/tmio_mmc.h
   3  *
   4  * Copyright (C) 2016 Sang Engineering, Wolfram Sang
   5  * Copyright (C) 2015-16 Renesas Electronics Corporation
   6  * Copyright (C) 2007 Ian Molton
   7  * Copyright (C) 2004 Ian Molton
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  *
  13  * Driver for the MMC / SD / SDIO cell found in:
  14  *
  15  * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
  16  */
  17
  18 #ifndef TMIO_MMC_H
  19 #define TMIO_MMC_H
  20
  21 #include <linux/dmaengine.h>
  22 #include <linux/highmem.h>
  23 #include <linux/mutex.h>
  24 #include <linux/pagemap.h>
  25 #include <linux/scatterlist.h>
  26 #include <linux/spinlock.h>
  27
  28 #define CTL_SD_CMD 0x00
  29 #define CTL_ARG_REG 0x04
  30 #define CTL_STOP_INTERNAL_ACTION 0x08
  31 #define CTL_XFER_BLK_COUNT 0xa
  32 #define CTL_RESPONSE 0x0c
  33 #define CTL_STATUS 0x1c
  34 #define CTL_STATUS2 0x1e
  35 #define CTL_IRQ_MASK 0x20
  36 #define CTL_SD_CARD_CLK_CTL 0x24
  37 #define CTL_SD_XFER_LEN 0x26
  38 #define CTL_SD_MEM_CARD_OPT 0x28
  39 #define CTL_SD_ERROR_DETAIL_STATUS 0x2c
  40 #define CTL_SD_DATA_PORT 0x30
  41 #define CTL_TRANSACTION_CTL 0x34
  42 #define CTL_SDIO_STATUS 0x36
  43 #define CTL_SDIO_IRQ_MASK 0x38
  44 #define CTL_DMA_ENABLE 0xd8
  45 #define CTL_RESET_SD 0xe0
  46 #define CTL_VERSION 0xe2
  47 #define CTL_SDIO_REGS 0x100
  48 #define CTL_CLK_AND_WAIT_CTL 0x138
  49 #define CTL_RESET_SDIO 0x1e0
  50
  51 /* Definitions for values the CTRL_STATUS register can take. */
  52 #define TMIO_STAT_CMDRESPEND    0x00000001
  53 #define TMIO_STAT_DATAEND       0x00000004
  54 #define TMIO_STAT_CARD_REMOVE   0x00000008
  55 #define TMIO_STAT_CARD_INSERT   0x00000010
  56 #define TMIO_STAT_SIGSTATE      0x00000020
  57 #define TMIO_STAT_WRPROTECT     0x00000080
  58 #define TMIO_STAT_CARD_REMOVE_A 0x00000100
  59 #define TMIO_STAT_CARD_INSERT_A 0x00000200
  60 #define TMIO_STAT_SIGSTATE_A    0x00000400
  61 #define TMIO_STAT_CMD_IDX_ERR   0x00010000
  62 #define TMIO_STAT_CRCFAIL       0x00020000
  63 #define TMIO_STAT_STOPBIT_ERR   0x00040000
  64 #define TMIO_STAT_DATATIMEOUT   0x00080000
  65 #define TMIO_STAT_RXOVERFLOW    0x00100000
  66 #define TMIO_STAT_TXUNDERRUN    0x00200000
  67 #define TMIO_STAT_CMDTIMEOUT    0x00400000
  68 #define TMIO_STAT_RXRDY         0x01000000
  69 #define TMIO_STAT_TXRQ          0x02000000
  70 #define TMIO_STAT_ILL_FUNC      0x20000000
  71 #define TMIO_STAT_CMD_BUSY      0x40000000
  72 #define TMIO_STAT_ILL_ACCESS    0x80000000
  73
  74 #define TMIO_STATUS2_DAT0       BIT(7)
  75
  76 #define CLK_CTL_DIV_MASK        0xff
  77 #define CLK_CTL_SCLKEN          BIT(8)
  78
  79 #define TMIO_BBS                512             /* Boot block size */
  80
  81 /* Definitions for values the CTRL_SDIO_STATUS register can take. */
  82 #define TMIO_SDIO_STAT_IOIRQ    0x0001
  83 #define TMIO_SDIO_STAT_EXPUB52  0x4000
  84 #define TMIO_SDIO_STAT_EXWT     0x8000
  85 #define TMIO_SDIO_MASK_ALL      0xc007
  86
  87 /* Define some IRQ masks */
  88 /* This is the mask used at reset by the chip */
  89 #define TMIO_MASK_ALL           0x837f031d
  90 #define TMIO_MASK_READOP  (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
  91 #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
  92 #define TMIO_MASK_CMD     (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
  93                 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
  94 #define TMIO_MASK_IRQ     (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
  95
  96 struct tmio_mmc_data;
  97 struct tmio_mmc_host;
  98
  99 struct tmio_mmc_dma {
 100         enum dma_slave_buswidth dma_buswidth;
 101         bool (*filter)(struct dma_chan *chan, void *arg);
 102         void (*enable)(struct tmio_mmc_host *host, bool enable);
 103 };
 104
 105 struct tmio_mmc_host {
 106         void __iomem *ctl;
 107         struct mmc_command      *cmd;
 108         struct mmc_request      *mrq;
 109         struct mmc_data         *data;
 110         struct mmc_host         *mmc;
 111
 112         /* Callbacks for clock / power control */
 113         void (*set_pwr)(struct platform_device *host, int state);
 114         void (*set_clk_div)(struct platform_device *host, int state);
 115
 116         /* pio related stuff */
 117         struct scatterlist      *sg_ptr;
 118         struct scatterlist      *sg_orig;
 119         unsigned int            sg_len;
 120         unsigned int            sg_off;
 121         unsigned long           bus_shift;
 122
 123         struct platform_device *pdev;
 124         struct tmio_mmc_data *pdata;
 125         struct tmio_mmc_dma     *dma;
 126
 127         /* DMA support */
 128         bool                    force_pio;
 129         struct dma_chan         *chan_rx;
 130         struct dma_chan         *chan_tx;
 131         struct tasklet_struct   dma_complete;
 132         struct tasklet_struct   dma_issue;
 133         struct scatterlist      bounce_sg;
 134         u8                      *bounce_buf;
 135
 136         /* Track lost interrupts */
 137         struct delayed_work     delayed_reset_work;
 138         struct work_struct      done;
 139
 140         /* Cache */
 141         u32                     sdcard_irq_mask;
 142         u32                     sdio_irq_mask;
 143         unsigned int            clk_cache;
 144
 145         spinlock_t              lock;           /* protect host private data */
 146         unsigned long           last_req_ts;
 147         struct mutex            ios_lock;       /* protect set_ios() context */
 148         bool                    native_hotplug;
 149         bool                    sdio_irq_enabled;
 150
 151         int (*write16_hook)(struct tmio_mmc_host *host, int addr);
 152         int (*clk_enable)(struct tmio_mmc_host *host);
 153         unsigned int (*clk_update)(struct tmio_mmc_host *host,
 154                                    unsigned int new_clock);
 155         void (*clk_disable)(struct tmio_mmc_host *host);
 156         int (*multi_io_quirk)(struct mmc_card *card,
 157                               unsigned int direction, int blk_size);
 158         int (*start_signal_voltage_switch)(struct mmc_host *mmc,
 159                                            struct mmc_ios *ios);
 160 };
 161
 162 struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev);
 163 void tmio_mmc_host_free(struct tmio_mmc_host *host);
 164 int tmio_mmc_host_probe(struct tmio_mmc_host *host,
 165                         struct tmio_mmc_data *pdata);
 166 void tmio_mmc_host_remove(struct tmio_mmc_host *host);
 167 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
 168
 169 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
 170 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
 171 irqreturn_t tmio_mmc_irq(int irq, void *devid);
 172
 173 static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
 174                                          unsigned long *flags)
 175 {
 176         local_irq_save(*flags);
 177         return kmap_atomic(sg_page(sg)) + sg->offset;
 178 }
 179
 180 static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
 181                                           unsigned long *flags, void *virt)
 182 {
 183         kunmap_atomic(virt - sg->offset);
 184         local_irq_restore(*flags);
 185 }
 186
 187 #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
 188 void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
 189 void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
 190 void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
 191 void tmio_mmc_release_dma(struct tmio_mmc_host *host);
 192 void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
 193 #else
 194 static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
 195                                struct mmc_data *data)
 196 {
 197 }
 198
 199 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
 200 {
 201 }
 202
 203 static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
 204                                  struct tmio_mmc_data *pdata)
 205 {
 206         host->chan_tx = NULL;
 207         host->chan_rx = NULL;
 208 }
 209
 210 static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
 211 {
 212 }
 213
 214 static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
 215 {
 216 }
 217 #endif
 218
 219 #ifdef CONFIG_PM
 220 int tmio_mmc_host_runtime_suspend(struct device *dev);
 221 int tmio_mmc_host_runtime_resume(struct device *dev);
 222 #endif
 223
 224 static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
 225 {
 226         return readw(host->ctl + (addr << host->bus_shift));
 227 }
 228
 229 static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
 230                 u16 *buf, int count)
 231 {
 232         readsw(host->ctl + (addr << host->bus_shift), buf, count);
 233 }
 234
 235 static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
 236 {
 237         return readw(host->ctl + (addr << host->bus_shift)) |
 238                readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
 239 }
 240
 241 static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
 242 {
 243         /* If there is a hook and it returns non-zero then there
 244          * is an error and the write should be skipped
 245          */
 246         if (host->write16_hook && host->write16_hook(host, addr))
 247                 return;
 248         writew(val, host->ctl + (addr << host->bus_shift));
 249 }
 250
 251 static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
 252                 u16 *buf, int count)
 253 {
 254         writesw(host->ctl + (addr << host->bus_shift), buf, count);
 255 }
 256
 257 static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
 258 {
 259         writew(val, host->ctl + (addr << host->bus_shift));
 260         writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
 261 }
 262
 263
 264 #endif