blob: 4a827af17e598792264662beb2ed86260dfbe3eb [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,
Patrice Chotard6bb9f0d2016-08-10 09:39:14 +020029 STMPE1600,
Rabin Vincent27e34992010-07-02 16:52:08 +053030 STMPE1601,
Jean-Nicolas Graux230f13a2013-04-09 10:35:19 +020031 STMPE1801,
Rabin Vincent27e34992010-07-02 16:52:08 +053032 STMPE2401,
33 STMPE2403,
Chris Blaire31f9b82012-01-26 22:17:03 +010034 STMPE_NBR_PARTS
Rabin Vincent27e34992010-07-02 16:52:08 +053035};
36
37/*
38 * For registers whose locations differ on variants, the correct address is
39 * obtained by indexing stmpe->regs with one of the following.
40 */
41enum {
42 STMPE_IDX_CHIP_ID,
Patrice Chotard0f4be8c2016-08-10 09:39:06 +020043 STMPE_IDX_SYS_CTRL,
44 STMPE_IDX_SYS_CTRL2,
Rabin Vincent27e34992010-07-02 16:52:08 +053045 STMPE_IDX_ICR_LSB,
46 STMPE_IDX_IER_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020047 STMPE_IDX_IER_MSB,
Jean-Nicolas Graux230f13a2013-04-09 10:35:19 +020048 STMPE_IDX_ISR_LSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053049 STMPE_IDX_ISR_MSB,
50 STMPE_IDX_GPMR_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020051 STMPE_IDX_GPMR_CSB,
52 STMPE_IDX_GPMR_MSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053053 STMPE_IDX_GPSR_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020054 STMPE_IDX_GPSR_CSB,
55 STMPE_IDX_GPSR_MSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053056 STMPE_IDX_GPCR_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020057 STMPE_IDX_GPCR_CSB,
58 STMPE_IDX_GPCR_MSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053059 STMPE_IDX_GPDR_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020060 STMPE_IDX_GPDR_CSB,
61 STMPE_IDX_GPDR_MSB,
62 STMPE_IDX_GPEDR_LSB,
63 STMPE_IDX_GPEDR_CSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053064 STMPE_IDX_GPEDR_MSB,
65 STMPE_IDX_GPRER_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020066 STMPE_IDX_GPRER_CSB,
67 STMPE_IDX_GPRER_MSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053068 STMPE_IDX_GPFER_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020069 STMPE_IDX_GPFER_CSB,
70 STMPE_IDX_GPFER_MSB,
Linus Walleij80e1dd82014-11-03 16:48:47 -080071 STMPE_IDX_GPPUR_LSB,
72 STMPE_IDX_GPPDR_LSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053073 STMPE_IDX_GPAFR_U_MSB,
74 STMPE_IDX_IEGPIOR_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020075 STMPE_IDX_IEGPIOR_CSB,
76 STMPE_IDX_IEGPIOR_MSB,
Jean-Nicolas Graux230f13a2013-04-09 10:35:19 +020077 STMPE_IDX_ISGPIOR_LSB,
Patrice Chotard897ac662016-08-10 09:39:11 +020078 STMPE_IDX_ISGPIOR_CSB,
Rabin Vincent27e34992010-07-02 16:52:08 +053079 STMPE_IDX_ISGPIOR_MSB,
80 STMPE_IDX_MAX,
81};
82
83
84struct stmpe_variant_info;
Viresh Kumar1a6e4b72011-11-17 11:02:20 +053085struct stmpe_client_info;
Linus Walleijfc1882d2016-05-25 14:22:02 +020086struct stmpe_platform_data;
Rabin Vincent27e34992010-07-02 16:52:08 +053087
88/**
89 * struct stmpe - STMPE MFD structure
Linus Walleij9c9e3212014-05-08 23:16:35 +020090 * @vcc: optional VCC regulator
91 * @vio: optional VIO regulator
Rabin Vincent27e34992010-07-02 16:52:08 +053092 * @lock: lock protecting I/O operations
93 * @irq_lock: IRQ bus lock
94 * @dev: device, mostly for dev_dbg()
Lee Jones76f93992012-11-05 16:10:31 +010095 * @irq_domain: IRQ domain
Viresh Kumar1a6e4b72011-11-17 11:02:20 +053096 * @client: client - i2c or spi
97 * @ci: client specific information
Om Prakash4dcaa6b2011-06-27 09:54:22 +020098 * @partnum: part number
Rabin Vincent27e34992010-07-02 16:52:08 +053099 * @variant: the detected STMPE model number
100 * @regs: list of addresses of registers which are at different addresses on
101 * different variants. Indexed by one of STMPE_IDX_*.
Viresh Kumar73de16d2011-11-08 09:44:06 +0530102 * @irq: irq number for stmpe
Rabin Vincent27e34992010-07-02 16:52:08 +0530103 * @num_gpios: number of gpios, differs for variants
104 * @ier: cache of IER registers for bus_lock
105 * @oldier: cache of IER registers for bus_lock
106 * @pdata: platform data
107 */
108struct stmpe {
Linus Walleij9c9e3212014-05-08 23:16:35 +0200109 struct regulator *vcc;
110 struct regulator *vio;
Rabin Vincent27e34992010-07-02 16:52:08 +0530111 struct mutex lock;
112 struct mutex irq_lock;
113 struct device *dev;
Lee Jones76f93992012-11-05 16:10:31 +0100114 struct irq_domain *domain;
Viresh Kumar1a6e4b72011-11-17 11:02:20 +0530115 void *client;
116 struct stmpe_client_info *ci;
Rabin Vincent27e34992010-07-02 16:52:08 +0530117 enum stmpe_partnum partnum;
118 struct stmpe_variant_info *variant;
119 const u8 *regs;
120
Viresh Kumar73de16d2011-11-08 09:44:06 +0530121 int irq;
Rabin Vincent27e34992010-07-02 16:52:08 +0530122 int num_gpios;
123 u8 ier[2];
124 u8 oldier[2];
125 struct stmpe_platform_data *pdata;
126};
127
128extern int stmpe_reg_write(struct stmpe *stmpe, u8 reg, u8 data);
129extern int stmpe_reg_read(struct stmpe *stmpe, u8 reg);
130extern int stmpe_block_read(struct stmpe *stmpe, u8 reg, u8 length,
131 u8 *values);
132extern int stmpe_block_write(struct stmpe *stmpe, u8 reg, u8 length,
133 const u8 *values);
134extern int stmpe_set_bits(struct stmpe *stmpe, u8 reg, u8 mask, u8 val);
135extern int stmpe_set_altfunc(struct stmpe *stmpe, u32 pins,
136 enum stmpe_block block);
137extern int stmpe_enable(struct stmpe *stmpe, unsigned int blocks);
138extern int stmpe_disable(struct stmpe *stmpe, unsigned int blocks);
139
Wolfram Sangb8e9cf02010-08-16 17:14:44 +0200140#define STMPE_GPIO_NOREQ_811_TOUCH (0xf0)
141
Rabin Vincent27e34992010-07-02 16:52:08 +0530142#endif