1/*
2 * MIPI DSI Bus
3 *
4 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
5 * Andrzej Hajda <a.hajda@samsung.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11
12#ifndef __DRM_MIPI_DSI_H__
13#define __DRM_MIPI_DSI_H__
14
15#include <linux/device.h>
16
17struct mipi_dsi_host;
18struct mipi_dsi_device;
19
20/* request ACK from peripheral */
21#define MIPI_DSI_MSG_REQ_ACK	BIT(0)
22/* use Low Power Mode to transmit message */
23#define MIPI_DSI_MSG_USE_LPM	BIT(1)
24
25/**
26 * struct mipi_dsi_msg - read/write DSI buffer
27 * @channel: virtual channel id
28 * @type: payload data type
29 * @flags: flags controlling this message transmission
30 * @tx_len: length of @tx_buf
31 * @tx_buf: data to be written
32 * @rx_len: length of @rx_buf
33 * @rx_buf: data to be read, or NULL
34 */
35struct mipi_dsi_msg {
36	u8 channel;
37	u8 type;
38	u16 flags;
39
40	size_t tx_len;
41	const void *tx_buf;
42
43	size_t rx_len;
44	void *rx_buf;
45};
46
47bool mipi_dsi_packet_format_is_short(u8 type);
48bool mipi_dsi_packet_format_is_long(u8 type);
49
50/**
51 * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
52 * @size: size (in bytes) of the packet
53 * @header: the four bytes that make up the header (Data ID, Word Count or
54 *     Packet Data, and ECC)
55 * @payload_length: number of bytes in the payload
56 * @payload: a pointer to a buffer containing the payload, if any
57 */
58struct mipi_dsi_packet {
59	size_t size;
60	u8 header[4];
61	size_t payload_length;
62	const u8 *payload;
63};
64
65int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
66			   const struct mipi_dsi_msg *msg);
67
68/**
69 * struct mipi_dsi_host_ops - DSI bus operations
70 * @attach: attach DSI device to DSI host
71 * @detach: detach DSI device from DSI host
72 * @transfer: transmit a DSI packet
73 *
74 * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
75 * structures. This structure contains information about the type of packet
76 * being transmitted as well as the transmit and receive buffers. When an
77 * error is encountered during transmission, this function will return a
78 * negative error code. On success it shall return the number of bytes
79 * transmitted for write packets or the number of bytes received for read
80 * packets.
81 *
82 * Note that typically DSI packet transmission is atomic, so the .transfer()
83 * function will seldomly return anything other than the number of bytes
84 * contained in the transmit buffer on success.
85 */
86struct mipi_dsi_host_ops {
87	int (*attach)(struct mipi_dsi_host *host,
88		      struct mipi_dsi_device *dsi);
89	int (*detach)(struct mipi_dsi_host *host,
90		      struct mipi_dsi_device *dsi);
91	ssize_t (*transfer)(struct mipi_dsi_host *host,
92			    const struct mipi_dsi_msg *msg);
93};
94
95/**
96 * struct mipi_dsi_host - DSI host device
97 * @dev: driver model device node for this DSI host
98 * @ops: DSI host operations
99 */
100struct mipi_dsi_host {
101	struct device *dev;
102	const struct mipi_dsi_host_ops *ops;
103};
104
105int mipi_dsi_host_register(struct mipi_dsi_host *host);
106void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
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/**
143 * struct mipi_dsi_device - DSI peripheral device
144 * @host: DSI host for this peripheral
145 * @dev: driver model device node for this peripheral
146 * @channel: virtual channel assigned to the peripheral
147 * @format: pixel format for video mode
148 * @lanes: number of active data lanes
149 * @mode_flags: DSI operation mode related flags
150 */
151struct mipi_dsi_device {
152	struct mipi_dsi_host *host;
153	struct device dev;
154
155	unsigned int channel;
156	unsigned int lanes;
157	enum mipi_dsi_pixel_format format;
158	unsigned long mode_flags;
159};
160
161static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
162{
163	return container_of(dev, struct mipi_dsi_device, dev);
164}
165
166struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
167int mipi_dsi_attach(struct mipi_dsi_device *dsi);
168int mipi_dsi_detach(struct mipi_dsi_device *dsi);
169int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
170					    u16 value);
171
172ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
173			       size_t size);
174ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
175			      size_t num_params, void *data, size_t size);
176
177/**
178 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
179 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
180 *    information only
181 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
182 *    V-Blanking and H-Blanking information
183 */
184enum mipi_dsi_dcs_tear_mode {
185	MIPI_DSI_DCS_TEAR_MODE_VBLANK,
186	MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
187};
188
189#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
190#define MIPI_DSI_DCS_POWER_MODE_NORMAL  (1 << 3)
191#define MIPI_DSI_DCS_POWER_MODE_SLEEP   (1 << 4)
192#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
193#define MIPI_DSI_DCS_POWER_MODE_IDLE    (1 << 6)
194
195ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
196				  const void *data, size_t len);
197ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
198			   const void *data, size_t len);
199ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
200			  size_t len);
201int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
202int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
203int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
204int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
205int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
206int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
207int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
208int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
209int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
210				    u16 end);
211int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
212				  u16 end);
213int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
214int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
215			     enum mipi_dsi_dcs_tear_mode mode);
216int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
217
218/**
219 * struct mipi_dsi_driver - DSI driver
220 * @driver: device driver model driver
221 * @probe: callback for device binding
222 * @remove: callback for device unbinding
223 * @shutdown: called at shutdown time to quiesce the device
224 */
225struct mipi_dsi_driver {
226	struct device_driver driver;
227	int(*probe)(struct mipi_dsi_device *dsi);
228	int(*remove)(struct mipi_dsi_device *dsi);
229	void (*shutdown)(struct mipi_dsi_device *dsi);
230};
231
232static inline struct mipi_dsi_driver *
233to_mipi_dsi_driver(struct device_driver *driver)
234{
235	return container_of(driver, struct mipi_dsi_driver, driver);
236}
237
238static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
239{
240	return dev_get_drvdata(&dsi->dev);
241}
242
243static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
244{
245	dev_set_drvdata(&dsi->dev, data);
246}
247
248int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
249				  struct module *owner);
250void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
251
252#define mipi_dsi_driver_register(driver) \
253	mipi_dsi_driver_register_full(driver, THIS_MODULE)
254
255#define module_mipi_dsi_driver(__mipi_dsi_driver) \
256	module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
257			mipi_dsi_driver_unregister)
258
259#endif /* __DRM_MIPI_DSI__ */
260