hellochar.c

   1 /*
   2  *  Copyright (C) 2010  Thadeu Lima de Souza Cascardo <cascardo@holoscopio.com>
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2 of the License, or
   7  *  (at your option) any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License along
  15  *  with this program; if not, write to the Free Software Foundation, Inc.,
  16  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #include <linux/module.h>
  20 #include <linux/fs.h>
  21 #include <linux/cdev.h>
  22 #include <linux/slab.h>
  23 #include <linux/mutex.h>
  24 #include <asm/uaccess.h>
  25 #include <linux/circ_buf.h>
  26 #include <linux/sched.h>
  27 #include <linux/completion.h>
  28 #include <linux/device.h>
  29
  30 MODULE_LICENSE("GPL");
  31
  32 #define MAXLEN 4096
  33 static dev_t devnum;
  34 static struct cdev *dev;
  35 static const char default_greeting[] = "Hello, World!\n";
  36
  37 static struct circ_buf *hello;
  38 static struct circ_buf hello_instance;
  39 static DEFINE_MUTEX(hello_mtx);
  40 static DECLARE_COMPLETION(hello_wait);
  41
  42 static int hello_open(struct inode *ino, struct file *fp)
  43 {
  44         return 0;
  45 }
  46
  47 static ssize_t hello_read(struct file *fp, char __user *buf, size_t sz,
  48         loff_t *pos)
  49 {
  50         int r;
  51         size_t fsz;
  52         size_t ssz;
  53         size_t len;
  54         if (mutex_lock_interruptible(&hello_mtx))
  55                 return -ERESTARTSYS;
  56         len = CIRC_CNT(hello->head, hello->tail, MAXLEN);
  57         if (sz > len)
  58                 sz = len;
  59         /* First, copy at most until the limit of the buffer */
  60         fsz = min(sz, CIRC_CNT_TO_END(hello->head, hello->tail, MAXLEN));
  61         r = copy_to_user(buf, hello->buf + hello->tail, fsz);
  62         ssz = sz - fsz;
  63         if (!r && !ssz)
  64                 r = copy_to_user(buf + fsz, hello->buf, ssz);
  65         if (!r)
  66                 hello->tail = (hello->tail + sz) & ~MAXLEN;
  67         mutex_unlock(&hello_mtx);
  68         if (r)
  69                 return -EFAULT;
  70         complete(&hello_wait);
  71         return sz;
  72 }
  73
  74 static ssize_t hello_write(struct file *fp, const char __user *buf, size_t sz,
  75         loff_t *pos)
  76 {
  77         int r;
  78         size_t fsz;
  79         size_t ssz;
  80         size_t len;
  81         if (mutex_lock_interruptible(&hello_mtx))
  82                 return -ERESTARTSYS;
  83         len = CIRC_SPACE(hello->head, hello->tail, MAXLEN);
  84         while (len == 0) {
  85                 mutex_unlock(&hello_mtx);
  86                 if (wait_for_completion_interruptible(&hello_wait))
  87                         return -ERESTARTSYS;
  88                 if (mutex_lock_interruptible(&hello_mtx))
  89                         return -ERESTARTSYS;
  90                 len = CIRC_SPACE(hello->head, hello->tail, MAXLEN);
  91         }
  92         if (sz > len)
  93                 sz = len;
  94         fsz = min(sz, CIRC_SPACE_TO_END(hello->head, hello->tail, MAXLEN));
  95         r = copy_from_user(hello->buf + hello->head, buf, fsz);
  96         ssz = sz - fsz;
  97         if (!r && !ssz)
  98                 r = copy_from_user(hello->buf, buf + fsz, ssz);
  99         if (!r)
 100                 hello->head = (hello->head + sz) & ~MAXLEN;
 101         mutex_unlock(&hello_mtx);
 102         if (r)
 103                 return -EFAULT;
 104         return sz;
 105 }
 106
 107 static int hello_release(struct inode *ino, struct file *fp)
 108 {
 109         return 0;
 110 }
 111
 112 static const struct file_operations hello_fops = {
 113         .owner = THIS_MODULE,
 114         .open = hello_open,
 115         .release = hello_release,
 116         .read = hello_read,
 117         .write = hello_write,
 118 };
 119
 120 static ssize_t hello_len_show(struct device *dev, struct device_attribute *attr,
 121         char *buffer)
 122 {
 123         size_t len = CIRC_CNT(hello->head, hello->tail, MAXLEN);
 124         return sprintf(buffer, "%d\n", len);
 125 }
 126
 127 static const struct device_attribute hello_len_attr = {
 128         .attr = { .name = "len", .mode = 0444, },
 129         .show = hello_len_show,
 130 };
 131
 132 static struct class *hello_class;
 133 static struct device *hello_dev;
 134
 135 static int __init ch_init(void)
 136 {
 137         int r = 0;
 138         hello = &hello_instance;
 139         hello->buf = kzalloc(sizeof(*hello) + MAXLEN, GFP_KERNEL);
 140         if (!hello) {
 141                 r = -ENOMEM;
 142                 goto out;
 143         }
 144         hello_class = class_create(THIS_MODULE, "hello");
 145         if (IS_ERR(hello_class)) {
 146                 r = PTR_ERR(hello_class);
 147                 goto class_out;
 148         }
 149         memcpy(hello->buf, default_greeting, sizeof(default_greeting));
 150         hello->head = sizeof(default_greeting);
 151         r = alloc_chrdev_region(&devnum, 0, 256, "hello");
 152         if (r)
 153                 goto reg_out;
 154         hello_dev = device_create(hello_class, NULL, devnum, NULL, "hello");
 155         if (!hello_dev) {
 156                 r = -ENODEV;
 157                 goto dev_out;
 158         }
 159         r = device_create_file(hello_dev, &hello_len_attr);
 160         if (r)
 161                 goto file_out;
 162         dev = cdev_alloc();
 163         if (!dev) {
 164                 r = -ENOMEM;
 165                 goto cdev_out;
 166         }
 167         dev->ops = &hello_fops;
 168         r = cdev_add(dev, devnum, 256);
 169         if (r)
 170                 goto add_out;
 171         return 0;
 172 add_out:
 173         kfree(dev);
 174 cdev_out:
 175         device_remove_file(hello_dev, &hello_len_attr);
 176 file_out:
 177         device_destroy(hello_class, devnum);
 178 dev_out:
 179         unregister_chrdev_region(devnum, 256);
 180 reg_out:
 181         class_destroy(hello_class);
 182 class_out:
 183         kfree(hello);
 184 out:
 185         return r;
 186 }
 187
 188 static void __exit ch_exit(void)
 189 {
 190         cdev_del(dev);
 191         device_remove_file(hello_dev, &hello_len_attr);
 192         device_destroy(hello_class, devnum);
 193         unregister_chrdev_region(devnum, 256);
 194         kfree(hello->buf);
 195         class_destroy(hello_class);
 196 }
 197
 198 module_init(ch_init);
 199 module_exit(ch_exit);