xref: /OK3568_Linux_fs/kernel/drivers/input/mouse/sentelic.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*-
3*4882a593Smuzhiyun  * Finger Sensing Pad PS/2 mouse driver.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2005-2007 Asia Vital Components Co., Ltd.
6*4882a593Smuzhiyun  * Copyright (C) 2005-2012 Tai-hwa Liang, Sentelic Corporation.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef	__SENTELIC_H
10*4882a593Smuzhiyun #define	__SENTELIC_H
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun /* Finger-sensing Pad information registers */
13*4882a593Smuzhiyun #define	FSP_REG_DEVICE_ID	0x00
14*4882a593Smuzhiyun #define	FSP_REG_VERSION		0x01
15*4882a593Smuzhiyun #define	FSP_REG_REVISION	0x04
16*4882a593Smuzhiyun #define	FSP_REG_TMOD_STATUS1	0x0B
17*4882a593Smuzhiyun #define	FSP_BIT_NO_ROTATION	BIT(3)
18*4882a593Smuzhiyun #define	FSP_REG_PAGE_CTRL	0x0F
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun /* Finger-sensing Pad control registers */
21*4882a593Smuzhiyun #define	FSP_REG_SYSCTL1		0x10
22*4882a593Smuzhiyun #define	FSP_BIT_EN_REG_CLK	BIT(5)
23*4882a593Smuzhiyun #define	FSP_REG_TMOD_STATUS	0x20
24*4882a593Smuzhiyun #define	FSP_REG_OPC_QDOWN	0x31
25*4882a593Smuzhiyun #define	FSP_BIT_EN_OPC_TAG	BIT(7)
26*4882a593Smuzhiyun #define	FSP_REG_OPTZ_XLO	0x34
27*4882a593Smuzhiyun #define	FSP_REG_OPTZ_XHI	0x35
28*4882a593Smuzhiyun #define	FSP_REG_OPTZ_YLO	0x36
29*4882a593Smuzhiyun #define	FSP_REG_OPTZ_YHI	0x37
30*4882a593Smuzhiyun #define	FSP_REG_SYSCTL5		0x40
31*4882a593Smuzhiyun #define	FSP_BIT_90_DEGREE	BIT(0)
32*4882a593Smuzhiyun #define	FSP_BIT_EN_MSID6	BIT(1)
33*4882a593Smuzhiyun #define	FSP_BIT_EN_MSID7	BIT(2)
34*4882a593Smuzhiyun #define	FSP_BIT_EN_MSID8	BIT(3)
35*4882a593Smuzhiyun #define	FSP_BIT_EN_AUTO_MSID8	BIT(5)
36*4882a593Smuzhiyun #define	FSP_BIT_EN_PKT_G0	BIT(6)
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #define	FSP_REG_ONPAD_CTL	0x43
39*4882a593Smuzhiyun #define	FSP_BIT_ONPAD_ENABLE	BIT(0)
40*4882a593Smuzhiyun #define	FSP_BIT_ONPAD_FBBB	BIT(1)
41*4882a593Smuzhiyun #define	FSP_BIT_FIX_VSCR	BIT(3)
42*4882a593Smuzhiyun #define	FSP_BIT_FIX_HSCR	BIT(5)
43*4882a593Smuzhiyun #define	FSP_BIT_DRAG_LOCK	BIT(6)
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun #define	FSP_REG_SWC1		(0x90)
46*4882a593Smuzhiyun #define	FSP_BIT_SWC1_EN_ABS_1F	BIT(0)
47*4882a593Smuzhiyun #define	FSP_BIT_SWC1_EN_GID	BIT(1)
48*4882a593Smuzhiyun #define	FSP_BIT_SWC1_EN_ABS_2F	BIT(2)
49*4882a593Smuzhiyun #define	FSP_BIT_SWC1_EN_FUP_OUT	BIT(3)
50*4882a593Smuzhiyun #define	FSP_BIT_SWC1_EN_ABS_CON	BIT(4)
51*4882a593Smuzhiyun #define	FSP_BIT_SWC1_GST_GRP0	BIT(5)
52*4882a593Smuzhiyun #define	FSP_BIT_SWC1_GST_GRP1	BIT(6)
53*4882a593Smuzhiyun #define	FSP_BIT_SWC1_BX_COMPAT	BIT(7)
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun #define	FSP_PAGE_0B		(0x0b)
56*4882a593Smuzhiyun #define	FSP_PAGE_82		(0x82)
57*4882a593Smuzhiyun #define	FSP_PAGE_DEFAULT	FSP_PAGE_82
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun #define	FSP_REG_SN0		(0x40)
60*4882a593Smuzhiyun #define	FSP_REG_SN1		(0x41)
61*4882a593Smuzhiyun #define	FSP_REG_SN2		(0x42)
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun /* Finger-sensing Pad packet formating related definitions */
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun /* absolute packet type */
66*4882a593Smuzhiyun #define	FSP_PKT_TYPE_NORMAL	(0x00)
67*4882a593Smuzhiyun #define	FSP_PKT_TYPE_ABS	(0x01)
68*4882a593Smuzhiyun #define	FSP_PKT_TYPE_NOTIFY	(0x02)
69*4882a593Smuzhiyun #define	FSP_PKT_TYPE_NORMAL_OPC	(0x03)
70*4882a593Smuzhiyun #define	FSP_PKT_TYPE_SHIFT	(6)
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun /* bit definitions for the first byte of report packet */
73*4882a593Smuzhiyun #define	FSP_PB0_LBTN		BIT(0)
74*4882a593Smuzhiyun #define	FSP_PB0_RBTN		BIT(1)
75*4882a593Smuzhiyun #define	FSP_PB0_MBTN		BIT(2)
76*4882a593Smuzhiyun #define	FSP_PB0_MFMC_FGR2	FSP_PB0_MBTN
77*4882a593Smuzhiyun #define	FSP_PB0_MUST_SET	BIT(3)
78*4882a593Smuzhiyun #define	FSP_PB0_PHY_BTN		BIT(4)
79*4882a593Smuzhiyun #define	FSP_PB0_MFMC		BIT(5)
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun /* hardware revisions */
82*4882a593Smuzhiyun #define	FSP_VER_STL3888_A4	(0xC1)
83*4882a593Smuzhiyun #define	FSP_VER_STL3888_B0	(0xD0)
84*4882a593Smuzhiyun #define	FSP_VER_STL3888_B1	(0xD1)
85*4882a593Smuzhiyun #define	FSP_VER_STL3888_B2	(0xD2)
86*4882a593Smuzhiyun #define	FSP_VER_STL3888_C0	(0xE0)
87*4882a593Smuzhiyun #define	FSP_VER_STL3888_C1	(0xE1)
88*4882a593Smuzhiyun #define	FSP_VER_STL3888_D0	(0xE2)
89*4882a593Smuzhiyun #define	FSP_VER_STL3888_D1	(0xE3)
90*4882a593Smuzhiyun #define	FSP_VER_STL3888_E0	(0xE4)
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun #ifdef __KERNEL__
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun struct fsp_data {
95*4882a593Smuzhiyun 	unsigned char	ver;		/* hardware version */
96*4882a593Smuzhiyun 	unsigned char	rev;		/* hardware revison */
97*4882a593Smuzhiyun 	unsigned int	buttons;	/* Number of buttons */
98*4882a593Smuzhiyun 	unsigned int	flags;
99*4882a593Smuzhiyun #define	FSPDRV_FLAG_EN_OPC	(0x001)	/* enable on-pad clicking */
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun 	bool		vscroll;	/* Vertical scroll zone enabled */
102*4882a593Smuzhiyun 	bool		hscroll;	/* Horizontal scroll zone enabled */
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	unsigned char	last_reg;	/* Last register we requested read from */
105*4882a593Smuzhiyun 	unsigned char	last_val;
106*4882a593Smuzhiyun 	unsigned int	last_mt_fgr;	/* Last seen finger(multitouch) */
107*4882a593Smuzhiyun };
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun extern int fsp_detect(struct psmouse *psmouse, bool set_properties);
110*4882a593Smuzhiyun extern int fsp_init(struct psmouse *psmouse);
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun #endif	/* __KERNEL__ */
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun #endif	/* !__SENTELIC_H */
115