Merge tag 'drm-intel-next-fixes-2020-04-08' of git://anongit.freedesktop.org/drm...
[linux-2.6-block.git] / include / drm / drm_mipi_dsi.h
CommitLineData
d2912cb1 1/* SPDX-License-Identifier: GPL-2.0-only */
068a0023
AH
2/*
3 * MIPI DSI Bus
4 *
5 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
6 * Andrzej Hajda <a.hajda@samsung.com>
068a0023
AH
7 */
8
9#ifndef __DRM_MIPI_DSI_H__
10#define __DRM_MIPI_DSI_H__
11
12#include <linux/device.h>
13
14struct mipi_dsi_host;
15struct mipi_dsi_device;
f4dea1aa 16struct drm_dsc_picture_parameter_set;
068a0023 17
1d96d4a6
AH
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
068a0023
AH
23/**
24 * struct mipi_dsi_msg - read/write DSI buffer
25 * @channel: virtual channel id
26 * @type: payload data type
009081e0 27 * @flags: flags controlling this message transmission
068a0023
AH
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 */
33struct mipi_dsi_msg {
34 u8 channel;
35 u8 type;
1d96d4a6 36 u16 flags;
068a0023
AH
37
38 size_t tx_len;
39 const void *tx_buf;
40
41 size_t rx_len;
42 void *rx_buf;
43};
44
02acb76d
TR
45bool mipi_dsi_packet_format_is_short(u8 type);
46bool mipi_dsi_packet_format_is_long(u8 type);
47
a52879e8
TR
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 */
56struct mipi_dsi_packet {
57 size_t size;
58 u8 header[4];
59 size_t payload_length;
60 const u8 *payload;
61};
62
63int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
64 const struct mipi_dsi_msg *msg);
65
068a0023
AH
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
009081e0
TR
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.
068a0023
AH
83 */
84struct mipi_dsi_host_ops {
85 int (*attach)(struct mipi_dsi_host *host,
86 struct mipi_dsi_device *dsi);
87 int (*detach)(struct mipi_dsi_host *host,
88 struct mipi_dsi_device *dsi);
89 ssize_t (*transfer)(struct mipi_dsi_host *host,
ed6ff40e 90 const struct mipi_dsi_msg *msg);
068a0023
AH
91};
92
93/**
94 * struct mipi_dsi_host - DSI host device
95 * @dev: driver model device node for this DSI host
96 * @ops: DSI host operations
97b6ae50 97 * @list: list management
068a0023
AH
98 */
99struct mipi_dsi_host {
100 struct device *dev;
101 const struct mipi_dsi_host_ops *ops;
97b6ae50 102 struct list_head list;
068a0023
AH
103};
104
105int mipi_dsi_host_register(struct mipi_dsi_host *host);
106void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
97b6ae50 107struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node);
068a0023
AH
108
109/* DSI mode flags */
110
111/* video mode */
112#define MIPI_DSI_MODE_VIDEO BIT(0)
113/* video burst mode */
114#define MIPI_DSI_MODE_VIDEO_BURST BIT(1)
115/* video pulse mode */
116#define MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2)
117/* enable auto vertical count mode */
118#define MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3)
119/* enable hsync-end packets in vsync-pulse and v-porch area */
120#define MIPI_DSI_MODE_VIDEO_HSE BIT(4)
121/* disable hfront-porch area */
122#define MIPI_DSI_MODE_VIDEO_HFP BIT(5)
123/* disable hback-porch area */
124#define MIPI_DSI_MODE_VIDEO_HBP BIT(6)
125/* disable hsync-active area */
126#define MIPI_DSI_MODE_VIDEO_HSA BIT(7)
127/* flush display FIFO on vsync pulse */
128#define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8)
129/* disable EoT packets in HS mode */
130#define MIPI_DSI_MODE_EOT_PACKET BIT(9)
884d6a0b
AC
131/* device supports non-continuous clock behavior (DSI spec 5.6.1) */
132#define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)
d87f09ab
ID
133/* transmit data in low power */
134#define MIPI_DSI_MODE_LPM BIT(11)
068a0023
AH
135
136enum mipi_dsi_pixel_format {
137 MIPI_DSI_FMT_RGB888,
138 MIPI_DSI_FMT_RGB666,
139 MIPI_DSI_FMT_RGB666_PACKED,
140 MIPI_DSI_FMT_RGB565,
141};
142
bf4363ce
AT
143#define DSI_DEV_NAME_SIZE 20
144
145/**
c63ae8a9 146 * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
bf4363ce 147 * @type: DSI peripheral chip type
c63ae8a9 148 * @channel: DSI virtual channel assigned to peripheral
bf4363ce 149 * @node: pointer to OF device node or NULL
c63ae8a9
AT
150 *
151 * This is populated and passed to mipi_dsi_device_new to create a new
152 * DSI device
153 */
154struct mipi_dsi_device_info {
bf4363ce 155 char type[DSI_DEV_NAME_SIZE];
c63ae8a9
AT
156 u32 channel;
157 struct device_node *node;
158};
159
068a0023
AH
160/**
161 * struct mipi_dsi_device - DSI peripheral device
162 * @host: DSI host for this peripheral
163 * @dev: driver model device node for this peripheral
bf4363ce 164 * @name: DSI peripheral chip type
068a0023
AH
165 * @channel: virtual channel assigned to the peripheral
166 * @format: pixel format for video mode
167 * @lanes: number of active data lanes
168 * @mode_flags: DSI operation mode related flags
e982e3f0
LW
169 * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
170 * be set to the real limits of the hardware, zero is only accepted for
171 * legacy drivers
172 * @lp_rate: maximum lane frequency for low power mode in hertz, this should
173 * be set to the real limits of the hardware, zero is only accepted for
174 * legacy drivers
068a0023
AH
175 */
176struct mipi_dsi_device {
177 struct mipi_dsi_host *host;
178 struct device dev;
179
bf4363ce 180 char name[DSI_DEV_NAME_SIZE];
068a0023
AH
181 unsigned int channel;
182 unsigned int lanes;
183 enum mipi_dsi_pixel_format format;
184 unsigned long mode_flags;
e982e3f0
LW
185 unsigned long hs_rate;
186 unsigned long lp_rate;
068a0023
AH
187};
188
babb24fe
TR
189#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
190
77df01dc
TR
191static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
192{
193 return container_of(dev, struct mipi_dsi_device, dev);
194}
068a0023 195
ec26d9e9
LY
196/**
197 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
198 * given pixel format defined by the MIPI DSI
199 * specification
200 * @fmt: MIPI DSI pixel format
201 *
202 * Returns: The number of bits per pixel of the given pixel format.
203 */
204static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
205{
206 switch (fmt) {
207 case MIPI_DSI_FMT_RGB888:
208 case MIPI_DSI_FMT_RGB666:
209 return 24;
210
211 case MIPI_DSI_FMT_RGB666_PACKED:
212 return 18;
213
214 case MIPI_DSI_FMT_RGB565:
215 return 16;
216 }
217
218 return -EINVAL;
219}
220
c63ae8a9
AT
221struct mipi_dsi_device *
222mipi_dsi_device_register_full(struct mipi_dsi_host *host,
223 const struct mipi_dsi_device_info *info);
509e42ce 224void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
3ef05924 225struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
068a0023
AH
226int mipi_dsi_attach(struct mipi_dsi_device *dsi);
227int mipi_dsi_detach(struct mipi_dsi_device *dsi);
6e8c9e33
WJ
228int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
229int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
dbf30b69
YC
230int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
231 u16 value);
f4dea1aa
JN
232ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
233ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
234 const struct drm_dsc_picture_parameter_set *pps);
550ab848
TR
235
236ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
237 size_t size);
238ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
239 size_t num_params, void *data, size_t size);
240
42fe1e75
YC
241/**
242 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
243 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
244 * information only
245 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
246 * V-Blanking and H-Blanking information
247 */
248enum mipi_dsi_dcs_tear_mode {
249 MIPI_DSI_DCS_TEAR_MODE_VBLANK,
250 MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
251};
252
3d9a8fcf
TR
253#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
254#define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
255#define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
256#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
257#define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
258
960dd616
TR
259ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
260 const void *data, size_t len);
261ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
262 const void *data, size_t len);
3c523d7d
TR
263ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
264 size_t len);
083d573f 265int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
2f16b897 266int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
3d9a8fcf 267int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
5cc0af16 268int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
42fe1e75
YC
269int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
270int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
271int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
272int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
3b46d4a0
TR
273int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
274 u16 end);
275int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
276 u16 end);
42fe1e75
YC
277int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
278int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
279 enum mipi_dsi_dcs_tear_mode mode);
5cc0af16 280int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
bbdcf516 281int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
1a9d7593
VSB
282int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
283 u16 brightness);
284int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
285 u16 *brightness);
068a0023
AH
286
287/**
288 * struct mipi_dsi_driver - DSI driver
289 * @driver: device driver model driver
290 * @probe: callback for device binding
291 * @remove: callback for device unbinding
d1621803 292 * @shutdown: called at shutdown time to quiesce the device
068a0023
AH
293 */
294struct mipi_dsi_driver {
295 struct device_driver driver;
296 int(*probe)(struct mipi_dsi_device *dsi);
297 int(*remove)(struct mipi_dsi_device *dsi);
d1621803 298 void (*shutdown)(struct mipi_dsi_device *dsi);
068a0023
AH
299};
300
77df01dc
TR
301static inline struct mipi_dsi_driver *
302to_mipi_dsi_driver(struct device_driver *driver)
303{
304 return container_of(driver, struct mipi_dsi_driver, driver);
305}
068a0023
AH
306
307static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
308{
309 return dev_get_drvdata(&dsi->dev);
310}
311
312static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
313{
314 dev_set_drvdata(&dsi->dev, data);
315}
316
99035e99
TR
317int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
318 struct module *owner);
068a0023
AH
319void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
320
99035e99
TR
321#define mipi_dsi_driver_register(driver) \
322 mipi_dsi_driver_register_full(driver, THIS_MODULE)
323
068a0023
AH
324#define module_mipi_dsi_driver(__mipi_dsi_driver) \
325 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
326 mipi_dsi_driver_unregister)
327
328#endif /* __DRM_MIPI_DSI__ */