blob: 3acb3a8e3af589cbf9b237290bb18d0216d57a8d [file] [log] [blame]
Rabin Vincentb4ecd322010-05-10 23:39:47 +02001/*
2 * Copyright (C) ST-Ericsson SA 2010
3 *
4 * License Terms: GNU General Public License, version 2
5 */
6
Sundar Iyer20406eb2010-12-13 09:33:14 +05307#ifndef __LINUX_MFD_TC3589x_H
8#define __LINUX_MFD_TC3589x_H
Rabin Vincentb4ecd322010-05-10 23:39:47 +02009
Paul Gortmaker313162d2012-01-30 11:46:54 -050010struct device;
Rabin Vincentb4ecd322010-05-10 23:39:47 +020011
Sundar Iyer611b7592010-12-13 09:33:15 +053012enum tx3589x_block {
13 TC3589x_BLOCK_GPIO = 1 << 0,
14 TC3589x_BLOCK_KEYPAD = 1 << 1,
15};
16
Sundar Iyer20406eb2010-12-13 09:33:14 +053017#define TC3589x_RSTCTRL_IRQRST (1 << 4)
18#define TC3589x_RSTCTRL_TIMRST (1 << 3)
19#define TC3589x_RSTCTRL_ROTRST (1 << 2)
20#define TC3589x_RSTCTRL_KBDRST (1 << 1)
21#define TC3589x_RSTCTRL_GPIRST (1 << 0)
Rabin Vincentb4ecd322010-05-10 23:39:47 +020022
Sundar Iyer09c730a2010-12-21 15:53:31 +053023/* Keyboard Configuration Registers */
24#define TC3589x_KBDSETTLE_REG 0x01
25#define TC3589x_KBDBOUNCE 0x02
26#define TC3589x_KBDSIZE 0x03
27#define TC3589x_KBCFG_LSB 0x04
28#define TC3589x_KBCFG_MSB 0x05
29#define TC3589x_KBDIC 0x08
30#define TC3589x_KBDMSK 0x09
31#define TC3589x_EVTCODE_FIFO 0x10
32#define TC3589x_KBDMFS 0x8F
33
Sundar Iyer20406eb2010-12-13 09:33:14 +053034#define TC3589x_IRQST 0x91
Rabin Vincentb4ecd322010-05-10 23:39:47 +020035
Sundar Iyer20406eb2010-12-13 09:33:14 +053036#define TC3589x_MANFCODE_MAGIC 0x03
37#define TC3589x_MANFCODE 0x80
38#define TC3589x_VERSION 0x81
39#define TC3589x_IOCFG 0xA7
Rabin Vincentb4ecd322010-05-10 23:39:47 +020040
Sundar Iyer20406eb2010-12-13 09:33:14 +053041#define TC3589x_CLKMODE 0x88
42#define TC3589x_CLKCFG 0x89
43#define TC3589x_CLKEN 0x8A
Rabin Vincentb4ecd322010-05-10 23:39:47 +020044
Sundar Iyer20406eb2010-12-13 09:33:14 +053045#define TC3589x_RSTCTRL 0x82
46#define TC3589x_EXTRSTN 0x83
47#define TC3589x_RSTINTCLR 0x84
Rabin Vincentb4ecd322010-05-10 23:39:47 +020048
Sundar Iyer09c730a2010-12-21 15:53:31 +053049/* Pull up/down configuration registers */
50#define TC3589x_IOCFG 0xA7
51#define TC3589x_IOPULLCFG0_LSB 0xAA
52#define TC3589x_IOPULLCFG0_MSB 0xAB
53#define TC3589x_IOPULLCFG1_LSB 0xAC
54#define TC3589x_IOPULLCFG1_MSB 0xAD
55#define TC3589x_IOPULLCFG2_LSB 0xAE
56
Sundar Iyer20406eb2010-12-13 09:33:14 +053057#define TC3589x_GPIOIS0 0xC9
58#define TC3589x_GPIOIS1 0xCA
59#define TC3589x_GPIOIS2 0xCB
60#define TC3589x_GPIOIBE0 0xCC
61#define TC3589x_GPIOIBE1 0xCD
62#define TC3589x_GPIOIBE2 0xCE
63#define TC3589x_GPIOIEV0 0xCF
64#define TC3589x_GPIOIEV1 0xD0
65#define TC3589x_GPIOIEV2 0xD1
66#define TC3589x_GPIOIE0 0xD2
67#define TC3589x_GPIOIE1 0xD3
68#define TC3589x_GPIOIE2 0xD4
69#define TC3589x_GPIORIS0 0xD6
70#define TC3589x_GPIORIS1 0xD7
71#define TC3589x_GPIORIS2 0xD8
72#define TC3589x_GPIOMIS0 0xD9
73#define TC3589x_GPIOMIS1 0xDA
74#define TC3589x_GPIOMIS2 0xDB
75#define TC3589x_GPIOIC0 0xDC
76#define TC3589x_GPIOIC1 0xDD
77#define TC3589x_GPIOIC2 0xDE
Rabin Vincentb4ecd322010-05-10 23:39:47 +020078
Sundar Iyer20406eb2010-12-13 09:33:14 +053079#define TC3589x_GPIODATA0 0xC0
80#define TC3589x_GPIOMASK0 0xc1
81#define TC3589x_GPIODATA1 0xC2
82#define TC3589x_GPIOMASK1 0xc3
83#define TC3589x_GPIODATA2 0xC4
84#define TC3589x_GPIOMASK2 0xC5
Rabin Vincentb4ecd322010-05-10 23:39:47 +020085
Sundar Iyer20406eb2010-12-13 09:33:14 +053086#define TC3589x_GPIODIR0 0xC6
87#define TC3589x_GPIODIR1 0xC7
88#define TC3589x_GPIODIR2 0xC8
Rabin Vincentb4ecd322010-05-10 23:39:47 +020089
Sundar Iyer20406eb2010-12-13 09:33:14 +053090#define TC3589x_GPIOSYNC0 0xE6
91#define TC3589x_GPIOSYNC1 0xE7
92#define TC3589x_GPIOSYNC2 0xE8
Rabin Vincentb4ecd322010-05-10 23:39:47 +020093
Sundar Iyer20406eb2010-12-13 09:33:14 +053094#define TC3589x_GPIOWAKE0 0xE9
95#define TC3589x_GPIOWAKE1 0xEA
96#define TC3589x_GPIOWAKE2 0xEB
Rabin Vincentb4ecd322010-05-10 23:39:47 +020097
Sundar Iyer20406eb2010-12-13 09:33:14 +053098#define TC3589x_GPIOODM0 0xE0
99#define TC3589x_GPIOODE0 0xE1
100#define TC3589x_GPIOODM1 0xE2
101#define TC3589x_GPIOODE1 0xE3
102#define TC3589x_GPIOODM2 0xE4
103#define TC3589x_GPIOODE2 0xE5
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200104
Sundar Iyer20406eb2010-12-13 09:33:14 +0530105#define TC3589x_INT_GPIIRQ 0
106#define TC3589x_INT_TI0IRQ 1
107#define TC3589x_INT_TI1IRQ 2
108#define TC3589x_INT_TI2IRQ 3
109#define TC3589x_INT_ROTIRQ 5
110#define TC3589x_INT_KBDIRQ 6
111#define TC3589x_INT_PORIRQ 7
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200112
Sundar Iyer20406eb2010-12-13 09:33:14 +0530113#define TC3589x_NR_INTERNAL_IRQS 8
114#define TC3589x_INT_GPIO(x) (TC3589x_NR_INTERNAL_IRQS + (x))
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200115
Sundar Iyer20406eb2010-12-13 09:33:14 +0530116struct tc3589x {
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200117 struct mutex lock;
118 struct device *dev;
119 struct i2c_client *i2c;
120
121 int irq_base;
122 int num_gpio;
Sundar Iyer20406eb2010-12-13 09:33:14 +0530123 struct tc3589x_platform_data *pdata;
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200124};
125
Sundar Iyer20406eb2010-12-13 09:33:14 +0530126extern int tc3589x_reg_write(struct tc3589x *tc3589x, u8 reg, u8 data);
127extern int tc3589x_reg_read(struct tc3589x *tc3589x, u8 reg);
128extern int tc3589x_block_read(struct tc3589x *tc3589x, u8 reg, u8 length,
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200129 u8 *values);
Sundar Iyer20406eb2010-12-13 09:33:14 +0530130extern int tc3589x_block_write(struct tc3589x *tc3589x, u8 reg, u8 length,
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200131 const u8 *values);
Sundar Iyer20406eb2010-12-13 09:33:14 +0530132extern int tc3589x_set_bits(struct tc3589x *tc3589x, u8 reg, u8 mask, u8 val);
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200133
Sundar Iyer09c730a2010-12-21 15:53:31 +0530134/*
135 * Keypad related platform specific constants
136 * These values may be modified for fine tuning
137 */
138#define TC_KPD_ROWS 0x8
139#define TC_KPD_COLUMNS 0x8
140#define TC_KPD_DEBOUNCE_PERIOD 0xA3
141#define TC_KPD_SETTLE_TIME 0xA3
142
143/**
144 * struct tc35893_platform_data - data structure for platform specific data
145 * @keymap_data: matrix scan code table for keycodes
146 * @krow: mask for available rows, value is 0xFF
147 * @kcol: mask for available columns, value is 0xFF
148 * @debounce_period: platform specific debounce time
149 * @settle_time: platform specific settle down time
150 * @irqtype: type of interrupt, falling or rising edge
151 * @enable_wakeup: specifies if keypad event can wake up system from sleep
152 * @no_autorepeat: flag for auto repetition
153 */
154struct tc3589x_keypad_platform_data {
155 const struct matrix_keymap_data *keymap_data;
156 u8 krow;
157 u8 kcol;
158 u8 debounce_period;
159 u8 settle_time;
160 unsigned long irqtype;
161 bool enable_wakeup;
162 bool no_autorepeat;
163};
164
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200165/**
Sundar Iyer20406eb2010-12-13 09:33:14 +0530166 * struct tc3589x_gpio_platform_data - TC3589x GPIO platform data
167 * @gpio_base: first gpio number assigned to TC3589x. A maximum of
168 * %TC3589x_NR_GPIOS GPIOs will be allocated.
Rabin Vincentf0a7a982010-09-13 13:04:02 +0100169 * @setup: callback for board-specific initialization
170 * @remove: callback for board-specific teardown
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200171 */
Sundar Iyer20406eb2010-12-13 09:33:14 +0530172struct tc3589x_gpio_platform_data {
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200173 int gpio_base;
Sundar Iyer20406eb2010-12-13 09:33:14 +0530174 void (*setup)(struct tc3589x *tc3589x, unsigned gpio_base);
175 void (*remove)(struct tc3589x *tc3589x, unsigned gpio_base);
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200176};
177
178/**
Sundar Iyer20406eb2010-12-13 09:33:14 +0530179 * struct tc3589x_platform_data - TC3589x platform data
Sundar Iyer611b7592010-12-13 09:33:15 +0530180 * @block: bitmask of blocks to enable (use TC3589x_BLOCK_*)
Sundar Iyer20406eb2010-12-13 09:33:14 +0530181 * @irq_base: base IRQ number. %TC3589x_NR_IRQS irqs will be used.
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200182 * @gpio: GPIO-specific platform data
Sundar Iyer09c730a2010-12-21 15:53:31 +0530183 * @keypad: keypad-specific platform data
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200184 */
Sundar Iyer20406eb2010-12-13 09:33:14 +0530185struct tc3589x_platform_data {
Sundar Iyer611b7592010-12-13 09:33:15 +0530186 unsigned int block;
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200187 int irq_base;
Sundar Iyer20406eb2010-12-13 09:33:14 +0530188 struct tc3589x_gpio_platform_data *gpio;
Sundar Iyer09c730a2010-12-21 15:53:31 +0530189 const struct tc3589x_keypad_platform_data *keypad;
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200190};
191
Sundar Iyer20406eb2010-12-13 09:33:14 +0530192#define TC3589x_NR_GPIOS 24
193#define TC3589x_NR_IRQS TC3589x_INT_GPIO(TC3589x_NR_GPIOS)
Rabin Vincentb4ecd322010-05-10 23:39:47 +0200194
195#endif