4 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
5 * Andrzej Hajda <a.hajda@samsung.com>
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.
12 #ifndef __DRM_MIPI_DSI_H__
13 #define __DRM_MIPI_DSI_H__
15 #include <linux/device.h>
18 struct mipi_dsi_device;
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)
26 * struct mipi_dsi_msg - read/write DSI buffer
27 * @channel: virtual channel id
28 * @type: payload data type
29 * @tx_len: length of @tx_buf
30 * @tx_buf: data to be written
31 * @rx_len: length of @rx_buf
32 * @rx_buf: data to be read, or NULL
46 bool mipi_dsi_packet_format_is_short(u8 type);
47 bool mipi_dsi_packet_format_is_long(u8 type);
50 * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
51 * @size: size (in bytes) of the packet
52 * @header: the four bytes that make up the header (Data ID, Word Count or
53 * Packet Data, and ECC)
54 * @payload_length: number of bytes in the payload
55 * @payload: a pointer to a buffer containing the payload, if any
57 struct mipi_dsi_packet {
60 size_t payload_length;
64 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
65 const struct mipi_dsi_msg *msg);
68 * struct mipi_dsi_host_ops - DSI bus operations
69 * @attach: attach DSI device to DSI host
70 * @detach: detach DSI device from DSI host
71 * @transfer: send and/or receive DSI packet, return number of received bytes,
74 struct mipi_dsi_host_ops {
75 int (*attach)(struct mipi_dsi_host *host,
76 struct mipi_dsi_device *dsi);
77 int (*detach)(struct mipi_dsi_host *host,
78 struct mipi_dsi_device *dsi);
79 ssize_t (*transfer)(struct mipi_dsi_host *host,
80 const struct mipi_dsi_msg *msg);
84 * struct mipi_dsi_host - DSI host device
85 * @dev: driver model device node for this DSI host
86 * @ops: DSI host operations
88 struct mipi_dsi_host {
90 const struct mipi_dsi_host_ops *ops;
93 int mipi_dsi_host_register(struct mipi_dsi_host *host);
94 void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
99 #define MIPI_DSI_MODE_VIDEO BIT(0)
100 /* video burst mode */
101 #define MIPI_DSI_MODE_VIDEO_BURST BIT(1)
102 /* video pulse mode */
103 #define MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2)
104 /* enable auto vertical count mode */
105 #define MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3)
106 /* enable hsync-end packets in vsync-pulse and v-porch area */
107 #define MIPI_DSI_MODE_VIDEO_HSE BIT(4)
108 /* disable hfront-porch area */
109 #define MIPI_DSI_MODE_VIDEO_HFP BIT(5)
110 /* disable hback-porch area */
111 #define MIPI_DSI_MODE_VIDEO_HBP BIT(6)
112 /* disable hsync-active area */
113 #define MIPI_DSI_MODE_VIDEO_HSA BIT(7)
114 /* flush display FIFO on vsync pulse */
115 #define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8)
116 /* disable EoT packets in HS mode */
117 #define MIPI_DSI_MODE_EOT_PACKET BIT(9)
118 /* device supports non-continuous clock behavior (DSI spec 5.6.1) */
119 #define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)
120 /* transmit data in low power */
121 #define MIPI_DSI_MODE_LPM BIT(11)
123 enum mipi_dsi_pixel_format {
126 MIPI_DSI_FMT_RGB666_PACKED,
131 * struct mipi_dsi_device - DSI peripheral device
132 * @host: DSI host for this peripheral
133 * @dev: driver model device node for this peripheral
134 * @channel: virtual channel assigned to the peripheral
135 * @format: pixel format for video mode
136 * @lanes: number of active data lanes
137 * @mode_flags: DSI operation mode related flags
139 struct mipi_dsi_device {
140 struct mipi_dsi_host *host;
143 unsigned int channel;
145 enum mipi_dsi_pixel_format format;
146 unsigned long mode_flags;
149 static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
151 return container_of(dev, struct mipi_dsi_device, dev);
154 int mipi_dsi_attach(struct mipi_dsi_device *dsi);
155 int mipi_dsi_detach(struct mipi_dsi_device *dsi);
156 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
157 const void *data, size_t len);
158 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
159 const void *data, size_t len);
160 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
164 * struct mipi_dsi_driver - DSI driver
165 * @driver: device driver model driver
166 * @probe: callback for device binding
167 * @remove: callback for device unbinding
168 * @shutdown: called at shutdown time to quiesce the device
170 struct mipi_dsi_driver {
171 struct device_driver driver;
172 int(*probe)(struct mipi_dsi_device *dsi);
173 int(*remove)(struct mipi_dsi_device *dsi);
174 void (*shutdown)(struct mipi_dsi_device *dsi);
177 static inline struct mipi_dsi_driver *
178 to_mipi_dsi_driver(struct device_driver *driver)
180 return container_of(driver, struct mipi_dsi_driver, driver);
183 static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
185 return dev_get_drvdata(&dsi->dev);
188 static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
190 dev_set_drvdata(&dsi->dev, data);
193 int mipi_dsi_driver_register(struct mipi_dsi_driver *driver);
194 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
196 #define module_mipi_dsi_driver(__mipi_dsi_driver) \
197 module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
198 mipi_dsi_driver_unregister)
200 #endif /* __DRM_MIPI_DSI__ */