[thirdparty/linux.git] / include / media / cec.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * cec - HDMI Consumer Electronics Control support header
 *
 * Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
 */

#ifndef _MEDIA_CEC_H
#define _MEDIA_CEC_H

#include <linux/poll.h>
#include <linux/fs.h>
#include <linux/debugfs.h>
#include <linux/device.h>
#include <linux/cdev.h>
#include <linux/kthread.h>
#include <linux/timer.h>
#include <linux/cec-funcs.h>
#include <media/rc-core.h>

#define CEC_CAP_DEFAULTS (CEC_CAP_LOG_ADDRS | CEC_CAP_TRANSMIT | \
			  CEC_CAP_PASSTHROUGH | CEC_CAP_RC)

/**
 * struct cec_devnode - cec device node
 * @dev:	cec device
 * @cdev:	cec character device
 * @minor:	device node minor number
 * @registered:	the device was correctly registered
 * @unregistered: the device was unregistered
 * @fhs_lock:	lock to control access to the filehandle list
 * @fhs:	the list of open filehandles (cec_fh)
 *
 * This structure represents a cec-related device node.
 *
 * The @parent is a physical device. It must be set by core or device drivers
 * before registering the node.
 */
struct cec_devnode {
	/* sysfs */
	struct device dev;
	struct cdev cdev;

	/* device info */
	int minor;
	bool registered;
	bool unregistered;
	struct list_head fhs;
	struct mutex lock;
};

struct cec_adapter;
struct cec_data;
struct cec_pin;
struct cec_notifier;

struct cec_data {
	struct list_head list;
	struct list_head xfer_list;
	struct cec_adapter *adap;
	struct cec_msg msg;
	struct cec_fh *fh;
	struct delayed_work work;
	struct completion c;
	u8 attempts;
	bool blocking;
	bool completed;
};

struct cec_msg_entry {
	struct list_head	list;
	struct cec_msg		msg;
};

struct cec_event_entry {
	struct list_head	list;
	struct cec_event	ev;
};

#define CEC_NUM_CORE_EVENTS 2
#define CEC_NUM_EVENTS CEC_EVENT_PIN_5V_HIGH

struct cec_fh {
	struct list_head	list;
	struct list_head	xfer_list;
	struct cec_adapter	*adap;
	u8			mode_initiator;
	u8			mode_follower;

	/* Events */
	wait_queue_head_t	wait;
	struct mutex		lock;
	struct list_head	events[CEC_NUM_EVENTS]; /* queued events */
	u16			queued_events[CEC_NUM_EVENTS];
	unsigned int		total_queued_events;
	struct cec_event_entry	core_events[CEC_NUM_CORE_EVENTS];
	struct list_head	msgs; /* queued messages */
	unsigned int		queued_msgs;
};

#define CEC_SIGNAL_FREE_TIME_RETRY		3
#define CEC_SIGNAL_FREE_TIME_NEW_INITIATOR	5
#define CEC_SIGNAL_FREE_TIME_NEXT_XFER		7

/* The nominal data bit period is 2.4 ms */
#define CEC_FREE_TIME_TO_USEC(ft)		((ft) * 2400)

struct cec_adap_ops {
	/* Low-level callbacks */
	int (*adap_enable)(struct cec_adapter *adap, bool enable);
	int (*adap_monitor_all_enable)(struct cec_adapter *adap, bool enable);
	int (*adap_monitor_pin_enable)(struct cec_adapter *adap, bool enable);
	int (*adap_log_addr)(struct cec_adapter *adap, u8 logical_addr);
	int (*adap_transmit)(struct cec_adapter *adap, u8 attempts,
			     u32 signal_free_time, struct cec_msg *msg);
	void (*adap_status)(struct cec_adapter *adap, struct seq_file *file);
	void (*adap_free)(struct cec_adapter *adap);

	/* Error injection callbacks */
	int (*error_inj_show)(struct cec_adapter *adap, struct seq_file *sf);
	bool (*error_inj_parse_line)(struct cec_adapter *adap, char *line);

	/* High-level CEC message callback */
	int (*received)(struct cec_adapter *adap, struct cec_msg *msg);
};

/*
 * The minimum message length you can receive (excepting poll messages) is 2.
 * With a transfer rate of at most 36 bytes per second this makes 18 messages
 * per second worst case.
 *
 * We queue at most 3 seconds worth of received messages. The CEC specification
 * requires that messages are replied to within a second, so 3 seconds should
 * give more than enough margin. Since most messages are actually more than 2
 * bytes, this is in practice a lot more than 3 seconds.
 */
#define CEC_MAX_MSG_RX_QUEUE_SZ		(18 * 3)

/*
 * The transmit queue is limited to 1 second worth of messages (worst case).
 * Messages can be transmitted by userspace and kernel space. But for both it
 * makes no sense to have a lot of messages queued up. One second seems
 * reasonable.
 */
#define CEC_MAX_MSG_TX_QUEUE_SZ		(18 * 1)

struct cec_adapter {
	struct module *owner;
	char name[32];
	struct cec_devnode devnode;
	struct mutex lock;
	struct rc_dev *rc;

	struct list_head transmit_queue;
	unsigned int transmit_queue_sz;
	struct list_head wait_queue;
	struct cec_data *transmitting;
	bool transmit_in_progress;

	struct task_struct *kthread_config;
	struct completion config_completion;

	struct task_struct *kthread;
	wait_queue_head_t kthread_waitq;
	wait_queue_head_t waitq;

	const struct cec_adap_ops *ops;
	void *priv;
	u32 capabilities;
	u8 available_log_addrs;

	u16 phys_addr;
	bool needs_hpd;
	bool is_configuring;
	bool is_configured;
	bool cec_pin_is_high;
	u8 last_initiator;
	u32 monitor_all_cnt;
	u32 monitor_pin_cnt;
	u32 follower_cnt;
	struct cec_fh *cec_follower;
	struct cec_fh *cec_initiator;
	bool passthrough;
	struct cec_log_addrs log_addrs;
	struct cec_connector_info conn_info;

	u32 tx_timeouts;

#ifdef CONFIG_CEC_NOTIFIER
	struct cec_notifier *notifier;
#endif
#ifdef CONFIG_CEC_PIN
	struct cec_pin *pin;
#endif

	struct dentry *cec_dir;
	struct dentry *status_file;
	struct dentry *error_inj_file;

	u16 phys_addrs[15];
	u32 sequence;

	char input_phys[32];
};

static inline void *cec_get_drvdata(const struct cec_adapter *adap)
{
	return adap->priv;
}

static inline bool cec_has_log_addr(const struct cec_adapter *adap, u8 log_addr)
{
	return adap->log_addrs.log_addr_mask & (1 << log_addr);
}

static inline bool cec_is_sink(const struct cec_adapter *adap)
{
	return adap->phys_addr == 0;
}

/**
 * cec_is_registered() - is the CEC adapter registered?
 *
 * @adap:	the CEC adapter, may be NULL.
 *
 * Return: true if the adapter is registered, false otherwise.
 */
static inline bool cec_is_registered(const struct cec_adapter *adap)
{
	return adap && adap->devnode.registered;
}

#define cec_phys_addr_exp(pa) \
	((pa) >> 12), ((pa) >> 8) & 0xf, ((pa) >> 4) & 0xf, (pa) & 0xf

struct edid;
struct drm_connector;

#if IS_REACHABLE(CONFIG_CEC_CORE)
struct cec_adapter *cec_allocate_adapter(const struct cec_adap_ops *ops,
		void *priv, const char *name, u32 caps, u8 available_las);
int cec_register_adapter(struct cec_adapter *adap, struct device *parent);
void cec_unregister_adapter(struct cec_adapter *adap);
void cec_delete_adapter(struct cec_adapter *adap);

int cec_s_log_addrs(struct cec_adapter *adap, struct cec_log_addrs *log_addrs,
		    bool block);
void cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr,
		     bool block);
void cec_s_phys_addr_from_edid(struct cec_adapter *adap,
			       const struct edid *edid);
void cec_s_conn_info(struct cec_adapter *adap,
		     const struct cec_connector_info *conn_info);
int cec_transmit_msg(struct cec_adapter *adap, struct cec_msg *msg,
		     bool block);

/* Called by the adapter */
void cec_transmit_done_ts(struct cec_adapter *adap, u8 status,
			  u8 arb_lost_cnt, u8 nack_cnt, u8 low_drive_cnt,
			  u8 error_cnt, ktime_t ts);

static inline void cec_transmit_done(struct cec_adapter *adap, u8 status,
				     u8 arb_lost_cnt, u8 nack_cnt,
				     u8 low_drive_cnt, u8 error_cnt)
{
	cec_transmit_done_ts(adap, status, arb_lost_cnt, nack_cnt,
			     low_drive_cnt, error_cnt, ktime_get());
}
/*
 * Simplified version of cec_transmit_done for hardware that doesn't retry
 * failed transmits. So this is always just one attempt in which case
 * the status is sufficient.
 */
void cec_transmit_attempt_done_ts(struct cec_adapter *adap,
				  u8 status, ktime_t ts);

static inline void cec_transmit_attempt_done(struct cec_adapter *adap,
					     u8 status)
{
	cec_transmit_attempt_done_ts(adap, status, ktime_get());
}

void cec_received_msg_ts(struct cec_adapter *adap,
			 struct cec_msg *msg, ktime_t ts);

static inline void cec_received_msg(struct cec_adapter *adap,
				    struct cec_msg *msg)
{
	cec_received_msg_ts(adap, msg, ktime_get());
}

/**
 * cec_queue_pin_cec_event() - queue a CEC pin event with a given timestamp.
 *
 * @adap:	pointer to the cec adapter
 * @is_high:	when true the CEC pin is high, otherwise it is low
 * @dropped_events: when true some events were dropped
 * @ts:		the timestamp for this event
 *
 */
void cec_queue_pin_cec_event(struct cec_adapter *adap, bool is_high,
			     bool dropped_events, ktime_t ts);

/**
 * cec_queue_pin_hpd_event() - queue a pin event with a given timestamp.
 *
 * @adap:	pointer to the cec adapter
 * @is_high:	when true the HPD pin is high, otherwise it is low
 * @ts:		the timestamp for this event
 *
 */
void cec_queue_pin_hpd_event(struct cec_adapter *adap, bool is_high, ktime_t ts);

/**
 * cec_queue_pin_5v_event() - queue a pin event with a given timestamp.
 *
 * @adap:	pointer to the cec adapter
 * @is_high:	when true the 5V pin is high, otherwise it is low
 * @ts:		the timestamp for this event
 *
 */
void cec_queue_pin_5v_event(struct cec_adapter *adap, bool is_high, ktime_t ts);

/**
 * cec_get_edid_phys_addr() - find and return the physical address
 *
 * @edid:	pointer to the EDID data
 * @size:	size in bytes of the EDID data
 * @offset:	If not %NULL then the location of the physical address
 *		bytes in the EDID will be returned here. This is set to 0
 *		if there is no physical address found.
 *
 * Return: the physical address or CEC_PHYS_ADDR_INVALID if there is none.
 */
u16 cec_get_edid_phys_addr(const u8 *edid, unsigned int size,
			   unsigned int *offset);

void cec_fill_conn_info_from_drm(struct cec_connector_info *conn_info,
				 const struct drm_connector *connector);

#else

static inline int cec_register_adapter(struct cec_adapter *adap,
				       struct device *parent)
{
	return 0;
}

static inline void cec_unregister_adapter(struct cec_adapter *adap)
{
}

static inline void cec_delete_adapter(struct cec_adapter *adap)
{
}

static inline void cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr,
				   bool block)
{
}

static inline void cec_s_phys_addr_from_edid(struct cec_adapter *adap,
					     const struct edid *edid)
{
}

static inline u16 cec_get_edid_phys_addr(const u8 *edid, unsigned int size,
					 unsigned int *offset)
{
	if (offset)
		*offset = 0;
	return CEC_PHYS_ADDR_INVALID;
}

static inline void cec_s_conn_info(struct cec_adapter *adap,
				   const struct cec_connector_info *conn_info)
{
}

static inline void
cec_fill_conn_info_from_drm(struct cec_connector_info *conn_info,
			    const struct drm_connector *connector)
{
	memset(conn_info, 0, sizeof(*conn_info));
}

#endif

/**
 * cec_phys_addr_invalidate() - set the physical address to INVALID
 *
 * @adap:	the CEC adapter
 *
 * This is a simple helper function to invalidate the physical
 * address.
 */
static inline void cec_phys_addr_invalidate(struct cec_adapter *adap)
{
	cec_s_phys_addr(adap, CEC_PHYS_ADDR_INVALID, false);
}

/**
 * cec_get_edid_spa_location() - find location of the Source Physical Address
 *
 * @edid: the EDID
 * @size: the size of the EDID
 *
 * This EDID is expected to be a CEA-861 compliant, which means that there are
 * at least two blocks and one or more of the extensions blocks are CEA-861
 * blocks.
 *
 * The returned location is guaranteed to be <= size-2.
 *
 * This is an inline function since it is used by both CEC and V4L2.
 * Ideally this would go in a module shared by both, but it is overkill to do
 * that for just a single function.
 */
static inline unsigned int cec_get_edid_spa_location(const u8 *edid,
						     unsigned int size)
{
	unsigned int blocks = size / 128;
	unsigned int block;
	u8 d;

	/* Sanity check: at least 2 blocks and a multiple of the block size */
	if (blocks < 2 || size % 128)
		return 0;

	/*
	 * If there are fewer extension blocks than the size, then update
	 * 'blocks'. It is allowed to have more extension blocks than the size,
	 * since some hardware can only read e.g. 256 bytes of the EDID, even
	 * though more blocks are present. The first CEA-861 extension block
	 * should normally be in block 1 anyway.
	 */
	if (edid[0x7e] + 1 < blocks)
		blocks = edid[0x7e] + 1;

	for (block = 1; block < blocks; block++) {
		unsigned int offset = block * 128;

		/* Skip any non-CEA-861 extension blocks */
		if (edid[offset] != 0x02 || edid[offset + 1] != 0x03)
			continue;

		/* search Vendor Specific Data Block (tag 3) */
		d = edid[offset + 2] & 0x7f;
		/* Check if there are Data Blocks */
		if (d <= 4)
			continue;
		if (d > 4) {
			unsigned int i = offset + 4;
			unsigned int end = offset + d;

			/* Note: 'end' is always < 'size' */
			do {
				u8 tag = edid[i] >> 5;
				u8 len = edid[i] & 0x1f;

				if (tag == 3 && len >= 5 && i + len <= end &&
				    edid[i + 1] == 0x03 &&
				    edid[i + 2] == 0x0c &&
				    edid[i + 3] == 0x00)
					return i + 4;
				i += len + 1;
			} while (i < end);
		}
	}
	return 0;
}

#endif /* _MEDIA_CEC_H */
Commit	Line	Data
ab15d248	1	/* SPDX-License-Identifier: GPL-2.0-only */
a56960e8 HV	2	/*
	3	* cec - HDMI Consumer Electronics Control support header
	4	*
	5	* Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
a56960e8 HV	6	*/
	7
	8	#ifndef _MEDIA_CEC_H
	9	#define _MEDIA_CEC_H
	10
	11	#include <linux/poll.h>
	12	#include <linux/fs.h>
	13	#include <linux/debugfs.h>
	14	#include <linux/device.h>
	15	#include <linux/cdev.h>
	16	#include <linux/kthread.h>
	17	#include <linux/timer.h>
	18	#include <linux/cec-funcs.h>
	19	#include <media/rc-core.h>
32a847f9	20
ee0c503e HV	21	#define CEC_CAP_DEFAULTS (CEC_CAP_LOG_ADDRS \| CEC_CAP_TRANSMIT \| \
	22	CEC_CAP_PASSTHROUGH \| CEC_CAP_RC)
	23
a56960e8 HV	24	/**
	25	* struct cec_devnode - cec device node
	26	* @dev: cec device
	27	* @cdev: cec character device
a56960e8 HV	28	* @minor: device node minor number
	29	* @registered: the device was correctly registered
	30	* @unregistered: the device was unregistered
	31	* @fhs_lock: lock to control access to the filehandle list
	32	* @fhs: the list of open filehandles (cec_fh)
	33	*
	34	* This structure represents a cec-related device node.
	35	*
	36	* The @parent is a physical device. It must be set by core or device drivers
	37	* before registering the node.
	38	*/
	39	struct cec_devnode {
	40	/* sysfs */
	41	struct device dev;
	42	struct cdev cdev;
a56960e8 HV	43
	44	/* device info */
	45	int minor;
	46	bool registered;
	47	bool unregistered;
a56960e8	48	struct list_head fhs;
62148f09	49	struct mutex lock;
a56960e8 HV	50	};
	51
	52	struct cec_adapter;
	53	struct cec_data;
ea5c8ef2	54	struct cec_pin;
32a847f9	55	struct cec_notifier;
a56960e8 HV	56
	57	struct cec_data {
	58	struct list_head list;
	59	struct list_head xfer_list;
	60	struct cec_adapter *adap;
	61	struct cec_msg msg;
	62	struct cec_fh *fh;
	63	struct delayed_work work;
	64	struct completion c;
	65	u8 attempts;
a56960e8 HV	66	bool blocking;
	67	bool completed;
	68	};
	69
	70	struct cec_msg_entry {
	71	struct list_head list;
	72	struct cec_msg msg;
	73	};
	74
6b2bbb08 HV	75	struct cec_event_entry {
	76	struct list_head list;
	77	struct cec_event ev;
	78	};
	79
	80	#define CEC_NUM_CORE_EVENTS 2
4786b0d6	81	#define CEC_NUM_EVENTS CEC_EVENT_PIN_5V_HIGH
a56960e8 HV	82
	83	struct cec_fh {
	84	struct list_head list;
	85	struct list_head xfer_list;
	86	struct cec_adapter *adap;
	87	u8 mode_initiator;
	88	u8 mode_follower;
	89
	90	/* Events */
	91	wait_queue_head_t wait;
a56960e8	92	struct mutex lock;
6b2bbb08	93	struct list_head events[CEC_NUM_EVENTS]; /* queued events */
6ec1cbf6	94	u16 queued_events[CEC_NUM_EVENTS];
6b2bbb08 HV	95	unsigned int total_queued_events;
6b2bbb08 HV	96	struct cec_event_entry core_events[CEC_NUM_CORE_EVENTS];
a56960e8 HV	97	struct list_head msgs; /* queued messages */
	98	unsigned int queued_msgs;
	99	};
	100
	101	#define CEC_SIGNAL_FREE_TIME_RETRY 3
	102	#define CEC_SIGNAL_FREE_TIME_NEW_INITIATOR 5
	103	#define CEC_SIGNAL_FREE_TIME_NEXT_XFER 7
	104
	105	/* The nominal data bit period is 2.4 ms */
	106	#define CEC_FREE_TIME_TO_USEC(ft) ((ft) * 2400)
	107
	108	struct cec_adap_ops {
	109	/* Low-level callbacks */
	110	int (adap_enable)(struct cec_adapter adap, bool enable);
	111	int (adap_monitor_all_enable)(struct cec_adapter adap, bool enable);
48ea2e92	112	int (adap_monitor_pin_enable)(struct cec_adapter adap, bool enable);
a56960e8 HV	113	int (adap_log_addr)(struct cec_adapter adap, u8 logical_addr);
	114	int (adap_transmit)(struct cec_adapter adap, u8 attempts,
	115	u32 signal_free_time, struct cec_msg *msg);
	116	void (adap_status)(struct cec_adapter adap, struct seq_file *file);
e6259b5f	117	void (adap_free)(struct cec_adapter adap);
a56960e8	118
9ca400c1 HV	119	/* Error injection callbacks */
	120	int (error_inj_show)(struct cec_adapter adap, struct seq_file *sf);
	121	bool (error_inj_parse_line)(struct cec_adapter adap, char *line);
	122
a56960e8 HV	123	/* High-level CEC message callback */
	124	int (received)(struct cec_adapter adap, struct cec_msg *msg);
	125	};
	126
	127	/*
	128	* The minimum message length you can receive (excepting poll messages) is 2.
	129	* With a transfer rate of at most 36 bytes per second this makes 18 messages
	130	* per second worst case.
	131	*
11065f85 HV	132	* We queue at most 3 seconds worth of received messages. The CEC specification
	133	* requires that messages are replied to within a second, so 3 seconds should
	134	* give more than enough margin. Since most messages are actually more than 2
	135	* bytes, this is in practice a lot more than 3 seconds.
a56960e8	136	*/
11065f85 HV	137	#define CEC_MAX_MSG_RX_QUEUE_SZ (18 * 3)
	138
	139	/*
	140	* The transmit queue is limited to 1 second worth of messages (worst case).
	141	* Messages can be transmitted by userspace and kernel space. But for both it
	142	* makes no sense to have a lot of messages queued up. One second seems
	143	* reasonable.
	144	*/
	145	#define CEC_MAX_MSG_TX_QUEUE_SZ (18 * 1)
a56960e8 HV	146
	147	struct cec_adapter {
	148	struct module *owner;
	149	char name[32];
	150	struct cec_devnode devnode;
	151	struct mutex lock;
	152	struct rc_dev *rc;
	153
	154	struct list_head transmit_queue;
11065f85	155	unsigned int transmit_queue_sz;
a56960e8 HV	156	struct list_head wait_queue;
a56960e8 HV	157	struct cec_data *transmitting;
32804fcb	158	bool transmit_in_progress;
a56960e8 HV	159
	160	struct task_struct *kthread_config;
	161	struct completion config_completion;
	162
	163	struct task_struct *kthread;
	164	wait_queue_head_t kthread_waitq;
	165	wait_queue_head_t waitq;
	166
	167	const struct cec_adap_ops *ops;
	168	void *priv;
	169	u32 capabilities;
	170	u8 available_log_addrs;
	171
	172	u16 phys_addr;
f902c1e9	173	bool needs_hpd;
a56960e8 HV	174	bool is_configuring;
a56960e8 HV	175	bool is_configured;
28e11b15	176	bool cec_pin_is_high;
7d867a1b	177	u8 last_initiator;
a56960e8	178	u32 monitor_all_cnt;
b8d62f50	179	u32 monitor_pin_cnt;
a56960e8 HV	180	u32 follower_cnt;
	181	struct cec_fh *cec_follower;
	182	struct cec_fh *cec_initiator;
	183	bool passthrough;
	184	struct cec_log_addrs log_addrs;
32a847f9	185	struct cec_connector_info conn_info;
a56960e8	186
bb789e03 HV	187	u32 tx_timeouts;
bb789e03 HV	188
e94c3281	189	#ifdef CONFIG_CEC_NOTIFIER
e3a93adc HV	190	struct cec_notifier *notifier;
e3a93adc HV	191	#endif
ea5c8ef2 HV	192	#ifdef CONFIG_CEC_PIN
	193	struct cec_pin *pin;
	194	#endif
e3a93adc	195
a56960e8 HV	196	struct dentry *cec_dir;
a56960e8 HV	197	struct dentry *status_file;
9ca400c1	198	struct dentry *error_inj_file;
a56960e8 HV	199
	200	u16 phys_addrs[15];
	201	u32 sequence;
	202
a56960e8	203	char input_phys[32];
a56960e8 HV	204	};
a56960e8 HV	205
0b0b97dc JA	206	static inline void cec_get_drvdata(const struct cec_adapter adap)
	207	{
	208	return adap->priv;
	209	}
	210
a56960e8 HV	211	static inline bool cec_has_log_addr(const struct cec_adapter *adap, u8 log_addr)
	212	{
	213	return adap->log_addrs.log_addr_mask & (1 << log_addr);
	214	}
	215
	216	static inline bool cec_is_sink(const struct cec_adapter *adap)
	217	{
	218	return adap->phys_addr == 0;
	219	}
	220
c8959a39 HV	221	/**
	222	* cec_is_registered() - is the CEC adapter registered?
	223	*
	224	* @adap: the CEC adapter, may be NULL.
	225	*
	226	* Return: true if the adapter is registered, false otherwise.
	227	*/
	228	static inline bool cec_is_registered(const struct cec_adapter *adap)
	229	{
	230	return adap && adap->devnode.registered;
	231	}
	232
ee7e9871 HV	233	#define cec_phys_addr_exp(pa) \
	234	((pa) >> 12), ((pa) >> 8) & 0xf, ((pa) >> 4) & 0xf, (pa) & 0xf
	235
23111ec3	236	struct edid;
32a847f9	237	struct drm_connector;
23111ec3	238
f9f314f3	239	#if IS_REACHABLE(CONFIG_CEC_CORE)
a56960e8	240	struct cec_adapter cec_allocate_adapter(const struct cec_adap_ops ops,
f51e8080 HV	241	void priv, const char name, u32 caps, u8 available_las);
f51e8080 HV	242	int cec_register_adapter(struct cec_adapter adap, struct device parent);
a56960e8 HV	243	void cec_unregister_adapter(struct cec_adapter *adap);
	244	void cec_delete_adapter(struct cec_adapter *adap);
	245
	246	int cec_s_log_addrs(struct cec_adapter adap, struct cec_log_addrs log_addrs,
	247	bool block);
	248	void cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr,
	249	bool block);
23111ec3 HV	250	void cec_s_phys_addr_from_edid(struct cec_adapter *adap,
23111ec3 HV	251	const struct edid *edid);
32a847f9 DM	252	void cec_s_conn_info(struct cec_adapter *adap,
32a847f9 DM	253	const struct cec_connector_info *conn_info);
a56960e8 HV	254	int cec_transmit_msg(struct cec_adapter adap, struct cec_msg msg,
	255	bool block);
	256
	257	/* Called by the adapter */
0861ad14 HV	258	void cec_transmit_done_ts(struct cec_adapter *adap, u8 status,
	259	u8 arb_lost_cnt, u8 nack_cnt, u8 low_drive_cnt,
	260	u8 error_cnt, ktime_t ts);
	261
	262	static inline void cec_transmit_done(struct cec_adapter *adap, u8 status,
	263	u8 arb_lost_cnt, u8 nack_cnt,
	264	u8 low_drive_cnt, u8 error_cnt)
	265	{
	266	cec_transmit_done_ts(adap, status, arb_lost_cnt, nack_cnt,
	267	low_drive_cnt, error_cnt, ktime_get());
	268	}
c94cdc1e HV	269	/*
	270	* Simplified version of cec_transmit_done for hardware that doesn't retry
	271	* failed transmits. So this is always just one attempt in which case
	272	* the status is sufficient.
	273	*/
0861ad14 HV	274	void cec_transmit_attempt_done_ts(struct cec_adapter *adap,
	275	u8 status, ktime_t ts);
	276
	277	static inline void cec_transmit_attempt_done(struct cec_adapter *adap,
	278	u8 status)
	279	{
	280	cec_transmit_attempt_done_ts(adap, status, ktime_get());
	281	}
	282
	283	void cec_received_msg_ts(struct cec_adapter *adap,
	284	struct cec_msg *msg, ktime_t ts);
	285
	286	static inline void cec_received_msg(struct cec_adapter *adap,
	287	struct cec_msg *msg)
	288	{
	289	cec_received_msg_ts(adap, msg, ktime_get());
	290	}
a56960e8	291
b8d62f50	292	/**
9a6b2a87	293	* cec_queue_pin_cec_event() - queue a CEC pin event with a given timestamp.
b8d62f50 HV	294	*
b8d62f50 HV	295	* @adap: pointer to the cec adapter
9a6b2a87	296	* @is_high: when true the CEC pin is high, otherwise it is low
6ec1cbf6	297	* @dropped_events: when true some events were dropped
b8d62f50 HV	298	* @ts: the timestamp for this event
	299	*
	300	*/
6ec1cbf6 HV	301	void cec_queue_pin_cec_event(struct cec_adapter *adap, bool is_high,
6ec1cbf6 HV	302	bool dropped_events, ktime_t ts);
b8d62f50	303
333ef6bd HV	304	/**
	305	* cec_queue_pin_hpd_event() - queue a pin event with a given timestamp.
	306	*
	307	* @adap: pointer to the cec adapter
	308	* @is_high: when true the HPD pin is high, otherwise it is low
	309	* @ts: the timestamp for this event
	310	*
	311	*/
	312	void cec_queue_pin_hpd_event(struct cec_adapter *adap, bool is_high, ktime_t ts);
	313
4786b0d6 HV	314	/**
	315	* cec_queue_pin_5v_event() - queue a pin event with a given timestamp.
	316	*
	317	* @adap: pointer to the cec adapter
	318	* @is_high: when true the 5V pin is high, otherwise it is low
	319	* @ts: the timestamp for this event
	320	*
	321	*/
	322	void cec_queue_pin_5v_event(struct cec_adapter *adap, bool is_high, ktime_t ts);
	323
ee7e9871 HV	324	/**
	325	* cec_get_edid_phys_addr() - find and return the physical address
	326	*
	327	* @edid: pointer to the EDID data
	328	* @size: size in bytes of the EDID data
	329	* @offset: If not %NULL then the location of the physical address
	330	* bytes in the EDID will be returned here. This is set to 0
	331	* if there is no physical address found.
	332	*
	333	* Return: the physical address or CEC_PHYS_ADDR_INVALID if there is none.
	334	*/
	335	u16 cec_get_edid_phys_addr(const u8 *edid, unsigned int size,
	336	unsigned int *offset);
	337
32a847f9 DM	338	void cec_fill_conn_info_from_drm(struct cec_connector_info *conn_info,
	339	const struct drm_connector *connector);
	340
a56960e8 HV	341	#else
a56960e8 HV	342
f51e8080 HV	343	static inline int cec_register_adapter(struct cec_adapter *adap,
f51e8080 HV	344	struct device *parent)
a56960e8 HV	345	{
	346	return 0;
	347	}
	348
	349	static inline void cec_unregister_adapter(struct cec_adapter *adap)
	350	{
	351	}
	352
	353	static inline void cec_delete_adapter(struct cec_adapter *adap)
	354	{
	355	}
	356
	357	static inline void cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr,
	358	bool block)
	359	{
	360	}
	361
23111ec3 HV	362	static inline void cec_s_phys_addr_from_edid(struct cec_adapter *adap,
	363	const struct edid *edid)
	364	{
	365	}
	366
ee7e9871 HV	367	static inline u16 cec_get_edid_phys_addr(const u8 *edid, unsigned int size,
	368	unsigned int *offset)
	369	{
	370	if (offset)
	371	*offset = 0;
	372	return CEC_PHYS_ADDR_INVALID;
	373	}
	374
32a847f9 DM	375	static inline void cec_s_conn_info(struct cec_adapter *adap,
	376	const struct cec_connector_info *conn_info)
	377	{
	378	}
	379
	380	static inline void
	381	cec_fill_conn_info_from_drm(struct cec_connector_info *conn_info,
	382	const struct drm_connector *connector)
	383	{
	384	memset(conn_info, 0, sizeof(*conn_info));
	385	}
	386
	387	#endif
	388
13532789 HV	389	/**
	390	* cec_phys_addr_invalidate() - set the physical address to INVALID
	391	*
	392	* @adap: the CEC adapter
	393	*
	394	* This is a simple helper function to invalidate the physical
	395	* address.
	396	*/
	397	static inline void cec_phys_addr_invalidate(struct cec_adapter *adap)
	398	{
	399	cec_s_phys_addr(adap, CEC_PHYS_ADDR_INVALID, false);
	400	}
	401
b915bf57 HV	402	/**
	403	* cec_get_edid_spa_location() - find location of the Source Physical Address
	404	*
	405	* @edid: the EDID
	406	* @size: the size of the EDID
	407	*
	408	* This EDID is expected to be a CEA-861 compliant, which means that there are
	409	* at least two blocks and one or more of the extensions blocks are CEA-861
	410	* blocks.
	411	*
	412	* The returned location is guaranteed to be <= size-2.
	413	*
	414	* This is an inline function since it is used by both CEC and V4L2.
	415	* Ideally this would go in a module shared by both, but it is overkill to do
	416	* that for just a single function.
	417	*/
	418	static inline unsigned int cec_get_edid_spa_location(const u8 *edid,
	419	unsigned int size)
	420	{
	421	unsigned int blocks = size / 128;
	422	unsigned int block;
	423	u8 d;
	424
	425	/* Sanity check: at least 2 blocks and a multiple of the block size */
	426	if (blocks < 2 \|\| size % 128)
	427	return 0;
	428
	429	/*
	430	* If there are fewer extension blocks than the size, then update
	431	* 'blocks'. It is allowed to have more extension blocks than the size,
	432	* since some hardware can only read e.g. 256 bytes of the EDID, even
	433	* though more blocks are present. The first CEA-861 extension block
	434	* should normally be in block 1 anyway.
	435	*/
	436	if (edid[0x7e] + 1 < blocks)
	437	blocks = edid[0x7e] + 1;
	438
	439	for (block = 1; block < blocks; block++) {
	440	unsigned int offset = block * 128;
	441
	442	/* Skip any non-CEA-861 extension blocks */
	443	if (edid[offset] != 0x02 \|\| edid[offset + 1] != 0x03)
	444	continue;
	445
	446	/* search Vendor Specific Data Block (tag 3) */
	447	d = edid[offset + 2] & 0x7f;
	448	/* Check if there are Data Blocks */
	449	if (d <= 4)
	450	continue;
	451	if (d > 4) {
	452	unsigned int i = offset + 4;
	453	unsigned int end = offset + d;
	454
	455	/* Note: 'end' is always < 'size' */
	456	do {
	457	u8 tag = edid[i] >> 5;
	458	u8 len = edid[i] & 0x1f;
	459
	460	if (tag == 3 && len >= 5 && i + len <= end &&
	461	edid[i + 1] == 0x03 &&
	462	edid[i + 2] == 0x0c &&
	463	edid[i + 3] == 0x00)
	464	return i + 4;
	465	i += len + 1;
466	} while (i < end);
467	}
468	}
469	return 0;
470	}
471
a56960e8	472	#endif /* _MEDIA_CEC_H */