drivers/mmc/host/tmio_mmc.h

   1 /*
   2  * linux/drivers/mmc/host/tmio_mmc.h
   3  *
   4  * Copyright (C) 2007 Ian Molton
   5  * Copyright (C) 2004 Ian Molton
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  *
  11  * Driver for the MMC / SD / SDIO cell found in:
  12  *
  13  * TC6393XB TC6391XB TC6387XB T7L66XB ASIC3
  14  */
  15
  16 #ifndef TMIO_MMC_H
  17 #define TMIO_MMC_H
  18
  19 #include <linux/highmem.h>
  20 #include <linux/mmc/tmio.h>
  21 #include <linux/mutex.h>
  22 #include <linux/pagemap.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/scatterlist.h>
  25
  26 /* Definitions for values the CTRL_SDIO_STATUS register can take. */
  27 #define TMIO_SDIO_STAT_IOIRQ    0x0001
  28 #define TMIO_SDIO_STAT_EXPUB52  0x4000
  29 #define TMIO_SDIO_STAT_EXWT     0x8000
  30 #define TMIO_SDIO_MASK_ALL      0xc007
  31
  32 /* Define some IRQ masks */
  33 /* This is the mask used at reset by the chip */
  34 #define TMIO_MASK_ALL           0x837f031d
  35 #define TMIO_MASK_READOP  (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
  36 #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
  37 #define TMIO_MASK_CMD     (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
  38                 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
  39 #define TMIO_MASK_IRQ     (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
  40
  41 struct tmio_mmc_data;
  42
  43 struct tmio_mmc_host {
  44         void __iomem *ctl;
  45         unsigned long bus_shift;
  46         struct mmc_command      *cmd;
  47         struct mmc_request      *mrq;
  48         struct mmc_data         *data;
  49         struct mmc_host         *mmc;
  50         unsigned int            sdio_irq_enabled;
  51
  52         /* Callbacks for clock / power control */
  53         void (*set_pwr)(struct platform_device *host, int state);
  54         void (*set_clk_div)(struct platform_device *host, int state);
  55
  56         int                     pm_error;
  57         /* recognise system-wide suspend in runtime PM methods */
  58         bool                    pm_global;
  59
  60         /* pio related stuff */
  61         struct scatterlist      *sg_ptr;
  62         struct scatterlist      *sg_orig;
  63         unsigned int            sg_len;
  64         unsigned int            sg_off;
  65
  66         struct platform_device *pdev;
  67         struct tmio_mmc_data *pdata;
  68
  69         /* DMA support */
  70         bool                    force_pio;
  71         struct dma_chan         *chan_rx;
  72         struct dma_chan         *chan_tx;
  73         struct tasklet_struct   dma_complete;
  74         struct tasklet_struct   dma_issue;
  75         struct scatterlist      bounce_sg;
  76         u8                      *bounce_buf;
  77
  78         /* Track lost interrupts */
  79         struct delayed_work     delayed_reset_work;
  80         struct work_struct      done;
  81
  82         /* Cache IRQ mask */
  83         u32                     sdcard_irq_mask;
  84         u32                     sdio_irq_mask;
  85
  86         spinlock_t              lock;           /* protect host private data */
  87         unsigned long           last_req_ts;
  88         struct mutex            ios_lock;       /* protect set_ios() context */
  89 };
  90
  91 int tmio_mmc_host_probe(struct tmio_mmc_host **host,
  92                         struct platform_device *pdev,
  93                         struct tmio_mmc_data *pdata);
  94 void tmio_mmc_host_remove(struct tmio_mmc_host *host);
  95 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
  96
  97 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
  98 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
  99 irqreturn_t tmio_mmc_irq(int irq, void *devid);
 100
 101 static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
 102                                          unsigned long *flags)
 103 {
 104         local_irq_save(*flags);
 105         return kmap_atomic(sg_page(sg), KM_BIO_SRC_IRQ) + sg->offset;
 106 }
 107
 108 static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
 109                                           unsigned long *flags, void *virt)
 110 {
 111         kunmap_atomic(virt - sg->offset, KM_BIO_SRC_IRQ);
 112         local_irq_restore(*flags);
 113 }
 114
 115 #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
 116 void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
 117 void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
 118 void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
 119 void tmio_mmc_release_dma(struct tmio_mmc_host *host);
 120 #else
 121 static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
 122                                struct mmc_data *data)
 123 {
 124 }
 125
 126 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
 127 {
 128 }
 129
 130 static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
 131                                  struct tmio_mmc_data *pdata)
 132 {
 133         host->chan_tx = NULL;
 134         host->chan_rx = NULL;
 135 }
 136
 137 static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
 138 {
 139 }
 140 #endif
 141
 142 #ifdef CONFIG_PM
 143 int tmio_mmc_host_suspend(struct device *dev);
 144 int tmio_mmc_host_resume(struct device *dev);
 145 #else
 146 #define tmio_mmc_host_suspend NULL
 147 #define tmio_mmc_host_resume NULL
 148 #endif
 149
 150 int tmio_mmc_host_runtime_suspend(struct device *dev);
 151 int tmio_mmc_host_runtime_resume(struct device *dev);
 152
 153 static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
 154 {
 155         return readw(host->ctl + (addr << host->bus_shift));
 156 }
 157
 158 static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
 159                 u16 *buf, int count)
 160 {
 161         readsw(host->ctl + (addr << host->bus_shift), buf, count);
 162 }
 163
 164 static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
 165 {
 166         return readw(host->ctl + (addr << host->bus_shift)) |
 167                readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
 168 }
 169
 170 static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
 171 {
 172         /* If there is a hook and it returns non-zero then there
 173          * is an error and the write should be skipped
 174          */
 175         if (host->pdata->write16_hook && host->pdata->write16_hook(host, addr))
 176                 return;
 177         writew(val, host->ctl + (addr << host->bus_shift));
 178 }
 179
 180 static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
 181                 u16 *buf, int count)
 182 {
 183         writesw(host->ctl + (addr << host->bus_shift), buf, count);
 184 }
 185
 186 static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
 187 {
 188         writew(val, host->ctl + (addr << host->bus_shift));
 189         writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
 190 }
 191
 192
 193 #endif