1 2 /* 3 * Register bits and API for Wolfson WM97xx series of codecs 4 */ 5 6 #ifndef _LINUX_WM97XX_H 7 #define _LINUX_WM97XX_H 8 9 #include <sound/core.h> 10 #include <sound/pcm.h> 11 #include <sound/ac97_codec.h> 12 #include <sound/initval.h> 13 #include <linux/types.h> 14 #include <linux/list.h> 15 #include <linux/input.h> /* Input device layer */ 16 #include <linux/platform_device.h> 17 18 /* 19 * WM97xx variants 20 */ 21 #define WM97xx_GENERIC 0x0000 22 #define WM97xx_WM1613 0x1613 23 24 /* 25 * WM97xx AC97 Touchscreen registers 26 */ 27 #define AC97_WM97XX_DIGITISER1 0x76 28 #define AC97_WM97XX_DIGITISER2 0x78 29 #define AC97_WM97XX_DIGITISER_RD 0x7a 30 #define AC97_WM9713_DIG1 0x74 31 #define AC97_WM9713_DIG2 AC97_WM97XX_DIGITISER1 32 #define AC97_WM9713_DIG3 AC97_WM97XX_DIGITISER2 33 34 /* 35 * WM97xx register bits 36 */ 37 #define WM97XX_POLL 0x8000 /* initiate a polling measurement */ 38 #define WM97XX_ADCSEL_X 0x1000 /* x coord measurement */ 39 #define WM97XX_ADCSEL_Y 0x2000 /* y coord measurement */ 40 #define WM97XX_ADCSEL_PRES 0x3000 /* pressure measurement */ 41 #define WM97XX_ADCSEL_MASK 0x7000 42 #define WM97XX_COO 0x0800 /* enable coordinate mode */ 43 #define WM97XX_CTC 0x0400 /* enable continuous mode */ 44 #define WM97XX_CM_RATE_93 0x0000 /* 93.75Hz continuous rate */ 45 #define WM97XX_CM_RATE_187 0x0100 /* 187.5Hz continuous rate */ 46 #define WM97XX_CM_RATE_375 0x0200 /* 375Hz continuous rate */ 47 #define WM97XX_CM_RATE_750 0x0300 /* 750Hz continuous rate */ 48 #define WM97XX_CM_RATE_8K 0x00f0 /* 8kHz continuous rate */ 49 #define WM97XX_CM_RATE_12K 0x01f0 /* 12kHz continuous rate */ 50 #define WM97XX_CM_RATE_24K 0x02f0 /* 24kHz continuous rate */ 51 #define WM97XX_CM_RATE_48K 0x03f0 /* 48kHz continuous rate */ 52 #define WM97XX_CM_RATE_MASK 0x03f0 53 #define WM97XX_RATE(i) (((i & 3) << 8) | ((i & 4) ? 0xf0 : 0)) 54 #define WM97XX_DELAY(i) ((i << 4) & 0x00f0) /* sample delay times */ 55 #define WM97XX_DELAY_MASK 0x00f0 56 #define WM97XX_SLEN 0x0008 /* slot read back enable */ 57 #define WM97XX_SLT(i) ((i - 5) & 0x7) /* panel slot (5-11) */ 58 #define WM97XX_SLT_MASK 0x0007 59 #define WM97XX_PRP_DETW 0x4000 /* detect on, digitise off, wake */ 60 #define WM97XX_PRP_DET 0x8000 /* detect on, digitise off, no wake */ 61 #define WM97XX_PRP_DET_DIG 0xc000 /* setect on, digitise on */ 62 #define WM97XX_RPR 0x2000 /* wake up on pen down */ 63 #define WM97XX_PEN_DOWN 0x8000 /* pen is down */ 64 #define WM97XX_ADCSRC_MASK 0x7000 /* ADC source mask */ 65 66 #define WM97XX_AUX_ID1 0x8001 67 #define WM97XX_AUX_ID2 0x8002 68 #define WM97XX_AUX_ID3 0x8003 69 #define WM97XX_AUX_ID4 0x8004 70 71 72 /* WM9712 Bits */ 73 #define WM9712_45W 0x1000 /* set for 5-wire touchscreen */ 74 #define WM9712_PDEN 0x0800 /* measure only when pen down */ 75 #define WM9712_WAIT 0x0200 /* wait until adc is read before next sample */ 76 #define WM9712_PIL 0x0100 /* current used for pressure measurement. set 400uA else 200uA */ 77 #define WM9712_MASK_HI 0x0040 /* hi on mask pin (47) stops conversions */ 78 #define WM9712_MASK_EDGE 0x0080 /* rising/falling edge on pin delays sample */ 79 #define WM9712_MASK_SYNC 0x00c0 /* rising/falling edge on mask initiates sample */ 80 #define WM9712_RPU(i) (i&0x3f) /* internal pull up on pen detect (64k / rpu) */ 81 #define WM9712_PD(i) (0x1 << i) /* power management */ 82 83 /* WM9712 Registers */ 84 #define AC97_WM9712_POWER 0x24 85 #define AC97_WM9712_REV 0x58 86 87 /* WM9705 Bits */ 88 #define WM9705_PDEN 0x1000 /* measure only when pen is down */ 89 #define WM9705_PINV 0x0800 /* inverts sense of pen down output */ 90 #define WM9705_BSEN 0x0400 /* BUSY flag enable, pin47 is 1 when busy */ 91 #define WM9705_BINV 0x0200 /* invert BUSY (pin47) output */ 92 #define WM9705_WAIT 0x0100 /* wait until adc is read before next sample */ 93 #define WM9705_PIL 0x0080 /* current used for pressure measurement. set 400uA else 200uA */ 94 #define WM9705_PHIZ 0x0040 /* set PHONE and PCBEEP inputs to high impedance */ 95 #define WM9705_MASK_HI 0x0010 /* hi on mask stops conversions */ 96 #define WM9705_MASK_EDGE 0x0020 /* rising/falling edge on pin delays sample */ 97 #define WM9705_MASK_SYNC 0x0030 /* rising/falling edge on mask initiates sample */ 98 #define WM9705_PDD(i) (i & 0x000f) /* pen detect comparator threshold */ 99 100 101 /* WM9713 Bits */ 102 #define WM9713_PDPOL 0x0400 /* Pen down polarity */ 103 #define WM9713_POLL 0x0200 /* initiate a polling measurement */ 104 #define WM9713_CTC 0x0100 /* enable continuous mode */ 105 #define WM9713_ADCSEL_X 0x0002 /* X measurement */ 106 #define WM9713_ADCSEL_Y 0x0004 /* Y measurement */ 107 #define WM9713_ADCSEL_PRES 0x0008 /* Pressure measurement */ 108 #define WM9713_COO 0x0001 /* enable coordinate mode */ 109 #define WM9713_45W 0x1000 /* set for 5 wire panel */ 110 #define WM9713_PDEN 0x0800 /* measure only when pen down */ 111 #define WM9713_ADCSEL_MASK 0x00fe /* ADC selection mask */ 112 #define WM9713_WAIT 0x0200 /* coordinate wait */ 113 114 /* AUX ADC ID's */ 115 #define TS_COMP1 0x0 116 #define TS_COMP2 0x1 117 #define TS_BMON 0x2 118 #define TS_WIPER 0x3 119 120 /* ID numbers */ 121 #define WM97XX_ID1 0x574d 122 #define WM9712_ID2 0x4c12 123 #define WM9705_ID2 0x4c05 124 #define WM9713_ID2 0x4c13 125 126 /* Codec GPIO's */ 127 #define WM97XX_MAX_GPIO 16 128 #define WM97XX_GPIO_1 (1 << 1) 129 #define WM97XX_GPIO_2 (1 << 2) 130 #define WM97XX_GPIO_3 (1 << 3) 131 #define WM97XX_GPIO_4 (1 << 4) 132 #define WM97XX_GPIO_5 (1 << 5) 133 #define WM97XX_GPIO_6 (1 << 6) 134 #define WM97XX_GPIO_7 (1 << 7) 135 #define WM97XX_GPIO_8 (1 << 8) 136 #define WM97XX_GPIO_9 (1 << 9) 137 #define WM97XX_GPIO_10 (1 << 10) 138 #define WM97XX_GPIO_11 (1 << 11) 139 #define WM97XX_GPIO_12 (1 << 12) 140 #define WM97XX_GPIO_13 (1 << 13) 141 #define WM97XX_GPIO_14 (1 << 14) 142 #define WM97XX_GPIO_15 (1 << 15) 143 144 145 #define AC97_LINK_FRAME 21 /* time in uS for AC97 link frame */ 146 147 148 /*---------------- Return codes from sample reading functions ---------------*/ 149 150 /* More data is available; call the sample gathering function again */ 151 #define RC_AGAIN 0x00000001 152 /* The returned sample is valid */ 153 #define RC_VALID 0x00000002 154 /* The pen is up (the first RC_VALID without RC_PENUP means pen is down) */ 155 #define RC_PENUP 0x00000004 156 /* The pen is down (RC_VALID implies RC_PENDOWN, but sometimes it is helpful 157 to tell the handler that the pen is down but we don't know yet his coords, 158 so the handler should not sleep or wait for pendown irq) */ 159 #define RC_PENDOWN 0x00000008 160 161 /* 162 * The wm97xx driver provides a private API for writing platform-specific 163 * drivers. 164 */ 165 166 /* The structure used to return arch specific sampled data into */ 167 struct wm97xx_data { 168 int x; 169 int y; 170 int p; 171 }; 172 173 /* 174 * Codec GPIO status 175 */ 176 enum wm97xx_gpio_status { 177 WM97XX_GPIO_HIGH, 178 WM97XX_GPIO_LOW 179 }; 180 181 /* 182 * Codec GPIO direction 183 */ 184 enum wm97xx_gpio_dir { 185 WM97XX_GPIO_IN, 186 WM97XX_GPIO_OUT 187 }; 188 189 /* 190 * Codec GPIO polarity 191 */ 192 enum wm97xx_gpio_pol { 193 WM97XX_GPIO_POL_HIGH, 194 WM97XX_GPIO_POL_LOW 195 }; 196 197 /* 198 * Codec GPIO sticky 199 */ 200 enum wm97xx_gpio_sticky { 201 WM97XX_GPIO_STICKY, 202 WM97XX_GPIO_NOTSTICKY 203 }; 204 205 /* 206 * Codec GPIO wake 207 */ 208 enum wm97xx_gpio_wake { 209 WM97XX_GPIO_WAKE, 210 WM97XX_GPIO_NOWAKE 211 }; 212 213 /* 214 * Digitiser ioctl commands 215 */ 216 #define WM97XX_DIG_START 0x1 217 #define WM97XX_DIG_STOP 0x2 218 #define WM97XX_PHY_INIT 0x3 219 #define WM97XX_AUX_PREPARE 0x4 220 #define WM97XX_DIG_RESTORE 0x5 221 222 struct wm97xx; 223 224 extern struct wm97xx_codec_drv wm9705_codec; 225 extern struct wm97xx_codec_drv wm9712_codec; 226 extern struct wm97xx_codec_drv wm9713_codec; 227 228 /* 229 * Codec driver interface - allows mapping to WM9705/12/13 and newer codecs 230 */ 231 struct wm97xx_codec_drv { 232 u16 id; 233 char *name; 234 235 /* read 1 sample */ 236 int (*poll_sample) (struct wm97xx *, int adcsel, int *sample); 237 238 /* read X,Y,[P] in poll */ 239 int (*poll_touch) (struct wm97xx *, struct wm97xx_data *); 240 241 int (*acc_enable) (struct wm97xx *, int enable); 242 void (*phy_init) (struct wm97xx *); 243 void (*dig_enable) (struct wm97xx *, int enable); 244 void (*dig_restore) (struct wm97xx *); 245 void (*aux_prepare) (struct wm97xx *); 246 }; 247 248 249 /* Machine specific and accelerated touch operations */ 250 struct wm97xx_mach_ops { 251 252 /* accelerated touch readback - coords are transmited on AC97 link */ 253 int acc_enabled; 254 void (*acc_pen_up) (struct wm97xx *); 255 int (*acc_pen_down) (struct wm97xx *); 256 int (*acc_startup) (struct wm97xx *); 257 void (*acc_shutdown) (struct wm97xx *); 258 259 /* interrupt mask control - required for accelerated operation */ 260 void (*irq_enable) (struct wm97xx *, int enable); 261 262 /* GPIO pin used for accelerated operation */ 263 int irq_gpio; 264 265 /* pre and post sample - can be used to minimise any analog noise */ 266 void (*pre_sample) (int); /* function to run before sampling */ 267 void (*post_sample) (int); /* function to run after sampling */ 268 }; 269 270 struct wm97xx { 271 u16 dig[3], id, gpio[6], misc; /* Cached codec registers */ 272 u16 dig_save[3]; /* saved during aux reading */ 273 struct wm97xx_codec_drv *codec; /* attached codec driver*/ 274 struct input_dev *input_dev; /* touchscreen input device */ 275 struct snd_ac97 *ac97; /* ALSA codec access */ 276 struct device *dev; /* ALSA device */ 277 struct platform_device *battery_dev; 278 struct platform_device *touch_dev; 279 struct wm97xx_mach_ops *mach_ops; 280 struct mutex codec_mutex; 281 struct delayed_work ts_reader; /* Used to poll touchscreen */ 282 unsigned long ts_reader_interval; /* Current interval for timer */ 283 unsigned long ts_reader_min_interval; /* Minimum interval */ 284 unsigned int pen_irq; /* Pen IRQ number in use */ 285 struct workqueue_struct *ts_workq; 286 struct work_struct pen_event_work; 287 u16 acc_slot; /* AC97 slot used for acc touch data */ 288 u16 acc_rate; /* acc touch data rate */ 289 unsigned pen_is_down:1; /* Pen is down */ 290 unsigned aux_waiting:1; /* aux measurement waiting */ 291 unsigned pen_probably_down:1; /* used in polling mode */ 292 u16 variant; /* WM97xx chip variant */ 293 u16 suspend_mode; /* PRP in suspend mode */ 294 }; 295 296 struct wm97xx_batt_pdata { 297 int batt_aux; 298 int temp_aux; 299 int charge_gpio; 300 int min_voltage; 301 int max_voltage; 302 int batt_div; 303 int batt_mult; 304 int temp_div; 305 int temp_mult; 306 int batt_tech; 307 char *batt_name; 308 }; 309 310 struct wm97xx_pdata { 311 struct wm97xx_batt_pdata *batt_pdata; /* battery data */ 312 }; 313 314 /* 315 * Codec GPIO access (not supported on WM9705) 316 * This can be used to set/get codec GPIO and Virtual GPIO status. 317 */ 318 enum wm97xx_gpio_status wm97xx_get_gpio(struct wm97xx *wm, u32 gpio); 319 void wm97xx_set_gpio(struct wm97xx *wm, u32 gpio, 320 enum wm97xx_gpio_status status); 321 void wm97xx_config_gpio(struct wm97xx *wm, u32 gpio, 322 enum wm97xx_gpio_dir dir, 323 enum wm97xx_gpio_pol pol, 324 enum wm97xx_gpio_sticky sticky, 325 enum wm97xx_gpio_wake wake); 326 327 void wm97xx_set_suspend_mode(struct wm97xx *wm, u16 mode); 328 329 /* codec AC97 IO access */ 330 int wm97xx_reg_read(struct wm97xx *wm, u16 reg); 331 void wm97xx_reg_write(struct wm97xx *wm, u16 reg, u16 val); 332 333 /* aux adc readback */ 334 int wm97xx_read_aux_adc(struct wm97xx *wm, u16 adcsel); 335 336 /* machine ops */ 337 int wm97xx_register_mach_ops(struct wm97xx *, struct wm97xx_mach_ops *); 338 void wm97xx_unregister_mach_ops(struct wm97xx *); 339 340 #endif 341