aboutsummaryrefslogtreecommitdiffstats
path: root/include/touchscreen_lld.h
blob: 9dd2962905135df8a05b4161d64e2f636f3ea844 (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
/*
    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	include/touchscreen_lld.h
 * @brief	TOUCHSCREEN Driver subsystem low level driver header.
 *
 * @addtogroup TOUCHSCREEN
 * @{
 */

#ifndef TOUCHSCREEN_LLD_H
#define TOUCHSCREEN_LLD_H

#if GFX_USE_TOUCHSCREEN || defined(__DOXYGEN__)

/*===========================================================================*/
/* Include the low level driver configuration information                    */
/*===========================================================================*/

#include "touchscreen_lld_config.h"

/*===========================================================================*/
/* Error checks.                                                             */
/*===========================================================================*/

#ifndef TOUCHSCREEN_NEED_MULTITHREAD
	#define TOUCHSCREEN_NEED_MULTITHREAD	FALSE
#endif

#ifndef TOUCHSCREEN_XY_INVERTED
	#define TOUCHSCREEN_XY_INVERTED	FALSE
#endif

#ifndef TOUCHSCREEN_HAS_PRESSED
	#define TOUCHSCREEN_HAS_PRESSED	FALSE
#endif

#ifndef TOUCHSCREEN_HAS_PRESSURE
	#define TOUCHSCREEN_HAS_PRESSURE	FALSE
#endif

#ifndef TOUCHSCREEN_SPI_PROLOGUE
    #define TOUCHSCREEN_SPI_PROLOGUE()
#endif

#ifndef TOUCHSCREEN_SPI_EPILOGUE
    #define TOUCHSCREEN_SPI_EPILOGUE()
#endif

#ifndef TOUCHSCREEN_STORE_CALIBRATION
	#define TOUCHSCREEN_STORE_CALIBRATION FALSE
#endif

#ifndef TOUCHSCREEN_VERIFY_CALIBRATION
	#define TOUCHSCREEN_VERIFY_CALIBRATION FALSE
#endif

#ifndef TOUCHSCREEN_CONVERSIONS
	#define	TOUCHSCREEN_CONVERSIONS 3
#endif

/*===========================================================================*/
/* Driver types.                                                             */
/*===========================================================================*/

/**
 * @brief	Structure representing a touchscreen driver. Hardware dependant.
 */
typedef struct TouchscreenDriver TouchscreenDriver;

// Forward declaration
struct cal_t;

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/


#ifdef __cplusplus
extern "C" {
#endif

	/* Core functions */
	void ts_lld_init(const TouchscreenDriver *ts);

	uint16_t ts_lld_read_value(uint8_t cmd);
	uint16_t ts_lld_read_x(void);
	uint16_t ts_lld_read_y(void);

	#if TOUCHSCREEN_HAS_PRESSED
	uint8_t ts_lld_pressed(void);
	#endif

	#if TOUCHSCREEN_HAS_PRESSURE
	uint16_t ts_lld_read_z(void);
	#endif

	#if TOUCHSCREEN_STORE_CALIBRATION
	// These may be defined by the low level driver or by the application
	void ts_store_calibration_lld(struct cal_t *cal);
	struct cal_t *ts_restore_calibration_lld(void);
	#endif

#ifdef __cplusplus
}
#endif

#endif /* GFX_USE_TOUCHSCREEN */

#endif /* _TOUCHSCREEN_LLD_H */
/** @} */