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