xref: /linux/drivers/mmc/host/tmio_mmc.h (revision 4949009eb8d40a441dcddcd96e101e77d31cf1b2)
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 struct tmio_mmc_host {
44 	void __iomem *ctl;
45 	struct mmc_command      *cmd;
46 	struct mmc_request      *mrq;
47 	struct mmc_data         *data;
48 	struct mmc_host         *mmc;
49 
50 	/* Callbacks for clock / power control */
51 	void (*set_pwr)(struct platform_device *host, int state);
52 	void (*set_clk_div)(struct platform_device *host, int state);
53 
54 	/* pio related stuff */
55 	struct scatterlist      *sg_ptr;
56 	struct scatterlist      *sg_orig;
57 	unsigned int            sg_len;
58 	unsigned int            sg_off;
59 
60 	struct platform_device *pdev;
61 	struct tmio_mmc_data *pdata;
62 
63 	/* DMA support */
64 	bool			force_pio;
65 	struct dma_chan		*chan_rx;
66 	struct dma_chan		*chan_tx;
67 	struct tasklet_struct	dma_complete;
68 	struct tasklet_struct	dma_issue;
69 	struct scatterlist	bounce_sg;
70 	u8			*bounce_buf;
71 
72 	/* Track lost interrupts */
73 	struct delayed_work	delayed_reset_work;
74 	struct work_struct	done;
75 
76 	/* Cache */
77 	u32			sdcard_irq_mask;
78 	u32			sdio_irq_mask;
79 	unsigned int		clk_cache;
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 	bool			native_hotplug;
85 	bool			sdio_irq_enabled;
86 };
87 
88 int tmio_mmc_host_probe(struct tmio_mmc_host **host,
89 			struct platform_device *pdev,
90 			struct tmio_mmc_data *pdata);
91 void tmio_mmc_host_remove(struct tmio_mmc_host *host);
92 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
93 
94 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
95 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
96 irqreturn_t tmio_mmc_irq(int irq, void *devid);
97 irqreturn_t tmio_mmc_sdcard_irq(int irq, void *devid);
98 irqreturn_t tmio_mmc_card_detect_irq(int irq, void *devid);
99 irqreturn_t tmio_mmc_sdio_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)) + 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);
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 void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
121 #else
122 static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
123 			       struct mmc_data *data)
124 {
125 }
126 
127 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
128 {
129 }
130 
131 static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
132 				 struct tmio_mmc_data *pdata)
133 {
134 	host->chan_tx = NULL;
135 	host->chan_rx = NULL;
136 }
137 
138 static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
139 {
140 }
141 
142 static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
143 {
144 }
145 #endif
146 
147 #ifdef CONFIG_PM
148 int tmio_mmc_host_runtime_suspend(struct device *dev);
149 int tmio_mmc_host_runtime_resume(struct device *dev);
150 #endif
151 
152 static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
153 {
154 	return readw(host->ctl + (addr << host->pdata->bus_shift));
155 }
156 
157 static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
158 		u16 *buf, int count)
159 {
160 	readsw(host->ctl + (addr << host->pdata->bus_shift), buf, count);
161 }
162 
163 static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
164 {
165 	return readw(host->ctl + (addr << host->pdata->bus_shift)) |
166 	       readw(host->ctl + ((addr + 2) << host->pdata->bus_shift)) << 16;
167 }
168 
169 static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
170 {
171 	/* If there is a hook and it returns non-zero then there
172 	 * is an error and the write should be skipped
173 	 */
174 	if (host->pdata->write16_hook && host->pdata->write16_hook(host, addr))
175 		return;
176 	writew(val, host->ctl + (addr << host->pdata->bus_shift));
177 }
178 
179 static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
180 		u16 *buf, int count)
181 {
182 	writesw(host->ctl + (addr << host->pdata->bus_shift), buf, count);
183 }
184 
185 static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
186 {
187 	writew(val, host->ctl + (addr << host->pdata->bus_shift));
188 	writew(val >> 16, host->ctl + ((addr + 2) << host->pdata->bus_shift));
189 }
190 
191 
192 #endif
193