ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include <stdlib.h>
#include <stdint.h>
#include <sys/cdefs.h>
#include "sdkconfig.h"
#define LOG_LOCAL_LEVEL
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_lcd_panel_interface.h"
#include "esp_lcd_panel_io.h"
#include "esp_lcd_panel_ssd1306.h"
#include "esp_lcd_panel_ops.h"
#include "driver/gpio.h"
#include "esp_log.h"
#include "esp_check.h"
#include "esp_compiler.h"
TAG
#define SSD1306_CMD_SET_MEMORY_ADDR_MODE
#define SSD1306_CMD_SET_COLUMN_RANGE
#define SSD1306_CMD_SET_PAGE_RANGE
#define SSD1306_CMD_SET_CHARGE_PUMP
#define SSD1306_CMD_MIRROR_X_OFF
#define SSD1306_CMD_MIRROR_X_ON
#define SSD1306_CMD_INVERT_OFF
#define SSD1306_CMD_INVERT_ON
#define SSD1306_CMD_SET_MULTIPLEX
#define SSD1306_CMD_DISP_OFF
#define SSD1306_CMD_DISP_ON
#define SSD1306_CMD_MIRROR_Y_OFF
#define SSD1306_CMD_MIRROR_Y_ON
#define SSD1306_CMD_SET_COMPINS
ssd1306_panel_t
esp_lcd_new_panel_ssd1306(const esp_lcd_panel_io_handle_t, const esp_lcd_panel_dev_config_t *, esp_lcd_panel_handle_t *)
panel_ssd1306_del(esp_lcd_panel_t *)
panel_ssd1306_reset(esp_lcd_panel_t *)
panel_ssd1306_init(esp_lcd_panel_t *)
panel_ssd1306_draw_bitmap(esp_lcd_panel_t *, int, int, int, int, const void *)
panel_ssd1306_invert_color(esp_lcd_panel_t *, bool)
panel_ssd1306_mirror(esp_lcd_panel_t *, bool, bool)
panel_ssd1306_swap_xy(esp_lcd_panel_t *, bool)
panel_ssd1306_set_gap(esp_lcd_panel_t *, int, int)
panel_ssd1306_disp_on_off(esp_lcd_panel_t *, bool)
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/esp_lcd/src/esp_lcd_panel_ssd1306.c
 
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #include <stdlib.h> #include <stdint.h> #include <sys/cdefs.h> #include "sdkconfig.h" #if CONFIG_LCD_ENABLE_DEBUG_LOG // The local log level must be defined before including esp_log.h // Set the maximum log level for this source file #define LOG_LOCAL_LEVEL ESP_LOG_DEBUG/* ... */ #endif #include "freertos/FreeRTOS.h" #include "freertos/task.h" #include "esp_lcd_panel_interface.h" #include "esp_lcd_panel_io.h" #include "esp_lcd_panel_ssd1306.h" #include "esp_lcd_panel_ops.h" #include "driver/gpio.h" #include "esp_log.h" #include "esp_check.h" #include "esp_compiler.h"10 includes static const char *TAG = "lcd_panel.ssd1306"; // SSD1306 commands #define SSD1306_CMD_SET_MEMORY_ADDR_MODE 0x20 #define SSD1306_CMD_SET_COLUMN_RANGE 0x21 #define SSD1306_CMD_SET_PAGE_RANGE 0x22 #define SSD1306_CMD_SET_CHARGE_PUMP 0x8D #define SSD1306_CMD_MIRROR_X_OFF 0xA0 #define SSD1306_CMD_MIRROR_X_ON 0xA1 #define SSD1306_CMD_INVERT_OFF 0xA6 #define SSD1306_CMD_INVERT_ON 0xA7 #define SSD1306_CMD_SET_MULTIPLEX 0xA8 #define SSD1306_CMD_DISP_OFF 0xAE #define SSD1306_CMD_DISP_ON 0xAF #define SSD1306_CMD_MIRROR_Y_OFF 0xC0 #define SSD1306_CMD_MIRROR_Y_ON 0xC8 #define SSD1306_CMD_SET_COMPINS 0xDA14 defines static esp_err_t panel_ssd1306_del(esp_lcd_panel_t *panel); static esp_err_t panel_ssd1306_reset(esp_lcd_panel_t *panel); static esp_err_t panel_ssd1306_init(esp_lcd_panel_t *panel); static esp_err_t panel_ssd1306_draw_bitmap(esp_lcd_panel_t *panel, int x_start, int y_start, int x_end, int y_end, const void *color_data); static esp_err_t panel_ssd1306_invert_color(esp_lcd_panel_t *panel, bool invert_color_data); static esp_err_t panel_ssd1306_mirror(esp_lcd_panel_t *panel, bool mirror_x, bool mirror_y); static esp_err_t panel_ssd1306_swap_xy(esp_lcd_panel_t *panel, bool swap_axes); static esp_err_t panel_ssd1306_set_gap(esp_lcd_panel_t *panel, int x_gap, int y_gap); static esp_err_t panel_ssd1306_disp_on_off(esp_lcd_panel_t *panel, bool off); typedef struct { esp_lcd_panel_t base; esp_lcd_panel_io_handle_t io; uint8_t height; int reset_gpio_num; int x_gap; int y_gap; unsigned int bits_per_pixel; bool reset_level; bool swap_axes; }{ ... } ssd1306_panel_t; esp_err_t esp_lcd_new_panel_ssd1306(const esp_lcd_panel_io_handle_t io, const esp_lcd_panel_dev_config_t *panel_dev_config, esp_lcd_panel_handle_t *ret_panel) { #if CONFIG_LCD_ENABLE_DEBUG_LOG esp_log_level_set(TAG, ESP_LOG_DEBUG); #endif esp_err_t ret = ESP_OK; ssd1306_panel_t *ssd1306 = NULL; ESP_GOTO_ON_FALSE(io && panel_dev_config && ret_panel, ESP_ERR_INVALID_ARG, err, TAG, "invalid argument"); ESP_GOTO_ON_FALSE(panel_dev_config->bits_per_pixel == 1, ESP_ERR_INVALID_ARG, err, TAG, "bpp must be 1"); esp_lcd_panel_ssd1306_config_t *ssd1306_spec_config = (esp_lcd_panel_ssd1306_config_t *)panel_dev_config->vendor_config; // leak detection of ssd1306 because saving ssd1306->base address ESP_COMPILER_DIAGNOSTIC_PUSH_IGNORE("-Wanalyzer-malloc-leak") ssd1306 = calloc(1, sizeof(ssd1306_panel_t)); ESP_GOTO_ON_FALSE(ssd1306, ESP_ERR_NO_MEM, err, TAG, "no mem for ssd1306 panel"); if (panel_dev_config->reset_gpio_num >= 0) { gpio_config_t io_conf = { .mode = GPIO_MODE_OUTPUT, .pin_bit_mask = 1ULL << panel_dev_config->reset_gpio_num, }{...}; ESP_GOTO_ON_ERROR(gpio_config(&io_conf), err, TAG, "configure GPIO for RST line failed"); }{...} ssd1306->io = io; ssd1306->bits_per_pixel = panel_dev_config->bits_per_pixel; ssd1306->reset_gpio_num = panel_dev_config->reset_gpio_num; ssd1306->reset_level = panel_dev_config->flags.reset_active_high; ssd1306->height = ssd1306_spec_config ? ssd1306_spec_config->height : 64; ssd1306->base.del = panel_ssd1306_del; ssd1306->base.reset = panel_ssd1306_reset; ssd1306->base.init = panel_ssd1306_init; ssd1306->base.draw_bitmap = panel_ssd1306_draw_bitmap; ssd1306->base.invert_color = panel_ssd1306_invert_color; ssd1306->base.set_gap = panel_ssd1306_set_gap; ssd1306->base.mirror = panel_ssd1306_mirror; ssd1306->base.swap_xy = panel_ssd1306_swap_xy; ssd1306->base.disp_on_off = panel_ssd1306_disp_on_off; *ret_panel = &(ssd1306->base); ESP_LOGD(TAG, "new ssd1306 panel @%p", ssd1306); return ESP_OK; err: if (ssd1306) { if (panel_dev_config->reset_gpio_num >= 0) { gpio_reset_pin(panel_dev_config->reset_gpio_num); }{...} free(ssd1306); }{...} return ret; ESP_COMPILER_DIAGNOSTIC_POP("-Wanalyzer-malloc-leak") }{ ... } static esp_err_t panel_ssd1306_del(esp_lcd_panel_t *panel) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); if (ssd1306->reset_gpio_num >= 0) { gpio_reset_pin(ssd1306->reset_gpio_num); }{...} ESP_LOGD(TAG, "del ssd1306 panel @%p", ssd1306); free(ssd1306); return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_reset(esp_lcd_panel_t *panel) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); // perform hardware reset if (ssd1306->reset_gpio_num >= 0) { gpio_set_level(ssd1306->reset_gpio_num, ssd1306->reset_level); vTaskDelay(pdMS_TO_TICKS(10)); gpio_set_level(ssd1306->reset_gpio_num, !ssd1306->reset_level); vTaskDelay(pdMS_TO_TICKS(10)); }{...} return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_init(esp_lcd_panel_t *panel) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); esp_lcd_panel_io_handle_t io = ssd1306->io; ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_MULTIPLEX, (uint8_t[]) { ssd1306->height - 1 // set multiplex ratio }{...}, 1), TAG, "io tx param SSD1306_CMD_SET_MULTIPLEX failed"); ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_COMPINS, (uint8_t[1]) { ssd1306->height == 64 ? 0x12 : 0x02 // set COM pins hardware configuration }{...}, 1), TAG, "io tx param SSD1306_CMD_SET_COMPINS failed"); ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_DISP_OFF, NULL, 0), TAG, "io tx param SSD1306_CMD_DISP_OFF failed"); ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_MEMORY_ADDR_MODE, (uint8_t[]) { 0x00 // horizontal addressing mode }{...}, 1), TAG, "io tx param SSD1306_CMD_SET_MEMORY_ADDR_MODE failed"); ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_CHARGE_PUMP, (uint8_t[]) { 0x14 // enable charge pump }{...}, 1), TAG, "io tx param SSD1306_CMD_SET_CHARGE_PUMP failed"); ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_MIRROR_X_OFF, NULL, 0), TAG, "io tx param SSD1306_CMD_MIRROR_X_OFF failed"); ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_MIRROR_Y_OFF, NULL, 0), TAG, "io tx param SSD1306_CMD_MIRROR_Y_OFF failed"); return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_draw_bitmap(esp_lcd_panel_t *panel, int x_start, int y_start, int x_end, int y_end, const void *color_data) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); esp_lcd_panel_io_handle_t io = ssd1306->io; // adding extra gap x_start += ssd1306->x_gap; x_end += ssd1306->x_gap; y_start += ssd1306->y_gap; y_end += ssd1306->y_gap; if (ssd1306->swap_axes) { int x = x_start; x_start = y_start; y_start = x; x = x_end; x_end = y_end; y_end = x; }{...} // one page contains 8 rows (COMs) uint8_t page_start = y_start / 8; uint8_t page_end = (y_end - 1) / 8; // define an area of frame memory where MCU can access ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_COLUMN_RANGE, (uint8_t[]) { (x_start & 0x7F), ((x_end - 1) & 0x7F), }{...}, 2), TAG, "io tx param SSD1306_CMD_SET_COLUMN_RANGE failed"); ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_PAGE_RANGE, (uint8_t[]) { (page_start & 0x07), (page_end & 0x07), }{...}, 2), TAG, "io tx param SSD1306_CMD_SET_PAGE_RANGE failed"); // transfer frame buffer size_t len = (y_end - y_start) * (x_end - x_start) * ssd1306->bits_per_pixel / 8; ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_color(io, -1, color_data, len), TAG, "io tx color failed"); return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_invert_color(esp_lcd_panel_t *panel, bool invert_color_data) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); esp_lcd_panel_io_handle_t io = ssd1306->io; int command = 0; if (invert_color_data) { command = SSD1306_CMD_INVERT_ON; }{...} else { command = SSD1306_CMD_INVERT_OFF; }{...} ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, command, NULL, 0), TAG, "io tx param SSD1306_CMD_INVERT_ON/OFF failed"); return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_mirror(esp_lcd_panel_t *panel, bool mirror_x, bool mirror_y) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); esp_lcd_panel_io_handle_t io = ssd1306->io; int command = 0; if (mirror_x) { command = SSD1306_CMD_MIRROR_X_ON; }{...} else { command = SSD1306_CMD_MIRROR_X_OFF; }{...} ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, command, NULL, 0), TAG, "io tx param SSD1306_CMD_MIRROR_X_ON/OFF failed"); if (mirror_y) { command = SSD1306_CMD_MIRROR_Y_ON; }{...} else { command = SSD1306_CMD_MIRROR_Y_OFF; }{...} ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, command, NULL, 0), TAG, "io tx param SSD1306_CMD_MIRROR_Y_ON/OFF failed"); return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_swap_xy(esp_lcd_panel_t *panel, bool swap_axes) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); ssd1306->swap_axes = swap_axes; return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_set_gap(esp_lcd_panel_t *panel, int x_gap, int y_gap) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); ssd1306->x_gap = x_gap; ssd1306->y_gap = y_gap; return ESP_OK; }{ ... } static esp_err_t panel_ssd1306_disp_on_off(esp_lcd_panel_t *panel, bool on_off) { ssd1306_panel_t *ssd1306 = __containerof(panel, ssd1306_panel_t, base); esp_lcd_panel_io_handle_t io = ssd1306->io; int command = 0; if (on_off) { command = SSD1306_CMD_DISP_ON; }{...} else { command = SSD1306_CMD_DISP_OFF; }{...} ESP_RETURN_ON_ERROR(esp_lcd_panel_io_tx_param(io, command, NULL, 0), TAG, "io tx param SSD1306_CMD_DISP_ON/OFF failed"); // SEG/COM will be ON/OFF after 100ms after sending DISP_ON/OFF command vTaskDelay(pdMS_TO_TICKS(100)); return ESP_OK; }{ ... }
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.