mipi_dbi.h File Reference

Main header file for MIPI-DBI (Display Bus Interface) driver API. More...

#include <zephyr/device.h>
#include <zephyr/drivers/display.h>
#include <zephyr/display/mipi_display.h>
#include <zephyr/drivers/spi.h>
#include <zephyr/dt-bindings/mipi_dbi/mipi_dbi.h>

Go to the source code of this file.

Data Structures
struct	mipi_dbi_config
	MIPI DBI controller configuration. More...
struct	mipi_dbi_driver_api
	MIPI-DBI host driver API. More...

Macros
#define	MIPI_DBI_SPI_CONFIG_DT(node_id, operation_, delay_)
	initialize a MIPI DBI SPI configuration struct from devicetree
#define	MIPI_DBI_SPI_CONFIG_DT_INST(inst, operation_, delay_)
	Initialize a MIPI DBI SPI configuration from devicetree instance.
#define	MIPI_DBI_CONFIG_DT(node_id, operation_, delay_)
	Initialize a MIPI DBI configuration from devicetree.
#define	MIPI_DBI_CONFIG_DT_INST(inst, operation_, delay_)
	Initialize a MIPI DBI configuration from device instance.
#define	MIPI_DBI_TE_MODE_DT(node_id, edge_prop)
	Get the MIPI DBI TE mode from devicetree.
#define	MIPI_DBI_TE_MODE_DT_INST(inst, edge_prop)
	Get the MIPI DBI TE mode for device instance.

Functions
static int	mipi_dbi_command_write (const struct device *dev, const struct mipi_dbi_config *config, uint8_t cmd, const uint8_t *data, size_t len)
	Write a command to the display controller.
static int	mipi_dbi_command_read (const struct device *dev, const struct mipi_dbi_config *config, uint8_t *cmds, size_t num_cmd, uint8_t *response, size_t len)
	Read a command response from the display controller.
static int	mipi_dbi_write_display (const struct device *dev, const struct mipi_dbi_config *config, const uint8_t *framebuf, struct display_buffer_descriptor *desc, enum display_pixel_format pixfmt)
	Write a display buffer to the display controller.
static int	mipi_dbi_reset (const struct device *dev, uint32_t delay_ms)
	Resets attached display controller.
static int	mipi_dbi_release (const struct device *dev, const struct mipi_dbi_config *config)
	Releases a locked MIPI DBI device.
static int	mipi_dbi_configure_te (const struct device *dev, uint8_t edge, uint32_t delay_us)
	Configures MIPI DBI tearing effect signal.

Detailed Description

Main header file for MIPI-DBI (Display Bus Interface) driver API.

MIPI-DBI defines the following 3 interfaces:

• Type A: Motorola 6800 type parallel bus
• Type B: Intel 8080 type parallel bus
• Type C: SPI Type (1 bit bus) with 3 options:
  1. 9 write clocks per byte, final bit is command/data selection bit
  2. Same as above, but 16 write clocks per byte
  3. 8 write clocks per byte. Command/data selected via GPIO pin The current driver interface does not support type C with 16 write clocks (option 2).