/* * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include #include #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_vendor.h" #include "esp_lcd_panel_ops.h" #include "driver/gpio.h" #include "esp_log.h" #include "esp_check.h" 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_DISP_OFF 0xAE #define SSD1306_CMD_DISP_ON 0xAF #define SSD1306_CMD_MIRROR_Y_OFF 0xC0 #define SSD1306_CMD_MIRROR_Y_ON 0xC8 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; int reset_gpio_num; bool reset_level; int x_gap; int y_gap; unsigned int bits_per_pixel; 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"); 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->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; } 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_lcd_panel_io_tx_param(io, SSD1306_CMD_DISP_OFF, NULL, 0); esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_MEMORY_ADDR_MODE, (uint8_t[]) { 0x00 // horizontal addressing mode }, 1); esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_CHARGE_PUMP, (uint8_t[]) { 0x14 // enable charge pump }, 1); esp_lcd_panel_io_tx_param(io, SSD1306_CMD_MIRROR_X_OFF, NULL, 0); esp_lcd_panel_io_tx_param(io, SSD1306_CMD_MIRROR_Y_OFF, NULL, 0); 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); assert((x_start < x_end) && (y_start < y_end) && "start position must be smaller than end position"); 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_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_COLUMN_RANGE, (uint8_t[]) { (x_start & 0x7F), ((x_end - 1) & 0x7F), }, 2); esp_lcd_panel_io_tx_param(io, SSD1306_CMD_SET_PAGE_RANGE, (uint8_t[]) { (page_start & 0x07), (page_end & 0x07), }, 2); // transfer frame buffer size_t len = (y_end - y_start) * (x_end - x_start) * ssd1306->bits_per_pixel / 8; esp_lcd_panel_io_tx_color(io, -1, color_data, len); 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_lcd_panel_io_tx_param(io, command, NULL, 0); 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_lcd_panel_io_tx_param(io, command, NULL, 0); if (mirror_y) { command = SSD1306_CMD_MIRROR_Y_ON; } else { command = SSD1306_CMD_MIRROR_Y_OFF; } esp_lcd_panel_io_tx_param(io, command, NULL, 0); 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_lcd_panel_io_tx_param(io, command, NULL, 0); // SEG/COM will be ON/OFF after 100ms after sending DISP_ON/OFF command vTaskDelay(pdMS_TO_TICKS(100)); return ESP_OK; }