mipi_dsi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teslabs Engineering S.L.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MIPI_DSI_H_
#define ZEPHYR_INCLUDE_DRIVERS_MIPI_DSI_H_
 
#include <errno.h>
#include <sys/types.h>
#include <zephyr/device.h>
#include <zephyr/display/mipi_display.h>
#include <zephyr/dt-bindings/mipi_dsi/mipi_dsi.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct mipi_dsi_timings {
        uint32_t hactive;
        uint32_t hfp;
        uint32_t hbp;
        uint32_t hsync;
        uint32_t vactive;
        uint32_t vfp;
        uint32_t vbp;
        uint32_t vsync;
};
 
#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)
 
struct mipi_dsi_device {
        uint8_t data_lanes;
        struct mipi_dsi_timings timings;
        uint32_t pixfmt;
        uint32_t mode_flags;
};
 
/*
 * Per message flag to indicate the message must be sent
 * using Low Power Mode instead of controller default.
 */
#define MIPI_DSI_MSG_USE_LPM BIT(0x0)
 
struct mipi_dsi_msg {
        uint8_t type;
        uint16_t flags;
        uint8_t cmd;
        size_t tx_len;
        const void *tx_buf;
        size_t rx_len;
        void *rx_buf;
        void *user_data;
};
 
__subsystem struct mipi_dsi_driver_api {
        int (*attach)(const struct device *dev, uint8_t channel,
                      const struct mipi_dsi_device *mdev);
        ssize_t (*transfer)(const struct device *dev, uint8_t channel,
                            struct mipi_dsi_msg *msg);
        int (*detach)(const struct device *dev, uint8_t channel,
                      const struct mipi_dsi_device *mdev);
};
 
static inline int mipi_dsi_attach(const struct device *dev,
                                  uint8_t channel,
                                  const struct mipi_dsi_device *mdev)
{
        const struct mipi_dsi_driver_api *api = (const struct mipi_dsi_driver_api *)dev->api;
 
        return api->attach(dev, channel, mdev);
}
 
static inline ssize_t mipi_dsi_transfer(const struct device *dev,
                                        uint8_t channel,
                                        struct mipi_dsi_msg *msg)
{
        const struct mipi_dsi_driver_api *api = (const struct mipi_dsi_driver_api *)dev->api;
 
        return api->transfer(dev, channel, msg);
}
 
ssize_t mipi_dsi_generic_read(const struct device *dev, uint8_t channel,
                              const void *params, size_t nparams,
                              void *buf, size_t len);
 
ssize_t mipi_dsi_generic_write(const struct device *dev, uint8_t channel,
                               const void *buf, size_t len);
 
ssize_t mipi_dsi_dcs_read(const struct device *dev, uint8_t channel,
                          uint8_t cmd, void *buf, size_t len);
 
ssize_t mipi_dsi_dcs_write(const struct device *dev, uint8_t channel,
                           uint8_t cmd, const void *buf, size_t len);
 
 
static inline int mipi_dsi_detach(const struct device *dev,
                                  uint8_t channel,
                                  const struct mipi_dsi_device *mdev)
{
        const struct mipi_dsi_driver_api *api = (const struct mipi_dsi_driver_api *)dev->api;
 
        if (api->detach == NULL) {
                return -ENOSYS;
        }
 
        return api->detach(dev, channel, mdev);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MIPI_DSI_H_ */