1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * MIPI DSI Bus
4  *
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 
14 struct mipi_dsi_host;
15 struct mipi_dsi_device;
16 struct drm_dsc_picture_parameter_set;
17 
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)
22 
23 /**
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
32  */
33 struct mipi_dsi_msg {
34 	u8 channel;
35 	u8 type;
36 	u16 flags;
37 
38 	size_t tx_len;
39 	const void *tx_buf;
40 
41 	size_t rx_len;
42 	void *rx_buf;
43 };
44 
45 bool mipi_dsi_packet_format_is_short(u8 type);
46 bool mipi_dsi_packet_format_is_long(u8 type);
47 
48 /**
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
55  */
56 struct mipi_dsi_packet {
57 	size_t size;
58 	u8 header[4];
59 	size_t payload_length;
60 	const u8 *payload;
61 };
62 
63 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
64 			   const struct mipi_dsi_msg *msg);
65 
66 /**
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
71  *
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
78  * packets.
79  *
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.
83  *
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
87  * properly enabled.
88  */
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);
96 };
97 
98 /**
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
103  */
104 struct mipi_dsi_host {
105 	struct device *dev;
106 	const struct mipi_dsi_host_ops *ops;
107 	struct list_head list;
108 };
109 
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);
113 
114 /* DSI mode flags */
115 
116 /* video mode */
117 #define MIPI_DSI_MODE_VIDEO		BIT(0)
118 /* video burst mode */
119 #define MIPI_DSI_MODE_VIDEO_BURST	BIT(1)
120 /* video pulse mode */
121 #define MIPI_DSI_MODE_VIDEO_SYNC_PULSE	BIT(2)
122 /* enable auto vertical count mode */
123 #define MIPI_DSI_MODE_VIDEO_AUTO_VERT	BIT(3)
124 /* enable hsync-end packets in vsync-pulse and v-porch area */
125 #define MIPI_DSI_MODE_VIDEO_HSE		BIT(4)
126 /* disable hfront-porch area */
127 #define MIPI_DSI_MODE_VIDEO_NO_HFP	BIT(5)
128 /* disable hback-porch area */
129 #define MIPI_DSI_MODE_VIDEO_NO_HBP	BIT(6)
130 /* disable hsync-active area */
131 #define MIPI_DSI_MODE_VIDEO_NO_HSA	BIT(7)
132 /* flush display FIFO on vsync pulse */
133 #define MIPI_DSI_MODE_VSYNC_FLUSH	BIT(8)
134 /* disable EoT packets in HS mode */
135 #define MIPI_DSI_MODE_NO_EOT_PACKET	BIT(9)
136 /* device supports non-continuous clock behavior (DSI spec 5.6.1) */
137 #define MIPI_DSI_CLOCK_NON_CONTINUOUS	BIT(10)
138 /* transmit data in low power */
139 #define MIPI_DSI_MODE_LPM		BIT(11)
140 /* transmit data ending at the same time for all lanes within one hsync */
141 #define MIPI_DSI_HS_PKT_END_ALIGNED	BIT(12)
142 
143 enum mipi_dsi_pixel_format {
144 	MIPI_DSI_FMT_RGB888,
145 	MIPI_DSI_FMT_RGB666,
146 	MIPI_DSI_FMT_RGB666_PACKED,
147 	MIPI_DSI_FMT_RGB565,
148 };
149 
150 #define DSI_DEV_NAME_SIZE		20
151 
152 /**
153  * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
154  * @type: DSI peripheral chip type
155  * @channel: DSI virtual channel assigned to peripheral
156  * @node: pointer to OF device node or NULL
157  *
158  * This is populated and passed to mipi_dsi_device_new to create a new
159  * DSI device
160  */
161 struct mipi_dsi_device_info {
162 	char type[DSI_DEV_NAME_SIZE];
163 	u32 channel;
164 	struct device_node *node;
165 };
166 
167 /**
168  * struct mipi_dsi_device - DSI peripheral device
169  * @host: DSI host for this peripheral
170  * @dev: driver model device node for this peripheral
171  * @name: DSI peripheral chip type
172  * @channel: virtual channel assigned to the peripheral
173  * @format: pixel format for video mode
174  * @lanes: number of active data lanes
175  * @mode_flags: DSI operation mode related flags
176  * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
177  * be set to the real limits of the hardware, zero is only accepted for
178  * legacy drivers
179  * @lp_rate: maximum lane frequency for low power mode in hertz, this should
180  * be set to the real limits of the hardware, zero is only accepted for
181  * legacy drivers
182  */
183 struct mipi_dsi_device {
184 	struct mipi_dsi_host *host;
185 	struct device dev;
186 
187 	char name[DSI_DEV_NAME_SIZE];
188 	unsigned int channel;
189 	unsigned int lanes;
190 	enum mipi_dsi_pixel_format format;
191 	unsigned long mode_flags;
192 	unsigned long hs_rate;
193 	unsigned long lp_rate;
194 };
195 
196 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
197 
to_mipi_dsi_device(struct device * dev)198 static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
199 {
200 	return container_of(dev, struct mipi_dsi_device, dev);
201 }
202 
203 /**
204  * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
205  *                                given pixel format defined by the MIPI DSI
206  *                                specification
207  * @fmt: MIPI DSI pixel format
208  *
209  * Returns: The number of bits per pixel of the given pixel format.
210  */
mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)211 static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
212 {
213 	switch (fmt) {
214 	case MIPI_DSI_FMT_RGB888:
215 	case MIPI_DSI_FMT_RGB666:
216 		return 24;
217 
218 	case MIPI_DSI_FMT_RGB666_PACKED:
219 		return 18;
220 
221 	case MIPI_DSI_FMT_RGB565:
222 		return 16;
223 	}
224 
225 	return -EINVAL;
226 }
227 
228 struct mipi_dsi_device *
229 mipi_dsi_device_register_full(struct mipi_dsi_host *host,
230 			      const struct mipi_dsi_device_info *info);
231 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
232 struct mipi_dsi_device *
233 devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host,
234 				   const struct mipi_dsi_device_info *info);
235 struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
236 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
237 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
238 int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);
239 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
240 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
241 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
242 					    u16 value);
243 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
244 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
245 				       const struct drm_dsc_picture_parameter_set *pps);
246 
247 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
248 			       size_t size);
249 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
250 			      size_t num_params, void *data, size_t size);
251 
252 /**
253  * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
254  * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
255  *    information only
256  * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
257  *    V-Blanking and H-Blanking information
258  */
259 enum mipi_dsi_dcs_tear_mode {
260 	MIPI_DSI_DCS_TEAR_MODE_VBLANK,
261 	MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
262 };
263 
264 #define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
265 #define MIPI_DSI_DCS_POWER_MODE_NORMAL  (1 << 3)
266 #define MIPI_DSI_DCS_POWER_MODE_SLEEP   (1 << 4)
267 #define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
268 #define MIPI_DSI_DCS_POWER_MODE_IDLE    (1 << 6)
269 
270 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
271 				  const void *data, size_t len);
272 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
273 			   const void *data, size_t len);
274 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
275 			  size_t len);
276 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
277 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
278 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
279 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
280 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
281 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
282 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
283 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
284 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
285 				    u16 end);
286 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
287 				  u16 end);
288 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
289 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
290 			     enum mipi_dsi_dcs_tear_mode mode);
291 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
292 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
293 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
294 					u16 brightness);
295 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
296 					u16 *brightness);
297 
298 /**
299  * struct mipi_dsi_driver - DSI driver
300  * @driver: device driver model driver
301  * @probe: callback for device binding
302  * @remove: callback for device unbinding
303  * @shutdown: called at shutdown time to quiesce the device
304  */
305 struct mipi_dsi_driver {
306 	struct device_driver driver;
307 	int(*probe)(struct mipi_dsi_device *dsi);
308 	int(*remove)(struct mipi_dsi_device *dsi);
309 	void (*shutdown)(struct mipi_dsi_device *dsi);
310 };
311 
312 static inline struct mipi_dsi_driver *
to_mipi_dsi_driver(struct device_driver * driver)313 to_mipi_dsi_driver(struct device_driver *driver)
314 {
315 	return container_of(driver, struct mipi_dsi_driver, driver);
316 }
317 
mipi_dsi_get_drvdata(const struct mipi_dsi_device * dsi)318 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
319 {
320 	return dev_get_drvdata(&dsi->dev);
321 }
322 
mipi_dsi_set_drvdata(struct mipi_dsi_device * dsi,void * data)323 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
324 {
325 	dev_set_drvdata(&dsi->dev, data);
326 }
327 
328 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
329 				  struct module *owner);
330 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
331 
332 #define mipi_dsi_driver_register(driver) \
333 	mipi_dsi_driver_register_full(driver, THIS_MODULE)
334 
335 #define module_mipi_dsi_driver(__mipi_dsi_driver) \
336 	module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
337 			mipi_dsi_driver_unregister)
338 
339 #endif /* __DRM_MIPI_DSI__ */
340