aboutsummaryrefslogtreecommitdiffstats
path: root/include/touchpad_lld.h
blob: 45a561d3c4ad675b5e72a0483a64ef3909657912 (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
/*
    ChibiOS-LCD-Driver/RT - Copyright (C) 2012
                 Joel Bodenmann aka Tectu <joel@unormal.org>

    This file is part of ChibiOS-LCD-Driver.

    ChibiOS-LCD-Driver 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-LCD-Driver 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	touchpad_lld.h
 * @brief	TOUCHPAD Driver subsystem low level driver header.
 *
 * @addgroup TOUCHPAD
 * @{
 */

#ifndef _TOUCHPAD_LLD_H
#define _TOUCHPAD_LLD_H

#if HAL_USE_TOUCHPAD || defined(__DOXYGEN__)

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

#include "touchpad_lld_config.h"

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

#ifndef TOUCHPAD_HAS_IRQ
	#define TOUCHPAD_HAS_IRQ	FALSE
#endif

#ifndef TOUCHPAD_HAS_PRESSURE
	#define TOUCHPAD_HAS_PRESSURE	FALSE
#endif

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

typedef struct TOUCHPADDriver TOUCHPADDriver;

/**
 * @brief	Structure representing a Touchpad driver.
 */
struct TOUCHPADDriver {
	/*
	 * @brief	Pointer to SPI driver.
	 */
	SPIDriver *spid;

	/*
	 * @brief	SPI configuration.
	 */
	SPIConfig *spicfg;	
};

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

#if !defined(__DOXYGEN__)
    extern TOUCHPADDriver Touchpad;
#endif

#ifdef __cplusplus
extern "C" {
#endif

	/* Core functions */
	void tp_lld_init(TOUCHPADDriver *tp);
	uint16_t tp_lld_read_x(void);
	uint16_t tp_lld_read_y(void);

	#if TOUCHPAD_HAS_IRQ
	uint8_t tp_lld_irq(void);
	#endif

	#if TOUCHPAD_HAS_PRESSURE
	uint16_t tp_lld_read_z(void);
	#endif

#ifdef __cplusplus
}
#endif

#endif /* HAL_USE_TOUCHPAD */

#endif /* _TOUCHPAD_LLD_H */
/** @} */