[RFC 1/6] cec: add new driver for cec support.
Kamil Debski
k.debski at samsung.com
Tue Dec 23 06:32:17 PST 2014
From: Hans Verkuil <hansverk at cisco.com>
Add the CEC framework.
Signed-off-by: Hans Verkuil <hansverk at cisco.com>
[k.debski at samsung.com: Merged CEC Updates commit by Hans Verkuil]
[k.debski at samsung.com: Merged Update author commit by Hans Verkuil]
[k.debski at samsung.com: change kthread handling when setting logical
address]
[k.debski at samsung.com: code cleanup]
Signed-off-by: Kamil Debski <k.debski at samsung.com>
---
cec-rfc.txt | 319 ++++++++++++++
cec.txt | 40 ++
drivers/media/Kconfig | 5 +
drivers/media/Makefile | 2 +
drivers/media/cec.c | 1048 ++++++++++++++++++++++++++++++++++++++++++++++
include/media/cec.h | 129 ++++++
include/uapi/linux/cec.h | 222 ++++++++++
7 files changed, 1765 insertions(+)
create mode 100644 cec-rfc.txt
create mode 100644 cec.txt
create mode 100644 drivers/media/cec.c
create mode 100644 include/media/cec.h
create mode 100644 include/uapi/linux/cec.h
diff --git a/cec-rfc.txt b/cec-rfc.txt
new file mode 100644
index 0000000..a5b7405
--- /dev/null
+++ b/cec-rfc.txt
@@ -0,0 +1,319 @@
+RFC CEC Kernel Support
+======================
+
+Almost three years ago an initial RFC for HDMI CEC support was posted:
+
+http://comments.gmane.org/gmane.linux.drivers.video-input-infrastructure/29747
+
+Since that time this work has stalled: partially due to lack of time, but
+also because the approach had to be changed due to HDMI 1.4b requirements
+and new insights in how this should be implemented.
+
+The original RFC exposed just the low-level CEC layer (sending and receiving
+messages) and relied on userspace to actually implement the higher protocol
+levels.
+
+However, some of the CEC features such as the Standby feature but also
+messages relating to audio (both HDMI audio and the Audio Return Channel),
+ethernet and CDC (Capability Discovery and Control) all have aspects that
+require direct kernel control. I.e., if a standby message is received, then
+you might want to handle that in the driver and not have to rely on userspace.
+And if ARC and/or ethernet is supported then even the hotplug signal is
+going to be sent as a CEC CDC message instead of actually toggling the
+hotplug pin.
+
+What part of the CEC features exactly needs to be implemented in the kernel
+will depend entirely on the particular product. You might want to implement
+almost everything in userspace for a CEC USB dongle that allows you to
+control the CEC pin, you might want to implement everything in the kernel if
+you are dealing with a driver for a GPU, or it can be some mix where a set
+of standard commands are handled in the kernel, but with the option for
+some of the commands to be handled from userspace.
+
+This does not make it easy to design the CEC support. Other problems are that
+the CEC transmission speed is prehistoric: we are talking around 300 bits per
+second. So everything has to be done asynchronously. And the protocol is one
+big mess of ad-hoc decisions. Also, the CEC API can be used within different
+kernel subsystems: GPUs might need it, video capture/output devices might need
+it and stand-alone CEC USB dongles need it.
+
+The proposal has been developed for CEC version 1.4b, but the final version
+of this proposal will have support for, or at the very least be prepared for
+version 2.0.
+
+There are still a few todo's, the main one being the remote control support
+feature of CEC. I need to research if that should be implemented via the
+standard kernel remote control support.
+
+CEC Adaptor
+-----------
+
+#define CEC_LOG_ADDR_INVALID 0xff
+
+// The maximum number of logical addresses one device can be assigned to.
+// The CEC 2.0 spec allows for only 2 logical addresses at the moment. The
+// Analog Devices CEC hardware supports 3. So let's go wild and go for 4.
+#define CEC_MAX_LOG_ADDRS 4
+
+// "You are in a maze of twisty little defines, all alike"
+// What were they thinking of when they came up with this mess...
+
+// The "Primary Device Type"
+#define CEC_PRIM_DEVTYPE_TV 0
+#define CEC_PRIM_DEVTYPE_RECORD 1
+#define CEC_PRIM_DEVTYPE_TUNER 3
+#define CEC_PRIM_DEVTYPE_PLAYBACK 4
+#define CEC_PRIM_DEVTYPE_AUDIOSYSTEM 5
+#define CEC_PRIM_DEVTYPE_SWITCH 6
+#define CEC_PRIM_DEVTYPE_VIDEOPROC 7
+
+// The "All Device Types" flags (CEC 2.0)
+#define CEC_FL_ALL_DEVTYPE_TV (1 << 7)
+#define CEC_FL_ALL_DEVTYPE_RECORD (1 << 6)
+#define CEC_FL_ALL_DEVTYPE_TUNER (1 << 5)
+#define CEC_FL_ALL_DEVTYPE_PLAYBACK (1 << 4)
+#define CEC_FL_ALL_DEVTYPE_AUDIOSYSTEM (1 << 3)
+#define CEC_FL_ALL_DEVTYPE_SWITCH (1 << 2)
+// And if you wondering what happened to VIDEOPROC devices: those should
+// be mapped to a SWITCH.
+
+// The logical address types that the CEC device wants to claim
+#define CEC_LOG_ADDR_TYPE_TV 0
+#define CEC_LOG_ADDR_TYPE_RECORD 1
+#define CEC_LOG_ADDR_TYPE_TUNER 2
+#define CEC_LOG_ADDR_TYPE_PLAYBACK 3
+#define CEC_LOG_ADDR_TYPE_AUDIOSYSTEM 4
+#define CEC_LOG_ADDR_TYPE_SPECIFIC 5
+#define CEC_LOG_ADDR_TYPE_UNREGISTERED 6
+// Switches should use UNREGISTERED.
+// Video processors should use SPECIFIC.
+
+// The CEC version
+#define CEC_VERSION_1_4B 5
+#define CEC_VERSION_2_0 6
+
+struct cec_adapter {
+ /* internal fields removed */
+
+ u16 phys_addr;
+ u32 capabilities;
+ u8 version;
+ u8 num_log_addrs;
+ u8 prim_device[CEC_MAX_LOG_ADDRS];
+ u8 log_addr_type[CEC_MAX_LOG_ADDRS];
+ u8 log_addr[CEC_MAX_LOG_ADDRS];
+
+ int (*adap_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, struct cec_msg *msg);
+ void (*adap_transmit_timed_out)(struct cec_adapter *adap);
+
+ int (*received_tv)(struct cec_adapter *adap, struct cec_msg *msg);
+ int (*received_record)(struct cec_adapter *adap, struct cec_msg *msg);
+ int (*received_tuner)(struct cec_adapter *adap, struct cec_msg *msg);
+ int (*received_playback)(struct cec_adapter *adap, struct cec_msg *msg);
+ int (*received_audiosystem)(struct cec_adapter *adap, struct cec_msg *msg);
+ int (*received_switch)(struct cec_adapter *adap, struct cec_msg *msg);
+ int (*received_videoproc)(struct cec_adapter *adap, struct cec_msg *msg);
+ int (*received)(struct cec_adapter *adap, struct cec_msg *msg);
+};
+
+int cec_create_adapter(struct cec_adapter *adap, u32 caps);
+void cec_delete_adapter(struct cec_adapter *adap);
+int cec_transmit_msg(struct cec_adapter *adap, struct cec_data *data, bool block);
+
+/* Called by the adapter */
+void cec_adap_transmit_done(struct cec_adapter *adap, u32 status);
+void cec_adap_received_msg(struct cec_adapter *adap, struct cec_msg *msg);
+
+
+The device type defines are defined by the CEC standard.
+
+The cec_adapter structure represents the adapter. It has a number of
+operations that have to be implemented in the driver: adap_enable() enables
+or disables the physical adapter, adap_log_addr() tells the driver which
+logical address should be configured. This may be called multiple times
+to configure multiple logical addresses. Calling adap_enable(false) or
+adap_log_addr(CEC_LOG_ADDR_INVALID) will clear all configured logical
+addresses.
+
+The adap_transmit op will setup the hardware to send out the given CEC message.
+This will return without waiting for the transmission to finish. The
+adap_transmit_timed_out() function is called when the current transmission timed
+out and the hardware needs to be informed of this (the hardware should go back
+from transmitter to receiver mode).
+
+The adapter driver will also call into the adapter: it should call
+cec_transmit_done() when a cec transfer was finalized and cec_received_msg()
+when a new message was received.
+
+When a message is received the corresponding received() op is called depending
+on the logical address it is received on. If the message is not handled by
+that the received op is called as fallback. The driver can hook into these ops
+and do whatever it needs to do in order to respond to the message.
+
+The driver has to call cec_create_adapter to initialize the structure. If
+the 'caps' argument is non-zero, then it will also create a /dev/cecX
+device node to allow userspace to interact with the CEC device. Userspace
+can request those capabilities with the CEC_G_CAPS ioctl.
+
+In order for a CEC adapter to be configured it needs a physical address.
+This is normally assigned by the driver. It is either 0.0.0.0 for a TV (aka
+video receiver) or it is derived from the EDID that the source received
+from the sink. This is normally set by the driver before enabling the CEC
+adapter, or it is set from userspace in the case of CEC USB dongles (although
+embedded systems might also want to set this manually).
+
+After enabling the CEC adapter it has to be configured. The CEC adapter has
+to be informed for which CEC device types a logical address has to be found.
+The CEC framework will attempt to find such logical addresses. If none are
+found, then it will fall back to logical address Unregistered (15).
+
+When a CEC message is received the CEC framework will take care of the CEC
+core messages CEC_OP_GET_CEC_VERSION, CEC_OP_GIVE_PHYS_ADDR and CEC_OP_ABORT.
+Then it will call the received() op (if set), and finally it will queue it
+for handling by userspace if create_devnode was true, or send back
+FEATURE_ABORT if create_devnode was false.
+
+Drivers can also use the cec_transmit_msg() call to transmit a message. This
+can either be fire-and-forget (the CEC framework will queue up messages in a
+transmit queue), or a blocking wait until there is either an error or a
+reply to the message.
+
+
+CEC Userspace API
+-----------------
+
+This is the main message struct:
+
+struct cec_msg {
+ __u32 len;
+ __u8 msg[16];
+ __u32 status;
+ /* If non-zero, then wait for a reply with this opcode.
+ If there was an error when sending the msg or FeatureAbort
+ was returned, then reply is set to 0.
+ If reply is non-zero upon return, then len/msg are set to
+ the received message.
+ If reply is zero upon return and status has the CEC_TX_STATUS_FEATURE_ABORT
+ bit set, then len/msg are set to the received feature abort message.
+ If reply is zero upon return and status has the CEC_TX_STATUS_REPLY_TIMEOUT
+ bit set, then no reply was seen at all.
+ This field is ignored with CEC_RECEIVE.
+ If reply is non-zero for CEC_TRANSMIT and the message is a broadcast,
+ then -EINVAL is returned.
+ if reply is non-zero, then timeout is set to 1000 (the required maximum
+ response time).
+ */
+ __u8 reply;
+ /* timeout (in ms) is used to timeout CEC_RECEIVE.
+ Set to 0 if you want to wait forever. */
+ __u32 timeout;
+ struct timespec ts;
+};
+
+16 bytes for the message, the length of the message, a status value
+in case of errors. Optionally you can request the CEC framework to
+wait after transmitting the message until the 'reply' message is
+returned (or Feature Abort). This is done asynchronously, i.e. it
+does not require that the reply comes right after the transmit, but
+other messages in between are allowed.
+
+#define CEC_TRANSMIT _IOWR('a', 1, struct cec_msg)
+#define CEC_RECEIVE _IOWR('a', 2, struct cec_msg)
+
+With CEC_TRANSMIT you can transmit a message, either blocking or
+non-blocking. With CEC_RECEIVE you can dequeue a pending received
+message from the internal queue or wait for a message to arrive
+(if called in blocking mode).
+
+
+/* Userspace has to configure the adapter state (enable/disable) */
+#define CEC_CAP_STATE (1 << 0)
+/* Userspace has to configure the physical address */
+#define CEC_CAP_PHYS_ADDR (1 << 1)
+/* Userspace has to configure the logical addresses */
+#define CEC_CAP_LOG_ADDRS (1 << 2)
+/* Userspace can transmit messages */
+#define CEC_CAP_TRANSMIT (1 << 3)
+/* Userspace can receive messages */
+#define CEC_CAP_RECEIVE (1 << 4)
+
+struct cec_caps {
+ __u32 available_log_addrs;
+ __u32 capabilities;
+};
+
+#define CEC_G_CAPS _IOR('a', 0, struct cec_caps)
+
+Obtain some of the CEC adapter capabilities: the number of logical addresses
+that the adapter can configure and what can be controlled from userspace.
+
+/*
+ Enable/disable the adapter. The S_ADAP_STATE ioctl is not available
+ unless CEC_CAP_STATE is set.
+ */
+#define CEC_G_ADAP_STATE _IOR('a', 5, __u32)
+#define CEC_S_ADAP_STATE _IOW('a', 6, __u32)
+
+/*
+ phys_addr is either 0 (if this is the CEC root device)
+ or a valid physical address obtained from the sink's EDID
+ as read by this CEC device (if this is a source device)
+ or a physical address obtained and modified from a sink
+ EDID and used for a sink CEC device.
+ If nothing is connected, then phys_addr is 0xffff.
+ See HDMI 1.4b, section 8.7 (Physical Address).
+
+ The S_ADAP_PHYS_ADDR ioctl is not available unless CEC_CAP_PHYS_ADDR
+ is set.
+ */
+#define CEC_G_ADAP_PHYS_ADDR _IOR('a', 7, __u16)
+#define CEC_S_ADAP_PHYS_ADDR _IOW('a', 8, __u16)
+
+struct cec_log_addrs {
+ __u8 cec_version;
+ __u8 num_log_addrs;
+ __u8 primary_device_type[CEC_MAX_LOG_ADDRS];
+ __u8 log_addr_type[CEC_MAX_LOG_ADDRS];
+ __u8 log_addr[CEC_MAX_LOG_ADDRS];
+
+ /* CEC 2.0 */
+ __u8 all_device_types;
+ __u8 features[CEC_MAX_LOG_ADDRS][12];
+};
+
+/*
+ Configure the CEC adapter.
+
+ The cec_version determines which CEC version should be followed.
+
+ It will try to claim num_log_addrs devices. The log_addr_type array has
+ the logical address type that needs to be claimed for that device, and
+ the log_addr array will receive the actual logical address that was
+ claimed for that device or 0xff if no address could be claimed.
+
+ The primary_device_type contains the primary device for each logical
+ address.
+
+ For CEC 2.0 devices the all_device_types parameter to use with the
+ Report Features command, and 'features' contains the remaining parameters
+ (RC Profile and Device Features) to use in Report Features.
+
+ An error is returned if the adapter is disabled or if there
+ is no physical address assigned or if cec_version is unknown.
+
+ If no logical address of one or more of the given types could be claimed,
+ then log_addr will be set to CEC_LOG_ADDR_INVALID.
+
+ If no logical address could be claimed at all, then num_log_addrs will
+ be set to 1, log_addr_type[0] to UNREGISTERED and log_addr[0] to 0xf.
+
+ The S_ADAP_LOG_ADDRS ioctl is not available unless CEC_CAP_LOG_ADDRS
+ is set.
+ */
+#define CEC_G_ADAP_LOG_ADDRS _IOR('a', 3, struct cec_log_addrs)
+#define CEC_S_ADAP_LOG_ADDRS _IOWR('a', 4, struct cec_log_addrs)
+
+
+#define CEC_G_EVENT _IOWR('a', 9, struct cec_event)
diff --git a/cec.txt b/cec.txt
new file mode 100644
index 0000000..422fb1a
--- /dev/null
+++ b/cec.txt
@@ -0,0 +1,40 @@
+http://xtreamerdev.googlecode.com/files/CEC_Specs.pdf (HDMI 1.3a)
+http://www.hdmi.org/pdf/whitepaper/DesigningCECintoYourNextHDMIProduct.pdf
+http://elinux.org/CEC_%28Consumer_Electronics_Control%29_over_HDMI
+
+- TX: check if dest == initiator: should probably disallow (CEC 6.1.3)
+
+- re-transmissions: retry at least once, and up to 5 times. Only once for a
+ polling msg.
+
+- follower shall ignore frame if data blocks < than required #blocks
+
+- logical address 15: multiple devices may have it with reduced functionality.
+ Otherwise LAs are unique.
+
+- TV (0) LA only for PA 0.0.0.0, otherwise 14/15.
+
+- <Source Devices> shall issue a <Active Source> message. (12.1)
+
+- big endian format
+
+- messages coming from addr 15 shall be ignored unless:
+
+ - it is a broadcast msg
+ - sent by a CEC switch
+ - it is <Standby>
+ - it is <Rep Phys Addr> or <Active Source> (if needed by the follower)
+ - or it is a CDC msg supported by the follower
+
+- replies may come in any order and may be interleaved with other messages.
+
+- unsupported directly addressed messages shall reply with Feature Abort
+
+- <Abort> (directly addressed) must be implemented in all but pure CEC Switches (LA 15).
+
+- 'Promiscuous mode' where all CEC bus traffic can be dumped?
+
+- devices with LA 15 (unregistered) cannot be addressed directly and can only
+ receive broadcast messages.
+
+- If a device loses its PA (e.g. when unplugged), set LA to unregistered.
diff --git a/drivers/media/Kconfig b/drivers/media/Kconfig
index 49cd308..e0653a1 100644
--- a/drivers/media/Kconfig
+++ b/drivers/media/Kconfig
@@ -15,6 +15,11 @@ if MEDIA_SUPPORT
comment "Multimedia core support"
+config CEC
+ tristate "CEC API (EXPERIMENTAL)"
+ ---help---
+ Enable the CEC API.
+
#
# Multimedia support - automatically enable V4L2 and DVB core
#
diff --git a/drivers/media/Makefile b/drivers/media/Makefile
index e608bbc..db66014 100644
--- a/drivers/media/Makefile
+++ b/drivers/media/Makefile
@@ -2,6 +2,8 @@
# Makefile for the kernel multimedia device drivers.
#
+obj-$(CONFIG_CEC) += cec.o
+
media-objs := media-device.o media-devnode.o media-entity.o
#
diff --git a/drivers/media/cec.c b/drivers/media/cec.c
new file mode 100644
index 0000000..914da8b
--- /dev/null
+++ b/drivers/media/cec.c
@@ -0,0 +1,1048 @@
+#include <linux/errno.h>
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/kernel.h>
+#include <linux/kmod.h>
+#include <linux/slab.h>
+#include <linux/mm.h>
+#include <linux/string.h>
+#include <linux/types.h>
+#include <linux/uaccess.h>
+#include <media/cec.h>
+
+#define CEC_NUM_DEVICES 256
+#define CEC_NAME "cec"
+
+static int debug;
+module_param(debug, int, 0644);
+MODULE_PARM_DESC(debug, "debug level (0-1)");
+
+struct cec_transmit_notifier {
+ struct completion c;
+ struct cec_data *data;
+};
+
+#define dprintk(fmt, arg...) \
+ do { \
+ if (debug) \
+ pr_info("cec-%s: " fmt, adap->name , ## arg); \
+ } while(0)
+
+static dev_t cec_dev_t;
+
+/* Active devices */
+static DEFINE_MUTEX(cec_devnode_lock);
+static DECLARE_BITMAP(cec_devnode_nums, CEC_NUM_DEVICES);
+
+/* dev to cec_devnode */
+#define to_cec_devnode(cd) container_of(cd, struct cec_devnode, dev)
+
+static inline struct cec_devnode *cec_devnode_data(struct file *filp)
+{
+ return filp->private_data;
+}
+
+static int cec_log_addr2idx(const struct cec_adapter *adap, u8 log_addr)
+{
+ int i;
+
+ for (i = 0; i < adap->num_log_addrs; i++)
+ if (adap->log_addr[i] == log_addr)
+ return i;
+ return -1;
+}
+
+static unsigned cec_log_addr2dev(const struct cec_adapter *adap, u8 log_addr)
+{
+ int i = cec_log_addr2idx(adap, log_addr);
+
+ return adap->prim_device[i < 0 ? 0 : i];
+}
+
+/* Called when the last user of the cec device exits. */
+static void cec_devnode_release(struct device *cd)
+{
+ struct cec_devnode *cecdev = to_cec_devnode(cd);
+
+ mutex_lock(&cec_devnode_lock);
+
+ /* Delete the cdev on this minor as well */
+ cdev_del(&cecdev->cdev);
+
+ /* Mark device node number as free */
+ clear_bit(cecdev->minor, cec_devnode_nums);
+
+ mutex_unlock(&cec_devnode_lock);
+
+ /* Release cec_devnode and perform other cleanups as needed. */
+ if (cecdev->release)
+ cecdev->release(cecdev);
+}
+
+static struct bus_type cec_bus_type = {
+ .name = CEC_NAME,
+};
+
+static bool cec_sleep(struct cec_adapter *adap, int timeout)
+{
+ bool timed_out = false;
+
+ DECLARE_WAITQUEUE(wait, current);
+
+ add_wait_queue(&adap->kthread_waitq, &wait);
+ if (!kthread_should_stop()) {
+ if (timeout < 0) {
+ set_current_state(TASK_INTERRUPTIBLE);
+ schedule();
+ } else {
+ timed_out = !schedule_timeout_interruptible
+ (msecs_to_jiffies(timeout));
+ }
+ }
+
+ remove_wait_queue(&adap->kthread_waitq, &wait);
+ return timed_out;
+}
+
+/*
+ * Main CEC state machine
+ *
+ * In the IDLE state the CEC adapter is ready to receive or transmit messages.
+ * If it is woken up it will check if a new message is queued, and if so it
+ * will be transmitted and the state will go to TRANSMITTING.
+ *
+ * When the transmit is marked as done the state machine will check if it
+ * should wait for a reply. If not, it will call the notifier and go back
+ * to the IDLE state. Else it will switch to the WAIT state and wait for a
+ * reply. When the reply arrives it will call the notifier and go back
+ * to IDLE state.
+ *
+ * For the transmit and the wait-for-reply states a timeout is used of
+ * 1 second as per the standard.
+ */
+static int cec_thread_func(void *data)
+{
+ struct cec_adapter *adap = data;
+ int timeout = -1;
+
+ for (;;) {
+ bool timed_out = cec_sleep(adap, timeout);
+
+ if (kthread_should_stop())
+ break;
+ timeout = -1;
+ mutex_lock(&adap->lock);
+ dprintk("state %d timedout: %d tx: %d@%d\n", adap->state,
+ timed_out, adap->tx_qcount, adap->tx_qstart);
+ if (adap->state == CEC_ADAP_STATE_TRANSMITTING && timed_out)
+ adap->adap_transmit_timed_out(adap);
+
+ if (adap->state == CEC_ADAP_STATE_WAIT ||
+ adap->state == CEC_ADAP_STATE_TRANSMITTING) {
+ struct cec_data *data = adap->tx_queue + adap->tx_qstart;
+
+ if (adap->state == CEC_ADAP_STATE_TRANSMITTING &&
+ data->msg.reply && !timed_out &&
+ data->msg.status == CEC_TX_STATUS_OK) {
+ adap->state = CEC_ADAP_STATE_WAIT;
+ timeout = 1000;
+ } else {
+ if (timed_out) {
+ data->msg.reply = 0;
+ if (adap->state == CEC_ADAP_STATE_TRANSMITTING)
+ data->msg.status = CEC_TX_STATUS_RETRY_TIMEOUT;
+ else
+ data->msg.status = CEC_TX_STATUS_REPLY_TIMEOUT;
+ }
+ adap->state = CEC_ADAP_STATE_IDLE;
+ if (data->func) {
+ mutex_unlock(&adap->lock);
+ data->func(adap, data, data->priv);
+ mutex_lock(&adap->lock);
+ }
+ adap->tx_qstart = (adap->tx_qstart + 1) % CEC_TX_QUEUE_SZ;
+ adap->tx_qcount--;
+ wake_up_interruptible(&adap->waitq);
+ }
+ }
+ if (adap->state == CEC_ADAP_STATE_IDLE && adap->tx_qcount) {
+ adap->state = CEC_ADAP_STATE_TRANSMITTING;
+ timeout = adap->tx_queue[adap->tx_qstart].msg.len == 1 ? 200 : 1000;
+ adap->adap_transmit(adap, &adap->tx_queue[adap->tx_qstart].msg);
+ mutex_unlock(&adap->lock);
+ continue;
+ }
+ mutex_unlock(&adap->lock);
+ }
+ return 0;
+}
+
+static int cec_transmit_notify(struct cec_adapter *adap, struct cec_data *data,
+ void *priv)
+{
+ struct cec_transmit_notifier *n = priv;
+
+ *(n->data) = *data;
+ complete(&n->c);
+ return 0;
+}
+
+int cec_transmit_msg(struct cec_adapter *adap, struct cec_data *data, bool block)
+{
+ struct cec_transmit_notifier notifier;
+ struct cec_msg *msg = &data->msg;
+ int res = 0;
+ unsigned idx;
+
+ if (msg->len == 0 || msg->len > 16)
+ return -EINVAL;
+ if (msg->reply && (msg->len == 1 || cec_msg_is_broadcast(msg)))
+ return -EINVAL;
+ if (msg->len > 1 && !cec_msg_is_broadcast(msg) &&
+ cec_msg_initiator(msg) == cec_msg_destination(msg))
+ return -EINVAL;
+ if (cec_msg_initiator(msg) != 0xf &&
+ cec_log_addr2idx(adap, cec_msg_initiator(msg)) < 0)
+ return -EINVAL;
+
+ if (msg->len == 1)
+ dprintk("cec_transmit_msg: 0x%02x%s\n",
+ msg->msg[0], !block ? " nb" : "");
+ else if (msg->reply)
+ dprintk("cec_transmit_msg: 0x%02x 0x%02x (wait for 0x%02x)%s\n",
+ msg->msg[0], msg->msg[1],
+ msg->reply, !block ? " nb" : "");
+ else
+ dprintk("cec_transmit_msg: 0x%02x 0x%02x%s\n",
+ msg->msg[0], msg->msg[1],
+ !block ? " nb" : "");
+
+ msg->status = 0;
+ memset(&msg->ts, 0, sizeof(msg->ts));
+ if (msg->reply)
+ msg->timeout = 1000;
+ if (block) {
+ init_completion(¬ifier.c);
+ notifier.data = data;
+ data->func = cec_transmit_notify;
+ data->priv = ¬ifier;
+ } else {
+ data->func = NULL;
+ data->priv = NULL;
+ }
+ mutex_lock(&adap->lock);
+ idx = (adap->tx_qstart + adap->tx_qcount) % CEC_TX_QUEUE_SZ;
+ if (adap->tx_qcount == CEC_TX_QUEUE_SZ) {
+ res = -EBUSY;
+ } else {
+ adap->tx_queue[idx] = *data;
+ adap->tx_qcount++;
+ if (adap->state == CEC_ADAP_STATE_IDLE)
+ wake_up_interruptible(&adap->kthread_waitq);
+ }
+ mutex_unlock(&adap->lock);
+ if (res || !block)
+ return res;
+ wait_for_completion_interruptible(¬ifier.c);
+ return res;
+}
+EXPORT_SYMBOL_GPL(cec_transmit_msg);
+
+void cec_transmit_done(struct cec_adapter *adap, u32 status)
+{
+ struct cec_msg *msg;
+
+ dprintk("cec_transmit_done\n");
+ mutex_lock(&adap->lock);
+ if (adap->state == CEC_ADAP_STATE_TRANSMITTING) {
+ msg = &adap->tx_queue[adap->tx_qstart].msg;
+ msg->status = status;
+ if (status)
+ msg->reply = 0;
+ ktime_get_ts(&msg->ts);
+ wake_up_interruptible(&adap->kthread_waitq);
+ }
+ mutex_unlock(&adap->lock);
+}
+EXPORT_SYMBOL_GPL(cec_transmit_done);
+
+static int cec_receive_notify(struct cec_adapter *adap, struct cec_msg *msg)
+{
+ bool is_broadcast = cec_msg_is_broadcast(msg);
+ u8 dest_laddr = cec_msg_destination(msg);
+ u8 devtype = cec_log_addr2dev(adap, dest_laddr);
+ bool is_directed = cec_log_addr2idx(adap, dest_laddr) >= 0;
+ struct cec_data tx_data;
+ int res = 0;
+ unsigned idx;
+
+ if (msg->len <= 1)
+ return 0;
+ if (!is_directed && !is_broadcast)
+ return 0; /* Not for us */
+
+ tx_data.msg.msg[0] = (msg->msg[0] << 4) | (msg->msg[0] >> 4);
+ tx_data.msg.reply = 0;
+
+ if (adap->received) {
+ res = adap->received(adap, msg);
+ if (res != -ENOMSG)
+ return 0;
+ res = 0;
+ }
+
+ switch (msg->msg[1]) {
+ case CEC_OP_GET_CEC_VERSION:
+ if (is_broadcast)
+ return 0;
+ tx_data.msg.len = 3;
+ tx_data.msg.msg[1] = CEC_OP_CEC_VERSION;
+ tx_data.msg.msg[2] = adap->version;
+ return cec_transmit_msg(adap, &tx_data, false);
+
+ case CEC_OP_GIVE_PHYS_ADDR:
+ if (!is_directed)
+ return 0;
+ /* Do nothing for CEC switches using addr 15 */
+ if (devtype == CEC_PRIM_DEVTYPE_SWITCH && dest_laddr == 15)
+ return 0;
+ tx_data.msg.len = 5;
+ tx_data.msg.msg[1] = CEC_OP_REPORT_PHYS_ADDR;
+ tx_data.msg.msg[2] = adap->phys_addr >> 8;
+ tx_data.msg.msg[3] = adap->phys_addr & 0xff;
+ tx_data.msg.msg[4] = devtype;
+ return cec_transmit_msg(adap, &tx_data, false);
+
+ case CEC_OP_ABORT:
+ /* Do nothing for CEC switches */
+ if (devtype == CEC_PRIM_DEVTYPE_SWITCH)
+ return 0;
+ tx_data.msg.len = 4;
+ tx_data.msg.msg[1] = CEC_OP_FEATURE_ABORT;
+ tx_data.msg.msg[2] = msg->msg[1];
+ tx_data.msg.msg[3] = 4; /* Refused */
+ return cec_transmit_msg(adap, &tx_data, false);
+ }
+
+ if ((adap->capabilities & CEC_CAP_RECEIVE) == 0)
+ return 0;
+ mutex_lock(&adap->lock);
+ idx = (adap->rx_qstart + adap->rx_qcount) % CEC_RX_QUEUE_SZ;
+ if (adap->rx_qcount == CEC_RX_QUEUE_SZ) {
+ res = -EBUSY;
+ } else {
+ adap->rx_queue[idx] = *msg;
+ adap->rx_qcount++;
+ wake_up_interruptible(&adap->waitq);
+ }
+ mutex_unlock(&adap->lock);
+ return res;
+}
+
+int cec_receive_msg(struct cec_adapter *adap, struct cec_msg *msg, bool block)
+{
+ int res;
+
+ do {
+ mutex_lock(&adap->lock);
+ if (adap->rx_qcount) {
+ *msg = adap->rx_queue[adap->rx_qstart];
+ adap->rx_qstart = (adap->rx_qstart + 1) % CEC_RX_QUEUE_SZ;
+ adap->rx_qcount--;
+ res = 0;
+ } else {
+ res = -EAGAIN;
+ }
+ mutex_unlock(&adap->lock);
+ if (!block || !res)
+ break;
+ if (msg->timeout) {
+ res = wait_event_interruptible_timeout(adap->waitq,
+ adap->rx_qcount, msecs_to_jiffies(msg->timeout));
+ if (res == 0)
+ res = -ETIMEDOUT;
+ else if (res > 0)
+ res = 0;
+ } else {
+ res = wait_event_interruptible(adap->waitq,
+ adap->rx_qcount);
+ }
+ } while (!res);
+ return res;
+}
+EXPORT_SYMBOL_GPL(cec_receive_msg);
+
+void cec_received_msg(struct cec_adapter *adap, struct cec_msg *msg)
+{
+ bool is_reply = false;
+
+ mutex_lock(&adap->lock);
+ ktime_get_ts(&msg->ts);
+ dprintk("cec_received_msg: %02x %02x\n", msg->msg[0], msg->msg[1]);
+ if (!cec_msg_is_broadcast(msg) && msg->len > 1 &&
+ adap->state == CEC_ADAP_STATE_WAIT) {
+ struct cec_msg *dst = &adap->tx_queue[adap->tx_qstart].msg;
+
+ if (msg->msg[1] == dst->reply ||
+ msg->msg[1] == CEC_OP_FEATURE_ABORT) {
+ *dst = *msg;
+ is_reply = true;
+ if (msg->msg[1] == CEC_OP_FEATURE_ABORT) {
+ dst->reply = 0;
+ dst->status = CEC_TX_STATUS_FEATURE_ABORT;
+ }
+ wake_up_interruptible(&adap->kthread_waitq);
+ }
+ }
+ mutex_unlock(&adap->lock);
+ if (!is_reply)
+ adap->recv_notifier(adap, msg);
+}
+EXPORT_SYMBOL_GPL(cec_received_msg);
+
+void cec_post_event(struct cec_adapter *adap, u32 event)
+{
+ unsigned idx;
+
+ mutex_lock(&adap->lock);
+ if (adap->ev_qcount == CEC_EV_QUEUE_SZ) {
+ /* Drop oldest event */
+ adap->ev_qstart = (adap->ev_qstart + 1) % CEC_EV_QUEUE_SZ;
+ adap->ev_qcount--;
+ }
+
+ idx = (adap->ev_qstart + adap->ev_qcount) % CEC_EV_QUEUE_SZ;
+
+ adap->ev_queue[idx].event = event;
+ ktime_get_ts(&adap->ev_queue[idx].ts);
+ adap->ev_qcount++;
+ mutex_unlock(&adap->lock);
+}
+EXPORT_SYMBOL_GPL(cec_post_event);
+
+static int cec_report_phys_addr(struct cec_adapter *adap, unsigned logical_addr)
+{
+ struct cec_data data;
+
+ /* Report Physical Address */
+ data.msg.len = 5;
+ data.msg.msg[0] = (logical_addr << 4) | 0x0f;
+ data.msg.msg[1] = CEC_OP_REPORT_PHYS_ADDR;
+ data.msg.msg[2] = adap->phys_addr >> 8;
+ data.msg.msg[3] = adap->phys_addr & 0xff;
+ data.msg.msg[4] = cec_log_addr2dev(adap, logical_addr);
+ data.msg.reply = 0;
+ dprintk("config: la %d pa %x.%x.%x.%x\n",
+ logical_addr, cec_phys_addr_exp(adap->phys_addr));
+ return cec_transmit_msg(adap, &data, true);
+}
+
+int cec_enable(struct cec_adapter *adap, bool enable)
+{
+ int ret;
+
+ mutex_lock(&adap->lock);
+ ret = adap->adap_enable(adap, enable);
+ if (ret) {
+ mutex_unlock(&adap->lock);
+ return ret;
+ }
+ if (!enable) {
+ adap->state = CEC_ADAP_STATE_DISABLED;
+ adap->tx_qcount = 0;
+ adap->rx_qcount = 0;
+ adap->ev_qcount = 0;
+ adap->num_log_addrs = 0;
+ } else {
+ adap->state = CEC_ADAP_STATE_UNCONF;
+ }
+ mutex_unlock(&adap->lock);
+ return 0;
+}
+EXPORT_SYMBOL_GPL(cec_enable);
+
+struct cec_log_addrs_int {
+ struct cec_adapter *adap;
+ struct cec_log_addrs log_addrs;
+ struct completion c;
+ bool free_on_exit;
+ int err;
+};
+
+static int cec_config_log_addrs(struct cec_adapter *adap, struct cec_log_addrs *log_addrs)
+{
+ static const u8 tv_log_addrs[] = {
+ 0, CEC_LOG_ADDR_INVALID
+ };
+ static const u8 record_log_addrs[] = {
+ 1, 2, 9, 12, 13, CEC_LOG_ADDR_INVALID
+ };
+ static const u8 tuner_log_addrs[] = {
+ 3, 6, 7, 10, 12, 13, CEC_LOG_ADDR_INVALID
+ };
+ static const u8 playback_log_addrs[] = {
+ 4, 8, 11, 12, 13, CEC_LOG_ADDR_INVALID
+ };
+ static const u8 audiosystem_log_addrs[] = {
+ 5, 12, 13, CEC_LOG_ADDR_INVALID
+ };
+ static const u8 specific_use_log_addrs[] = {
+ 14, 12, 13, CEC_LOG_ADDR_INVALID
+ };
+ static const u8 unregistered_log_addrs[] = {
+ CEC_LOG_ADDR_INVALID
+ };
+ static const u8 *type2addrs[7] = {
+ [CEC_LOG_ADDR_TYPE_TV] = tv_log_addrs,
+ [CEC_LOG_ADDR_TYPE_RECORD] = record_log_addrs,
+ [CEC_LOG_ADDR_TYPE_TUNER] = tuner_log_addrs,
+ [CEC_LOG_ADDR_TYPE_PLAYBACK] = playback_log_addrs,
+ [CEC_LOG_ADDR_TYPE_AUDIOSYSTEM] = audiosystem_log_addrs,
+ [CEC_LOG_ADDR_TYPE_SPECIFIC] = specific_use_log_addrs,
+ [CEC_LOG_ADDR_TYPE_UNREGISTERED] = unregistered_log_addrs,
+ };
+ struct cec_data data;
+ u32 claimed_addrs = 0;
+ int i, j;
+ int err;
+
+ if (adap->phys_addr) {
+ /* The TV functionality can only map to physical address 0.
+ For any other address, try the Specific functionality
+ instead as per the spec. */
+ for (i = 0; i < log_addrs->num_log_addrs; i++)
+ if (log_addrs->log_addr_type[i] == CEC_LOG_ADDR_TYPE_TV)
+ log_addrs->log_addr_type[i] = CEC_LOG_ADDR_TYPE_SPECIFIC;
+ }
+
+ memcpy(adap->prim_device, log_addrs->primary_device_type, log_addrs->num_log_addrs);
+ dprintk("physical address: %x.%x.%x.%x, claim %d logical addresses\n",
+ cec_phys_addr_exp(adap->phys_addr), log_addrs->num_log_addrs);
+ adap->num_log_addrs = 0;
+ adap->state = CEC_ADAP_STATE_IDLE;
+
+ /* TODO: remember last used logical addr type to achieve
+ faster logical address polling by trying that one first.
+ */
+ for (i = 0; i < log_addrs->num_log_addrs; i++) {
+ const u8 *la_list = type2addrs[log_addrs->log_addr_type[i]];
+
+ if (kthread_should_stop())
+ return -EINTR;
+
+ for (j = 0; la_list[j] != CEC_LOG_ADDR_INVALID; j++) {
+ u8 log_addr = la_list[j];
+
+ if (claimed_addrs & (1 << log_addr))
+ continue;
+
+ /* Send polling message */
+ data.msg.len = 1;
+ data.msg.msg[0] = 0xf0 | log_addr;
+ data.msg.reply = 0;
+ err = cec_transmit_msg(adap, &data, true);
+ if (err)
+ return err;
+ if (data.msg.status == CEC_TX_STATUS_RETRY_TIMEOUT) {
+ /* Message not acknowledged, so this logical
+ address is free to use. */
+ claimed_addrs |= 1 << log_addr;
+ adap->log_addr[adap->num_log_addrs++] = log_addr;
+ log_addrs->log_addr[i] = log_addr;
+ err = adap->adap_log_addr(adap, log_addr);
+ dprintk("claim addr %d (%d)\n", log_addr, adap->prim_device[i]);
+ if (err)
+ return err;
+ cec_report_phys_addr(adap, log_addr);
+ if (adap->claimed_log_addr)
+ adap->claimed_log_addr(adap, i);
+ break;
+ }
+ }
+ }
+ if (adap->num_log_addrs == 0) {
+ if (log_addrs->num_log_addrs > 1)
+ dprintk("could not claim last %d addresses\n", log_addrs->num_log_addrs - 1);
+ adap->log_addr[adap->num_log_addrs++] = 15;
+ log_addrs->log_addr_type[0] = CEC_LOG_ADDR_TYPE_UNREGISTERED;
+ log_addrs->log_addr[0] = 15;
+ log_addrs->num_log_addrs = 1;
+ err = adap->adap_log_addr(adap, 15);
+ dprintk("claim addr %d (%d)\n", 15, adap->prim_device[0]);
+ if (err)
+ return err;
+ cec_report_phys_addr(adap, 15);
+ if (adap->claimed_log_addr)
+ adap->claimed_log_addr(adap, 0);
+ }
+ return 0;
+}
+
+static int cec_config_thread_func(void *arg)
+{
+ struct cec_log_addrs_int *cla_int = arg;
+ int err;
+
+ cla_int->err = err = cec_config_log_addrs(cla_int->adap, &cla_int->log_addrs);
+ cla_int->adap->kthread_config = NULL;
+ if (cla_int->free_on_exit)
+ kfree(cla_int);
+ else
+ complete(&cla_int->c);
+ return err;
+}
+
+int cec_claim_log_addrs(struct cec_adapter *adap, struct cec_log_addrs *log_addrs, bool block)
+{
+ struct cec_log_addrs_int *cla_int;
+ int i;
+
+ if (adap->state == CEC_ADAP_STATE_DISABLED)
+ return -EINVAL;
+
+ if (log_addrs->num_log_addrs == 0 ||
+ log_addrs->num_log_addrs > CEC_MAX_LOG_ADDRS)
+ return -EINVAL;
+ if (log_addrs->cec_version != CEC_VERSION_1_4B &&
+ log_addrs->cec_version != CEC_VERSION_2_0)
+ return -EINVAL;
+ if (log_addrs->num_log_addrs > 1)
+ for (i = 0; i < log_addrs->num_log_addrs; i++)
+ if (log_addrs->log_addr_type[i] ==
+ CEC_LOG_ADDR_TYPE_UNREGISTERED)
+ return -EINVAL;
+ for (i = 0; i < log_addrs->num_log_addrs; i++) {
+ if (log_addrs->primary_device_type[i] > CEC_PRIM_DEVTYPE_VIDEOPROC)
+ return -EINVAL;
+ if (log_addrs->primary_device_type[i] == 2)
+ return -EINVAL;
+ if (log_addrs->log_addr_type[i] > CEC_LOG_ADDR_TYPE_UNREGISTERED)
+ return -EINVAL;
+ }
+
+ /* For phys addr 0xffff only the Unregistered functionality is
+ allowed. */
+ if (adap->phys_addr == 0xffff &&
+ (log_addrs->num_log_addrs > 1 ||
+ log_addrs->log_addr_type[0] != CEC_LOG_ADDR_TYPE_UNREGISTERED))
+ return -EINVAL;
+
+ cla_int = kzalloc(sizeof(*cla_int), GFP_KERNEL);
+ if (cla_int == NULL)
+ return -ENOMEM;
+ init_completion(&cla_int->c);
+ cla_int->free_on_exit = !block;
+ cla_int->adap = adap;
+ cla_int->log_addrs = *log_addrs;
+ adap->kthread_config = kthread_run(cec_config_thread_func, cla_int, "cec_log_addrs");
+ if (block) {
+ wait_for_completion(&cla_int->c);
+ kfree(cla_int);
+ }
+ return 0;
+}
+EXPORT_SYMBOL_GPL(cec_claim_log_addrs);
+
+static ssize_t cec_read(struct file *filp, char __user *buf,
+ size_t sz, loff_t *off)
+{
+ struct cec_devnode *cecdev = cec_devnode_data(filp);
+
+ if (!cec_devnode_is_registered(cecdev))
+ return -EIO;
+ return 0;
+}
+
+static ssize_t cec_write(struct file *filp, const char __user *buf,
+ size_t sz, loff_t *off)
+{
+ struct cec_devnode *cecdev = cec_devnode_data(filp);
+
+ if (!cec_devnode_is_registered(cecdev))
+ return -EIO;
+ return 0;
+}
+
+static unsigned int cec_poll(struct file *filp,
+ struct poll_table_struct *poll)
+{
+ struct cec_devnode *cecdev = cec_devnode_data(filp);
+ struct cec_adapter *adap = to_cec_adapter(cecdev);
+ unsigned res = 0;
+
+ if (!cec_devnode_is_registered(cecdev))
+ return POLLERR | POLLHUP;
+ mutex_lock(&adap->lock);
+ if (adap->tx_qcount < CEC_TX_QUEUE_SZ)
+ res |= POLLOUT | POLLWRNORM;
+ if (adap->rx_qcount)
+ res |= POLLIN | POLLRDNORM;
+ poll_wait(filp, &adap->waitq, poll);
+ mutex_unlock(&adap->lock);
+ return res;
+}
+
+static long cec_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
+{
+ struct cec_devnode *cecdev = cec_devnode_data(filp);
+ struct cec_adapter *adap = to_cec_adapter(cecdev);
+ void __user *parg = (void __user *)arg;
+ int err;
+
+ if (!cec_devnode_is_registered(cecdev))
+ return -EIO;
+
+ switch (cmd) {
+ case CEC_G_CAPS: {
+ struct cec_caps caps;
+
+ caps.available_log_addrs = 3;
+ caps.capabilities = adap->capabilities;
+ if (copy_to_user(parg, &caps, sizeof(caps)))
+ return -EFAULT;
+ break;
+ }
+
+ case CEC_TRANSMIT: {
+ struct cec_data data;
+
+ if (!(adap->capabilities & CEC_CAP_TRANSMIT))
+ return -ENOTTY;
+ if (copy_from_user(&data.msg, parg, sizeof(data.msg)))
+ return -EFAULT;
+ err = cec_transmit_msg(adap, &data, !(filp->f_flags & O_NONBLOCK));
+ if (err)
+ return err;
+ if (copy_to_user(parg, &data.msg, sizeof(data.msg)))
+ return -EFAULT;
+ break;
+ }
+
+ case CEC_RECEIVE: {
+ struct cec_data data;
+
+ if (!(adap->capabilities & CEC_CAP_RECEIVE))
+ return -ENOTTY;
+ if (copy_from_user(&data.msg, parg, sizeof(data.msg)))
+ return -EFAULT;
+ err = cec_receive_msg(adap, &data.msg, !(filp->f_flags & O_NONBLOCK));
+ if (err)
+ return err;
+ if (copy_to_user(parg, &data.msg, sizeof(data.msg)))
+ return -EFAULT;
+ break;
+ }
+
+ case CEC_G_EVENT: {
+ struct cec_event ev;
+
+ mutex_lock(&adap->lock);
+ err = -EAGAIN;
+ if (adap->ev_qcount) {
+ err = 0;
+ ev = adap->ev_queue[adap->ev_qstart];
+ adap->ev_qstart = (adap->ev_qstart + 1) % CEC_EV_QUEUE_SZ;
+ adap->ev_qcount--;
+ }
+ mutex_unlock(&adap->lock);
+ if (err)
+ return err;
+ if (copy_to_user((void __user *)arg, &ev, sizeof(ev)))
+ return -EFAULT;
+ break;
+ }
+
+ case CEC_G_ADAP_STATE: {
+ u32 state = adap->state != CEC_ADAP_STATE_DISABLED;
+
+ if (copy_to_user(parg, &state, sizeof(state)))
+ return -EFAULT;
+ break;
+ }
+
+ case CEC_S_ADAP_STATE: {
+ u32 state;
+
+ if (!(adap->capabilities & CEC_CAP_STATE))
+ return -ENOTTY;
+ if (copy_from_user(&state, parg, sizeof(state)))
+ return -EFAULT;
+ if (!state && adap->state == CEC_ADAP_STATE_DISABLED)
+ return 0;
+ if (state && adap->state != CEC_ADAP_STATE_DISABLED)
+ return 0;
+ cec_enable(adap, !!state);
+ break;
+ }
+
+ case CEC_G_ADAP_PHYS_ADDR:
+ if (copy_to_user(parg, &adap->phys_addr, sizeof(adap->phys_addr)))
+ return -EFAULT;
+ break;
+
+ case CEC_S_ADAP_PHYS_ADDR: {
+ u16 phys_addr;
+
+ if (!(adap->capabilities & CEC_CAP_PHYS_ADDR))
+ return -ENOTTY;
+ if (copy_from_user(&phys_addr, parg, sizeof(phys_addr)))
+ return -EFAULT;
+ adap->phys_addr = phys_addr;
+ break;
+ }
+
+ case CEC_G_ADAP_LOG_ADDRS: {
+ struct cec_log_addrs log_addrs;
+
+ log_addrs.cec_version = adap->version;
+ log_addrs.num_log_addrs = adap->num_log_addrs;
+ memcpy(log_addrs.primary_device_type, adap->prim_device, CEC_MAX_LOG_ADDRS);
+ memcpy(log_addrs.log_addr_type, adap->log_addr_type, CEC_MAX_LOG_ADDRS);
+ memcpy(log_addrs.log_addr, adap->log_addr, CEC_MAX_LOG_ADDRS);
+
+ if (copy_to_user(parg, &log_addrs, sizeof(log_addrs)))
+ return -EFAULT;
+ break;
+ }
+
+ case CEC_S_ADAP_LOG_ADDRS: {
+ struct cec_log_addrs log_addrs;
+
+ if (!(adap->capabilities & CEC_CAP_LOG_ADDRS))
+ return -ENOTTY;
+ if (copy_from_user(&log_addrs, parg, sizeof(log_addrs)))
+ return -EFAULT;
+ err = cec_claim_log_addrs(adap, &log_addrs, true);
+ if (err)
+ return err;
+
+ if (copy_to_user(parg, &log_addrs, sizeof(log_addrs)))
+ return -EFAULT;
+ break;
+ }
+
+ default:
+ return -ENOTTY;
+ }
+ return 0;
+}
+
+/* Override for the open function */
+static int cec_open(struct inode *inode, struct file *filp)
+{
+ struct cec_devnode *cecdev;
+
+ /* Check if the cec device is available. This needs to be done with
+ * the cec_devnode_lock held to prevent an open/unregister race:
+ * without the lock, the device could be unregistered and freed between
+ * the cec_devnode_is_registered() and get_device() calls, leading to
+ * a crash.
+ */
+ mutex_lock(&cec_devnode_lock);
+ cecdev = container_of(inode->i_cdev, struct cec_devnode, cdev);
+ /* return ENXIO if the cec device has been removed
+ already or if it is not registered anymore. */
+ if (!cec_devnode_is_registered(cecdev)) {
+ mutex_unlock(&cec_devnode_lock);
+ return -ENXIO;
+ }
+ /* and increase the device refcount */
+ get_device(&cecdev->dev);
+ mutex_unlock(&cec_devnode_lock);
+
+ filp->private_data = cecdev;
+
+ return 0;
+}
+
+/* Override for the release function */
+static int cec_release(struct inode *inode, struct file *filp)
+{
+ struct cec_devnode *cecdev = cec_devnode_data(filp);
+ int ret = 0;
+
+ /* decrease the refcount unconditionally since the release()
+ return value is ignored. */
+ put_device(&cecdev->dev);
+ filp->private_data = NULL;
+ return ret;
+}
+
+static const struct file_operations cec_devnode_fops = {
+ .owner = THIS_MODULE,
+ .read = cec_read,
+ .write = cec_write,
+ .open = cec_open,
+ .unlocked_ioctl = cec_ioctl,
+ .release = cec_release,
+ .poll = cec_poll,
+ .llseek = no_llseek,
+};
+
+/**
+ * cec_devnode_register - register a cec device node
+ * @cecdev: cec device node structure we want to register
+ *
+ * The registration code assigns minor numbers and registers the new device node
+ * with the kernel. An error is returned if no free minor number can be found,
+ * or if the registration of the device node fails.
+ *
+ * Zero is returned on success.
+ *
+ * Note that if the cec_devnode_register call fails, the release() callback of
+ * the cec_devnode structure is *not* called, so the caller is responsible for
+ * freeing any data.
+ */
+static int __must_check cec_devnode_register(struct cec_devnode *cecdev,
+ struct module *owner)
+{
+ int minor;
+ int ret;
+
+ /* Part 1: Find a free minor number */
+ mutex_lock(&cec_devnode_lock);
+ minor = find_next_zero_bit(cec_devnode_nums, CEC_NUM_DEVICES, 0);
+ if (minor == CEC_NUM_DEVICES) {
+ mutex_unlock(&cec_devnode_lock);
+ pr_err("could not get a free minor\n");
+ return -ENFILE;
+ }
+
+ set_bit(minor, cec_devnode_nums);
+ mutex_unlock(&cec_devnode_lock);
+
+ cecdev->minor = minor;
+
+ /* Part 2: Initialize and register the character device */
+ cdev_init(&cecdev->cdev, &cec_devnode_fops);
+ cecdev->cdev.owner = owner;
+
+ ret = cdev_add(&cecdev->cdev, MKDEV(MAJOR(cec_dev_t), cecdev->minor), 1);
+ if (ret < 0) {
+ pr_err("%s: cdev_add failed\n", __func__);
+ goto error;
+ }
+
+ /* Part 3: Register the cec device */
+ cecdev->dev.bus = &cec_bus_type;
+ cecdev->dev.devt = MKDEV(MAJOR(cec_dev_t), cecdev->minor);
+ cecdev->dev.release = cec_devnode_release;
+ if (cecdev->parent)
+ cecdev->dev.parent = cecdev->parent;
+ dev_set_name(&cecdev->dev, "cec%d", cecdev->minor);
+ ret = device_register(&cecdev->dev);
+ if (ret < 0) {
+ pr_err("%s: device_register failed\n", __func__);
+ goto error;
+ }
+
+ /* Part 4: Activate this minor. The char device can now be used. */
+ set_bit(CEC_FLAG_REGISTERED, &cecdev->flags);
+
+ return 0;
+
+error:
+ cdev_del(&cecdev->cdev);
+ clear_bit(cecdev->minor, cec_devnode_nums);
+ return ret;
+}
+
+/**
+ * cec_devnode_unregister - unregister a cec device node
+ * @cecdev: the device node to unregister
+ *
+ * This unregisters the passed device. Future open calls will be met with
+ * errors.
+ *
+ * This function can safely be called if the device node has never been
+ * registered or has already been unregistered.
+ */
+static void cec_devnode_unregister(struct cec_devnode *cecdev)
+{
+ /* Check if cecdev was ever registered at all */
+ if (!cec_devnode_is_registered(cecdev))
+ return;
+
+ mutex_lock(&cec_devnode_lock);
+ clear_bit(CEC_FLAG_REGISTERED, &cecdev->flags);
+ mutex_unlock(&cec_devnode_lock);
+ device_unregister(&cecdev->dev);
+}
+
+int cec_create_adapter(struct cec_adapter *adap, const char *name, u32 caps)
+{
+ int res = 0;
+
+ adap->state = CEC_ADAP_STATE_DISABLED;
+ adap->name = name;
+ adap->phys_addr = 0xffff;
+ adap->capabilities = caps;
+ adap->version = CEC_VERSION_1_4B;
+ mutex_init(&adap->lock);
+ adap->kthread = kthread_run(cec_thread_func, adap, name);
+ init_waitqueue_head(&adap->kthread_waitq);
+ init_waitqueue_head(&adap->waitq);
+ if (IS_ERR(adap->kthread)) {
+ pr_err("cec-%s: kernel_thread() failed\n", name);
+ return PTR_ERR(adap->kthread);
+ }
+ if (caps) {
+ res = cec_devnode_register(&adap->devnode, adap->owner);
+ if (res)
+ kthread_stop(adap->kthread);
+ }
+ adap->recv_notifier = cec_receive_notify;
+ return res;
+}
+EXPORT_SYMBOL_GPL(cec_create_adapter);
+
+void cec_delete_adapter(struct cec_adapter *adap)
+{
+ if (adap->kthread == NULL)
+ return;
+ kthread_stop(adap->kthread);
+ if (adap->kthread_config)
+ kthread_stop(adap->kthread_config);
+ adap->state = CEC_ADAP_STATE_DISABLED;
+ if (cec_devnode_is_registered(&adap->devnode))
+ cec_devnode_unregister(&adap->devnode);
+}
+EXPORT_SYMBOL_GPL(cec_delete_adapter);
+
+/*
+ * Initialise cec for linux
+ */
+static int __init cec_devnode_init(void)
+{
+ int ret;
+
+ pr_info("Linux cec interface: v0.10\n");
+ ret = alloc_chrdev_region(&cec_dev_t, 0, CEC_NUM_DEVICES,
+ CEC_NAME);
+ if (ret < 0) {
+ pr_warn("cec: unable to allocate major\n");
+ return ret;
+ }
+
+ ret = bus_register(&cec_bus_type);
+ if (ret < 0) {
+ unregister_chrdev_region(cec_dev_t, CEC_NUM_DEVICES);
+ pr_warn("cec: bus_register failed\n");
+ return -EIO;
+ }
+
+ return 0;
+}
+
+static void __exit cec_devnode_exit(void)
+{
+ bus_unregister(&cec_bus_type);
+ unregister_chrdev_region(cec_dev_t, CEC_NUM_DEVICES);
+}
+
+subsys_initcall(cec_devnode_init);
+module_exit(cec_devnode_exit)
+
+MODULE_AUTHOR("Hans Verkuil <hans.verkuil at cisco.com>");
+MODULE_DESCRIPTION("Device node registration for cec drivers");
+MODULE_LICENSE("GPL");
diff --git a/include/media/cec.h b/include/media/cec.h
new file mode 100644
index 0000000..e78023f
--- /dev/null
+++ b/include/media/cec.h
@@ -0,0 +1,129 @@
+#ifndef _CEC_DEVNODE_H
+#define _CEC_DEVNODE_H
+
+#include <linux/poll.h>
+#include <linux/fs.h>
+#include <linux/device.h>
+#include <linux/cdev.h>
+#include <linux/kthread.h>
+#include <linux/cec.h>
+
+#define cec_phys_addr_exp(pa) \
+ ((pa) >> 12), ((pa) >> 8) & 0xf, ((pa) >> 4) & 0xf, (pa) & 0xf
+
+/*
+ * Flag to mark the cec_devnode struct as registered. Drivers must not touch
+ * this flag directly, it will be set and cleared by cec_devnode_register and
+ * cec_devnode_unregister.
+ */
+#define CEC_FLAG_REGISTERED 0
+
+/**
+ * struct cec_devnode - cec device node
+ * @parent: parent device
+ * @minor: device node minor number
+ * @flags: flags, combination of the CEC_FLAG_* constants
+ *
+ * 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; /* cec device */
+ struct cdev cdev; /* character device */
+ struct device *parent; /* device parent */
+
+ /* device info */
+ int minor;
+ unsigned long flags; /* Use bitops to access flags */
+
+ /* callbacks */
+ void (*release)(struct cec_devnode *cecdev);
+};
+
+static inline int cec_devnode_is_registered(struct cec_devnode *cecdev)
+{
+ return test_bit(CEC_FLAG_REGISTERED, &cecdev->flags);
+}
+
+struct cec_adapter;
+struct cec_data;
+
+typedef int (*cec_notify)(struct cec_adapter *adap, struct cec_data *data, void *priv);
+typedef int (*cec_recv_notify)(struct cec_adapter *adap, struct cec_msg *msg);
+
+struct cec_data {
+ struct cec_msg msg;
+ cec_notify func;
+ void *priv;
+};
+
+/* Unconfigured state */
+#define CEC_ADAP_STATE_DISABLED 0
+#define CEC_ADAP_STATE_UNCONF 1
+#define CEC_ADAP_STATE_IDLE 2
+#define CEC_ADAP_STATE_TRANSMITTING 3
+#define CEC_ADAP_STATE_WAIT 4
+#define CEC_ADAP_STATE_RECEIVED 5
+
+#define CEC_TX_QUEUE_SZ (4)
+#define CEC_RX_QUEUE_SZ (4)
+#define CEC_EV_QUEUE_SZ (16)
+
+struct cec_adapter {
+ struct module *owner;
+ const char *name;
+ struct cec_devnode devnode;
+ struct mutex lock;
+
+ struct cec_data tx_queue[CEC_TX_QUEUE_SZ];
+ u8 tx_qstart, tx_qcount;
+
+ struct cec_msg rx_queue[CEC_RX_QUEUE_SZ];
+ u8 rx_qstart, rx_qcount;
+
+ struct cec_event ev_queue[CEC_EV_QUEUE_SZ];
+ u8 ev_qstart, ev_qcount;
+
+ cec_recv_notify recv_notifier;
+ struct task_struct *kthread_config;
+
+ struct task_struct *kthread;
+ wait_queue_head_t kthread_waitq;
+ wait_queue_head_t waitq;
+
+ u8 state;
+ u32 capabilities;
+ u16 phys_addr;
+ u8 version;
+ u8 num_log_addrs;
+ u8 prim_device[CEC_MAX_LOG_ADDRS];
+ u8 log_addr_type[CEC_MAX_LOG_ADDRS];
+ u8 log_addr[CEC_MAX_LOG_ADDRS];
+
+ int (*adap_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, struct cec_msg *msg);
+ void (*adap_transmit_timed_out)(struct cec_adapter *adap);
+
+ void (*claimed_log_addr)(struct cec_adapter *adap, u8 idx);
+ int (*received)(struct cec_adapter *adap, struct cec_msg *msg);
+};
+
+#define to_cec_adapter(node) container_of(node, struct cec_adapter, devnode)
+
+int cec_create_adapter(struct cec_adapter *adap, const char *name, u32 caps);
+void cec_delete_adapter(struct cec_adapter *adap);
+int cec_transmit_msg(struct cec_adapter *adap, struct cec_data *data, bool block);
+int cec_receive_msg(struct cec_adapter *adap, struct cec_msg *msg, bool block);
+void cec_post_event(struct cec_adapter *adap, u32 event);
+int cec_claim_log_addrs(struct cec_adapter *adap, struct cec_log_addrs *log_addrs, bool block);
+int cec_enable(struct cec_adapter *adap, bool enable);
+
+/* Called by the adapter */
+void cec_transmit_done(struct cec_adapter *adap, u32 status);
+void cec_received_msg(struct cec_adapter *adap, struct cec_msg *msg);
+
+#endif /* _CEC_DEVNODE_H */
diff --git a/include/uapi/linux/cec.h b/include/uapi/linux/cec.h
new file mode 100644
index 0000000..a2c78d7
--- /dev/null
+++ b/include/uapi/linux/cec.h
@@ -0,0 +1,222 @@
+#ifndef _CEC_H
+#define _CEC_H
+
+#include <linux/types.h>
+
+struct cec_msg {
+ __u32 len;
+ __u8 msg[16];
+ __u32 status;
+ /* If non-zero, then wait for a reply with this opcode.
+ If there was an error when sending the msg or FeatureAbort
+ was returned, then reply is set to 0.
+ If reply is non-zero upon return, then len/msg are set to
+ the received message.
+ If reply is zero upon return and status has the CEC_TX_STATUS_FEATURE_ABORT
+ bit set, then len/msg are set to the received feature abort message.
+ If reply is zero upon return and status has the CEC_TX_STATUS_REPLY_TIMEOUT
+ bit set, then no reply was seen at all.
+ This field is ignored with CEC_RECEIVE.
+ If reply is non-zero for CEC_TRANSMIT and the message is a broadcast,
+ then -EINVAL is returned.
+ if reply is non-zero, then timeout is set to 1000 (the required maximum
+ response time).
+ */
+ __u8 reply;
+ /* timeout (in ms) is used to timeout CEC_RECEIVE.
+ Set to 0 if you want to wait forever. */
+ __u32 timeout;
+ struct timespec ts;
+};
+
+static inline __u8 cec_msg_initiator(const struct cec_msg *msg)
+{
+ return msg->msg[0] >> 4;
+}
+
+static inline __u8 cec_msg_destination(const struct cec_msg *msg)
+{
+ return msg->msg[0] & 0xf;
+}
+
+static inline bool cec_msg_is_broadcast(const struct cec_msg *msg)
+{
+ return (msg->msg[0] & 0xf) == 0xf;
+}
+
+/* cec status field */
+#define CEC_TX_STATUS_OK (0)
+#define CEC_TX_STATUS_ARB_LOST (1 << 0)
+#define CEC_TX_STATUS_RETRY_TIMEOUT (1 << 1)
+#define CEC_TX_STATUS_FEATURE_ABORT (1 << 2)
+#define CEC_TX_STATUS_REPLY_TIMEOUT (1 << 3)
+#define CEC_RX_STATUS_READY (0)
+
+#define CEC_LOG_ADDR_INVALID 0xff
+
+// The maximum number of logical addresses one device can be assigned to.
+// The CEC 2.0 spec allows for only 2 logical addresses at the moment. The
+// Analog Devices CEC hardware supports 3. So let's go wild and go for 4.
+#define CEC_MAX_LOG_ADDRS 4
+
+// "You are in a maze of twisty little defines, all alike"
+// What were they thinking of when they came up with this mess...
+
+// The "Primary Device Type"
+#define CEC_PRIM_DEVTYPE_TV 0
+#define CEC_PRIM_DEVTYPE_RECORD 1
+#define CEC_PRIM_DEVTYPE_TUNER 3
+#define CEC_PRIM_DEVTYPE_PLAYBACK 4
+#define CEC_PRIM_DEVTYPE_AUDIOSYSTEM 5
+#define CEC_PRIM_DEVTYPE_SWITCH 6
+#define CEC_PRIM_DEVTYPE_VIDEOPROC 7
+
+// The "All Device Types" flags (CEC 2.0)
+#define CEC_FL_ALL_DEVTYPE_TV (1 << 7)
+#define CEC_FL_ALL_DEVTYPE_RECORD (1 << 6)
+#define CEC_FL_ALL_DEVTYPE_TUNER (1 << 5)
+#define CEC_FL_ALL_DEVTYPE_PLAYBACK (1 << 4)
+#define CEC_FL_ALL_DEVTYPE_AUDIOSYSTEM (1 << 3)
+#define CEC_FL_ALL_DEVTYPE_SWITCH (1 << 2)
+// And if you wondering what happened to VIDEOPROC devices: those should
+// be mapped to a SWITCH.
+
+// The logical address types that the CEC device wants to claim
+#define CEC_LOG_ADDR_TYPE_TV 0
+#define CEC_LOG_ADDR_TYPE_RECORD 1
+#define CEC_LOG_ADDR_TYPE_TUNER 2
+#define CEC_LOG_ADDR_TYPE_PLAYBACK 3
+#define CEC_LOG_ADDR_TYPE_AUDIOSYSTEM 4
+#define CEC_LOG_ADDR_TYPE_SPECIFIC 5
+#define CEC_LOG_ADDR_TYPE_UNREGISTERED 6
+// Switches should use UNREGISTERED.
+// Video processors should use SPECIFIC.
+
+// The CEC version
+#define CEC_VERSION_1_4B 5
+#define CEC_VERSION_2_0 6
+
+struct cec_event {
+ __u32 event;
+ struct timespec ts;
+};
+
+/* Userspace has to configure the adapter state (enable/disable) */
+#define CEC_CAP_STATE (1 << 0)
+/* Userspace has to configure the physical address */
+#define CEC_CAP_PHYS_ADDR (1 << 1)
+/* Userspace has to configure the logical addresses */
+#define CEC_CAP_LOG_ADDRS (1 << 2)
+/* Userspace can transmit messages */
+#define CEC_CAP_TRANSMIT (1 << 3)
+/* Userspace can receive messages */
+#define CEC_CAP_RECEIVE (1 << 4)
+
+struct cec_caps {
+ __u32 available_log_addrs;
+ __u32 capabilities;
+};
+
+struct cec_log_addrs {
+ __u8 cec_version;
+ __u8 num_log_addrs;
+ __u8 primary_device_type[CEC_MAX_LOG_ADDRS];
+ __u8 log_addr_type[CEC_MAX_LOG_ADDRS];
+ __u8 log_addr[CEC_MAX_LOG_ADDRS];
+
+ /* CEC 2.0 */
+ __u8 all_device_types;
+ __u8 features[CEC_MAX_LOG_ADDRS][12];
+};
+
+/* Commands */
+
+/* Standby Feature */
+#define CEC_OP_STANDBY 0x36
+
+/* System Information Feature */
+#define CEC_OP_CEC_VERSION 0x9e
+#define CEC_OP_GET_CEC_VERSION 0x9f
+#define CEC_OP_GIVE_PHYS_ADDR 0x83
+#define CEC_OP_GET_MENU_LANG 0x91
+#define CEC_OP_REPORT_PHYS_ADDR 0x84
+#define CEC_OP_SET_MENU_LANG 0x32
+
+/* One Touch Play Feature */
+#define CEC_OP_ACTIVE_SOURCE 0x82
+#define CEC_OP_REQUEST_ACTIVE_SOURCE 0x85
+#define CEC_OP_IMAGE_VIEW_ON 0x04
+#define CEC_OP_TEXT_VIEW_ON 0x0d
+
+/* Vendor Specific Commands Feature */
+#define CEC_OP_DEVICE_VENDOR_ID 0x87
+#define CEC_OP_GIVE_DEVICE_VENDOR_ID 0x8c
+#define CEC_OP_VENDOR_CMD 0x89
+#define CEC_OP_VENDOR_CMD_WITH_ID 0xa0
+#define CEC_OP_VENDOR_REMOTE_BTN_DOWN 0x8a
+#define CEC_OP_VENDOR_REMOTE_BTN_UP 0x8b
+
+/* OSD Display Feature */
+#define CEC_OP_SET_OSD_STRING 0x64
+#define CEC_OP_GIVE_OSD_NAME 0x46
+#define CEC_OP_SET_OSD_NAME 0x47
+
+/* Power Status Feature */
+#define CEC_OP_GIVE_DEVICE_POWER_STATUS 0x8f
+#define CEC_OP_REPORT_POWER_STATUS 0x90
+
+/* General Protocol Messages */
+#define CEC_OP_FEATURE_ABORT 0x00
+#define CEC_OP_ABORT 0xff
+
+/* Capability Discovery and Control Feature */
+#define CEC_OP_CDC_MSG 0xf8
+#define CDC_OP_HPD_SET_STATE 0x10
+#define CDC_OP_HPD_REPORT_STATE 0x11
+
+/* ioctls */
+
+#define CEC_EVENT_READY 1
+#define CEC_EVENT_DISCONNECT 2
+
+/* issue a CEC command */
+#define CEC_G_CAPS _IOWR('a', 0, struct cec_caps)
+#define CEC_TRANSMIT _IOWR('a', 1, struct cec_msg)
+#define CEC_RECEIVE _IOWR('a', 2, struct cec_msg)
+
+/*
+ Configure the CEC adapter. It sets the device type and which
+ logical types it will try to claim. It will return which
+ logical addresses it could actually claim.
+ An error is returned if the adapter is disabled or if there
+ is no physical address assigned.
+ */
+
+#define CEC_G_ADAP_LOG_ADDRS _IOR('a', 3, struct cec_log_addrs)
+#define CEC_S_ADAP_LOG_ADDRS _IOWR('a', 4, struct cec_log_addrs)
+
+/*
+ Enable/disable the adapter. The Set state ioctl may not
+ be available if that is handled internally.
+ */
+#define CEC_G_ADAP_STATE _IOR('a', 5, __u32)
+#define CEC_S_ADAP_STATE _IOW('a', 6, __u32)
+
+/*
+ phys_addr is either 0 (if this is the CEC root device)
+ or a valid physical address obtained from the sink's EDID
+ as read by this CEC device (if this is a source device)
+ or a physical address obtained and modified from a sink
+ EDID and used for a sink CEC device.
+ If nothing is connected, then phys_addr is 0xffff.
+ See HDMI 1.4b, section 8.7 (Physical Address).
+
+ The Set ioctl may not be available if that is handled
+ internally.
+ */
+#define CEC_G_ADAP_PHYS_ADDR _IOR('a', 7, __u16)
+#define CEC_S_ADAP_PHYS_ADDR _IOW('a', 8, __u16)
+
+#define CEC_G_EVENT _IOWR('a', 9, struct cec_event)
+
+#endif
--
1.7.9.5
More information about the dri-devel
mailing list