a752c7ab
 elopes
add first test an...
|
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
|
/*
* Copyright (C) 2017 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup drivers_hd44780 HD44780 LCD driver
* @ingroup drivers_actuators
* @brief Driver for the Hitachi HD44780 LCD driver
*
* @note The driver currently supports direct addressing, no I2C
*
* @{
*
* @file
* @brief Interface definition for the HD44780 LCD driver
*
* @author Sebastian Meiling <s@mlng.net>
*/
#ifndef HD44780_H
#define HD44780_H
#include <stdint.h>
#include "periph/gpio.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Maximal number of columns supported by the driver
*/
#define HD44780_MAX_COLS (40U)
/**
* @brief Maximal number of rows supported by the driver
*/
#define HD44780_MAX_ROWS (4U)
/**
* @brief Number of data pins for communication 4 or 8.
*/
#define HD44780_MAX_PINS (8U)
/**
* @brief Specific value to turn rw pin off, if unused.
*/
#define HD44780_RW_OFF (255U)
/**
* @brief Size of RAM for custom chars
*
* Generally the driver could support 8 chars of size 5x8 or 4 of size 5x10.
* However, most displays only use the former, which is (hard wired) default.
*/
#define HD44780_CGRAM_SIZE (8U)
/**
* @brief Parameters needed for device initialization
*/
typedef struct {
uint8_t cols; /**< number of LCD cols */
uint8_t rows; /**< number of LCD rows */
gpio_t rs; /**< rs gpio pin */
gpio_t rw; /**< rw gpio pin */
gpio_t enable; /**< enable gpio pin */
gpio_t data[8]; /**< data gpio pins */
} hd44780_params_t;
/**
* @brief Device descriptor for HD44780 LCD
*/
typedef struct {
hd44780_params_t p; /**< LCD config parameters */
uint8_t flag; /**< LCD functional flags */
uint8_t ctrl; /**< LCD control flags */
uint8_t mode; /**< LCD mode flags */
uint8_t roff[HD44780_MAX_ROWS]; /**< offsets for LCD rows */
} hd44780_t;
/**
* @brief Simple state values
*/
typedef enum {
HD44780_OFF, /**< disable feature */
HD44780_ON /**< enable feature */
} hd44780_state_t;
/**
* @brief Initialize the given driver
*
* @param[out] dev device descriptor of display to initialize
* @param[in] params configuration parameters
*
* @return 0 on success, otherwise error
*/
int hd44780_init(hd44780_t *dev, const hd44780_params_t *params);
/**
* @brief Clear display, delete all chars
*
* @param[in] dev device descriptor of LCD
*/
void hd44780_clear(const hd44780_t *dev);
/**
* @brief Reset cursor to row 0 and column 0
*
* @param[in] dev device descriptor of LCD
*/
void hd44780_home(const hd44780_t *dev);
/**
* @brief Set cursor to specific position in column and row
*
* @param[in] dev device descriptor of LCD
* @param[in] col column position
* @param[in] row row position
*/
void hd44780_set_cursor(const hd44780_t *dev, uint8_t col, uint8_t row);
/**
* @brief Turn display on or off
*
* @param[in] dev device descriptor of LCD
* @param[in] state display on or off
*/
void hd44780_display(hd44780_t *dev, hd44780_state_t state);
/**
* @brief Show cursor, on or off
*
* @param[in] dev device descriptor of LCD
* @param[in] state cursor on or off
*/
void hd44780_cursor(hd44780_t *dev, hd44780_state_t state);
/**
* @brief Blink cursor, on or off
*
* @param[in] dev device descriptor of LCD
* @param[in] state blink on or off
*/
void hd44780_blink(hd44780_t *dev, hd44780_state_t state);
/**
* @brief Enable left scrolling
*
* @param[in] dev device descriptor of LCD
*/
void hd44780_scroll_left(const hd44780_t *dev);
/**
* @brief Enable right scrolling
*
* @param[in] dev device descriptor of LCD
*/
void hd44780_scroll_right(const hd44780_t *dev);
/**
* @brief Set display direction left to right
*
* @param[in] dev device descriptor of LCD
*/
void hd44780_left2right(hd44780_t *dev);
/**
* @brief Set display direction right to left
*
* @param[in] dev device descriptor of LCD
*/
void hd44780_right2left(hd44780_t *dev);
/**
* @brief Display autoscroll on or off
*
* @param[in] dev device descriptor of LCD
* @param[in] state scroll on or off
*/
void hd44780_autoscroll(hd44780_t *dev, hd44780_state_t state);
/**
* @brief Create and store a custom character on display memory
*
* @param[in] dev device descriptor of LCD
* @param[in] location memory location
* @param[in] charmap character bitmap
*
* @pre charmap has to be of size HD44780_CGRAM_SIZE, which is 8 by default
*/
void hd44780_create_char(const hd44780_t *dev, uint8_t location, uint8_t charmap[]);
/**
* @brief Write a single character on the LCD
*
* @param[in] dev device descriptor of LCD
* @param[in] value the character to print, i.e., memory location
*/
void hd44780_write(const hd44780_t *dev, uint8_t value);
/**
* @brief Write a string on the LCD
*
* @param[in] dev device descriptor of LCD
* @param[in] data the string to print
*/
void hd44780_print(const hd44780_t *dev, const char *data);
#ifdef __cplusplus
}
#endif
#endif /* HD44780_H */
/** @} */
|