Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
MIPI-DBI Driver Backend API

Data Structures

struct  mipi_dbi_config
 MIPI DBI controller configuration. More...
struct  mipi_dbi_driver_api
  Driver Operations MIPI-DBI driver operations More...

Typedefs

typedef int(* mipi_dbi_command_write_t) (const struct device *dev, const struct mipi_dbi_config *config, uint8_t cmd, const uint8_t *data, size_t len)
 Callback API to write a command to the display controller.
typedef int(* mipi_dbi_command_read_t) (const struct device *dev, const struct mipi_dbi_config *config, uint8_t *cmds, size_t num_cmds, uint8_t *response, size_t len)
 Callback API to read a command response from the display controller.
typedef int(* mipi_dbi_write_display_t) (const struct device *dev, const struct mipi_dbi_config *config, const uint8_t *framebuf, struct display_buffer_descriptor *desc, enum display_pixel_format pixfmt)
 Callback API to write a display buffer to the display controller.
typedef int(* mipi_dbi_reset_t) (const struct device *dev, k_timeout_t delay)
 Callback API to reset the attached display controller.
typedef int(* mipi_dbi_release_t) (const struct device *dev, const struct mipi_dbi_config *config)
 Callback API to release a locked MIPI DBI device.
typedef int(* mipi_dbi_configure_te_t) (const struct device *dev, uint8_t edge, k_timeout_t delay)
 Callback API to configure the MIPI DBI tearing effect signal.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a MIPI-DBI driver.

Typedef Documentation

◆ mipi_dbi_command_read_t

typedef int(* mipi_dbi_command_read_t) (const struct device *dev, const struct mipi_dbi_config *config, uint8_t *cmds, size_t num_cmds, uint8_t *response, size_t len)

#include <zephyr/drivers/mipi_dbi.h>

Callback API to read a command response from the display controller.

See mipi_dbi_command_read() for argument description

◆ mipi_dbi_command_write_t

typedef int(* mipi_dbi_command_write_t) (const struct device *dev, const struct mipi_dbi_config *config, uint8_t cmd, const uint8_t *data, size_t len)

#include <zephyr/drivers/mipi_dbi.h>

Callback API to write a command to the display controller.

See mipi_dbi_command_write() for argument description

◆ mipi_dbi_configure_te_t

typedef int(* mipi_dbi_configure_te_t) (const struct device *dev, uint8_t edge, k_timeout_t delay)

#include <zephyr/drivers/mipi_dbi.h>

Callback API to configure the MIPI DBI tearing effect signal.

See mipi_dbi_configure_te() for argument description

◆ mipi_dbi_release_t

typedef int(* mipi_dbi_release_t) (const struct device *dev, const struct mipi_dbi_config *config)

#include <zephyr/drivers/mipi_dbi.h>

Callback API to release a locked MIPI DBI device.

See mipi_dbi_release() for argument description

◆ mipi_dbi_reset_t

typedef int(* mipi_dbi_reset_t) (const struct device *dev, k_timeout_t delay)

#include <zephyr/drivers/mipi_dbi.h>

Callback API to reset the attached display controller.

See mipi_dbi_reset() for argument description

◆ mipi_dbi_write_display_t

typedef int(* mipi_dbi_write_display_t) (const struct device *dev, const struct mipi_dbi_config *config, const uint8_t *framebuf, struct display_buffer_descriptor *desc, enum display_pixel_format pixfmt)

#include <zephyr/drivers/mipi_dbi.h>

Callback API to write a display buffer to the display controller.

See mipi_dbi_write_display() for argument description