file.c 6.2 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
Linus Torvalds's avatar
Linus Torvalds committed
2
/*
3
 * drivers/usb/core/file.c
Linus Torvalds's avatar
Linus Torvalds committed
4
5
6
7
8
9
10
11
 *
 * (C) Copyright Linus Torvalds 1999
 * (C) Copyright Johannes Erdfelt 1999-2001
 * (C) Copyright Andreas Gal 1999
 * (C) Copyright Gregory P. Smith 1999
 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
 * (C) Copyright Randy Dunlap 2000
 * (C) Copyright David Brownell 2000-2001 (kernel hotplug, usb_device_id,
12
 *	more docs, etc)
Linus Torvalds's avatar
Linus Torvalds committed
13
14
15
16
 * (C) Copyright Yggdrasil Computing, Inc. 2000
 *     (usb_device_id matching changes by Adam J. Richter)
 * (C) Copyright Greg Kroah-Hartman 2002-2003
 *
17
 * Released under the GPLv2 only.
Linus Torvalds's avatar
Linus Torvalds committed
18
19
20
21
 */

#include <linux/module.h>
#include <linux/errno.h>
22
#include <linux/rwsem.h>
23
#include <linux/slab.h>
24
#include <linux/string.h>
Linus Torvalds's avatar
Linus Torvalds committed
25
26
#include <linux/usb.h>

27
28
#include "usb.h"

Linus Torvalds's avatar
Linus Torvalds committed
29
#define MAX_USB_MINORS	256
30
static const struct file_operations *usb_minors[MAX_USB_MINORS];
31
static DECLARE_RWSEM(minor_rwsem);
32
static DEFINE_MUTEX(init_usb_class_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
33

34
static int usb_open(struct inode *inode, struct file *file)
Linus Torvalds's avatar
Linus Torvalds committed
35
36
{
	int err = -ENODEV;
37
	const struct file_operations *new_fops;
Linus Torvalds's avatar
Linus Torvalds committed
38

39
	down_read(&minor_rwsem);
40
	new_fops = fops_get(usb_minors[iminor(inode)]);
Linus Torvalds's avatar
Linus Torvalds committed
41

42
	if (!new_fops)
43
		goto done;
Linus Torvalds's avatar
Linus Torvalds committed
44

45
	replace_fops(file, new_fops);
Linus Torvalds's avatar
Linus Torvalds committed
46
47
	/* Curiouser and curiouser... NULL ->open() as "no device" ? */
	if (file->f_op->open)
48
		err = file->f_op->open(inode, file);
49
50
 done:
	up_read(&minor_rwsem);
Linus Torvalds's avatar
Linus Torvalds committed
51
52
53
	return err;
}

54
static const struct file_operations usb_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
55
56
	.owner =	THIS_MODULE,
	.open =		usb_open,
57
	.llseek =	noop_llseek,
Linus Torvalds's avatar
Linus Torvalds committed
58
59
};

60
61
62
63
static struct usb_class {
	struct kref kref;
	struct class *class;
} *usb_class;
Linus Torvalds's avatar
Linus Torvalds committed
64

65
static char *usb_devnode(struct device *dev, umode_t *mode)
66
67
68
69
{
	struct usb_class_driver *drv;

	drv = dev_get_drvdata(dev);
70
	if (!drv || !drv->devnode)
71
		return NULL;
72
	return drv->devnode(dev, mode);
73
74
}

75
static int init_usb_class(void)
Linus Torvalds's avatar
Linus Torvalds committed
76
{
77
	int result = 0;
Linus Torvalds's avatar
Linus Torvalds committed
78

79
80
81
82
83
84
85
86
87
	if (usb_class != NULL) {
		kref_get(&usb_class->kref);
		goto exit;
	}

	usb_class = kmalloc(sizeof(*usb_class), GFP_KERNEL);
	if (!usb_class) {
		result = -ENOMEM;
		goto exit;
Linus Torvalds's avatar
Linus Torvalds committed
88
89
	}

90
	kref_init(&usb_class->kref);
91
	usb_class->class = class_create(THIS_MODULE, "usbmisc");
92
	if (IS_ERR(usb_class->class)) {
93
		result = PTR_ERR(usb_class->class);
94
		printk(KERN_ERR "class_create failed for usb devices\n");
95
96
		kfree(usb_class);
		usb_class = NULL;
97
		goto exit;
Linus Torvalds's avatar
Linus Torvalds committed
98
	}
99
	usb_class->class->devnode = usb_devnode;
Linus Torvalds's avatar
Linus Torvalds committed
100

101
102
103
104
105
106
107
108
109
110
111
112
113
114
exit:
	return result;
}

static void release_usb_class(struct kref *kref)
{
	/* Ok, we cheat as we know we only have one usb_class */
	class_destroy(usb_class->class);
	kfree(usb_class);
	usb_class = NULL;
}

static void destroy_usb_class(void)
{
115
116
117
	mutex_lock(&init_usb_class_mutex);
	kref_put(&usb_class->kref, release_usb_class);
	mutex_unlock(&init_usb_class_mutex);
118
119
120
121
122
123
124
125
}

int usb_major_init(void)
{
	int error;

	error = register_chrdev(USB_MAJOR, "usb", &usb_fops);
	if (error)
126
127
		printk(KERN_ERR "Unable to get major %d for usb devices\n",
		       USB_MAJOR);
128

Linus Torvalds's avatar
Linus Torvalds committed
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
	return error;
}

void usb_major_cleanup(void)
{
	unregister_chrdev(USB_MAJOR, "usb");
}

/**
 * usb_register_dev - register a USB device, and ask for a minor number
 * @intf: pointer to the usb_interface that is being registered
 * @class_driver: pointer to the usb_class_driver for this device
 *
 * This should be called by all USB drivers that use the USB major number.
 * If CONFIG_USB_DYNAMIC_MINORS is enabled, the minor number will be
 * dynamically allocated out of the list of available ones.  If it is not
 * enabled, the minor number will be based on the next available free minor,
 * starting at the class_driver->minor_base.
 *
148
 * This function also creates a usb class device in the sysfs tree.
Linus Torvalds's avatar
Linus Torvalds committed
149
150
151
152
 *
 * usb_deregister_dev() must be called when the driver is done with
 * the minor numbers given out by this function.
 *
153
 * Return: -EINVAL if something bad happens with trying to register a
Linus Torvalds's avatar
Linus Torvalds committed
154
155
156
157
158
 * device, and 0 on success.
 */
int usb_register_dev(struct usb_interface *intf,
		     struct usb_class_driver *class_driver)
{
159
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
160
	int minor_base = class_driver->minor_base;
161
	int minor;
162
	char name[20];
Linus Torvalds's avatar
Linus Torvalds committed
163
164

#ifdef CONFIG_USB_DYNAMIC_MINORS
165
	/*
Linus Torvalds's avatar
Linus Torvalds committed
166
167
168
169
170
171
172
173
	 * We don't care what the device tries to start at, we want to start
	 * at zero to pack the devices into the smallest available space with
	 * no holes in the minor range.
	 */
	minor_base = 0;
#endif

	if (class_driver->fops == NULL)
174
175
176
177
		return -EINVAL;
	if (intf->minor >= 0)
		return -EADDRINUSE;

178
	mutex_lock(&init_usb_class_mutex);
179
	retval = init_usb_class();
180
181
	mutex_unlock(&init_usb_class_mutex);

182
183
184
	if (retval)
		return retval;

185
	dev_dbg(&intf->dev, "looking for a minor, starting at %d\n", minor_base);
Linus Torvalds's avatar
Linus Torvalds committed
186

187
	down_write(&minor_rwsem);
Linus Torvalds's avatar
Linus Torvalds committed
188
189
190
191
192
	for (minor = minor_base; minor < MAX_USB_MINORS; ++minor) {
		if (usb_minors[minor])
			continue;

		usb_minors[minor] = class_driver->fops;
193
		intf->minor = minor;
Linus Torvalds's avatar
Linus Torvalds committed
194
195
		break;
	}
196
197
	if (intf->minor < 0) {
		up_write(&minor_rwsem);
198
		return -EXFULL;
199
	}
Linus Torvalds's avatar
Linus Torvalds committed
200
201

	/* create a usb class device for this usb interface */
202
	snprintf(name, sizeof(name), class_driver->name, minor - minor_base);
203
	intf->usb_dev = device_create(usb_class->class, &intf->dev,
204
				      MKDEV(USB_MAJOR, minor), class_driver,
205
				      "%s", kbasename(name));
206
	if (IS_ERR(intf->usb_dev)) {
207
208
		usb_minors[minor] = NULL;
		intf->minor = -1;
209
		retval = PTR_ERR(intf->usb_dev);
Linus Torvalds's avatar
Linus Torvalds committed
210
	}
211
	up_write(&minor_rwsem);
Linus Torvalds's avatar
Linus Torvalds committed
212
213
	return retval;
}
214
EXPORT_SYMBOL_GPL(usb_register_dev);
Linus Torvalds's avatar
Linus Torvalds committed
215
216
217
218
219
220
221
222
223
224
225

/**
 * usb_deregister_dev - deregister a USB device's dynamic minor.
 * @intf: pointer to the usb_interface that is being deregistered
 * @class_driver: pointer to the usb_class_driver for this device
 *
 * Used in conjunction with usb_register_dev().  This function is called
 * when the USB driver is finished with the minor numbers gotten from a
 * call to usb_register_dev() (usually when the device is disconnected
 * from the system.)
 *
226
227
 * This function also removes the usb class device from the sysfs tree.
 *
Linus Torvalds's avatar
Linus Torvalds committed
228
229
230
231
232
233
234
235
 * This should be called by all drivers that use the USB major number.
 */
void usb_deregister_dev(struct usb_interface *intf,
			struct usb_class_driver *class_driver)
{
	if (intf->minor == -1)
		return;

236
	dev_dbg(&intf->dev, "removing %d minor\n", intf->minor);
237
	device_destroy(usb_class->class, MKDEV(USB_MAJOR, intf->minor));
Linus Torvalds's avatar
Linus Torvalds committed
238

239
	down_write(&minor_rwsem);
Linus Torvalds's avatar
Linus Torvalds committed
240
	usb_minors[intf->minor] = NULL;
241
	up_write(&minor_rwsem);
Linus Torvalds's avatar
Linus Torvalds committed
242

243
	intf->usb_dev = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
244
	intf->minor = -1;
245
	destroy_usb_class();
Linus Torvalds's avatar
Linus Torvalds committed
246
}
247
EXPORT_SYMBOL_GPL(usb_deregister_dev);