1 /* SPDX-License-Identifier: GPL-2.0-only */
5 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
6 * Andrzej Hajda <a.hajda@samsung.com>
9 #ifndef __DRM_MIPI_DSI_H__
10 #define __DRM_MIPI_DSI_H__
12 #include <linux/device.h>
15 struct mipi_dsi_device;
16 struct drm_dsc_picture_parameter_set;
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)
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
45 bool mipi_dsi_packet_format_is_short(u8 type);
46 bool mipi_dsi_packet_format_is_long(u8 type);
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
56 struct mipi_dsi_packet {
59 size_t payload_length;
63 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
64 const struct mipi_dsi_msg *msg);
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
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
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.
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
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);
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
104 struct mipi_dsi_host {
106 const struct mipi_dsi_host_ops *ops;
107 struct list_head list;
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);
116 /* Video mode display.
117 * Not set denotes a command mode display.
119 #define MIPI_DSI_MODE_VIDEO BIT(0)
121 * Link frequency to be configured via platform configuration.
122 * This should always be set in conjunction with MIPI_DSI_MODE_VIDEO.
123 * (DSI spec V1.1 8.11.4)
125 #define MIPI_DSI_MODE_VIDEO_BURST BIT(1)
127 * Not set denotes sync event mode. (DSI spec V1.1 8.11.2)
129 #define MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2)
130 /* Enable auto vertical count mode */
131 #define MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3)
132 /* Enable hsync-end packets in vsync-pulse and v-porch area */
133 #define MIPI_DSI_MODE_VIDEO_HSE BIT(4)
134 /* Transmit NULL packets or LP mode during hfront-porch area.
135 * Not set denotes sending a blanking packet instead. (DSI spec V1.1 8.11.1)
137 #define MIPI_DSI_MODE_VIDEO_NO_HFP BIT(5)
138 /* Transmit NULL packets or LP mode during hback-porch area.
139 * Not set denotes sending a blanking packet instead. (DSI spec V1.1 8.11.1)
141 #define MIPI_DSI_MODE_VIDEO_NO_HBP BIT(6)
142 /* Transmit NULL packets or LP mode during hsync-active area.
143 * Not set denotes sending a blanking packet instead. (DSI spec V1.1 8.11.1)
145 #define MIPI_DSI_MODE_VIDEO_NO_HSA BIT(7)
146 /* Flush display FIFO on vsync pulse */
147 #define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8)
148 /* Disable EoT packets in HS mode. (DSI spec V1.1 8.1) */
149 #define MIPI_DSI_MODE_NO_EOT_PACKET BIT(9)
150 /* Device supports non-continuous clock behavior (DSI spec V1.1 5.6.1) */
151 #define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)
152 /* Transmit data in low power */
153 #define MIPI_DSI_MODE_LPM BIT(11)
154 /* transmit data ending at the same time for all lanes within one hsync */
155 #define MIPI_DSI_HS_PKT_END_ALIGNED BIT(12)
157 enum mipi_dsi_pixel_format {
160 MIPI_DSI_FMT_RGB666_PACKED,
164 #define DSI_DEV_NAME_SIZE 20
167 * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
168 * @type: DSI peripheral chip type
169 * @channel: DSI virtual channel assigned to peripheral
170 * @node: pointer to OF device node or NULL
172 * This is populated and passed to mipi_dsi_device_new to create a new
175 struct mipi_dsi_device_info {
176 char type[DSI_DEV_NAME_SIZE];
178 struct device_node *node;
182 * struct mipi_dsi_device - DSI peripheral device
183 * @host: DSI host for this peripheral
184 * @dev: driver model device node for this peripheral
185 * @attached: the DSI device has been successfully attached
186 * @name: DSI peripheral chip type
187 * @channel: virtual channel assigned to the peripheral
188 * @format: pixel format for video mode
189 * @lanes: number of active data lanes
190 * @mode_flags: DSI operation mode related flags
191 * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
192 * be set to the real limits of the hardware, zero is only accepted for
194 * @lp_rate: maximum lane frequency for low power mode in hertz, this should
195 * be set to the real limits of the hardware, zero is only accepted for
197 * @dsc: panel/bridge DSC pps payload to be sent
199 struct mipi_dsi_device {
200 struct mipi_dsi_host *host;
204 char name[DSI_DEV_NAME_SIZE];
205 unsigned int channel;
207 enum mipi_dsi_pixel_format format;
208 unsigned long mode_flags;
209 unsigned long hs_rate;
210 unsigned long lp_rate;
211 struct drm_dsc_config *dsc;
214 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
216 #define to_mipi_dsi_device(__dev) container_of_const(__dev, struct mipi_dsi_device, dev)
219 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
220 * given pixel format defined by the MIPI DSI
222 * @fmt: MIPI DSI pixel format
224 * Returns: The number of bits per pixel of the given pixel format.
226 static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
229 case MIPI_DSI_FMT_RGB888:
230 case MIPI_DSI_FMT_RGB666:
233 case MIPI_DSI_FMT_RGB666_PACKED:
236 case MIPI_DSI_FMT_RGB565:
243 struct mipi_dsi_device *
244 mipi_dsi_device_register_full(struct mipi_dsi_host *host,
245 const struct mipi_dsi_device_info *info);
246 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
247 struct mipi_dsi_device *
248 devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host,
249 const struct mipi_dsi_device_info *info);
250 struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
251 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
252 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
253 int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);
254 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
255 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
256 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
258 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
259 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
260 const struct drm_dsc_picture_parameter_set *pps);
262 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
264 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
265 size_t num_params, void *data, size_t size);
268 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
269 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
271 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
272 * V-Blanking and H-Blanking information
274 enum mipi_dsi_dcs_tear_mode {
275 MIPI_DSI_DCS_TEAR_MODE_VBLANK,
276 MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
279 #define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
280 #define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
281 #define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
282 #define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
283 #define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
285 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
286 const void *data, size_t len);
287 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
288 const void *data, size_t len);
289 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
291 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
292 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
293 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
294 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
295 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
296 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
297 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
298 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
299 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
301 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
303 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
304 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
305 enum mipi_dsi_dcs_tear_mode mode);
306 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
307 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
308 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
310 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
312 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
314 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
318 * mipi_dsi_generic_write_seq - transmit data using a generic write packet
319 * @dsi: DSI peripheral device
320 * @seq: buffer containing the payload
322 #define mipi_dsi_generic_write_seq(dsi, seq...) \
324 static const u8 d[] = { seq }; \
325 struct device *dev = &dsi->dev; \
327 ret = mipi_dsi_generic_write(dsi, d, ARRAY_SIZE(d)); \
329 dev_err_ratelimited(dev, "transmit data failed: %d\n", \
336 * mipi_dsi_dcs_write_seq - transmit a DCS command with payload
337 * @dsi: DSI peripheral device
339 * @seq: buffer containing data to be transmitted
341 #define mipi_dsi_dcs_write_seq(dsi, cmd, seq...) \
343 static const u8 d[] = { cmd, seq }; \
344 struct device *dev = &dsi->dev; \
346 ret = mipi_dsi_dcs_write_buffer(dsi, d, ARRAY_SIZE(d)); \
348 dev_err_ratelimited( \
349 dev, "sending command %#02x failed: %d\n", \
356 * struct mipi_dsi_driver - DSI driver
357 * @driver: device driver model driver
358 * @probe: callback for device binding
359 * @remove: callback for device unbinding
360 * @shutdown: called at shutdown time to quiesce the device
362 struct mipi_dsi_driver {
363 struct device_driver driver;
364 int(*probe)(struct mipi_dsi_device *dsi);
365 void (*remove)(struct mipi_dsi_device *dsi);
366 void (*shutdown)(struct mipi_dsi_device *dsi);
369 static inline struct mipi_dsi_driver *
370 to_mipi_dsi_driver(struct device_driver *driver)
372 return container_of(driver, struct mipi_dsi_driver, driver);
375 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
377 return dev_get_drvdata(&dsi->dev);
380 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
382 dev_set_drvdata(&dsi->dev, data);
385 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
386 struct module *owner);
387 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
389 #define mipi_dsi_driver_register(driver) \
390 mipi_dsi_driver_register_full(driver, THIS_MODULE)
392 #define module_mipi_dsi_driver(__mipi_dsi_driver) \
393 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
394 mipi_dsi_driver_unregister)
396 #endif /* __DRM_MIPI_DSI__ */