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 #include <linux/delay.h> 14 15 struct mipi_dsi_host; 16 struct mipi_dsi_device; 17 struct drm_dsc_picture_parameter_set; 18 19 /* request ACK from peripheral */ 20 #define MIPI_DSI_MSG_REQ_ACK BIT(0) 21 /* use Low Power Mode to transmit message */ 22 #define MIPI_DSI_MSG_USE_LPM BIT(1) 23 24 /** 25 * struct mipi_dsi_msg - read/write DSI buffer 26 * @channel: virtual channel id 27 * @type: payload data type 28 * @flags: flags controlling this message transmission 29 * @tx_len: length of @tx_buf 30 * @tx_buf: data to be written 31 * @rx_len: length of @rx_buf 32 * @rx_buf: data to be read, or NULL 33 */ 34 struct mipi_dsi_msg { 35 u8 channel; 36 u8 type; 37 u16 flags; 38 39 size_t tx_len; 40 const void *tx_buf; 41 42 size_t rx_len; 43 void *rx_buf; 44 }; 45 46 bool mipi_dsi_packet_format_is_short(u8 type); 47 bool mipi_dsi_packet_format_is_long(u8 type); 48 49 /** 50 * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format 51 * @size: size (in bytes) of the packet 52 * @header: the four bytes that make up the header (Data ID, Word Count or 53 * Packet Data, and ECC) 54 * @payload_length: number of bytes in the payload 55 * @payload: a pointer to a buffer containing the payload, if any 56 */ 57 struct mipi_dsi_packet { 58 size_t size; 59 u8 header[4]; 60 size_t payload_length; 61 const u8 *payload; 62 }; 63 64 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet, 65 const struct mipi_dsi_msg *msg); 66 67 /** 68 * struct mipi_dsi_host_ops - DSI bus operations 69 * @attach: attach DSI device to DSI host 70 * @detach: detach DSI device from DSI host 71 * @transfer: transmit a DSI packet 72 * 73 * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg 74 * structures. This structure contains information about the type of packet 75 * being transmitted as well as the transmit and receive buffers. When an 76 * error is encountered during transmission, this function will return a 77 * negative error code. On success it shall return the number of bytes 78 * transmitted for write packets or the number of bytes received for read 79 * packets. 80 * 81 * Note that typically DSI packet transmission is atomic, so the .transfer() 82 * function will seldomly return anything other than the number of bytes 83 * contained in the transmit buffer on success. 84 * 85 * Also note that those callbacks can be called no matter the state the 86 * host is in. Drivers that need the underlying device to be powered to 87 * perform these operations will first need to make sure it's been 88 * properly enabled. 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_host - DSI host device 101 * @dev: driver model device node for this DSI host 102 * @ops: DSI host operations 103 * @list: list management 104 */ 105 struct mipi_dsi_host { 106 struct device *dev; 107 const struct mipi_dsi_host_ops *ops; 108 struct list_head list; 109 }; 110 111 int mipi_dsi_host_register(struct mipi_dsi_host *host); 112 void mipi_dsi_host_unregister(struct mipi_dsi_host *host); 113 struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node); 114 115 /* DSI mode flags */ 116 117 /* video mode */ 118 #define MIPI_DSI_MODE_VIDEO BIT(0) 119 /* video burst mode */ 120 #define MIPI_DSI_MODE_VIDEO_BURST BIT(1) 121 /* video pulse mode */ 122 #define MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2) 123 /* enable auto vertical count mode */ 124 #define MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3) 125 /* enable hsync-end packets in vsync-pulse and v-porch area */ 126 #define MIPI_DSI_MODE_VIDEO_HSE BIT(4) 127 /* disable hfront-porch area */ 128 #define MIPI_DSI_MODE_VIDEO_NO_HFP BIT(5) 129 /* disable hback-porch area */ 130 #define MIPI_DSI_MODE_VIDEO_NO_HBP BIT(6) 131 /* disable hsync-active area */ 132 #define MIPI_DSI_MODE_VIDEO_NO_HSA BIT(7) 133 /* disable EoT packets in HS mode */ 134 #define MIPI_DSI_MODE_NO_EOT_PACKET BIT(9) 135 /* device supports non-continuous clock behavior (DSI spec 5.6.1) */ 136 #define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10) 137 /* transmit data in low power */ 138 #define MIPI_DSI_MODE_LPM BIT(11) 139 /* transmit data ending at the same time for all lanes within one hsync */ 140 #define MIPI_DSI_HS_PKT_END_ALIGNED BIT(12) 141 142 enum mipi_dsi_pixel_format { 143 MIPI_DSI_FMT_RGB888, 144 MIPI_DSI_FMT_RGB666, 145 MIPI_DSI_FMT_RGB666_PACKED, 146 MIPI_DSI_FMT_RGB565, 147 }; 148 149 #define DSI_DEV_NAME_SIZE 20 150 151 /** 152 * struct mipi_dsi_device_info - template for creating a mipi_dsi_device 153 * @type: DSI peripheral chip type 154 * @channel: DSI virtual channel assigned to peripheral 155 * @node: pointer to OF device node or NULL 156 * 157 * This is populated and passed to mipi_dsi_device_new to create a new 158 * DSI device 159 */ 160 struct mipi_dsi_device_info { 161 char type[DSI_DEV_NAME_SIZE]; 162 u32 channel; 163 struct device_node *node; 164 }; 165 166 /** 167 * struct mipi_dsi_device - DSI peripheral device 168 * @host: DSI host for this peripheral 169 * @dev: driver model device node for this peripheral 170 * @attached: the DSI device has been successfully attached 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 bool attached; 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 unsigned long hs_rate; 195 unsigned long lp_rate; 196 struct drm_dsc_config *dsc; 197 }; 198 199 /** 200 * struct mipi_dsi_multi_context - Context to call multiple MIPI DSI funcs in a row 201 */ 202 struct mipi_dsi_multi_context { 203 /** 204 * @dsi: Pointer to the MIPI DSI device 205 */ 206 struct mipi_dsi_device *dsi; 207 208 /** 209 * @accum_err: Storage for the accumulated error over the multiple calls 210 * 211 * Init to 0. If a function encounters an error then the error code 212 * will be stored here. If you call a function and this points to a 213 * non-zero value then the function will be a noop. This allows calling 214 * a function many times in a row and just checking the error at the 215 * end to see if any of them failed. 216 */ 217 int accum_err; 218 }; 219 220 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:" 221 222 #define to_mipi_dsi_device(__dev) container_of_const(__dev, struct mipi_dsi_device, dev) 223 224 extern const struct bus_type mipi_dsi_bus_type; 225 #define dev_is_mipi_dsi(dev) ((dev)->bus == &mipi_dsi_bus_type) 226 227 /** 228 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any 229 * given pixel format defined by the MIPI DSI 230 * specification 231 * @fmt: MIPI DSI pixel format 232 * 233 * Returns: The number of bits per pixel of the given pixel format. 234 */ 235 static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt) 236 { 237 switch (fmt) { 238 case MIPI_DSI_FMT_RGB888: 239 case MIPI_DSI_FMT_RGB666: 240 return 24; 241 242 case MIPI_DSI_FMT_RGB666_PACKED: 243 return 18; 244 245 case MIPI_DSI_FMT_RGB565: 246 return 16; 247 } 248 249 return -EINVAL; 250 } 251 252 enum mipi_dsi_compression_algo { 253 MIPI_DSI_COMPRESSION_DSC = 0, 254 MIPI_DSI_COMPRESSION_VENDOR = 3, 255 /* other two values are reserved, DSI 1.3 */ 256 }; 257 258 struct mipi_dsi_device * 259 mipi_dsi_device_register_full(struct mipi_dsi_host *host, 260 const struct mipi_dsi_device_info *info); 261 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi); 262 struct mipi_dsi_device * 263 devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host, 264 const struct mipi_dsi_device_info *info); 265 struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np); 266 int mipi_dsi_attach(struct mipi_dsi_device *dsi); 267 int mipi_dsi_detach(struct mipi_dsi_device *dsi); 268 int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi); 269 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi); 270 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi); 271 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi, 272 u16 value); 273 int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable); 274 int mipi_dsi_compression_mode_ext(struct mipi_dsi_device *dsi, bool enable, 275 enum mipi_dsi_compression_algo algo, 276 unsigned int pps_selector); 277 int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi, 278 const struct drm_dsc_picture_parameter_set *pps); 279 280 void mipi_dsi_compression_mode_ext_multi(struct mipi_dsi_multi_context *ctx, 281 bool enable, 282 enum mipi_dsi_compression_algo algo, 283 unsigned int pps_selector); 284 void mipi_dsi_compression_mode_multi(struct mipi_dsi_multi_context *ctx, 285 bool enable); 286 void mipi_dsi_picture_parameter_set_multi(struct mipi_dsi_multi_context *ctx, 287 const struct drm_dsc_picture_parameter_set *pps); 288 289 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload, 290 size_t size); 291 int mipi_dsi_generic_write_chatty(struct mipi_dsi_device *dsi, 292 const void *payload, size_t size); 293 void mipi_dsi_generic_write_multi(struct mipi_dsi_multi_context *ctx, 294 const void *payload, size_t size); 295 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params, 296 size_t num_params, void *data, size_t size); 297 u32 drm_mipi_dsi_get_input_bus_fmt(enum mipi_dsi_pixel_format dsi_format); 298 299 #define mipi_dsi_msleep(ctx, delay) \ 300 do { \ 301 if (!(ctx)->accum_err) \ 302 msleep(delay); \ 303 } while (0) 304 305 #define mipi_dsi_usleep_range(ctx, min, max) \ 306 do { \ 307 if (!(ctx)->accum_err) \ 308 usleep_range(min, max); \ 309 } while (0) 310 311 /** 312 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode 313 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking 314 * information only 315 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both 316 * V-Blanking and H-Blanking information 317 */ 318 enum mipi_dsi_dcs_tear_mode { 319 MIPI_DSI_DCS_TEAR_MODE_VBLANK, 320 MIPI_DSI_DCS_TEAR_MODE_VHBLANK, 321 }; 322 323 #define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2) 324 #define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3) 325 #define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4) 326 #define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5) 327 #define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6) 328 329 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi, 330 const void *data, size_t len); 331 int mipi_dsi_dcs_write_buffer_chatty(struct mipi_dsi_device *dsi, 332 const void *data, size_t len); 333 void mipi_dsi_dcs_write_buffer_multi(struct mipi_dsi_multi_context *ctx, 334 const void *data, size_t len); 335 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd, 336 const void *data, size_t len); 337 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data, 338 size_t len); 339 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi); 340 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi); 341 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode); 342 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format); 343 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi); 344 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi); 345 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi); 346 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi); 347 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start, 348 u16 end); 349 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start, 350 u16 end); 351 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi, 352 enum mipi_dsi_dcs_tear_mode mode); 353 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format); 354 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline); 355 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi, 356 u16 brightness); 357 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi, 358 u16 *brightness); 359 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi, 360 u16 brightness); 361 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi, 362 u16 *brightness); 363 364 void mipi_dsi_dcs_nop_multi(struct mipi_dsi_multi_context *ctx); 365 void mipi_dsi_dcs_enter_sleep_mode_multi(struct mipi_dsi_multi_context *ctx); 366 void mipi_dsi_dcs_exit_sleep_mode_multi(struct mipi_dsi_multi_context *ctx); 367 void mipi_dsi_dcs_set_display_off_multi(struct mipi_dsi_multi_context *ctx); 368 void mipi_dsi_dcs_set_display_on_multi(struct mipi_dsi_multi_context *ctx); 369 void mipi_dsi_dcs_set_tear_on_multi(struct mipi_dsi_multi_context *ctx, 370 enum mipi_dsi_dcs_tear_mode mode); 371 void mipi_dsi_turn_on_peripheral_multi(struct mipi_dsi_multi_context *ctx); 372 void mipi_dsi_dcs_soft_reset_multi(struct mipi_dsi_multi_context *ctx); 373 void mipi_dsi_dcs_set_display_brightness_multi(struct mipi_dsi_multi_context *ctx, 374 u16 brightness); 375 void mipi_dsi_dcs_set_pixel_format_multi(struct mipi_dsi_multi_context *ctx, 376 u8 format); 377 void mipi_dsi_dcs_set_column_address_multi(struct mipi_dsi_multi_context *ctx, 378 u16 start, u16 end); 379 void mipi_dsi_dcs_set_page_address_multi(struct mipi_dsi_multi_context *ctx, 380 u16 start, u16 end); 381 void mipi_dsi_dcs_set_tear_scanline_multi(struct mipi_dsi_multi_context *ctx, 382 u16 scanline); 383 void mipi_dsi_dcs_set_tear_off_multi(struct mipi_dsi_multi_context *ctx); 384 385 /** 386 * mipi_dsi_generic_write_seq - transmit data using a generic write packet 387 * 388 * This macro will print errors for you and will RETURN FROM THE CALLING 389 * FUNCTION (yes this is non-intuitive) upon error. 390 * 391 * Because of the non-intuitive return behavior, THIS MACRO IS DEPRECATED. 392 * Please replace calls of it with mipi_dsi_generic_write_seq_multi(). 393 * 394 * @dsi: DSI peripheral device 395 * @seq: buffer containing the payload 396 */ 397 #define mipi_dsi_generic_write_seq(dsi, seq...) \ 398 do { \ 399 static const u8 d[] = { seq }; \ 400 int ret; \ 401 ret = mipi_dsi_generic_write_chatty(dsi, d, ARRAY_SIZE(d)); \ 402 if (ret < 0) \ 403 return ret; \ 404 } while (0) 405 406 /** 407 * mipi_dsi_generic_write_seq_multi - transmit data using a generic write packet 408 * 409 * This macro will print errors for you and error handling is optimized for 410 * callers that call this multiple times in a row. 411 * 412 * @ctx: Context for multiple DSI transactions 413 * @seq: buffer containing the payload 414 */ 415 #define mipi_dsi_generic_write_seq_multi(ctx, seq...) \ 416 do { \ 417 static const u8 d[] = { seq }; \ 418 mipi_dsi_generic_write_multi(ctx, d, ARRAY_SIZE(d)); \ 419 } while (0) 420 421 /** 422 * mipi_dsi_dcs_write_seq_multi - transmit a DCS command with payload 423 * 424 * This macro will print errors for you and error handling is optimized for 425 * callers that call this multiple times in a row. 426 * 427 * @ctx: Context for multiple DSI transactions 428 * @cmd: Command 429 * @seq: buffer containing data to be transmitted 430 */ 431 #define mipi_dsi_dcs_write_seq_multi(ctx, cmd, seq...) \ 432 do { \ 433 static const u8 d[] = { cmd, seq }; \ 434 mipi_dsi_dcs_write_buffer_multi(ctx, d, ARRAY_SIZE(d)); \ 435 } while (0) 436 437 /** 438 * struct mipi_dsi_driver - DSI driver 439 * @driver: device driver model driver 440 * @probe: callback for device binding 441 * @remove: callback for device unbinding 442 * @shutdown: called at shutdown time to quiesce the device 443 */ 444 struct mipi_dsi_driver { 445 struct device_driver driver; 446 int(*probe)(struct mipi_dsi_device *dsi); 447 void (*remove)(struct mipi_dsi_device *dsi); 448 void (*shutdown)(struct mipi_dsi_device *dsi); 449 }; 450 451 static inline struct mipi_dsi_driver * 452 to_mipi_dsi_driver(struct device_driver *driver) 453 { 454 return container_of(driver, struct mipi_dsi_driver, driver); 455 } 456 457 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi) 458 { 459 return dev_get_drvdata(&dsi->dev); 460 } 461 462 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data) 463 { 464 dev_set_drvdata(&dsi->dev, data); 465 } 466 467 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver, 468 struct module *owner); 469 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver); 470 471 #define mipi_dsi_driver_register(driver) \ 472 mipi_dsi_driver_register_full(driver, THIS_MODULE) 473 474 #define module_mipi_dsi_driver(__mipi_dsi_driver) \ 475 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \ 476 mipi_dsi_driver_unregister) 477 478 #endif /* __DRM_MIPI_DSI__ */ 479