[mirror_ubuntu-focal-kernel.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>

/* CEC_ADAP_G_CONNECTOR_INFO is available */
#define CEC_CAP_CONNECTOR_INFO	(1 << 8)

#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_drm_connector_info - tells which drm connector is
 * associated with the CEC adapter.
 * @card_no: drm card number
 * @connector_id: drm connector ID
 */
struct cec_drm_connector_info {
	__u32 card_no;
	__u32 connector_id;
};

#define CEC_CONNECTOR_TYPE_NO_CONNECTOR	0
#define CEC_CONNECTOR_TYPE_DRM		1

/**
 * struct cec_connector_info - tells if and which connector is
 * associated with the CEC adapter.
 * @type: connector type (if any)
 * @drm: drm connector info
 */
struct cec_connector_info {
	__u32 type;
	union {
		struct cec_drm_connector_info drm;
		__u32 raw[16];
	};
};

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

#if IS_REACHABLE(CONFIG_CEC_CORE) && IS_ENABLED(CONFIG_CEC_NOTIFIER)

/**
 * cec_notifier_register - register a callback with the notifier
 * @n: the CEC notifier
 * @adap: the CEC adapter, passed as argument to the callback function
 * @callback: the callback function
 */
void cec_notifier_register(struct cec_notifier *n,
			   struct cec_adapter *adap,
			   void (*callback)(struct cec_adapter *adap, u16 pa));

/**
 * cec_notifier_unregister - unregister the callback from the notifier.
 * @n: the CEC notifier
 */
void cec_notifier_unregister(struct cec_notifier *n);

/**
 * cec_register_cec_notifier - register the notifier with the cec adapter.
 * @adap: the CEC adapter
 * @notifier: the CEC notifier
 */
void cec_register_cec_notifier(struct cec_adapter *adap,
			       struct cec_notifier *notifier);

#else

static inline void
cec_notifier_register(struct cec_notifier *n,
		      struct cec_adapter *adap,
		      void (*callback)(struct cec_adapter *adap, u16 pa))
{
}

static inline void cec_notifier_unregister(struct cec_notifier *n)
{
}

static inline void cec_register_cec_notifier(struct cec_adapter *adap,
					     struct cec_notifier *notifier)
{
}

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