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