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