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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * MIPI DSI Bus
 *
 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
 * Andrzej Hajda <a.hajda@samsung.com>
 */

#ifndef __DRM_MIPI_DSI_H__
#define __DRM_MIPI_DSI_H__

#include <linux/device.h>

struct mipi_dsi_host;
struct mipi_dsi_device;
struct drm_dsc_picture_parameter_set;

/* 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.
 *
 * Also note that those callbacks can be called no matter the state the
 * host is in. Drivers that need the underlying device to be powered to
 * perform these operations will first need to make sure it's been
 * properly enabled.
 */
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
 * @list: list management
 */
struct mipi_dsi_host {
	struct device *dev;
	const struct mipi_dsi_host_ops *ops;
	struct list_head list;
};

int mipi_dsi_host_register(struct mipi_dsi_host *host);
void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node);

/* 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_NO_HFP	BIT(5)
/* disable hback-porch area */
#define MIPI_DSI_MODE_VIDEO_NO_HBP	BIT(6)
/* disable hsync-active area */
#define MIPI_DSI_MODE_VIDEO_NO_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_NO_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)
/* transmit data ending at the same time for all lanes within one hsync */
#define MIPI_DSI_HS_PKT_END_ALIGNED	BIT(12)

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

#define DSI_DEV_NAME_SIZE		20

/**
 * struct mipi_dsi_device_info - template for creating a mipi_dsi_device
 * @type: DSI peripheral chip type
 * @channel: DSI virtual channel assigned to peripheral
 * @node: pointer to OF device node or NULL
 *
 * This is populated and passed to mipi_dsi_device_new to create a new
 * DSI device
 */
struct mipi_dsi_device_info {
	char type[DSI_DEV_NAME_SIZE];
	u32 channel;
	struct device_node *node;
};

/**
 * struct mipi_dsi_device - DSI peripheral device
 * @host: DSI host for this peripheral
 * @dev: driver model device node for this peripheral
 * @name: DSI peripheral chip type
 * @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
 * @hs_rate: maximum lane frequency for high speed mode in hertz, this should
 * be set to the real limits of the hardware, zero is only accepted for
 * legacy drivers
 * @lp_rate: maximum lane frequency for low power mode in hertz, this should
 * be set to the real limits of the hardware, zero is only accepted for
 * legacy drivers
 */
struct mipi_dsi_device {
	struct mipi_dsi_host *host;
	struct device dev;

	char name[DSI_DEV_NAME_SIZE];
	unsigned int channel;
	unsigned int lanes;
	enum mipi_dsi_pixel_format format;
	unsigned long mode_flags;
	unsigned long hs_rate;
	unsigned long lp_rate;
};

#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"

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

/**
 * mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
 *                                given pixel format defined by the MIPI DSI
 *                                specification
 * @fmt: MIPI DSI pixel format
 *
 * Returns: The number of bits per pixel of the given pixel format.
 */
static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
{
	switch (fmt) {
	case MIPI_DSI_FMT_RGB888:
	case MIPI_DSI_FMT_RGB666:
		return 24;

	case MIPI_DSI_FMT_RGB666_PACKED:
		return 18;

	case MIPI_DSI_FMT_RGB565:
		return 16;
	}

	return -EINVAL;
}

struct mipi_dsi_device *
mipi_dsi_device_register_full(struct mipi_dsi_host *host,
			      const struct mipi_dsi_device_info *info);
void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
struct mipi_dsi_device *
devm_mipi_dsi_device_register_full(struct device *dev, struct mipi_dsi_host *host,
				   const struct mipi_dsi_device_info *info);
struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np);
int mipi_dsi_attach(struct mipi_dsi_device *dsi);
int mipi_dsi_detach(struct mipi_dsi_device *dsi);
int devm_mipi_dsi_attach(struct device *dev, struct mipi_dsi_device *dsi);
int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
					    u16 value);
ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
				       const struct drm_dsc_picture_parameter_set *pps);

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_column_address(struct mipi_dsi_device *dsi, u16 start,
				    u16 end);
int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
				  u16 end);
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);
int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
					u16 brightness);
int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
					u16 *brightness);

/**
 * mipi_dsi_dcs_write_seq - transmit a DCS command with payload
 * @dsi: DSI peripheral device
 * @cmd: Command
 * @seq: buffer containing data to be transmitted
 */
#define mipi_dsi_dcs_write_seq(dsi, cmd, seq...) do {				\
		static const u8 d[] = { cmd, seq };				\
		struct device *dev = &dsi->dev;	\
		int ret;						\
		ret = mipi_dsi_dcs_write_buffer(dsi, d, ARRAY_SIZE(d));	\
		if (ret < 0) {						\
			dev_err_ratelimited(dev, "sending command %#02x failed: %d\n", cmd, ret); \
			return ret;						\
		}						\
	} while (0)

/**
 * 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_full(struct mipi_dsi_driver *driver,
				  struct module *owner);
void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);

#define mipi_dsi_driver_register(driver) \
	mipi_dsi_driver_register_full(driver, THIS_MODULE)

#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
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
	14	struct mipi_dsi_host;
	15	struct mipi_dsi_device;
f4dea1aa	16	struct 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	*/
	33	struct 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	45	bool mipi_dsi_packet_format_is_short(u8 type);
	46	bool 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	*/
	56	struct mipi_dsi_packet {
	57	size_t size;
	58	u8 header[4];
	59	size_t payload_length;
	60	const u8 *payload;
	61	};
	62
	63	int 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.
bacbab58 MR	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.
068a0023 AH	88	*/
	89	struct 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,
ed6ff40e	95	const struct mipi_dsi_msg *msg);
068a0023 AH	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
97b6ae50	102	* @list: list management
068a0023 AH	103	*/
	104	struct mipi_dsi_host {
	105	struct device *dev;
	106	const struct mipi_dsi_host_ops *ops;
97b6ae50	107	struct list_head list;
068a0023 AH	108	};
	109
	110	int mipi_dsi_host_register(struct mipi_dsi_host *host);
	111	void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
97b6ae50	112	struct mipi_dsi_host of_find_mipi_dsi_host_by_node(struct device_node node);
068a0023 AH	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 */
0f3b68b6	127	#define MIPI_DSI_MODE_VIDEO_NO_HFP BIT(5)
068a0023	128	/* disable hback-porch area */
0f3b68b6	129	#define MIPI_DSI_MODE_VIDEO_NO_HBP BIT(6)
068a0023	130	/* disable hsync-active area */
0f3b68b6	131	#define MIPI_DSI_MODE_VIDEO_NO_HSA BIT(7)
068a0023 AH	132	/* flush display FIFO on vsync pulse */
	133	#define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8)
	134	/* disable EoT packets in HS mode */
0f3b68b6	135	#define MIPI_DSI_MODE_NO_EOT_PACKET BIT(9)
884d6a0b AC	136	/* device supports non-continuous clock behavior (DSI spec 5.6.1) */
884d6a0b AC	137	#define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)
d87f09ab ID	138	/* transmit data in low power */
d87f09ab ID	139	#define MIPI_DSI_MODE_LPM BIT(11)
14989152 RBC	140	/* transmit data ending at the same time for all lanes within one hsync */
14989152 RBC	141	#define MIPI_DSI_HS_PKT_END_ALIGNED BIT(12)
068a0023 AH	142
	143	enum 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
bf4363ce AT	150	#define DSI_DEV_NAME_SIZE 20
	151
	152	/**
c63ae8a9	153	* struct mipi_dsi_device_info - template for creating a mipi_dsi_device
bf4363ce	154	* @type: DSI peripheral chip type
c63ae8a9	155	* @channel: DSI virtual channel assigned to peripheral
bf4363ce	156	* @node: pointer to OF device node or NULL
c63ae8a9 AT	157	*
	158	* This is populated and passed to mipi_dsi_device_new to create a new
	159	* DSI device
	160	*/
	161	struct mipi_dsi_device_info {
bf4363ce	162	char type[DSI_DEV_NAME_SIZE];
c63ae8a9 AT	163	u32 channel;
	164	struct device_node *node;
	165	};
	166
068a0023 AH	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
bf4363ce	171	* @name: DSI peripheral chip type
068a0023 AH	172	* @channel: virtual channel assigned to the peripheral
	173	* @format: pixel format for video mode
	174	* @lanes: number of active data lanes
	175	* @mode_flags: DSI operation mode related flags
e982e3f0 LW	176	* @hs_rate: maximum lane frequency for high speed mode in hertz, this should
	177	* be set to the real limits of the hardware, zero is only accepted for
	178	* legacy drivers
	179	* @lp_rate: maximum lane frequency for low power mode in hertz, this should
	180	* be set to the real limits of the hardware, zero is only accepted for
	181	* legacy drivers
068a0023 AH	182	*/
	183	struct mipi_dsi_device {
	184	struct mipi_dsi_host *host;
	185	struct device dev;
	186
bf4363ce	187	char name[DSI_DEV_NAME_SIZE];
068a0023 AH	188	unsigned int channel;
	189	unsigned int lanes;
	190	enum mipi_dsi_pixel_format format;
	191	unsigned long mode_flags;
e982e3f0 LW	192	unsigned long hs_rate;
e982e3f0 LW	193	unsigned long lp_rate;
068a0023 AH	194	};
068a0023 AH	195
babb24fe TR	196	#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
babb24fe TR	197
77df01dc TR	198	static inline struct mipi_dsi_device to_mipi_dsi_device(struct device dev)
	199	{
	200	return container_of(dev, struct mipi_dsi_device, dev);
	201	}
068a0023	202
ec26d9e9 LY	203	/**
	204	* mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
	205	* given pixel format defined by the MIPI DSI
	206	* specification
	207	* @fmt: MIPI DSI pixel format
	208	*
	209	* Returns: The number of bits per pixel of the given pixel format.
	210	*/
	211	static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
	212	{
	213	switch (fmt) {
	214	case MIPI_DSI_FMT_RGB888:
	215	case MIPI_DSI_FMT_RGB666:
	216	return 24;
	217
	218	case MIPI_DSI_FMT_RGB666_PACKED:
	219	return 18;
	220
	221	case MIPI_DSI_FMT_RGB565:
	222	return 16;
	223	}
	224
	225	return -EINVAL;
	226	}
	227
c63ae8a9 AT	228	struct mipi_dsi_device *
	229	mipi_dsi_device_register_full(struct mipi_dsi_host *host,
	230	const struct mipi_dsi_device_info *info);
509e42ce	231	void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
a1419fb4 MR	232	struct mipi_dsi_device *
	233	devm_mipi_dsi_device_register_full(struct device dev, struct mipi_dsi_host host,
	234	const struct mipi_dsi_device_info *info);
3ef05924	235	struct mipi_dsi_device of_find_mipi_dsi_device_by_node(struct device_node np);
068a0023 AH	236	int mipi_dsi_attach(struct mipi_dsi_device *dsi);
068a0023 AH	237	int mipi_dsi_detach(struct mipi_dsi_device *dsi);
db656849	238	int devm_mipi_dsi_attach(struct device dev, struct mipi_dsi_device dsi);
6e8c9e33 WJ	239	int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
6e8c9e33 WJ	240	int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
dbf30b69 YC	241	int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
dbf30b69 YC	242	u16 value);
f4dea1aa JN	243	ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
	244	ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
	245	const struct drm_dsc_picture_parameter_set *pps);
550ab848 TR	246
	247	ssize_t mipi_dsi_generic_write(struct mipi_dsi_device dsi, const void payload,
	248	size_t size);
	249	ssize_t mipi_dsi_generic_read(struct mipi_dsi_device dsi, const void params,
	250	size_t num_params, void *data, size_t size);
	251
42fe1e75 YC	252	/**
	253	* enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
	254	* @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
	255	* information only
	256	* @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
	257	* V-Blanking and H-Blanking information
	258	*/
	259	enum mipi_dsi_dcs_tear_mode {
	260	MIPI_DSI_DCS_TEAR_MODE_VBLANK,
	261	MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
	262	};
	263
3d9a8fcf TR	264	#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
	265	#define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
	266	#define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
	267	#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
	268	#define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
	269
960dd616 TR	270	ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
	271	const void *data, size_t len);
	272	ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
	273	const void *data, size_t len);
3c523d7d TR	274	ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device dsi, u8 cmd, void data,
3c523d7d TR	275	size_t len);
083d573f	276	int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
2f16b897	277	int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
3d9a8fcf	278	int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device dsi, u8 mode);
5cc0af16	279	int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device dsi, u8 format);
42fe1e75 YC	280	int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
	281	int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
	282	int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
	283	int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
3b46d4a0 TR	284	int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
	285	u16 end);
	286	int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
	287	u16 end);
42fe1e75 YC	288	int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi);
	289	int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
	290	enum mipi_dsi_dcs_tear_mode mode);
5cc0af16	291	int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
bbdcf516	292	int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
1a9d7593 VSB	293	int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
	294	u16 brightness);
	295	int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
	296	u16 *brightness);
068a0023	297
2a9e9daf JS	298	/**
	299	* mipi_dsi_dcs_write_seq - transmit a DCS command with payload
	300	* @dsi: DSI peripheral device
	301	* @cmd: Command
	302	* @seq: buffer containing data to be transmitted
	303	*/
	304	#define mipi_dsi_dcs_write_seq(dsi, cmd, seq...) do { \
	305	static const u8 d[] = { cmd, seq }; \
	306	struct device *dev = &dsi->dev; \
	307	int ret; \
	308	ret = mipi_dsi_dcs_write_buffer(dsi, d, ARRAY_SIZE(d)); \
	309	if (ret < 0) { \
	310	dev_err_ratelimited(dev, "sending command %#02x failed: %d\n", cmd, ret); \
	311	return ret; \
	312	} \
	313	} while (0)
	314
068a0023 AH	315	/**
	316	* struct mipi_dsi_driver - DSI driver
	317	* @driver: device driver model driver
	318	* @probe: callback for device binding
	319	* @remove: callback for device unbinding
d1621803	320	* @shutdown: called at shutdown time to quiesce the device
068a0023 AH	321	*/
	322	struct mipi_dsi_driver {
	323	struct device_driver driver;
	324	int(probe)(struct mipi_dsi_device dsi);
	325	int(remove)(struct mipi_dsi_device dsi);
d1621803	326	void (shutdown)(struct mipi_dsi_device dsi);
068a0023 AH	327	};
068a0023 AH	328
77df01dc TR	329	static inline struct mipi_dsi_driver *
	330	to_mipi_dsi_driver(struct device_driver *driver)
	331	{
	332	return container_of(driver, struct mipi_dsi_driver, driver);
	333	}
068a0023 AH	334
	335	static inline void mipi_dsi_get_drvdata(const struct mipi_dsi_device dsi)
	336	{
	337	return dev_get_drvdata(&dsi->dev);
	338	}
	339
	340	static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device dsi, void data)
	341	{
	342	dev_set_drvdata(&dsi->dev, data);
	343	}
	344
99035e99 TR	345	int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
99035e99 TR	346	struct module *owner);
068a0023 AH	347	void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
068a0023 AH	348
99035e99 TR	349	#define mipi_dsi_driver_register(driver) \
	350	mipi_dsi_driver_register_full(driver, THIS_MODULE)
	351
068a0023 AH	352	#define module_mipi_dsi_driver(__mipi_dsi_driver) \
	353	module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
	354	mipi_dsi_driver_unregister)
	355
	356	#endif /* __DRM_MIPI_DSI__ */