aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/touchpad/XPT2046/touchpad_lld.c
blob: 50f73e12ab18d857dbfc63765a9463aeb74e772c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*
    ChibiOS/GFX - Copyright (C) 2012
                 Joel Bodenmann aka Tectu <joel@unormal.org>

    This file is part of ChibiOS/GFX.

    ChibiOS/GFX is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/GFX is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    touchpadXPT2046/touchpad_lld.c
 * @brief   Touchpad Driver subsystem low level driver source.
 *
 * @addtogroup TOUCHPAD
 * @{
 */

#include "ch.h"
#include "hal.h"
#include "touchpad.h"

#if HAL_USE_TOUCHPAD || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver local definitions.                                                 */
/*===========================================================================*/

#ifdef UNUSED
#elif defined(__GNUC__)
# define UNUSED(x) UNUSED_ ## x __attribute__((unused))
#elif defined(__LCLINT__)
# define UNUSED(x) /*@unused@*/ x
#else
# define UNUSED(x) x
#endif

/*===========================================================================*/
/* Driver exported variables.                                                */
/*===========================================================================*/

/*===========================================================================*/
/* Driver local variables.                                                   */
/*===========================================================================*/
#if !defined(__DOXYGEN__)
    /* Local copy of the current touchpad driver */
    static const TOUCHPADDriver *tpDriver;

    static uint16_t sampleBuf[7];
#endif

/*===========================================================================*/
/* Driver local functions.                                                   */
/*===========================================================================*/

/*===========================================================================*/
/* Driver interrupt handlers.                                                */
/*===========================================================================*/

/*===========================================================================*/
/* Driver exported functions.                                                */
/*===========================================================================*/

/* ---- Required Routines ---- */

/**
 * @brief   Low level Touchpad driver initialization.
 *
 * @notapi
 */
void tp_lld_init(const TOUCHPADDriver *tp) {
	tpDriver = tp;

	if(tpDriver->direct_init)
		spiStart(tpDriver->spip, tpDriver->spicfg);
}


/**
 * @brief   Reads a conversion from the touchpad
 *
 * @param[in] cmd    The command bits to send to the touchpad
 *
 * @return  The read value 12-bit right-justified
 *
 * @note    This function only reads data, it is assumed that the pins are
 *          configured properly and the bus has been acquired beforehand
 *
 * @notapi
 */
uint16_t tp_lld_read_value(uint8_t cmd) {
	static uint8_t txbuf[3] = {0};
	static uint8_t rxbuf[3] = {0};
	uint16_t ret;

	txbuf[0] = cmd;

	spiExchange(tpDriver->spip, 3, txbuf, rxbuf);

	ret = (rxbuf[1] << 5) | (rxbuf[2] >> 3);

	return ret;
}

/**
 * @brief   7-point median filtering code for touchpad samples
 *
 * @note    This is an internally used routine only.
 *
 * @notapi
 */
static void tp_lld_filter(void) {
	uint16_t temp;
	int i,j;

	for(i = 0; i < 4; i++) {
		for(j=i; j < 7; j++) {
			if(sampleBuf[i] > sampleBuf[j]) {
				/* Swap the values */
				temp = sampleBuf[i];
				sampleBuf[i] = sampleBuf[j];
				sampleBuf[j] = temp;
			}
		}
	}
}

/**
 * @brief   Reads out the X direction.
 *
 * @note    The samples are median filtered for greater noise reduction
 *
 * @notapi
 */
uint16_t tp_lld_read_x(void) {
	int i;

#if defined(SPI_USE_MUTUAL_EXCLUSION)
	spiAcquireBus(tpDriver->spip);
#endif

	TOUCHPAD_SPI_PROLOGUE();
	palClearPad(tpDriver->spicfg->ssport, tpDriver->spicfg->sspad);

	/* Discard the first conversion - very noisy and keep the ADC on hereafter
	 * till we are done with the sampling. Note that PENIRQ is disabled.
 	 */
	tp_lld_read_value(0xD1);

	for(i = 0; i < 7; i++) {
		sampleBuf[i]=tp_lld_read_value(0xD1);
	}

	/* Switch on PENIRQ once again - perform a dummy read */
	tp_lld_read_value(0xD0);

	palSetPad(tpDriver->spicfg->ssport, tpDriver->spicfg->sspad);
	TOUCHPAD_SPI_EPILOGUE();

#if defined(SPI_USE_MUTUAL_EXCLUSION)
	spiReleaseBus(tpDriver->spip);
#endif

	/* Find the median - use selection sort */
	tp_lld_filter();

	return sampleBuf[3];
}

/*
 * @brief	Reads out the Y direction.
 *
 * @notapi
 */
uint16_t tp_lld_read_y(void) {
	int i;

#if defined(SPI_USE_MUTUAL_EXCLUSION)
	spiAcquireBus(tpDriver->spip);
#endif

	TOUCHPAD_SPI_PROLOGUE();
	palClearPad(tpDriver->spicfg->ssport, tpDriver->spicfg->sspad);

	/* Discard the first conversion - very noisy and keep the ADC on hereafter
	 * till we are done with the sampling. Note that PENIRQ is disabled.
	 */
	tp_lld_read_value(0x91);

	for(i = 0; i < 7; i++) {
		sampleBuf[i] = tp_lld_read_value(0x91);
	}

	/* Switch on PENIRQ once again - perform a dummy read */
	tp_lld_read_value(0x90);

	palSetPad(tpDriver->spicfg->ssport, tpDriver->spicfg->sspad);
	TOUCHPAD_SPI_EPILOGUE();

#ifdef SPI_USE_MUTUAL_EXCLUSION
	spiReleaseBus(tpDriver->spip);
#endif

	/* Find the median - use selection sort */
	tp_lld_filter();

	return sampleBuf[3];
}

/* ---- Optional Routines ---- */
#if TOUCHPAD_HAS_IRQ || defined(__DOXYGEN__)
	/*
	 * @brief	for checking if touchpad is pressed or not.
	 *
	 * @return	1 if pressed / 0 if not pressed
	 *
	 * @notapi
	 */
	uint8_t tp_lld_irq(void) {
		return (!palReadPad(tpDriver->tpIRQPort, tpDriver->tpIRQPin));
	}
#endif

#if TOUCHPAD_HAS_PRESSURE || defined(__DOXYGEN__)
	/*
	 * @brief	Reads out the Z direction / pressure.
	 *
	 * @notapi
	 */
	uint16_t tp_lld_read_z(void) {
		/* ToDo */
		return 42;
	}
#endif

#endif /* HAL_USE_TOUCHPAD */
/** @} */