blob: 032188b766defdd2dd80a14c72cac1aa2a2c0b93 [file] [log] [blame]
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +01001/*
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
Kuninori Morimoto361936e2015-01-13 04:59:14 +000019#include <linux/dmaengine.h>
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010020#include <linux/highmem.h>
Simon Hormancba179a2011-03-24 09:48:36 +010021#include <linux/mmc/tmio.h>
Guennadi Liakhovetskib9269fd2011-07-14 12:12:38 +020022#include <linux/mutex.h>
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010023#include <linux/pagemap.h>
Rafael J. Wysocki6c0cbef2011-07-26 20:50:23 +020024#include <linux/scatterlist.h>
Guennadi Liakhovetskie3de2be2012-01-06 13:06:51 +010025#include <linux/spinlock.h>
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010026
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010027/* Definitions for values the CTRL_SDIO_STATUS register can take. */
Simon Hormancba179a2011-03-24 09:48:36 +010028#define TMIO_SDIO_STAT_IOIRQ 0x0001
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010029#define TMIO_SDIO_STAT_EXPUB52 0x4000
Simon Hormancba179a2011-03-24 09:48:36 +010030#define TMIO_SDIO_STAT_EXWT 0x8000
31#define TMIO_SDIO_MASK_ALL 0xc007
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010032
33/* Define some IRQ masks */
34/* This is the mask used at reset by the chip */
35#define TMIO_MASK_ALL 0x837f031d
36#define TMIO_MASK_READOP (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND)
37#define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND)
38#define TMIO_MASK_CMD (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
39 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
40#define TMIO_MASK_IRQ (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
41
42struct tmio_mmc_data;
Kuninori Morimoto5add2ac2015-01-13 04:59:05 +000043struct tmio_mmc_host;
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010044
Kuninori Morimoto7ecc09b2015-01-13 04:57:33 +000045struct tmio_mmc_dma {
Kuninori Morimoto361936e2015-01-13 04:59:14 +000046 enum dma_slave_buswidth dma_buswidth;
Kuninori Morimoto7ecc09b2015-01-13 04:57:33 +000047 bool (*filter)(struct dma_chan *chan, void *arg);
Kuninori Morimoto5add2ac2015-01-13 04:59:05 +000048 void (*enable)(struct tmio_mmc_host *host, bool enable);
Kuninori Morimoto7ecc09b2015-01-13 04:57:33 +000049};
50
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010051struct tmio_mmc_host {
52 void __iomem *ctl;
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010053 struct mmc_command *cmd;
54 struct mmc_request *mrq;
55 struct mmc_data *data;
56 struct mmc_host *mmc;
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010057
58 /* Callbacks for clock / power control */
59 void (*set_pwr)(struct platform_device *host, int state);
60 void (*set_clk_div)(struct platform_device *host, int state);
61
62 /* pio related stuff */
63 struct scatterlist *sg_ptr;
64 struct scatterlist *sg_orig;
65 unsigned int sg_len;
66 unsigned int sg_off;
Kuninori Morimoto7445bf92015-01-13 04:58:20 +000067 unsigned long bus_shift;
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010068
69 struct platform_device *pdev;
70 struct tmio_mmc_data *pdata;
Kuninori Morimoto7ecc09b2015-01-13 04:57:33 +000071 struct tmio_mmc_dma *dma;
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010072
73 /* DMA support */
74 bool force_pio;
75 struct dma_chan *chan_rx;
76 struct dma_chan *chan_tx;
77 struct tasklet_struct dma_complete;
78 struct tasklet_struct dma_issue;
79 struct scatterlist bounce_sg;
80 u8 *bounce_buf;
81
82 /* Track lost interrupts */
83 struct delayed_work delayed_reset_work;
Guennadi Liakhovetskib9269fd2011-07-14 12:12:38 +020084 struct work_struct done;
85
Ulf Hanssonae12d252013-10-30 00:16:17 +010086 /* Cache */
Simon Horman54680fe2011-08-25 10:27:25 +090087 u32 sdcard_irq_mask;
88 u32 sdio_irq_mask;
Ulf Hanssonae12d252013-10-30 00:16:17 +010089 unsigned int clk_cache;
Simon Horman54680fe2011-08-25 10:27:25 +090090
Guennadi Liakhovetskib9269fd2011-07-14 12:12:38 +020091 spinlock_t lock; /* protect host private data */
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +010092 unsigned long last_req_ts;
Guennadi Liakhovetskib9269fd2011-07-14 12:12:38 +020093 struct mutex ios_lock; /* protect set_ios() context */
Guennadi Liakhovetski2b1ac5c2012-02-09 22:57:08 +010094 bool native_hotplug;
Ulf Hansson7501c432013-10-24 15:58:45 +020095 bool sdio_irq_enabled;
Kuninori Morimotodfe9a222015-01-13 04:57:42 +000096
97 int (*write16_hook)(struct tmio_mmc_host *host, int addr);
Ben Hutchings0ea28212016-04-01 17:44:31 +020098 int (*clk_enable)(struct tmio_mmc_host *host);
Ben Hutchings2fb55952016-04-01 17:44:32 +020099 unsigned int (*clk_update)(struct tmio_mmc_host *host,
100 unsigned int new_clock);
Ben Hutchings0ea28212016-04-01 17:44:31 +0200101 void (*clk_disable)(struct tmio_mmc_host *host);
Kuninori Morimoto85c02dd2015-01-13 04:58:10 +0000102 int (*multi_io_quirk)(struct mmc_card *card,
103 unsigned int direction, int blk_size);
Wolfram Sang452e5ee2016-04-01 17:44:33 +0200104 int (*start_signal_voltage_switch)(struct mmc_host *mmc,
105 struct mmc_ios *ios);
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100106};
107
Kuninori Morimoto94b110a2015-01-13 04:57:22 +0000108struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev);
109void tmio_mmc_host_free(struct tmio_mmc_host *host);
110int tmio_mmc_host_probe(struct tmio_mmc_host *host,
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100111 struct tmio_mmc_data *pdata);
112void tmio_mmc_host_remove(struct tmio_mmc_host *host);
113void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
114
115void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
116void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
Magnus Damm8e7bfdb2011-05-06 11:02:33 +0000117irqreturn_t tmio_mmc_irq(int irq, void *devid);
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100118
119static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
120 unsigned long *flags)
121{
122 local_irq_save(*flags);
Cong Wang482fce92011-11-27 13:27:00 +0800123 return kmap_atomic(sg_page(sg)) + sg->offset;
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100124}
125
126static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
127 unsigned long *flags, void *virt)
128{
Cong Wang482fce92011-11-27 13:27:00 +0800129 kunmap_atomic(virt - sg->offset);
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100130 local_irq_restore(*flags);
131}
132
Guennadi Liakhovetski42051e82011-03-14 09:52:33 +0100133#if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100134void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
Guennadi Liakhovetski162f43e2011-07-14 18:39:10 +0200135void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100136void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
137void tmio_mmc_release_dma(struct tmio_mmc_host *host);
Guennadi Liakhovetskie3de2be2012-01-06 13:06:51 +0100138void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100139#else
140static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
141 struct mmc_data *data)
142{
143}
144
Guennadi Liakhovetski162f43e2011-07-14 18:39:10 +0200145static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
146{
147}
148
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100149static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
150 struct tmio_mmc_data *pdata)
151{
152 host->chan_tx = NULL;
153 host->chan_rx = NULL;
154}
155
156static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
157{
158}
Guennadi Liakhovetskie3de2be2012-01-06 13:06:51 +0100159
160static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
161{
162}
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100163#endif
164
Ulf Hansson9ade7db2014-08-25 12:03:20 +0200165#ifdef CONFIG_PM
Guennadi Liakhovetski7311bef2011-05-11 16:51:11 +0000166int tmio_mmc_host_runtime_suspend(struct device *dev);
167int tmio_mmc_host_runtime_resume(struct device *dev);
Ulf Hansson710dec92013-10-23 14:55:07 +0200168#endif
Guennadi Liakhovetski7311bef2011-05-11 16:51:11 +0000169
Simon Hormana11862d2011-06-21 08:00:09 +0900170static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
171{
Kuninori Morimoto7445bf92015-01-13 04:58:20 +0000172 return readw(host->ctl + (addr << host->bus_shift));
Simon Hormana11862d2011-06-21 08:00:09 +0900173}
174
175static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
176 u16 *buf, int count)
177{
Kuninori Morimoto7445bf92015-01-13 04:58:20 +0000178 readsw(host->ctl + (addr << host->bus_shift), buf, count);
Simon Hormana11862d2011-06-21 08:00:09 +0900179}
180
181static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
182{
Kuninori Morimoto7445bf92015-01-13 04:58:20 +0000183 return readw(host->ctl + (addr << host->bus_shift)) |
184 readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
Simon Hormana11862d2011-06-21 08:00:09 +0900185}
186
187static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
188{
Simon Horman973ed3a2011-06-21 08:00:10 +0900189 /* If there is a hook and it returns non-zero then there
190 * is an error and the write should be skipped
191 */
Kuninori Morimotodfe9a222015-01-13 04:57:42 +0000192 if (host->write16_hook && host->write16_hook(host, addr))
Simon Horman973ed3a2011-06-21 08:00:10 +0900193 return;
Kuninori Morimoto7445bf92015-01-13 04:58:20 +0000194 writew(val, host->ctl + (addr << host->bus_shift));
Simon Hormana11862d2011-06-21 08:00:09 +0900195}
196
197static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
198 u16 *buf, int count)
199{
Kuninori Morimoto7445bf92015-01-13 04:58:20 +0000200 writesw(host->ctl + (addr << host->bus_shift), buf, count);
Simon Hormana11862d2011-06-21 08:00:09 +0900201}
202
203static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
204{
Kuninori Morimoto7445bf92015-01-13 04:58:20 +0000205 writew(val, host->ctl + (addr << host->bus_shift));
206 writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
Simon Hormana11862d2011-06-21 08:00:09 +0900207}
208
209
Guennadi Liakhovetskib6147492011-03-23 12:42:44 +0100210#endif