Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * linux/fs/char_dev.c | |
3 | * | |
4 | * Copyright (C) 1991, 1992 Linus Torvalds | |
5 | */ | |
6 | ||
1da177e4 LT |
7 | #include <linux/init.h> |
8 | #include <linux/fs.h> | |
b446b60e | 9 | #include <linux/kdev_t.h> |
1da177e4 LT |
10 | #include <linux/slab.h> |
11 | #include <linux/string.h> | |
12 | ||
13 | #include <linux/major.h> | |
14 | #include <linux/errno.h> | |
15 | #include <linux/module.h> | |
16 | #include <linux/smp_lock.h> | |
68eef3b4 | 17 | #include <linux/seq_file.h> |
1da177e4 LT |
18 | |
19 | #include <linux/kobject.h> | |
20 | #include <linux/kobj_map.h> | |
21 | #include <linux/cdev.h> | |
58383af6 | 22 | #include <linux/mutex.h> |
5da6185b | 23 | #include <linux/backing-dev.h> |
1da177e4 | 24 | |
07f3f05c | 25 | #include "internal.h" |
1da177e4 | 26 | |
5da6185b DH |
27 | /* |
28 | * capabilities for /dev/mem, /dev/kmem and similar directly mappable character | |
29 | * devices | |
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 | |
33 | */ | |
34 | struct backing_dev_info directly_mappable_cdev_bdi = { | |
35 | .capabilities = ( | |
36 | #ifdef CONFIG_MMU | |
37 | /* permit private copies of the data to be taken */ | |
38 | BDI_CAP_MAP_COPY | | |
39 | #endif | |
40 | /* permit direct mmap, for read, write or exec */ | |
41 | BDI_CAP_MAP_DIRECT | | |
42 | BDI_CAP_READ_MAP | BDI_CAP_WRITE_MAP | BDI_CAP_EXEC_MAP), | |
43 | }; | |
44 | ||
1da177e4 LT |
45 | static struct kobj_map *cdev_map; |
46 | ||
58383af6 | 47 | static DEFINE_MUTEX(chrdevs_lock); |
1da177e4 LT |
48 | |
49 | static struct char_device_struct { | |
50 | struct char_device_struct *next; | |
51 | unsigned int major; | |
52 | unsigned int baseminor; | |
53 | int minorct; | |
7170be5f | 54 | char name[64]; |
1da177e4 | 55 | struct cdev *cdev; /* will die */ |
68eef3b4 | 56 | } *chrdevs[CHRDEV_MAJOR_HASH_SIZE]; |
1da177e4 LT |
57 | |
58 | /* index in the above */ | |
59 | static inline int major_to_index(int major) | |
60 | { | |
68eef3b4 | 61 | return major % CHRDEV_MAJOR_HASH_SIZE; |
7170be5f NH |
62 | } |
63 | ||
68eef3b4 | 64 | #ifdef CONFIG_PROC_FS |
7170be5f | 65 | |
68eef3b4 | 66 | void chrdev_show(struct seq_file *f, off_t offset) |
7170be5f NH |
67 | { |
68 | struct char_device_struct *cd; | |
7170be5f | 69 | |
68eef3b4 JK |
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); | |
1da177e4 | 75 | } |
7170be5f NH |
76 | } |
77 | ||
68eef3b4 | 78 | #endif /* CONFIG_PROC_FS */ |
1da177e4 LT |
79 | |
80 | /* | |
81 | * Register a single major with a specified minor range. | |
82 | * | |
83 | * If major == 0 this functions will dynamically allocate a major and return | |
84 | * its number. | |
85 | * | |
86 | * If major > 0 this function will attempt to reserve the passed range of | |
87 | * minors and will return zero on success. | |
88 | * | |
89 | * Returns a -ve errno on failure. | |
90 | */ | |
91 | static struct char_device_struct * | |
92 | __register_chrdev_region(unsigned int major, unsigned int baseminor, | |
93 | int minorct, const char *name) | |
94 | { | |
95 | struct char_device_struct *cd, **cp; | |
96 | int ret = 0; | |
97 | int i; | |
98 | ||
11b0b5ab | 99 | cd = kzalloc(sizeof(struct char_device_struct), GFP_KERNEL); |
1da177e4 LT |
100 | if (cd == NULL) |
101 | return ERR_PTR(-ENOMEM); | |
102 | ||
58383af6 | 103 | mutex_lock(&chrdevs_lock); |
1da177e4 LT |
104 | |
105 | /* temporary */ | |
106 | if (major == 0) { | |
107 | for (i = ARRAY_SIZE(chrdevs)-1; i > 0; i--) { | |
108 | if (chrdevs[i] == NULL) | |
109 | break; | |
110 | } | |
111 | ||
112 | if (i == 0) { | |
113 | ret = -EBUSY; | |
114 | goto out; | |
115 | } | |
116 | major = i; | |
117 | ret = major; | |
118 | } | |
119 | ||
120 | cd->major = major; | |
121 | cd->baseminor = baseminor; | |
122 | cd->minorct = minorct; | |
8c401888 | 123 | strlcpy(cd->name, name, sizeof(cd->name)); |
1da177e4 LT |
124 | |
125 | i = major_to_index(major); | |
126 | ||
127 | for (cp = &chrdevs[i]; *cp; cp = &(*cp)->next) | |
128 | if ((*cp)->major > major || | |
01d553d0 AW |
129 | ((*cp)->major == major && |
130 | (((*cp)->baseminor >= baseminor) || | |
131 | ((*cp)->baseminor + (*cp)->minorct > baseminor)))) | |
1da177e4 | 132 | break; |
01d553d0 AW |
133 | |
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; | |
140 | ||
141 | /* New driver overlaps from the left. */ | |
142 | if (new_max >= old_min && new_max <= old_max) { | |
143 | ret = -EBUSY; | |
144 | goto out; | |
145 | } | |
146 | ||
147 | /* New driver overlaps from the right. */ | |
148 | if (new_min <= old_max && new_min >= old_min) { | |
149 | ret = -EBUSY; | |
150 | goto out; | |
151 | } | |
1da177e4 | 152 | } |
01d553d0 | 153 | |
1da177e4 LT |
154 | cd->next = *cp; |
155 | *cp = cd; | |
58383af6 | 156 | mutex_unlock(&chrdevs_lock); |
1da177e4 LT |
157 | return cd; |
158 | out: | |
58383af6 | 159 | mutex_unlock(&chrdevs_lock); |
1da177e4 LT |
160 | kfree(cd); |
161 | return ERR_PTR(ret); | |
162 | } | |
163 | ||
164 | static struct char_device_struct * | |
165 | __unregister_chrdev_region(unsigned major, unsigned baseminor, int minorct) | |
166 | { | |
167 | struct char_device_struct *cd = NULL, **cp; | |
168 | int i = major_to_index(major); | |
169 | ||
58383af6 | 170 | mutex_lock(&chrdevs_lock); |
1da177e4 LT |
171 | for (cp = &chrdevs[i]; *cp; cp = &(*cp)->next) |
172 | if ((*cp)->major == major && | |
173 | (*cp)->baseminor == baseminor && | |
174 | (*cp)->minorct == minorct) | |
175 | break; | |
176 | if (*cp) { | |
177 | cd = *cp; | |
178 | *cp = cd->next; | |
179 | } | |
58383af6 | 180 | mutex_unlock(&chrdevs_lock); |
1da177e4 LT |
181 | return cd; |
182 | } | |
183 | ||
cf3e43db JC |
184 | /** |
185 | * register_chrdev_region() - register a range of device numbers | |
186 | * @from: the first in the desired range of device numbers; must include | |
187 | * the major number. | |
188 | * @count: the number of consecutive device numbers required | |
189 | * @name: the name of the device or driver. | |
190 | * | |
191 | * Return value is zero on success, a negative error code on failure. | |
192 | */ | |
1da177e4 LT |
193 | int register_chrdev_region(dev_t from, unsigned count, const char *name) |
194 | { | |
195 | struct char_device_struct *cd; | |
196 | dev_t to = from + count; | |
197 | dev_t n, next; | |
198 | ||
199 | for (n = from; n < to; n = next) { | |
200 | next = MKDEV(MAJOR(n)+1, 0); | |
201 | if (next > to) | |
202 | next = to; | |
203 | cd = __register_chrdev_region(MAJOR(n), MINOR(n), | |
204 | next - n, name); | |
205 | if (IS_ERR(cd)) | |
206 | goto fail; | |
207 | } | |
208 | return 0; | |
209 | fail: | |
210 | to = 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)); | |
214 | } | |
215 | return PTR_ERR(cd); | |
216 | } | |
217 | ||
cf3e43db JC |
218 | /** |
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 | |
224 | * | |
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. | |
228 | */ | |
1da177e4 LT |
229 | int alloc_chrdev_region(dev_t *dev, unsigned baseminor, unsigned count, |
230 | const char *name) | |
231 | { | |
232 | struct char_device_struct *cd; | |
233 | cd = __register_chrdev_region(0, baseminor, count, name); | |
234 | if (IS_ERR(cd)) | |
235 | return PTR_ERR(cd); | |
236 | *dev = MKDEV(cd->major, cd->baseminor); | |
237 | return 0; | |
238 | } | |
239 | ||
d247e2c6 REB |
240 | /** |
241 | * register_chrdev() - Register a major number for character devices. | |
242 | * @major: major device number or 0 for dynamic allocation | |
243 | * @name: name of this range of devices | |
244 | * @fops: file operations associated with this devices | |
245 | * | |
246 | * If @major == 0 this functions will dynamically allocate a major and return | |
247 | * its number. | |
248 | * | |
249 | * If @major > 0 this function will attempt to reserve a device with the given | |
250 | * major number and will return zero on success. | |
251 | * | |
252 | * Returns a -ve errno on failure. | |
253 | * | |
254 | * The name of this device has nothing to do with the name of the device in | |
255 | * /dev. It only helps to keep track of the different owners of devices. If | |
256 | * your module name has only one type of devices it's ok to use e.g. the name | |
257 | * of the module here. | |
258 | * | |
259 | * This function registers a range of 256 minor numbers. The first minor number | |
260 | * is 0. | |
261 | */ | |
1da177e4 | 262 | int register_chrdev(unsigned int major, const char *name, |
99ac48f5 | 263 | const struct file_operations *fops) |
1da177e4 LT |
264 | { |
265 | struct char_device_struct *cd; | |
266 | struct cdev *cdev; | |
267 | char *s; | |
268 | int err = -ENOMEM; | |
269 | ||
270 | cd = __register_chrdev_region(major, 0, 256, name); | |
271 | if (IS_ERR(cd)) | |
272 | return PTR_ERR(cd); | |
273 | ||
274 | cdev = cdev_alloc(); | |
275 | if (!cdev) | |
276 | goto out2; | |
277 | ||
278 | cdev->owner = fops->owner; | |
279 | cdev->ops = fops; | |
280 | kobject_set_name(&cdev->kobj, "%s", name); | |
281 | for (s = strchr(kobject_name(&cdev->kobj),'/'); s; s = strchr(s, '/')) | |
282 | *s = '!'; | |
283 | ||
284 | err = cdev_add(cdev, MKDEV(cd->major, 0), 256); | |
285 | if (err) | |
286 | goto out; | |
287 | ||
288 | cd->cdev = cdev; | |
289 | ||
290 | return major ? 0 : cd->major; | |
291 | out: | |
292 | kobject_put(&cdev->kobj); | |
293 | out2: | |
294 | kfree(__unregister_chrdev_region(cd->major, 0, 256)); | |
295 | return err; | |
296 | } | |
297 | ||
cf3e43db JC |
298 | /** |
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 | |
302 | * | |
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... | |
306 | */ | |
1da177e4 LT |
307 | void unregister_chrdev_region(dev_t from, unsigned count) |
308 | { | |
309 | dev_t to = from + count; | |
310 | dev_t n, next; | |
311 | ||
312 | for (n = from; n < to; n = next) { | |
313 | next = MKDEV(MAJOR(n)+1, 0); | |
314 | if (next > to) | |
315 | next = to; | |
316 | kfree(__unregister_chrdev_region(MAJOR(n), MINOR(n), next - n)); | |
317 | } | |
318 | } | |
319 | ||
e53252d9 | 320 | void unregister_chrdev(unsigned int major, const char *name) |
1da177e4 LT |
321 | { |
322 | struct char_device_struct *cd; | |
323 | cd = __unregister_chrdev_region(major, 0, 256); | |
324 | if (cd && cd->cdev) | |
325 | cdev_del(cd->cdev); | |
326 | kfree(cd); | |
1da177e4 LT |
327 | } |
328 | ||
329 | static DEFINE_SPINLOCK(cdev_lock); | |
330 | ||
331 | static struct kobject *cdev_get(struct cdev *p) | |
332 | { | |
333 | struct module *owner = p->owner; | |
334 | struct kobject *kobj; | |
335 | ||
336 | if (owner && !try_module_get(owner)) | |
337 | return NULL; | |
338 | kobj = kobject_get(&p->kobj); | |
339 | if (!kobj) | |
340 | module_put(owner); | |
341 | return kobj; | |
342 | } | |
343 | ||
344 | void cdev_put(struct cdev *p) | |
345 | { | |
346 | if (p) { | |
7da6844c | 347 | struct module *owner = p->owner; |
1da177e4 | 348 | kobject_put(&p->kobj); |
7da6844c | 349 | module_put(owner); |
1da177e4 LT |
350 | } |
351 | } | |
352 | ||
353 | /* | |
354 | * Called every time a character special file is opened | |
355 | */ | |
922f9cfa | 356 | static int chrdev_open(struct inode *inode, struct file *filp) |
1da177e4 LT |
357 | { |
358 | struct cdev *p; | |
359 | struct cdev *new = NULL; | |
360 | int ret = 0; | |
361 | ||
362 | spin_lock(&cdev_lock); | |
363 | p = inode->i_cdev; | |
364 | if (!p) { | |
365 | struct kobject *kobj; | |
366 | int idx; | |
367 | spin_unlock(&cdev_lock); | |
368 | kobj = kobj_lookup(cdev_map, inode->i_rdev, &idx); | |
369 | if (!kobj) | |
370 | return -ENXIO; | |
371 | new = container_of(kobj, struct cdev, kobj); | |
372 | spin_lock(&cdev_lock); | |
a30427d9 JC |
373 | /* Check i_cdev again in case somebody beat us to it while |
374 | we dropped the lock. */ | |
1da177e4 LT |
375 | p = inode->i_cdev; |
376 | if (!p) { | |
377 | inode->i_cdev = p = new; | |
1da177e4 LT |
378 | list_add(&inode->i_devices, &p->list); |
379 | new = NULL; | |
380 | } else if (!cdev_get(p)) | |
381 | ret = -ENXIO; | |
382 | } else if (!cdev_get(p)) | |
383 | ret = -ENXIO; | |
384 | spin_unlock(&cdev_lock); | |
385 | cdev_put(new); | |
386 | if (ret) | |
387 | return ret; | |
a518ab93 CH |
388 | |
389 | ret = -ENXIO; | |
1da177e4 | 390 | filp->f_op = fops_get(p->ops); |
a518ab93 CH |
391 | if (!filp->f_op) |
392 | goto out_cdev_put; | |
393 | ||
394 | if (filp->f_op->open) { | |
1da177e4 | 395 | ret = filp->f_op->open(inode,filp); |
a518ab93 CH |
396 | if (ret) |
397 | goto out_cdev_put; | |
398 | } | |
399 | ||
400 | return 0; | |
401 | ||
402 | out_cdev_put: | |
403 | cdev_put(p); | |
1da177e4 LT |
404 | return ret; |
405 | } | |
406 | ||
9fd5746f TT |
407 | int cdev_index(struct inode *inode) |
408 | { | |
409 | int idx; | |
410 | struct kobject *kobj; | |
411 | ||
412 | kobj = kobj_lookup(cdev_map, inode->i_rdev, &idx); | |
413 | if (!kobj) | |
414 | return -1; | |
415 | kobject_put(kobj); | |
416 | return idx; | |
417 | } | |
418 | ||
1da177e4 LT |
419 | void cd_forget(struct inode *inode) |
420 | { | |
421 | spin_lock(&cdev_lock); | |
422 | list_del_init(&inode->i_devices); | |
423 | inode->i_cdev = NULL; | |
424 | spin_unlock(&cdev_lock); | |
425 | } | |
426 | ||
75c96f85 | 427 | static void cdev_purge(struct cdev *cdev) |
1da177e4 LT |
428 | { |
429 | spin_lock(&cdev_lock); | |
430 | while (!list_empty(&cdev->list)) { | |
431 | struct inode *inode; | |
432 | inode = container_of(cdev->list.next, struct inode, i_devices); | |
433 | list_del_init(&inode->i_devices); | |
434 | inode->i_cdev = NULL; | |
435 | } | |
436 | spin_unlock(&cdev_lock); | |
437 | } | |
438 | ||
439 | /* | |
440 | * Dummy default file-operations: the only thing this does | |
441 | * is contain the open that then fills in the correct operations | |
442 | * depending on the special file... | |
443 | */ | |
4b6f5d20 | 444 | const struct file_operations def_chr_fops = { |
1da177e4 LT |
445 | .open = chrdev_open, |
446 | }; | |
447 | ||
448 | static struct kobject *exact_match(dev_t dev, int *part, void *data) | |
449 | { | |
450 | struct cdev *p = data; | |
451 | return &p->kobj; | |
452 | } | |
453 | ||
454 | static int exact_lock(dev_t dev, void *data) | |
455 | { | |
456 | struct cdev *p = data; | |
457 | return cdev_get(p) ? 0 : -1; | |
458 | } | |
459 | ||
cf3e43db JC |
460 | /** |
461 | * cdev_add() - add a char device to the system | |
462 | * @p: the cdev structure for the device | |
463 | * @dev: the first device number for which this device is responsible | |
464 | * @count: the number of consecutive minor numbers corresponding to this | |
465 | * device | |
466 | * | |
467 | * cdev_add() adds the device represented by @p to the system, making it | |
468 | * live immediately. A negative error code is returned on failure. | |
469 | */ | |
1da177e4 LT |
470 | int cdev_add(struct cdev *p, dev_t dev, unsigned count) |
471 | { | |
472 | p->dev = dev; | |
473 | p->count = count; | |
474 | return kobj_map(cdev_map, dev, count, NULL, exact_match, exact_lock, p); | |
475 | } | |
476 | ||
477 | static void cdev_unmap(dev_t dev, unsigned count) | |
478 | { | |
479 | kobj_unmap(cdev_map, dev, count); | |
480 | } | |
481 | ||
cf3e43db JC |
482 | /** |
483 | * cdev_del() - remove a cdev from the system | |
484 | * @p: the cdev structure to be removed | |
485 | * | |
486 | * cdev_del() removes @p from the system, possibly freeing the structure | |
487 | * itself. | |
488 | */ | |
1da177e4 LT |
489 | void cdev_del(struct cdev *p) |
490 | { | |
491 | cdev_unmap(p->dev, p->count); | |
492 | kobject_put(&p->kobj); | |
493 | } | |
494 | ||
495 | ||
496 | static void cdev_default_release(struct kobject *kobj) | |
497 | { | |
498 | struct cdev *p = container_of(kobj, struct cdev, kobj); | |
499 | cdev_purge(p); | |
500 | } | |
501 | ||
502 | static void cdev_dynamic_release(struct kobject *kobj) | |
503 | { | |
504 | struct cdev *p = container_of(kobj, struct cdev, kobj); | |
505 | cdev_purge(p); | |
506 | kfree(p); | |
507 | } | |
508 | ||
509 | static struct kobj_type ktype_cdev_default = { | |
510 | .release = cdev_default_release, | |
511 | }; | |
512 | ||
513 | static struct kobj_type ktype_cdev_dynamic = { | |
514 | .release = cdev_dynamic_release, | |
515 | }; | |
516 | ||
cf3e43db JC |
517 | /** |
518 | * cdev_alloc() - allocate a cdev structure | |
519 | * | |
520 | * Allocates and returns a cdev structure, or NULL on failure. | |
521 | */ | |
1da177e4 LT |
522 | struct cdev *cdev_alloc(void) |
523 | { | |
11b0b5ab | 524 | struct cdev *p = kzalloc(sizeof(struct cdev), GFP_KERNEL); |
1da177e4 | 525 | if (p) { |
1da177e4 | 526 | INIT_LIST_HEAD(&p->list); |
f9cb074b | 527 | kobject_init(&p->kobj, &ktype_cdev_dynamic); |
1da177e4 LT |
528 | } |
529 | return p; | |
530 | } | |
531 | ||
cf3e43db JC |
532 | /** |
533 | * cdev_init() - initialize a cdev structure | |
534 | * @cdev: the structure to initialize | |
535 | * @fops: the file_operations for this device | |
536 | * | |
537 | * Initializes @cdev, remembering @fops, making it ready to add to the | |
538 | * system with cdev_add(). | |
539 | */ | |
99ac48f5 | 540 | void cdev_init(struct cdev *cdev, const struct file_operations *fops) |
1da177e4 LT |
541 | { |
542 | memset(cdev, 0, sizeof *cdev); | |
543 | INIT_LIST_HEAD(&cdev->list); | |
f9cb074b | 544 | kobject_init(&cdev->kobj, &ktype_cdev_default); |
1da177e4 LT |
545 | cdev->ops = fops; |
546 | } | |
547 | ||
548 | static struct kobject *base_probe(dev_t dev, int *part, void *data) | |
549 | { | |
550 | if (request_module("char-major-%d-%d", MAJOR(dev), MINOR(dev)) > 0) | |
551 | /* Make old-style 2.4 aliases work */ | |
552 | request_module("char-major-%d", MAJOR(dev)); | |
553 | return NULL; | |
554 | } | |
555 | ||
556 | void __init chrdev_init(void) | |
557 | { | |
558 | cdev_map = kobj_map_init(base_probe, &chrdevs_lock); | |
e0bf68dd | 559 | bdi_init(&directly_mappable_cdev_bdi); |
1da177e4 LT |
560 | } |
561 | ||
562 | ||
563 | /* Let modules do char dev stuff */ | |
564 | EXPORT_SYMBOL(register_chrdev_region); | |
565 | EXPORT_SYMBOL(unregister_chrdev_region); | |
566 | EXPORT_SYMBOL(alloc_chrdev_region); | |
567 | EXPORT_SYMBOL(cdev_init); | |
568 | EXPORT_SYMBOL(cdev_alloc); | |
569 | EXPORT_SYMBOL(cdev_del); | |
570 | EXPORT_SYMBOL(cdev_add); | |
9fd5746f | 571 | EXPORT_SYMBOL(cdev_index); |
1da177e4 LT |
572 | EXPORT_SYMBOL(register_chrdev); |
573 | EXPORT_SYMBOL(unregister_chrdev); | |
5da6185b | 574 | EXPORT_SYMBOL(directly_mappable_cdev_bdi); |