[linux.git] / include / drm / drm_mipi_dsi.h

/*
 * MIPI DSI Bus
 *
 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
 * Andrzej Hajda <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef __DRM_MIPI_DSI_H__
#define __DRM_MIPI_DSI_H__

#include <linux/device.h>

struct mipi_dsi_host;
struct mipi_dsi_device;

/* request ACK from peripheral */
#define MIPI_DSI_MSG_REQ_ACK	BIT(0)
/* use Low Power Mode to transmit message */
#define MIPI_DSI_MSG_USE_LPM	BIT(1)

/**
 * struct mipi_dsi_msg - read/write DSI buffer
 * @channel: virtual channel id
 * @type: payload data type
 * @flags: flags controlling this message transmission
 * @tx_len: length of @tx_buf
 * @tx_buf: data to be written
 * @rx_len: length of @rx_buf
 * @rx_buf: data to be read, or NULL
 */
struct mipi_dsi_msg {
	u8 channel;
	u8 type;
	u16 flags;

	size_t tx_len;
	const void *tx_buf;

	size_t rx_len;
	void *rx_buf;
};

bool mipi_dsi_packet_format_is_short(u8 type);
bool mipi_dsi_packet_format_is_long(u8 type);

/**
 * struct mipi_dsi_packet - represents a MIPI DSI packet in protocol format
 * @size: size (in bytes) of the packet
 * @header: the four bytes that make up the header (Data ID, Word Count or
 *     Packet Data, and ECC)
 * @payload_length: number of bytes in the payload
 * @payload: a pointer to a buffer containing the payload, if any
 */
struct mipi_dsi_packet {
	size_t size;
	u8 header[4];
	size_t payload_length;
	const u8 *payload;
};

int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
			   const struct mipi_dsi_msg *msg);

/**
 * struct mipi_dsi_host_ops - DSI bus operations
 * @attach: attach DSI device to DSI host
 * @detach: detach DSI device from DSI host
 * @transfer: transmit a DSI packet
 *
 * DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
 * structures. This structure contains information about the type of packet
 * being transmitted as well as the transmit and receive buffers. When an
 * error is encountered during transmission, this function will return a
 * negative error code. On success it shall return the number of bytes
 * transmitted for write packets or the number of bytes received for read
 * packets.
 *
 * Note that typically DSI packet transmission is atomic, so the .transfer()
 * function will seldomly return anything other than the number of bytes
 * contained in the transmit buffer on success.
 */
struct mipi_dsi_host_ops {
	int (*attach)(struct mipi_dsi_host *host,
		      struct mipi_dsi_device *dsi);
	int (*detach)(struct mipi_dsi_host *host,
		      struct mipi_dsi_device *dsi);
	ssize_t (*transfer)(struct mipi_dsi_host *host,
			    const struct mipi_dsi_msg *msg);
};

/**
 * struct mipi_dsi_host - DSI host device
 * @dev: driver model device node for this DSI host
 * @ops: DSI host operations
 */
struct mipi_dsi_host {
	struct device *dev;
	const struct mipi_dsi_host_ops *ops;
};

int mipi_dsi_host_register(struct mipi_dsi_host *host);
void mipi_dsi_host_unregister(struct mipi_dsi_host *host);

/* DSI mode flags */

/* video mode */
#define MIPI_DSI_MODE_VIDEO		BIT(0)
/* video burst mode */
#define MIPI_DSI_MODE_VIDEO_BURST	BIT(1)
/* video pulse mode */
#define MIPI_DSI_MODE_VIDEO_SYNC_PULSE	BIT(2)
/* enable auto vertical count mode */
#define MIPI_DSI_MODE_VIDEO_AUTO_VERT	BIT(3)
/* enable hsync-end packets in vsync-pulse and v-porch area */
#define MIPI_DSI_MODE_VIDEO_HSE		BIT(4)
/* disable hfront-porch area */
#define MIPI_DSI_MODE_VIDEO_HFP		BIT(5)
/* disable hback-porch area */
#define MIPI_DSI_MODE_VIDEO_HBP		BIT(6)
/* disable hsync-active area */
#define MIPI_DSI_MODE_VIDEO_HSA		BIT(7)
/* flush display FIFO on vsync pulse */
#define MIPI_DSI_MODE_VSYNC_FLUSH	BIT(8)
/* disable EoT packets in HS mode */
#define MIPI_DSI_MODE_EOT_PACKET	BIT(9)
/* device supports non-continuous clock behavior (DSI spec 5.6.1) */
#define MIPI_DSI_CLOCK_NON_CONTINUOUS	BIT(10)
/* transmit data in low power */
#define MIPI_DSI_MODE_LPM		BIT(11)

enum mipi_dsi_pixel_format {
	MIPI_DSI_FMT_RGB888,
	MIPI_DSI_FMT_RGB666,
	MIPI_DSI_FMT_RGB666_PACKED,
	MIPI_DSI_FMT_RGB565,
};

/**
 * struct mipi_dsi_device - DSI peripheral device
 * @host: DSI host for this peripheral
 * @dev: driver model device node for this peripheral
 * @channel: virtual channel assigned to the peripheral
 * @format: pixel format for video mode
 * @lanes: number of active data lanes
 * @mode_flags: DSI operation mode related flags
 */
struct mipi_dsi_device {
	struct mipi_dsi_host *host;
	struct device dev;

	unsigned int channel;
	unsigned int lanes;
	enum mipi_dsi_pixel_format format;
	unsigned long mode_flags;
};

static inline struct mipi_dsi_device *to_mipi_dsi_device(struct device *dev)
{
	return container_of(dev, struct mipi_dsi_device, dev);
}

int mipi_dsi_attach(struct mipi_dsi_device *dsi);
int mipi_dsi_detach(struct mipi_dsi_device *dsi);
int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
					    u16 value);

ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
			       size_t size);
ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
			      size_t num_params, void *data, size_t size);

/**
 * enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
 * @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
 *    information only
 * @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
 *    V-Blanking and H-Blanking information
 */
enum mipi_dsi_dcs_tear_mode {
	MIPI_DSI_DCS_TEAR_MODE_VBLANK,
	MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
};

#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
#define MIPI_DSI_DCS_POWER_MODE_NORMAL  (1 << 3)
#define MIPI_DSI_DCS_POWER_MODE_SLEEP   (1 << 4)
#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
#define MIPI_DSI_DCS_POWER_MODE_IDLE    (1 << 6)

ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
				  const void *data, size_t len);
ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
			   const void *data, size_t len);
ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
			  size_t len);
int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode);
int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format);
int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
			     enum mipi_dsi_dcs_tear_mode mode);
int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);

/**
 * struct mipi_dsi_driver - DSI driver
 * @driver: device driver model driver
 * @probe: callback for device binding
 * @remove: callback for device unbinding
 * @shutdown: called at shutdown time to quiesce the device
 */
struct mipi_dsi_driver {
	struct device_driver driver;
	int(*probe)(struct mipi_dsi_device *dsi);
	int(*remove)(struct mipi_dsi_device *dsi);
	void (*shutdown)(struct mipi_dsi_device *dsi);
};

static inline struct mipi_dsi_driver *
to_mipi_dsi_driver(struct device_driver *driver)
{
	return container_of(driver, struct mipi_dsi_driver, driver);
}

static inline void *mipi_dsi_get_drvdata(const struct mipi_dsi_device *dsi)
{
	return dev_get_drvdata(&dsi->dev);
}

static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device *dsi, void *data)
{
	dev_set_drvdata(&dsi->dev, data);
}

int mipi_dsi_driver_register(struct mipi_dsi_driver *driver);
void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);

#define module_mipi_dsi_driver(__mipi_dsi_driver) \
	module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
			mipi_dsi_driver_unregister)

#endif /* __DRM_MIPI_DSI__ */
Commit	Line	Data
068a0023 AH	1	/*
	2	* MIPI DSI Bus
	3	*
	4	* Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
	5	* Andrzej Hajda <[email protected]>
	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
	17	struct mipi_dsi_host;
	18	struct mipi_dsi_device;
	19
1d96d4a6 AH	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
068a0023 AH	25	/**
	26	* struct mipi_dsi_msg - read/write DSI buffer
	27	* @channel: virtual channel id
	28	* @type: payload data type
009081e0	29	* @flags: flags controlling this message transmission
068a0023 AH	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	*/
	35	struct mipi_dsi_msg {
	36	u8 channel;
	37	u8 type;
1d96d4a6	38	u16 flags;
068a0023 AH	39
	40	size_t tx_len;
	41	const void *tx_buf;
	42
	43	size_t rx_len;
	44	void *rx_buf;
	45	};
	46
02acb76d TR	47	bool mipi_dsi_packet_format_is_short(u8 type);
	48	bool mipi_dsi_packet_format_is_long(u8 type);
	49
a52879e8 TR	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	*/
	58	struct mipi_dsi_packet {
	59	size_t size;
	60	u8 header[4];
	61	size_t payload_length;
	62	const u8 *payload;
	63	};
	64
	65	int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
	66	const struct mipi_dsi_msg *msg);
	67
068a0023 AH	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
009081e0 TR	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.
068a0023 AH	85	*/
	86	struct 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,
ed6ff40e	92	const struct mipi_dsi_msg *msg);
068a0023 AH	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	*/
	100	struct mipi_dsi_host {
	101	struct device *dev;
	102	const struct mipi_dsi_host_ops *ops;
	103	};
	104
	105	int mipi_dsi_host_register(struct mipi_dsi_host *host);
	106	void 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)
884d6a0b AC	130	/* device supports non-continuous clock behavior (DSI spec 5.6.1) */
884d6a0b AC	131	#define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)
d87f09ab ID	132	/* transmit data in low power */
d87f09ab ID	133	#define MIPI_DSI_MODE_LPM BIT(11)
068a0023 AH	134
	135	enum 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	*/
	151	struct 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
77df01dc TR	161	static inline struct mipi_dsi_device to_mipi_dsi_device(struct device dev)
	162	{
	163	return container_of(dev, struct mipi_dsi_device, dev);
	164	}
068a0023 AH	165
	166	int mipi_dsi_attach(struct mipi_dsi_device *dsi);
	167	int mipi_dsi_detach(struct mipi_dsi_device *dsi);
dbf30b69 YC	168	int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
dbf30b69 YC	169	u16 value);
550ab848 TR	170
	171	ssize_t mipi_dsi_generic_write(struct mipi_dsi_device dsi, const void payload,
	172	size_t size);
	173	ssize_t mipi_dsi_generic_read(struct mipi_dsi_device dsi, const void params,
	174	size_t num_params, void *data, size_t size);
	175
42fe1e75 YC	176	/**
	177	* enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
	178	* @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
	179	* information only
	180	* @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
	181	* V-Blanking and H-Blanking information
	182	*/
	183	enum mipi_dsi_dcs_tear_mode {
	184	MIPI_DSI_DCS_TEAR_MODE_VBLANK,
	185	MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
	186	};
	187
3d9a8fcf TR	188	#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
	189	#define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
	190	#define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
	191	#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
	192	#define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
	193
960dd616 TR	194	ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
	195	const void *data, size_t len);
	196	ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
	197	const void *data, size_t len);
3c523d7d TR	198	ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device dsi, u8 cmd, void data,
3c523d7d TR	199	size_t len);
083d573f	200	int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
2f16b897	201	int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
3d9a8fcf	202	int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device dsi, u8 mode);
5cc0af16	203	int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device dsi, u8 format);
42fe1e75 YC	204	int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
	205	int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
	206	int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
	207	int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
	208	int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
	209	int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
	210	enum mipi_dsi_dcs_tear_mode mode);
5cc0af16	211	int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
068a0023 AH	212
	213	/**
	214	* struct mipi_dsi_driver - DSI driver
	215	* @driver: device driver model driver
	216	* @probe: callback for device binding
	217	* @remove: callback for device unbinding
d1621803	218	* @shutdown: called at shutdown time to quiesce the device
068a0023 AH	219	*/
	220	struct mipi_dsi_driver {
	221	struct device_driver driver;
	222	int(probe)(struct mipi_dsi_device dsi);
	223	int(remove)(struct mipi_dsi_device dsi);
d1621803	224	void (shutdown)(struct mipi_dsi_device dsi);
068a0023 AH	225	};
068a0023 AH	226
77df01dc TR	227	static inline struct mipi_dsi_driver *
	228	to_mipi_dsi_driver(struct device_driver *driver)
	229	{
	230	return container_of(driver, struct mipi_dsi_driver, driver);
	231	}
068a0023 AH	232
	233	static inline void mipi_dsi_get_drvdata(const struct mipi_dsi_device dsi)
	234	{
	235	return dev_get_drvdata(&dsi->dev);
	236	}
	237
	238	static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device dsi, void data)
	239	{
	240	dev_set_drvdata(&dsi->dev, data);
	241	}
	242
	243	int mipi_dsi_driver_register(struct mipi_dsi_driver *driver);
	244	void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
	245
	246	#define module_mipi_dsi_driver(__mipi_dsi_driver) \
	247	module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
	248	mipi_dsi_driver_unregister)
	249
	250	#endif /* __DRM_MIPI_DSI__ */