drivers/rpmsg/rpmsg_char.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2016, Linaro Ltd.
   4  * Copyright (c) 2012, Michal Simek <monstr@monstr.eu>
   5  * Copyright (c) 2012, PetaLogix
   6  * Copyright (c) 2011, Texas Instruments, Inc.
   7  * Copyright (c) 2011, Google, Inc.
   8  *
   9  * Based on rpmsg performance statistics driver by Michal Simek, which in turn
  10  * was based on TI & Google OMX rpmsg driver.
  11  */
  12 #include <linux/cdev.h>
  13 #include <linux/device.h>
  14 #include <linux/fs.h>
  15 #include <linux/idr.h>
  16 #include <linux/kernel.h>
  17 #include <linux/module.h>
  18 #include <linux/poll.h>
  19 #include <linux/rpmsg.h>
  20 #include <linux/skbuff.h>
  21 #include <linux/slab.h>
  22 #include <linux/uaccess.h>
  23 #include <uapi/linux/rpmsg.h>
  24
  25 #include "rpmsg_internal.h"
  26
  27 #define RPMSG_DEV_MAX   (MINORMASK + 1)
  28
  29 static dev_t rpmsg_major;
  30 static struct class *rpmsg_class;
  31
  32 static DEFINE_IDA(rpmsg_ctrl_ida);
  33 static DEFINE_IDA(rpmsg_ept_ida);
  34 static DEFINE_IDA(rpmsg_minor_ida);
  35
  36 #define dev_to_eptdev(dev) container_of(dev, struct rpmsg_eptdev, dev)
  37 #define cdev_to_eptdev(i_cdev) container_of(i_cdev, struct rpmsg_eptdev, cdev)
  38
  39 #define dev_to_ctrldev(dev) container_of(dev, struct rpmsg_ctrldev, dev)
  40 #define cdev_to_ctrldev(i_cdev) container_of(i_cdev, struct rpmsg_ctrldev, cdev)
  41
  42 /**
  43  * struct rpmsg_ctrldev - control device for instantiating endpoint devices
  44  * @rpdev:      underlaying rpmsg device
  45  * @cdev:       cdev for the ctrl device
  46  * @dev:        device for the ctrl device
  47  */
  48 struct rpmsg_ctrldev {
  49         struct rpmsg_device *rpdev;
  50         struct cdev cdev;
  51         struct device dev;
  52 };
  53
  54 /**
  55  * struct rpmsg_eptdev - endpoint device context
  56  * @dev:        endpoint device
  57  * @cdev:       cdev for the endpoint device
  58  * @rpdev:      underlaying rpmsg device
  59  * @chinfo:     info used to open the endpoint
  60  * @ept_lock:   synchronization of @ept modifications
  61  * @ept:        rpmsg endpoint reference, when open
  62  * @queue_lock: synchronization of @queue operations
  63  * @queue:      incoming message queue
  64  * @readq:      wait object for incoming queue
  65  */
  66 struct rpmsg_eptdev {
  67         struct device dev;
  68         struct cdev cdev;
  69
  70         struct rpmsg_device *rpdev;
  71         struct rpmsg_channel_info chinfo;
  72
  73         struct mutex ept_lock;
  74         struct rpmsg_endpoint *ept;
  75
  76         spinlock_t queue_lock;
  77         struct sk_buff_head queue;
  78         wait_queue_head_t readq;
  79 };
  80
  81 static int rpmsg_eptdev_destroy(struct device *dev, void *data)
  82 {
  83         struct rpmsg_eptdev *eptdev = dev_to_eptdev(dev);
  84
  85         mutex_lock(&eptdev->ept_lock);
  86         if (eptdev->ept) {
  87                 rpmsg_destroy_ept(eptdev->ept);
  88                 eptdev->ept = NULL;
  89         }
  90         mutex_unlock(&eptdev->ept_lock);
  91
  92         /* wake up any blocked readers */
  93         wake_up_interruptible(&eptdev->readq);
  94
  95         cdev_device_del(&eptdev->cdev, &eptdev->dev);
  96         put_device(&eptdev->dev);
  97
  98         return 0;
  99 }
 100
 101 static int rpmsg_ept_cb(struct rpmsg_device *rpdev, void *buf, int len,
 102                         void *priv, u32 addr)
 103 {
 104         struct rpmsg_eptdev *eptdev = priv;
 105         struct sk_buff *skb;
 106
 107         skb = alloc_skb(len, GFP_ATOMIC);
 108         if (!skb)
 109                 return -ENOMEM;
 110
 111         skb_put_data(skb, buf, len);
 112
 113         spin_lock(&eptdev->queue_lock);
 114         skb_queue_tail(&eptdev->queue, skb);
 115         spin_unlock(&eptdev->queue_lock);
 116
 117         /* wake up any blocking processes, waiting for new data */
 118         wake_up_interruptible(&eptdev->readq);
 119
 120         return 0;
 121 }
 122
 123 static int rpmsg_eptdev_open(struct inode *inode, struct file *filp)
 124 {
 125         struct rpmsg_eptdev *eptdev = cdev_to_eptdev(inode->i_cdev);
 126         struct rpmsg_endpoint *ept;
 127         struct rpmsg_device *rpdev = eptdev->rpdev;
 128         struct device *dev = &eptdev->dev;
 129
 130         mutex_lock(&eptdev->ept_lock);
 131         if (eptdev->ept) {
 132                 mutex_unlock(&eptdev->ept_lock);
 133                 return -EBUSY;
 134         }
 135
 136         get_device(dev);
 137
 138         ept = rpmsg_create_ept(rpdev, rpmsg_ept_cb, eptdev, eptdev->chinfo);
 139         if (!ept) {
 140                 dev_err(dev, "failed to open %s\n", eptdev->chinfo.name);
 141                 put_device(dev);
 142                 mutex_unlock(&eptdev->ept_lock);
 143                 return -EINVAL;
 144         }
 145
 146         eptdev->ept = ept;
 147         filp->private_data = eptdev;
 148         mutex_unlock(&eptdev->ept_lock);
 149
 150         return 0;
 151 }
 152
 153 static int rpmsg_eptdev_release(struct inode *inode, struct file *filp)
 154 {
 155         struct rpmsg_eptdev *eptdev = cdev_to_eptdev(inode->i_cdev);
 156         struct device *dev = &eptdev->dev;
 157
 158         /* Close the endpoint, if it's not already destroyed by the parent */
 159         mutex_lock(&eptdev->ept_lock);
 160         if (eptdev->ept) {
 161                 rpmsg_destroy_ept(eptdev->ept);
 162                 eptdev->ept = NULL;
 163         }
 164         mutex_unlock(&eptdev->ept_lock);
 165
 166         /* Discard all SKBs */
 167         skb_queue_purge(&eptdev->queue);
 168
 169         put_device(dev);
 170
 171         return 0;
 172 }
 173
 174 static ssize_t rpmsg_eptdev_read_iter(struct kiocb *iocb, struct iov_iter *to)
 175 {
 176         struct file *filp = iocb->ki_filp;
 177         struct rpmsg_eptdev *eptdev = filp->private_data;
 178         unsigned long flags;
 179         struct sk_buff *skb;
 180         int use;
 181
 182         if (!eptdev->ept)
 183                 return -EPIPE;
 184
 185         spin_lock_irqsave(&eptdev->queue_lock, flags);
 186
 187         /* Wait for data in the queue */
 188         if (skb_queue_empty(&eptdev->queue)) {
 189                 spin_unlock_irqrestore(&eptdev->queue_lock, flags);
 190
 191                 if (filp->f_flags & O_NONBLOCK)
 192                         return -EAGAIN;
 193
 194                 /* Wait until we get data or the endpoint goes away */
 195                 if (wait_event_interruptible(eptdev->readq,
 196                                              !skb_queue_empty(&eptdev->queue) ||
 197                                              !eptdev->ept))
 198                         return -ERESTARTSYS;
 199
 200                 /* We lost the endpoint while waiting */
 201                 if (!eptdev->ept)
 202                         return -EPIPE;
 203
 204                 spin_lock_irqsave(&eptdev->queue_lock, flags);
 205         }
 206
 207         skb = skb_dequeue(&eptdev->queue);
 208         spin_unlock_irqrestore(&eptdev->queue_lock, flags);
 209         if (!skb)
 210                 return -EFAULT;
 211
 212         use = min_t(size_t, iov_iter_count(to), skb->len);
 213         if (copy_to_iter(skb->data, use, to) != use)
 214                 use = -EFAULT;
 215
 216         kfree_skb(skb);
 217
 218         return use;
 219 }
 220
 221 static ssize_t rpmsg_eptdev_write_iter(struct kiocb *iocb,
 222                                        struct iov_iter *from)
 223 {
 224         struct file *filp = iocb->ki_filp;
 225         struct rpmsg_eptdev *eptdev = filp->private_data;
 226         size_t len = iov_iter_count(from);
 227         void *kbuf;
 228         int ret;
 229
 230         kbuf = kzalloc(len, GFP_KERNEL);
 231         if (!kbuf)
 232                 return -ENOMEM;
 233
 234         if (!copy_from_iter_full(kbuf, len, from)) {
 235                 ret = -EFAULT;
 236                 goto free_kbuf;
 237         }
 238
 239         if (mutex_lock_interruptible(&eptdev->ept_lock)) {
 240                 ret = -ERESTARTSYS;
 241                 goto free_kbuf;
 242         }
 243
 244         if (!eptdev->ept) {
 245                 ret = -EPIPE;
 246                 goto unlock_eptdev;
 247         }
 248
 249         if (filp->f_flags & O_NONBLOCK)
 250                 ret = rpmsg_trysendto(eptdev->ept, kbuf, len, eptdev->chinfo.dst);
 251         else
 252                 ret = rpmsg_sendto(eptdev->ept, kbuf, len, eptdev->chinfo.dst);
 253
 254 unlock_eptdev:
 255         mutex_unlock(&eptdev->ept_lock);
 256
 257 free_kbuf:
 258         kfree(kbuf);
 259         return ret < 0 ? ret : len;
 260 }
 261
 262 static __poll_t rpmsg_eptdev_poll(struct file *filp, poll_table *wait)
 263 {
 264         struct rpmsg_eptdev *eptdev = filp->private_data;
 265         __poll_t mask = 0;
 266
 267         if (!eptdev->ept)
 268                 return EPOLLERR;
 269
 270         poll_wait(filp, &eptdev->readq, wait);
 271
 272         if (!skb_queue_empty(&eptdev->queue))
 273                 mask |= EPOLLIN | EPOLLRDNORM;
 274
 275         mask |= rpmsg_poll(eptdev->ept, filp, wait);
 276
 277         return mask;
 278 }
 279
 280 static long rpmsg_eptdev_ioctl(struct file *fp, unsigned int cmd,
 281                                unsigned long arg)
 282 {
 283         struct rpmsg_eptdev *eptdev = fp->private_data;
 284
 285         if (cmd != RPMSG_DESTROY_EPT_IOCTL)
 286                 return -EINVAL;
 287
 288         return rpmsg_eptdev_destroy(&eptdev->dev, NULL);
 289 }
 290
 291 static const struct file_operations rpmsg_eptdev_fops = {
 292         .owner = THIS_MODULE,
 293         .open = rpmsg_eptdev_open,
 294         .release = rpmsg_eptdev_release,
 295         .read_iter = rpmsg_eptdev_read_iter,
 296         .write_iter = rpmsg_eptdev_write_iter,
 297         .poll = rpmsg_eptdev_poll,
 298         .unlocked_ioctl = rpmsg_eptdev_ioctl,
 299         .compat_ioctl = compat_ptr_ioctl,
 300 };
 301
 302 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
 303                          char *buf)
 304 {
 305         struct rpmsg_eptdev *eptdev = dev_get_drvdata(dev);
 306
 307         return sprintf(buf, "%s\n", eptdev->chinfo.name);
 308 }
 309 static DEVICE_ATTR_RO(name);
 310
 311 static ssize_t src_show(struct device *dev, struct device_attribute *attr,
 312                          char *buf)
 313 {
 314         struct rpmsg_eptdev *eptdev = dev_get_drvdata(dev);
 315
 316         return sprintf(buf, "%d\n", eptdev->chinfo.src);
 317 }
 318 static DEVICE_ATTR_RO(src);
 319
 320 static ssize_t dst_show(struct device *dev, struct device_attribute *attr,
 321                          char *buf)
 322 {
 323         struct rpmsg_eptdev *eptdev = dev_get_drvdata(dev);
 324
 325         return sprintf(buf, "%d\n", eptdev->chinfo.dst);
 326 }
 327 static DEVICE_ATTR_RO(dst);
 328
 329 static struct attribute *rpmsg_eptdev_attrs[] = {
 330         &dev_attr_name.attr,
 331         &dev_attr_src.attr,
 332         &dev_attr_dst.attr,
 333         NULL
 334 };
 335 ATTRIBUTE_GROUPS(rpmsg_eptdev);
 336
 337 static void rpmsg_eptdev_release_device(struct device *dev)
 338 {
 339         struct rpmsg_eptdev *eptdev = dev_to_eptdev(dev);
 340
 341         ida_simple_remove(&rpmsg_ept_ida, dev->id);
 342         ida_simple_remove(&rpmsg_minor_ida, MINOR(eptdev->dev.devt));
 343         kfree(eptdev);
 344 }
 345
 346 static int rpmsg_eptdev_create(struct rpmsg_ctrldev *ctrldev,
 347                                struct rpmsg_channel_info chinfo)
 348 {
 349         struct rpmsg_device *rpdev = ctrldev->rpdev;
 350         struct rpmsg_eptdev *eptdev;
 351         struct device *dev;
 352         int ret;
 353
 354         eptdev = kzalloc(sizeof(*eptdev), GFP_KERNEL);
 355         if (!eptdev)
 356                 return -ENOMEM;
 357
 358         dev = &eptdev->dev;
 359         eptdev->rpdev = rpdev;
 360         eptdev->chinfo = chinfo;
 361
 362         mutex_init(&eptdev->ept_lock);
 363         spin_lock_init(&eptdev->queue_lock);
 364         skb_queue_head_init(&eptdev->queue);
 365         init_waitqueue_head(&eptdev->readq);
 366
 367         device_initialize(dev);
 368         dev->class = rpmsg_class;
 369         dev->parent = &ctrldev->dev;
 370         dev->groups = rpmsg_eptdev_groups;
 371         dev_set_drvdata(dev, eptdev);
 372
 373         cdev_init(&eptdev->cdev, &rpmsg_eptdev_fops);
 374         eptdev->cdev.owner = THIS_MODULE;
 375
 376         ret = ida_simple_get(&rpmsg_minor_ida, 0, RPMSG_DEV_MAX, GFP_KERNEL);
 377         if (ret < 0)
 378                 goto free_eptdev;
 379         dev->devt = MKDEV(MAJOR(rpmsg_major), ret);
 380
 381         ret = ida_simple_get(&rpmsg_ept_ida, 0, 0, GFP_KERNEL);
 382         if (ret < 0)
 383                 goto free_minor_ida;
 384         dev->id = ret;
 385         dev_set_name(dev, "rpmsg%d", ret);
 386
 387         ret = cdev_device_add(&eptdev->cdev, &eptdev->dev);
 388         if (ret)
 389                 goto free_ept_ida;
 390
 391         /* We can now rely on the release function for cleanup */
 392         dev->release = rpmsg_eptdev_release_device;
 393
 394         return ret;
 395
 396 free_ept_ida:
 397         ida_simple_remove(&rpmsg_ept_ida, dev->id);
 398 free_minor_ida:
 399         ida_simple_remove(&rpmsg_minor_ida, MINOR(dev->devt));
 400 free_eptdev:
 401         put_device(dev);
 402         kfree(eptdev);
 403
 404         return ret;
 405 }
 406
 407 static int rpmsg_ctrldev_open(struct inode *inode, struct file *filp)
 408 {
 409         struct rpmsg_ctrldev *ctrldev = cdev_to_ctrldev(inode->i_cdev);
 410
 411         get_device(&ctrldev->dev);
 412         filp->private_data = ctrldev;
 413
 414         return 0;
 415 }
 416
 417 static int rpmsg_ctrldev_release(struct inode *inode, struct file *filp)
 418 {
 419         struct rpmsg_ctrldev *ctrldev = cdev_to_ctrldev(inode->i_cdev);
 420
 421         put_device(&ctrldev->dev);
 422
 423         return 0;
 424 }
 425
 426 static long rpmsg_ctrldev_ioctl(struct file *fp, unsigned int cmd,
 427                                 unsigned long arg)
 428 {
 429         struct rpmsg_ctrldev *ctrldev = fp->private_data;
 430         void __user *argp = (void __user *)arg;
 431         struct rpmsg_endpoint_info eptinfo;
 432         struct rpmsg_channel_info chinfo;
 433
 434         if (cmd != RPMSG_CREATE_EPT_IOCTL)
 435                 return -EINVAL;
 436
 437         if (copy_from_user(&eptinfo, argp, sizeof(eptinfo)))
 438                 return -EFAULT;
 439
 440         memcpy(chinfo.name, eptinfo.name, RPMSG_NAME_SIZE);
 441         chinfo.name[RPMSG_NAME_SIZE-1] = '\0';
 442         chinfo.src = eptinfo.src;
 443         chinfo.dst = eptinfo.dst;
 444
 445         return rpmsg_eptdev_create(ctrldev, chinfo);
 446 };
 447
 448 static const struct file_operations rpmsg_ctrldev_fops = {
 449         .owner = THIS_MODULE,
 450         .open = rpmsg_ctrldev_open,
 451         .release = rpmsg_ctrldev_release,
 452         .unlocked_ioctl = rpmsg_ctrldev_ioctl,
 453         .compat_ioctl = compat_ptr_ioctl,
 454 };
 455
 456 static void rpmsg_ctrldev_release_device(struct device *dev)
 457 {
 458         struct rpmsg_ctrldev *ctrldev = dev_to_ctrldev(dev);
 459
 460         ida_simple_remove(&rpmsg_ctrl_ida, dev->id);
 461         ida_simple_remove(&rpmsg_minor_ida, MINOR(dev->devt));
 462         kfree(ctrldev);
 463 }
 464
 465 static int rpmsg_chrdev_probe(struct rpmsg_device *rpdev)
 466 {
 467         struct rpmsg_ctrldev *ctrldev;
 468         struct device *dev;
 469         int ret;
 470
 471         ctrldev = kzalloc(sizeof(*ctrldev), GFP_KERNEL);
 472         if (!ctrldev)
 473                 return -ENOMEM;
 474
 475         ctrldev->rpdev = rpdev;
 476
 477         dev = &ctrldev->dev;
 478         device_initialize(dev);
 479         dev->parent = &rpdev->dev;
 480         dev->class = rpmsg_class;
 481
 482         cdev_init(&ctrldev->cdev, &rpmsg_ctrldev_fops);
 483         ctrldev->cdev.owner = THIS_MODULE;
 484
 485         ret = ida_simple_get(&rpmsg_minor_ida, 0, RPMSG_DEV_MAX, GFP_KERNEL);
 486         if (ret < 0)
 487                 goto free_ctrldev;
 488         dev->devt = MKDEV(MAJOR(rpmsg_major), ret);
 489
 490         ret = ida_simple_get(&rpmsg_ctrl_ida, 0, 0, GFP_KERNEL);
 491         if (ret < 0)
 492                 goto free_minor_ida;
 493         dev->id = ret;
 494         dev_set_name(&ctrldev->dev, "rpmsg_ctrl%d", ret);
 495
 496         ret = cdev_device_add(&ctrldev->cdev, &ctrldev->dev);
 497         if (ret)
 498                 goto free_ctrl_ida;
 499
 500         /* We can now rely on the release function for cleanup */
 501         dev->release = rpmsg_ctrldev_release_device;
 502
 503         dev_set_drvdata(&rpdev->dev, ctrldev);
 504
 505         return ret;
 506
 507 free_ctrl_ida:
 508         ida_simple_remove(&rpmsg_ctrl_ida, dev->id);
 509 free_minor_ida:
 510         ida_simple_remove(&rpmsg_minor_ida, MINOR(dev->devt));
 511 free_ctrldev:
 512         put_device(dev);
 513         kfree(ctrldev);
 514
 515         return ret;
 516 }
 517
 518 static void rpmsg_chrdev_remove(struct rpmsg_device *rpdev)
 519 {
 520         struct rpmsg_ctrldev *ctrldev = dev_get_drvdata(&rpdev->dev);
 521         int ret;
 522
 523         /* Destroy all endpoints */
 524         ret = device_for_each_child(&ctrldev->dev, NULL, rpmsg_eptdev_destroy);
 525         if (ret)
 526                 dev_warn(&rpdev->dev, "failed to nuke endpoints: %d\n", ret);
 527
 528         cdev_device_del(&ctrldev->cdev, &ctrldev->dev);
 529         put_device(&ctrldev->dev);
 530 }
 531
 532 static struct rpmsg_driver rpmsg_chrdev_driver = {
 533         .probe = rpmsg_chrdev_probe,
 534         .remove = rpmsg_chrdev_remove,
 535         .drv = {
 536                 .name = "rpmsg_chrdev",
 537         },
 538 };
 539
 540 static int rpmsg_chrdev_init(void)
 541 {
 542         int ret;
 543
 544         ret = alloc_chrdev_region(&rpmsg_major, 0, RPMSG_DEV_MAX, "rpmsg");
 545         if (ret < 0) {
 546                 pr_err("rpmsg: failed to allocate char dev region\n");
 547                 return ret;
 548         }
 549
 550         rpmsg_class = class_create(THIS_MODULE, "rpmsg");
 551         if (IS_ERR(rpmsg_class)) {
 552                 pr_err("failed to create rpmsg class\n");
 553                 unregister_chrdev_region(rpmsg_major, RPMSG_DEV_MAX);
 554                 return PTR_ERR(rpmsg_class);
 555         }
 556
 557         ret = register_rpmsg_driver(&rpmsg_chrdev_driver);
 558         if (ret < 0) {
 559                 pr_err("rpmsgchr: failed to register rpmsg driver\n");
 560                 class_destroy(rpmsg_class);
 561                 unregister_chrdev_region(rpmsg_major, RPMSG_DEV_MAX);
 562         }
 563
 564         return ret;
 565 }
 566 postcore_initcall(rpmsg_chrdev_init);
 567
 568 static void rpmsg_chrdev_exit(void)
 569 {
 570         unregister_rpmsg_driver(&rpmsg_chrdev_driver);
 571         class_destroy(rpmsg_class);
 572         unregister_chrdev_region(rpmsg_major, RPMSG_DEV_MAX);
 573 }
 574 module_exit(rpmsg_chrdev_exit);
 575
 576 MODULE_ALIAS("rpmsg:rpmsg_chrdev");
 577 MODULE_LICENSE("GPL v2");