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/scatterlist.h>
  24 #include <linux/spinlock.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 /*
  44  * We differentiate between the following 3 power states:
  45  * 1. card slot powered off, controller stopped. This is used, when either there
  46  *    is no card in the slot, or the card really has to be powered down.
  47  * 2. card slot powered on, controller stopped. This is used, when a card is in
  48  *    the slot, but no activity is currently taking place. This is a power-
  49  *    saving mode with card-state preserved. This state can be entered, e.g.
  50  *    when MMC clock-gating is used.
  51  * 3. card slot powered on, controller running. This is the actual active state.
  52  */
  53 enum tmio_mmc_power {
  54         TMIO_MMC_OFF_STOP,      /* card power off, controller stopped */
  55         TMIO_MMC_ON_STOP,       /* card power on, controller stopped */
  56         TMIO_MMC_ON_RUN,        /* card power on, controller running */
  57 };
  58
  59 struct tmio_mmc_host {
  60         void __iomem *ctl;
  61         unsigned long bus_shift;
  62         struct mmc_command      *cmd;
  63         struct mmc_request      *mrq;
  64         struct mmc_data         *data;
  65         struct mmc_host         *mmc;
  66
  67         /* Controller and card power state */
  68         enum tmio_mmc_power     power;
  69
  70         /* Callbacks for clock / power control */
  71         void (*set_pwr)(struct platform_device *host, int state);
  72         void (*set_clk_div)(struct platform_device *host, int state);
  73
  74         /* pio related stuff */
  75         struct scatterlist      *sg_ptr;
  76         struct scatterlist      *sg_orig;
  77         unsigned int            sg_len;
  78         unsigned int            sg_off;
  79
  80         struct platform_device *pdev;
  81         struct tmio_mmc_data *pdata;
  82
  83         /* DMA support */
  84         bool                    force_pio;
  85         struct dma_chan         *chan_rx;
  86         struct dma_chan         *chan_tx;
  87         struct tasklet_struct   dma_complete;
  88         struct tasklet_struct   dma_issue;
  89         struct scatterlist      bounce_sg;
  90         u8                      *bounce_buf;
  91
  92         /* Track lost interrupts */
  93         struct delayed_work     delayed_reset_work;
  94         struct work_struct      done;
  95
  96         /* Cache IRQ mask */
  97         u32                     sdcard_irq_mask;
  98         u32                     sdio_irq_mask;
  99
 100         spinlock_t              lock;           /* protect host private data */
 101         unsigned long           last_req_ts;
 102         struct mutex            ios_lock;       /* protect set_ios() context */
 103         bool                    native_hotplug;
 104         bool                    resuming;
 105 };
 106
 107 int tmio_mmc_host_probe(struct tmio_mmc_host **host,
 108                         struct platform_device *pdev,
 109                         struct tmio_mmc_data *pdata);
 110 void tmio_mmc_host_remove(struct tmio_mmc_host *host);
 111 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
 112
 113 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
 114 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
 115 irqreturn_t tmio_mmc_irq(int irq, void *devid);
 116 irqreturn_t tmio_mmc_sdcard_irq(int irq, void *devid);
 117 irqreturn_t tmio_mmc_card_detect_irq(int irq, void *devid);
 118 irqreturn_t tmio_mmc_sdio_irq(int irq, void *devid);
 119
 120 static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
 121                                          unsigned long *flags)
 122 {
 123         local_irq_save(*flags);
 124         return kmap_atomic(sg_page(sg)) + sg->offset;
 125 }
 126
 127 static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
 128                                           unsigned long *flags, void *virt)
 129 {
 130         kunmap_atomic(virt - sg->offset);
 131         local_irq_restore(*flags);
 132 }
 133
 134 #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
 135 void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
 136 void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
 137 void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
 138 void tmio_mmc_release_dma(struct tmio_mmc_host *host);
 139 void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
 140 #else
 141 static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
 142                                struct mmc_data *data)
 143 {
 144 }
 145
 146 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
 147 {
 148 }
 149
 150 static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
 151                                  struct tmio_mmc_data *pdata)
 152 {
 153         host->chan_tx = NULL;
 154         host->chan_rx = NULL;
 155 }
 156
 157 static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
 158 {
 159 }
 160
 161 static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
 162 {
 163 }
 164 #endif
 165
 166 #ifdef CONFIG_PM
 167 int tmio_mmc_host_suspend(struct device *dev);
 168 int tmio_mmc_host_resume(struct device *dev);
 169 #else
 170 #define tmio_mmc_host_suspend NULL
 171 #define tmio_mmc_host_resume NULL
 172 #endif
 173
 174 int tmio_mmc_host_runtime_suspend(struct device *dev);
 175 int tmio_mmc_host_runtime_resume(struct device *dev);
 176
 177 static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
 178 {
 179         return readw(host->ctl + (addr << host->bus_shift));
 180 }
 181
 182 static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
 183                 u16 *buf, int count)
 184 {
 185         readsw(host->ctl + (addr << host->bus_shift), buf, count);
 186 }
 187
 188 static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
 189 {
 190         return readw(host->ctl + (addr << host->bus_shift)) |
 191                readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
 192 }
 193
 194 static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
 195 {
 196         /* If there is a hook and it returns non-zero then there
 197          * is an error and the write should be skipped
 198          */
 199         if (host->pdata->write16_hook && host->pdata->write16_hook(host, addr))
 200                 return;
 201         writew(val, host->ctl + (addr << host->bus_shift));
 202 }
 203
 204 static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
 205                 u16 *buf, int count)
 206 {
 207         writesw(host->ctl + (addr << host->bus_shift), buf, count);
 208 }
 209
 210 static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
 211 {
 212         writew(val, host->ctl + (addr << host->bus_shift));
 213         writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
 214 }
 215
 216
 217 #endif