4 * Copyright (C) 1991, 1992 Linus Torvalds
7 #include <linux/init.h>
9 #include <linux/kdev_t.h>
10 #include <linux/slab.h>
11 #include <linux/string.h>
13 #include <linux/major.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/seq_file.h>
18 #include <linux/kobject.h>
19 #include <linux/kobj_map.h>
20 #include <linux/cdev.h>
21 #include <linux/mutex.h>
22 #include <linux/backing-dev.h>
23 #include <linux/tty.h>
28 * capabilities for /dev/mem, /dev/kmem and similar directly mappable character
30 * - permits shared-mmap for read, write and/or exec
31 * - does not permit private mmap in NOMMU mode (can't do COW)
32 * - no readahead or I/O queue unplugging required
34 struct backing_dev_info directly_mappable_cdev_bdi
= {
38 /* permit private copies of the data to be taken */
41 /* permit direct mmap, for read, write or exec */
43 BDI_CAP_READ_MAP
| BDI_CAP_WRITE_MAP
| BDI_CAP_EXEC_MAP
),
46 static struct kobj_map
*cdev_map
;
48 static DEFINE_MUTEX(chrdevs_lock
);
50 static struct char_device_struct
{
51 struct char_device_struct
*next
;
53 unsigned int baseminor
;
56 struct cdev
*cdev
; /* will die */
57 } *chrdevs
[CHRDEV_MAJOR_HASH_SIZE
];
59 /* index in the above */
60 static inline int major_to_index(int major
)
62 return major
% CHRDEV_MAJOR_HASH_SIZE
;
67 void chrdev_show(struct seq_file
*f
, off_t offset
)
69 struct char_device_struct
*cd
;
71 if (offset
< CHRDEV_MAJOR_HASH_SIZE
) {
72 mutex_lock(&chrdevs_lock
);
73 for (cd
= chrdevs
[offset
]; cd
; cd
= cd
->next
)
74 seq_printf(f
, "%3d %s\n", cd
->major
, cd
->name
);
75 mutex_unlock(&chrdevs_lock
);
79 #endif /* CONFIG_PROC_FS */
82 * Register a single major with a specified minor range.
84 * If major == 0 this functions will dynamically allocate a major and return
87 * If major > 0 this function will attempt to reserve the passed range of
88 * minors and will return zero on success.
90 * Returns a -ve errno on failure.
92 static struct char_device_struct
*
93 __register_chrdev_region(unsigned int major
, unsigned int baseminor
,
94 int minorct
, const char *name
)
96 struct char_device_struct
*cd
, **cp
;
100 cd
= kzalloc(sizeof(struct char_device_struct
), GFP_KERNEL
);
102 return ERR_PTR(-ENOMEM
);
104 mutex_lock(&chrdevs_lock
);
108 for (i
= ARRAY_SIZE(chrdevs
)-1; i
> 0; i
--) {
109 if (chrdevs
[i
] == NULL
)
122 cd
->baseminor
= baseminor
;
123 cd
->minorct
= minorct
;
124 strlcpy(cd
->name
, name
, sizeof(cd
->name
));
126 i
= major_to_index(major
);
128 for (cp
= &chrdevs
[i
]; *cp
; cp
= &(*cp
)->next
)
129 if ((*cp
)->major
> major
||
130 ((*cp
)->major
== major
&&
131 (((*cp
)->baseminor
>= baseminor
) ||
132 ((*cp
)->baseminor
+ (*cp
)->minorct
> baseminor
))))
135 /* Check for overlapping minor ranges. */
136 if (*cp
&& (*cp
)->major
== major
) {
137 int old_min
= (*cp
)->baseminor
;
138 int old_max
= (*cp
)->baseminor
+ (*cp
)->minorct
- 1;
139 int new_min
= baseminor
;
140 int new_max
= baseminor
+ minorct
- 1;
142 /* New driver overlaps from the left. */
143 if (new_max
>= old_min
&& new_max
<= old_max
) {
148 /* New driver overlaps from the right. */
149 if (new_min
<= old_max
&& new_min
>= old_min
) {
157 mutex_unlock(&chrdevs_lock
);
160 mutex_unlock(&chrdevs_lock
);
165 static struct char_device_struct
*
166 __unregister_chrdev_region(unsigned major
, unsigned baseminor
, int minorct
)
168 struct char_device_struct
*cd
= NULL
, **cp
;
169 int i
= major_to_index(major
);
171 mutex_lock(&chrdevs_lock
);
172 for (cp
= &chrdevs
[i
]; *cp
; cp
= &(*cp
)->next
)
173 if ((*cp
)->major
== major
&&
174 (*cp
)->baseminor
== baseminor
&&
175 (*cp
)->minorct
== minorct
)
181 mutex_unlock(&chrdevs_lock
);
186 * register_chrdev_region() - register a range of device numbers
187 * @from: the first in the desired range of device numbers; must include
189 * @count: the number of consecutive device numbers required
190 * @name: the name of the device or driver.
192 * Return value is zero on success, a negative error code on failure.
194 int register_chrdev_region(dev_t from
, unsigned count
, const char *name
)
196 struct char_device_struct
*cd
;
197 dev_t to
= from
+ count
;
200 for (n
= from
; n
< to
; n
= next
) {
201 next
= MKDEV(MAJOR(n
)+1, 0);
204 cd
= __register_chrdev_region(MAJOR(n
), MINOR(n
),
212 for (n
= from
; n
< to
; n
= next
) {
213 next
= MKDEV(MAJOR(n
)+1, 0);
214 kfree(__unregister_chrdev_region(MAJOR(n
), MINOR(n
), next
- n
));
220 * alloc_chrdev_region() - register a range of char device numbers
221 * @dev: output parameter for first assigned number
222 * @baseminor: first of the requested range of minor numbers
223 * @count: the number of minor numbers required
224 * @name: the name of the associated device or driver
226 * Allocates a range of char device numbers. The major number will be
227 * chosen dynamically, and returned (along with the first minor number)
228 * in @dev. Returns zero or a negative error code.
230 int alloc_chrdev_region(dev_t
*dev
, unsigned baseminor
, unsigned count
,
233 struct char_device_struct
*cd
;
234 cd
= __register_chrdev_region(0, baseminor
, count
, name
);
237 *dev
= MKDEV(cd
->major
, cd
->baseminor
);
242 * __register_chrdev() - create and register a cdev occupying a range of minors
243 * @major: major device number or 0 for dynamic allocation
244 * @baseminor: first of the requested range of minor numbers
245 * @count: the number of minor numbers required
246 * @name: name of this range of devices
247 * @fops: file operations associated with this devices
249 * If @major == 0 this functions will dynamically allocate a major and return
252 * If @major > 0 this function will attempt to reserve a device with the given
253 * major number and will return zero on success.
255 * Returns a -ve errno on failure.
257 * The name of this device has nothing to do with the name of the device in
258 * /dev. It only helps to keep track of the different owners of devices. If
259 * your module name has only one type of devices it's ok to use e.g. the name
260 * of the module here.
262 int __register_chrdev(unsigned int major
, unsigned int baseminor
,
263 unsigned int count
, const char *name
,
264 const struct file_operations
*fops
)
266 struct char_device_struct
*cd
;
270 cd
= __register_chrdev_region(major
, baseminor
, count
, name
);
278 cdev
->owner
= fops
->owner
;
280 kobject_set_name(&cdev
->kobj
, "%s", name
);
282 err
= cdev_add(cdev
, MKDEV(cd
->major
, baseminor
), count
);
288 return major
? 0 : cd
->major
;
290 kobject_put(&cdev
->kobj
);
292 kfree(__unregister_chrdev_region(cd
->major
, baseminor
, count
));
297 * unregister_chrdev_region() - return a range of device numbers
298 * @from: the first in the range of numbers to unregister
299 * @count: the number of device numbers to unregister
301 * This function will unregister a range of @count device numbers,
302 * starting with @from. The caller should normally be the one who
303 * allocated those numbers in the first place...
305 void unregister_chrdev_region(dev_t from
, unsigned count
)
307 dev_t to
= from
+ count
;
310 for (n
= from
; n
< to
; n
= next
) {
311 next
= MKDEV(MAJOR(n
)+1, 0);
314 kfree(__unregister_chrdev_region(MAJOR(n
), MINOR(n
), next
- n
));
319 * __unregister_chrdev - unregister and destroy a cdev
320 * @major: major device number
321 * @baseminor: first of the range of minor numbers
322 * @count: the number of minor numbers this cdev is occupying
323 * @name: name of this range of devices
325 * Unregister and destroy the cdev occupying the region described by
326 * @major, @baseminor and @count. This function undoes what
327 * __register_chrdev() did.
329 void __unregister_chrdev(unsigned int major
, unsigned int baseminor
,
330 unsigned int count
, const char *name
)
332 struct char_device_struct
*cd
;
334 cd
= __unregister_chrdev_region(major
, baseminor
, count
);
340 static DEFINE_SPINLOCK(cdev_lock
);
342 static struct kobject
*cdev_get(struct cdev
*p
)
344 struct module
*owner
= p
->owner
;
345 struct kobject
*kobj
;
347 if (owner
&& !try_module_get(owner
))
349 kobj
= kobject_get(&p
->kobj
);
355 void cdev_put(struct cdev
*p
)
358 struct module
*owner
= p
->owner
;
359 kobject_put(&p
->kobj
);
365 * Called every time a character special file is opened
367 static int chrdev_open(struct inode
*inode
, struct file
*filp
)
370 struct cdev
*new = NULL
;
373 spin_lock(&cdev_lock
);
376 struct kobject
*kobj
;
378 spin_unlock(&cdev_lock
);
379 kobj
= kobj_lookup(cdev_map
, inode
->i_rdev
, &idx
);
382 new = container_of(kobj
, struct cdev
, kobj
);
383 spin_lock(&cdev_lock
);
384 /* Check i_cdev again in case somebody beat us to it while
385 we dropped the lock. */
388 inode
->i_cdev
= p
= new;
389 list_add(&inode
->i_devices
, &p
->list
);
391 } else if (!cdev_get(p
))
393 } else if (!cdev_get(p
))
395 spin_unlock(&cdev_lock
);
401 filp
->f_op
= fops_get(p
->ops
);
405 if (filp
->f_op
->open
) {
406 ret
= filp
->f_op
->open(inode
,filp
);
418 int cdev_index(struct inode
*inode
)
421 struct kobject
*kobj
;
423 kobj
= kobj_lookup(cdev_map
, inode
->i_rdev
, &idx
);
430 void cd_forget(struct inode
*inode
)
432 spin_lock(&cdev_lock
);
433 list_del_init(&inode
->i_devices
);
434 inode
->i_cdev
= NULL
;
435 spin_unlock(&cdev_lock
);
438 static void cdev_purge(struct cdev
*cdev
)
440 spin_lock(&cdev_lock
);
441 while (!list_empty(&cdev
->list
)) {
443 inode
= container_of(cdev
->list
.next
, struct inode
, i_devices
);
444 list_del_init(&inode
->i_devices
);
445 inode
->i_cdev
= NULL
;
447 spin_unlock(&cdev_lock
);
451 * Dummy default file-operations: the only thing this does
452 * is contain the open that then fills in the correct operations
453 * depending on the special file...
455 const struct file_operations def_chr_fops
= {
459 static struct kobject
*exact_match(dev_t dev
, int *part
, void *data
)
461 struct cdev
*p
= data
;
465 static int exact_lock(dev_t dev
, void *data
)
467 struct cdev
*p
= data
;
468 return cdev_get(p
) ? 0 : -1;
472 * cdev_add() - add a char device to the system
473 * @p: the cdev structure for the device
474 * @dev: the first device number for which this device is responsible
475 * @count: the number of consecutive minor numbers corresponding to this
478 * cdev_add() adds the device represented by @p to the system, making it
479 * live immediately. A negative error code is returned on failure.
481 int cdev_add(struct cdev
*p
, dev_t dev
, unsigned count
)
485 return kobj_map(cdev_map
, dev
, count
, NULL
, exact_match
, exact_lock
, p
);
488 static void cdev_unmap(dev_t dev
, unsigned count
)
490 kobj_unmap(cdev_map
, dev
, count
);
494 * cdev_del() - remove a cdev from the system
495 * @p: the cdev structure to be removed
497 * cdev_del() removes @p from the system, possibly freeing the structure
500 void cdev_del(struct cdev
*p
)
502 cdev_unmap(p
->dev
, p
->count
);
503 kobject_put(&p
->kobj
);
507 static void cdev_default_release(struct kobject
*kobj
)
509 struct cdev
*p
= container_of(kobj
, struct cdev
, kobj
);
513 static void cdev_dynamic_release(struct kobject
*kobj
)
515 struct cdev
*p
= container_of(kobj
, struct cdev
, kobj
);
520 static struct kobj_type ktype_cdev_default
= {
521 .release
= cdev_default_release
,
524 static struct kobj_type ktype_cdev_dynamic
= {
525 .release
= cdev_dynamic_release
,
529 * cdev_alloc() - allocate a cdev structure
531 * Allocates and returns a cdev structure, or NULL on failure.
533 struct cdev
*cdev_alloc(void)
535 struct cdev
*p
= kzalloc(sizeof(struct cdev
), GFP_KERNEL
);
537 INIT_LIST_HEAD(&p
->list
);
538 kobject_init(&p
->kobj
, &ktype_cdev_dynamic
);
544 * cdev_init() - initialize a cdev structure
545 * @cdev: the structure to initialize
546 * @fops: the file_operations for this device
548 * Initializes @cdev, remembering @fops, making it ready to add to the
549 * system with cdev_add().
551 void cdev_init(struct cdev
*cdev
, const struct file_operations
*fops
)
553 memset(cdev
, 0, sizeof *cdev
);
554 INIT_LIST_HEAD(&cdev
->list
);
555 kobject_init(&cdev
->kobj
, &ktype_cdev_default
);
559 static struct kobject
*base_probe(dev_t dev
, int *part
, void *data
)
561 if (request_module("char-major-%d-%d", MAJOR(dev
), MINOR(dev
)) > 0)
562 /* Make old-style 2.4 aliases work */
563 request_module("char-major-%d", MAJOR(dev
));
567 void __init
chrdev_init(void)
569 cdev_map
= kobj_map_init(base_probe
, &chrdevs_lock
);
570 bdi_init(&directly_mappable_cdev_bdi
);
574 /* Let modules do char dev stuff */
575 EXPORT_SYMBOL(register_chrdev_region
);
576 EXPORT_SYMBOL(unregister_chrdev_region
);
577 EXPORT_SYMBOL(alloc_chrdev_region
);
578 EXPORT_SYMBOL(cdev_init
);
579 EXPORT_SYMBOL(cdev_alloc
);
580 EXPORT_SYMBOL(cdev_del
);
581 EXPORT_SYMBOL(cdev_add
);
582 EXPORT_SYMBOL(cdev_index
);
583 EXPORT_SYMBOL(__register_chrdev
);
584 EXPORT_SYMBOL(__unregister_chrdev
);
585 EXPORT_SYMBOL(directly_mappable_cdev_bdi
);