drm_mipi_dsi.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * MIPI DSI Bus
 *
 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
 * Andrzej Hajda <a.hajda@samsung.com>
 */
 
#ifndef __DRM_MIPI_DSI_H__
#define __DRM_MIPI_DSI_H__
 
#include <linux/device.h>
#include <linux/delay.h>
 
struct mipi_dsi_host;
struct mipi_dsi_device;
struct drm_dsc_picture_parameter_set;
 
/* request ACK from peripheral */
#define MIPI_DSI_MSG_REQ_ACK    BIT(0)
/* use Low Power Mode to transmit message */
#define MIPI_DSI_MSG_USE_LPM    BIT(1)
 
struct mipi_dsi_msg {
    u8 channel;
    u8 type;
    u16 flags;
 
    size_t tx_len;
    const void *tx_buf;
 
    size_t rx_len;
    void *rx_buf;
};
 
bool mipi_dsi_packet_format_is_short(u8 type);
bool mipi_dsi_packet_format_is_long(u8 type);
 
struct mipi_dsi_packet {
    size_t size;
    u8 header[4];
    size_t payload_length;
    const u8 *payload;
};
 
int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
               const struct mipi_dsi_msg *msg);
 
struct mipi_dsi_host_ops {
    int (*attach)(struct mipi_dsi_host *host,
              struct mipi_dsi_device *dsi);
    int (*detach)(struct mipi_dsi_host *host,
              struct mipi_dsi_device *dsi);
    ssize_t (*transfer)(struct mipi_dsi_host *host,
                const struct mipi_dsi_msg *msg);
};
 
struct mipi_dsi_host {
    struct device *dev;
    const struct mipi_dsi_host_ops *ops;
    struct list_head list;
};
 
int mipi_dsi_host_register(struct mipi_dsi_host *host);
void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node);
 
/* DSI mode flags */
 
/* video mode */
#define MIPI_DSI_MODE_VIDEO     BIT(0)
/* video burst mode */
#define MIPI_DSI_MODE_VIDEO_BURST   BIT(1)
/* video pulse mode */
#define MIPI_DSI_MODE_VIDEO_SYNC_PULSE  BIT(2)
/* enable auto vertical count mode */
#define MIPI_DSI_MODE_VIDEO_AUTO_VERT   BIT(3)
/* enable hsync-end packets in vsync-pulse and v-porch area */
#define MIPI_DSI_MODE_VIDEO_HSE     BIT(4)
/* disable hfront-porch area */
#define MIPI_DSI_MODE_VIDEO_NO_HFP  BIT(5)
/* disable hback-porch area */
#define MIPI_DSI_MODE_VIDEO_NO_HBP  BIT(6)
/* disable hsync-active area */
#define MIPI_DSI_MODE_VIDEO_NO_HSA  BIT(7)
/* disable EoT packets in HS mode */
#define MIPI_DSI_MODE_NO_EOT_PACKET BIT(9)
/* device supports non-continuous clock behavior (DSI spec 5.6.1) */
#define MIPI_DSI_CLOCK_NON_CONTINUOUS   BIT(10)
/* transmit data in low power */
#define MIPI_DSI_MODE_LPM       BIT(11)
/* transmit data ending at the same time for all lanes within one hsync */
#define MIPI_DSI_HS_PKT_END_ALIGNED BIT(12)
 
enum mipi_dsi_pixel_format {
    MIPI_DSI_FMT_RGB888,
    MIPI_DSI_FMT_RGB666,
    MIPI_DSI_FMT_RGB666_PACKED,
    MIPI_DSI_FMT_RGB565,
    MIPI_DSI_FMT_RGB101010,
};
 
#define DSI_DEV_NAME_SIZE       20
 
struct mipi_dsi_device_info {
    char type[DSI_DEV_NAME_SIZE];
    u32 channel;
    struct device_node *node;
};
 
struct mipi_dsi_device {
    struct mipi_dsi_host *host;
    struct device dev;
    bool attached;
 
    char name[DSI_DEV_NAME_SIZE];
    unsigned int channel;
    unsigned int lanes;
    enum mipi_dsi_pixel_format format;
    unsigned long mode_flags;
    unsigned long hs_rate;
    unsigned long lp_rate;
    struct drm_dsc_config *dsc;
};
 
struct mipi_dsi_multi_context {
    struct mipi_dsi_device *dsi;
 
    int accum_err;
};
 
#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
 
#define to_mipi_dsi_device(__dev)   container_of_const(__dev, struct mipi_dsi_device, dev)
 
extern const struct bus_type mipi_dsi_bus_type;
#define dev_is_mipi_dsi(dev)    ((dev)->bus == &mipi_dsi_bus_type)
 
static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
{
    switch (fmt) {
    case MIPI_DSI_FMT_RGB101010:
        return 30;
 
    case MIPI_DSI_FMT_RGB888:
    case MIPI_DSI_FMT_RGB666:
        return 24;
 
    case MIPI_DSI_FMT_RGB666_PACKED:
        return 18;
 
    case MIPI_DSI_FMT_RGB565:
        return 16;
    }
 
    return -EINVAL;
}
 
enum mipi_dsi_compression_algo {
    MIPI_DSI_COMPRESSION_DSC = 0,
    MIPI_DSI_COMPRESSION_VENDOR = 3,
    /* other two values are reserved, DSI 1.3 */
};
 
struct mipi_dsi_device *
mipi_dsi_device_register_full(struct mipi_dsi_host *host,
                  const struct mipi_dsi_device_info *info);
void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
struct mipi_dsi_device *
devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host,
                   const struct mipi_dsi_device_info *info);
struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
int mipi_dsi_attach(struct mipi_dsi_device *dsi);
int mipi_dsi_detach(struct mipi_dsi_device *dsi);
int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);
int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
                        u16 value);
int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
int mipi_dsi_compression_mode_ext(struct mipi_dsi_device *dsi, bool enable,
                  enum mipi_dsi_compression_algo algo,
                  unsigned int pps_selector);
int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
                   const struct drm_dsc_picture_parameter_set *pps);
 
void mipi_dsi_compression_mode_ext_multi(struct mipi_dsi_multi_context *ctx,
                     bool enable,
                     enum mipi_dsi_compression_algo algo,
                     unsigned int pps_selector);
void mipi_dsi_compression_mode_multi(struct mipi_dsi_multi_context *ctx,
                     bool enable);
void mipi_dsi_picture_parameter_set_multi(struct mipi_dsi_multi_context *ctx,
                      const struct drm_dsc_picture_parameter_set *pps);
 
ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
                   size_t size);
void mipi_dsi_generic_write_multi(struct mipi_dsi_multi_context *ctx,
                  const void *payload, size_t size);
void mipi_dsi_dual_generic_write_multi(struct mipi_dsi_multi_context *ctx,
                       struct mipi_dsi_device *dsi1,
                       struct mipi_dsi_device *dsi2,
                       const void *payload, size_t size);
ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
                  size_t num_params, void *data, size_t size);
u32 drm_mipi_dsi_get_input_bus_fmt(enum mipi_dsi_pixel_format dsi_format);
 
#define mipi_dsi_msleep(ctx, delay) \
    do {                \
        if (!(ctx)->accum_err)  \
            msleep(delay);  \
    } while (0)
 
#define mipi_dsi_usleep_range(ctx, min, max)    \
    do {                    \
        if (!(ctx)->accum_err)      \
            usleep_range(min, max); \
    } while (0)
 
enum mipi_dsi_dcs_tear_mode {
    MIPI_DSI_DCS_TEAR_MODE_VBLANK,
    MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
};
 
#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
#define MIPI_DSI_DCS_POWER_MODE_NORMAL  (1 << 3)
#define MIPI_DSI_DCS_POWER_MODE_SLEEP   (1 << 4)
#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
#define MIPI_DSI_DCS_POWER_MODE_IDLE    (1 << 6)
 
ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
                  const void *data, size_t len);
int mipi_dsi_dcs_write_buffer_chatty(struct mipi_dsi_device *dsi,
                     const void *data, size_t len);
void mipi_dsi_dcs_write_buffer_multi(struct mipi_dsi_multi_context *ctx,
                     const void *data, size_t len);
void mipi_dsi_dual_dcs_write_buffer_multi(struct mipi_dsi_multi_context *ctx,
                      struct mipi_dsi_device *dsi1,
                      struct mipi_dsi_device *dsi2,
                      const void *data, size_t len);
ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
               const void *data, size_t len);
ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
              size_t len);
void mipi_dsi_dcs_read_multi(struct mipi_dsi_multi_context *ctx, u8 cmd,
                 void *data, size_t len);
int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
                    u16 end);
int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
                  u16 end);
int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
                 enum mipi_dsi_dcs_tear_mode mode);
int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
                    u16 brightness);
int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
                    u16 *brightness);
int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
                         u16 brightness);
int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
                         u16 *brightness);
 
void mipi_dsi_dcs_nop_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_enter_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_exit_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_display_off_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_display_on_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_tear_on_multi(struct mipi_dsi_multi_context *ctx,
                    enum mipi_dsi_dcs_tear_mode mode);
void mipi_dsi_turn_on_peripheral_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_soft_reset_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_display_brightness_multi(struct mipi_dsi_multi_context *ctx,
                           u16 brightness);
void mipi_dsi_dcs_set_pixel_format_multi(struct mipi_dsi_multi_context *ctx,
                     u8 format);
void mipi_dsi_dcs_set_column_address_multi(struct mipi_dsi_multi_context *ctx,
                       u16 start, u16 end);
void mipi_dsi_dcs_set_page_address_multi(struct mipi_dsi_multi_context *ctx,
                     u16 start, u16 end);
void mipi_dsi_dcs_set_tear_scanline_multi(struct mipi_dsi_multi_context *ctx,
                      u16 scanline);
void mipi_dsi_dcs_set_tear_off_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_shutdown_peripheral_multi(struct mipi_dsi_multi_context *ctx);
 
#define mipi_dsi_generic_write_seq_multi(ctx, seq...)                \
    do {                                                         \
        static const u8 d[] = { seq };                       \
        mipi_dsi_generic_write_multi(ctx, d, ARRAY_SIZE(d)); \
    } while (0)
 
#define mipi_dsi_generic_write_var_seq_multi(ctx, seq...)        \
    do {                                 \
        const u8 d[] = { seq };                  \
        mipi_dsi_generic_write_multi(ctx, d, ARRAY_SIZE(d)); \
    } while (0)
 
#define mipi_dsi_dcs_write_seq_multi(ctx, cmd, seq...)                  \
    do {                                                            \
        static const u8 d[] = { cmd, seq };                     \
        mipi_dsi_dcs_write_buffer_multi(ctx, d, ARRAY_SIZE(d)); \
    } while (0)
 
#define mipi_dsi_dcs_write_var_seq_multi(ctx, cmd, seq...)      \
    do {                                \
        const u8 d[] = { cmd, seq };                \
        mipi_dsi_dcs_write_buffer_multi(ctx, d, ARRAY_SIZE(d)); \
    } while (0)
 
#define mipi_dsi_dual(_func, _ctx, _dsi1, _dsi2, ...)        \
    do {                             \
        struct mipi_dsi_multi_context *_ctxcpy = (_ctx); \
        _ctxcpy->dsi = (_dsi1);              \
        (_func)(_ctxcpy, ##__VA_ARGS__);         \
        _ctxcpy->dsi = (_dsi2);              \
        (_func)(_ctxcpy, ##__VA_ARGS__);         \
    } while (0)
 
#define mipi_dsi_dual_generic_write_seq_multi(_ctx, _dsi1, _dsi2, _seq...) \
    do {                                   \
        static const u8 d[] = { _seq };                \
        mipi_dsi_dual_generic_write_multi(_ctx, _dsi1, _dsi2, d,   \
                          ARRAY_SIZE(d));      \
    } while (0)
 
#define mipi_dsi_dual_dcs_write_seq_multi(_ctx, _dsi1, _dsi2, _cmd, _seq...) \
    do {                                     \
        static const u8 d[] = { _cmd, _seq };                \
        mipi_dsi_dual_dcs_write_buffer_multi(_ctx, _dsi1, _dsi2, d,  \
                             ARRAY_SIZE(d));         \
    } while (0)
 
struct mipi_dsi_driver {
    struct device_driver driver;
    int(*probe)(struct mipi_dsi_device *dsi);
    void (*remove)(struct mipi_dsi_device *dsi);
    void (*shutdown)(struct mipi_dsi_device *dsi);
};
 
static inline struct mipi_dsi_driver *
to_mipi_dsi_driver(struct device_driver *driver)
{
    return container_of(driver, struct mipi_dsi_driver, driver);
}
 
static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
{
    return dev_get_drvdata(&dsi->dev);
}
 
static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
{
    dev_set_drvdata(&dsi->dev, data);
}
 
int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
                  struct module *owner);
void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
 
#define mipi_dsi_driver_register(driver) \
    mipi_dsi_driver_register_full(driver, THIS_MODULE)
 
#define module_mipi_dsi_driver(__mipi_dsi_driver) \
    module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
            mipi_dsi_driver_unregister)
 
#endif /* __DRM_MIPI_DSI__ */