[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>
#include <linux/delay.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
 * @attached: the DSI device has been successfully attached
 * @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
 * @dsc: panel/bridge DSC pps payload to be sent
 */
struct mipi_dsi_device {
	struct mipi_dsi_host *host;
	struct device dev;
	bool attached;

	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;
	struct drm_dsc_config *dsc;
};

/**
 * struct mipi_dsi_multi_context - Context to call multiple MIPI DSI funcs in a row
 */
struct mipi_dsi_multi_context {
	/**
	 * @dsi: Pointer to the MIPI DSI device
	 */
	struct mipi_dsi_device *dsi;

	/**
	 * @accum_err: Storage for the accumulated error over the multiple calls
	 *
	 * Init to 0. If a function encounters an error then the error code
	 * will be stored here. If you call a function and this points to a
	 * non-zero value then the function will be a noop. This allows calling
	 * a function many times in a row and just checking the error at the
	 * end to see if any of them failed.
	 */
	int accum_err;
};

#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"

#define to_mipi_dsi_device(__dev)	container_of_const(__dev, struct mipi_dsi_device, dev)

extern const struct bus_type mipi_dsi_bus_type;
#define dev_is_mipi_dsi(dev)	((dev)->bus == &mipi_dsi_bus_type)

/**
 * 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;
}

enum mipi_dsi_compression_algo {
	MIPI_DSI_COMPRESSION_DSC = 0,
	MIPI_DSI_COMPRESSION_VENDOR = 3,
	/* other two values are reserved, DSI 1.3 */
};

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);
int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
int mipi_dsi_compression_mode_ext(struct mipi_dsi_device *dsi, bool enable,
				  enum mipi_dsi_compression_algo algo,
				  unsigned int pps_selector);
int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
				   const struct drm_dsc_picture_parameter_set *pps);

void mipi_dsi_compression_mode_ext_multi(struct mipi_dsi_multi_context *ctx,
					 bool enable,
					 enum mipi_dsi_compression_algo algo,
					 unsigned int pps_selector);
void mipi_dsi_compression_mode_multi(struct mipi_dsi_multi_context *ctx,
				     bool enable);
void mipi_dsi_picture_parameter_set_multi(struct mipi_dsi_multi_context *ctx,
					  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);
int mipi_dsi_generic_write_chatty(struct mipi_dsi_device *dsi,
				  const void *payload, size_t size);
void mipi_dsi_generic_write_multi(struct mipi_dsi_multi_context *ctx,
				  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);
u32 drm_mipi_dsi_get_input_bus_fmt(enum mipi_dsi_pixel_format dsi_format);

#define mipi_dsi_msleep(ctx, delay)	\
	do {				\
		if (!(ctx)->accum_err)	\
			msleep(delay);	\
	} while (0)

#define mipi_dsi_usleep_range(ctx, min, max)	\
	do {					\
		if (!(ctx)->accum_err)		\
			usleep_range(min, max);	\
	} while (0)

/**
 * 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);
int mipi_dsi_dcs_write_buffer_chatty(struct mipi_dsi_device *dsi,
				     const void *data, size_t len);
void mipi_dsi_dcs_write_buffer_multi(struct mipi_dsi_multi_context *ctx,
				     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_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);
int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
					     u16 brightness);
int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
					     u16 *brightness);

void mipi_dsi_dcs_nop_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_enter_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_exit_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_display_off_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_display_on_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_tear_on_multi(struct mipi_dsi_multi_context *ctx,
				    enum mipi_dsi_dcs_tear_mode mode);
void mipi_dsi_turn_on_peripheral_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_soft_reset_multi(struct mipi_dsi_multi_context *ctx);
void mipi_dsi_dcs_set_display_brightness_multi(struct mipi_dsi_multi_context *ctx,
					       u16 brightness);
void mipi_dsi_dcs_set_pixel_format_multi(struct mipi_dsi_multi_context *ctx,
					 u8 format);
void mipi_dsi_dcs_set_column_address_multi(struct mipi_dsi_multi_context *ctx,
					   u16 start, u16 end);
void mipi_dsi_dcs_set_page_address_multi(struct mipi_dsi_multi_context *ctx,
					 u16 start, u16 end);
void mipi_dsi_dcs_set_tear_scanline_multi(struct mipi_dsi_multi_context *ctx,
					  u16 scanline);
void mipi_dsi_dcs_set_tear_off_multi(struct mipi_dsi_multi_context *ctx);

/**
 * mipi_dsi_generic_write_seq - transmit data using a generic write packet
 *
 * This macro will print errors for you and will RETURN FROM THE CALLING
 * FUNCTION (yes this is non-intuitive) upon error.
 *
 * Because of the non-intuitive return behavior, THIS MACRO IS DEPRECATED.
 * Please replace calls of it with mipi_dsi_generic_write_seq_multi().
 *
 * @dsi: DSI peripheral device
 * @seq: buffer containing the payload
 */
#define mipi_dsi_generic_write_seq(dsi, seq...)                                \
	do {                                                                   \
		static const u8 d[] = { seq };                                 \
		int ret;                                                       \
		ret = mipi_dsi_generic_write_chatty(dsi, d, ARRAY_SIZE(d));    \
		if (ret < 0)                                                   \
			return ret;                                            \
	} while (0)

/**
 * mipi_dsi_generic_write_seq_multi - transmit data using a generic write packet
 *
 * This macro will print errors for you and error handling is optimized for
 * callers that call this multiple times in a row.
 *
 * @ctx: Context for multiple DSI transactions
 * @seq: buffer containing the payload
 */
#define mipi_dsi_generic_write_seq_multi(ctx, seq...)                \
	do {                                                         \
		static const u8 d[] = { seq };                       \
		mipi_dsi_generic_write_multi(ctx, d, ARRAY_SIZE(d)); \
	} while (0)

/**
 * mipi_dsi_dcs_write_seq_multi - transmit a DCS command with payload
 *
 * This macro will print errors for you and error handling is optimized for
 * callers that call this multiple times in a row.
 *
 * @ctx: Context for multiple DSI transactions
 * @cmd: Command
 * @seq: buffer containing data to be transmitted
 */
#define mipi_dsi_dcs_write_seq_multi(ctx, cmd, seq...)                  \
	do {                                                            \
		static const u8 d[] = { cmd, seq };                     \
		mipi_dsi_dcs_write_buffer_multi(ctx, d, ARRAY_SIZE(d)); \
	} 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);
	void (*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>
3ebc76c4	13	#include <linux/delay.h>
068a0023 AH	14
	15	struct mipi_dsi_host;
	16	struct mipi_dsi_device;
f4dea1aa	17	struct drm_dsc_picture_parameter_set;
068a0023	18
1d96d4a6 AH	19	/* request ACK from peripheral */
	20	#define MIPI_DSI_MSG_REQ_ACK BIT(0)
	21	/* use Low Power Mode to transmit message */
	22	#define MIPI_DSI_MSG_USE_LPM BIT(1)
	23
068a0023 AH	24	/**
	25	* struct mipi_dsi_msg - read/write DSI buffer
	26	* @channel: virtual channel id
	27	* @type: payload data type
009081e0	28	* @flags: flags controlling this message transmission
068a0023 AH	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
	33	*/
	34	struct mipi_dsi_msg {
	35	u8 channel;
	36	u8 type;
1d96d4a6	37	u16 flags;
068a0023 AH	38
	39	size_t tx_len;
	40	const void *tx_buf;
	41
	42	size_t rx_len;
	43	void *rx_buf;
	44	};
	45
02acb76d TR	46	bool mipi_dsi_packet_format_is_short(u8 type);
	47	bool mipi_dsi_packet_format_is_long(u8 type);
	48
a52879e8 TR	49	/**
	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
	56	*/
	57	struct mipi_dsi_packet {
	58	size_t size;
	59	u8 header[4];
	60	size_t payload_length;
	61	const u8 *payload;
	62	};
	63
	64	int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
	65	const struct mipi_dsi_msg *msg);
	66
068a0023 AH	67	/**
	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
009081e0 TR	71	* @transfer: transmit a DSI packet
	72	*
	73	* DSI packets transmitted by .transfer() are passed in as mipi_dsi_msg
	74	* structures. This structure contains information about the type of packet
	75	* being transmitted as well as the transmit and receive buffers. When an
	76	* error is encountered during transmission, this function will return a
	77	* negative error code. On success it shall return the number of bytes
	78	* transmitted for write packets or the number of bytes received for read
	79	* packets.
	80	*
	81	* Note that typically DSI packet transmission is atomic, so the .transfer()
	82	* function will seldomly return anything other than the number of bytes
	83	* contained in the transmit buffer on success.
bacbab58 MR	84	*
	85	* Also note that those callbacks can be called no matter the state the
	86	* host is in. Drivers that need the underlying device to be powered to
	87	* perform these operations will first need to make sure it's been
	88	* properly enabled.
068a0023 AH	89	*/
	90	struct mipi_dsi_host_ops {
	91	int (attach)(struct mipi_dsi_host host,
	92	struct mipi_dsi_device *dsi);
	93	int (detach)(struct mipi_dsi_host host,
	94	struct mipi_dsi_device *dsi);
	95	ssize_t (transfer)(struct mipi_dsi_host host,
ed6ff40e	96	const struct mipi_dsi_msg *msg);
068a0023 AH	97	};
	98
	99	/**
	100	* struct mipi_dsi_host - DSI host device
	101	* @dev: driver model device node for this DSI host
	102	* @ops: DSI host operations
97b6ae50	103	* @list: list management
068a0023 AH	104	*/
	105	struct mipi_dsi_host {
	106	struct device *dev;
	107	const struct mipi_dsi_host_ops *ops;
97b6ae50	108	struct list_head list;
068a0023 AH	109	};
	110
	111	int mipi_dsi_host_register(struct mipi_dsi_host *host);
	112	void mipi_dsi_host_unregister(struct mipi_dsi_host *host);
97b6ae50	113	struct mipi_dsi_host of_find_mipi_dsi_host_by_node(struct device_node node);
068a0023 AH	114
	115	/* DSI mode flags */
	116
	117	/* video mode */
	118	#define MIPI_DSI_MODE_VIDEO BIT(0)
	119	/* video burst mode */
	120	#define MIPI_DSI_MODE_VIDEO_BURST BIT(1)
	121	/* video pulse mode */
	122	#define MIPI_DSI_MODE_VIDEO_SYNC_PULSE BIT(2)
	123	/* enable auto vertical count mode */
	124	#define MIPI_DSI_MODE_VIDEO_AUTO_VERT BIT(3)
	125	/* enable hsync-end packets in vsync-pulse and v-porch area */
	126	#define MIPI_DSI_MODE_VIDEO_HSE BIT(4)
	127	/* disable hfront-porch area */
0f3b68b6	128	#define MIPI_DSI_MODE_VIDEO_NO_HFP BIT(5)
068a0023	129	/* disable hback-porch area */
0f3b68b6	130	#define MIPI_DSI_MODE_VIDEO_NO_HBP BIT(6)
068a0023	131	/* disable hsync-active area */
0f3b68b6	132	#define MIPI_DSI_MODE_VIDEO_NO_HSA BIT(7)
068a0023 AH	133	/* flush display FIFO on vsync pulse */
	134	#define MIPI_DSI_MODE_VSYNC_FLUSH BIT(8)
	135	/* disable EoT packets in HS mode */
0f3b68b6	136	#define MIPI_DSI_MODE_NO_EOT_PACKET BIT(9)
884d6a0b AC	137	/* device supports non-continuous clock behavior (DSI spec 5.6.1) */
884d6a0b AC	138	#define MIPI_DSI_CLOCK_NON_CONTINUOUS BIT(10)
d87f09ab ID	139	/* transmit data in low power */
d87f09ab ID	140	#define MIPI_DSI_MODE_LPM BIT(11)
14989152 RBC	141	/* transmit data ending at the same time for all lanes within one hsync */
14989152 RBC	142	#define MIPI_DSI_HS_PKT_END_ALIGNED BIT(12)
068a0023 AH	143
	144	enum mipi_dsi_pixel_format {
	145	MIPI_DSI_FMT_RGB888,
	146	MIPI_DSI_FMT_RGB666,
	147	MIPI_DSI_FMT_RGB666_PACKED,
	148	MIPI_DSI_FMT_RGB565,
	149	};
	150
bf4363ce AT	151	#define DSI_DEV_NAME_SIZE 20
	152
	153	/**
c63ae8a9	154	* struct mipi_dsi_device_info - template for creating a mipi_dsi_device
bf4363ce	155	* @type: DSI peripheral chip type
c63ae8a9	156	* @channel: DSI virtual channel assigned to peripheral
bf4363ce	157	* @node: pointer to OF device node or NULL
c63ae8a9 AT	158	*
	159	* This is populated and passed to mipi_dsi_device_new to create a new
	160	* DSI device
	161	*/
	162	struct mipi_dsi_device_info {
bf4363ce	163	char type[DSI_DEV_NAME_SIZE];
c63ae8a9 AT	164	u32 channel;
	165	struct device_node *node;
	166	};
	167
068a0023 AH	168	/**
	169	* struct mipi_dsi_device - DSI peripheral device
	170	* @host: DSI host for this peripheral
	171	* @dev: driver model device node for this peripheral
90d50b8d	172	* @attached: the DSI device has been successfully attached
bf4363ce	173	* @name: DSI peripheral chip type
068a0023 AH	174	* @channel: virtual channel assigned to the peripheral
	175	* @format: pixel format for video mode
	176	* @lanes: number of active data lanes
	177	* @mode_flags: DSI operation mode related flags
e982e3f0 LW	178	* @hs_rate: maximum lane frequency for high speed mode in hertz, this should
	179	* be set to the real limits of the hardware, zero is only accepted for
	180	* legacy drivers
	181	* @lp_rate: maximum lane frequency for low power mode in hertz, this should
	182	* be set to the real limits of the hardware, zero is only accepted for
	183	* legacy drivers
02c830b3	184	* @dsc: panel/bridge DSC pps payload to be sent
068a0023 AH	185	*/
	186	struct mipi_dsi_device {
	187	struct mipi_dsi_host *host;
	188	struct device dev;
90d50b8d	189	bool attached;
068a0023	190
bf4363ce	191	char name[DSI_DEV_NAME_SIZE];
068a0023 AH	192	unsigned int channel;
	193	unsigned int lanes;
	194	enum mipi_dsi_pixel_format format;
	195	unsigned long mode_flags;
e982e3f0 LW	196	unsigned long hs_rate;
e982e3f0 LW	197	unsigned long lp_rate;
02c830b3	198	struct drm_dsc_config *dsc;
068a0023 AH	199	};
068a0023 AH	200
966e397e DA	201	/**
	202	* struct mipi_dsi_multi_context - Context to call multiple MIPI DSI funcs in a row
	203	*/
	204	struct mipi_dsi_multi_context {
	205	/**
	206	* @dsi: Pointer to the MIPI DSI device
	207	*/
	208	struct mipi_dsi_device *dsi;
	209
	210	/**
	211	* @accum_err: Storage for the accumulated error over the multiple calls
	212	*
	213	* Init to 0. If a function encounters an error then the error code
	214	* will be stored here. If you call a function and this points to a
	215	* non-zero value then the function will be a noop. This allows calling
	216	* a function many times in a row and just checking the error at the
	217	* end to see if any of them failed.
	218	*/
	219	int accum_err;
	220	};
	221
babb24fe TR	222	#define MIPI_DSI_MODULE_PREFIX "mipi-dsi:"
babb24fe TR	223
dad1b442	224	#define to_mipi_dsi_device(__dev) container_of_const(__dev, struct mipi_dsi_device, dev)
068a0023	225
2d22b63f MR	226	extern const struct bus_type mipi_dsi_bus_type;
	227	#define dev_is_mipi_dsi(dev) ((dev)->bus == &mipi_dsi_bus_type)
	228
ec26d9e9 LY	229	/**
	230	* mipi_dsi_pixel_format_to_bpp - obtain the number of bits per pixel for any
	231	* given pixel format defined by the MIPI DSI
	232	* specification
	233	* @fmt: MIPI DSI pixel format
	234	*
	235	* Returns: The number of bits per pixel of the given pixel format.
	236	*/
	237	static inline int mipi_dsi_pixel_format_to_bpp(enum mipi_dsi_pixel_format fmt)
	238	{
	239	switch (fmt) {
	240	case MIPI_DSI_FMT_RGB888:
	241	case MIPI_DSI_FMT_RGB666:
	242	return 24;
	243
	244	case MIPI_DSI_FMT_RGB666_PACKED:
	245	return 18;
	246
	247	case MIPI_DSI_FMT_RGB565:
	248	return 16;
	249	}
	250
	251	return -EINVAL;
	252	}
	253
b724455e DB	254	enum mipi_dsi_compression_algo {
	255	MIPI_DSI_COMPRESSION_DSC = 0,
	256	MIPI_DSI_COMPRESSION_VENDOR = 3,
	257	/* other two values are reserved, DSI 1.3 */
	258	};
	259
c63ae8a9 AT	260	struct mipi_dsi_device *
	261	mipi_dsi_device_register_full(struct mipi_dsi_host *host,
	262	const struct mipi_dsi_device_info *info);
509e42ce	263	void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi);
a1419fb4 MR	264	struct mipi_dsi_device *
	265	devm_mipi_dsi_device_register_full(struct device dev, struct mipi_dsi_host host,
	266	const struct mipi_dsi_device_info *info);
3ef05924	267	struct mipi_dsi_device of_find_mipi_dsi_device_by_node(struct device_node np);
068a0023 AH	268	int mipi_dsi_attach(struct mipi_dsi_device *dsi);
068a0023 AH	269	int mipi_dsi_detach(struct mipi_dsi_device *dsi);
db656849	270	int devm_mipi_dsi_attach(struct device dev, struct mipi_dsi_device dsi);
6e8c9e33 WJ	271	int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi);
6e8c9e33 WJ	272	int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi);
dbf30b69 YC	273	int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
dbf30b69 YC	274	u16 value);
de1c705c	275	int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable);
b724455e DB	276	int mipi_dsi_compression_mode_ext(struct mipi_dsi_device *dsi, bool enable,
	277	enum mipi_dsi_compression_algo algo,
	278	unsigned int pps_selector);
de1c705c DB	279	int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
de1c705c DB	280	const struct drm_dsc_picture_parameter_set *pps);
550ab848	281
f79d6d28 DB	282	void mipi_dsi_compression_mode_ext_multi(struct mipi_dsi_multi_context *ctx,
	283	bool enable,
	284	enum mipi_dsi_compression_algo algo,
	285	unsigned int pps_selector);
975bdea8 DS	286	void mipi_dsi_compression_mode_multi(struct mipi_dsi_multi_context *ctx,
975bdea8 DS	287	bool enable);
f79d6d28 DB	288	void mipi_dsi_picture_parameter_set_multi(struct mipi_dsi_multi_context *ctx,
	289	const struct drm_dsc_picture_parameter_set *pps);
	290
550ab848 TR	291	ssize_t mipi_dsi_generic_write(struct mipi_dsi_device dsi, const void payload,
550ab848 TR	292	size_t size);
3b724909 DA	293	int mipi_dsi_generic_write_chatty(struct mipi_dsi_device *dsi,
3b724909 DA	294	const void *payload, size_t size);
966e397e DA	295	void mipi_dsi_generic_write_multi(struct mipi_dsi_multi_context *ctx,
966e397e DA	296	const void *payload, size_t size);
550ab848 TR	297	ssize_t mipi_dsi_generic_read(struct mipi_dsi_device dsi, const void params,
550ab848 TR	298	size_t num_params, void *data, size_t size);
e83967c3	299	u32 drm_mipi_dsi_get_input_bus_fmt(enum mipi_dsi_pixel_format dsi_format);
550ab848	300
f79d6d28 DB	301	#define mipi_dsi_msleep(ctx, delay) \
f79d6d28 DB	302	do { \
66055636	303	if (!(ctx)->accum_err) \
f79d6d28 DB	304	msleep(delay); \
	305	} while (0)
	306
3ebc76c4 JB	307	#define mipi_dsi_usleep_range(ctx, min, max) \
	308	do { \
	309	if (!(ctx)->accum_err) \
	310	usleep_range(min, max); \
	311	} while (0)
	312
42fe1e75 YC	313	/**
	314	* enum mipi_dsi_dcs_tear_mode - Tearing Effect Output Line mode
	315	* @MIPI_DSI_DCS_TEAR_MODE_VBLANK: the TE output line consists of V-Blanking
	316	* information only
	317	* @MIPI_DSI_DCS_TEAR_MODE_VHBLANK : the TE output line consists of both
	318	* V-Blanking and H-Blanking information
	319	*/
	320	enum mipi_dsi_dcs_tear_mode {
	321	MIPI_DSI_DCS_TEAR_MODE_VBLANK,
	322	MIPI_DSI_DCS_TEAR_MODE_VHBLANK,
	323	};
	324
3d9a8fcf TR	325	#define MIPI_DSI_DCS_POWER_MODE_DISPLAY (1 << 2)
	326	#define MIPI_DSI_DCS_POWER_MODE_NORMAL (1 << 3)
	327	#define MIPI_DSI_DCS_POWER_MODE_SLEEP (1 << 4)
	328	#define MIPI_DSI_DCS_POWER_MODE_PARTIAL (1 << 5)
	329	#define MIPI_DSI_DCS_POWER_MODE_IDLE (1 << 6)
	330
960dd616 TR	331	ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
960dd616 TR	332	const void *data, size_t len);
3b724909 DA	333	int mipi_dsi_dcs_write_buffer_chatty(struct mipi_dsi_device *dsi,
3b724909 DA	334	const void *data, size_t len);
966e397e DA	335	void mipi_dsi_dcs_write_buffer_multi(struct mipi_dsi_multi_context *ctx,
966e397e DA	336	const void *data, size_t len);
960dd616 TR	337	ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
960dd616 TR	338	const void *data, size_t len);
3c523d7d TR	339	ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device dsi, u8 cmd, void data,
3c523d7d TR	340	size_t len);
083d573f	341	int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi);
2f16b897	342	int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi);
3d9a8fcf	343	int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device dsi, u8 mode);
5cc0af16	344	int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device dsi, u8 format);
42fe1e75 YC	345	int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi);
	346	int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi);
	347	int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi);
	348	int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi);
3b46d4a0 TR	349	int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
	350	u16 end);
	351	int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
	352	u16 end);
42fe1e75 YC	353	int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
42fe1e75 YC	354	enum mipi_dsi_dcs_tear_mode mode);
5cc0af16	355	int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format);
bbdcf516	356	int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline);
1a9d7593 VSB	357	int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
	358	u16 brightness);
	359	int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
	360	u16 *brightness);
c9d27c6b DM	361	int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
	362	u16 brightness);
	363	int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
	364	u16 *brightness);
068a0023	365
f79d6d28 DB	366	void mipi_dsi_dcs_nop_multi(struct mipi_dsi_multi_context *ctx);
	367	void mipi_dsi_dcs_enter_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);
	368	void mipi_dsi_dcs_exit_sleep_mode_multi(struct mipi_dsi_multi_context *ctx);
	369	void mipi_dsi_dcs_set_display_off_multi(struct mipi_dsi_multi_context *ctx);
	370	void mipi_dsi_dcs_set_display_on_multi(struct mipi_dsi_multi_context *ctx);
	371	void mipi_dsi_dcs_set_tear_on_multi(struct mipi_dsi_multi_context *ctx,
	372	enum mipi_dsi_dcs_tear_mode mode);
5ddb0a8a TV	373	void mipi_dsi_turn_on_peripheral_multi(struct mipi_dsi_multi_context *ctx);
	374	void mipi_dsi_dcs_soft_reset_multi(struct mipi_dsi_multi_context *ctx);
	375	void mipi_dsi_dcs_set_display_brightness_multi(struct mipi_dsi_multi_context *ctx,
	376	u16 brightness);
	377	void mipi_dsi_dcs_set_pixel_format_multi(struct mipi_dsi_multi_context *ctx,
	378	u8 format);
	379	void mipi_dsi_dcs_set_column_address_multi(struct mipi_dsi_multi_context *ctx,
	380	u16 start, u16 end);
	381	void mipi_dsi_dcs_set_page_address_multi(struct mipi_dsi_multi_context *ctx,
	382	u16 start, u16 end);
051c86af TV	383	void mipi_dsi_dcs_set_tear_scanline_multi(struct mipi_dsi_multi_context *ctx,
051c86af TV	384	u16 scanline);
fb13d349	385	void mipi_dsi_dcs_set_tear_off_multi(struct mipi_dsi_multi_context *ctx);
f79d6d28	386
a9015ce5 JMC	387	/**
a9015ce5 JMC	388	* mipi_dsi_generic_write_seq - transmit data using a generic write packet
3b724909 DA	389	*
	390	* This macro will print errors for you and will RETURN FROM THE CALLING
	391	* FUNCTION (yes this is non-intuitive) upon error.
	392	*
966e397e DA	393	* Because of the non-intuitive return behavior, THIS MACRO IS DEPRECATED.
	394	* Please replace calls of it with mipi_dsi_generic_write_seq_multi().
	395	*
a9015ce5 JMC	396	* @dsi: DSI peripheral device
	397	* @seq: buffer containing the payload
	398	*/
3b724909 DA	399	#define mipi_dsi_generic_write_seq(dsi, seq...) \
	400	do { \
	401	static const u8 d[] = { seq }; \
	402	int ret; \
	403	ret = mipi_dsi_generic_write_chatty(dsi, d, ARRAY_SIZE(d)); \
	404	if (ret < 0) \
	405	return ret; \
a9015ce5 JMC	406	} while (0)
a9015ce5 JMC	407
966e397e DA	408	/**
	409	* mipi_dsi_generic_write_seq_multi - transmit data using a generic write packet
	410	*
	411	* This macro will print errors for you and error handling is optimized for
	412	* callers that call this multiple times in a row.
	413	*
	414	* @ctx: Context for multiple DSI transactions
	415	* @seq: buffer containing the payload
	416	*/
	417	#define mipi_dsi_generic_write_seq_multi(ctx, seq...) \
	418	do { \
	419	static const u8 d[] = { seq }; \
	420	mipi_dsi_generic_write_multi(ctx, d, ARRAY_SIZE(d)); \
	421	} while (0)
	422
966e397e DA	423	/**
	424	* mipi_dsi_dcs_write_seq_multi - transmit a DCS command with payload
	425	*
	426	* This macro will print errors for you and error handling is optimized for
	427	* callers that call this multiple times in a row.
	428	*
	429	* @ctx: Context for multiple DSI transactions
	430	* @cmd: Command
	431	* @seq: buffer containing data to be transmitted
	432	*/
	433	#define mipi_dsi_dcs_write_seq_multi(ctx, cmd, seq...) \
	434	do { \
	435	static const u8 d[] = { cmd, seq }; \
	436	mipi_dsi_dcs_write_buffer_multi(ctx, d, ARRAY_SIZE(d)); \
	437	} while (0)
	438
068a0023 AH	439	/**
	440	* struct mipi_dsi_driver - DSI driver
	441	* @driver: device driver model driver
	442	* @probe: callback for device binding
	443	* @remove: callback for device unbinding
d1621803	444	* @shutdown: called at shutdown time to quiesce the device
068a0023 AH	445	*/
	446	struct mipi_dsi_driver {
	447	struct device_driver driver;
	448	int(probe)(struct mipi_dsi_device dsi);
79abca2b	449	void (remove)(struct mipi_dsi_device dsi);
d1621803	450	void (shutdown)(struct mipi_dsi_device dsi);
068a0023 AH	451	};
068a0023 AH	452
77df01dc TR	453	static inline struct mipi_dsi_driver *
	454	to_mipi_dsi_driver(struct device_driver *driver)
	455	{
	456	return container_of(driver, struct mipi_dsi_driver, driver);
	457	}
068a0023 AH	458
	459	static inline void mipi_dsi_get_drvdata(const struct mipi_dsi_device dsi)
	460	{
	461	return dev_get_drvdata(&dsi->dev);
	462	}
	463
	464	static inline void mipi_dsi_set_drvdata(struct mipi_dsi_device dsi, void data)
	465	{
	466	dev_set_drvdata(&dsi->dev, data);
	467	}
	468
99035e99 TR	469	int mipi_dsi_driver_register_full(struct mipi_dsi_driver *driver,
99035e99 TR	470	struct module *owner);
068a0023 AH	471	void mipi_dsi_driver_unregister(struct mipi_dsi_driver *driver);
068a0023 AH	472
99035e99 TR	473	#define mipi_dsi_driver_register(driver) \
	474	mipi_dsi_driver_register_full(driver, THIS_MODULE)
	475
068a0023 AH	476	#define module_mipi_dsi_driver(__mipi_dsi_driver) \
	477	module_driver(__mipi_dsi_driver, mipi_dsi_driver_register, \
	478	mipi_dsi_driver_unregister)
	479
	480	#endif /* __DRM_MIPI_DSI__ */