include/mipi_dsi.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * MIPI DSI Bus
   4  *
   5  * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
   6  * Copyright (C) 2018 STMicroelectronics - All Rights Reserved
   7  * Author(s): Andrzej Hajda <a.hajda@samsung.com>
   8  *            Yannick Fertre <yannick.fertre@st.com>
   9  *            Philippe Cornu <philippe.cornu@st.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  */
  15 #ifndef MIPI_DSI_H
  16 #define MIPI_DSI_H
  17
  18 #include <mipi_display.h>
  19 #include <linux/bitops.h>
  20
  21 struct mipi_dsi_host;
  22 struct mipi_dsi_device;
  23
  24 /* request ACK from peripheral */
  25 #define MIPI_DSI_MSG_REQ_ACK    BIT(0)
  26 /* use Low Power Mode to transmit message */
  27 #define MIPI_DSI_MSG_USE_LPM    BIT(1)
  28
  29 /**
  30  * struct mipi_dsi_msg - read/write DSI buffer
  31  * @channel: virtual channel id
  32  * @type: payload data type
  33  * @flags: flags controlling this message transmission
  34  * @tx_len: length of @tx_buf
  35  * @tx_buf: data to be written
  36  * @rx_len: length of @rx_buf
  37  * @rx_buf: data to be read, or NULL
  38  */
  39 struct mipi_dsi_msg {
  40         u8 channel;
  41         u8 type;
  42         u16 flags;
  43
  44         size_t tx_len;
  45         const void *tx_buf;
  46
  47         size_t rx_len;
  48         void *rx_buf;
  49 };
  50
  51 bool mipi_dsi_packet_format_is_short(u8 type);
  52 bool mipi_dsi_packet_format_is_long(u8 type);
  53
  54 /**
  55  * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
  56  * @size: size (in bytes) of the packet
  57  * @header: the four bytes that make up the header (Data ID, Word Count or
  58  *     Packet Data, and ECC)
  59  * @payload_length: number of bytes in the payload
  60  * @payload: a pointer to a buffer containing the payload, if any
  61  */
  62 struct mipi_dsi_packet {
  63         size_t size;
  64         u8 header[4];
  65         size_t payload_length;
  66         const u8 *payload;
  67 };
  68
  69 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
  70                            const struct mipi_dsi_msg *msg);
  71
  72 /**
  73  * struct mipi_dsi_host_ops - DSI bus operations
  74  * @attach: attach DSI device to DSI host
  75  * @detach: detach DSI device from DSI host
  76  * @transfer: transmit a DSI packet
  77  *
  78  * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
  79  * structures. This structure contains information about the type of packet
  80  * being transmitted as well as the transmit and receive buffers. When an
  81  * error is encountered during transmission, this function will return a
  82  * negative error code. On success it shall return the number of bytes
  83  * transmitted for write packets or the number of bytes received for read
  84  * packets.
  85  *
  86  * Note that typically DSI packet transmission is atomic, so the .transfer()
  87  * function will seldomly return anything other than the number of bytes
  88  * contained in the transmit buffer on success.
  89  */
  90 struct mipi_dsi_host_ops {
  91         int (*attach)(struct mipi_dsi_host *host,
  92                       struct mipi_dsi_device *dsi);
  93         int (*detach)(struct mipi_dsi_host *host,
  94                       struct mipi_dsi_device *dsi);
  95         ssize_t (*transfer)(struct mipi_dsi_host *host,
  96                             const struct mipi_dsi_msg *msg);
  97 };
  98
  99 /**
 100  * struct mipi_dsi_phy_ops - DSI host physical operations
 101  * @init: initialized host physical part
 102  * @get_lane_mbps: get lane bitrate per lane (mbps)
 103  * @post_set_mode: operation that should after set mode
 104  */
 105 struct mipi_dsi_phy_ops {
 106         int (*init)(void *priv_data);
 107         int (*get_lane_mbps)(void *priv_data, struct display_timing *timings,
 108                              u32 lanes, u32 format, unsigned int *lane_mbps);
 109         void (*post_set_mode)(void *priv_data,  unsigned long mode_flags);
 110 };
 111
 112 /**
 113  * struct mipi_dsi_host - DSI host device
 114  * @dev: driver model device node for this DSI host
 115  * @ops: DSI host operations
 116  * @list: list management
 117  */
 118 struct mipi_dsi_host {
 119         struct device *dev;
 120         const struct mipi_dsi_host_ops *ops;
 121         struct list_head list;
 122 };
 123
 124 /* DSI mode flags */
 125
 126 /* video mode */
 127 #define MIPI_DSI_MODE_VIDEO             BIT(0)
 128 /* video burst mode */
 129 #define MIPI_DSI_MODE_VIDEO_BURST       BIT(1)
 130 /* video pulse mode */
 131 #define MIPI_DSI_MODE_VIDEO_SYNC_PULSE  BIT(2)
 132 /* enable auto vertical count mode */
 133 #define MIPI_DSI_MODE_VIDEO_AUTO_VERT   BIT(3)
 134 /* enable hsync-end packets in vsync-pulse and v-porch area */
 135 #define MIPI_DSI_MODE_VIDEO_HSE         BIT(4)
 136 /* disable hfront-porch area */
 137 #define MIPI_DSI_MODE_VIDEO_HFP         BIT(5)
 138 /* disable hback-porch area */
 139 #define MIPI_DSI_MODE_VIDEO_HBP         BIT(6)
 140 /* disable hsync-active area */
 141 #define MIPI_DSI_MODE_VIDEO_HSA         BIT(7)
 142 /* flush display FIFO on vsync pulse */
 143 #define MIPI_DSI_MODE_VSYNC_FLUSH       BIT(8)
 144 /* disable EoT packets in HS mode */
 145 #define MIPI_DSI_MODE_EOT_PACKET        BIT(9)
 146 /* device supports non-continuous clock behavior (DSI spec 5.6.1) */
 147 #define MIPI_DSI_CLOCK_NON_CONTINUOUS   BIT(10)
 148 /* transmit data in low power */
 149 #define MIPI_DSI_MODE_LPM               BIT(11)
 150
 151 enum mipi_dsi_pixel_format {
 152         MIPI_DSI_FMT_RGB888,
 153         MIPI_DSI_FMT_RGB666,
 154         MIPI_DSI_FMT_RGB666_PACKED,
 155         MIPI_DSI_FMT_RGB565,
 156 };
 157
 158 #define DSI_DEV_NAME_SIZE               20
 159
 160 /**
 161  * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
 162  * @type: DSI peripheral chip type
 163  * @channel: DSI virtual channel assigned to peripheral
 164  * @node: pointer to OF device node or NULL
 165  *
 166  * This is populated and passed to mipi_dsi_device_new to create a new
 167  * DSI device
 168  */
 169 struct mipi_dsi_device_info {
 170         char type[DSI_DEV_NAME_SIZE];
 171         u32 channel;
 172         struct device_node *node;
 173 };
 174
 175 /**
 176  * struct mipi_dsi_device - DSI peripheral device
 177  * @host: DSI host for this peripheral
 178  * @dev: driver model device node for this peripheral
 179  * @name: DSI peripheral chip type
 180  * @channel: virtual channel assigned to the peripheral
 181  * @format: pixel format for video mode
 182  * @lanes: number of active data lanes
 183  * @mode_flags: DSI operation mode related flags
 184  */
 185 struct mipi_dsi_device {
 186         struct mipi_dsi_host *host;
 187         struct udevice *dev;
 188
 189         char name[DSI_DEV_NAME_SIZE];
 190         unsigned int channel;
 191         unsigned int lanes;
 192         enum mipi_dsi_pixel_format format;
 193         unsigned long mode_flags;
 194 };
 195
 196 /**
 197  * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
 198  *                                given pixel format defined by the MIPI DSI
 199  *                                specification
 200  * @fmt: MIPI DSI pixel format
 201  *
 202  * Returns: The number of bits per pixel of the given pixel format.
 203  */
 204 static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
 205 {
 206         switch (fmt) {
 207         case MIPI_DSI_FMT_RGB888:
 208         case MIPI_DSI_FMT_RGB666:
 209                 return 24;
 210
 211         case MIPI_DSI_FMT_RGB666_PACKED:
 212                 return 18;
 213
 214         case MIPI_DSI_FMT_RGB565:
 215                 return 16;
 216         }
 217
 218         return -EINVAL;
 219 }
 220
 221 /**
 222  * struct mipi_dsi_panel_plat - DSI panel platform data
 223  * @device: DSI peripheral device
 224  */
 225 struct mipi_dsi_panel_plat {
 226         struct mipi_dsi_device *device;
 227 };
 228
 229 /**
 230  * mipi_dsi_attach - attach a DSI device to its DSI host
 231  * @dsi: DSI peripheral
 232  */
 233 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
 234
 235 /**
 236  * mipi_dsi_detach - detach a DSI device from its DSI host
 237  * @dsi: DSI peripheral
 238  */
 239 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
 240 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
 241 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
 242 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
 243                                             u16 value);
 244
 245 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
 246                                size_t size);
 247 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
 248                               size_t num_params, void *data, size_t size);
 249
 250 /**
 251  * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
 252  * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
 253  *    information only
 254  * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
 255  *    V-Blanking and H-Blanking information
 256  */
 257 enum mipi_dsi_dcs_tear_mode {
 258         MIPI_DSI_DCS_TEAR_MODE_VBLANK,
 259         MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
 260 };
 261
 262 #define MIPI_DSI_DCS_POWER_MODE_DISPLAY BIT(2)
 263 #define MIPI_DSI_DCS_POWER_MODE_NORMAL  BIT(3)
 264 #define MIPI_DSI_DCS_POWER_MODE_SLEEP   BIT(4)
 265 #define MIPI_DSI_DCS_POWER_MODE_PARTIAL BIT(5)
 266 #define MIPI_DSI_DCS_POWER_MODE_IDLE    BIT(6)
 267
 268 /**
 269  * mipi_dsi_dcs_write_buffer() - transmit a DCS command with payload
 270  * @dsi: DSI peripheral device
 271  * @data: buffer containing data to be transmitted
 272  * @len: size of transmission buffer
 273  *
 274  * This function will automatically choose the right data type depending on
 275  * the command payload length.
 276  *
 277  * Return: The number of bytes successfully transmitted or a negative error
 278  * code on failure.
 279  */
 280 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
 281                                   const void *data, size_t len);
 282
 283 /**
 284  * mipi_dsi_dcs_write() - send DCS write command
 285  * @dsi: DSI peripheral device
 286  * @cmd: DCS command
 287  * @data: buffer containing the command payload
 288  * @len: command payload length
 289  *
 290  * This function will automatically choose the right data type depending on
 291  * the command payload length.
 292
 293  * code on failure.
 294  */
 295 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
 296                            const void *data, size_t len);
 297
 298 /**
 299  * mipi_dsi_dcs_read() - send DCS read request command
 300  * @dsi: DSI peripheral device
 301  * @cmd: DCS command
 302  * @data: buffer in which to receive data
 303  * @len: size of receive buffer
 304  *
 305  * Return: The number of bytes read or a negative error code on failure.
 306  */
 307 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
 308                           size_t len);
 309
 310 /**
 311  * mipi_dsi_dcs_nop() - send DCS nop packet
 312  * @dsi: DSI peripheral device
 313  *
 314  * Return: 0 on success or a negative error code on failure.
 315  */
 316 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
 317
 318 /**
 319  * mipi_dsi_dcs_soft_reset() - perform a software reset of the display module
 320  * @dsi: DSI peripheral device
 321  *
 322  * Return: 0 on success or a negative error code on failure.
 323  */
 324 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
 325
 326 /**
 327  * mipi_dsi_dcs_get_power_mode() - query the display module's current power
 328  *    mode
 329  * @dsi: DSI peripheral device
 330  * @mode: return location for the current power mode
 331  *
 332  * Return: 0 on success or a negative error code on failure.
 333  */
 334 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
 335
 336 /**
 337  * mipi_dsi_dcs_get_pixel_format() - gets the pixel format for the RGB image
 338  *    data used by the interface
 339  * @dsi: DSI peripheral device
 340  * @format: return location for the pixel format
 341  *
 342  * Return: 0 on success or a negative error code on failure.
 343  */
 344 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
 345
 346 /**
 347  * mipi_dsi_dcs_enter_sleep_mode() - disable all unnecessary blocks inside the
 348  *    display module except interface communication
 349  * @dsi: DSI peripheral device
 350  *
 351  * Return: 0 on success or a negative error code on failure.
 352  */
 353 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
 354
 355 /**
 356  * mipi_dsi_dcs_exit_sleep_mode() - enable all blocks inside the display
 357  *    module
 358  * @dsi: DSI peripheral device
 359  *
 360  * Return: 0 on success or a negative error code on failure.
 361  */
 362 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
 363
 364 /**
 365  * mipi_dsi_dcs_set_display_off() - stop displaying the image data on the
 366  *    display device
 367  * @dsi: DSI peripheral device
 368  *
 369  * Return: 0 on success or a negative error code on failure.
 370  */
 371 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
 372
 373 /**
 374  * mipi_dsi_dcs_set_display_on() - start displaying the image data on the
 375  *    display device
 376  * @dsi: DSI peripheral device
 377  *
 378  * Return: 0 on success or a negative error code on failure
 379  */
 380 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
 381
 382 /**
 383  * mipi_dsi_dcs_set_column_address() - define the column extent of the frame
 384  *    memory accessed by the host processor
 385  * @dsi: DSI peripheral device
 386  * @start: first column of frame memory
 387  * @end: last column of frame memory
 388  *
 389  * Return: 0 on success or a negative error code on failure.
 390  */
 391 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
 392                                     u16 end);
 393 /**
 394  * mipi_dsi_dcs_set_page_address() - define the page extent of the frame
 395  *    memory accessed by the host processor
 396  * @dsi: DSI peripheral device
 397  * @start: first page of frame memory
 398  * @end: last page of frame memory
 399  *
 400  * Return: 0 on success or a negative error code on failure.
 401  */
 402 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
 403                                   u16 end);
 404
 405 /**
 406  * mipi_dsi_dcs_set_tear_off() - turn off the display module's Tearing Effect
 407  *    output signal on the TE signal line
 408  * @dsi: DSI peripheral device
 409  *
 410  * Return: 0 on success or a negative error code on failure
 411  */
 412 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
 413
 414 /**
 415  * mipi_dsi_dcs_set_tear_on() - turn on the display module's Tearing Effect
 416  *    output signal on the TE signal line.
 417  * @dsi: DSI peripheral device
 418  * @mode: the Tearing Effect Output Line mode
 419  *
 420  * Return: 0 on success or a negative error code on failure
 421  */
 422 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
 423                              enum mipi_dsi_dcs_tear_mode mode);
 424
 425 /**
 426  * mipi_dsi_dcs_set_pixel_format() - sets the pixel format for the RGB image
 427  *    data used by the interface
 428  * @dsi: DSI peripheral device
 429  * @format: pixel format
 430  *
 431  * Return: 0 on success or a negative error code on failure.
 432  */
 433 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
 434
 435 /**
 436  * mipi_dsi_dcs_set_tear_scanline() - set the scanline to use as trigger for
 437  *    the Tearing Effect output signal of the display module
 438  * @dsi: DSI peripheral device
 439  * @scanline: scanline to use as trigger
 440  *
 441  * Return: 0 on success or a negative error code on failure
 442  */
 443 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
 444
 445 /**
 446  * mipi_dsi_dcs_set_display_brightness() - sets the brightness value of the
 447  *    display
 448  * @dsi: DSI peripheral device
 449  * @brightness: brightness value
 450  *
 451  * Return: 0 on success or a negative error code on failure.
 452  */
 453 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
 454                                         u16 brightness);
 455
 456 /**
 457  * mipi_dsi_dcs_get_display_brightness() - gets the current brightness value
 458  *    of the display
 459  * @dsi: DSI peripheral device
 460  * @brightness: brightness value
 461  *
 462  * Return: 0 on success or a negative error code on failure.
 463  */
 464 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
 465                                         u16 *brightness);
 466
 467 #endif /* MIPI_DSI_H */