[mirror_ubuntu-bionic-kernel.git] / include / media / cec.h

/*
 * cec - HDMI Consumer Electronics Control support header
 *
 * Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
 *
 * This program is free software; you may redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#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>
#include <media/cec-notifier.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_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 new_initiator;
	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_CEC_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 */
	u8			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_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);

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

	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;
	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;

	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;

	u16 phys_addrs[15];
	u32 sequence;

	char device_name[32];
	char input_phys[32];
	char input_drv[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;
}

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

struct edid;

#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);
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
 * @ts:		the timestamp for this event
 *
 */
void cec_queue_pin_cec_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);

/**
 * cec_set_edid_phys_addr() - find and set the physical address
 *
 * @edid:	pointer to the EDID data
 * @size:	size in bytes of the EDID data
 * @phys_addr:	the new physical address
 *
 * This function finds the location of the physical address in the EDID
 * and fills in the given physical address and updates the checksum
 * at the end of the EDID block. It does nothing if the EDID doesn't
 * contain a physical address.
 */
void cec_set_edid_phys_addr(u8 *edid, unsigned int size, u16 phys_addr);

/**
 * cec_phys_addr_for_input() - calculate the PA for an input
 *
 * @phys_addr:	the physical address of the parent
 * @input:	the number of the input port, must be between 1 and 15
 *
 * This function calculates a new physical address based on the input
 * port number. For example:
 *
 * PA = 0.0.0.0 and input = 2 becomes 2.0.0.0
 *
 * PA = 3.0.0.0 and input = 1 becomes 3.1.0.0
 *
 * PA = 3.2.1.0 and input = 5 becomes 3.2.1.5
 *
 * PA = 3.2.1.3 and input = 5 becomes f.f.f.f since it maxed out the depth.
 *
 * Return: the new physical address or CEC_PHYS_ADDR_INVALID.
 */
u16 cec_phys_addr_for_input(u16 phys_addr, u8 input);

/**
 * cec_phys_addr_validate() - validate a physical address from an EDID
 *
 * @phys_addr:	the physical address to validate
 * @parent:	if not %NULL, then this is filled with the parents PA.
 * @port:	if not %NULL, then this is filled with the input port.
 *
 * This validates a physical address as read from an EDID. If the
 * PA is invalid (such as 1.0.1.0 since '0' is only allowed at the end),
 * then it will return -EINVAL.
 *
 * The parent PA is passed into %parent and the input port is passed into
 * %port. For example:
 *
 * PA = 0.0.0.0: has parent 0.0.0.0 and input port 0.
 *
 * PA = 1.0.0.0: has parent 0.0.0.0 and input port 1.
 *
 * PA = 3.2.0.0: has parent 3.0.0.0 and input port 2.
 *
 * PA = f.f.f.f: has parent f.f.f.f and input port 0.
 *
 * Return: 0 if the PA is valid, -EINVAL if not.
 */
int cec_phys_addr_validate(u16 phys_addr, u16 *parent, u16 *port);

#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_set_edid_phys_addr(u8 *edid, unsigned int size,
					  u16 phys_addr)
{
}

static inline u16 cec_phys_addr_for_input(u16 phys_addr, u8 input)
{
	return CEC_PHYS_ADDR_INVALID;
}

static inline int cec_phys_addr_validate(u16 phys_addr, u16 *parent, u16 *port)
{
	return 0;
}

#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);
}

#endif /* _MEDIA_CEC_H */
Commit	Line	Data
a56960e8 HV	1	/*
	2	* cec - HDMI Consumer Electronics Control support header
	3	*
	4	* Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
	5	*
	6	* This program is free software; you may redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; version 2 of the License.
	9	*
	10	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	11	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	12	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	13	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	14	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	15	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	16	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	17	* SOFTWARE.
	18	*/
	19
	20	#ifndef _MEDIA_CEC_H
	21	#define _MEDIA_CEC_H
	22
	23	#include <linux/poll.h>
	24	#include <linux/fs.h>
	25	#include <linux/debugfs.h>
	26	#include <linux/device.h>
	27	#include <linux/cdev.h>
	28	#include <linux/kthread.h>
	29	#include <linux/timer.h>
	30	#include <linux/cec-funcs.h>
	31	#include <media/rc-core.h>
e3a93adc	32	#include <media/cec-notifier.h>
a56960e8	33
ee0c503e HV	34	#define CEC_CAP_DEFAULTS (CEC_CAP_LOG_ADDRS \| CEC_CAP_TRANSMIT \| \
	35	CEC_CAP_PASSTHROUGH \| CEC_CAP_RC)
	36
a56960e8 HV	37	/**
	38	* struct cec_devnode - cec device node
	39	* @dev: cec device
	40	* @cdev: cec character device
a56960e8 HV	41	* @minor: device node minor number
	42	* @registered: the device was correctly registered
	43	* @unregistered: the device was unregistered
	44	* @fhs_lock: lock to control access to the filehandle list
	45	* @fhs: the list of open filehandles (cec_fh)
	46	*
	47	* This structure represents a cec-related device node.
	48	*
	49	* The @parent is a physical device. It must be set by core or device drivers
	50	* before registering the node.
	51	*/
	52	struct cec_devnode {
	53	/* sysfs */
	54	struct device dev;
	55	struct cdev cdev;
a56960e8 HV	56
	57	/* device info */
	58	int minor;
	59	bool registered;
	60	bool unregistered;
a56960e8	61	struct list_head fhs;
62148f09	62	struct mutex lock;
a56960e8 HV	63	};
	64
	65	struct cec_adapter;
	66	struct cec_data;
ea5c8ef2	67	struct cec_pin;
a56960e8 HV	68
	69	struct cec_data {
	70	struct list_head list;
	71	struct list_head xfer_list;
	72	struct cec_adapter *adap;
	73	struct cec_msg msg;
	74	struct cec_fh *fh;
	75	struct delayed_work work;
	76	struct completion c;
	77	u8 attempts;
	78	bool new_initiator;
	79	bool blocking;
	80	bool completed;
	81	};
	82
	83	struct cec_msg_entry {
	84	struct list_head list;
	85	struct cec_msg msg;
	86	};
	87
6b2bbb08 HV	88	struct cec_event_entry {
	89	struct list_head list;
	90	struct cec_event ev;
	91	};
	92
	93	#define CEC_NUM_CORE_EVENTS 2
9a6b2a87	94	#define CEC_NUM_EVENTS CEC_EVENT_PIN_CEC_HIGH
a56960e8 HV	95
	96	struct cec_fh {
	97	struct list_head list;
	98	struct list_head xfer_list;
	99	struct cec_adapter *adap;
	100	u8 mode_initiator;
	101	u8 mode_follower;
	102
	103	/* Events */
	104	wait_queue_head_t wait;
a56960e8	105	struct mutex lock;
6b2bbb08 HV	106	struct list_head events[CEC_NUM_EVENTS]; /* queued events */
	107	u8 queued_events[CEC_NUM_EVENTS];
	108	unsigned int total_queued_events;
	109	struct cec_event_entry core_events[CEC_NUM_CORE_EVENTS];
a56960e8 HV	110	struct list_head msgs; /* queued messages */
	111	unsigned int queued_msgs;
	112	};
	113
	114	#define CEC_SIGNAL_FREE_TIME_RETRY 3
	115	#define CEC_SIGNAL_FREE_TIME_NEW_INITIATOR 5
	116	#define CEC_SIGNAL_FREE_TIME_NEXT_XFER 7
	117
	118	/* The nominal data bit period is 2.4 ms */
	119	#define CEC_FREE_TIME_TO_USEC(ft) ((ft) * 2400)
	120
	121	struct cec_adap_ops {
	122	/* Low-level callbacks */
	123	int (adap_enable)(struct cec_adapter adap, bool enable);
	124	int (adap_monitor_all_enable)(struct cec_adapter adap, bool enable);
	125	int (adap_log_addr)(struct cec_adapter adap, u8 logical_addr);
	126	int (adap_transmit)(struct cec_adapter adap, u8 attempts,
	127	u32 signal_free_time, struct cec_msg *msg);
	128	void (adap_status)(struct cec_adapter adap, struct seq_file *file);
e6259b5f	129	void (adap_free)(struct cec_adapter adap);
a56960e8 HV	130
	131	/* High-level CEC message callback */
	132	int (received)(struct cec_adapter adap, struct cec_msg *msg);
	133	};
	134
	135	/*
	136	* The minimum message length you can receive (excepting poll messages) is 2.
	137	* With a transfer rate of at most 36 bytes per second this makes 18 messages
	138	* per second worst case.
	139	*
11065f85 HV	140	* We queue at most 3 seconds worth of received messages. The CEC specification
	141	* requires that messages are replied to within a second, so 3 seconds should
	142	* give more than enough margin. Since most messages are actually more than 2
	143	* bytes, this is in practice a lot more than 3 seconds.
a56960e8	144	*/
11065f85 HV	145	#define CEC_MAX_MSG_RX_QUEUE_SZ (18 * 3)
	146
	147	/*
	148	* The transmit queue is limited to 1 second worth of messages (worst case).
	149	* Messages can be transmitted by userspace and kernel space. But for both it
	150	* makes no sense to have a lot of messages queued up. One second seems
	151	* reasonable.
	152	*/
	153	#define CEC_MAX_MSG_TX_QUEUE_SZ (18 * 1)
a56960e8 HV	154
	155	struct cec_adapter {
	156	struct module *owner;
	157	char name[32];
	158	struct cec_devnode devnode;
	159	struct mutex lock;
	160	struct rc_dev *rc;
	161
	162	struct list_head transmit_queue;
11065f85	163	unsigned int transmit_queue_sz;
a56960e8 HV	164	struct list_head wait_queue;
	165	struct cec_data *transmitting;
	166
	167	struct task_struct *kthread_config;
	168	struct completion config_completion;
	169
	170	struct task_struct *kthread;
	171	wait_queue_head_t kthread_waitq;
	172	wait_queue_head_t waitq;
	173
	174	const struct cec_adap_ops *ops;
	175	void *priv;
	176	u32 capabilities;
	177	u8 available_log_addrs;
	178
	179	u16 phys_addr;
f902c1e9	180	bool needs_hpd;
a56960e8 HV	181	bool is_configuring;
	182	bool is_configured;
	183	u32 monitor_all_cnt;
b8d62f50	184	u32 monitor_pin_cnt;
a56960e8 HV	185	u32 follower_cnt;
	186	struct cec_fh *cec_follower;
	187	struct cec_fh *cec_initiator;
	188	bool passthrough;
	189	struct cec_log_addrs log_addrs;
	190
bb789e03 HV	191	u32 tx_timeouts;
bb789e03 HV	192
e94c3281	193	#ifdef CONFIG_CEC_NOTIFIER
e3a93adc HV	194	struct cec_notifier *notifier;
e3a93adc HV	195	#endif
ea5c8ef2 HV	196	#ifdef CONFIG_CEC_PIN
	197	struct cec_pin *pin;
	198	#endif
e3a93adc	199
a56960e8 HV	200	struct dentry *cec_dir;
	201	struct dentry *status_file;
	202
	203	u16 phys_addrs[15];
	204	u32 sequence;
	205
518f4b26	206	char device_name[32];
a56960e8 HV	207	char input_phys[32];
	208	char input_drv[32];
	209	};
	210
0b0b97dc JA	211	static inline void cec_get_drvdata(const struct cec_adapter adap)
	212	{
	213	return adap->priv;
	214	}
	215
a56960e8 HV	216	static inline bool cec_has_log_addr(const struct cec_adapter *adap, u8 log_addr)
	217	{
	218	return adap->log_addrs.log_addr_mask & (1 << log_addr);
	219	}
	220
	221	static inline bool cec_is_sink(const struct cec_adapter *adap)
	222	{
	223	return adap->phys_addr == 0;
	224	}
	225
ee7e9871 HV	226	#define cec_phys_addr_exp(pa) \
	227	((pa) >> 12), ((pa) >> 8) & 0xf, ((pa) >> 4) & 0xf, (pa) & 0xf
	228
23111ec3 HV	229	struct edid;
23111ec3 HV	230
f9f314f3	231	#if IS_REACHABLE(CONFIG_CEC_CORE)
a56960e8	232	struct cec_adapter cec_allocate_adapter(const struct cec_adap_ops ops,
f51e8080 HV	233	void priv, const char name, u32 caps, u8 available_las);
f51e8080 HV	234	int cec_register_adapter(struct cec_adapter adap, struct device parent);
a56960e8 HV	235	void cec_unregister_adapter(struct cec_adapter *adap);
	236	void cec_delete_adapter(struct cec_adapter *adap);
	237
	238	int cec_s_log_addrs(struct cec_adapter adap, struct cec_log_addrs log_addrs,
	239	bool block);
	240	void cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr,
	241	bool block);
23111ec3 HV	242	void cec_s_phys_addr_from_edid(struct cec_adapter *adap,
23111ec3 HV	243	const struct edid *edid);
a56960e8 HV	244	int cec_transmit_msg(struct cec_adapter adap, struct cec_msg msg,
	245	bool block);
	246
	247	/* Called by the adapter */
0861ad14 HV	248	void cec_transmit_done_ts(struct cec_adapter *adap, u8 status,
	249	u8 arb_lost_cnt, u8 nack_cnt, u8 low_drive_cnt,
	250	u8 error_cnt, ktime_t ts);
	251
	252	static inline void cec_transmit_done(struct cec_adapter *adap, u8 status,
	253	u8 arb_lost_cnt, u8 nack_cnt,
	254	u8 low_drive_cnt, u8 error_cnt)
	255	{
	256	cec_transmit_done_ts(adap, status, arb_lost_cnt, nack_cnt,
	257	low_drive_cnt, error_cnt, ktime_get());
	258	}
c94cdc1e HV	259	/*
	260	* Simplified version of cec_transmit_done for hardware that doesn't retry
	261	* failed transmits. So this is always just one attempt in which case
	262	* the status is sufficient.
	263	*/
0861ad14 HV	264	void cec_transmit_attempt_done_ts(struct cec_adapter *adap,
	265	u8 status, ktime_t ts);
	266
	267	static inline void cec_transmit_attempt_done(struct cec_adapter *adap,
	268	u8 status)
	269	{
	270	cec_transmit_attempt_done_ts(adap, status, ktime_get());
	271	}
	272
	273	void cec_received_msg_ts(struct cec_adapter *adap,
	274	struct cec_msg *msg, ktime_t ts);
	275
	276	static inline void cec_received_msg(struct cec_adapter *adap,
	277	struct cec_msg *msg)
	278	{
	279	cec_received_msg_ts(adap, msg, ktime_get());
	280	}
a56960e8	281
b8d62f50	282	/**
9a6b2a87	283	* cec_queue_pin_cec_event() - queue a CEC pin event with a given timestamp.
b8d62f50 HV	284	*
b8d62f50 HV	285	* @adap: pointer to the cec adapter
9a6b2a87	286	* @is_high: when true the CEC pin is high, otherwise it is low
b8d62f50 HV	287	* @ts: the timestamp for this event
	288	*
	289	*/
9a6b2a87 HV	290	void cec_queue_pin_cec_event(struct cec_adapter *adap,
9a6b2a87 HV	291	bool is_high, ktime_t ts);
b8d62f50	292
ee7e9871 HV	293	/**
	294	* cec_get_edid_phys_addr() - find and return the physical address
	295	*
	296	* @edid: pointer to the EDID data
	297	* @size: size in bytes of the EDID data
	298	* @offset: If not %NULL then the location of the physical address
	299	* bytes in the EDID will be returned here. This is set to 0
	300	* if there is no physical address found.
	301	*
	302	* Return: the physical address or CEC_PHYS_ADDR_INVALID if there is none.
	303	*/
	304	u16 cec_get_edid_phys_addr(const u8 *edid, unsigned int size,
	305	unsigned int *offset);
	306
	307	/**
	308	* cec_set_edid_phys_addr() - find and set the physical address
	309	*
	310	* @edid: pointer to the EDID data
	311	* @size: size in bytes of the EDID data
	312	* @phys_addr: the new physical address
	313	*
	314	* This function finds the location of the physical address in the EDID
	315	* and fills in the given physical address and updates the checksum
	316	* at the end of the EDID block. It does nothing if the EDID doesn't
	317	* contain a physical address.
	318	*/
	319	void cec_set_edid_phys_addr(u8 *edid, unsigned int size, u16 phys_addr);
	320
	321	/**
	322	* cec_phys_addr_for_input() - calculate the PA for an input
	323	*
	324	* @phys_addr: the physical address of the parent
	325	* @input: the number of the input port, must be between 1 and 15
	326	*
	327	* This function calculates a new physical address based on the input
	328	* port number. For example:
	329	*
	330	* PA = 0.0.0.0 and input = 2 becomes 2.0.0.0
	331	*
	332	* PA = 3.0.0.0 and input = 1 becomes 3.1.0.0
	333	*
	334	* PA = 3.2.1.0 and input = 5 becomes 3.2.1.5
	335	*
	336	* PA = 3.2.1.3 and input = 5 becomes f.f.f.f since it maxed out the depth.
	337	*
	338	* Return: the new physical address or CEC_PHYS_ADDR_INVALID.
	339	*/
	340	u16 cec_phys_addr_for_input(u16 phys_addr, u8 input);
	341
	342	/**
	343	* cec_phys_addr_validate() - validate a physical address from an EDID
	344	*
	345	* @phys_addr: the physical address to validate
	346	* @parent: if not %NULL, then this is filled with the parents PA.
	347	* @port: if not %NULL, then this is filled with the input port.
	348	*
	349	* This validates a physical address as read from an EDID. If the
	350	* PA is invalid (such as 1.0.1.0 since '0' is only allowed at the end),
	351	* then it will return -EINVAL.
	352	*
	353	* The parent PA is passed into %parent and the input port is passed into
	354	* %port. For example:
	355	*
	356	* PA = 0.0.0.0: has parent 0.0.0.0 and input port 0.
357	*
358	* PA = 1.0.0.0: has parent 0.0.0.0 and input port 1.
359	*
360	* PA = 3.2.0.0: has parent 3.0.0.0 and input port 2.
361	*
362	* PA = f.f.f.f: has parent f.f.f.f and input port 0.
363	*
364	* Return: 0 if the PA is valid, -EINVAL if not.
365	*/
366	int cec_phys_addr_validate(u16 phys_addr, u16 parent, u16 port);
367
a56960e8 HV	368	#else
a56960e8 HV	369
f51e8080 HV	370	static inline int cec_register_adapter(struct cec_adapter *adap,
f51e8080 HV	371	struct device *parent)
a56960e8 HV	372	{
	373	return 0;
	374	}
	375
	376	static inline void cec_unregister_adapter(struct cec_adapter *adap)
	377	{
	378	}
	379
	380	static inline void cec_delete_adapter(struct cec_adapter *adap)
	381	{
	382	}
	383
	384	static inline void cec_s_phys_addr(struct cec_adapter *adap, u16 phys_addr,
	385	bool block)
	386	{
	387	}
	388
23111ec3 HV	389	static inline void cec_s_phys_addr_from_edid(struct cec_adapter *adap,
	390	const struct edid *edid)
	391	{
	392	}
	393
ee7e9871 HV	394	static inline u16 cec_get_edid_phys_addr(const u8 *edid, unsigned int size,
	395	unsigned int *offset)
	396	{
	397	if (offset)
	398	*offset = 0;
	399	return CEC_PHYS_ADDR_INVALID;
	400	}
	401
	402	static inline void cec_set_edid_phys_addr(u8 *edid, unsigned int size,
	403	u16 phys_addr)
	404	{
	405	}
	406
	407	static inline u16 cec_phys_addr_for_input(u16 phys_addr, u8 input)
	408	{
	409	return CEC_PHYS_ADDR_INVALID;
	410	}
	411
	412	static inline int cec_phys_addr_validate(u16 phys_addr, u16 parent, u16 port)
	413	{
	414	return 0;
	415	}
	416
a56960e8 HV	417	#endif
a56960e8 HV	418
13532789 HV	419	/**
	420	* cec_phys_addr_invalidate() - set the physical address to INVALID
	421	*
	422	* @adap: the CEC adapter
	423	*
	424	* This is a simple helper function to invalidate the physical
	425	* address.
	426	*/
	427	static inline void cec_phys_addr_invalidate(struct cec_adapter *adap)
	428	{
	429	cec_s_phys_addr(adap, CEC_PHYS_ADDR_INVALID, false);
	430	}
	431
a56960e8	432	#endif /* _MEDIA_CEC_H */