zephyr/drivers/display/display_st7789v.c

/*
 * Copyright (c) 2017 Jan Van Winkel <jan.van_winkel@dxplore.eu>
 * 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 <zephyr/device.h>
#include <zephyr/drivers/mipi_dbi.h>
#include <zephyr/pm/device.h>
#include <zephyr/sys/byteorder.h>
#include <zephyr/drivers/display.h>

#define LOG_LEVEL CONFIG_DISPLAY_LOG_LEVEL
#include <zephyr/logging/log.h>
LOG_MODULE_REGISTER(display_st7789v);

struct st7789v_config {
	const struct device *mipi_dbi;
	const struct mipi_dbi_config dbi_config;
	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;
	bool inversion_on;
	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;
	uint8_t ready_time_ms;
};

struct st7789v_data {
	uint16_t x_offset;
	uint16_t y_offset;
};

#ifdef CONFIG_ST7789V_RGB888
#define ST7789V_PIXEL_SIZE 3u
#else
#define ST7789V_PIXEL_SIZE 2u
#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 int st7789v_transmit(const struct device *dev, uint8_t cmd,
			    uint8_t *tx_data, size_t tx_count)
{
	const struct st7789v_config *config = dev->config;

	return mipi_dbi_command_write(config->mipi_dbi, &config->dbi_config,
				      cmd, tx_data, tx_count);
}

static int st7789v_exit_sleep(const struct device *dev)
{
	int ret;

	ret = st7789v_transmit(dev, ST7789V_CMD_SLEEP_OUT, NULL, 0);
	if (ret < 0) {
		return ret;
	}

	k_sleep(K_MSEC(120));
	return ret;
}

static int st7789v_reset_display(const struct device *dev)
{
	const struct st7789v_config *config = dev->config;
	int ret;

	LOG_DBG("Resetting display");

	k_sleep(K_MSEC(1));
	ret = mipi_dbi_reset(config->mipi_dbi, 6);
	if (ret == -ENOTSUP) {
		/* Send software reset command */
		ret = st7789v_transmit(dev, ST7789V_CMD_SW_RESET, NULL, 0);
		if (ret < 0) {
			return ret;
		}
		k_sleep(K_MSEC(5));
	} else {
		k_sleep(K_MSEC(20));
	}

	return ret;
}

static int st7789v_blanking_on(const struct device *dev)
{
	return st7789v_transmit(dev, ST7789V_CMD_DISP_OFF, NULL, 0);
}

static int st7789v_blanking_off(const struct device *dev)
{
	return st7789v_transmit(dev, ST7789V_CMD_DISP_ON, NULL, 0);
}

static int 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;

	int ret;

	spi_data[0] = sys_cpu_to_be16(ram_x);
	spi_data[1] = sys_cpu_to_be16(ram_x + w - 1);
	ret = st7789v_transmit(dev, ST7789V_CMD_CASET, (uint8_t *)&spi_data[0], 4);
	if (ret < 0) {
		return ret;
	}

	spi_data[0] = sys_cpu_to_be16(ram_y);
	spi_data[1] = sys_cpu_to_be16(ram_y + h - 1);
	return 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 struct st7789v_config *config = dev->config;
	struct display_buffer_descriptor mipi_desc;
	const uint8_t *write_data_start = (uint8_t *) buf;
	uint16_t nbr_of_writes;
	uint16_t write_h;
	enum display_pixel_format pixfmt;
	int ret;

	__ASSERT(desc->width <= desc->pitch, "Pitch is smaller than width");
	__ASSERT((desc->pitch * ST7789V_PIXEL_SIZE * desc->height) <= desc->buf_size,
			"Input buffer too small");

	LOG_DBG("Writing %dx%d (w,h) @ %dx%d (x,y)",
		desc->width, desc->height, x, y);
	ret = st7789v_set_mem_area(dev, x, y, desc->width, desc->height);
	if (ret < 0) {
		return ret;
	}

	if (desc->pitch > desc->width) {
		write_h = 1U;
		nbr_of_writes = desc->height;
		mipi_desc.height = 1;
		mipi_desc.buf_size = desc->pitch * ST7789V_PIXEL_SIZE;
	} else {
		write_h = desc->height;
		nbr_of_writes = 1U;
		mipi_desc.height = desc->height;
		mipi_desc.buf_size = desc->width * write_h * ST7789V_PIXEL_SIZE;
	}
	if (IS_ENABLED(CONFIG_ST7789V_RGB565)) {
		pixfmt = PIXEL_FORMAT_RGB_565;
	} else if (IS_ENABLED(CONFIG_ST7789V_BGR565)) {
		pixfmt = PIXEL_FORMAT_BGR_565;
	} else {
		pixfmt = PIXEL_FORMAT_RGB_888;
	}

	mipi_desc.width = desc->width;
	/* Per MIPI API, pitch must always match width */
	mipi_desc.pitch = desc->width;

	/* Send RAMWR command */
	ret = st7789v_transmit(dev, ST7789V_CMD_RAMWR, NULL, 0);
	if (ret < 0) {
		return ret;
	}

	for (uint16_t write_cnt = 0U; write_cnt < nbr_of_writes; ++write_cnt) {
		ret = mipi_dbi_write_display(config->mipi_dbi, &config->dbi_config,
					     write_data_start, &mipi_desc, pixfmt);
		if (ret < 0) {
			return ret;
		}

		write_data_start += (desc->pitch * ST7789V_PIXEL_SIZE);
	}

	return ret;
}

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;
#elif CONFIG_ST7789V_BGR565
	capabilities->supported_pixel_formats = PIXEL_FORMAT_BGR_565;
	capabilities->current_pixel_format = PIXEL_FORMAT_BGR_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) {
#elif CONFIG_ST7789V_BGR565
	if (pixel_format == PIXEL_FORMAT_BGR_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 int st7789v_lcd_init(const struct device *dev)
{
	struct st7789v_data *data = dev->data;
	const struct st7789v_config *config = dev->config;
	uint8_t tmp;
	int ret;

	st7789v_set_lcd_margins(dev, data->x_offset,
				data->y_offset);

	ret = st7789v_transmit(dev, ST7789V_CMD_CMD2EN,
			       (uint8_t *)config->cmd2en_param,
			       sizeof(config->cmd2en_param));
	if (ret < 0) {
		return ret;
	}

	ret = st7789v_transmit(dev, ST7789V_CMD_PORCTRL,
			       (uint8_t *)config->porch_param,
			       sizeof(config->porch_param));
	if (ret < 0) {
		return ret;
	}

	/* Digital Gamma Enable, default disabled */
	tmp = 0x00;
	ret = st7789v_transmit(dev, ST7789V_CMD_DGMEN, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	/* Frame Rate Control in Normal Mode, default value */
	tmp = 0x0f;
	ret = st7789v_transmit(dev, ST7789V_CMD_FRCTRL2, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	tmp = config->gctrl;
	ret = st7789v_transmit(dev, ST7789V_CMD_GCTRL, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	tmp = config->vcom;
	ret = st7789v_transmit(dev, ST7789V_CMD_VCOMS, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	if (config->vdv_vrh_enable) {
		tmp = 0x01;
		ret = st7789v_transmit(dev, ST7789V_CMD_VDVVRHEN, &tmp, 1);
		if (ret < 0) {
			return ret;
		}

		tmp = config->vrh_value;
		ret = st7789v_transmit(dev, ST7789V_CMD_VRH, &tmp, 1);
		if (ret < 0) {
			return ret;
		}

		tmp = config->vdv_value;
		ret = st7789v_transmit(dev, ST7789V_CMD_VDS, &tmp, 1);
		if (ret < 0) {
			return ret;
		}
	}

	ret = st7789v_transmit(dev, ST7789V_CMD_PWCTRL1,
			       (uint8_t *)config->pwctrl1_param,
			       sizeof(config->pwctrl1_param));
	if (ret < 0) {
		return ret;
	}

	/* Memory Data Access Control */
	tmp = config->mdac;
	ret = st7789v_transmit(dev, ST7789V_CMD_MADCTL, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	/* Interface Pixel Format */
	tmp = config->colmod;
	ret = st7789v_transmit(dev, ST7789V_CMD_COLMOD, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	tmp = config->lcm;
	ret = st7789v_transmit(dev, ST7789V_CMD_LCMCTRL, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	tmp = config->gamma;
	ret = st7789v_transmit(dev, ST7789V_CMD_GAMSET, &tmp, 1);
	if (ret < 0) {
		return ret;
	}

	if (config->inversion_on) {
		ret = st7789v_transmit(dev, ST7789V_CMD_INV_ON, NULL, 0);
	} else {
		ret = st7789v_transmit(dev, ST7789V_CMD_INV_OFF, NULL, 0);
	}
	if (ret < 0) {
		return ret;
	}

	ret = st7789v_transmit(dev, ST7789V_CMD_PVGAMCTRL,
			       (uint8_t *)config->pvgam_param,
			       sizeof(config->pvgam_param));
	if (ret < 0) {
		return ret;
	}

	ret = st7789v_transmit(dev, ST7789V_CMD_NVGAMCTRL,
			       (uint8_t *)config->nvgam_param,
			       sizeof(config->nvgam_param));
	if (ret < 0) {
		return ret;
	}

	ret = st7789v_transmit(dev, ST7789V_CMD_RAMCTRL,
			       (uint8_t *)config->ram_param,
			       sizeof(config->ram_param));
	if (ret < 0) {
		return ret;
	}

	ret = st7789v_transmit(dev, ST7789V_CMD_RGBCTRL,
			       (uint8_t *)config->rgb_param,
			       sizeof(config->rgb_param));
	return ret;
}

static int st7789v_init(const struct device *dev)
{
	const struct st7789v_config *config = dev->config;
	int ret;

	if (!device_is_ready(config->mipi_dbi)) {
		LOG_ERR("MIPI DBI device not ready");
		return -ENODEV;
	}

	k_sleep(K_TIMEOUT_ABS_MS(config->ready_time_ms));

	ret = st7789v_reset_display(dev);
	if (ret < 0) {
		LOG_ERR("Failed to reset display (%d)", ret);
		return ret;
	}

	ret = st7789v_blanking_on(dev);
	if (ret < 0) {
		LOG_ERR("Failed to turn blanking on (%d)", ret);
		return ret;
	}

	ret = st7789v_lcd_init(dev);
	if (ret < 0) {
		LOG_ERR("Failed to init display (%d)", ret);
		return ret;
	}

	ret = st7789v_exit_sleep(dev);
	if (ret < 0) {
		LOG_ERR("Failed to exit the sleep mode (%d)", ret);
		return ret;
	}

	return ret;
}

#ifdef CONFIG_PM_DEVICE
static int st7789v_pm_action(const struct device *dev,
			     enum pm_device_action action)
{
	int ret;

	switch (action) {
	case PM_DEVICE_ACTION_RESUME:
		ret = st7789v_exit_sleep(dev);
		break;
	case PM_DEVICE_ACTION_SUSPEND:
		ret = st7789v_transmit(dev, ST7789V_CMD_SLEEP_IN, NULL, 0);
		break;
	default:
		ret = -ENOTSUP;
		break;
	}

	return ret;
}
#endif /* CONFIG_PM_DEVICE */

static DEVICE_API(display, st7789v_api) = {
	.blanking_on = st7789v_blanking_on,
	.blanking_off = st7789v_blanking_off,
	.write = st7789v_write,
	.get_capabilities = st7789v_get_capabilities,
	.set_pixel_format = st7789v_set_pixel_format,
	.set_orientation = st7789v_set_orientation,
};

#define ST7789V_WORD_SIZE(inst)								\
	((DT_INST_STRING_UPPER_TOKEN(inst, mipi_mode) == MIPI_DBI_MODE_SPI_4WIRE) ?     \
	SPI_WORD_SET(8) : SPI_WORD_SET(9))
#define ST7789V_INIT(inst)								\
	static const struct st7789v_config st7789v_config_ ## inst = {			\
		.mipi_dbi = DEVICE_DT_GET(DT_INST_PARENT(inst)),                        \
		.dbi_config = MIPI_DBI_CONFIG_DT_INST(inst,                             \
						      ST7789V_WORD_SIZE(inst) |         \
						      SPI_OP_MODE_MASTER, 0),           \
		.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),						\
		.inversion_on = !DT_INST_PROP(inst, inversion_off),			\
		.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),					\
		.ready_time_ms = DT_INST_PROP(inst, ready_time_ms),			\
	};										\
											\
	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)