]>
Commit | Line | Data |
---|---|---|
88751dd6 MH |
1 | /* |
2 | * Analog Devices ADP5588 I/O Expander and QWERTY Keypad Controller | |
3 | * | |
95716c0d | 4 | * Copyright 2009-2010 Analog Devices Inc. |
88751dd6 MH |
5 | * |
6 | * Licensed under the GPL-2 or later. | |
7 | */ | |
8 | ||
9 | #ifndef _ADP5588_H | |
10 | #define _ADP5588_H | |
11 | ||
12 | #define DEV_ID 0x00 /* Device ID */ | |
13 | #define CFG 0x01 /* Configuration Register1 */ | |
14 | #define INT_STAT 0x02 /* Interrupt Status Register */ | |
15 | #define KEY_LCK_EC_STAT 0x03 /* Key Lock and Event Counter Register */ | |
16 | #define Key_EVENTA 0x04 /* Key Event Register A */ | |
17 | #define Key_EVENTB 0x05 /* Key Event Register B */ | |
18 | #define Key_EVENTC 0x06 /* Key Event Register C */ | |
19 | #define Key_EVENTD 0x07 /* Key Event Register D */ | |
20 | #define Key_EVENTE 0x08 /* Key Event Register E */ | |
21 | #define Key_EVENTF 0x09 /* Key Event Register F */ | |
22 | #define Key_EVENTG 0x0A /* Key Event Register G */ | |
23 | #define Key_EVENTH 0x0B /* Key Event Register H */ | |
24 | #define Key_EVENTI 0x0C /* Key Event Register I */ | |
25 | #define Key_EVENTJ 0x0D /* Key Event Register J */ | |
26 | #define KP_LCK_TMR 0x0E /* Keypad Lock1 to Lock2 Timer */ | |
27 | #define UNLOCK1 0x0F /* Unlock Key1 */ | |
28 | #define UNLOCK2 0x10 /* Unlock Key2 */ | |
29 | #define GPIO_INT_STAT1 0x11 /* GPIO Interrupt Status */ | |
30 | #define GPIO_INT_STAT2 0x12 /* GPIO Interrupt Status */ | |
31 | #define GPIO_INT_STAT3 0x13 /* GPIO Interrupt Status */ | |
32 | #define GPIO_DAT_STAT1 0x14 /* GPIO Data Status, Read twice to clear */ | |
33 | #define GPIO_DAT_STAT2 0x15 /* GPIO Data Status, Read twice to clear */ | |
34 | #define GPIO_DAT_STAT3 0x16 /* GPIO Data Status, Read twice to clear */ | |
35 | #define GPIO_DAT_OUT1 0x17 /* GPIO DATA OUT */ | |
36 | #define GPIO_DAT_OUT2 0x18 /* GPIO DATA OUT */ | |
37 | #define GPIO_DAT_OUT3 0x19 /* GPIO DATA OUT */ | |
38 | #define GPIO_INT_EN1 0x1A /* GPIO Interrupt Enable */ | |
39 | #define GPIO_INT_EN2 0x1B /* GPIO Interrupt Enable */ | |
40 | #define GPIO_INT_EN3 0x1C /* GPIO Interrupt Enable */ | |
41 | #define KP_GPIO1 0x1D /* Keypad or GPIO Selection */ | |
42 | #define KP_GPIO2 0x1E /* Keypad or GPIO Selection */ | |
43 | #define KP_GPIO3 0x1F /* Keypad or GPIO Selection */ | |
44 | #define GPI_EM1 0x20 /* GPI Event Mode 1 */ | |
45 | #define GPI_EM2 0x21 /* GPI Event Mode 2 */ | |
46 | #define GPI_EM3 0x22 /* GPI Event Mode 3 */ | |
47 | #define GPIO_DIR1 0x23 /* GPIO Data Direction */ | |
48 | #define GPIO_DIR2 0x24 /* GPIO Data Direction */ | |
49 | #define GPIO_DIR3 0x25 /* GPIO Data Direction */ | |
50 | #define GPIO_INT_LVL1 0x26 /* GPIO Edge/Level Detect */ | |
51 | #define GPIO_INT_LVL2 0x27 /* GPIO Edge/Level Detect */ | |
52 | #define GPIO_INT_LVL3 0x28 /* GPIO Edge/Level Detect */ | |
53 | #define Debounce_DIS1 0x29 /* Debounce Disable */ | |
54 | #define Debounce_DIS2 0x2A /* Debounce Disable */ | |
55 | #define Debounce_DIS3 0x2B /* Debounce Disable */ | |
56 | #define GPIO_PULL1 0x2C /* GPIO Pull Disable */ | |
57 | #define GPIO_PULL2 0x2D /* GPIO Pull Disable */ | |
58 | #define GPIO_PULL3 0x2E /* GPIO Pull Disable */ | |
59 | #define CMP_CFG_STAT 0x30 /* Comparator Configuration and Status Register */ | |
60 | #define CMP_CONFG_SENS1 0x31 /* Sensor1 Comparator Configuration Register */ | |
61 | #define CMP_CONFG_SENS2 0x32 /* L2 Light Sensor Reference Level, Output Falling for Sensor 1 */ | |
62 | #define CMP1_LVL2_TRIP 0x33 /* L2 Light Sensor Hysteresis (Active when Output Rising) for Sensor 1 */ | |
63 | #define CMP1_LVL2_HYS 0x34 /* L3 Light Sensor Reference Level, Output Falling For Sensor 1 */ | |
64 | #define CMP1_LVL3_TRIP 0x35 /* L3 Light Sensor Hysteresis (Active when Output Rising) For Sensor 1 */ | |
65 | #define CMP1_LVL3_HYS 0x36 /* Sensor 2 Comparator Configuration Register */ | |
66 | #define CMP2_LVL2_TRIP 0x37 /* L2 Light Sensor Reference Level, Output Falling for Sensor 2 */ | |
67 | #define CMP2_LVL2_HYS 0x38 /* L2 Light Sensor Hysteresis (Active when Output Rising) for Sensor 2 */ | |
68 | #define CMP2_LVL3_TRIP 0x39 /* L3 Light Sensor Reference Level, Output Falling For Sensor 2 */ | |
69 | #define CMP2_LVL3_HYS 0x3A /* L3 Light Sensor Hysteresis (Active when Output Rising) For Sensor 2 */ | |
70 | #define CMP1_ADC_DAT_R1 0x3B /* Comparator 1 ADC data Register1 */ | |
71 | #define CMP1_ADC_DAT_R2 0x3C /* Comparator 1 ADC data Register2 */ | |
72 | #define CMP2_ADC_DAT_R1 0x3D /* Comparator 2 ADC data Register1 */ | |
73 | #define CMP2_ADC_DAT_R2 0x3E /* Comparator 2 ADC data Register2 */ | |
74 | ||
75 | #define ADP5588_DEVICE_ID_MASK 0xF | |
76 | ||
459773ae MH |
77 | /* Configuration Register1 */ |
78 | #define ADP5588_AUTO_INC (1 << 7) | |
79 | #define ADP5588_GPIEM_CFG (1 << 6) | |
95716c0d | 80 | #define ADP5588_OVR_FLOW_M (1 << 5) |
459773ae | 81 | #define ADP5588_INT_CFG (1 << 4) |
95716c0d MH |
82 | #define ADP5588_OVR_FLOW_IEN (1 << 3) |
83 | #define ADP5588_K_LCK_IM (1 << 2) | |
459773ae | 84 | #define ADP5588_GPI_IEN (1 << 1) |
95716c0d | 85 | #define ADP5588_KE_IEN (1 << 0) |
459773ae MH |
86 | |
87 | /* Interrupt Status Register */ | |
95716c0d MH |
88 | #define ADP5588_CMP2_INT (1 << 5) |
89 | #define ADP5588_CMP1_INT (1 << 4) | |
90 | #define ADP5588_OVR_FLOW_INT (1 << 3) | |
91 | #define ADP5588_K_LCK_INT (1 << 2) | |
459773ae MH |
92 | #define ADP5588_GPI_INT (1 << 1) |
93 | #define ADP5588_KE_INT (1 << 0) | |
94 | ||
95716c0d MH |
95 | /* Key Lock and Event Counter Register */ |
96 | #define ADP5588_K_LCK_EN (1 << 6) | |
97 | #define ADP5588_LCK21 0x30 | |
98 | #define ADP5588_KEC 0xF | |
99 | ||
459773ae MH |
100 | #define ADP5588_MAXGPIO 18 |
101 | #define ADP5588_BANK(offs) ((offs) >> 3) | |
102 | #define ADP5588_BIT(offs) (1u << ((offs) & 0x7)) | |
103 | ||
88751dd6 MH |
104 | /* Put one of these structures in i2c_board_info platform_data */ |
105 | ||
106 | #define ADP5588_KEYMAPSIZE 80 | |
107 | ||
69a4af60 XC |
108 | #define GPI_PIN_ROW0 97 |
109 | #define GPI_PIN_ROW1 98 | |
110 | #define GPI_PIN_ROW2 99 | |
111 | #define GPI_PIN_ROW3 100 | |
112 | #define GPI_PIN_ROW4 101 | |
113 | #define GPI_PIN_ROW5 102 | |
114 | #define GPI_PIN_ROW6 103 | |
115 | #define GPI_PIN_ROW7 104 | |
116 | #define GPI_PIN_COL0 105 | |
117 | #define GPI_PIN_COL1 106 | |
118 | #define GPI_PIN_COL2 107 | |
119 | #define GPI_PIN_COL3 108 | |
120 | #define GPI_PIN_COL4 109 | |
121 | #define GPI_PIN_COL5 110 | |
122 | #define GPI_PIN_COL6 111 | |
123 | #define GPI_PIN_COL7 112 | |
124 | #define GPI_PIN_COL8 113 | |
125 | #define GPI_PIN_COL9 114 | |
126 | ||
127 | #define GPI_PIN_ROW_BASE GPI_PIN_ROW0 | |
128 | #define GPI_PIN_ROW_END GPI_PIN_ROW7 | |
129 | #define GPI_PIN_COL_BASE GPI_PIN_COL0 | |
130 | #define GPI_PIN_COL_END GPI_PIN_COL9 | |
131 | ||
132 | #define GPI_PIN_BASE GPI_PIN_ROW_BASE | |
133 | #define GPI_PIN_END GPI_PIN_COL_END | |
134 | ||
135 | #define ADP5588_GPIMAPSIZE_MAX (GPI_PIN_END - GPI_PIN_BASE + 1) | |
136 | ||
137 | struct adp5588_gpi_map { | |
138 | unsigned short pin; | |
139 | unsigned short sw_evt; | |
140 | }; | |
141 | ||
88751dd6 MH |
142 | struct adp5588_kpad_platform_data { |
143 | int rows; /* Number of rows */ | |
144 | int cols; /* Number of columns */ | |
145 | const unsigned short *keymap; /* Pointer to keymap */ | |
146 | unsigned short keymapsize; /* Keymap size */ | |
147 | unsigned repeat:1; /* Enable key repeat */ | |
148 | unsigned en_keylock:1; /* Enable Key Lock feature */ | |
149 | unsigned short unlock_key1; /* Unlock Key 1 */ | |
150 | unsigned short unlock_key2; /* Unlock Key 2 */ | |
69a4af60 XC |
151 | const struct adp5588_gpi_map *gpimap; |
152 | unsigned short gpimapsize; | |
ba9f507a | 153 | const struct adp5588_gpio_platform_data *gpio_data; |
88751dd6 MH |
154 | }; |
155 | ||
dc5ae4f2 MH |
156 | struct i2c_client; /* forward declaration */ |
157 | ||
80884094 | 158 | struct adp5588_gpio_platform_data { |
9ef8c8c5 | 159 | int gpio_start; /* GPIO Chip base # */ |
d0a3457d | 160 | const char *const *names; |
9ef8c8c5 MH |
161 | unsigned irq_base; /* interrupt base # */ |
162 | unsigned pullup_dis_mask; /* Pull-Up Disable Mask */ | |
80884094 | 163 | int (*setup)(struct i2c_client *client, |
dc1b5ba1 | 164 | unsigned gpio, unsigned ngpio, |
80884094 MH |
165 | void *context); |
166 | int (*teardown)(struct i2c_client *client, | |
dc1b5ba1 | 167 | unsigned gpio, unsigned ngpio, |
80884094 MH |
168 | void *context); |
169 | void *context; | |
170 | }; | |
171 | ||
88751dd6 | 172 | #endif |