drivers/usb/core/file.c

   1 /*
   2  * drivers/usb/core/file.c
   3  *
   4  * (C) Copyright Linus Torvalds 1999
   5  * (C) Copyright Johannes Erdfelt 1999-2001
   6  * (C) Copyright Andreas Gal 1999
   7  * (C) Copyright Gregory P. Smith 1999
   8  * (C) Copyright Deti Fliegl 1999 (new USB architecture)
   9  * (C) Copyright Randy Dunlap 2000
  10  * (C) Copyright David Brownell 2000-2001 (kernel hotplug, usb_device_id,
  11         more docs, etc)
  12  * (C) Copyright Yggdrasil Computing, Inc. 2000
  13  *     (usb_device_id matching changes by Adam J. Richter)
  14  * (C) Copyright Greg Kroah-Hartman 2002-2003
  15  *
  16  */
  17
  18 #include <linux/module.h>
  19 #include <linux/errno.h>
  20 #include <linux/rwsem.h>
  21 #include <linux/slab.h>
  22 #include <linux/usb.h>
  23
  24 #include "usb.h"
  25
  26 #define MAX_USB_MINORS  256
  27 static const struct file_operations *usb_minors[MAX_USB_MINORS];
  28 static DECLARE_RWSEM(minor_rwsem);
  29 static DEFINE_MUTEX(init_usb_class_mutex);
  30
  31 static int usb_open(struct inode * inode, struct file * file)
  32 {
  33         int minor = iminor(inode);
  34         const struct file_operations *c;
  35         int err = -ENODEV;
  36         const struct file_operations *old_fops, *new_fops = NULL;
  37
  38         down_read(&minor_rwsem);
  39         c = usb_minors[minor];
  40
  41         if (!c || !(new_fops = fops_get(c)))
  42                 goto done;
  43
  44         old_fops = file->f_op;
  45         file->f_op = new_fops;
  46         /* Curiouser and curiouser... NULL ->open() as "no device" ? */
  47         if (file->f_op->open)
  48                 err = file->f_op->open(inode,file);
  49         if (err) {
  50                 fops_put(file->f_op);
  51                 file->f_op = fops_get(old_fops);
  52         }
  53         fops_put(old_fops);
  54  done:
  55         up_read(&minor_rwsem);
  56         return err;
  57 }
  58
  59 static const struct file_operations usb_fops = {
  60         .owner =        THIS_MODULE,
  61         .open =         usb_open,
  62         .llseek =       noop_llseek,
  63 };
  64
  65 static struct usb_class {
  66         struct kref kref;
  67         struct class *class;
  68 } *usb_class;
  69
  70 static char *usb_devnode(struct device *dev, mode_t *mode)
  71 {
  72         struct usb_class_driver *drv;
  73
  74         drv = dev_get_drvdata(dev);
  75         if (!drv || !drv->devnode)
  76                 return NULL;
  77         return drv->devnode(dev, mode);
  78 }
  79
  80 static int init_usb_class(void)
  81 {
  82         int result = 0;
  83
  84         if (usb_class != NULL) {
  85                 kref_get(&usb_class->kref);
  86                 goto exit;
  87         }
  88
  89         usb_class = kmalloc(sizeof(*usb_class), GFP_KERNEL);
  90         if (!usb_class) {
  91                 result = -ENOMEM;
  92                 goto exit;
  93         }
  94
  95         kref_init(&usb_class->kref);
  96         usb_class->class = class_create(THIS_MODULE, "usb");
  97         if (IS_ERR(usb_class->class)) {
  98                 result = IS_ERR(usb_class->class);
  99                 printk(KERN_ERR "class_create failed for usb devices\n");
 100                 kfree(usb_class);
 101                 usb_class = NULL;
 102                 goto exit;
 103         }
 104         usb_class->class->devnode = usb_devnode;
 105
 106 exit:
 107         return result;
 108 }
 109
 110 static void release_usb_class(struct kref *kref)
 111 {
 112         /* Ok, we cheat as we know we only have one usb_class */
 113         class_destroy(usb_class->class);
 114         kfree(usb_class);
 115         usb_class = NULL;
 116 }
 117
 118 static void destroy_usb_class(void)
 119 {
 120         mutex_lock(&init_usb_class_mutex);
 121         kref_put(&usb_class->kref, release_usb_class);
 122         mutex_unlock(&init_usb_class_mutex);
 123 }
 124
 125 int usb_major_init(void)
 126 {
 127         int error;
 128
 129         error = register_chrdev(USB_MAJOR, "usb", &usb_fops);
 130         if (error)
 131                 printk(KERN_ERR "Unable to get major %d for usb devices\n",
 132                        USB_MAJOR);
 133
 134         return error;
 135 }
 136
 137 void usb_major_cleanup(void)
 138 {
 139         unregister_chrdev(USB_MAJOR, "usb");
 140 }
 141
 142 /**
 143  * usb_register_dev - register a USB device, and ask for a minor number
 144  * @intf: pointer to the usb_interface that is being registered
 145  * @class_driver: pointer to the usb_class_driver for this device
 146  *
 147  * This should be called by all USB drivers that use the USB major number.
 148  * If CONFIG_USB_DYNAMIC_MINORS is enabled, the minor number will be
 149  * dynamically allocated out of the list of available ones.  If it is not
 150  * enabled, the minor number will be based on the next available free minor,
 151  * starting at the class_driver->minor_base.
 152  *
 153  * This function also creates a usb class device in the sysfs tree.
 154  *
 155  * usb_deregister_dev() must be called when the driver is done with
 156  * the minor numbers given out by this function.
 157  *
 158  * Returns -EINVAL if something bad happens with trying to register a
 159  * device, and 0 on success.
 160  */
 161 int usb_register_dev(struct usb_interface *intf,
 162                      struct usb_class_driver *class_driver)
 163 {
 164         int retval;
 165         int minor_base = class_driver->minor_base;
 166         int minor;
 167         char name[20];
 168         char *temp;
 169
 170 #ifdef CONFIG_USB_DYNAMIC_MINORS
 171         /*
 172          * We don't care what the device tries to start at, we want to start
 173          * at zero to pack the devices into the smallest available space with
 174          * no holes in the minor range.
 175          */
 176         minor_base = 0;
 177 #endif
 178
 179         if (class_driver->fops == NULL)
 180                 return -EINVAL;
 181         if (intf->minor >= 0)
 182                 return -EADDRINUSE;
 183
 184         mutex_lock(&init_usb_class_mutex);
 185         retval = init_usb_class();
 186         mutex_unlock(&init_usb_class_mutex);
 187
 188         if (retval)
 189                 return retval;
 190
 191         dev_dbg(&intf->dev, "looking for a minor, starting at %d", minor_base);
 192
 193         down_write(&minor_rwsem);
 194         for (minor = minor_base; minor < MAX_USB_MINORS; ++minor) {
 195                 if (usb_minors[minor])
 196                         continue;
 197
 198                 usb_minors[minor] = class_driver->fops;
 199                 intf->minor = minor;
 200                 break;
 201         }
 202         up_write(&minor_rwsem);
 203         if (intf->minor < 0)
 204                 return -EXFULL;
 205
 206         /* create a usb class device for this usb interface */
 207         snprintf(name, sizeof(name), class_driver->name, minor - minor_base);
 208         temp = strrchr(name, '/');
 209         if (temp && (temp[1] != '\0'))
 210                 ++temp;
 211         else
 212                 temp = name;
 213         intf->usb_dev = device_create(usb_class->class, &intf->dev,
 214                                       MKDEV(USB_MAJOR, minor), class_driver,
 215                                       "%s", temp);
 216         if (IS_ERR(intf->usb_dev)) {
 217                 down_write(&minor_rwsem);
 218                 usb_minors[minor] = NULL;
 219                 intf->minor = -1;
 220                 up_write(&minor_rwsem);
 221                 retval = PTR_ERR(intf->usb_dev);
 222         }
 223         return retval;
 224 }
 225 EXPORT_SYMBOL_GPL(usb_register_dev);
 226
 227 /**
 228  * usb_deregister_dev - deregister a USB device's dynamic minor.
 229  * @intf: pointer to the usb_interface that is being deregistered
 230  * @class_driver: pointer to the usb_class_driver for this device
 231  *
 232  * Used in conjunction with usb_register_dev().  This function is called
 233  * when the USB driver is finished with the minor numbers gotten from a
 234  * call to usb_register_dev() (usually when the device is disconnected
 235  * from the system.)
 236  *
 237  * This function also removes the usb class device from the sysfs tree.
 238  *
 239  * This should be called by all drivers that use the USB major number.
 240  */
 241 void usb_deregister_dev(struct usb_interface *intf,
 242                         struct usb_class_driver *class_driver)
 243 {
 244         if (intf->minor == -1)
 245                 return;
 246
 247         dbg ("removing %d minor", intf->minor);
 248
 249         down_write(&minor_rwsem);
 250         usb_minors[intf->minor] = NULL;
 251         up_write(&minor_rwsem);
 252
 253         device_destroy(usb_class->class, MKDEV(USB_MAJOR, intf->minor));
 254         intf->usb_dev = NULL;
 255         intf->minor = -1;
 256         destroy_usb_class();
 257 }
 258 EXPORT_SYMBOL_GPL(usb_deregister_dev);