Linux 5.15.57
[platform/kernel/linux-rpi.git] / include / drm / drm_mipi_dsi.h
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
141 enum mipi_dsi_pixel_format {
142         MIPI_DSI_FMT_RGB888,
143         MIPI_DSI_FMT_RGB666,
144         MIPI_DSI_FMT_RGB666_PACKED,
145         MIPI_DSI_FMT_RGB565,
146 };
147
148 #define DSI_DEV_NAME_SIZE               20
149
150 /**
151  * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
152  * @type: DSI peripheral chip type
153  * @channel: DSI virtual channel assigned to peripheral
154  * @node: pointer to OF device node or NULL
155  *
156  * This is populated and passed to mipi_dsi_device_new to create a new
157  * DSI device
158  */
159 struct mipi_dsi_device_info {
160         char type[DSI_DEV_NAME_SIZE];
161         u32 channel;
162         struct device_node *node;
163 };
164
165 /**
166  * struct mipi_dsi_device - DSI peripheral device
167  * @host: DSI host for this peripheral
168  * @dev: driver model device node for this peripheral
169  * @name: DSI peripheral chip type
170  * @channel: virtual channel assigned to the peripheral
171  * @format: pixel format for video mode
172  * @lanes: number of active data lanes
173  * @mode_flags: DSI operation mode related flags
174  * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
175  * be set to the real limits of the hardware, zero is only accepted for
176  * legacy drivers
177  * @lp_rate: maximum lane frequency for low power mode in hertz, this should
178  * be set to the real limits of the hardware, zero is only accepted for
179  * legacy drivers
180  */
181 struct mipi_dsi_device {
182         struct mipi_dsi_host *host;
183         struct device dev;
184
185         char name[DSI_DEV_NAME_SIZE];
186         unsigned int channel;
187         unsigned int lanes;
188         enum mipi_dsi_pixel_format format;
189         unsigned long mode_flags;
190         unsigned long hs_rate;
191         unsigned long lp_rate;
192 };
193
194 #define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
195
196 static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
197 {
198         return container_of(dev, struct mipi_dsi_device, dev);
199 }
200
201 /**
202  * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
203  *                                given pixel format defined by the MIPI DSI
204  *                                specification
205  * @fmt: MIPI DSI pixel format
206  *
207  * Returns: The number of bits per pixel of the given pixel format.
208  */
209 static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
210 {
211         switch (fmt) {
212         case MIPI_DSI_FMT_RGB888:
213         case MIPI_DSI_FMT_RGB666:
214                 return 24;
215
216         case MIPI_DSI_FMT_RGB666_PACKED:
217                 return 18;
218
219         case MIPI_DSI_FMT_RGB565:
220                 return 16;
221         }
222
223         return -EINVAL;
224 }
225
226 struct mipi_dsi_device *
227 mipi_dsi_device_register_full(struct mipi_dsi_host *host,
228                               const struct mipi_dsi_device_info *info);
229 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
230 struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
231 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
232 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
233 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
234 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
235 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
236                                             u16 value);
237 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
238 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
239                                        const struct drm_dsc_picture_parameter_set *pps);
240
241 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
242                                size_t size);
243 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
244                               size_t num_params, void *data, size_t size);
245
246 /**
247  * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
248  * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
249  *    information only
250  * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
251  *    V-Blanking and H-Blanking information
252  */
253 enum mipi_dsi_dcs_tear_mode {
254         MIPI_DSI_DCS_TEAR_MODE_VBLANK,
255         MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
256 };
257
258 #define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
259 #define MIPI_DSI_DCS_POWER_MODE_NORMAL  (1 << 3)
260 #define MIPI_DSI_DCS_POWER_MODE_SLEEP   (1 << 4)
261 #define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
262 #define MIPI_DSI_DCS_POWER_MODE_IDLE    (1 << 6)
263
264 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
265                                   const void *data, size_t len);
266 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
267                            const void *data, size_t len);
268 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
269                           size_t len);
270 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
271 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
272 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
273 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
274 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
275 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
276 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
277 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
278 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
279                                     u16 end);
280 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
281                                   u16 end);
282 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
283 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
284                              enum mipi_dsi_dcs_tear_mode mode);
285 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
286 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
287 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
288                                         u16 brightness);
289 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
290                                         u16 *brightness);
291
292 /**
293  * struct mipi_dsi_driver - DSI driver
294  * @driver: device driver model driver
295  * @probe: callback for device binding
296  * @remove: callback for device unbinding
297  * @shutdown: called at shutdown time to quiesce the device
298  */
299 struct mipi_dsi_driver {
300         struct device_driver driver;
301         int(*probe)(struct mipi_dsi_device *dsi);
302         int(*remove)(struct mipi_dsi_device *dsi);
303         void (*shutdown)(struct mipi_dsi_device *dsi);
304 };
305
306 static inline struct mipi_dsi_driver *
307 to_mipi_dsi_driver(struct device_driver *driver)
308 {
309         return container_of(driver, struct mipi_dsi_driver, driver);
310 }
311
312 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
313 {
314         return dev_get_drvdata(&dsi->dev);
315 }
316
317 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
318 {
319         dev_set_drvdata(&dsi->dev, data);
320 }
321
322 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
323                                   struct module *owner);
324 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
325
326 #define mipi_dsi_driver_register(driver) \
327         mipi_dsi_driver_register_full(driver, THIS_MODULE)
328
329 #define module_mipi_dsi_driver(__mipi_dsi_driver) \
330         module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
331                         mipi_dsi_driver_unregister)
332
333 #endif /* __DRM_MIPI_DSI__ */