include/drm/drm_mipi_dsi.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * MIPI DSI Bus
5  * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
25  * struct mipi_dsi_msg - read/write DSI buffer
50  * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
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
73  * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
81  * Note that typically DSI packet transmission is atomic, so the .transfer()
92 		      struct mipi_dsi_device *dsi);
94 		      struct mipi_dsi_device *dsi);
100  * struct mipi_dsi_host - DSI host device
101  * @dev: driver model device node for this DSI host
102  * @ops: DSI host operations
115 /* DSI mode flags */
125 /* enable hsync-end packets in vsync-pulse and v-porch area */
127 /* disable hfront-porch area */
129 /* disable hback-porch area */
131 /* disable hsync-active area */
137 /* device supports non-continuous clock behavior (DSI spec 5.6.1) */
154  * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
155  * @type: DSI peripheral chip type
156  * @channel: DSI virtual channel assigned to peripheral
160  * DSI device
169  * struct mipi_dsi_device - DSI peripheral device
170  * @host: DSI host for this peripheral
172  * @attached: the DSI device has been successfully attached
173  * @name: DSI peripheral chip type
177  * @mode_flags: DSI operation mode related flags
202  * struct mipi_dsi_multi_context - Context to call multiple MIPI DSI funcs in a row
206 	 * @dsi: Pointer to the MIPI DSI device
208 	struct mipi_dsi_device *dsi;  member
215 	 * non-zero value then the function will be a noop. This allows calling
222 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
227  * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
228  *                                given pixel format defined by the MIPI DSI
230  * @fmt: MIPI DSI pixel format
248 	return -EINVAL;  in mipi_dsi_pixel_format_to_bpp()
254 	/* other two values are reserved, DSI 1.3 */
260 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
265 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
266 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
267 int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);
268 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
269 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
270 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
272 int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
273 int mipi_dsi_compression_mode_ext(struct mipi_dsi_device *dsi, bool enable,
276 int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
286 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
288 int mipi_dsi_generic_write_chatty(struct mipi_dsi_device *dsi,
292 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
297 		if (!(ctx)->accum_err)	\
303 		if (!(ctx)->accum_err)		\
308  * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
309  * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
312  *    V-Blanking and H-Blanking information
325 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
327 int mipi_dsi_dcs_write_buffer_chatty(struct mipi_dsi_device *dsi,
331 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
333 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
335 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
336 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
337 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
338 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
339 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
340 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
341 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
342 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
343 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
345 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
347 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
348 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
350 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
351 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
352 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
354 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
356 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
358 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
382  * mipi_dsi_generic_write_seq - transmit data using a generic write packet
385  * FUNCTION (yes this is non-intuitive) upon error.
387  * Because of the non-intuitive return behavior, THIS MACRO IS DEPRECATED.
390  * @dsi: DSI peripheral device
393 #define mipi_dsi_generic_write_seq(dsi, seq...)                                \  argument
397 		ret = mipi_dsi_generic_write_chatty(dsi, d, ARRAY_SIZE(d));    \
403  * mipi_dsi_generic_write_seq_multi - transmit data using a generic write packet
408  * @ctx: Context for multiple DSI transactions
418  * mipi_dsi_dcs_write_seq - transmit a DCS command with payload
421  * FUNCTION (yes this is non-intuitive) upon error.
423  * Because of the non-intuitive return behavior, THIS MACRO IS DEPRECATED.
426  * @dsi: DSI peripheral device
430 #define mipi_dsi_dcs_write_seq(dsi, cmd, seq...)                               \  argument
434 		ret = mipi_dsi_dcs_write_buffer_chatty(dsi, d, ARRAY_SIZE(d)); \
440  * mipi_dsi_dcs_write_seq_multi - transmit a DCS command with payload
445  * @ctx: Context for multiple DSI transactions
456  * struct mipi_dsi_driver - DSI 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);
475 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)  in mipi_dsi_get_drvdata()  argument
477 	return dev_get_drvdata(&dsi->dev);  in mipi_dsi_get_drvdata()
480 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)  in mipi_dsi_set_drvdata()  argument
482 	dev_set_drvdata(&dsi->dev, data);  in mipi_dsi_set_drvdata()