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