Loading...
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
14struct mipi_dsi_host;
15struct mipi_dsi_device;
16
17/* request ACK from peripheral */
18#define MIPI_DSI_MSG_REQ_ACK BIT(0)
19/* use Low Power Mode to transmit message */
20#define MIPI_DSI_MSG_USE_LPM BIT(1)
21
22/**
23 * struct mipi_dsi_msg - read/write DSI buffer
24 * @channel: virtual channel id
25 * @type: payload data type
26 * @flags: flags controlling this message transmission
27 * @tx_len: length of @tx_buf
28 * @tx_buf: data to be written
29 * @rx_len: length of @rx_buf
30 * @rx_buf: data to be read, or NULL
31 */
32struct mipi_dsi_msg {
33 u8 channel;
34 u8 type;
35 u16 flags;
36
37 size_t tx_len;
38 const void *tx_buf;
39
40 size_t rx_len;
41 void *rx_buf;
42};
43
44bool mipi_dsi_packet_format_is_short(u8 type);
45bool mipi_dsi_packet_format_is_long(u8 type);
46
47/**
48 * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
49 * @size: size (in bytes) of the packet
50 * @header: the four bytes that make up the header (Data ID, Word Count or
51 * Packet Data, and ECC)
52 * @payload_length: number of bytes in the payload
53 * @payload: a pointer to a buffer containing the payload, if any
54 */
55struct mipi_dsi_packet {
56 size_t size;
57 u8 header[4];
58 size_t payload_length;
59 const u8 *payload;
60};
61
62int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
63 const struct mipi_dsi_msg *msg);
64
65/**
66 * struct mipi_dsi_host_ops - DSI bus operations
67 * @attach: attach DSI device to DSI host
68 * @detach: detach DSI device from DSI host
69 * @transfer: transmit a DSI packet
70 *
71 * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
72 * structures. This structure contains information about the type of packet
73 * being transmitted as well as the transmit and receive buffers. When an
74 * error is encountered during transmission, this function will return a
75 * negative error code. On success it shall return the number of bytes
76 * transmitted for write packets or the number of bytes received for read
77 * packets.
78 *
79 * Note that typically DSI packet transmission is atomic, so the .transfer()
80 * function will seldomly return anything other than the number of bytes
81 * contained in the transmit buffer on success.
82 */
83struct mipi_dsi_host_ops {
84 int (*attach)(struct mipi_dsi_host *host,
85 struct mipi_dsi_device *dsi);
86 int (*detach)(struct mipi_dsi_host *host,
87 struct mipi_dsi_device *dsi);
88 ssize_t (*transfer)(struct mipi_dsi_host *host,
89 const struct mipi_dsi_msg *msg);
90};
91
92/**
93 * struct mipi_dsi_host - DSI host device
94 * @dev: driver model device node for this DSI host
95 * @ops: DSI host operations
96 * @list: list management
97 */
98struct mipi_dsi_host {
99 struct device *dev;
100 const struct mipi_dsi_host_ops *ops;
101 struct list_head list;
102};
103
104int mipi_dsi_host_register(struct mipi_dsi_host *host);
105void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
106struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node);
107
108/* DSI mode flags */
109
110/* video mode */
111#define MIPI_DSI_MODE_VIDEO BIT(0)
112/* video burst mode */
113#define MIPI_DSI_MODE_VIDEO_BURST BIT(1)
114/* video pulse mode */
115#define MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2)
116/* enable auto vertical count mode */
117#define MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3)
118/* enable hsync-end packets in vsync-pulse and v-porch area */
119#define MIPI_DSI_MODE_VIDEO_HSE BIT(4)
120/* disable hfront-porch area */
121#define MIPI_DSI_MODE_VIDEO_HFP BIT(5)
122/* disable hback-porch area */
123#define MIPI_DSI_MODE_VIDEO_HBP BIT(6)
124/* disable hsync-active area */
125#define MIPI_DSI_MODE_VIDEO_HSA BIT(7)
126/* flush display FIFO on vsync pulse */
127#define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8)
128/* disable EoT packets in HS mode */
129#define MIPI_DSI_MODE_EOT_PACKET BIT(9)
130/* device supports non-continuous clock behavior (DSI spec 5.6.1) */
131#define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)
132/* transmit data in low power */
133#define MIPI_DSI_MODE_LPM BIT(11)
134
135enum mipi_dsi_pixel_format {
136 MIPI_DSI_FMT_RGB888,
137 MIPI_DSI_FMT_RGB666,
138 MIPI_DSI_FMT_RGB666_PACKED,
139 MIPI_DSI_FMT_RGB565,
140};
141
142#define DSI_DEV_NAME_SIZE 20
143
144/**
145 * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
146 * @type: DSI peripheral chip type
147 * @channel: DSI virtual channel assigned to peripheral
148 * @node: pointer to OF device node or NULL
149 *
150 * This is populated and passed to mipi_dsi_device_new to create a new
151 * DSI device
152 */
153struct mipi_dsi_device_info {
154 char type[DSI_DEV_NAME_SIZE];
155 u32 channel;
156 struct device_node *node;
157};
158
159/**
160 * struct mipi_dsi_device - DSI peripheral device
161 * @host: DSI host for this peripheral
162 * @dev: driver model device node for this peripheral
163 * @name: DSI peripheral chip type
164 * @channel: virtual channel assigned to the peripheral
165 * @format: pixel format for video mode
166 * @lanes: number of active data lanes
167 * @mode_flags: DSI operation mode related flags
168 * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
169 * be set to the real limits of the hardware, zero is only accepted for
170 * legacy drivers
171 * @lp_rate: maximum lane frequency for low power mode in hertz, this should
172 * be set to the real limits of the hardware, zero is only accepted for
173 * legacy drivers
174 */
175struct mipi_dsi_device {
176 struct mipi_dsi_host *host;
177 struct device dev;
178
179 char name[DSI_DEV_NAME_SIZE];
180 unsigned int channel;
181 unsigned int lanes;
182 enum mipi_dsi_pixel_format format;
183 unsigned long mode_flags;
184 unsigned long hs_rate;
185 unsigned long lp_rate;
186};
187
188#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
189
190static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
191{
192 return container_of(dev, struct mipi_dsi_device, dev);
193}
194
195/**
196 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
197 * given pixel format defined by the MIPI DSI
198 * specification
199 * @fmt: MIPI DSI pixel format
200 *
201 * Returns: The number of bits per pixel of the given pixel format.
202 */
203static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
204{
205 switch (fmt) {
206 case MIPI_DSI_FMT_RGB888:
207 case MIPI_DSI_FMT_RGB666:
208 return 24;
209
210 case MIPI_DSI_FMT_RGB666_PACKED:
211 return 18;
212
213 case MIPI_DSI_FMT_RGB565:
214 return 16;
215 }
216
217 return -EINVAL;
218}
219
220struct mipi_dsi_device *
221mipi_dsi_device_register_full(struct mipi_dsi_host *host,
222 const struct mipi_dsi_device_info *info);
223void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
224struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
225int mipi_dsi_attach(struct mipi_dsi_device *dsi);
226int mipi_dsi_detach(struct mipi_dsi_device *dsi);
227int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
228int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
229int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
230 u16 value);
231
232ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
233 size_t size);
234ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
235 size_t num_params, void *data, size_t size);
236
237/**
238 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
239 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
240 * information only
241 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
242 * V-Blanking and H-Blanking information
243 */
244enum mipi_dsi_dcs_tear_mode {
245 MIPI_DSI_DCS_TEAR_MODE_VBLANK,
246 MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
247};
248
249#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
250#define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
251#define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
252#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
253#define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
254
255ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
256 const void *data, size_t len);
257ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
258 const void *data, size_t len);
259ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
260 size_t len);
261int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
262int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
263int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
264int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
265int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
266int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
267int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
268int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
269int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
270 u16 end);
271int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
272 u16 end);
273int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
274int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
275 enum mipi_dsi_dcs_tear_mode mode);
276int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
277int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
278int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
279 u16 brightness);
280int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
281 u16 *brightness);
282
283/**
284 * struct mipi_dsi_driver - DSI driver
285 * @driver: device driver model driver
286 * @probe: callback for device binding
287 * @remove: callback for device unbinding
288 * @shutdown: called at shutdown time to quiesce the device
289 */
290struct mipi_dsi_driver {
291 struct device_driver driver;
292 int(*probe)(struct mipi_dsi_device *dsi);
293 int(*remove)(struct mipi_dsi_device *dsi);
294 void (*shutdown)(struct mipi_dsi_device *dsi);
295};
296
297static inline struct mipi_dsi_driver *
298to_mipi_dsi_driver(struct device_driver *driver)
299{
300 return container_of(driver, struct mipi_dsi_driver, driver);
301}
302
303static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
304{
305 return dev_get_drvdata(&dsi->dev);
306}
307
308static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
309{
310 dev_set_drvdata(&dsi->dev, data);
311}
312
313int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
314 struct module *owner);
315void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
316
317#define mipi_dsi_driver_register(driver) \
318 mipi_dsi_driver_register_full(driver, THIS_MODULE)
319
320#define module_mipi_dsi_driver(__mipi_dsi_driver) \
321 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
322 mipi_dsi_driver_unregister)
323
324#endif /* __DRM_MIPI_DSI__ */
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
14struct mipi_dsi_host;
15struct mipi_dsi_device;
16struct 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 */
33struct 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
45bool mipi_dsi_packet_format_is_short(u8 type);
46bool 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 */
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
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 */
89struct 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 */
104struct mipi_dsi_host {
105 struct device *dev;
106 const struct mipi_dsi_host_ops *ops;
107 struct list_head list;
108};
109
110int mipi_dsi_host_register(struct mipi_dsi_host *host);
111void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
112struct 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
143enum 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 */
161struct 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 * @attached: the DSI device has been successfully attached
172 * @name: DSI peripheral chip type
173 * @channel: virtual channel assigned to the peripheral
174 * @format: pixel format for video mode
175 * @lanes: number of active data lanes
176 * @mode_flags: DSI operation mode related flags
177 * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
178 * be set to the real limits of the hardware, zero is only accepted for
179 * legacy drivers
180 * @lp_rate: maximum lane frequency for low power mode in hertz, this should
181 * be set to the real limits of the hardware, zero is only accepted for
182 * legacy drivers
183 * @dsc: panel/bridge DSC pps payload to be sent
184 */
185struct mipi_dsi_device {
186 struct mipi_dsi_host *host;
187 struct device dev;
188 bool attached;
189
190 char name[DSI_DEV_NAME_SIZE];
191 unsigned int channel;
192 unsigned int lanes;
193 enum mipi_dsi_pixel_format format;
194 unsigned long mode_flags;
195 unsigned long hs_rate;
196 unsigned long lp_rate;
197 struct drm_dsc_config *dsc;
198};
199
200#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
201
202#define to_mipi_dsi_device(__dev) container_of_const(__dev, struct mipi_dsi_device, dev)
203
204/**
205 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
206 * given pixel format defined by the MIPI DSI
207 * specification
208 * @fmt: MIPI DSI pixel format
209 *
210 * Returns: The number of bits per pixel of the given pixel format.
211 */
212static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
213{
214 switch (fmt) {
215 case MIPI_DSI_FMT_RGB888:
216 case MIPI_DSI_FMT_RGB666:
217 return 24;
218
219 case MIPI_DSI_FMT_RGB666_PACKED:
220 return 18;
221
222 case MIPI_DSI_FMT_RGB565:
223 return 16;
224 }
225
226 return -EINVAL;
227}
228
229struct mipi_dsi_device *
230mipi_dsi_device_register_full(struct mipi_dsi_host *host,
231 const struct mipi_dsi_device_info *info);
232void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
233struct mipi_dsi_device *
234devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host,
235 const struct mipi_dsi_device_info *info);
236struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
237int mipi_dsi_attach(struct mipi_dsi_device *dsi);
238int mipi_dsi_detach(struct mipi_dsi_device *dsi);
239int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);
240int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
241int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
242int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
243 u16 value);
244int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
245int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
246 const struct drm_dsc_picture_parameter_set *pps);
247
248ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
249 size_t size);
250ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
251 size_t num_params, void *data, size_t size);
252
253/**
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
256 * information only
257 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
258 * V-Blanking and H-Blanking information
259 */
260enum mipi_dsi_dcs_tear_mode {
261 MIPI_DSI_DCS_TEAR_MODE_VBLANK,
262 MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
263};
264
265#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
266#define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
267#define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
268#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
269#define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
270
271ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
272 const void *data, size_t len);
273ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
274 const void *data, size_t len);
275ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
276 size_t len);
277int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
278int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
279int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
280int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
281int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
282int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
283int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
284int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
285int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
286 u16 end);
287int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
288 u16 end);
289int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
290int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
291 enum mipi_dsi_dcs_tear_mode mode);
292int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
293int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
294int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
295 u16 brightness);
296int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
297 u16 *brightness);
298int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
299 u16 brightness);
300int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
301 u16 *brightness);
302
303/**
304 * mipi_dsi_generic_write_seq - transmit data using a generic write packet
305 * @dsi: DSI peripheral device
306 * @seq: buffer containing the payload
307 */
308#define mipi_dsi_generic_write_seq(dsi, seq...) \
309 do { \
310 static const u8 d[] = { seq }; \
311 struct device *dev = &dsi->dev; \
312 int ret; \
313 ret = mipi_dsi_generic_write(dsi, d, ARRAY_SIZE(d)); \
314 if (ret < 0) { \
315 dev_err_ratelimited(dev, "transmit data failed: %d\n", \
316 ret); \
317 return ret; \
318 } \
319 } while (0)
320
321/**
322 * mipi_dsi_dcs_write_seq - transmit a DCS command with payload
323 * @dsi: DSI peripheral device
324 * @cmd: Command
325 * @seq: buffer containing data to be transmitted
326 */
327#define mipi_dsi_dcs_write_seq(dsi, cmd, seq...) \
328 do { \
329 static const u8 d[] = { cmd, seq }; \
330 struct device *dev = &dsi->dev; \
331 int ret; \
332 ret = mipi_dsi_dcs_write_buffer(dsi, d, ARRAY_SIZE(d)); \
333 if (ret < 0) { \
334 dev_err_ratelimited( \
335 dev, "sending command %#02x failed: %d\n", \
336 cmd, ret); \
337 return ret; \
338 } \
339 } while (0)
340
341/**
342 * struct mipi_dsi_driver - DSI driver
343 * @driver: device driver model driver
344 * @probe: callback for device binding
345 * @remove: callback for device unbinding
346 * @shutdown: called at shutdown time to quiesce the device
347 */
348struct mipi_dsi_driver {
349 struct device_driver driver;
350 int(*probe)(struct mipi_dsi_device *dsi);
351 void (*remove)(struct mipi_dsi_device *dsi);
352 void (*shutdown)(struct mipi_dsi_device *dsi);
353};
354
355static inline struct mipi_dsi_driver *
356to_mipi_dsi_driver(struct device_driver *driver)
357{
358 return container_of(driver, struct mipi_dsi_driver, driver);
359}
360
361static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
362{
363 return dev_get_drvdata(&dsi->dev);
364}
365
366static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
367{
368 dev_set_drvdata(&dsi->dev, data);
369}
370
371int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
372 struct module *owner);
373void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
374
375#define mipi_dsi_driver_register(driver) \
376 mipi_dsi_driver_register_full(driver, THIS_MODULE)
377
378#define module_mipi_dsi_driver(__mipi_dsi_driver) \
379 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
380 mipi_dsi_driver_unregister)
381
382#endif /* __DRM_MIPI_DSI__ */