bc19e5fb7ea8f1791960e961e7a9dab803f15a54
[linux-2.6.git] / include / linux / mfd / ucb1x00.h
1 /*
2  *  linux/include/mfd/ucb1x00.h
3  *
4  *  Copyright (C) 2001 Russell King, All Rights Reserved.
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 as published by
8  * the Free Software Foundation; either version 2 of the License.
9  */
10 #ifndef UCB1200_H
11 #define UCB1200_H
12
13 #include <linux/mfd/mcp.h>
14 #include <linux/gpio.h>
15 #include <linux/semaphore.h>
16
17 #define UCB_IO_DATA     0x00
18 #define UCB_IO_DIR      0x01
19
20 #define UCB_IO_0                (1 << 0)
21 #define UCB_IO_1                (1 << 1)
22 #define UCB_IO_2                (1 << 2)
23 #define UCB_IO_3                (1 << 3)
24 #define UCB_IO_4                (1 << 4)
25 #define UCB_IO_5                (1 << 5)
26 #define UCB_IO_6                (1 << 6)
27 #define UCB_IO_7                (1 << 7)
28 #define UCB_IO_8                (1 << 8)
29 #define UCB_IO_9                (1 << 9)
30
31 #define UCB_IE_RIS      0x02
32 #define UCB_IE_FAL      0x03
33 #define UCB_IE_STATUS   0x04
34 #define UCB_IE_CLEAR    0x04
35 #define UCB_IE_ADC              (1 << 11)
36 #define UCB_IE_TSPX             (1 << 12)
37 #define UCB_IE_TSMX             (1 << 13)
38 #define UCB_IE_TCLIP            (1 << 14)
39 #define UCB_IE_ACLIP            (1 << 15)
40
41 #define UCB_IRQ_TSPX            12
42
43 #define UCB_TC_A        0x05
44 #define UCB_TC_A_LOOP           (1 << 7)        /* UCB1200 */
45 #define UCB_TC_A_AMPL           (1 << 7)        /* UCB1300 */
46
47 #define UCB_TC_B        0x06
48 #define UCB_TC_B_VOICE_ENA      (1 << 3)
49 #define UCB_TC_B_CLIP           (1 << 4)
50 #define UCB_TC_B_ATT            (1 << 6)
51 #define UCB_TC_B_SIDE_ENA       (1 << 11)
52 #define UCB_TC_B_MUTE           (1 << 13)
53 #define UCB_TC_B_IN_ENA         (1 << 14)
54 #define UCB_TC_B_OUT_ENA        (1 << 15)
55
56 #define UCB_AC_A        0x07
57 #define UCB_AC_B        0x08
58 #define UCB_AC_B_LOOP           (1 << 8)
59 #define UCB_AC_B_MUTE           (1 << 13)
60 #define UCB_AC_B_IN_ENA         (1 << 14)
61 #define UCB_AC_B_OUT_ENA        (1 << 15)
62
63 #define UCB_TS_CR       0x09
64 #define UCB_TS_CR_TSMX_POW      (1 << 0)
65 #define UCB_TS_CR_TSPX_POW      (1 << 1)
66 #define UCB_TS_CR_TSMY_POW      (1 << 2)
67 #define UCB_TS_CR_TSPY_POW      (1 << 3)
68 #define UCB_TS_CR_TSMX_GND      (1 << 4)
69 #define UCB_TS_CR_TSPX_GND      (1 << 5)
70 #define UCB_TS_CR_TSMY_GND      (1 << 6)
71 #define UCB_TS_CR_TSPY_GND      (1 << 7)
72 #define UCB_TS_CR_MODE_INT      (0 << 8)
73 #define UCB_TS_CR_MODE_PRES     (1 << 8)
74 #define UCB_TS_CR_MODE_POS      (2 << 8)
75 #define UCB_TS_CR_BIAS_ENA      (1 << 11)
76 #define UCB_TS_CR_TSPX_LOW      (1 << 12)
77 #define UCB_TS_CR_TSMX_LOW      (1 << 13)
78
79 #define UCB_ADC_CR      0x0a
80 #define UCB_ADC_SYNC_ENA        (1 << 0)
81 #define UCB_ADC_VREFBYP_CON     (1 << 1)
82 #define UCB_ADC_INP_TSPX        (0 << 2)
83 #define UCB_ADC_INP_TSMX        (1 << 2)
84 #define UCB_ADC_INP_TSPY        (2 << 2)
85 #define UCB_ADC_INP_TSMY        (3 << 2)
86 #define UCB_ADC_INP_AD0         (4 << 2)
87 #define UCB_ADC_INP_AD1         (5 << 2)
88 #define UCB_ADC_INP_AD2         (6 << 2)
89 #define UCB_ADC_INP_AD3         (7 << 2)
90 #define UCB_ADC_EXT_REF         (1 << 5)
91 #define UCB_ADC_START           (1 << 7)
92 #define UCB_ADC_ENA             (1 << 15)
93
94 #define UCB_ADC_DATA    0x0b
95 #define UCB_ADC_DAT_VAL         (1 << 15)
96 #define UCB_ADC_DAT(x)          (((x) & 0x7fe0) >> 5)
97
98 #define UCB_ID          0x0c
99 #define UCB_ID_1200             0x1004
100 #define UCB_ID_1300             0x1005
101 #define UCB_ID_TC35143          0x9712
102
103 #define UCB_MODE        0x0d
104 #define UCB_MODE_DYN_VFLAG_ENA  (1 << 12)
105 #define UCB_MODE_AUD_OFF_CAN    (1 << 13)
106
107 struct ucb1x00_plat_data {
108         int             gpio_base;
109 };
110
111 struct ucb1x00_irq {
112         void *devid;
113         void (*fn)(int, void *);
114 };
115
116 struct ucb1x00 {
117         spinlock_t              lock;
118         struct mcp              *mcp;
119         unsigned int            irq;
120         struct semaphore        adc_sem;
121         spinlock_t              io_lock;
122         const struct mcp_device_id *id;
123         u16                     io_dir;
124         u16                     io_out;
125         u16                     adc_cr;
126         u16                     irq_fal_enbl;
127         u16                     irq_ris_enbl;
128         struct ucb1x00_irq      irq_handler[16];
129         struct device           dev;
130         struct list_head        node;
131         struct list_head        devs;
132         struct gpio_chip        gpio;
133 };
134
135 struct ucb1x00_driver;
136
137 struct ucb1x00_dev {
138         struct list_head        dev_node;
139         struct list_head        drv_node;
140         struct ucb1x00          *ucb;
141         struct ucb1x00_driver   *drv;
142         void                    *priv;
143 };
144
145 struct ucb1x00_driver {
146         struct list_head        node;
147         struct list_head        devs;
148         int     (*add)(struct ucb1x00_dev *dev);
149         void    (*remove)(struct ucb1x00_dev *dev);
150         int     (*suspend)(struct ucb1x00_dev *dev, pm_message_t state);
151         int     (*resume)(struct ucb1x00_dev *dev);
152 };
153
154 #define classdev_to_ucb1x00(cd) container_of(cd, struct ucb1x00, dev)
155
156 int ucb1x00_register_driver(struct ucb1x00_driver *);
157 void ucb1x00_unregister_driver(struct ucb1x00_driver *);
158
159 /**
160  *      ucb1x00_clkrate - return the UCB1x00 SIB clock rate
161  *      @ucb: UCB1x00 structure describing chip
162  *
163  *      Return the SIB clock rate in Hz.
164  */
165 static inline unsigned int ucb1x00_clkrate(struct ucb1x00 *ucb)
166 {
167         return mcp_get_sclk_rate(ucb->mcp);
168 }
169
170 /**
171  *      ucb1x00_enable - enable the UCB1x00 SIB clock
172  *      @ucb: UCB1x00 structure describing chip
173  *
174  *      Enable the SIB clock.  This can be called multiple times.
175  */
176 static inline void ucb1x00_enable(struct ucb1x00 *ucb)
177 {
178         mcp_enable(ucb->mcp);
179 }
180
181 /**
182  *      ucb1x00_disable - disable the UCB1x00 SIB clock
183  *      @ucb: UCB1x00 structure describing chip
184  *
185  *      Disable the SIB clock.  The SIB clock will only be disabled
186  *      when the number of ucb1x00_enable calls match the number of
187  *      ucb1x00_disable calls.
188  */
189 static inline void ucb1x00_disable(struct ucb1x00 *ucb)
190 {
191         mcp_disable(ucb->mcp);
192 }
193
194 /**
195  *      ucb1x00_reg_write - write a UCB1x00 register
196  *      @ucb: UCB1x00 structure describing chip
197  *      @reg: UCB1x00 4-bit register index to write
198  *      @val: UCB1x00 16-bit value to write
199  *
200  *      Write the UCB1x00 register @reg with value @val.  The SIB
201  *      clock must be running for this function to return.
202  */
203 static inline void ucb1x00_reg_write(struct ucb1x00 *ucb, unsigned int reg, unsigned int val)
204 {
205         mcp_reg_write(ucb->mcp, reg, val);
206 }
207
208 /**
209  *      ucb1x00_reg_read - read a UCB1x00 register
210  *      @ucb: UCB1x00 structure describing chip
211  *      @reg: UCB1x00 4-bit register index to write
212  *
213  *      Read the UCB1x00 register @reg and return its value.  The SIB
214  *      clock must be running for this function to return.
215  */
216 static inline unsigned int ucb1x00_reg_read(struct ucb1x00 *ucb, unsigned int reg)
217 {
218         return mcp_reg_read(ucb->mcp, reg);
219 }
220 /**
221  *      ucb1x00_set_audio_divisor - 
222  *      @ucb: UCB1x00 structure describing chip
223  *      @div: SIB clock divisor
224  */
225 static inline void ucb1x00_set_audio_divisor(struct ucb1x00 *ucb, unsigned int div)
226 {
227         mcp_set_audio_divisor(ucb->mcp, div);
228 }
229
230 /**
231  *      ucb1x00_set_telecom_divisor -
232  *      @ucb: UCB1x00 structure describing chip
233  *      @div: SIB clock divisor
234  */
235 static inline void ucb1x00_set_telecom_divisor(struct ucb1x00 *ucb, unsigned int div)
236 {
237         mcp_set_telecom_divisor(ucb->mcp, div);
238 }
239
240 void ucb1x00_io_set_dir(struct ucb1x00 *ucb, unsigned int, unsigned int);
241 void ucb1x00_io_write(struct ucb1x00 *ucb, unsigned int, unsigned int);
242 unsigned int ucb1x00_io_read(struct ucb1x00 *ucb);
243
244 #define UCB_NOSYNC      (0)
245 #define UCB_SYNC        (1)
246
247 unsigned int ucb1x00_adc_read(struct ucb1x00 *ucb, int adc_channel, int sync);
248 void ucb1x00_adc_enable(struct ucb1x00 *ucb);
249 void ucb1x00_adc_disable(struct ucb1x00 *ucb);
250
251 /*
252  * Which edges of the IRQ do you want to control today?
253  */
254 #define UCB_RISING      (1 << 0)
255 #define UCB_FALLING     (1 << 1)
256
257 int ucb1x00_hook_irq(struct ucb1x00 *ucb, unsigned int idx, void (*fn)(int, void *), void *devid);
258 void ucb1x00_enable_irq(struct ucb1x00 *ucb, unsigned int idx, int edges);
259 void ucb1x00_disable_irq(struct ucb1x00 *ucb, unsigned int idx, int edges);
260 int ucb1x00_free_irq(struct ucb1x00 *ucb, unsigned int idx, void *devid);
261
262 #endif