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.
28  * struct mipi_dsi_msg - read/write DSI buffer
57  * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
75  * struct mipi_dsi_host_ops - DSI bus operations
76  * @attach: attach DSI device to DSI host
77  * @detach: detach DSI device from DSI host
78  * @transfer: transmit a DSI packet
80  * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
88  * Note that typically DSI packet transmission is atomic, so the .transfer()
94 		      struct mipi_dsi_device *dsi);
96 		      struct mipi_dsi_device *dsi);
102  * struct mipi_dsi_host - DSI host device
103  * @dev: driver model device node for this DSI host
104  * @ops: DSI host operations
117 /* DSI mode flags */
127 /* enable hsync-end packets in vsync-pulse and v-porch area */
129 /* disable hfront-porch area */
131 /* disable hback-porch area */
133 /* disable hsync-active area */
139 /* device supports non-continuous clock behavior (DSI spec 5.6.1) */
158  * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
159  * @type: DSI peripheral chip type
160  * @channel: DSI virtual channel assigned to peripheral
164  * DSI device
173  * struct mipi_dsi_device - DSI peripheral device
174  * @host: DSI host for this peripheral
176  * @name: DSI peripheral chip type
179  * @lanes: number of active data lanes
180  * @mode_flags: DSI operation mode related flags
194 	unsigned int lanes;  member
201 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
209  * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
210  *                                given pixel format defined by the MIPI DSI
212  * @fmt: MIPI DSI pixel format
230 	return -EINVAL;  in mipi_dsi_pixel_format_to_bpp()
236 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
238 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
239 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
240 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
241 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
242 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
244 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
245 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
248 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
250 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
254  * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
255  * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
258  *    V-Blanking and H-Blanking information
271 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
273 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
275 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
277 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
278 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
279 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
280 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
281 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
282 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
283 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
284 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
285 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
287 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
289 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
290 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
292 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
293 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
294 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
296 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
300  * struct mipi_dsi_driver - DSI driver
308 	int(*probe)(struct mipi_dsi_device *dsi);
309 	int(*remove)(struct mipi_dsi_device *dsi);
310 	void (*shutdown)(struct mipi_dsi_device *dsi);
319 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)  in mipi_dsi_get_drvdata()  argument
321 	return dev_get_drvdata(&dsi->dev);  in mipi_dsi_get_drvdata()
324 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)  in mipi_dsi_set_drvdata()  argument
326 	dev_set_drvdata(&dsi->dev, data);  in mipi_dsi_set_drvdata()