blob: de748bc7525e56b9555bd41c35cb737e32929f48 [file] [log] [blame]
Rabin Vincent27e34992010-07-02 16:52:08 +05301/*
2 * Copyright (C) ST-Ericsson SA 2010
3 *
4 * License Terms: GNU General Public License, version 2
5 * Author: Rabin Vincent <rabin.vincent@stericsson.com> for ST-Ericsson
6 */
7
8#ifndef __LINUX_MFD_STMPE_H
9#define __LINUX_MFD_STMPE_H
10
Paul Gortmaker313162d2012-01-30 11:46:54 -050011#include <linux/mutex.h>
12
13struct device;
Linus Walleij9c9e3212014-05-08 23:16:35 +020014struct regulator;
Rabin Vincent27e34992010-07-02 16:52:08 +053015
16enum stmpe_block {
17 STMPE_BLOCK_GPIO = 1 << 0,
18 STMPE_BLOCK_KEYPAD = 1 << 1,
19 STMPE_BLOCK_TOUCHSCREEN = 1 << 2,
20 STMPE_BLOCK_ADC = 1 << 3,
21 STMPE_BLOCK_PWM = 1 << 4,
22 STMPE_BLOCK_ROTATOR = 1 << 5,
23};
24
25enum stmpe_partnum {
Viresh Kumar1cda2392011-11-17 11:02:22 +053026 STMPE610,
Viresh Kumar7f7f4ea2011-11-17 11:02:23 +053027 STMPE801,
Rabin Vincent27e34992010-07-02 16:52:08 +053028 STMPE811,
29 STMPE1601,
Jean-Nicolas Graux230f13a2013-04-09 10:35:19 +020030 STMPE1801,
Rabin Vincent27e34992010-07-02 16:52:08 +053031 STMPE2401,
32 STMPE2403,
Chris Blaire31f9b82012-01-26 22:17:03 +010033 STMPE_NBR_PARTS
Rabin Vincent27e34992010-07-02 16:52:08 +053034};
35
36/*
37 * For registers whose locations differ on variants, the correct address is
38 * obtained by indexing stmpe->regs with one of the following.
39 */
40enum {
41 STMPE_IDX_CHIP_ID,
42 STMPE_IDX_ICR_LSB,
43 STMPE_IDX_IER_LSB,
Jean-Nicolas Graux230f13a2013-04-09 10:35:19 +020044 STMPE_IDX_ISR_LSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053045 STMPE_IDX_ISR_MSB,
46 STMPE_IDX_GPMR_LSB,
47 STMPE_IDX_GPSR_LSB,
48 STMPE_IDX_GPCR_LSB,
49 STMPE_IDX_GPDR_LSB,
50 STMPE_IDX_GPEDR_MSB,
51 STMPE_IDX_GPRER_LSB,
52 STMPE_IDX_GPFER_LSB,
Linus Walleij80e1dd82014-11-03 16:48:47 -080053 STMPE_IDX_GPPUR_LSB,
54 STMPE_IDX_GPPDR_LSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053055 STMPE_IDX_GPAFR_U_MSB,
56 STMPE_IDX_IEGPIOR_LSB,
Jean-Nicolas Graux230f13a2013-04-09 10:35:19 +020057 STMPE_IDX_ISGPIOR_LSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053058 STMPE_IDX_ISGPIOR_MSB,
59 STMPE_IDX_MAX,
60};
61
62
63struct stmpe_variant_info;
Viresh Kumar1a6e4b72011-11-17 11:02:20 +053064struct stmpe_client_info;
Linus Walleijfc1882d2016-05-25 14:22:02 +020065struct stmpe_platform_data;
Rabin Vincent27e34992010-07-02 16:52:08 +053066
67/**
68 * struct stmpe - STMPE MFD structure
Linus Walleij9c9e3212014-05-08 23:16:35 +020069 * @vcc: optional VCC regulator
70 * @vio: optional VIO regulator
Rabin Vincent27e34992010-07-02 16:52:08 +053071 * @lock: lock protecting I/O operations
72 * @irq_lock: IRQ bus lock
73 * @dev: device, mostly for dev_dbg()
Lee Jones76f93992012-11-05 16:10:31 +010074 * @irq_domain: IRQ domain
Viresh Kumar1a6e4b72011-11-17 11:02:20 +053075 * @client: client - i2c or spi
76 * @ci: client specific information
Om Prakash4dcaa6b2011-06-27 09:54:22 +020077 * @partnum: part number
Rabin Vincent27e34992010-07-02 16:52:08 +053078 * @variant: the detected STMPE model number
79 * @regs: list of addresses of registers which are at different addresses on
80 * different variants. Indexed by one of STMPE_IDX_*.
Viresh Kumar73de16d2011-11-08 09:44:06 +053081 * @irq: irq number for stmpe
Rabin Vincent27e34992010-07-02 16:52:08 +053082 * @num_gpios: number of gpios, differs for variants
83 * @ier: cache of IER registers for bus_lock
84 * @oldier: cache of IER registers for bus_lock
85 * @pdata: platform data
86 */
87struct stmpe {
Linus Walleij9c9e3212014-05-08 23:16:35 +020088 struct regulator *vcc;
89 struct regulator *vio;
Rabin Vincent27e34992010-07-02 16:52:08 +053090 struct mutex lock;
91 struct mutex irq_lock;
92 struct device *dev;
Lee Jones76f93992012-11-05 16:10:31 +010093 struct irq_domain *domain;
Viresh Kumar1a6e4b72011-11-17 11:02:20 +053094 void *client;
95 struct stmpe_client_info *ci;
Rabin Vincent27e34992010-07-02 16:52:08 +053096 enum stmpe_partnum partnum;
97 struct stmpe_variant_info *variant;
98 const u8 *regs;
99
Viresh Kumar73de16d2011-11-08 09:44:06 +0530100 int irq;
Rabin Vincent27e34992010-07-02 16:52:08 +0530101 int num_gpios;
102 u8 ier[2];
103 u8 oldier[2];
104 struct stmpe_platform_data *pdata;
105};
106
107extern int stmpe_reg_write(struct stmpe *stmpe, u8 reg, u8 data);
108extern int stmpe_reg_read(struct stmpe *stmpe, u8 reg);
109extern int stmpe_block_read(struct stmpe *stmpe, u8 reg, u8 length,
110 u8 *values);
111extern int stmpe_block_write(struct stmpe *stmpe, u8 reg, u8 length,
112 const u8 *values);
113extern int stmpe_set_bits(struct stmpe *stmpe, u8 reg, u8 mask, u8 val);
114extern int stmpe_set_altfunc(struct stmpe *stmpe, u32 pins,
115 enum stmpe_block block);
116extern int stmpe_enable(struct stmpe *stmpe, unsigned int blocks);
117extern int stmpe_disable(struct stmpe *stmpe, unsigned int blocks);
118
Wolfram Sangb8e9cf02010-08-16 17:14:44 +0200119#define STMPE_GPIO_NOREQ_811_TOUCH (0xf0)
120
Rabin Vincent27e34992010-07-02 16:52:08 +0530121#endif