497 lines · c
1/* SPDX-License-Identifier: GPL-2.0-only */2/*3 * MIPI DSI Bus4 *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 15struct mipi_dsi_host;16struct mipi_dsi_device;17struct 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 buffer26 * @channel: virtual channel id27 * @type: payload data type28 * @flags: flags controlling this message transmission29 * @tx_len: length of @tx_buf30 * @tx_buf: data to be written31 * @rx_len: length of @rx_buf32 * @rx_buf: data to be read, or NULL33 */34struct 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 46bool mipi_dsi_packet_format_is_short(u8 type);47bool mipi_dsi_packet_format_is_long(u8 type);48 49/**50 * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format51 * @size: size (in bytes) of the packet52 * @header: the four bytes that make up the header (Data ID, Word Count or53 * Packet Data, and ECC)54 * @payload_length: number of bytes in the payload55 * @payload: a pointer to a buffer containing the payload, if any56 */57struct mipi_dsi_packet {58 size_t size;59 u8 header[4];60 size_t payload_length;61 const u8 *payload;62};63 64int 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 operations69 * @attach: attach DSI device to DSI host70 * @detach: detach DSI device from DSI host71 * @transfer: transmit a DSI packet72 *73 * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg74 * structures. This structure contains information about the type of packet75 * being transmitted as well as the transmit and receive buffers. When an76 * error is encountered during transmission, this function will return a77 * negative error code. On success it shall return the number of bytes78 * transmitted for write packets or the number of bytes received for read79 * 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 bytes83 * contained in the transmit buffer on success.84 *85 * Also note that those callbacks can be called no matter the state the86 * host is in. Drivers that need the underlying device to be powered to87 * perform these operations will first need to make sure it's been88 * properly enabled.89 */90struct 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 device101 * @dev: driver model device node for this DSI host102 * @ops: DSI host operations103 * @list: list management104 */105struct mipi_dsi_host {106 struct device *dev;107 const struct mipi_dsi_host_ops *ops;108 struct list_head list;109};110 111int mipi_dsi_host_register(struct mipi_dsi_host *host);112void mipi_dsi_host_unregister(struct mipi_dsi_host *host);113struct 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/* flush display FIFO on vsync pulse */134#define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8)135/* disable EoT packets in HS mode */136#define MIPI_DSI_MODE_NO_EOT_PACKET BIT(9)137/* device supports non-continuous clock behavior (DSI spec 5.6.1) */138#define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)139/* transmit data in low power */140#define MIPI_DSI_MODE_LPM BIT(11)141/* transmit data ending at the same time for all lanes within one hsync */142#define MIPI_DSI_HS_PKT_END_ALIGNED BIT(12)143 144enum mipi_dsi_pixel_format {145 MIPI_DSI_FMT_RGB888,146 MIPI_DSI_FMT_RGB666,147 MIPI_DSI_FMT_RGB666_PACKED,148 MIPI_DSI_FMT_RGB565,149};150 151#define DSI_DEV_NAME_SIZE 20152 153/**154 * struct mipi_dsi_device_info - template for creating a mipi_dsi_device155 * @type: DSI peripheral chip type156 * @channel: DSI virtual channel assigned to peripheral157 * @node: pointer to OF device node or NULL158 *159 * This is populated and passed to mipi_dsi_device_new to create a new160 * DSI device161 */162struct mipi_dsi_device_info {163 char type[DSI_DEV_NAME_SIZE];164 u32 channel;165 struct device_node *node;166};167 168/**169 * struct mipi_dsi_device - DSI peripheral device170 * @host: DSI host for this peripheral171 * @dev: driver model device node for this peripheral172 * @attached: the DSI device has been successfully attached173 * @name: DSI peripheral chip type174 * @channel: virtual channel assigned to the peripheral175 * @format: pixel format for video mode176 * @lanes: number of active data lanes177 * @mode_flags: DSI operation mode related flags178 * @hs_rate: maximum lane frequency for high speed mode in hertz, this should179 * be set to the real limits of the hardware, zero is only accepted for180 * legacy drivers181 * @lp_rate: maximum lane frequency for low power mode in hertz, this should182 * be set to the real limits of the hardware, zero is only accepted for183 * legacy drivers184 * @dsc: panel/bridge DSC pps payload to be sent185 */186struct mipi_dsi_device {187 struct mipi_dsi_host *host;188 struct device dev;189 bool attached;190 191 char name[DSI_DEV_NAME_SIZE];192 unsigned int channel;193 unsigned int lanes;194 enum mipi_dsi_pixel_format format;195 unsigned long mode_flags;196 unsigned long hs_rate;197 unsigned long lp_rate;198 struct drm_dsc_config *dsc;199};200 201/**202 * struct mipi_dsi_multi_context - Context to call multiple MIPI DSI funcs in a row203 */204struct mipi_dsi_multi_context {205 /**206 * @dsi: Pointer to the MIPI DSI device207 */208 struct mipi_dsi_device *dsi;209 210 /**211 * @accum_err: Storage for the accumulated error over the multiple calls212 *213 * Init to 0. If a function encounters an error then the error code214 * will be stored here. If you call a function and this points to a215 * non-zero value then the function will be a noop. This allows calling216 * a function many times in a row and just checking the error at the217 * end to see if any of them failed.218 */219 int accum_err;220};221 222#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"223 224#define to_mipi_dsi_device(__dev) container_of_const(__dev, struct mipi_dsi_device, dev)225 226/**227 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any228 * given pixel format defined by the MIPI DSI229 * specification230 * @fmt: MIPI DSI pixel format231 *232 * Returns: The number of bits per pixel of the given pixel format.233 */234static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)235{236 switch (fmt) {237 case MIPI_DSI_FMT_RGB888:238 case MIPI_DSI_FMT_RGB666:239 return 24;240 241 case MIPI_DSI_FMT_RGB666_PACKED:242 return 18;243 244 case MIPI_DSI_FMT_RGB565:245 return 16;246 }247 248 return -EINVAL;249}250 251enum mipi_dsi_compression_algo {252 MIPI_DSI_COMPRESSION_DSC = 0,253 MIPI_DSI_COMPRESSION_VENDOR = 3,254 /* other two values are reserved, DSI 1.3 */255};256 257struct mipi_dsi_device *258mipi_dsi_device_register_full(struct mipi_dsi_host *host,259 const struct mipi_dsi_device_info *info);260void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);261struct mipi_dsi_device *262devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host,263 const struct mipi_dsi_device_info *info);264struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);265int mipi_dsi_attach(struct mipi_dsi_device *dsi);266int mipi_dsi_detach(struct mipi_dsi_device *dsi);267int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);268int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);269int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);270int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,271 u16 value);272int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);273int mipi_dsi_compression_mode_ext(struct mipi_dsi_device *dsi, bool enable,274 enum mipi_dsi_compression_algo algo,275 unsigned int pps_selector);276int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,277 const struct drm_dsc_picture_parameter_set *pps);278 279void mipi_dsi_compression_mode_ext_multi(struct mipi_dsi_multi_context *ctx,280 bool enable,281 enum mipi_dsi_compression_algo algo,282 unsigned int pps_selector);283void mipi_dsi_picture_parameter_set_multi(struct mipi_dsi_multi_context *ctx,284 const struct drm_dsc_picture_parameter_set *pps);285 286ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,287 size_t size);288int mipi_dsi_generic_write_chatty(struct mipi_dsi_device *dsi,289 const void *payload, size_t size);290void mipi_dsi_generic_write_multi(struct mipi_dsi_multi_context *ctx,291 const void *payload, size_t size);292ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,293 size_t num_params, void *data, size_t size);294 295#define mipi_dsi_msleep(ctx, delay) \296 do { \297 if (!(ctx)->accum_err) \298 msleep(delay); \299 } while (0)300 301#define mipi_dsi_usleep_range(ctx, min, max) \302 do { \303 if (!(ctx)->accum_err) \304 usleep_range(min, max); \305 } while (0)306 307/**308 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode309 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking310 * information only311 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both312 * V-Blanking and H-Blanking information313 */314enum mipi_dsi_dcs_tear_mode {315 MIPI_DSI_DCS_TEAR_MODE_VBLANK,316 MIPI_DSI_DCS_TEAR_MODE_VHBLANK,317};318 319#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)320#define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)321#define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)322#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)323#define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)324 325ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,326 const void *data, size_t len);327int mipi_dsi_dcs_write_buffer_chatty(struct mipi_dsi_device *dsi,328 const void *data, size_t len);329void mipi_dsi_dcs_write_buffer_multi(struct mipi_dsi_multi_context *ctx,330 const void *data, size_t len);331ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,332 const void *data, size_t len);333ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,334 size_t len);335int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);336int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);337int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);338int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);339int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);340int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);341int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);342int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);343int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,344 u16 end);345int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,346 u16 end);347int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);348int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,349 enum mipi_dsi_dcs_tear_mode mode);350int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);351int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);352int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,353 u16 brightness);354int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,355 u16 *brightness);356int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,357 u16 brightness);358int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,359 u16 *brightness);360 361void mipi_dsi_dcs_nop_multi(struct mipi_dsi_multi_context *ctx);362void mipi_dsi_dcs_enter_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);363void mipi_dsi_dcs_exit_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);364void mipi_dsi_dcs_set_display_off_multi(struct mipi_dsi_multi_context *ctx);365void mipi_dsi_dcs_set_display_on_multi(struct mipi_dsi_multi_context *ctx);366void mipi_dsi_dcs_set_tear_on_multi(struct mipi_dsi_multi_context *ctx,367 enum mipi_dsi_dcs_tear_mode mode);368void mipi_dsi_turn_on_peripheral_multi(struct mipi_dsi_multi_context *ctx);369void mipi_dsi_dcs_soft_reset_multi(struct mipi_dsi_multi_context *ctx);370void mipi_dsi_dcs_set_display_brightness_multi(struct mipi_dsi_multi_context *ctx,371 u16 brightness);372void mipi_dsi_dcs_set_pixel_format_multi(struct mipi_dsi_multi_context *ctx,373 u8 format);374void mipi_dsi_dcs_set_column_address_multi(struct mipi_dsi_multi_context *ctx,375 u16 start, u16 end);376void mipi_dsi_dcs_set_page_address_multi(struct mipi_dsi_multi_context *ctx,377 u16 start, u16 end);378void mipi_dsi_dcs_set_tear_scanline_multi(struct mipi_dsi_multi_context *ctx,379 u16 scanline);380 381/**382 * mipi_dsi_generic_write_seq - transmit data using a generic write packet383 *384 * This macro will print errors for you and will RETURN FROM THE CALLING385 * FUNCTION (yes this is non-intuitive) upon error.386 *387 * Because of the non-intuitive return behavior, THIS MACRO IS DEPRECATED.388 * Please replace calls of it with mipi_dsi_generic_write_seq_multi().389 *390 * @dsi: DSI peripheral device391 * @seq: buffer containing the payload392 */393#define mipi_dsi_generic_write_seq(dsi, seq...) \394 do { \395 static const u8 d[] = { seq }; \396 int ret; \397 ret = mipi_dsi_generic_write_chatty(dsi, d, ARRAY_SIZE(d)); \398 if (ret < 0) \399 return ret; \400 } while (0)401 402/**403 * mipi_dsi_generic_write_seq_multi - transmit data using a generic write packet404 *405 * This macro will print errors for you and error handling is optimized for406 * callers that call this multiple times in a row.407 *408 * @ctx: Context for multiple DSI transactions409 * @seq: buffer containing the payload410 */411#define mipi_dsi_generic_write_seq_multi(ctx, seq...) \412 do { \413 static const u8 d[] = { seq }; \414 mipi_dsi_generic_write_multi(ctx, d, ARRAY_SIZE(d)); \415 } while (0)416 417/**418 * mipi_dsi_dcs_write_seq - transmit a DCS command with payload419 *420 * This macro will print errors for you and will RETURN FROM THE CALLING421 * FUNCTION (yes this is non-intuitive) upon error.422 *423 * Because of the non-intuitive return behavior, THIS MACRO IS DEPRECATED.424 * Please replace calls of it with mipi_dsi_dcs_write_seq_multi().425 *426 * @dsi: DSI peripheral device427 * @cmd: Command428 * @seq: buffer containing data to be transmitted429 */430#define mipi_dsi_dcs_write_seq(dsi, cmd, seq...) \431 do { \432 static const u8 d[] = { cmd, seq }; \433 int ret; \434 ret = mipi_dsi_dcs_write_buffer_chatty(dsi, d, ARRAY_SIZE(d)); \435 if (ret < 0) \436 return ret; \437 } while (0)438 439/**440 * mipi_dsi_dcs_write_seq_multi - transmit a DCS command with payload441 *442 * This macro will print errors for you and error handling is optimized for443 * callers that call this multiple times in a row.444 *445 * @ctx: Context for multiple DSI transactions446 * @cmd: Command447 * @seq: buffer containing data to be transmitted448 */449#define mipi_dsi_dcs_write_seq_multi(ctx, cmd, seq...) \450 do { \451 static const u8 d[] = { cmd, seq }; \452 mipi_dsi_dcs_write_buffer_multi(ctx, d, ARRAY_SIZE(d)); \453 } while (0)454 455/**456 * struct mipi_dsi_driver - DSI driver457 * @driver: device driver model driver458 * @probe: callback for device binding459 * @remove: callback for device unbinding460 * @shutdown: called at shutdown time to quiesce the device461 */462struct mipi_dsi_driver {463 struct device_driver driver;464 int(*probe)(struct mipi_dsi_device *dsi);465 void (*remove)(struct mipi_dsi_device *dsi);466 void (*shutdown)(struct mipi_dsi_device *dsi);467};468 469static inline struct mipi_dsi_driver *470to_mipi_dsi_driver(struct device_driver *driver)471{472 return container_of(driver, struct mipi_dsi_driver, driver);473}474 475static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)476{477 return dev_get_drvdata(&dsi->dev);478}479 480static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)481{482 dev_set_drvdata(&dsi->dev, data);483}484 485int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,486 struct module *owner);487void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);488 489#define mipi_dsi_driver_register(driver) \490 mipi_dsi_driver_register_full(driver, THIS_MODULE)491 492#define module_mipi_dsi_driver(__mipi_dsi_driver) \493 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \494 mipi_dsi_driver_unregister)495 496#endif /* __DRM_MIPI_DSI__ */497