include/linux/spi/tsc2301.h

   1 #ifndef _LINUX_SPI_TSC2301_H
   2 #define _LINUX_SPI_TSC2301_H
   3
   4 #include <linux/types.h>
   5 #include <linux/timer.h>
   6
   7 struct tsc2301_platform_data {
   8         /*
   9          * Keypad
  10          */
  11         s16     reset_gpio;
  12         s16     keyb_int;
  13         s16     keymap[16];     /* Set a key to a negative value if not used */
  14         unsigned kp_rep:1;      /* Enable keypad repeating */
  15
  16         /*
  17          * Touchscreen
  18          */
  19         s16     dav_gpio;
  20         u16     ts_x_plate_ohm;
  21         u32     ts_stab_time;   /* voltage settling time */
  22         u8      ts_hw_avg;      /* HW assiseted averaging. Can be
  23                                    0, 4, 8, 16 samples per reading */
  24         u32     ts_max_pressure;/* Samples with bigger pressure value will
  25                                    be ignored, since the corresponding X, Y
  26                                    values are unreliable */
  27         u32     ts_touch_pressure;      /* Pressure limit until we report a
  28                                            touch event. After that we switch
  29                                            to ts_max_pressure. */
  30         u32     ts_pressure_fudge;
  31         u32     ts_x_max;
  32         u32     ts_x_fudge;
  33         u32     ts_y_max;
  34         u32     ts_y_fudge;
  35
  36         /*
  37          * Audio
  38          */
  39         unsigned        pll_pdc:4;
  40         unsigned        pll_a:4;
  41         unsigned        pll_n:4;
  42         unsigned        pll_output:1; /* Output PLL on GPIO_0 */
  43
  44         unsigned        mclk_ratio:2;
  45         unsigned        i2s_sample_rate:4;
  46         unsigned        i2s_format:2;
  47         /* Mask for audio blocks to be powered down */
  48         u16             power_down_blocks;
  49
  50         /* Called after codec has been initialized, can be NULL */
  51         int (* codec_init)(struct device *tsc2301_dev);
  52         /* Called when codec is being removed, can be NULL */
  53         void (* codec_cleanup)(struct device *tsc2301_dev);
  54         int     (*enable_clock)(struct device *dev);
  55         void    (*disable_clock)(struct device *dev);
  56
  57         const struct tsc2301_mixer_gpio {
  58                 const char      *name;
  59                 unsigned        gpio:4;
  60                 unsigned        inverted:1;
  61                 unsigned        def_enable:1; /* enable by default */
  62                 unsigned        deactivate_on_pd:1; /* power-down flag */
  63         } *mixer_gpios;
  64         int     n_mixer_gpios;
  65 };
  66
  67 struct tsc2301_kp;
  68 struct tsc2301_ts;
  69 struct tsc2301_mixer;
  70
  71 struct tsc2301 {
  72         struct spi_device       *spi;
  73
  74         s16                     reset_gpio;
  75         u16                     config2_shadow;
  76
  77         struct tsc2301_kp       *kp;
  78         struct tsc2301_ts       *ts;
  79         struct tsc2301_mixer    *mixer;
  80
  81         int                     (*enable_clock)(struct device *dev);
  82         void                    (*disable_clock)(struct device *dev);
  83 };
  84
  85
  86 #define TSC2301_HZ      33000000
  87
  88 #define TSC2301_REG(page, addr)  (((page) << 11) | ((addr) << 5))
  89 #define TSC2301_REG_TO_PAGE(reg) (((reg) >> 11) & 0x03)
  90 #define TSC2301_REG_TO_ADDR(reg) (((reg) >> 5)  & 0x1f)
  91
  92 #define TSC2301_REG_X           TSC2301_REG(0, 0)
  93 #define TSC2301_REG_Y           TSC2301_REG(0, 1)
  94 #define TSC2301_REG_Z1          TSC2301_REG(0, 2)
  95 #define TSC2301_REG_Z2          TSC2301_REG(0, 3)
  96 #define TSC2301_REG_KPDATA      TSC2301_REG(0, 4)
  97 #define TSC2301_REG_ADC         TSC2301_REG(1, 0)
  98 #define TSC2301_REG_KEY         TSC2301_REG(1, 1)
  99 #define TSC2301_REG_DAC         TSC2301_REG(1, 2)
 100 #define TSC2301_REG_REF         TSC2301_REG(1, 3)
 101 #define TSC2301_REG_RESET       TSC2301_REG(1, 4)
 102 #define TSC2301_REG_CONFIG      TSC2301_REG(1, 5)
 103 #define TSC2301_REG_CONFIG2     TSC2301_REG(1, 6)
 104 #define TSC2301_REG_KPMASK      TSC2301_REG(1, 16)
 105 #define TSC2301_REG_AUDCNTL     TSC2301_REG(2, 0)
 106 #define TSC2301_REG_ADCVOL      TSC2301_REG(2, 1)
 107 #define TSC2301_REG_DACVOL      TSC2301_REG(2, 2)
 108 #define TSC2301_REG_BPVOL       TSC2301_REG(2, 3)
 109 #define TSC2301_REG_KEYCTL      TSC2301_REG(2, 4)
 110 #define TSC2301_REG_PD_MISC     TSC2301_REG(2, 5)
 111 #define TSC2301_REG_GPIO        TSC2301_REG(2, 6)
 112 #define TSC2301_REG_ADCLKCFG    TSC2301_REG(2, 27)
 113
 114 #define TSC2301_REG_PD_MISC_APD         (1 << 15)
 115 #define TSC2301_REG_PD_MISC_AVPD        (1 << 14)
 116 #define TSC2301_REG_PD_MISC_ABPD        (1 << 13)
 117 #define TSC2301_REG_PD_MISC_HAPD        (1 << 12)
 118 #define TSC2301_REG_PD_MISC_MOPD        (1 << 11)
 119 #define TSC2301_REG_PD_MISC_DAPD        (1 << 10)
 120 #define TSC2301_REG_PD_MISC_ADPDL       (1 << 9)
 121 #define TSC2301_REG_PD_MISC_ADPDR       (1 << 8)
 122 #define TSC2301_REG_PD_MISC_PDSTS       (1 << 7)
 123 #define TSC2301_REG_PD_MISC_MIBPD       (1 << 6)
 124 #define TSC2301_REG_PD_MISC_OTSYN       (1 << 2)
 125
 126 /* I2S sample rate */
 127 #define TSC2301_I2S_SR_48000    0x00
 128 #define TSC2301_I2S_SR_44100    0x01
 129 #define TSC2301_I2S_SR_32000    0x02
 130 #define TSC2301_I2S_SR_24000    0x03
 131 #define TSC2301_I2S_SR_22050    0x04
 132 #define TSC2301_I2S_SR_16000    0x05
 133 #define TSC2301_I2S_SR_12000    0x06
 134 #define TSC2301_I2S_SR_11050    0x07
 135 #define TSC2301_I2S_SR_8000     0x08
 136
 137 /* 16-bit, MSB-first. DAC Right-Justified, ADC Left-Justified */
 138 #define TSC2301_I2S_FORMAT0     0x00
 139 /* 20-bit, MSB-first. DAC Right-Justified, ADC Left-Justified */
 140 #define TSC2301_I2S_FORMAT1     0x01
 141 /* 20-bit, MSB-first. DAC Left-Justified, ADC Left-Justified */
 142 #define TSC2301_I2S_FORMAT2     0x02
 143 /* 20-bit, MSB-first */
 144 #define TSC2301_I2S_FORMAT3     0x03
 145
 146 /* Master Clock Ratio */
 147 #define TSC2301_MCLK_256xFS     0x00 /* default */
 148 #define TSC2301_MCLK_384xFS     0x01
 149 #define TSC2301_MCLK_512xFS     0x02
 150
 151
 152 extern u16 tsc2301_read_reg(struct tsc2301 *tsc, int reg);
 153 extern void tsc2301_write_reg(struct tsc2301 *tsc, int reg, u16 val);
 154 extern void tsc2301_write_kbc(struct tsc2301 *tsc, int val);
 155 extern void tsc2301_write_pll(struct tsc2301 *tsc, int pll_n, int pll_a,
 156                               int pll_pdc, int pct_e, int pll_o);
 157 extern void tsc2301_read_buf(struct tsc2301 *tsc, int reg, u16 *buf, int len);
 158
 159 #define TSC2301_DECL_MOD(module)                                        \
 160 extern int  tsc2301_##module##_init(struct tsc2301 *tsc,                \
 161                            struct tsc2301_platform_data *pdata);        \
 162 extern void tsc2301_##module##_exit(struct tsc2301 *tsc);               \
 163 extern int  tsc2301_##module##_suspend(struct tsc2301 *tsc);            \
 164 extern void tsc2301_##module##_resume(struct tsc2301 *tsc);
 165
 166 #define TSC2301_DECL_EMPTY_MOD(module)                                  \
 167 static inline int tsc2301_##module##_init(struct tsc2301 *tsc,          \
 168                            struct tsc2301_platform_data *pdata)         \
 169 {                                                                       \
 170         return 0;                                                       \
 171 }                                                                       \
 172 static inline void tsc2301_##module##_exit(struct tsc2301 *tsc) {}      \
 173 static inline int  tsc2301_##module##_suspend(struct tsc2301 *tsc)      \
 174 {                                                                       \
 175         return 0;                                                       \
 176 }                                                                       \
 177 static inline void tsc2301_##module##_resume(struct tsc2301 *tsc) {}
 178
 179 #ifdef CONFIG_KEYBOARD_TSC2301
 180 TSC2301_DECL_MOD(kp)
 181 void tsc2301_kp_restart(struct tsc2301 *tsc);
 182 #else
 183 TSC2301_DECL_EMPTY_MOD(kp)
 184 static inline void tsc2301_kp_restart(struct tsc2301 *tsc) {}
 185 #endif
 186
 187 #ifdef CONFIG_TOUCHSCREEN_TSC2301
 188 TSC2301_DECL_MOD(ts)
 189 #else
 190 TSC2301_DECL_EMPTY_MOD(ts)
 191 #endif
 192
 193 #ifdef CONFIG_SPI_TSC2301_AUDIO
 194 TSC2301_DECL_MOD(mixer)
 195 extern void tsc2301_mixer_set_power(struct device *tsc_dev, int dac, int adc);
 196
 197 struct snd_card;
 198 extern int tsc2301_mixer_register_controls(struct device *tsc_dev,
 199                                            struct snd_card *card);
 200 #else
 201 TSC2301_DECL_EMPTY_MOD(mixer)
 202 #endif
 203
 204 extern void tsc2301_mixer_enable_mclk(struct device *tsc_dev);
 205 extern void tsc2301_mixer_disable_mclk(struct device *tsc_dev);
 206
 207 #endif