blob: 5bb3a2109ab729c260767455c17016876a2f5e1d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/char/misc.c
3 *
4 * Generic misc open routine by Johan Myreen
5 *
6 * Based on code from Linus
7 *
8 * Teemu Rantanen's Microsoft Busmouse support and Derrick Cole's
9 * changes incorporated into 0.97pl4
10 * by Peter Cervasio (pete%q106fm.uucp@wupost.wustl.edu) (08SEP92)
11 * See busmouse.c for particulars.
12 *
13 * Made things a lot mode modular - easy to compile in just one or two
14 * of the misc drivers, as they are now completely independent. Linus.
15 *
16 * Support for loadable modules. 8-Sep-95 Philip Blundell <pjb27@cam.ac.uk>
17 *
18 * Fixed a failing symbol register to free the device registration
19 * Alan Cox <alan@lxorguk.ukuu.org.uk> 21-Jan-96
20 *
21 * Dynamic minors and /proc/mice by Alessandro Rubini. 26-Mar-96
22 *
23 * Renamed to misc and miscdevice to be more accurate. Alan Cox 26-Mar-96
24 *
25 * Handling of mouse minor numbers for kerneld:
26 * Idea by Jacques Gelinas <jack@solucorp.qc.ca>,
27 * adapted by Bjorn Ekwall <bj0rn@blox.se>
28 * corrected by Alan Cox <alan@lxorguk.ukuu.org.uk>
29 *
30 * Changes for kmod (from kerneld):
31 * Cyrus Durgin <cider@speakeasy.org>
32 *
33 * Added devfs support. Richard Gooch <rgooch@atnf.csiro.au> 10-Jan-1998
34 */
35
36#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38#include <linux/fs.h>
39#include <linux/errno.h>
40#include <linux/miscdevice.h>
41#include <linux/kernel.h>
42#include <linux/major.h>
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -070043#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/proc_fs.h>
45#include <linux/seq_file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/stat.h>
47#include <linux/init.h>
48#include <linux/device.h>
49#include <linux/tty.h>
50#include <linux/kmod.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090051#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53/*
54 * Head entry for the doubly linked miscdevice list
55 */
56static LIST_HEAD(misc_list);
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -070057static DEFINE_MUTEX(misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59/*
60 * Assigned numbers, used for dynamic minors
61 */
62#define DYNAMIC_MINORS 64 /* like dynamic majors */
Thadeu Lima de Souza Cascardo1f2f38d2009-12-14 18:00:31 -080063static DECLARE_BITMAP(misc_minors, DYNAMIC_MINORS);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#ifdef CONFIG_PROC_FS
66static void *misc_seq_start(struct seq_file *seq, loff_t *pos)
67{
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -070068 mutex_lock(&misc_mtx);
Pavel Emelianov46c65b72007-07-15 23:39:53 -070069 return seq_list_start(&misc_list, *pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070}
71
72static void *misc_seq_next(struct seq_file *seq, void *v, loff_t *pos)
73{
Pavel Emelianov46c65b72007-07-15 23:39:53 -070074 return seq_list_next(v, &misc_list, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075}
76
77static void misc_seq_stop(struct seq_file *seq, void *v)
78{
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -070079 mutex_unlock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080}
81
82static int misc_seq_show(struct seq_file *seq, void *v)
83{
Pavel Emelianov46c65b72007-07-15 23:39:53 -070084 const struct miscdevice *p = list_entry(v, struct miscdevice, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86 seq_printf(seq, "%3i %s\n", p->minor, p->name ? p->name : "");
87 return 0;
88}
89
90
James Morris88e9d342009-09-22 16:43:43 -070091static const struct seq_operations misc_seq_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 .start = misc_seq_start,
93 .next = misc_seq_next,
94 .stop = misc_seq_stop,
95 .show = misc_seq_show,
96};
97
98static int misc_seq_open(struct inode *inode, struct file *file)
99{
100 return seq_open(file, &misc_seq_ops);
101}
102
Arjan van de Ven62322d22006-07-03 00:24:21 -0700103static const struct file_operations misc_proc_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 .owner = THIS_MODULE,
105 .open = misc_seq_open,
106 .read = seq_read,
107 .llseek = seq_lseek,
108 .release = seq_release,
109};
110#endif
111
112static int misc_open(struct inode * inode, struct file * file)
113{
114 int minor = iminor(inode);
115 struct miscdevice *c;
116 int err = -ENODEV;
Al Viroe84f9e52013-09-22 14:17:15 -0400117 const struct file_operations *new_fops = NULL;
Thomas Gleixner40b798e2009-10-10 15:35:43 +0000118
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700119 mutex_lock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121 list_for_each_entry(c, &misc_list, list) {
122 if (c->minor == minor) {
123 new_fops = fops_get(c->fops);
124 break;
125 }
126 }
127
128 if (!new_fops) {
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700129 mutex_unlock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 request_module("char-major-%d-%d", MISC_MAJOR, minor);
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700131 mutex_lock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133 list_for_each_entry(c, &misc_list, list) {
134 if (c->minor == minor) {
135 new_fops = fops_get(c->fops);
136 break;
137 }
138 }
139 if (!new_fops)
140 goto fail;
141 }
142
143 err = 0;
Al Viroe84f9e52013-09-22 14:17:15 -0400144 replace_fops(file, new_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 if (file->f_op->open) {
Samu Onkalofa1f68d2010-05-24 14:33:10 -0700146 file->private_data = c;
Al Viroe84f9e52013-09-22 14:17:15 -0400147 err = file->f_op->open(inode,file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149fail:
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700150 mutex_unlock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 return err;
152}
153
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800154static struct class *misc_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Arjan van de Ven62322d22006-07-03 00:24:21 -0700156static const struct file_operations misc_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 .owner = THIS_MODULE,
158 .open = misc_open,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200159 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160};
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162/**
163 * misc_register - register a miscellaneous device
164 * @misc: device structure
165 *
166 * Register a miscellaneous device with the kernel. If the minor
167 * number is set to %MISC_DYNAMIC_MINOR a minor number is assigned
168 * and placed in the minor field of the structure. For other cases
169 * the minor number requested is used.
170 *
171 * The structure passed is linked into the kernel and may not be
Martin Kepplinger03190c62015-03-23 13:59:46 +0100172 * destroyed until it has been unregistered. By default, an open()
173 * syscall to the device sets file->private_data to point to the
174 * structure. Drivers don't need open in fops for this.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 *
176 * A zero is returned on success and a negative errno code for
177 * failure.
178 */
179
180int misc_register(struct miscdevice * misc)
181{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 dev_t dev;
Greg Kroah-Hartman7c69ef72005-06-20 21:15:16 -0700183 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Neil Horman5d469ec2006-12-06 20:37:08 -0800185 INIT_LIST_HEAD(&misc->list);
186
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700187 mutex_lock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189 if (misc->minor == MISC_DYNAMIC_MINOR) {
Thadeu Lima de Souza Cascardo1f2f38d2009-12-14 18:00:31 -0800190 int i = find_first_zero_bit(misc_minors, DYNAMIC_MINORS);
191 if (i >= DYNAMIC_MINORS) {
Elad Wexler684116c2013-09-14 18:02:11 +0300192 err = -EBUSY;
193 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 }
Thadeu Lima de Souza Cascardo1f2f38d2009-12-14 18:00:31 -0800195 misc->minor = DYNAMIC_MINORS - i - 1;
196 set_bit(i, misc_minors);
Dae S. Kim3c94ce62013-02-27 17:05:14 -0800197 } else {
198 struct miscdevice *c;
199
200 list_for_each_entry(c, &misc_list, list) {
201 if (c->minor == misc->minor) {
Elad Wexler684116c2013-09-14 18:02:11 +0300202 err = -EBUSY;
203 goto out;
Dae S. Kim3c94ce62013-02-27 17:05:14 -0800204 }
205 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 }
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 dev = MKDEV(MISC_MAJOR, misc->minor);
209
Takashi Iwaibd735992015-02-02 15:44:54 +0100210 misc->this_device =
211 device_create_with_groups(misc_class, misc->parent, dev,
212 misc, misc->groups, "%s", misc->name);
Greg Kroah-Hartman94fbcde2006-07-27 16:16:04 -0700213 if (IS_ERR(misc->this_device)) {
Thadeu Lima de Souza Cascardo1f2f38d2009-12-14 18:00:31 -0800214 int i = DYNAMIC_MINORS - misc->minor - 1;
Thadeu Lima de Souza Cascardo4ae717d2009-12-14 18:00:30 -0800215 if (i < DYNAMIC_MINORS && i >= 0)
Thadeu Lima de Souza Cascardo1f2f38d2009-12-14 18:00:31 -0800216 clear_bit(i, misc_minors);
Greg Kroah-Hartman94fbcde2006-07-27 16:16:04 -0700217 err = PTR_ERR(misc->this_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 goto out;
219 }
220
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 /*
222 * Add it to the front, so that later devices can "override"
223 * earlier defaults
224 */
225 list_add(&misc->list, &misc_list);
226 out:
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700227 mutex_unlock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 return err;
229}
230
231/**
Rafael J. Wysockib844eba2008-03-23 20:28:24 +0100232 * misc_deregister - unregister a miscellaneous device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 * @misc: device to unregister
234 *
235 * Unregister a miscellaneous device that was previously
236 * successfully registered with misc_register(). Success
237 * is indicated by a zero return, a negative errno code
238 * indicates an error.
239 */
240
Rafael J. Wysockib844eba2008-03-23 20:28:24 +0100241int misc_deregister(struct miscdevice *misc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242{
Thadeu Lima de Souza Cascardo1f2f38d2009-12-14 18:00:31 -0800243 int i = DYNAMIC_MINORS - misc->minor - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Akinobu Mitab329bec2010-08-09 17:20:35 -0700245 if (WARN_ON(list_empty(&misc->list)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 return -EINVAL;
247
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700248 mutex_lock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 list_del(&misc->list);
Rafael J. Wysockib844eba2008-03-23 20:28:24 +0100250 device_destroy(misc_class, MKDEV(MISC_MAJOR, misc->minor));
Thadeu Lima de Souza Cascardo4ae717d2009-12-14 18:00:30 -0800251 if (i < DYNAMIC_MINORS && i >= 0)
Thadeu Lima de Souza Cascardo1f2f38d2009-12-14 18:00:31 -0800252 clear_bit(i, misc_minors);
Matthias Kaehlcke0e82d5b2007-05-08 00:32:08 -0700253 mutex_unlock(&misc_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 return 0;
255}
256
257EXPORT_SYMBOL(misc_register);
Rafael J. Wysockib844eba2008-03-23 20:28:24 +0100258EXPORT_SYMBOL(misc_deregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Al Viro2c9ede52011-07-23 20:24:48 -0400260static char *misc_devnode(struct device *dev, umode_t *mode)
Kay Sieversd4056402009-04-30 15:23:42 +0200261{
262 struct miscdevice *c = dev_get_drvdata(dev);
263
Kay Sieverse454cea2009-09-18 23:01:12 +0200264 if (mode && c->mode)
265 *mode = c->mode;
266 if (c->nodename)
267 return kstrdup(c->nodename, GFP_KERNEL);
Kay Sieversd4056402009-04-30 15:23:42 +0200268 return NULL;
269}
270
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271static int __init misc_init(void)
272{
Denis V. Lunev1b502212008-04-29 01:02:34 -0700273 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Denis V. Lunev1b502212008-04-29 01:02:34 -0700275#ifdef CONFIG_PROC_FS
276 proc_create("misc", 0, NULL, &misc_proc_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277#endif
gregkh@suse.deca8eca62005-03-23 09:53:09 -0800278 misc_class = class_create(THIS_MODULE, "misc");
Denis V. Lunev1b502212008-04-29 01:02:34 -0700279 err = PTR_ERR(misc_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 if (IS_ERR(misc_class))
Denis V. Lunev1b502212008-04-29 01:02:34 -0700281 goto fail_remove;
Christoph Hellwig573fc112005-09-06 15:16:58 -0700282
Denis V. Lunev1b502212008-04-29 01:02:34 -0700283 err = -EIO;
284 if (register_chrdev(MISC_MAJOR,"misc",&misc_fops))
285 goto fail_printk;
Kay Sieverse454cea2009-09-18 23:01:12 +0200286 misc_class->devnode = misc_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 return 0;
Denis V. Lunev1b502212008-04-29 01:02:34 -0700288
289fail_printk:
290 printk("unable to get major %d for misc devices\n", MISC_MAJOR);
291 class_destroy(misc_class);
292fail_remove:
293 remove_proc_entry("misc", NULL);
294 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295}
296subsys_initcall(misc_init);