drivers/rpmsg/rpmsg_char.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2022, STMicroelectronics
   4  * Copyright (c) 2016, Linaro Ltd.
   5  * Copyright (c) 2012, Michal Simek <monstr@monstr.eu>
   6  * Copyright (c) 2012, PetaLogix
   7  * Copyright (c) 2011, Texas Instruments, Inc.
   8  * Copyright (c) 2011, Google, Inc.
   9  *
  10  * Based on rpmsg performance statistics driver by Michal Simek, which in turn
  11  * was based on TI & Google OMX rpmsg driver.
  12  */
  13
  14 #define pr_fmt(fmt)     KBUILD_MODNAME ": " fmt
  15
  16 #include <linux/cdev.h>
  17 #include <linux/device.h>
  18 #include <linux/fs.h>
  19 #include <linux/idr.h>
  20 #include <linux/kernel.h>
  21 #include <linux/module.h>
  22 #include <linux/poll.h>
  23 #include <linux/rpmsg.h>
  24 #include <linux/skbuff.h>
  25 #include <linux/slab.h>
  26 #include <linux/uaccess.h>
  27 #include <uapi/linux/rpmsg.h>
  28
  29 #include "rpmsg_char.h"
  30 #include "rpmsg_internal.h"
  31
  32 #define RPMSG_DEV_MAX   (MINORMASK + 1)
  33
  34 static dev_t rpmsg_major;
  35
  36 static DEFINE_IDA(rpmsg_ept_ida);
  37 static DEFINE_IDA(rpmsg_minor_ida);
  38
  39 #define dev_to_eptdev(dev) container_of(dev, struct rpmsg_eptdev, dev)
  40 #define cdev_to_eptdev(i_cdev) container_of(i_cdev, struct rpmsg_eptdev, cdev)
  41
  42 /**
  43  * struct rpmsg_eptdev - endpoint device context
  44  * @dev:        endpoint device
  45  * @cdev:       cdev for the endpoint device
  46  * @rpdev:      underlaying rpmsg device
  47  * @chinfo:     info used to open the endpoint
  48  * @ept_lock:   synchronization of @ept modifications
  49  * @ept:        rpmsg endpoint reference, when open
  50  * @queue_lock: synchronization of @queue operations
  51  * @queue:      incoming message queue
  52  * @readq:      wait object for incoming queue
  53  */
  54 struct rpmsg_eptdev {
  55         struct device dev;
  56         struct cdev cdev;
  57
  58         struct rpmsg_device *rpdev;
  59         struct rpmsg_channel_info chinfo;
  60
  61         struct mutex ept_lock;
  62         struct rpmsg_endpoint *ept;
  63
  64         spinlock_t queue_lock;
  65         struct sk_buff_head queue;
  66         wait_queue_head_t readq;
  67 };
  68
  69 int rpmsg_chrdev_eptdev_destroy(struct device *dev, void *data)
  70 {
  71         struct rpmsg_eptdev *eptdev = dev_to_eptdev(dev);
  72
  73         mutex_lock(&eptdev->ept_lock);
  74         if (eptdev->ept) {
  75                 rpmsg_destroy_ept(eptdev->ept);
  76                 eptdev->ept = NULL;
  77         }
  78         mutex_unlock(&eptdev->ept_lock);
  79
  80         /* wake up any blocked readers */
  81         wake_up_interruptible(&eptdev->readq);
  82
  83         cdev_device_del(&eptdev->cdev, &eptdev->dev);
  84         put_device(&eptdev->dev);
  85
  86         return 0;
  87 }
  88 EXPORT_SYMBOL(rpmsg_chrdev_eptdev_destroy);
  89
  90 static int rpmsg_ept_cb(struct rpmsg_device *rpdev, void *buf, int len,
  91                         void *priv, u32 addr)
  92 {
  93         struct rpmsg_eptdev *eptdev = priv;
  94         struct sk_buff *skb;
  95
  96         skb = alloc_skb(len, GFP_ATOMIC);
  97         if (!skb)
  98                 return -ENOMEM;
  99
 100         skb_put_data(skb, buf, len);
 101
 102         spin_lock(&eptdev->queue_lock);
 103         skb_queue_tail(&eptdev->queue, skb);
 104         spin_unlock(&eptdev->queue_lock);
 105
 106         /* wake up any blocking processes, waiting for new data */
 107         wake_up_interruptible(&eptdev->readq);
 108
 109         return 0;
 110 }
 111
 112 static int rpmsg_eptdev_open(struct inode *inode, struct file *filp)
 113 {
 114         struct rpmsg_eptdev *eptdev = cdev_to_eptdev(inode->i_cdev);
 115         struct rpmsg_endpoint *ept;
 116         struct rpmsg_device *rpdev = eptdev->rpdev;
 117         struct device *dev = &eptdev->dev;
 118
 119         if (eptdev->ept)
 120                 return -EBUSY;
 121
 122         get_device(dev);
 123
 124         ept = rpmsg_create_ept(rpdev, rpmsg_ept_cb, eptdev, eptdev->chinfo);
 125         if (!ept) {
 126                 dev_err(dev, "failed to open %s\n", eptdev->chinfo.name);
 127                 put_device(dev);
 128                 return -EINVAL;
 129         }
 130
 131         eptdev->ept = ept;
 132         filp->private_data = eptdev;
 133
 134         return 0;
 135 }
 136
 137 static int rpmsg_eptdev_release(struct inode *inode, struct file *filp)
 138 {
 139         struct rpmsg_eptdev *eptdev = cdev_to_eptdev(inode->i_cdev);
 140         struct device *dev = &eptdev->dev;
 141
 142         /* Close the endpoint, if it's not already destroyed by the parent */
 143         mutex_lock(&eptdev->ept_lock);
 144         if (eptdev->ept) {
 145                 rpmsg_destroy_ept(eptdev->ept);
 146                 eptdev->ept = NULL;
 147         }
 148         mutex_unlock(&eptdev->ept_lock);
 149
 150         /* Discard all SKBs */
 151         skb_queue_purge(&eptdev->queue);
 152
 153         put_device(dev);
 154
 155         return 0;
 156 }
 157
 158 static ssize_t rpmsg_eptdev_read_iter(struct kiocb *iocb, struct iov_iter *to)
 159 {
 160         struct file *filp = iocb->ki_filp;
 161         struct rpmsg_eptdev *eptdev = filp->private_data;
 162         unsigned long flags;
 163         struct sk_buff *skb;
 164         int use;
 165
 166         if (!eptdev->ept)
 167                 return -EPIPE;
 168
 169         spin_lock_irqsave(&eptdev->queue_lock, flags);
 170
 171         /* Wait for data in the queue */
 172         if (skb_queue_empty(&eptdev->queue)) {
 173                 spin_unlock_irqrestore(&eptdev->queue_lock, flags);
 174
 175                 if (filp->f_flags & O_NONBLOCK)
 176                         return -EAGAIN;
 177
 178                 /* Wait until we get data or the endpoint goes away */
 179                 if (wait_event_interruptible(eptdev->readq,
 180                                              !skb_queue_empty(&eptdev->queue) ||
 181                                              !eptdev->ept))
 182                         return -ERESTARTSYS;
 183
 184                 /* We lost the endpoint while waiting */
 185                 if (!eptdev->ept)
 186                         return -EPIPE;
 187
 188                 spin_lock_irqsave(&eptdev->queue_lock, flags);
 189         }
 190
 191         skb = skb_dequeue(&eptdev->queue);
 192         spin_unlock_irqrestore(&eptdev->queue_lock, flags);
 193         if (!skb)
 194                 return -EFAULT;
 195
 196         use = min_t(size_t, iov_iter_count(to), skb->len);
 197         if (copy_to_iter(skb->data, use, to) != use)
 198                 use = -EFAULT;
 199
 200         kfree_skb(skb);
 201
 202         return use;
 203 }
 204
 205 static ssize_t rpmsg_eptdev_write_iter(struct kiocb *iocb,
 206                                        struct iov_iter *from)
 207 {
 208         struct file *filp = iocb->ki_filp;
 209         struct rpmsg_eptdev *eptdev = filp->private_data;
 210         size_t len = iov_iter_count(from);
 211         void *kbuf;
 212         int ret;
 213
 214         kbuf = kzalloc(len, GFP_KERNEL);
 215         if (!kbuf)
 216                 return -ENOMEM;
 217
 218         if (!copy_from_iter_full(kbuf, len, from)) {
 219                 ret = -EFAULT;
 220                 goto free_kbuf;
 221         }
 222
 223         if (mutex_lock_interruptible(&eptdev->ept_lock)) {
 224                 ret = -ERESTARTSYS;
 225                 goto free_kbuf;
 226         }
 227
 228         if (!eptdev->ept) {
 229                 ret = -EPIPE;
 230                 goto unlock_eptdev;
 231         }
 232
 233         if (filp->f_flags & O_NONBLOCK) {
 234                 ret = rpmsg_trysendto(eptdev->ept, kbuf, len, eptdev->chinfo.dst);
 235                 if (ret == -ENOMEM)
 236                         ret = -EAGAIN;
 237         } else {
 238                 ret = rpmsg_sendto(eptdev->ept, kbuf, len, eptdev->chinfo.dst);
 239         }
 240
 241 unlock_eptdev:
 242         mutex_unlock(&eptdev->ept_lock);
 243
 244 free_kbuf:
 245         kfree(kbuf);
 246         return ret < 0 ? ret : len;
 247 }
 248
 249 static __poll_t rpmsg_eptdev_poll(struct file *filp, poll_table *wait)
 250 {
 251         struct rpmsg_eptdev *eptdev = filp->private_data;
 252         __poll_t mask = 0;
 253
 254         if (!eptdev->ept)
 255                 return EPOLLERR;
 256
 257         poll_wait(filp, &eptdev->readq, wait);
 258
 259         if (!skb_queue_empty(&eptdev->queue))
 260                 mask |= EPOLLIN | EPOLLRDNORM;
 261
 262         mask |= rpmsg_poll(eptdev->ept, filp, wait);
 263
 264         return mask;
 265 }
 266
 267 static long rpmsg_eptdev_ioctl(struct file *fp, unsigned int cmd,
 268                                unsigned long arg)
 269 {
 270         struct rpmsg_eptdev *eptdev = fp->private_data;
 271
 272         if (cmd != RPMSG_DESTROY_EPT_IOCTL)
 273                 return -EINVAL;
 274
 275         return rpmsg_chrdev_eptdev_destroy(&eptdev->dev, NULL);
 276 }
 277
 278 static const struct file_operations rpmsg_eptdev_fops = {
 279         .owner = THIS_MODULE,
 280         .open = rpmsg_eptdev_open,
 281         .release = rpmsg_eptdev_release,
 282         .read_iter = rpmsg_eptdev_read_iter,
 283         .write_iter = rpmsg_eptdev_write_iter,
 284         .poll = rpmsg_eptdev_poll,
 285         .unlocked_ioctl = rpmsg_eptdev_ioctl,
 286         .compat_ioctl = compat_ptr_ioctl,
 287 };
 288
 289 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
 290                          char *buf)
 291 {
 292         struct rpmsg_eptdev *eptdev = dev_get_drvdata(dev);
 293
 294         return sprintf(buf, "%s\n", eptdev->chinfo.name);
 295 }
 296 static DEVICE_ATTR_RO(name);
 297
 298 static ssize_t src_show(struct device *dev, struct device_attribute *attr,
 299                          char *buf)
 300 {
 301         struct rpmsg_eptdev *eptdev = dev_get_drvdata(dev);
 302
 303         return sprintf(buf, "%d\n", eptdev->chinfo.src);
 304 }
 305 static DEVICE_ATTR_RO(src);
 306
 307 static ssize_t dst_show(struct device *dev, struct device_attribute *attr,
 308                          char *buf)
 309 {
 310         struct rpmsg_eptdev *eptdev = dev_get_drvdata(dev);
 311
 312         return sprintf(buf, "%d\n", eptdev->chinfo.dst);
 313 }
 314 static DEVICE_ATTR_RO(dst);
 315
 316 static struct attribute *rpmsg_eptdev_attrs[] = {
 317         &dev_attr_name.attr,
 318         &dev_attr_src.attr,
 319         &dev_attr_dst.attr,
 320         NULL
 321 };
 322 ATTRIBUTE_GROUPS(rpmsg_eptdev);
 323
 324 static void rpmsg_eptdev_release_device(struct device *dev)
 325 {
 326         struct rpmsg_eptdev *eptdev = dev_to_eptdev(dev);
 327
 328         ida_simple_remove(&rpmsg_ept_ida, dev->id);
 329         ida_simple_remove(&rpmsg_minor_ida, MINOR(eptdev->dev.devt));
 330         kfree(eptdev);
 331 }
 332
 333 static struct rpmsg_eptdev *rpmsg_chrdev_eptdev_alloc(struct rpmsg_device *rpdev,
 334                                                       struct device *parent)
 335 {
 336         struct rpmsg_eptdev *eptdev;
 337         struct device *dev;
 338
 339         eptdev = kzalloc(sizeof(*eptdev), GFP_KERNEL);
 340         if (!eptdev)
 341                 return ERR_PTR(-ENOMEM);
 342
 343         dev = &eptdev->dev;
 344         eptdev->rpdev = rpdev;
 345
 346         mutex_init(&eptdev->ept_lock);
 347         spin_lock_init(&eptdev->queue_lock);
 348         skb_queue_head_init(&eptdev->queue);
 349         init_waitqueue_head(&eptdev->readq);
 350
 351         device_initialize(dev);
 352         dev->class = rpmsg_class;
 353         dev->parent = parent;
 354         dev->groups = rpmsg_eptdev_groups;
 355         dev_set_drvdata(dev, eptdev);
 356
 357         cdev_init(&eptdev->cdev, &rpmsg_eptdev_fops);
 358         eptdev->cdev.owner = THIS_MODULE;
 359
 360         return eptdev;
 361 }
 362
 363 static int rpmsg_chrdev_eptdev_add(struct rpmsg_eptdev *eptdev, struct rpmsg_channel_info chinfo)
 364 {
 365         struct device *dev = &eptdev->dev;
 366         int ret;
 367
 368         eptdev->chinfo = chinfo;
 369
 370         ret = ida_simple_get(&rpmsg_minor_ida, 0, RPMSG_DEV_MAX, GFP_KERNEL);
 371         if (ret < 0)
 372                 goto free_eptdev;
 373         dev->devt = MKDEV(MAJOR(rpmsg_major), ret);
 374
 375         ret = ida_simple_get(&rpmsg_ept_ida, 0, 0, GFP_KERNEL);
 376         if (ret < 0)
 377                 goto free_minor_ida;
 378         dev->id = ret;
 379         dev_set_name(dev, "rpmsg%d", ret);
 380
 381         ret = cdev_device_add(&eptdev->cdev, &eptdev->dev);
 382         if (ret)
 383                 goto free_ept_ida;
 384
 385         /* We can now rely on the release function for cleanup */
 386         dev->release = rpmsg_eptdev_release_device;
 387
 388         return ret;
 389
 390 free_ept_ida:
 391         ida_simple_remove(&rpmsg_ept_ida, dev->id);
 392 free_minor_ida:
 393         ida_simple_remove(&rpmsg_minor_ida, MINOR(dev->devt));
 394 free_eptdev:
 395         put_device(dev);
 396         kfree(eptdev);
 397
 398         return ret;
 399 }
 400
 401 int rpmsg_chrdev_eptdev_create(struct rpmsg_device *rpdev, struct device *parent,
 402                                struct rpmsg_channel_info chinfo)
 403 {
 404         struct rpmsg_eptdev *eptdev;
 405         int ret;
 406
 407         eptdev = rpmsg_chrdev_eptdev_alloc(rpdev, parent);
 408         if (IS_ERR(eptdev))
 409                 return PTR_ERR(eptdev);
 410
 411         ret = rpmsg_chrdev_eptdev_add(eptdev, chinfo);
 412
 413         return ret;
 414 }
 415 EXPORT_SYMBOL(rpmsg_chrdev_eptdev_create);
 416
 417 static int rpmsg_chrdev_init(void)
 418 {
 419         int ret;
 420
 421         ret = alloc_chrdev_region(&rpmsg_major, 0, RPMSG_DEV_MAX, "rpmsg_char");
 422         if (ret < 0) {
 423                 pr_err("failed to allocate char dev region\n");
 424                 return ret;
 425         }
 426
 427         return 0;
 428 }
 429 postcore_initcall(rpmsg_chrdev_init);
 430
 431 static void rpmsg_chrdev_exit(void)
 432 {
 433         unregister_chrdev_region(rpmsg_major, RPMSG_DEV_MAX);
 434 }
 435 module_exit(rpmsg_chrdev_exit);
 436
 437 MODULE_ALIAS("rpmsg:rpmsg_chrdev");
 438 MODULE_LICENSE("GPL v2");