| 
    Zephyr Project API
    3.3.0
    
   A Scalable Open Source RTOS 
   | 
 
MIPI-DSI driver APIs. More...
Data Structures | |
| struct | mipi_dsi_timings | 
| struct | mipi_dsi_device | 
| struct | mipi_dsi_msg | 
| struct | mipi_dsi_driver_api | 
Functions | |
| static int | mipi_dsi_attach (const struct device *dev, uint8_t channel, const struct mipi_dsi_device *mdev) | 
| Attach a new device to the MIPI-DSI bus.  More... | |
| static ssize_t | mipi_dsi_transfer (const struct device *dev, uint8_t channel, struct mipi_dsi_msg *msg) | 
| Transfer data to/from a device attached to the MIPI-DSI bus.  More... | |
| ssize_t | mipi_dsi_generic_read (const struct device *dev, uint8_t channel, const void *params, size_t nparams, void *buf, size_t len) | 
| MIPI-DSI generic read.  More... | |
| ssize_t | mipi_dsi_generic_write (const struct device *dev, uint8_t channel, const void *buf, size_t len) | 
| MIPI-DSI generic write.  More... | |
| ssize_t | mipi_dsi_dcs_read (const struct device *dev, uint8_t channel, uint8_t cmd, void *buf, size_t len) | 
| MIPI-DSI DCS read.  More... | |
| ssize_t | mipi_dsi_dcs_write (const struct device *dev, uint8_t channel, uint8_t cmd, const void *buf, size_t len) | 
| MIPI-DSI DCS write.  More... | |
MIPI-DSI Address mode register fields. | |
| #define | MIPI_DCS_ADDRESS_MODE_MIRROR_Y BIT(7) | 
| #define | MIPI_DCS_ADDRESS_MODE_MIRROR_X BIT(6) | 
| #define | MIPI_DCS_ADDRESS_MODE_SWAP_XY BIT(5) | 
| #define | MIPI_DCS_ADDRESS_MODE_REFRESH_BT BIT(4) | 
| #define | MIPI_DCS_ADDRESS_MODE_BGR BIT(3) | 
| #define | MIPI_DCS_ADDRESS_MODE_LATCH_RL BIT(2) | 
| #define | MIPI_DCS_ADDRESS_MODE_FLIP_X BIT(1) | 
| #define | MIPI_DCS_ADDRESS_MODE_FLIP_Y BIT(0) | 
MIPI-DSI Device mode flags. | |
| #define | MIPI_DSI_MODE_VIDEO BIT(0) | 
| #define | MIPI_DSI_MODE_VIDEO_BURST BIT(1) | 
| #define | MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2) | 
| #define | MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3) | 
| #define | MIPI_DSI_MODE_VIDEO_HSE BIT(4) | 
| #define | MIPI_DSI_MODE_VIDEO_HFP BIT(5) | 
| #define | MIPI_DSI_MODE_VIDEO_HBP BIT(6) | 
| #define | MIPI_DSI_MODE_VIDEO_HSA BIT(7) | 
| #define | MIPI_DSI_MODE_VSYNC_FLUSH BIT(8) | 
| #define | MIPI_DSI_MODE_EOT_PACKET BIT(9) | 
| #define | MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10) | 
| #define | MIPI_DSI_MODE_LPM BIT(11) | 
MIPI-DSI Pixel formats. | |
| #define | MIPI_DSI_PIXFMT_RGB888 0U | 
| #define | MIPI_DSI_PIXFMT_RGB666 1U | 
| #define | MIPI_DSI_PIXFMT_RGB666_PACKED 2U | 
| #define | MIPI_DSI_PIXFMT_RGB565 3U | 
MIPI-DSI driver APIs.
| #define MIPI_DCS_ADDRESS_MODE_BGR BIT(3) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ADDRESS_MODE_FLIP_X BIT(1) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ADDRESS_MODE_FLIP_Y BIT(0) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ADDRESS_MODE_LATCH_RL BIT(2) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ADDRESS_MODE_MIRROR_X BIT(6) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ADDRESS_MODE_MIRROR_Y BIT(7) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ADDRESS_MODE_REFRESH_BT BIT(4) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ADDRESS_MODE_SWAP_XY BIT(5) | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ENTER_IDLE_MODE 0x39U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ENTER_INVERT_MODE 0x21U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ENTER_NORMAL_MODE 0x13U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ENTER_PARTIAL_MODE 0x12U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_ENTER_SLEEP_MODE 0x10U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_EXIT_IDLE_MODE 0x38U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_EXIT_INVERT_MODE 0x20U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_EXIT_SLEEP_MODE 0x11U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_3D_CONTROL 0x3FU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_ADDRESS_MODE 0x0BU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_BLUE_CHANNEL 0x08U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_CABC_MIN_BRIGHTNESS 0x5FU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_COMPRESSION_MODE 0x03U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_CONTROL_DISPLAY 0x54U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_DIAGNOSTIC_RESULT 0x0FU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_DISPLAY_BRIGHTNESS 0x52U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_DISPLAY_ID 0x04U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_DISPLAY_MODE 0x0DU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_DISPLAY_STATUS 0x09U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_GREEN_CHANNEL 0x07U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_PIXEL_FORMAT 0x0CU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_POWER_MODE 0x0AU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_POWER_SAVE 0x56U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_RED_CHANNEL 0x06U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_SCANLINE 0x45U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_GET_SIGNAL_MODE 0x0EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_NOP 0x00U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_PIXEL_FORMAT_12BIT 0x33 | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_PIXEL_FORMAT_16BIT 0x55 | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_PIXEL_FORMAT_18BIT 0x66 | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_PIXEL_FORMAT_24BIT 0x77 | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_PIXEL_FORMAT_3BIT 0x11 | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_PIXEL_FORMAT_8BIT 0x22 | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_READ_DDB_CONTINUE 0xA8U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_READ_DDB_START 0xA1U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_READ_MEMORY_CONTINUE 0x3EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_READ_MEMORY_START 0x2EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_3D_CONTROL 0x3DU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_ADDRESS_MODE 0x36U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_CABC_MIN_BRIGHTNESS 0x5EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_COLUMN_ADDRESS 0x2AU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_DISPLAY_BRIGHTNESS 0x51U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_DISPLAY_OFF 0x28U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_DISPLAY_ON 0x29U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_GAMMA_CURVE 0x26U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_PAGE_ADDRESS 0x2BU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_PARTIAL_COLUMNS 0x31U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_PARTIAL_ROWS 0x30U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_PIXEL_FORMAT 0x3AU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_SCROLL_AREA 0x33U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_SCROLL_START 0x37U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_TEAR_OFF 0x34U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_TEAR_ON 0x35U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_TEAR_SCANLINE 0x44U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SET_VSYNC_TIMING 0x40U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_SOFT_RESET 0x01U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_WRITE_CONTROL_DISPLAY 0x53U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_WRITE_LUT 0x2DU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_WRITE_MEMORY_CONTINUE 0x3CU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_WRITE_MEMORY_START 0x2CU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DCS_WRITE_POWER_SAVE 0x55U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_BLANKING_PACKET 0x19U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Device supports non-continuous clock behavior (DSI spec 5.6.1)
| #define MIPI_DSI_COLOR_MODE_OFF 0x02U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_COLOR_MODE_ON 0x12U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_DCS_LONG_WRITE 0x39U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_DCS_READ 0x06U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_DCS_SHORT_WRITE 0x05U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_DCS_SHORT_WRITE_PARAM 0x15U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_END_OF_TRANSMISSION 0x08U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_GENERIC_LONG_WRITE 0x29U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM 0x04U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM 0x14U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM 0x24U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM 0x03U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM 0x13U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM 0x23U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_H_SYNC_END 0x31U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_H_SYNC_START 0x21U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_LOOSELY_PACKED_PIXEL_STREAM_YCBCR20 0x0CU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_MODE_EOT_PACKET BIT(9) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Disable EoT packets in HS mode
| #define MIPI_DSI_MODE_LPM BIT(11) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Transmit data in low power
| #define MIPI_DSI_MODE_VIDEO BIT(0) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Video mode
| #define MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Enable auto vertical count mode
| #define MIPI_DSI_MODE_VIDEO_BURST BIT(1) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Video burst mode
| #define MIPI_DSI_MODE_VIDEO_HBP BIT(6) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Disable hback-porch area
| #define MIPI_DSI_MODE_VIDEO_HFP BIT(5) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Disable hfront-porch area
| #define MIPI_DSI_MODE_VIDEO_HSA BIT(7) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Disable hsync-active area
| #define MIPI_DSI_MODE_VIDEO_HSE BIT(4) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Enable hsync-end packets in vsync-pulse and v-porch area
| #define MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Video pulse mode
| #define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8) | 
#include <include/zephyr/drivers/mipi_dsi.h>
Flush display FIFO on vsync pulse
| #define MIPI_DSI_NULL_PACKET 0x09U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_16 0x0EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_18 0x1EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_24 0x3EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_30 0x0DU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_36 0x1DU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR12 0x3DU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR16 0x2CU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR24 0x1CU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PIXEL_STREAM_3BYTE_18 0x2EU | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_PIXFMT_RGB565 3U | 
#include <include/zephyr/dt-bindings/mipi_dsi/mipi_dsi.h>
RGB565 (16bpp).
| #define MIPI_DSI_PIXFMT_RGB666 1U | 
#include <include/zephyr/dt-bindings/mipi_dsi/mipi_dsi.h>
RGB666 (24bpp).
| #define MIPI_DSI_PIXFMT_RGB666_PACKED 2U | 
#include <include/zephyr/dt-bindings/mipi_dsi/mipi_dsi.h>
Packed RGB666 (18bpp).
| #define MIPI_DSI_PIXFMT_RGB888 0U | 
#include <include/zephyr/dt-bindings/mipi_dsi/mipi_dsi.h>
RGB888 (24bpp).
| #define MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE 0x37U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_SHUTDOWN_PERIPHERAL 0x22U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_TURN_ON_PERIPHERAL 0x32U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_V_SYNC_END 0x11U | 
#include <include/zephyr/drivers/mipi_dsi.h>
| #define MIPI_DSI_V_SYNC_START 0x01U | 
#include <include/zephyr/drivers/mipi_dsi.h>
      
  | 
  inlinestatic | 
#include <include/zephyr/drivers/mipi_dsi.h>
Attach a new device to the MIPI-DSI bus.
| dev | MIPI-DSI host device. | 
| channel | Device channel (VID). | 
| mdev | MIPI-DSI device description. | 
| ssize_t mipi_dsi_dcs_read | ( | const struct device * | dev, | 
| uint8_t | channel, | ||
| uint8_t | cmd, | ||
| void * | buf, | ||
| size_t | len | ||
| ) | 
#include <include/zephyr/drivers/mipi_dsi.h>
MIPI-DSI DCS read.
| dev | MIPI-DSI host device. | 
| channel | Device channel (VID). | 
| cmd | DCS command. | 
| buf | Buffer where read data will be stored. | 
| len | Length of the reception buffer. | 
| ssize_t mipi_dsi_dcs_write | ( | const struct device * | dev, | 
| uint8_t | channel, | ||
| uint8_t | cmd, | ||
| const void * | buf, | ||
| size_t | len | ||
| ) | 
#include <include/zephyr/drivers/mipi_dsi.h>
MIPI-DSI DCS write.
| dev | MIPI-DSI host device. | 
| channel | Device channel (VID). | 
| cmd | DCS command. | 
| buf | Transmission buffer. | 
| len | Length of the transmission buffer | 
| ssize_t mipi_dsi_generic_read | ( | const struct device * | dev, | 
| uint8_t | channel, | ||
| const void * | params, | ||
| size_t | nparams, | ||
| void * | buf, | ||
| size_t | len | ||
| ) | 
#include <include/zephyr/drivers/mipi_dsi.h>
MIPI-DSI generic read.
| dev | MIPI-DSI host device. | 
| channel | Device channel (VID). | 
| params | Buffer containing request parameters. | 
| nparams | Number of parameters. | 
| buf | Buffer where read data will be stored. | 
| len | Length of the reception buffer. | 
| ssize_t mipi_dsi_generic_write | ( | const struct device * | dev, | 
| uint8_t | channel, | ||
| const void * | buf, | ||
| size_t | len | ||
| ) | 
#include <include/zephyr/drivers/mipi_dsi.h>
MIPI-DSI generic write.
| dev | MIPI-DSI host device. | 
| channel | Device channel (VID). | 
| buf | Transmission buffer. | 
| len | Length of the transmission buffer | 
      
  | 
  inlinestatic | 
#include <include/zephyr/drivers/mipi_dsi.h>
Transfer data to/from a device attached to the MIPI-DSI bus.
| dev | MIPI-DSI device. | 
| channel | Device channel (VID). | 
| msg | Message. |