drivers/media/cec/cec-core.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * cec-core.c - HDMI Consumer Electronics Control framework - Core
   4  *
   5  * Copyright 2016 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
   6  */
   7
   8 #include <linux/errno.h>
   9 #include <linux/init.h>
  10 #include <linux/module.h>
  11 #include <linux/kernel.h>
  12 #include <linux/kmod.h>
  13 #include <linux/slab.h>
  14 #include <linux/mm.h>
  15 #include <linux/string.h>
  16 #include <linux/types.h>
  17
  18 #include "cec-priv.h"
  19
  20 #define CEC_NUM_DEVICES 256
  21 #define CEC_NAME        "cec"
  22
  23 int cec_debug;
  24 module_param_named(debug, cec_debug, int, 0644);
  25 MODULE_PARM_DESC(debug, "debug level (0-2)");
  26
  27 static bool debug_phys_addr;
  28 module_param(debug_phys_addr, bool, 0644);
  29 MODULE_PARM_DESC(debug_phys_addr, "add CEC_CAP_PHYS_ADDR if set");
  30
  31 static dev_t cec_dev_t;
  32
  33 /* Active devices */
  34 static DEFINE_MUTEX(cec_devnode_lock);
  35 static DECLARE_BITMAP(cec_devnode_nums, CEC_NUM_DEVICES);
  36
  37 static struct dentry *top_cec_dir;
  38
  39 /* dev to cec_devnode */
  40 #define to_cec_devnode(cd) container_of(cd, struct cec_devnode, dev)
  41
  42 int cec_get_device(struct cec_devnode *devnode)
  43 {
  44         /*
  45          * Check if the cec device is available. This needs to be done with
  46          * the devnode->lock held to prevent an open/unregister race:
  47          * without the lock, the device could be unregistered and freed between
  48          * the devnode->registered check and get_device() calls, leading to
  49          * a crash.
  50          */
  51         mutex_lock(&devnode->lock);
  52         /*
  53          * return ENXIO if the cec device has been removed
  54          * already or if it is not registered anymore.
  55          */
  56         if (!devnode->registered) {
  57                 mutex_unlock(&devnode->lock);
  58                 return -ENXIO;
  59         }
  60         /* and increase the device refcount */
  61         get_device(&devnode->dev);
  62         mutex_unlock(&devnode->lock);
  63         return 0;
  64 }
  65
  66 void cec_put_device(struct cec_devnode *devnode)
  67 {
  68         put_device(&devnode->dev);
  69 }
  70
  71 /* Called when the last user of the cec device exits. */
  72 static void cec_devnode_release(struct device *cd)
  73 {
  74         struct cec_devnode *devnode = to_cec_devnode(cd);
  75
  76         mutex_lock(&cec_devnode_lock);
  77         /* Mark device node number as free */
  78         clear_bit(devnode->minor, cec_devnode_nums);
  79         mutex_unlock(&cec_devnode_lock);
  80
  81         cec_delete_adapter(to_cec_adapter(devnode));
  82 }
  83
  84 static struct bus_type cec_bus_type = {
  85         .name = CEC_NAME,
  86 };
  87
  88 /*
  89  * Register a cec device node
  90  *
  91  * The registration code assigns minor numbers and registers the new device node
  92  * with the kernel. An error is returned if no free minor number can be found,
  93  * or if the registration of the device node fails.
  94  *
  95  * Zero is returned on success.
  96  *
  97  * Note that if the cec_devnode_register call fails, the release() callback of
  98  * the cec_devnode structure is *not* called, so the caller is responsible for
  99  * freeing any data.
 100  */
 101 static int __must_check cec_devnode_register(struct cec_devnode *devnode,
 102                                              struct module *owner)
 103 {
 104         int minor;
 105         int ret;
 106
 107         /* Part 1: Find a free minor number */
 108         mutex_lock(&cec_devnode_lock);
 109         minor = find_next_zero_bit(cec_devnode_nums, CEC_NUM_DEVICES, 0);
 110         if (minor == CEC_NUM_DEVICES) {
 111                 mutex_unlock(&cec_devnode_lock);
 112                 pr_err("could not get a free minor\n");
 113                 return -ENFILE;
 114         }
 115
 116         set_bit(minor, cec_devnode_nums);
 117         mutex_unlock(&cec_devnode_lock);
 118
 119         devnode->minor = minor;
 120         devnode->dev.bus = &cec_bus_type;
 121         devnode->dev.devt = MKDEV(MAJOR(cec_dev_t), minor);
 122         devnode->dev.release = cec_devnode_release;
 123         dev_set_name(&devnode->dev, "cec%d", devnode->minor);
 124         device_initialize(&devnode->dev);
 125
 126         /* Part 2: Initialize and register the character device */
 127         cdev_init(&devnode->cdev, &cec_devnode_fops);
 128         devnode->cdev.owner = owner;
 129
 130         ret = cdev_device_add(&devnode->cdev, &devnode->dev);
 131         if (ret) {
 132                 pr_err("%s: cdev_device_add failed\n", __func__);
 133                 goto clr_bit;
 134         }
 135
 136         devnode->registered = true;
 137         return 0;
 138
 139 clr_bit:
 140         mutex_lock(&cec_devnode_lock);
 141         clear_bit(devnode->minor, cec_devnode_nums);
 142         mutex_unlock(&cec_devnode_lock);
 143         return ret;
 144 }
 145
 146 /*
 147  * Unregister a cec device node
 148  *
 149  * This unregisters the passed device. Future open calls will be met with
 150  * errors.
 151  *
 152  * This function can safely be called if the device node has never been
 153  * registered or has already been unregistered.
 154  */
 155 static void cec_devnode_unregister(struct cec_adapter *adap)
 156 {
 157         struct cec_devnode *devnode = &adap->devnode;
 158         struct cec_fh *fh;
 159
 160         mutex_lock(&devnode->lock);
 161
 162         /* Check if devnode was never registered or already unregistered */
 163         if (!devnode->registered || devnode->unregistered) {
 164                 mutex_unlock(&devnode->lock);
 165                 return;
 166         }
 167
 168         list_for_each_entry(fh, &devnode->fhs, list)
 169                 wake_up_interruptible(&fh->wait);
 170
 171         devnode->registered = false;
 172         devnode->unregistered = true;
 173         mutex_unlock(&devnode->lock);
 174
 175         mutex_lock(&adap->lock);
 176         __cec_s_phys_addr(adap, CEC_PHYS_ADDR_INVALID, false);
 177         __cec_s_log_addrs(adap, NULL, false);
 178         mutex_unlock(&adap->lock);
 179
 180         cdev_device_del(&devnode->cdev, &devnode->dev);
 181         put_device(&devnode->dev);
 182 }
 183
 184 #ifdef CONFIG_CEC_NOTIFIER
 185 static void cec_cec_notify(struct cec_adapter *adap, u16 pa)
 186 {
 187         cec_s_phys_addr(adap, pa, false);
 188 }
 189
 190 void cec_register_cec_notifier(struct cec_adapter *adap,
 191                                struct cec_notifier *notifier)
 192 {
 193         if (WARN_ON(!cec_is_registered(adap)))
 194                 return;
 195
 196         adap->notifier = notifier;
 197         cec_notifier_register(adap->notifier, adap, cec_cec_notify);
 198 }
 199 EXPORT_SYMBOL_GPL(cec_register_cec_notifier);
 200 #endif
 201
 202 #ifdef CONFIG_DEBUG_FS
 203 static ssize_t cec_error_inj_write(struct file *file,
 204         const char __user *ubuf, size_t count, loff_t *ppos)
 205 {
 206         struct seq_file *sf = file->private_data;
 207         struct cec_adapter *adap = sf->private;
 208         char *buf;
 209         char *line;
 210         char *p;
 211
 212         buf = memdup_user_nul(ubuf, min_t(size_t, PAGE_SIZE, count));
 213         if (IS_ERR(buf))
 214                 return PTR_ERR(buf);
 215         p = buf;
 216         while (p && *p) {
 217                 p = skip_spaces(p);
 218                 line = strsep(&p, "\n");
 219                 if (!*line || *line == '#')
 220                         continue;
 221                 if (!adap->ops->error_inj_parse_line(adap, line)) {
 222                         kfree(buf);
 223                         return -EINVAL;
 224                 }
 225         }
 226         kfree(buf);
 227         return count;
 228 }
 229
 230 static int cec_error_inj_show(struct seq_file *sf, void *unused)
 231 {
 232         struct cec_adapter *adap = sf->private;
 233
 234         return adap->ops->error_inj_show(adap, sf);
 235 }
 236
 237 static int cec_error_inj_open(struct inode *inode, struct file *file)
 238 {
 239         return single_open(file, cec_error_inj_show, inode->i_private);
 240 }
 241
 242 static const struct file_operations cec_error_inj_fops = {
 243         .open = cec_error_inj_open,
 244         .write = cec_error_inj_write,
 245         .read = seq_read,
 246         .llseek = seq_lseek,
 247         .release = single_release,
 248 };
 249 #endif
 250
 251 struct cec_adapter *cec_allocate_adapter(const struct cec_adap_ops *ops,
 252                                          void *priv, const char *name, u32 caps,
 253                                          u8 available_las)
 254 {
 255         struct cec_adapter *adap;
 256         int res;
 257
 258 #ifndef CONFIG_MEDIA_CEC_RC
 259         caps &= ~CEC_CAP_RC;
 260 #endif
 261
 262         if (WARN_ON(!caps))
 263                 return ERR_PTR(-EINVAL);
 264         if (WARN_ON(!ops))
 265                 return ERR_PTR(-EINVAL);
 266         if (WARN_ON(!available_las || available_las > CEC_MAX_LOG_ADDRS))
 267                 return ERR_PTR(-EINVAL);
 268         adap = kzalloc(sizeof(*adap), GFP_KERNEL);
 269         if (!adap)
 270                 return ERR_PTR(-ENOMEM);
 271         strscpy(adap->name, name, sizeof(adap->name));
 272         adap->phys_addr = CEC_PHYS_ADDR_INVALID;
 273         adap->cec_pin_is_high = true;
 274         adap->log_addrs.cec_version = CEC_OP_CEC_VERSION_2_0;
 275         adap->log_addrs.vendor_id = CEC_VENDOR_ID_NONE;
 276         adap->capabilities = caps;
 277         if (debug_phys_addr)
 278                 adap->capabilities |= CEC_CAP_PHYS_ADDR;
 279         adap->needs_hpd = caps & CEC_CAP_NEEDS_HPD;
 280         adap->available_log_addrs = available_las;
 281         adap->sequence = 0;
 282         adap->ops = ops;
 283         adap->priv = priv;
 284         memset(adap->phys_addrs, 0xff, sizeof(adap->phys_addrs));
 285         mutex_init(&adap->lock);
 286         INIT_LIST_HEAD(&adap->transmit_queue);
 287         INIT_LIST_HEAD(&adap->wait_queue);
 288         init_waitqueue_head(&adap->kthread_waitq);
 289
 290         /* adap->devnode initialization */
 291         INIT_LIST_HEAD(&adap->devnode.fhs);
 292         mutex_init(&adap->devnode.lock);
 293
 294         adap->kthread = kthread_run(cec_thread_func, adap, "cec-%s", name);
 295         if (IS_ERR(adap->kthread)) {
 296                 pr_err("cec-%s: kernel_thread() failed\n", name);
 297                 res = PTR_ERR(adap->kthread);
 298                 kfree(adap);
 299                 return ERR_PTR(res);
 300         }
 301
 302 #ifdef CONFIG_MEDIA_CEC_RC
 303         if (!(caps & CEC_CAP_RC))
 304                 return adap;
 305
 306         /* Prepare the RC input device */
 307         adap->rc = rc_allocate_device(RC_DRIVER_SCANCODE);
 308         if (!adap->rc) {
 309                 pr_err("cec-%s: failed to allocate memory for rc_dev\n",
 310                        name);
 311                 kthread_stop(adap->kthread);
 312                 kfree(adap);
 313                 return ERR_PTR(-ENOMEM);
 314         }
 315
 316         snprintf(adap->input_phys, sizeof(adap->input_phys),
 317                  "%s/input0", adap->name);
 318
 319         adap->rc->device_name = adap->name;
 320         adap->rc->input_phys = adap->input_phys;
 321         adap->rc->input_id.bustype = BUS_CEC;
 322         adap->rc->input_id.vendor = 0;
 323         adap->rc->input_id.product = 0;
 324         adap->rc->input_id.version = 1;
 325         adap->rc->driver_name = CEC_NAME;
 326         adap->rc->allowed_protocols = RC_PROTO_BIT_CEC;
 327         adap->rc->priv = adap;
 328         adap->rc->map_name = RC_MAP_CEC;
 329         adap->rc->timeout = MS_TO_NS(550);
 330 #endif
 331         return adap;
 332 }
 333 EXPORT_SYMBOL_GPL(cec_allocate_adapter);
 334
 335 int cec_register_adapter(struct cec_adapter *adap,
 336                          struct device *parent)
 337 {
 338         int res;
 339
 340         if (IS_ERR_OR_NULL(adap))
 341                 return 0;
 342
 343         if (WARN_ON(!parent))
 344                 return -EINVAL;
 345
 346         adap->owner = parent->driver->owner;
 347         adap->devnode.dev.parent = parent;
 348
 349 #ifdef CONFIG_MEDIA_CEC_RC
 350         if (adap->capabilities & CEC_CAP_RC) {
 351                 adap->rc->dev.parent = parent;
 352                 res = rc_register_device(adap->rc);
 353
 354                 if (res) {
 355                         pr_err("cec-%s: failed to prepare input device\n",
 356                                adap->name);
 357                         rc_free_device(adap->rc);
 358                         adap->rc = NULL;
 359                         return res;
 360                 }
 361         }
 362 #endif
 363
 364         res = cec_devnode_register(&adap->devnode, adap->owner);
 365         if (res) {
 366 #ifdef CONFIG_MEDIA_CEC_RC
 367                 /* Note: rc_unregister also calls rc_free */
 368                 rc_unregister_device(adap->rc);
 369                 adap->rc = NULL;
 370 #endif
 371                 return res;
 372         }
 373
 374         dev_set_drvdata(&adap->devnode.dev, adap);
 375 #ifdef CONFIG_DEBUG_FS
 376         if (!top_cec_dir)
 377                 return 0;
 378
 379         adap->cec_dir = debugfs_create_dir(dev_name(&adap->devnode.dev), top_cec_dir);
 380         if (IS_ERR_OR_NULL(adap->cec_dir)) {
 381                 pr_warn("cec-%s: Failed to create debugfs dir\n", adap->name);
 382                 return 0;
 383         }
 384         adap->status_file = debugfs_create_devm_seqfile(&adap->devnode.dev,
 385                 "status", adap->cec_dir, cec_adap_status);
 386         if (IS_ERR_OR_NULL(adap->status_file)) {
 387                 pr_warn("cec-%s: Failed to create status file\n", adap->name);
 388                 debugfs_remove_recursive(adap->cec_dir);
 389                 adap->cec_dir = NULL;
 390                 return 0;
 391         }
 392         if (!adap->ops->error_inj_show || !adap->ops->error_inj_parse_line)
 393                 return 0;
 394         adap->error_inj_file = debugfs_create_file("error-inj", 0644,
 395                                                    adap->cec_dir, adap,
 396                                                    &cec_error_inj_fops);
 397         if (IS_ERR_OR_NULL(adap->error_inj_file))
 398                 pr_warn("cec-%s: Failed to create error-inj file\n",
 399                         adap->name);
 400 #endif
 401         return 0;
 402 }
 403 EXPORT_SYMBOL_GPL(cec_register_adapter);
 404
 405 void cec_unregister_adapter(struct cec_adapter *adap)
 406 {
 407         if (IS_ERR_OR_NULL(adap))
 408                 return;
 409
 410 #ifdef CONFIG_MEDIA_CEC_RC
 411         /* Note: rc_unregister also calls rc_free */
 412         rc_unregister_device(adap->rc);
 413         adap->rc = NULL;
 414 #endif
 415         debugfs_remove_recursive(adap->cec_dir);
 416 #ifdef CONFIG_CEC_NOTIFIER
 417         if (adap->notifier)
 418                 cec_notifier_unregister(adap->notifier);
 419 #endif
 420         cec_devnode_unregister(adap);
 421 }
 422 EXPORT_SYMBOL_GPL(cec_unregister_adapter);
 423
 424 void cec_delete_adapter(struct cec_adapter *adap)
 425 {
 426         if (IS_ERR_OR_NULL(adap))
 427                 return;
 428         kthread_stop(adap->kthread);
 429         if (adap->kthread_config)
 430                 kthread_stop(adap->kthread_config);
 431         if (adap->ops->adap_free)
 432                 adap->ops->adap_free(adap);
 433 #ifdef CONFIG_MEDIA_CEC_RC
 434         rc_free_device(adap->rc);
 435 #endif
 436         kfree(adap);
 437 }
 438 EXPORT_SYMBOL_GPL(cec_delete_adapter);
 439
 440 /*
 441  *      Initialise cec for linux
 442  */
 443 static int __init cec_devnode_init(void)
 444 {
 445         int ret = alloc_chrdev_region(&cec_dev_t, 0, CEC_NUM_DEVICES, CEC_NAME);
 446
 447         if (ret < 0) {
 448                 pr_warn("cec: unable to allocate major\n");
 449                 return ret;
 450         }
 451
 452 #ifdef CONFIG_DEBUG_FS
 453         top_cec_dir = debugfs_create_dir("cec", NULL);
 454         if (IS_ERR_OR_NULL(top_cec_dir)) {
 455                 pr_warn("cec: Failed to create debugfs cec dir\n");
 456                 top_cec_dir = NULL;
 457         }
 458 #endif
 459
 460         ret = bus_register(&cec_bus_type);
 461         if (ret < 0) {
 462                 unregister_chrdev_region(cec_dev_t, CEC_NUM_DEVICES);
 463                 pr_warn("cec: bus_register failed\n");
 464                 return -EIO;
 465         }
 466
 467         return 0;
 468 }
 469
 470 static void __exit cec_devnode_exit(void)
 471 {
 472         debugfs_remove_recursive(top_cec_dir);
 473         bus_unregister(&cec_bus_type);
 474         unregister_chrdev_region(cec_dev_t, CEC_NUM_DEVICES);
 475 }
 476
 477 subsys_initcall(cec_devnode_init);
 478 module_exit(cec_devnode_exit)
 479
 480 MODULE_AUTHOR("Hans Verkuil <[email protected]>");
 481 MODULE_DESCRIPTION("Device node registration for cec drivers");
 482 MODULE_LICENSE("GPL");