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