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>
27 * capabilities for /dev/mem, /dev/kmem and similar directly mappable character
29 * - permits shared-mmap for read, write and/or exec
30 * - does not permit private mmap in NOMMU mode (can't do COW)
31 * - no readahead or I/O queue unplugging required
33 struct backing_dev_info directly_mappable_cdev_bdi
= {
37 /* permit private copies of the data to be taken */
40 /* permit direct mmap, for read, write or exec */
42 BDI_CAP_READ_MAP
| BDI_CAP_WRITE_MAP
| BDI_CAP_EXEC_MAP
),
45 static struct kobj_map
*cdev_map
;
47 static DEFINE_MUTEX(chrdevs_lock
);
49 static struct char_device_struct
{
50 struct char_device_struct
*next
;
52 unsigned int baseminor
;
55 struct cdev
*cdev
; /* will die */
56 } *chrdevs
[CHRDEV_MAJOR_HASH_SIZE
];
58 /* index in the above */
59 static inline int major_to_index(int major
)
61 return major
% CHRDEV_MAJOR_HASH_SIZE
;
66 void chrdev_show(struct seq_file
*f
, off_t offset
)
68 struct char_device_struct
*cd
;
70 if (offset
< CHRDEV_MAJOR_HASH_SIZE
) {
71 mutex_lock(&chrdevs_lock
);
72 for (cd
= chrdevs
[offset
]; cd
; cd
= cd
->next
)
73 seq_printf(f
, "%3d %s\n", cd
->major
, cd
->name
);
74 mutex_unlock(&chrdevs_lock
);
78 #endif /* CONFIG_PROC_FS */
81 * Register a single major with a specified minor range.
83 * If major == 0 this functions will dynamically allocate a major and return
86 * If major > 0 this function will attempt to reserve the passed range of
87 * minors and will return zero on success.
89 * Returns a -ve errno on failure.
91 static struct char_device_struct
*
92 __register_chrdev_region(unsigned int major
, unsigned int baseminor
,
93 int minorct
, const char *name
)
95 struct char_device_struct
*cd
, **cp
;
99 cd
= kzalloc(sizeof(struct char_device_struct
), GFP_KERNEL
);
101 return ERR_PTR(-ENOMEM
);
103 mutex_lock(&chrdevs_lock
);
107 for (i
= ARRAY_SIZE(chrdevs
)-1; i
> 0; i
--) {
108 if (chrdevs
[i
] == NULL
)
121 cd
->baseminor
= baseminor
;
122 cd
->minorct
= minorct
;
123 strlcpy(cd
->name
, name
, sizeof(cd
->name
));
125 i
= major_to_index(major
);
127 for (cp
= &chrdevs
[i
]; *cp
; cp
= &(*cp
)->next
)
128 if ((*cp
)->major
> major
||
129 ((*cp
)->major
== major
&&
130 (((*cp
)->baseminor
>= baseminor
) ||
131 ((*cp
)->baseminor
+ (*cp
)->minorct
> baseminor
))))
134 /* Check for overlapping minor ranges. */
135 if (*cp
&& (*cp
)->major
== major
) {
136 int old_min
= (*cp
)->baseminor
;
137 int old_max
= (*cp
)->baseminor
+ (*cp
)->minorct
- 1;
138 int new_min
= baseminor
;
139 int new_max
= baseminor
+ minorct
- 1;
141 /* New driver overlaps from the left. */
142 if (new_max
>= old_min
&& new_max
<= old_max
) {
147 /* New driver overlaps from the right. */
148 if (new_min
<= old_max
&& new_min
>= old_min
) {
156 mutex_unlock(&chrdevs_lock
);
159 mutex_unlock(&chrdevs_lock
);
164 static struct char_device_struct
*
165 __unregister_chrdev_region(unsigned major
, unsigned baseminor
, int minorct
)
167 struct char_device_struct
*cd
= NULL
, **cp
;
168 int i
= major_to_index(major
);
170 mutex_lock(&chrdevs_lock
);
171 for (cp
= &chrdevs
[i
]; *cp
; cp
= &(*cp
)->next
)
172 if ((*cp
)->major
== major
&&
173 (*cp
)->baseminor
== baseminor
&&
174 (*cp
)->minorct
== minorct
)
180 mutex_unlock(&chrdevs_lock
);
185 * register_chrdev_region() - register a range of device numbers
186 * @from: the first in the desired range of device numbers; must include
188 * @count: the number of consecutive device numbers required
189 * @name: the name of the device or driver.
191 * Return value is zero on success, a negative error code on failure.
193 int register_chrdev_region(dev_t from
, unsigned count
, const char *name
)
195 struct char_device_struct
*cd
;
196 dev_t to
= from
+ count
;
199 for (n
= from
; n
< to
; n
= next
) {
200 next
= MKDEV(MAJOR(n
)+1, 0);
203 cd
= __register_chrdev_region(MAJOR(n
), MINOR(n
),
211 for (n
= from
; n
< to
; n
= next
) {
212 next
= MKDEV(MAJOR(n
)+1, 0);
213 kfree(__unregister_chrdev_region(MAJOR(n
), MINOR(n
), next
- n
));
219 * alloc_chrdev_region() - register a range of char device numbers
220 * @dev: output parameter for first assigned number
221 * @baseminor: first of the requested range of minor numbers
222 * @count: the number of minor numbers required
223 * @name: the name of the associated device or driver
225 * Allocates a range of char device numbers. The major number will be
226 * chosen dynamically, and returned (along with the first minor number)
227 * in @dev. Returns zero or a negative error code.
229 int alloc_chrdev_region(dev_t
*dev
, unsigned baseminor
, unsigned count
,
232 struct char_device_struct
*cd
;
233 cd
= __register_chrdev_region(0, baseminor
, count
, name
);
236 *dev
= MKDEV(cd
->major
, cd
->baseminor
);
241 * __register_chrdev() - create and register a cdev occupying a range of minors
242 * @major: major device number or 0 for dynamic allocation
243 * @baseminor: first of the requested range of minor numbers
244 * @count: the number of minor numbers required
245 * @name: name of this range of devices
246 * @fops: file operations associated with this devices
248 * If @major == 0 this functions will dynamically allocate a major and return
251 * If @major > 0 this function will attempt to reserve a device with the given
252 * major number and will return zero on success.
254 * Returns a -ve errno on failure.
256 * The name of this device has nothing to do with the name of the device in
257 * /dev. It only helps to keep track of the different owners of devices. If
258 * your module name has only one type of devices it's ok to use e.g. the name
259 * of the module here.
261 int __register_chrdev(unsigned int major
, unsigned int baseminor
,
262 unsigned int count
, const char *name
,
263 const struct file_operations
*fops
)
265 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
);
281 for (s
= strchr(kobject_name(&cdev
->kobj
),'/'); s
; s
= strchr(s
, '/'))
284 err
= cdev_add(cdev
, MKDEV(cd
->major
, baseminor
), count
);
290 return major
? 0 : cd
->major
;
292 kobject_put(&cdev
->kobj
);
294 kfree(__unregister_chrdev_region(cd
->major
, baseminor
, count
));
299 * unregister_chrdev_region() - return a range of device numbers
300 * @from: the first in the range of numbers to unregister
301 * @count: the number of device numbers to unregister
303 * This function will unregister a range of @count device numbers,
304 * starting with @from. The caller should normally be the one who
305 * allocated those numbers in the first place...
307 void unregister_chrdev_region(dev_t from
, unsigned count
)
309 dev_t to
= from
+ count
;
312 for (n
= from
; n
< to
; n
= next
) {
313 next
= MKDEV(MAJOR(n
)+1, 0);
316 kfree(__unregister_chrdev_region(MAJOR(n
), MINOR(n
), next
- n
));
321 * __unregister_chrdev - unregister and destroy a cdev
322 * @major: major device number
323 * @baseminor: first of the range of minor numbers
324 * @count: the number of minor numbers this cdev is occupying
325 * @name: name of this range of devices
327 * Unregister and destroy the cdev occupying the region described by
328 * @major, @baseminor and @count. This function undoes what
329 * __register_chrdev() did.
331 void __unregister_chrdev(unsigned int major
, unsigned int baseminor
,
332 unsigned int count
, const char *name
)
334 struct char_device_struct
*cd
;
336 cd
= __unregister_chrdev_region(major
, baseminor
, count
);
342 static DEFINE_SPINLOCK(cdev_lock
);
344 static struct kobject
*cdev_get(struct cdev
*p
)
346 struct module
*owner
= p
->owner
;
347 struct kobject
*kobj
;
349 if (owner
&& !try_module_get(owner
))
351 kobj
= kobject_get(&p
->kobj
);
357 void cdev_put(struct cdev
*p
)
360 struct module
*owner
= p
->owner
;
361 kobject_put(&p
->kobj
);
367 * Called every time a character special file is opened
369 static int chrdev_open(struct inode
*inode
, struct file
*filp
)
372 struct cdev
*new = NULL
;
375 spin_lock(&cdev_lock
);
378 struct kobject
*kobj
;
380 spin_unlock(&cdev_lock
);
381 kobj
= kobj_lookup(cdev_map
, inode
->i_rdev
, &idx
);
384 new = container_of(kobj
, struct cdev
, kobj
);
385 spin_lock(&cdev_lock
);
386 /* Check i_cdev again in case somebody beat us to it while
387 we dropped the lock. */
390 inode
->i_cdev
= p
= new;
391 list_add(&inode
->i_devices
, &p
->list
);
393 } else if (!cdev_get(p
))
395 } else if (!cdev_get(p
))
397 spin_unlock(&cdev_lock
);
403 filp
->f_op
= fops_get(p
->ops
);
407 if (filp
->f_op
->open
) {
408 ret
= filp
->f_op
->open(inode
,filp
);
420 int cdev_index(struct inode
*inode
)
423 struct kobject
*kobj
;
425 kobj
= kobj_lookup(cdev_map
, inode
->i_rdev
, &idx
);
432 void cd_forget(struct inode
*inode
)
434 spin_lock(&cdev_lock
);
435 list_del_init(&inode
->i_devices
);
436 inode
->i_cdev
= NULL
;
437 spin_unlock(&cdev_lock
);
440 static void cdev_purge(struct cdev
*cdev
)
442 spin_lock(&cdev_lock
);
443 while (!list_empty(&cdev
->list
)) {
445 inode
= container_of(cdev
->list
.next
, struct inode
, i_devices
);
446 list_del_init(&inode
->i_devices
);
447 inode
->i_cdev
= NULL
;
449 spin_unlock(&cdev_lock
);
453 * Dummy default file-operations: the only thing this does
454 * is contain the open that then fills in the correct operations
455 * depending on the special file...
457 const struct file_operations def_chr_fops
= {
461 static struct kobject
*exact_match(dev_t dev
, int *part
, void *data
)
463 struct cdev
*p
= data
;
467 static int exact_lock(dev_t dev
, void *data
)
469 struct cdev
*p
= data
;
470 return cdev_get(p
) ? 0 : -1;
474 * cdev_add() - add a char device to the system
475 * @p: the cdev structure for the device
476 * @dev: the first device number for which this device is responsible
477 * @count: the number of consecutive minor numbers corresponding to this
480 * cdev_add() adds the device represented by @p to the system, making it
481 * live immediately. A negative error code is returned on failure.
483 int cdev_add(struct cdev
*p
, dev_t dev
, unsigned count
)
487 return kobj_map(cdev_map
, dev
, count
, NULL
, exact_match
, exact_lock
, p
);
490 static void cdev_unmap(dev_t dev
, unsigned count
)
492 kobj_unmap(cdev_map
, dev
, count
);
496 * cdev_del() - remove a cdev from the system
497 * @p: the cdev structure to be removed
499 * cdev_del() removes @p from the system, possibly freeing the structure
502 void cdev_del(struct cdev
*p
)
504 cdev_unmap(p
->dev
, p
->count
);
505 kobject_put(&p
->kobj
);
509 static void cdev_default_release(struct kobject
*kobj
)
511 struct cdev
*p
= container_of(kobj
, struct cdev
, kobj
);
515 static void cdev_dynamic_release(struct kobject
*kobj
)
517 struct cdev
*p
= container_of(kobj
, struct cdev
, kobj
);
522 static struct kobj_type ktype_cdev_default
= {
523 .release
= cdev_default_release
,
526 static struct kobj_type ktype_cdev_dynamic
= {
527 .release
= cdev_dynamic_release
,
531 * cdev_alloc() - allocate a cdev structure
533 * Allocates and returns a cdev structure, or NULL on failure.
535 struct cdev
*cdev_alloc(void)
537 struct cdev
*p
= kzalloc(sizeof(struct cdev
), GFP_KERNEL
);
539 INIT_LIST_HEAD(&p
->list
);
540 kobject_init(&p
->kobj
, &ktype_cdev_dynamic
);
546 * cdev_init() - initialize a cdev structure
547 * @cdev: the structure to initialize
548 * @fops: the file_operations for this device
550 * Initializes @cdev, remembering @fops, making it ready to add to the
551 * system with cdev_add().
553 void cdev_init(struct cdev
*cdev
, const struct file_operations
*fops
)
555 memset(cdev
, 0, sizeof *cdev
);
556 INIT_LIST_HEAD(&cdev
->list
);
557 kobject_init(&cdev
->kobj
, &ktype_cdev_default
);
561 static struct kobject
*base_probe(dev_t dev
, int *part
, void *data
)
563 if (request_module("char-major-%d-%d", MAJOR(dev
), MINOR(dev
)) > 0)
564 /* Make old-style 2.4 aliases work */
565 request_module("char-major-%d", MAJOR(dev
));
569 void __init
chrdev_init(void)
571 cdev_map
= kobj_map_init(base_probe
, &chrdevs_lock
);
572 bdi_init(&directly_mappable_cdev_bdi
);
576 /* Let modules do char dev stuff */
577 EXPORT_SYMBOL(register_chrdev_region
);
578 EXPORT_SYMBOL(unregister_chrdev_region
);
579 EXPORT_SYMBOL(alloc_chrdev_region
);
580 EXPORT_SYMBOL(cdev_init
);
581 EXPORT_SYMBOL(cdev_alloc
);
582 EXPORT_SYMBOL(cdev_del
);
583 EXPORT_SYMBOL(cdev_add
);
584 EXPORT_SYMBOL(cdev_index
);
585 EXPORT_SYMBOL(__register_chrdev
);
586 EXPORT_SYMBOL(__unregister_chrdev
);
587 EXPORT_SYMBOL(directly_mappable_cdev_bdi
);