xref: /linux/include/linux/mfd/stmpe.h (revision 6bb9f0d93399cbde14fc6a1532341a14a85d2df4)
127e34995SRabin Vincent /*
227e34995SRabin Vincent  * Copyright (C) ST-Ericsson SA 2010
327e34995SRabin Vincent  *
427e34995SRabin Vincent  * License Terms: GNU General Public License, version 2
527e34995SRabin Vincent  * Author: Rabin Vincent <rabin.vincent@stericsson.com> for ST-Ericsson
627e34995SRabin Vincent  */
727e34995SRabin Vincent 
827e34995SRabin Vincent #ifndef __LINUX_MFD_STMPE_H
927e34995SRabin Vincent #define __LINUX_MFD_STMPE_H
1027e34995SRabin Vincent 
11313162d0SPaul Gortmaker #include <linux/mutex.h>
12313162d0SPaul Gortmaker 
13313162d0SPaul Gortmaker struct device;
149c9e3214SLinus Walleij struct regulator;
1527e34995SRabin Vincent 
1627e34995SRabin Vincent enum stmpe_block {
1727e34995SRabin Vincent 	STMPE_BLOCK_GPIO	= 1 << 0,
1827e34995SRabin Vincent 	STMPE_BLOCK_KEYPAD	= 1 << 1,
1927e34995SRabin Vincent 	STMPE_BLOCK_TOUCHSCREEN	= 1 << 2,
2027e34995SRabin Vincent 	STMPE_BLOCK_ADC		= 1 << 3,
2127e34995SRabin Vincent 	STMPE_BLOCK_PWM		= 1 << 4,
2227e34995SRabin Vincent 	STMPE_BLOCK_ROTATOR	= 1 << 5,
2327e34995SRabin Vincent };
2427e34995SRabin Vincent 
2527e34995SRabin Vincent enum stmpe_partnum {
261cda2394SViresh Kumar 	STMPE610,
277f7f4ea1SViresh Kumar 	STMPE801,
2827e34995SRabin Vincent 	STMPE811,
29*6bb9f0d9SPatrice Chotard 	STMPE1600,
3027e34995SRabin Vincent 	STMPE1601,
31230f13a5SJean-Nicolas Graux 	STMPE1801,
3227e34995SRabin Vincent 	STMPE2401,
3327e34995SRabin Vincent 	STMPE2403,
34e31f9b82SChris Blair 	STMPE_NBR_PARTS
3527e34995SRabin Vincent };
3627e34995SRabin Vincent 
3727e34995SRabin Vincent /*
3827e34995SRabin Vincent  * For registers whose locations differ on variants,  the correct address is
3927e34995SRabin Vincent  * obtained by indexing stmpe->regs with one of the following.
4027e34995SRabin Vincent  */
4127e34995SRabin Vincent enum {
4227e34995SRabin Vincent 	STMPE_IDX_CHIP_ID,
430f4be8cfSPatrice Chotard 	STMPE_IDX_SYS_CTRL,
440f4be8cfSPatrice Chotard 	STMPE_IDX_SYS_CTRL2,
4527e34995SRabin Vincent 	STMPE_IDX_ICR_LSB,
4627e34995SRabin Vincent 	STMPE_IDX_IER_LSB,
47897ac667SPatrice Chotard 	STMPE_IDX_IER_MSB,
48230f13a5SJean-Nicolas Graux 	STMPE_IDX_ISR_LSB,
4927e34995SRabin Vincent 	STMPE_IDX_ISR_MSB,
5027e34995SRabin Vincent 	STMPE_IDX_GPMR_LSB,
51897ac667SPatrice Chotard 	STMPE_IDX_GPMR_CSB,
52897ac667SPatrice Chotard 	STMPE_IDX_GPMR_MSB,
5327e34995SRabin Vincent 	STMPE_IDX_GPSR_LSB,
54897ac667SPatrice Chotard 	STMPE_IDX_GPSR_CSB,
55897ac667SPatrice Chotard 	STMPE_IDX_GPSR_MSB,
5627e34995SRabin Vincent 	STMPE_IDX_GPCR_LSB,
57897ac667SPatrice Chotard 	STMPE_IDX_GPCR_CSB,
58897ac667SPatrice Chotard 	STMPE_IDX_GPCR_MSB,
5927e34995SRabin Vincent 	STMPE_IDX_GPDR_LSB,
60897ac667SPatrice Chotard 	STMPE_IDX_GPDR_CSB,
61897ac667SPatrice Chotard 	STMPE_IDX_GPDR_MSB,
62897ac667SPatrice Chotard 	STMPE_IDX_GPEDR_LSB,
63897ac667SPatrice Chotard 	STMPE_IDX_GPEDR_CSB,
6427e34995SRabin Vincent 	STMPE_IDX_GPEDR_MSB,
6527e34995SRabin Vincent 	STMPE_IDX_GPRER_LSB,
66897ac667SPatrice Chotard 	STMPE_IDX_GPRER_CSB,
67897ac667SPatrice Chotard 	STMPE_IDX_GPRER_MSB,
6827e34995SRabin Vincent 	STMPE_IDX_GPFER_LSB,
69897ac667SPatrice Chotard 	STMPE_IDX_GPFER_CSB,
70897ac667SPatrice Chotard 	STMPE_IDX_GPFER_MSB,
7180e1dd82SLinus Walleij 	STMPE_IDX_GPPUR_LSB,
7280e1dd82SLinus Walleij 	STMPE_IDX_GPPDR_LSB,
7327e34995SRabin Vincent 	STMPE_IDX_GPAFR_U_MSB,
7427e34995SRabin Vincent 	STMPE_IDX_IEGPIOR_LSB,
75897ac667SPatrice Chotard 	STMPE_IDX_IEGPIOR_CSB,
76897ac667SPatrice Chotard 	STMPE_IDX_IEGPIOR_MSB,
77230f13a5SJean-Nicolas Graux 	STMPE_IDX_ISGPIOR_LSB,
78897ac667SPatrice Chotard 	STMPE_IDX_ISGPIOR_CSB,
7927e34995SRabin Vincent 	STMPE_IDX_ISGPIOR_MSB,
8027e34995SRabin Vincent 	STMPE_IDX_MAX,
8127e34995SRabin Vincent };
8227e34995SRabin Vincent 
8327e34995SRabin Vincent 
8427e34995SRabin Vincent struct stmpe_variant_info;
851a6e4b74SViresh Kumar struct stmpe_client_info;
86fc1882dcSLinus Walleij struct stmpe_platform_data;
8727e34995SRabin Vincent 
8827e34995SRabin Vincent /**
8927e34995SRabin Vincent  * struct stmpe - STMPE MFD structure
909c9e3214SLinus Walleij  * @vcc: optional VCC regulator
919c9e3214SLinus Walleij  * @vio: optional VIO regulator
9227e34995SRabin Vincent  * @lock: lock protecting I/O operations
9327e34995SRabin Vincent  * @irq_lock: IRQ bus lock
9427e34995SRabin Vincent  * @dev: device, mostly for dev_dbg()
9576f93992SLee Jones  * @irq_domain: IRQ domain
961a6e4b74SViresh Kumar  * @client: client - i2c or spi
971a6e4b74SViresh Kumar  * @ci: client specific information
984dcaa6b6SOm Prakash  * @partnum: part number
9927e34995SRabin Vincent  * @variant: the detected STMPE model number
10027e34995SRabin Vincent  * @regs: list of addresses of registers which are at different addresses on
10127e34995SRabin Vincent  *	  different variants.  Indexed by one of STMPE_IDX_*.
10273de16dbSViresh Kumar  * @irq: irq number for stmpe
10327e34995SRabin Vincent  * @num_gpios: number of gpios, differs for variants
10427e34995SRabin Vincent  * @ier: cache of IER registers for bus_lock
10527e34995SRabin Vincent  * @oldier: cache of IER registers for bus_lock
10627e34995SRabin Vincent  * @pdata: platform data
10727e34995SRabin Vincent  */
10827e34995SRabin Vincent struct stmpe {
1099c9e3214SLinus Walleij 	struct regulator *vcc;
1109c9e3214SLinus Walleij 	struct regulator *vio;
11127e34995SRabin Vincent 	struct mutex lock;
11227e34995SRabin Vincent 	struct mutex irq_lock;
11327e34995SRabin Vincent 	struct device *dev;
11476f93992SLee Jones 	struct irq_domain *domain;
1151a6e4b74SViresh Kumar 	void *client;
1161a6e4b74SViresh Kumar 	struct stmpe_client_info *ci;
11727e34995SRabin Vincent 	enum stmpe_partnum partnum;
11827e34995SRabin Vincent 	struct stmpe_variant_info *variant;
11927e34995SRabin Vincent 	const u8 *regs;
12027e34995SRabin Vincent 
12173de16dbSViresh Kumar 	int irq;
12227e34995SRabin Vincent 	int num_gpios;
12327e34995SRabin Vincent 	u8 ier[2];
12427e34995SRabin Vincent 	u8 oldier[2];
12527e34995SRabin Vincent 	struct stmpe_platform_data *pdata;
12627e34995SRabin Vincent };
12727e34995SRabin Vincent 
12827e34995SRabin Vincent extern int stmpe_reg_write(struct stmpe *stmpe, u8 reg, u8 data);
12927e34995SRabin Vincent extern int stmpe_reg_read(struct stmpe *stmpe, u8 reg);
13027e34995SRabin Vincent extern int stmpe_block_read(struct stmpe *stmpe, u8 reg, u8 length,
13127e34995SRabin Vincent 			    u8 *values);
13227e34995SRabin Vincent extern int stmpe_block_write(struct stmpe *stmpe, u8 reg, u8 length,
13327e34995SRabin Vincent 			     const u8 *values);
13427e34995SRabin Vincent extern int stmpe_set_bits(struct stmpe *stmpe, u8 reg, u8 mask, u8 val);
13527e34995SRabin Vincent extern int stmpe_set_altfunc(struct stmpe *stmpe, u32 pins,
13627e34995SRabin Vincent 			     enum stmpe_block block);
13727e34995SRabin Vincent extern int stmpe_enable(struct stmpe *stmpe, unsigned int blocks);
13827e34995SRabin Vincent extern int stmpe_disable(struct stmpe *stmpe, unsigned int blocks);
13927e34995SRabin Vincent 
140b8e9cf0bSWolfram Sang #define STMPE_GPIO_NOREQ_811_TOUCH	(0xf0)
141b8e9cf0bSWolfram Sang 
14227e34995SRabin Vincent #endif
143