Use completion.
[cascardo/kernel/samples/char2/.git] / 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
29 MODULE_LICENSE("GPL");
30
31 #define MAXLEN 4096
32 static dev_t devnum;
33 static struct cdev *dev;
34 static const char default_greeting[] = "Hello, World!\n";
35
36 static struct circ_buf *hello;
37 static struct circ_buf hello_instance;
38 static DEFINE_MUTEX(hello_mtx);
39 static DECLARE_COMPLETION(hello_wait);
40
41 static int hello_open(struct inode *ino, struct file *fp)
42 {
43         return 0;
44 }
45
46 static ssize_t hello_read(struct file *fp, char __user *buf, size_t sz,
47         loff_t *pos)
48 {
49         int r;
50         size_t fsz;
51         size_t ssz;
52         size_t len;
53         if (mutex_lock_interruptible(&hello_mtx))
54                 return -ERESTARTSYS;
55         len = CIRC_CNT(hello->head, hello->tail, MAXLEN);
56         if (sz > len)
57                 sz = len;
58         /* First, copy at most until the limit of the buffer */
59         fsz = min(sz, CIRC_CNT_TO_END(hello->head, hello->tail, MAXLEN));
60         r = copy_to_user(buf, hello->buf + hello->tail, fsz);
61         ssz = sz - fsz;
62         if (!r && !ssz)
63                 r = copy_to_user(buf + fsz, hello->buf, ssz);
64         if (!r)
65                 hello->tail = (hello->tail + sz) & ~MAXLEN;
66         mutex_unlock(&hello_mtx);
67         if (r)
68                 return -EFAULT;
69         complete(&hello_wait);
70         return sz;
71 }
72
73 static ssize_t hello_write(struct file *fp, const char __user *buf, size_t sz,
74         loff_t *pos)
75 {
76         int r;
77         size_t fsz;
78         size_t ssz;
79         size_t len;
80         if (mutex_lock_interruptible(&hello_mtx))
81                 return -ERESTARTSYS;
82         len = CIRC_SPACE(hello->head, hello->tail, MAXLEN);
83         while (len == 0) {
84                 mutex_unlock(&hello_mtx);
85                 if (wait_for_completion_interruptible(&hello_wait))
86                         return -ERESTARTSYS;
87                 if (mutex_lock_interruptible(&hello_mtx))
88                         return -ERESTARTSYS;
89                 len = CIRC_SPACE(hello->head, hello->tail, MAXLEN);
90         }
91         if (sz > len)
92                 sz = len;
93         fsz = min(sz, CIRC_SPACE_TO_END(hello->head, hello->tail, MAXLEN));
94         r = copy_from_user(hello->buf + hello->head, buf, fsz);
95         ssz = sz - fsz;
96         if (!r && !ssz)
97                 r = copy_from_user(hello->buf, buf + fsz, ssz);
98         if (!r)
99                 hello->head = (hello->head + sz) & ~MAXLEN;
100         mutex_unlock(&hello_mtx);
101         if (r)
102                 return -EFAULT;
103         return sz;
104 }
105
106 static int hello_release(struct inode *ino, struct file *fp)
107 {
108         return 0;
109 }
110
111 static const struct file_operations hello_fops = {
112         .owner = THIS_MODULE,
113         .open = hello_open,
114         .release = hello_release,
115         .read = hello_read,
116         .write = hello_write,
117 };
118
119 static int __init ch_init(void)
120 {
121         int r = 0;
122         hello = &hello_instance;
123         hello->buf = kzalloc(sizeof(*hello) + MAXLEN, GFP_KERNEL);
124         if (!hello) {
125                 r = -ENOMEM;
126                 goto out;
127         }
128         memcpy(hello->buf, default_greeting, sizeof(default_greeting));
129         hello->head = sizeof(default_greeting);
130         r = alloc_chrdev_region(&devnum, 0, 256, "hello");
131         if (r)
132                 goto reg_out;
133         dev = cdev_alloc();
134         if (!dev) {
135                 r = -ENOMEM;
136                 goto cdev_out;
137         }
138         dev->ops = &hello_fops;
139         r = cdev_add(dev, devnum, 256);
140         if (r)
141                 goto add_out;
142         return 0;
143 add_out:
144         kfree(dev);
145 cdev_out:
146         unregister_chrdev_region(devnum, 256);
147 reg_out:
148         kfree(hello);
149 out:
150         return r;
151 }
152
153 static void __exit ch_exit(void)
154 {
155         cdev_del(dev);
156         unregister_chrdev_region(devnum, 256);
157         kfree(hello->buf);
158 }
159
160 module_init(ch_init);
161 module_exit(ch_exit);