char_dev.c 14 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8
/*
 *  linux/fs/char_dev.c
 *
 *  Copyright (C) 1991, 1992  Linus Torvalds
 */

#include <linux/init.h>
#include <linux/fs.h>
9
#include <linux/kdev_t.h>
Linus Torvalds's avatar
Linus Torvalds committed
10 11 12 13 14 15
#include <linux/slab.h>
#include <linux/string.h>

#include <linux/major.h>
#include <linux/errno.h>
#include <linux/module.h>
16
#include <linux/seq_file.h>
Linus Torvalds's avatar
Linus Torvalds committed
17 18 19 20

#include <linux/kobject.h>
#include <linux/kobj_map.h>
#include <linux/cdev.h>
21
#include <linux/mutex.h>
22
#include <linux/backing-dev.h>
23
#include <linux/tty.h>
Linus Torvalds's avatar
Linus Torvalds committed
24

25
#include "internal.h"
Linus Torvalds's avatar
Linus Torvalds committed
26

27 28 29 30 31 32 33 34
/*
 * capabilities for /dev/mem, /dev/kmem and similar directly mappable character
 * devices
 * - permits shared-mmap for read, write and/or exec
 * - does not permit private mmap in NOMMU mode (can't do COW)
 * - no readahead or I/O queue unplugging required
 */
struct backing_dev_info directly_mappable_cdev_bdi = {
35
	.name = "char",
36 37 38 39 40 41 42
	.capabilities	= (
#ifdef CONFIG_MMU
		/* permit private copies of the data to be taken */
		BDI_CAP_MAP_COPY |
#endif
		/* permit direct mmap, for read, write or exec */
		BDI_CAP_MAP_DIRECT |
43 44 45
		BDI_CAP_READ_MAP | BDI_CAP_WRITE_MAP | BDI_CAP_EXEC_MAP |
		/* no writeback happens */
		BDI_CAP_NO_ACCT_AND_WRITEBACK),
46 47
};

Linus Torvalds's avatar
Linus Torvalds committed
48 49
static struct kobj_map *cdev_map;

50
static DEFINE_MUTEX(chrdevs_lock);
Linus Torvalds's avatar
Linus Torvalds committed
51 52 53 54 55 56

static struct char_device_struct {
	struct char_device_struct *next;
	unsigned int major;
	unsigned int baseminor;
	int minorct;
57
	char name[64];
Linus Torvalds's avatar
Linus Torvalds committed
58
	struct cdev *cdev;		/* will die */
59
} *chrdevs[CHRDEV_MAJOR_HASH_SIZE];
Linus Torvalds's avatar
Linus Torvalds committed
60 61

/* index in the above */
62
static inline int major_to_index(unsigned major)
Linus Torvalds's avatar
Linus Torvalds committed
63
{
64
	return major % CHRDEV_MAJOR_HASH_SIZE;
65 66
}

67
#ifdef CONFIG_PROC_FS
68

69
void chrdev_show(struct seq_file *f, off_t offset)
70 71 72
{
	struct char_device_struct *cd;

73 74 75 76 77
	if (offset < CHRDEV_MAJOR_HASH_SIZE) {
		mutex_lock(&chrdevs_lock);
		for (cd = chrdevs[offset]; cd; cd = cd->next)
			seq_printf(f, "%3d %s\n", cd->major, cd->name);
		mutex_unlock(&chrdevs_lock);
Linus Torvalds's avatar
Linus Torvalds committed
78
	}
79 80
}

81
#endif /* CONFIG_PROC_FS */
Linus Torvalds's avatar
Linus Torvalds committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

/*
 * Register a single major with a specified minor range.
 *
 * If major == 0 this functions will dynamically allocate a major and return
 * its number.
 *
 * If major > 0 this function will attempt to reserve the passed range of
 * minors and will return zero on success.
 *
 * Returns a -ve errno on failure.
 */
static struct char_device_struct *
__register_chrdev_region(unsigned int major, unsigned int baseminor,
			   int minorct, const char *name)
{
	struct char_device_struct *cd, **cp;
	int ret = 0;
	int i;

102
	cd = kzalloc(sizeof(struct char_device_struct), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
103 104 105
	if (cd == NULL)
		return ERR_PTR(-ENOMEM);

106
	mutex_lock(&chrdevs_lock);
Linus Torvalds's avatar
Linus Torvalds committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125

	/* temporary */
	if (major == 0) {
		for (i = ARRAY_SIZE(chrdevs)-1; i > 0; i--) {
			if (chrdevs[i] == NULL)
				break;
		}

		if (i == 0) {
			ret = -EBUSY;
			goto out;
		}
		major = i;
		ret = major;
	}

	cd->major = major;
	cd->baseminor = baseminor;
	cd->minorct = minorct;
126
	strlcpy(cd->name, name, sizeof(cd->name));
Linus Torvalds's avatar
Linus Torvalds committed
127 128 129 130 131

	i = major_to_index(major);

	for (cp = &chrdevs[i]; *cp; cp = &(*cp)->next)
		if ((*cp)->major > major ||
132 133 134
		    ((*cp)->major == major &&
		     (((*cp)->baseminor >= baseminor) ||
		      ((*cp)->baseminor + (*cp)->minorct > baseminor))))
Linus Torvalds's avatar
Linus Torvalds committed
135
			break;
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

	/* Check for overlapping minor ranges.  */
	if (*cp && (*cp)->major == major) {
		int old_min = (*cp)->baseminor;
		int old_max = (*cp)->baseminor + (*cp)->minorct - 1;
		int new_min = baseminor;
		int new_max = baseminor + minorct - 1;

		/* New driver overlaps from the left.  */
		if (new_max >= old_min && new_max <= old_max) {
			ret = -EBUSY;
			goto out;
		}

		/* New driver overlaps from the right.  */
		if (new_min <= old_max && new_min >= old_min) {
			ret = -EBUSY;
			goto out;
		}
Linus Torvalds's avatar
Linus Torvalds committed
155
	}
156

Linus Torvalds's avatar
Linus Torvalds committed
157 158
	cd->next = *cp;
	*cp = cd;
159
	mutex_unlock(&chrdevs_lock);
Linus Torvalds's avatar
Linus Torvalds committed
160 161
	return cd;
out:
162
	mutex_unlock(&chrdevs_lock);
Linus Torvalds's avatar
Linus Torvalds committed
163 164 165 166 167 168 169 170 171 172
	kfree(cd);
	return ERR_PTR(ret);
}

static struct char_device_struct *
__unregister_chrdev_region(unsigned major, unsigned baseminor, int minorct)
{
	struct char_device_struct *cd = NULL, **cp;
	int i = major_to_index(major);

173
	mutex_lock(&chrdevs_lock);
Linus Torvalds's avatar
Linus Torvalds committed
174 175 176 177 178 179 180 181 182
	for (cp = &chrdevs[i]; *cp; cp = &(*cp)->next)
		if ((*cp)->major == major &&
		    (*cp)->baseminor == baseminor &&
		    (*cp)->minorct == minorct)
			break;
	if (*cp) {
		cd = *cp;
		*cp = cd->next;
	}
183
	mutex_unlock(&chrdevs_lock);
Linus Torvalds's avatar
Linus Torvalds committed
184 185 186
	return cd;
}

187 188 189 190 191 192 193 194 195
/**
 * register_chrdev_region() - register a range of device numbers
 * @from: the first in the desired range of device numbers; must include
 *        the major number.
 * @count: the number of consecutive device numbers required
 * @name: the name of the device or driver.
 *
 * Return value is zero on success, a negative error code on failure.
 */
Linus Torvalds's avatar
Linus Torvalds committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
int register_chrdev_region(dev_t from, unsigned count, const char *name)
{
	struct char_device_struct *cd;
	dev_t to = from + count;
	dev_t n, next;

	for (n = from; n < to; n = next) {
		next = MKDEV(MAJOR(n)+1, 0);
		if (next > to)
			next = to;
		cd = __register_chrdev_region(MAJOR(n), MINOR(n),
			       next - n, name);
		if (IS_ERR(cd))
			goto fail;
	}
	return 0;
fail:
	to = n;
	for (n = from; n < to; n = next) {
		next = MKDEV(MAJOR(n)+1, 0);
		kfree(__unregister_chrdev_region(MAJOR(n), MINOR(n), next - n));
	}
	return PTR_ERR(cd);
}

221 222 223 224 225 226 227 228 229 230 231
/**
 * alloc_chrdev_region() - register a range of char device numbers
 * @dev: output parameter for first assigned number
 * @baseminor: first of the requested range of minor numbers
 * @count: the number of minor numbers required
 * @name: the name of the associated device or driver
 *
 * Allocates a range of char device numbers.  The major number will be
 * chosen dynamically, and returned (along with the first minor number)
 * in @dev.  Returns zero or a negative error code.
 */
Linus Torvalds's avatar
Linus Torvalds committed
232 233 234 235 236 237 238 239 240 241 242
int alloc_chrdev_region(dev_t *dev, unsigned baseminor, unsigned count,
			const char *name)
{
	struct char_device_struct *cd;
	cd = __register_chrdev_region(0, baseminor, count, name);
	if (IS_ERR(cd))
		return PTR_ERR(cd);
	*dev = MKDEV(cd->major, cd->baseminor);
	return 0;
}

243
/**
244
 * __register_chrdev() - create and register a cdev occupying a range of minors
245
 * @major: major device number or 0 for dynamic allocation
246 247
 * @baseminor: first of the requested range of minor numbers
 * @count: the number of minor numbers required
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
 * @name: name of this range of devices
 * @fops: file operations associated with this devices
 *
 * If @major == 0 this functions will dynamically allocate a major and return
 * its number.
 *
 * If @major > 0 this function will attempt to reserve a device with the given
 * major number and will return zero on success.
 *
 * Returns a -ve errno on failure.
 *
 * The name of this device has nothing to do with the name of the device in
 * /dev. It only helps to keep track of the different owners of devices. If
 * your module name has only one type of devices it's ok to use e.g. the name
 * of the module here.
 */
264 265 266
int __register_chrdev(unsigned int major, unsigned int baseminor,
		      unsigned int count, const char *name,
		      const struct file_operations *fops)
Linus Torvalds's avatar
Linus Torvalds committed
267 268 269 270 271
{
	struct char_device_struct *cd;
	struct cdev *cdev;
	int err = -ENOMEM;

272
	cd = __register_chrdev_region(major, baseminor, count, name);
Linus Torvalds's avatar
Linus Torvalds committed
273 274
	if (IS_ERR(cd))
		return PTR_ERR(cd);
275

Linus Torvalds's avatar
Linus Torvalds committed
276 277 278 279 280 281 282
	cdev = cdev_alloc();
	if (!cdev)
		goto out2;

	cdev->owner = fops->owner;
	cdev->ops = fops;
	kobject_set_name(&cdev->kobj, "%s", name);
283

284
	err = cdev_add(cdev, MKDEV(cd->major, baseminor), count);
Linus Torvalds's avatar
Linus Torvalds committed
285 286 287 288 289 290 291 292 293
	if (err)
		goto out;

	cd->cdev = cdev;

	return major ? 0 : cd->major;
out:
	kobject_put(&cdev->kobj);
out2:
294
	kfree(__unregister_chrdev_region(cd->major, baseminor, count));
Linus Torvalds's avatar
Linus Torvalds committed
295 296 297
	return err;
}

298 299 300 301 302 303 304 305 306
/**
 * unregister_chrdev_region() - return a range of device numbers
 * @from: the first in the range of numbers to unregister
 * @count: the number of device numbers to unregister
 *
 * This function will unregister a range of @count device numbers,
 * starting with @from.  The caller should normally be the one who
 * allocated those numbers in the first place...
 */
Linus Torvalds's avatar
Linus Torvalds committed
307 308 309 310 311 312 313 314 315 316 317 318 319
void unregister_chrdev_region(dev_t from, unsigned count)
{
	dev_t to = from + count;
	dev_t n, next;

	for (n = from; n < to; n = next) {
		next = MKDEV(MAJOR(n)+1, 0);
		if (next > to)
			next = to;
		kfree(__unregister_chrdev_region(MAJOR(n), MINOR(n), next - n));
	}
}

320 321 322 323 324 325 326 327 328 329 330 331 332
/**
 * __unregister_chrdev - unregister and destroy a cdev
 * @major: major device number
 * @baseminor: first of the range of minor numbers
 * @count: the number of minor numbers this cdev is occupying
 * @name: name of this range of devices
 *
 * Unregister and destroy the cdev occupying the region described by
 * @major, @baseminor and @count.  This function undoes what
 * __register_chrdev() did.
 */
void __unregister_chrdev(unsigned int major, unsigned int baseminor,
			 unsigned int count, const char *name)
Linus Torvalds's avatar
Linus Torvalds committed
333 334
{
	struct char_device_struct *cd;
335 336

	cd = __unregister_chrdev_region(major, baseminor, count);
Linus Torvalds's avatar
Linus Torvalds committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
	if (cd && cd->cdev)
		cdev_del(cd->cdev);
	kfree(cd);
}

static DEFINE_SPINLOCK(cdev_lock);

static struct kobject *cdev_get(struct cdev *p)
{
	struct module *owner = p->owner;
	struct kobject *kobj;

	if (owner && !try_module_get(owner))
		return NULL;
	kobj = kobject_get(&p->kobj);
	if (!kobj)
		module_put(owner);
	return kobj;
}

void cdev_put(struct cdev *p)
{
	if (p) {
Brian King's avatar
Brian King committed
360
		struct module *owner = p->owner;
Linus Torvalds's avatar
Linus Torvalds committed
361
		kobject_put(&p->kobj);
Brian King's avatar
Brian King committed
362
		module_put(owner);
Linus Torvalds's avatar
Linus Torvalds committed
363 364 365 366 367 368
	}
}

/*
 * Called every time a character special file is opened
 */
369
static int chrdev_open(struct inode *inode, struct file *filp)
Linus Torvalds's avatar
Linus Torvalds committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
{
	struct cdev *p;
	struct cdev *new = NULL;
	int ret = 0;

	spin_lock(&cdev_lock);
	p = inode->i_cdev;
	if (!p) {
		struct kobject *kobj;
		int idx;
		spin_unlock(&cdev_lock);
		kobj = kobj_lookup(cdev_map, inode->i_rdev, &idx);
		if (!kobj)
			return -ENXIO;
		new = container_of(kobj, struct cdev, kobj);
		spin_lock(&cdev_lock);
386 387
		/* Check i_cdev again in case somebody beat us to it while
		   we dropped the lock. */
Linus Torvalds's avatar
Linus Torvalds committed
388 389 390 391 392 393 394 395 396 397 398 399 400
		p = inode->i_cdev;
		if (!p) {
			inode->i_cdev = p = new;
			list_add(&inode->i_devices, &p->list);
			new = NULL;
		} else if (!cdev_get(p))
			ret = -ENXIO;
	} else if (!cdev_get(p))
		ret = -ENXIO;
	spin_unlock(&cdev_lock);
	cdev_put(new);
	if (ret)
		return ret;
401 402

	ret = -ENXIO;
Linus Torvalds's avatar
Linus Torvalds committed
403
	filp->f_op = fops_get(p->ops);
404 405 406 407
	if (!filp->f_op)
		goto out_cdev_put;

	if (filp->f_op->open) {
408
		ret = filp->f_op->open(inode, filp);
409 410 411 412 413 414 415 416
		if (ret)
			goto out_cdev_put;
	}

	return 0;

 out_cdev_put:
	cdev_put(p);
Linus Torvalds's avatar
Linus Torvalds committed
417 418 419 420 421 422 423 424 425 426 427
	return ret;
}

void cd_forget(struct inode *inode)
{
	spin_lock(&cdev_lock);
	list_del_init(&inode->i_devices);
	inode->i_cdev = NULL;
	spin_unlock(&cdev_lock);
}

428
static void cdev_purge(struct cdev *cdev)
Linus Torvalds's avatar
Linus Torvalds committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
{
	spin_lock(&cdev_lock);
	while (!list_empty(&cdev->list)) {
		struct inode *inode;
		inode = container_of(cdev->list.next, struct inode, i_devices);
		list_del_init(&inode->i_devices);
		inode->i_cdev = NULL;
	}
	spin_unlock(&cdev_lock);
}

/*
 * Dummy default file-operations: the only thing this does
 * is contain the open that then fills in the correct operations
 * depending on the special file...
 */
445
const struct file_operations def_chr_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
446
	.open = chrdev_open,
447
	.llseek = noop_llseek,
Linus Torvalds's avatar
Linus Torvalds committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461
};

static struct kobject *exact_match(dev_t dev, int *part, void *data)
{
	struct cdev *p = data;
	return &p->kobj;
}

static int exact_lock(dev_t dev, void *data)
{
	struct cdev *p = data;
	return cdev_get(p) ? 0 : -1;
}

462 463 464 465 466 467 468 469 470 471
/**
 * cdev_add() - add a char device to the system
 * @p: the cdev structure for the device
 * @dev: the first device number for which this device is responsible
 * @count: the number of consecutive minor numbers corresponding to this
 *         device
 *
 * cdev_add() adds the device represented by @p to the system, making it
 * live immediately.  A negative error code is returned on failure.
 */
Linus Torvalds's avatar
Linus Torvalds committed
472 473
int cdev_add(struct cdev *p, dev_t dev, unsigned count)
{
474 475
	int error;

Linus Torvalds's avatar
Linus Torvalds committed
476 477
	p->dev = dev;
	p->count = count;
478 479 480 481 482 483 484 485 486

	error = kobj_map(cdev_map, dev, count, NULL,
			 exact_match, exact_lock, p);
	if (error)
		return error;

	kobject_get(p->kobj.parent);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
487 488 489 490 491 492 493
}

static void cdev_unmap(dev_t dev, unsigned count)
{
	kobj_unmap(cdev_map, dev, count);
}

494 495 496 497 498 499 500
/**
 * cdev_del() - remove a cdev from the system
 * @p: the cdev structure to be removed
 *
 * cdev_del() removes @p from the system, possibly freeing the structure
 * itself.
 */
Linus Torvalds's avatar
Linus Torvalds committed
501 502 503 504 505 506 507 508 509 510
void cdev_del(struct cdev *p)
{
	cdev_unmap(p->dev, p->count);
	kobject_put(&p->kobj);
}


static void cdev_default_release(struct kobject *kobj)
{
	struct cdev *p = container_of(kobj, struct cdev, kobj);
511 512
	struct kobject *parent = kobj->parent;

Linus Torvalds's avatar
Linus Torvalds committed
513
	cdev_purge(p);
514
	kobject_put(parent);
Linus Torvalds's avatar
Linus Torvalds committed
515 516 517 518 519
}

static void cdev_dynamic_release(struct kobject *kobj)
{
	struct cdev *p = container_of(kobj, struct cdev, kobj);
520 521
	struct kobject *parent = kobj->parent;

Linus Torvalds's avatar
Linus Torvalds committed
522 523
	cdev_purge(p);
	kfree(p);
524
	kobject_put(parent);
Linus Torvalds's avatar
Linus Torvalds committed
525 526 527 528 529 530 531 532 533 534
}

static struct kobj_type ktype_cdev_default = {
	.release	= cdev_default_release,
};

static struct kobj_type ktype_cdev_dynamic = {
	.release	= cdev_dynamic_release,
};

535 536 537 538 539
/**
 * cdev_alloc() - allocate a cdev structure
 *
 * Allocates and returns a cdev structure, or NULL on failure.
 */
Linus Torvalds's avatar
Linus Torvalds committed
540 541
struct cdev *cdev_alloc(void)
{
542
	struct cdev *p = kzalloc(sizeof(struct cdev), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
543 544
	if (p) {
		INIT_LIST_HEAD(&p->list);
545
		kobject_init(&p->kobj, &ktype_cdev_dynamic);
Linus Torvalds's avatar
Linus Torvalds committed
546 547 548 549
	}
	return p;
}

550 551 552 553 554 555 556 557
/**
 * cdev_init() - initialize a cdev structure
 * @cdev: the structure to initialize
 * @fops: the file_operations for this device
 *
 * Initializes @cdev, remembering @fops, making it ready to add to the
 * system with cdev_add().
 */
558
void cdev_init(struct cdev *cdev, const struct file_operations *fops)
Linus Torvalds's avatar
Linus Torvalds committed
559 560 561
{
	memset(cdev, 0, sizeof *cdev);
	INIT_LIST_HEAD(&cdev->list);
562
	kobject_init(&cdev->kobj, &ktype_cdev_default);
Linus Torvalds's avatar
Linus Torvalds committed
563 564 565 566 567 568 569 570 571 572 573 574 575 576
	cdev->ops = fops;
}

static struct kobject *base_probe(dev_t dev, int *part, void *data)
{
	if (request_module("char-major-%d-%d", MAJOR(dev), MINOR(dev)) > 0)
		/* Make old-style 2.4 aliases work */
		request_module("char-major-%d", MAJOR(dev));
	return NULL;
}

void __init chrdev_init(void)
{
	cdev_map = kobj_map_init(base_probe, &chrdevs_lock);
Peter Zijlstra's avatar
Peter Zijlstra committed
577
	bdi_init(&directly_mappable_cdev_bdi);
Linus Torvalds's avatar
Linus Torvalds committed
578 579 580 581 582 583 584 585 586 587 588
}


/* Let modules do char dev stuff */
EXPORT_SYMBOL(register_chrdev_region);
EXPORT_SYMBOL(unregister_chrdev_region);
EXPORT_SYMBOL(alloc_chrdev_region);
EXPORT_SYMBOL(cdev_init);
EXPORT_SYMBOL(cdev_alloc);
EXPORT_SYMBOL(cdev_del);
EXPORT_SYMBOL(cdev_add);
589 590
EXPORT_SYMBOL(__register_chrdev);
EXPORT_SYMBOL(__unregister_chrdev);
591
EXPORT_SYMBOL(directly_mappable_cdev_bdi);