xref: /openbmc/linux/drivers/mmc/host/tmio_mmc.h (revision 9cfc5c90)
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/dmaengine.h>
20 #include <linux/highmem.h>
21 #include <linux/mmc/tmio.h>
22 #include <linux/mutex.h>
23 #include <linux/pagemap.h>
24 #include <linux/scatterlist.h>
25 #include <linux/spinlock.h>
26 
27 /* Definitions for values the CTRL_SDIO_STATUS register can take. */
28 #define TMIO_SDIO_STAT_IOIRQ	0x0001
29 #define TMIO_SDIO_STAT_EXPUB52	0x4000
30 #define TMIO_SDIO_STAT_EXWT	0x8000
31 #define TMIO_SDIO_MASK_ALL	0xc007
32 
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 
42 struct tmio_mmc_data;
43 struct tmio_mmc_host;
44 
45 struct tmio_mmc_dma {
46 	enum dma_slave_buswidth dma_buswidth;
47 	bool (*filter)(struct dma_chan *chan, void *arg);
48 	void (*enable)(struct tmio_mmc_host *host, bool enable);
49 };
50 
51 struct tmio_mmc_host {
52 	void __iomem *ctl;
53 	struct mmc_command      *cmd;
54 	struct mmc_request      *mrq;
55 	struct mmc_data         *data;
56 	struct mmc_host         *mmc;
57 
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;
67 	unsigned long		bus_shift;
68 
69 	struct platform_device *pdev;
70 	struct tmio_mmc_data *pdata;
71 	struct tmio_mmc_dma	*dma;
72 
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;
84 	struct work_struct	done;
85 
86 	/* Cache */
87 	u32			sdcard_irq_mask;
88 	u32			sdio_irq_mask;
89 	unsigned int		clk_cache;
90 
91 	spinlock_t		lock;		/* protect host private data */
92 	unsigned long		last_req_ts;
93 	struct mutex		ios_lock;	/* protect set_ios() context */
94 	bool			native_hotplug;
95 	bool			sdio_irq_enabled;
96 
97 	int (*write16_hook)(struct tmio_mmc_host *host, int addr);
98 	int (*clk_enable)(struct platform_device *pdev, unsigned int *f);
99 	void (*clk_disable)(struct platform_device *pdev);
100 	int (*multi_io_quirk)(struct mmc_card *card,
101 			      unsigned int direction, int blk_size);
102 };
103 
104 struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev);
105 void tmio_mmc_host_free(struct tmio_mmc_host *host);
106 int tmio_mmc_host_probe(struct tmio_mmc_host *host,
107 			struct tmio_mmc_data *pdata);
108 void tmio_mmc_host_remove(struct tmio_mmc_host *host);
109 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host);
110 
111 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
112 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i);
113 irqreturn_t tmio_mmc_irq(int irq, void *devid);
114 irqreturn_t tmio_mmc_sdcard_irq(int irq, void *devid);
115 irqreturn_t tmio_mmc_card_detect_irq(int irq, void *devid);
116 irqreturn_t tmio_mmc_sdio_irq(int irq, void *devid);
117 
118 static inline char *tmio_mmc_kmap_atomic(struct scatterlist *sg,
119 					 unsigned long *flags)
120 {
121 	local_irq_save(*flags);
122 	return kmap_atomic(sg_page(sg)) + sg->offset;
123 }
124 
125 static inline void tmio_mmc_kunmap_atomic(struct scatterlist *sg,
126 					  unsigned long *flags, void *virt)
127 {
128 	kunmap_atomic(virt - sg->offset);
129 	local_irq_restore(*flags);
130 }
131 
132 #if defined(CONFIG_MMC_SDHI) || defined(CONFIG_MMC_SDHI_MODULE)
133 void tmio_mmc_start_dma(struct tmio_mmc_host *host, struct mmc_data *data);
134 void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable);
135 void tmio_mmc_request_dma(struct tmio_mmc_host *host, struct tmio_mmc_data *pdata);
136 void tmio_mmc_release_dma(struct tmio_mmc_host *host);
137 void tmio_mmc_abort_dma(struct tmio_mmc_host *host);
138 #else
139 static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
140 			       struct mmc_data *data)
141 {
142 }
143 
144 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
145 {
146 }
147 
148 static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
149 				 struct tmio_mmc_data *pdata)
150 {
151 	host->chan_tx = NULL;
152 	host->chan_rx = NULL;
153 }
154 
155 static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
156 {
157 }
158 
159 static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
160 {
161 }
162 #endif
163 
164 #ifdef CONFIG_PM
165 int tmio_mmc_host_runtime_suspend(struct device *dev);
166 int tmio_mmc_host_runtime_resume(struct device *dev);
167 #endif
168 
169 static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
170 {
171 	return readw(host->ctl + (addr << host->bus_shift));
172 }
173 
174 static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
175 		u16 *buf, int count)
176 {
177 	readsw(host->ctl + (addr << host->bus_shift), buf, count);
178 }
179 
180 static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
181 {
182 	return readw(host->ctl + (addr << host->bus_shift)) |
183 	       readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
184 }
185 
186 static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr, u16 val)
187 {
188 	/* If there is a hook and it returns non-zero then there
189 	 * is an error and the write should be skipped
190 	 */
191 	if (host->write16_hook && host->write16_hook(host, addr))
192 		return;
193 	writew(val, host->ctl + (addr << host->bus_shift));
194 }
195 
196 static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
197 		u16 *buf, int count)
198 {
199 	writesw(host->ctl + (addr << host->bus_shift), buf, count);
200 }
201 
202 static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr, u32 val)
203 {
204 	writew(val, host->ctl + (addr << host->bus_shift));
205 	writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
206 }
207 
208 
209 #endif
210