include/drm/drm_mipi_dsi.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * MIPI DSI Bus
   4  *
   5  * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
   6  * Andrzej Hajda <a.hajda@samsung.com>
   7  */
   8
   9 #ifndef __DRM_MIPI_DSI_H__
  10 #define __DRM_MIPI_DSI_H__
  11
  12 #include <linux/device.h>
  13
  14 struct mipi_dsi_host;
  15 struct mipi_dsi_device;
  16 struct drm_dsc_picture_parameter_set;
  17
  18 /* request ACK from peripheral */
  19 #define MIPI_DSI_MSG_REQ_ACK    BIT(0)
  20 /* use Low Power Mode to transmit message */
  21 #define MIPI_DSI_MSG_USE_LPM    BIT(1)
  22
  23 /**
  24  * struct mipi_dsi_msg - read/write DSI buffer
  25  * @channel: virtual channel id
  26  * @type: payload data type
  27  * @flags: flags controlling this message transmission
  28  * @tx_len: length of @tx_buf
  29  * @tx_buf: data to be written
  30  * @rx_len: length of @rx_buf
  31  * @rx_buf: data to be read, or NULL
  32  */
  33 struct mipi_dsi_msg {
  34         u8 channel;
  35         u8 type;
  36         u16 flags;
  37
  38         size_t tx_len;
  39         const void *tx_buf;
  40
  41         size_t rx_len;
  42         void *rx_buf;
  43 };
  44
  45 bool mipi_dsi_packet_format_is_short(u8 type);
  46 bool mipi_dsi_packet_format_is_long(u8 type);
  47
  48 /**
  49  * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
  50  * @size: size (in bytes) of the packet
  51  * @header: the four bytes that make up the header (Data ID, Word Count or
  52  *     Packet Data, and ECC)
  53  * @payload_length: number of bytes in the payload
  54  * @payload: a pointer to a buffer containing the payload, if any
  55  */
  56 struct mipi_dsi_packet {
  57         size_t size;
  58         u8 header[4];
  59         size_t payload_length;
  60         const u8 *payload;
  61 };
  62
  63 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
  64                            const struct mipi_dsi_msg *msg);
  65
  66 /**
  67  * struct mipi_dsi_host_ops - DSI bus operations
  68  * @attach: attach DSI device to DSI host
  69  * @detach: detach DSI device from DSI host
  70  * @transfer: transmit a DSI packet
  71  *
  72  * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
  73  * structures. This structure contains information about the type of packet
  74  * being transmitted as well as the transmit and receive buffers. When an
  75  * error is encountered during transmission, this function will return a
  76  * negative error code. On success it shall return the number of bytes
  77  * transmitted for write packets or the number of bytes received for read
  78  * packets.
  79  *
  80  * Note that typically DSI packet transmission is atomic, so the .transfer()
  81  * function will seldomly return anything other than the number of bytes
  82  * contained in the transmit buffer on success.
  83  *
  84  * Also note that those callbacks can be called no matter the state the
  85  * host is in. Drivers that need the underlying device to be powered to
  86  * perform these operations will first need to make sure it's been
  87  * properly enabled.
  88  */
  89 struct mipi_dsi_host_ops {
  90         int (*attach)(struct mipi_dsi_host *host,
  91                       struct mipi_dsi_device *dsi);
  92         int (*detach)(struct mipi_dsi_host *host,
  93                       struct mipi_dsi_device *dsi);
  94         ssize_t (*transfer)(struct mipi_dsi_host *host,
  95                             const struct mipi_dsi_msg *msg);
  96 };
  97
  98 /**
  99  * struct mipi_dsi_host - DSI host device
 100  * @dev: driver model device node for this DSI host
 101  * @ops: DSI host operations
 102  * @list: list management
 103  */
 104 struct mipi_dsi_host {
 105         struct device *dev;
 106         const struct mipi_dsi_host_ops *ops;
 107         struct list_head list;
 108 };
 109
 110 int mipi_dsi_host_register(struct mipi_dsi_host *host);
 111 void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
 112 struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node);
 113
 114 /* DSI mode flags */
 115
 116 /* video mode */
 117 #define MIPI_DSI_MODE_VIDEO             BIT(0)
 118 /* video burst mode */
 119 #define MIPI_DSI_MODE_VIDEO_BURST       BIT(1)
 120 /* video pulse mode */
 121 #define MIPI_DSI_MODE_VIDEO_SYNC_PULSE  BIT(2)
 122 /* enable auto vertical count mode */
 123 #define MIPI_DSI_MODE_VIDEO_AUTO_VERT   BIT(3)
 124 /* enable hsync-end packets in vsync-pulse and v-porch area */
 125 #define MIPI_DSI_MODE_VIDEO_HSE         BIT(4)
 126 /* disable hfront-porch area */
 127 #define MIPI_DSI_MODE_VIDEO_NO_HFP      BIT(5)
 128 /* disable hback-porch area */
 129 #define MIPI_DSI_MODE_VIDEO_NO_HBP      BIT(6)
 130 /* disable hsync-active area */
 131 #define MIPI_DSI_MODE_VIDEO_NO_HSA      BIT(7)
 132 /* flush display FIFO on vsync pulse */
 133 #define MIPI_DSI_MODE_VSYNC_FLUSH       BIT(8)
 134 /* disable EoT packets in HS mode */
 135 #define MIPI_DSI_MODE_NO_EOT_PACKET     BIT(9)
 136 /* device supports non-continuous clock behavior (DSI spec 5.6.1) */
 137 #define MIPI_DSI_CLOCK_NON_CONTINUOUS   BIT(10)
 138 /* transmit data in low power */
 139 #define MIPI_DSI_MODE_LPM               BIT(11)
 140 /* transmit data ending at the same time for all lanes within one hsync */
 141 #define MIPI_DSI_HS_PKT_END_ALIGNED     BIT(12)
 142
 143 enum mipi_dsi_pixel_format {
 144         MIPI_DSI_FMT_RGB888,
 145         MIPI_DSI_FMT_RGB666,
 146         MIPI_DSI_FMT_RGB666_PACKED,
 147         MIPI_DSI_FMT_RGB565,
 148 };
 149
 150 #define DSI_DEV_NAME_SIZE               20
 151
 152 /**
 153  * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
 154  * @type: DSI peripheral chip type
 155  * @channel: DSI virtual channel assigned to peripheral
 156  * @node: pointer to OF device node or NULL
 157  *
 158  * This is populated and passed to mipi_dsi_device_new to create a new
 159  * DSI device
 160  */
 161 struct mipi_dsi_device_info {
 162         char type[DSI_DEV_NAME_SIZE];
 163         u32 channel;
 164         struct device_node *node;
 165 };
 166
 167 /**
 168  * struct mipi_dsi_device - DSI peripheral device
 169  * @host: DSI host for this peripheral
 170  * @dev: driver model device node for this peripheral
 171  * @name: DSI peripheral chip type
 172  * @channel: virtual channel assigned to the peripheral
 173  * @format: pixel format for video mode
 174  * @lanes: number of active data lanes
 175  * @mode_flags: DSI operation mode related flags
 176  * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
 177  * be set to the real limits of the hardware, zero is only accepted for
 178  * legacy drivers
 179  * @lp_rate: maximum lane frequency for low power mode in hertz, this should
 180  * be set to the real limits of the hardware, zero is only accepted for
 181  * legacy drivers
 182  * @dsc: panel/bridge DSC pps payload to be sent
 183  */
 184 struct mipi_dsi_device {
 185         struct mipi_dsi_host *host;
 186         struct device dev;
 187
 188         char name[DSI_DEV_NAME_SIZE];
 189         unsigned int channel;
 190         unsigned int lanes;
 191         enum mipi_dsi_pixel_format format;
 192         unsigned long mode_flags;
 193         unsigned long hs_rate;
 194         unsigned long lp_rate;
 195         struct drm_dsc_config *dsc;
 196 };
 197
 198 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
 199
 200 #define to_mipi_dsi_device(__dev)       container_of_const(__dev, struct mipi_dsi_device, dev)
 201
 202 /**
 203  * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
 204  *                                given pixel format defined by the MIPI DSI
 205  *                                specification
 206  * @fmt: MIPI DSI pixel format
 207  *
 208  * Returns: The number of bits per pixel of the given pixel format.
 209  */
 210 static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
 211 {
 212         switch (fmt) {
 213         case MIPI_DSI_FMT_RGB888:
 214         case MIPI_DSI_FMT_RGB666:
 215                 return 24;
 216
 217         case MIPI_DSI_FMT_RGB666_PACKED:
 218                 return 18;
 219
 220         case MIPI_DSI_FMT_RGB565:
 221                 return 16;
 222         }
 223
 224         return -EINVAL;
 225 }
 226
 227 struct mipi_dsi_device *
 228 mipi_dsi_device_register_full(struct mipi_dsi_host *host,
 229                               const struct mipi_dsi_device_info *info);
 230 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
 231 struct mipi_dsi_device *
 232 devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host,
 233                                    const struct mipi_dsi_device_info *info);
 234 struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
 235 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
 236 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
 237 int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);
 238 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
 239 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
 240 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
 241                                             u16 value);
 242 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
 243 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
 244                                        const struct drm_dsc_picture_parameter_set *pps);
 245
 246 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
 247                                size_t size);
 248 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
 249                               size_t num_params, void *data, size_t size);
 250
 251 /**
 252  * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
 253  * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
 254  *    information only
 255  * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
 256  *    V-Blanking and H-Blanking information
 257  */
 258 enum mipi_dsi_dcs_tear_mode {
 259         MIPI_DSI_DCS_TEAR_MODE_VBLANK,
 260         MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
 261 };
 262
 263 #define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
 264 #define MIPI_DSI_DCS_POWER_MODE_NORMAL  (1 << 3)
 265 #define MIPI_DSI_DCS_POWER_MODE_SLEEP   (1 << 4)
 266 #define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
 267 #define MIPI_DSI_DCS_POWER_MODE_IDLE    (1 << 6)
 268
 269 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
 270                                   const void *data, size_t len);
 271 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
 272                            const void *data, size_t len);
 273 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
 274                           size_t len);
 275 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
 276 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
 277 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
 278 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
 279 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
 280 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
 281 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
 282 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
 283 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
 284                                     u16 end);
 285 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
 286                                   u16 end);
 287 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
 288 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
 289                              enum mipi_dsi_dcs_tear_mode mode);
 290 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
 291 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
 292 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
 293                                         u16 brightness);
 294 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
 295                                         u16 *brightness);
 296 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
 297                                              u16 brightness);
 298 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
 299                                              u16 *brightness);
 300
 301 /**
 302  * mipi_dsi_generic_write_seq - transmit data using a generic write packet
 303  * @dsi: DSI peripheral device
 304  * @seq: buffer containing the payload
 305  */
 306 #define mipi_dsi_generic_write_seq(dsi, seq...)                                \
 307         do {                                                                   \
 308                 static const u8 d[] = { seq };                                 \
 309                 struct device *dev = &dsi->dev;                                \
 310                 int ret;                                                       \
 311                 ret = mipi_dsi_generic_write(dsi, d, ARRAY_SIZE(d));           \
 312                 if (ret < 0) {                                                 \
 313                         dev_err_ratelimited(dev, "transmit data failed: %d\n", \
 314                                             ret);                              \
 315                         return ret;                                            \
 316                 }                                                              \
 317         } while (0)
 318
 319 /**
 320  * mipi_dsi_dcs_write_seq - transmit a DCS command with payload
 321  * @dsi: DSI peripheral device
 322  * @cmd: Command
 323  * @seq: buffer containing data to be transmitted
 324  */
 325 #define mipi_dsi_dcs_write_seq(dsi, cmd, seq...)                           \
 326         do {                                                               \
 327                 static const u8 d[] = { cmd, seq };                        \
 328                 struct device *dev = &dsi->dev;                            \
 329                 int ret;                                                   \
 330                 ret = mipi_dsi_dcs_write_buffer(dsi, d, ARRAY_SIZE(d));    \
 331                 if (ret < 0) {                                             \
 332                         dev_err_ratelimited(                               \
 333                                 dev, "sending command %#02x failed: %d\n", \
 334                                 cmd, ret);                                 \
 335                         return ret;                                        \
 336                 }                                                          \
 337         } while (0)
 338
 339 /**
 340  * struct mipi_dsi_driver - DSI driver
 341  * @driver: device driver model driver
 342  * @probe: callback for device binding
 343  * @remove: callback for device unbinding
 344  * @shutdown: called at shutdown time to quiesce the device
 345  */
 346 struct mipi_dsi_driver {
 347         struct device_driver driver;
 348         int(*probe)(struct mipi_dsi_device *dsi);
 349         void (*remove)(struct mipi_dsi_device *dsi);
 350         void (*shutdown)(struct mipi_dsi_device *dsi);
 351 };
 352
 353 static inline struct mipi_dsi_driver *
 354 to_mipi_dsi_driver(struct device_driver *driver)
 355 {
 356         return container_of(driver, struct mipi_dsi_driver, driver);
 357 }
 358
 359 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
 360 {
 361         return dev_get_drvdata(&dsi->dev);
 362 }
 363
 364 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
 365 {
 366         dev_set_drvdata(&dsi->dev, data);
 367 }
 368
 369 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
 370                                   struct module *owner);
 371 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
 372
 373 #define mipi_dsi_driver_register(driver) \
 374         mipi_dsi_driver_register_full(driver, THIS_MODULE)
 375
 376 #define module_mipi_dsi_driver(__mipi_dsi_driver) \
 377         module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
 378                         mipi_dsi_driver_unregister)
 379
 380 #endif /* __DRM_MIPI_DSI__ */