/* * Copyright (c) 2017 Jan Van Winkel * Copyright (c) 2019 Nordic Semiconductor ASA * Copyright (c) 2019 Marc Reilly * Copyright (c) 2019 PHYTEC Messtechnik GmbH * Copyright (c) 2020 Endian Technologies AB * Copyright (c) 2022 Basalte bv * * SPDX-License-Identifier: Apache-2.0 */ #define DT_DRV_COMPAT sitronix_st7789v #include "display_st7789v.h" #include #include #include #include #include #include #define LOG_LEVEL CONFIG_DISPLAY_LOG_LEVEL #include LOG_MODULE_REGISTER(display_st7789v); struct st7789v_config { struct spi_dt_spec bus; struct gpio_dt_spec cmd_data_gpio; struct gpio_dt_spec reset_gpio; uint8_t vcom; uint8_t gctrl; bool vdv_vrh_enable; uint8_t vrh_value; uint8_t vdv_value; uint8_t mdac; uint8_t gamma; uint8_t colmod; uint8_t lcm; uint8_t porch_param[5]; uint8_t cmd2en_param[4]; uint8_t pwctrl1_param[2]; uint8_t pvgam_param[14]; uint8_t nvgam_param[14]; uint8_t ram_param[2]; uint8_t rgb_param[3]; uint16_t height; uint16_t width; }; struct st7789v_data { uint16_t x_offset; uint16_t y_offset; }; #ifdef CONFIG_ST7789V_RGB565 #define ST7789V_PIXEL_SIZE 2u #else #define ST7789V_PIXEL_SIZE 3u #endif static void st7789v_set_lcd_margins(const struct device *dev, uint16_t x_offset, uint16_t y_offset) { struct st7789v_data *data = dev->data; data->x_offset = x_offset; data->y_offset = y_offset; } static void st7789v_transmit(const struct device *dev, uint8_t cmd, uint8_t *tx_data, size_t tx_count) { const struct st7789v_config *config = dev->config; uint16_t data = cmd; struct spi_buf tx_buf = { .buf = &cmd, .len = 1 }; struct spi_buf_set tx_bufs = { .buffers = &tx_buf, .count = 1 }; if (config->cmd_data_gpio.port != NULL) { if (cmd != ST7789V_CMD_NONE) { gpio_pin_set_dt(&config->cmd_data_gpio, 1); spi_write_dt(&config->bus, &tx_bufs); } if (tx_data != NULL) { tx_buf.buf = tx_data; tx_buf.len = tx_count; gpio_pin_set_dt(&config->cmd_data_gpio, 0); spi_write_dt(&config->bus, &tx_bufs); } } else { tx_buf.buf = &data; tx_buf.len = 2; if (cmd != ST7789V_CMD_NONE) { spi_write_dt(&config->bus, &tx_bufs); } if (tx_data != NULL) { for (size_t index = 0; index < tx_count; ++index) { data = 0x0100 | tx_data[index]; spi_write_dt(&config->bus, &tx_bufs); } } } } static void st7789v_exit_sleep(const struct device *dev) { st7789v_transmit(dev, ST7789V_CMD_SLEEP_OUT, NULL, 0); k_sleep(K_MSEC(120)); } static void st7789v_reset_display(const struct device *dev) { LOG_DBG("Resetting display"); const struct st7789v_config *config = dev->config; if (config->reset_gpio.port != NULL) { k_sleep(K_MSEC(1)); gpio_pin_set_dt(&config->reset_gpio, 1); k_sleep(K_MSEC(6)); gpio_pin_set_dt(&config->reset_gpio, 0); k_sleep(K_MSEC(20)); } else { st7789v_transmit(dev, ST7789V_CMD_SW_RESET, NULL, 0); k_sleep(K_MSEC(5)); } } static int st7789v_blanking_on(const struct device *dev) { st7789v_transmit(dev, ST7789V_CMD_DISP_OFF, NULL, 0); return 0; } static int st7789v_blanking_off(const struct device *dev) { st7789v_transmit(dev, ST7789V_CMD_DISP_ON, NULL, 0); return 0; } static int st7789v_read(const struct device *dev, const uint16_t x, const uint16_t y, const struct display_buffer_descriptor *desc, void *buf) { return -ENOTSUP; } static void st7789v_set_mem_area(const struct device *dev, const uint16_t x, const uint16_t y, const uint16_t w, const uint16_t h) { struct st7789v_data *data = dev->data; uint16_t spi_data[2]; uint16_t ram_x = x + data->x_offset; uint16_t ram_y = y + data->y_offset; spi_data[0] = sys_cpu_to_be16(ram_x); spi_data[1] = sys_cpu_to_be16(ram_x + w - 1); st7789v_transmit(dev, ST7789V_CMD_CASET, (uint8_t *)&spi_data[0], 4); spi_data[0] = sys_cpu_to_be16(ram_y); spi_data[1] = sys_cpu_to_be16(ram_y + h - 1); st7789v_transmit(dev, ST7789V_CMD_RASET, (uint8_t *)&spi_data[0], 4); } static int st7789v_write(const struct device *dev, const uint16_t x, const uint16_t y, const struct display_buffer_descriptor *desc, const void *buf) { const uint8_t *write_data_start = (uint8_t *) buf; uint16_t nbr_of_writes; uint16_t write_h; __ASSERT(desc->width <= desc->pitch, "Pitch is smaller then width"); __ASSERT((desc->pitch * ST7789V_PIXEL_SIZE * desc->height) <= desc->buf_size, "Input buffer to small"); LOG_DBG("Writing %dx%d (w,h) @ %dx%d (x,y)", desc->width, desc->height, x, y); st7789v_set_mem_area(dev, x, y, desc->width, desc->height); if (desc->pitch > desc->width) { write_h = 1U; nbr_of_writes = desc->height; } else { write_h = desc->height; nbr_of_writes = 1U; } for (uint16_t write_cnt = 0U; write_cnt < nbr_of_writes; ++write_cnt) { st7789v_transmit(dev, write_cnt == 0U ? ST7789V_CMD_RAMWR : ST7789V_CMD_NONE, (void *) write_data_start, desc->width * ST7789V_PIXEL_SIZE * write_h); write_data_start += (desc->pitch * ST7789V_PIXEL_SIZE); } return 0; } static void *st7789v_get_framebuffer(const struct device *dev) { return NULL; } static int st7789v_set_brightness(const struct device *dev, const uint8_t brightness) { return -ENOTSUP; } static int st7789v_set_contrast(const struct device *dev, const uint8_t contrast) { return -ENOTSUP; } static void st7789v_get_capabilities(const struct device *dev, struct display_capabilities *capabilities) { const struct st7789v_config *config = dev->config; memset(capabilities, 0, sizeof(struct display_capabilities)); capabilities->x_resolution = config->width; capabilities->y_resolution = config->height; #ifdef CONFIG_ST7789V_RGB565 capabilities->supported_pixel_formats = PIXEL_FORMAT_RGB_565; capabilities->current_pixel_format = PIXEL_FORMAT_RGB_565; #else capabilities->supported_pixel_formats = PIXEL_FORMAT_RGB_888; capabilities->current_pixel_format = PIXEL_FORMAT_RGB_888; #endif capabilities->current_orientation = DISPLAY_ORIENTATION_NORMAL; } static int st7789v_set_pixel_format(const struct device *dev, const enum display_pixel_format pixel_format) { #ifdef CONFIG_ST7789V_RGB565 if (pixel_format == PIXEL_FORMAT_RGB_565) { #else if (pixel_format == PIXEL_FORMAT_RGB_888) { #endif return 0; } LOG_ERR("Pixel format change not implemented"); return -ENOTSUP; } static int st7789v_set_orientation(const struct device *dev, const enum display_orientation orientation) { if (orientation == DISPLAY_ORIENTATION_NORMAL) { return 0; } LOG_ERR("Changing display orientation not implemented"); return -ENOTSUP; } static void st7789v_lcd_init(const struct device *dev) { struct st7789v_data *data = dev->data; const struct st7789v_config *config = dev->config; uint8_t tmp; st7789v_set_lcd_margins(dev, data->x_offset, data->y_offset); st7789v_transmit(dev, ST7789V_CMD_CMD2EN, (uint8_t *)config->cmd2en_param, sizeof(config->cmd2en_param)); st7789v_transmit(dev, ST7789V_CMD_PORCTRL, (uint8_t *)config->porch_param, sizeof(config->porch_param)); /* Digital Gamma Enable, default disabled */ tmp = 0x00; st7789v_transmit(dev, ST7789V_CMD_DGMEN, &tmp, 1); /* Frame Rate Control in Normal Mode, default value */ tmp = 0x0f; st7789v_transmit(dev, ST7789V_CMD_FRCTRL2, &tmp, 1); tmp = config->gctrl; st7789v_transmit(dev, ST7789V_CMD_GCTRL, &tmp, 1); tmp = config->vcom; st7789v_transmit(dev, ST7789V_CMD_VCOMS, &tmp, 1); if (config->vdv_vrh_enable) { tmp = 0x01; st7789v_transmit(dev, ST7789V_CMD_VDVVRHEN, &tmp, 1); tmp = config->vrh_value; st7789v_transmit(dev, ST7789V_CMD_VRH, &tmp, 1); tmp = config->vdv_value; st7789v_transmit(dev, ST7789V_CMD_VDS, &tmp, 1); } st7789v_transmit(dev, ST7789V_CMD_PWCTRL1, (uint8_t *)config->pwctrl1_param, sizeof(config->pwctrl1_param)); /* Memory Data Access Control */ tmp = config->mdac; st7789v_transmit(dev, ST7789V_CMD_MADCTL, &tmp, 1); /* Interface Pixel Format */ tmp = config->colmod; st7789v_transmit(dev, ST7789V_CMD_COLMOD, &tmp, 1); tmp = config->lcm; st7789v_transmit(dev, ST7789V_CMD_LCMCTRL, &tmp, 1); tmp = config->gamma; st7789v_transmit(dev, ST7789V_CMD_GAMSET, &tmp, 1); st7789v_transmit(dev, ST7789V_CMD_INV_ON, NULL, 0); st7789v_transmit(dev, ST7789V_CMD_PVGAMCTRL, (uint8_t *)config->pvgam_param, sizeof(config->pvgam_param)); st7789v_transmit(dev, ST7789V_CMD_NVGAMCTRL, (uint8_t *)config->nvgam_param, sizeof(config->nvgam_param)); st7789v_transmit(dev, ST7789V_CMD_RAMCTRL, (uint8_t *)config->ram_param, sizeof(config->ram_param)); st7789v_transmit(dev, ST7789V_CMD_RGBCTRL, (uint8_t *)config->rgb_param, sizeof(config->rgb_param)); } static int st7789v_init(const struct device *dev) { const struct st7789v_config *config = dev->config; if (!spi_is_ready_dt(&config->bus)) { LOG_ERR("SPI device not ready"); return -ENODEV; } if (config->reset_gpio.port != NULL) { if (!gpio_is_ready_dt(&config->reset_gpio)) { LOG_ERR("Reset GPIO device not ready"); return -ENODEV; } if (gpio_pin_configure_dt(&config->reset_gpio, GPIO_OUTPUT_INACTIVE)) { LOG_ERR("Couldn't configure reset pin"); return -EIO; } } if (config->cmd_data_gpio.port != NULL) { if (!gpio_is_ready_dt(&config->cmd_data_gpio)) { LOG_ERR("CMD/DATA GPIO device not ready"); return -ENODEV; } if (gpio_pin_configure_dt(&config->cmd_data_gpio, GPIO_OUTPUT)) { LOG_ERR("Couldn't configure CMD/DATA pin"); return -EIO; } } st7789v_reset_display(dev); st7789v_blanking_on(dev); st7789v_lcd_init(dev); st7789v_exit_sleep(dev); return 0; } #ifdef CONFIG_PM_DEVICE static int st7789v_pm_action(const struct device *dev, enum pm_device_action action) { int ret = 0; switch (action) { case PM_DEVICE_ACTION_RESUME: st7789v_exit_sleep(dev); break; case PM_DEVICE_ACTION_SUSPEND: st7789v_transmit(dev, ST7789V_CMD_SLEEP_IN, NULL, 0); break; default: ret = -ENOTSUP; break; } return ret; } #endif /* CONFIG_PM_DEVICE */ static const struct display_driver_api st7789v_api = { .blanking_on = st7789v_blanking_on, .blanking_off = st7789v_blanking_off, .write = st7789v_write, .read = st7789v_read, .get_framebuffer = st7789v_get_framebuffer, .set_brightness = st7789v_set_brightness, .set_contrast = st7789v_set_contrast, .get_capabilities = st7789v_get_capabilities, .set_pixel_format = st7789v_set_pixel_format, .set_orientation = st7789v_set_orientation, }; #define ST7789V_WORD_SIZE(inst) \ COND_CODE_1(DT_INST_NODE_HAS_PROP(inst, cmd_data_gpios), (8), (9)) #define ST7789V_INIT(inst) \ static const struct st7789v_config st7789v_config_ ## inst = { \ .bus = SPI_DT_SPEC_INST_GET(inst, SPI_OP_MODE_MASTER | \ SPI_WORD_SET(ST7789V_WORD_SIZE(inst)), 0), \ .cmd_data_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, cmd_data_gpios, {}), \ .reset_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, reset_gpios, {}), \ .vcom = DT_INST_PROP(inst, vcom), \ .gctrl = DT_INST_PROP(inst, gctrl), \ .vdv_vrh_enable = (DT_INST_NODE_HAS_PROP(inst, vrhs) \ && DT_INST_NODE_HAS_PROP(inst, vdvs)), \ .vrh_value = DT_INST_PROP_OR(inst, vrhs, 0), \ .vdv_value = DT_INST_PROP_OR(inst, vdvs, 0), \ .mdac = DT_INST_PROP(inst, mdac), \ .gamma = DT_INST_PROP(inst, gamma), \ .colmod = DT_INST_PROP(inst, colmod), \ .lcm = DT_INST_PROP(inst, lcm), \ .porch_param = DT_INST_PROP(inst, porch_param), \ .cmd2en_param = DT_INST_PROP(inst, cmd2en_param), \ .pwctrl1_param = DT_INST_PROP(inst, pwctrl1_param), \ .pvgam_param = DT_INST_PROP(inst, pvgam_param), \ .nvgam_param = DT_INST_PROP(inst, nvgam_param), \ .ram_param = DT_INST_PROP(inst, ram_param), \ .rgb_param = DT_INST_PROP(inst, rgb_param), \ .width = DT_INST_PROP(inst, width), \ .height = DT_INST_PROP(inst, height), \ }; \ \ static struct st7789v_data st7789v_data_ ## inst = { \ .x_offset = DT_INST_PROP(inst, x_offset), \ .y_offset = DT_INST_PROP(inst, y_offset), \ }; \ \ PM_DEVICE_DT_INST_DEFINE(inst, st7789v_pm_action); \ \ DEVICE_DT_INST_DEFINE(inst, &st7789v_init, PM_DEVICE_DT_INST_GET(inst), \ &st7789v_data_ ## inst, &st7789v_config_ ## inst, \ POST_KERNEL, CONFIG_DISPLAY_INIT_PRIORITY, \ &st7789v_api); DT_INST_FOREACH_STATUS_OKAY(ST7789V_INIT)