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)
155 enum mipi_dsi_pixel_format {
158 MIPI_DSI_FMT_RGB666_PACKED,
162 #define DSI_DEV_NAME_SIZE 20
165 * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
166 * @type: DSI peripheral chip type
167 * @channel: DSI virtual channel assigned to peripheral
168 * @node: pointer to OF device node or NULL
170 * This is populated and passed to mipi_dsi_device_new to create a new
173 struct mipi_dsi_device_info {
174 char type[DSI_DEV_NAME_SIZE];
176 struct device_node *node;
180 * struct mipi_dsi_device - DSI peripheral device
181 * @host: DSI host for this peripheral
182 * @dev: driver model device node for this peripheral
183 * @name: DSI peripheral chip type
184 * @channel: virtual channel assigned to the peripheral
185 * @format: pixel format for video mode
186 * @lanes: number of active data lanes
187 * @mode_flags: DSI operation mode related flags
188 * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
189 * be set to the real limits of the hardware, zero is only accepted for
191 * @lp_rate: maximum lane frequency for low power mode in hertz, this should
192 * be set to the real limits of the hardware, zero is only accepted for
195 struct mipi_dsi_device {
196 struct mipi_dsi_host *host;
199 char name[DSI_DEV_NAME_SIZE];
200 unsigned int channel;
202 enum mipi_dsi_pixel_format format;
203 unsigned long mode_flags;
204 unsigned long hs_rate;
205 unsigned long lp_rate;
208 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
210 static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
212 return container_of(dev, struct mipi_dsi_device, dev);
216 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
217 * given pixel format defined by the MIPI DSI
219 * @fmt: MIPI DSI pixel format
221 * Returns: The number of bits per pixel of the given pixel format.
223 static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
226 case MIPI_DSI_FMT_RGB888:
227 case MIPI_DSI_FMT_RGB666:
230 case MIPI_DSI_FMT_RGB666_PACKED:
233 case MIPI_DSI_FMT_RGB565:
240 struct mipi_dsi_device *
241 mipi_dsi_device_register_full(struct mipi_dsi_host *host,
242 const struct mipi_dsi_device_info *info);
243 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
244 struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
245 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
246 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
247 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
248 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
249 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
251 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
252 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
253 const struct drm_dsc_picture_parameter_set *pps);
255 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
257 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
258 size_t num_params, void *data, size_t size);
261 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
262 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
264 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
265 * V-Blanking and H-Blanking information
267 enum mipi_dsi_dcs_tear_mode {
268 MIPI_DSI_DCS_TEAR_MODE_VBLANK,
269 MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
272 #define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
273 #define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
274 #define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
275 #define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
276 #define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
278 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
279 const void *data, size_t len);
280 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
281 const void *data, size_t len);
282 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
284 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
285 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
286 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
287 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
288 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
289 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
290 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
291 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
292 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
294 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
296 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
297 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
298 enum mipi_dsi_dcs_tear_mode mode);
299 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
300 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
301 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
303 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
307 * struct mipi_dsi_driver - DSI driver
308 * @driver: device driver model driver
309 * @probe: callback for device binding
310 * @remove: callback for device unbinding
311 * @shutdown: called at shutdown time to quiesce the device
313 struct mipi_dsi_driver {
314 struct device_driver driver;
315 int(*probe)(struct mipi_dsi_device *dsi);
316 int(*remove)(struct mipi_dsi_device *dsi);
317 void (*shutdown)(struct mipi_dsi_device *dsi);
320 static inline struct mipi_dsi_driver *
321 to_mipi_dsi_driver(struct device_driver *driver)
323 return container_of(driver, struct mipi_dsi_driver, driver);
326 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
328 return dev_get_drvdata(&dsi->dev);
331 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
333 dev_set_drvdata(&dsi->dev, data);
336 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
337 struct module *owner);
338 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
340 #define mipi_dsi_driver_register(driver) \
341 mipi_dsi_driver_register_full(driver, THIS_MODULE)
343 #define module_mipi_dsi_driver(__mipi_dsi_driver) \
344 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
345 mipi_dsi_driver_unregister)
347 #endif /* __DRM_MIPI_DSI__ */