mfd: tmio_mmc hardware abstraction for CNF area
[safe/jmp/linux-2.6] / drivers / mmc / host / tmio_mmc.h
1 /* Definitons for use with the tmio_mmc.c
2  *
3  * (c) 2004 Ian Molton <spyro@f2s.com>
4  * (c) 2007 Ian Molton <spyro@f2s.com>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  */
11
12 #include <linux/highmem.h>
13
14 #define CTL_SD_CMD 0x00
15 #define CTL_ARG_REG 0x04
16 #define CTL_STOP_INTERNAL_ACTION 0x08
17 #define CTL_XFER_BLK_COUNT 0xa
18 #define CTL_RESPONSE 0x0c
19 #define CTL_STATUS 0x1c
20 #define CTL_IRQ_MASK 0x20
21 #define CTL_SD_CARD_CLK_CTL 0x24
22 #define CTL_SD_XFER_LEN 0x26
23 #define CTL_SD_MEM_CARD_OPT 0x28
24 #define CTL_SD_ERROR_DETAIL_STATUS 0x2c
25 #define CTL_SD_DATA_PORT 0x30
26 #define CTL_TRANSACTION_CTL 0x34
27 #define CTL_RESET_SD 0xe0
28 #define CTL_SDIO_REGS 0x100
29 #define CTL_CLK_AND_WAIT_CTL 0x138
30 #define CTL_RESET_SDIO 0x1e0
31
32 /* Definitions for values the CTRL_STATUS register can take. */
33 #define TMIO_STAT_CMDRESPEND    0x00000001
34 #define TMIO_STAT_DATAEND       0x00000004
35 #define TMIO_STAT_CARD_REMOVE   0x00000008
36 #define TMIO_STAT_CARD_INSERT   0x00000010
37 #define TMIO_STAT_SIGSTATE      0x00000020
38 #define TMIO_STAT_WRPROTECT     0x00000080
39 #define TMIO_STAT_CARD_REMOVE_A 0x00000100
40 #define TMIO_STAT_CARD_INSERT_A 0x00000200
41 #define TMIO_STAT_SIGSTATE_A    0x00000400
42 #define TMIO_STAT_CMD_IDX_ERR   0x00010000
43 #define TMIO_STAT_CRCFAIL       0x00020000
44 #define TMIO_STAT_STOPBIT_ERR   0x00040000
45 #define TMIO_STAT_DATATIMEOUT   0x00080000
46 #define TMIO_STAT_RXOVERFLOW    0x00100000
47 #define TMIO_STAT_TXUNDERRUN    0x00200000
48 #define TMIO_STAT_CMDTIMEOUT    0x00400000
49 #define TMIO_STAT_RXRDY         0x01000000
50 #define TMIO_STAT_TXRQ          0x02000000
51 #define TMIO_STAT_ILL_FUNC      0x20000000
52 #define TMIO_STAT_CMD_BUSY      0x40000000
53 #define TMIO_STAT_ILL_ACCESS    0x80000000
54
55 /* Define some IRQ masks */
56 /* This is the mask used at reset by the chip */
57 #define TMIO_MASK_ALL           0x837f031d
58 #define TMIO_MASK_READOP  (TMIO_STAT_RXRDY | TMIO_STAT_DATAEND | \
59                 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
60 #define TMIO_MASK_WRITEOP (TMIO_STAT_TXRQ | TMIO_STAT_DATAEND | \
61                 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
62 #define TMIO_MASK_CMD     (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT | \
63                 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT)
64 #define TMIO_MASK_IRQ     (TMIO_MASK_READOP | TMIO_MASK_WRITEOP | TMIO_MASK_CMD)
65
66
67 #define enable_mmc_irqs(host, i) \
68         do { \
69                 u32 mask;\
70                 mask  = sd_ctrl_read32((host), CTL_IRQ_MASK); \
71                 mask &= ~((i) & TMIO_MASK_IRQ); \
72                 sd_ctrl_write32((host), CTL_IRQ_MASK, mask); \
73         } while (0)
74
75 #define disable_mmc_irqs(host, i) \
76         do { \
77                 u32 mask;\
78                 mask  = sd_ctrl_read32((host), CTL_IRQ_MASK); \
79                 mask |= ((i) & TMIO_MASK_IRQ); \
80                 sd_ctrl_write32((host), CTL_IRQ_MASK, mask); \
81         } while (0)
82
83 #define ack_mmc_irqs(host, i) \
84         do { \
85                 u32 mask;\
86                 mask  = sd_ctrl_read32((host), CTL_STATUS); \
87                 mask &= ~((i) & TMIO_MASK_IRQ); \
88                 sd_ctrl_write32((host), CTL_STATUS, mask); \
89         } while (0)
90
91
92 struct tmio_mmc_host {
93         void __iomem *ctl;
94         unsigned long bus_shift;
95         struct mmc_command      *cmd;
96         struct mmc_request      *mrq;
97         struct mmc_data         *data;
98         struct mmc_host         *mmc;
99         int                     irq;
100
101         /* Callbacks for clock / power control */
102         void (*set_pwr)(struct platform_device *host, int state);
103         void (*set_clk_div)(struct platform_device *host, int state);
104
105         /* pio related stuff */
106         struct scatterlist      *sg_ptr;
107         unsigned int            sg_len;
108         unsigned int            sg_off;
109
110         struct platform_device *pdev;
111 };
112
113 #include <linux/io.h>
114
115 static inline u16 sd_ctrl_read16(struct tmio_mmc_host *host, int addr)
116 {
117         return readw(host->ctl + (addr << host->bus_shift));
118 }
119
120 static inline void sd_ctrl_read16_rep(struct tmio_mmc_host *host, int addr,
121                 u16 *buf, int count)
122 {
123         readsw(host->ctl + (addr << host->bus_shift), buf, count);
124 }
125
126 static inline u32 sd_ctrl_read32(struct tmio_mmc_host *host, int addr)
127 {
128         return readw(host->ctl + (addr << host->bus_shift)) |
129                readw(host->ctl + ((addr + 2) << host->bus_shift)) << 16;
130 }
131
132 static inline void sd_ctrl_write16(struct tmio_mmc_host *host, int addr,
133                 u16 val)
134 {
135         writew(val, host->ctl + (addr << host->bus_shift));
136 }
137
138 static inline void sd_ctrl_write16_rep(struct tmio_mmc_host *host, int addr,
139                 u16 *buf, int count)
140 {
141         writesw(host->ctl + (addr << host->bus_shift), buf, count);
142 }
143
144 static inline void sd_ctrl_write32(struct tmio_mmc_host *host, int addr,
145                 u32 val)
146 {
147         writew(val, host->ctl + (addr << host->bus_shift));
148         writew(val >> 16, host->ctl + ((addr + 2) << host->bus_shift));
149 }
150
151 #include <linux/scatterlist.h>
152 #include <linux/blkdev.h>
153
154 static inline void tmio_mmc_init_sg(struct tmio_mmc_host *host,
155         struct mmc_data *data)
156 {
157         host->sg_len = data->sg_len;
158         host->sg_ptr = data->sg;
159         host->sg_off = 0;
160 }
161
162 static inline int tmio_mmc_next_sg(struct tmio_mmc_host *host)
163 {
164         host->sg_ptr = sg_next(host->sg_ptr);
165         host->sg_off = 0;
166         return --host->sg_len;
167 }
168
169 static inline char *tmio_mmc_kmap_atomic(struct tmio_mmc_host *host,
170         unsigned long *flags)
171 {
172         struct scatterlist *sg = host->sg_ptr;
173
174         local_irq_save(*flags);
175         return kmap_atomic(sg_page(sg), KM_BIO_SRC_IRQ) + sg->offset;
176 }
177
178 static inline void tmio_mmc_kunmap_atomic(struct tmio_mmc_host *host,
179         unsigned long *flags)
180 {
181         kunmap_atomic(sg_page(host->sg_ptr), KM_BIO_SRC_IRQ);
182         local_irq_restore(*flags);
183 }
184
185 #ifdef CONFIG_MMC_DEBUG
186
187 #define STATUS_TO_TEXT(a) \
188         do { \
189                 if (status & TMIO_STAT_##a) \
190                         printk(#a); \
191         } while (0)
192
193 void pr_debug_status(u32 status)
194 {
195         printk(KERN_DEBUG "status: %08x = ", status);
196         STATUS_TO_TEXT(CARD_REMOVE);
197         STATUS_TO_TEXT(CARD_INSERT);
198         STATUS_TO_TEXT(SIGSTATE);
199         STATUS_TO_TEXT(WRPROTECT);
200         STATUS_TO_TEXT(CARD_REMOVE_A);
201         STATUS_TO_TEXT(CARD_INSERT_A);
202         STATUS_TO_TEXT(SIGSTATE_A);
203         STATUS_TO_TEXT(CMD_IDX_ERR);
204         STATUS_TO_TEXT(STOPBIT_ERR);
205         STATUS_TO_TEXT(ILL_FUNC);
206         STATUS_TO_TEXT(CMD_BUSY);
207         STATUS_TO_TEXT(CMDRESPEND);
208         STATUS_TO_TEXT(DATAEND);
209         STATUS_TO_TEXT(CRCFAIL);
210         STATUS_TO_TEXT(DATATIMEOUT);
211         STATUS_TO_TEXT(CMDTIMEOUT);
212         STATUS_TO_TEXT(RXOVERFLOW);
213         STATUS_TO_TEXT(TXUNDERRUN);
214         STATUS_TO_TEXT(RXRDY);
215         STATUS_TO_TEXT(TXRQ);
216         STATUS_TO_TEXT(ILL_ACCESS);
217         printk("\n");
218 }
219
220 #else
221 #define pr_debug_status(s)  do { } while (0)
222 #endif