drivers/usb/core/file.c

   1 /*
   2  * drivers/usb/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/config.h>
  19 #include <linux/module.h>
  20 #include <linux/devfs_fs_kernel.h>
  21 #include <linux/spinlock.h>
  22 #include <linux/errno.h>
  23
  24 #ifdef CONFIG_USB_DEBUG
  25         #define DEBUG
  26 #else
  27         #undef DEBUG
  28 #endif
  29 #include <linux/usb.h>
  30
  31 #define MAX_USB_MINORS  256
  32 static struct file_operations *usb_minors[MAX_USB_MINORS];
  33 static spinlock_t minor_lock = SPIN_LOCK_UNLOCKED;
  34
  35 static int usb_open(struct inode * inode, struct file * file)
  36 {
  37         int minor = iminor(inode);
  38         struct file_operations *c;
  39         int err = -ENODEV;
  40         struct file_operations *old_fops, *new_fops = NULL;
  41
  42         spin_lock (&minor_lock);
  43         c = usb_minors[minor];
  44
  45         if (!c || !(new_fops = fops_get(c))) {
  46                 spin_unlock(&minor_lock);
  47                 return err;
  48         }
  49         spin_unlock(&minor_lock);
  50
  51         old_fops = file->f_op;
  52         file->f_op = new_fops;
  53         /* Curiouser and curiouser... NULL ->open() as "no device" ? */
  54         if (file->f_op->open)
  55                 err = file->f_op->open(inode,file);
  56         if (err) {
  57                 fops_put(file->f_op);
  58                 file->f_op = fops_get(old_fops);
  59         }
  60         fops_put(old_fops);
  61         return err;
  62 }
  63
  64 static struct file_operations usb_fops = {
  65         .owner =        THIS_MODULE,
  66         .open =         usb_open,
  67 };
  68
  69 static void release_usb_class_dev(struct class_device *class_dev)
  70 {
  71         dbg("%s - %s", __FUNCTION__, class_dev->class_id);
  72         kfree(class_dev);
  73 }
  74
  75 static struct class usb_class = {
  76         .name           = "usb",
  77         .release        = &release_usb_class_dev,
  78 };
  79
  80 int usb_major_init(void)
  81 {
  82         if (register_chrdev(USB_MAJOR, "usb", &usb_fops)) {
  83                 err("unable to get major %d for usb devices", USB_MAJOR);
  84                 return -EBUSY;
  85         }
  86
  87         devfs_mk_dir("usb");
  88         class_register(&usb_class);
  89         return 0;
  90 }
  91
  92 void usb_major_cleanup(void)
  93 {
  94         class_unregister(&usb_class);
  95         devfs_remove("usb");
  96         unregister_chrdev(USB_MAJOR, "usb");
  97 }
  98
  99 static ssize_t show_dev(struct class_device *class_dev, char *buf)
 100 {
 101         int minor = (int)(long)class_get_devdata(class_dev);
 102         return print_dev_t(buf, MKDEV(USB_MAJOR, minor));
 103 }
 104 static CLASS_DEVICE_ATTR(dev, S_IRUGO, show_dev, NULL);
 105
 106 /**
 107  * usb_register_dev - register a USB device, and ask for a minor number
 108  * @intf: pointer to the usb_interface that is being registered
 109  * @class_driver: pointer to the usb_class_driver for this device
 110  *
 111  * This should be called by all USB drivers that use the USB major number.
 112  * If CONFIG_USB_DYNAMIC_MINORS is enabled, the minor number will be
 113  * dynamically allocated out of the list of available ones.  If it is not
 114  * enabled, the minor number will be based on the next available free minor,
 115  * starting at the class_driver->minor_base.
 116  *
 117  * This function also creates the devfs file for the usb device, if devfs
 118  * is enabled, and creates a usb class device in the sysfs tree.
 119  *
 120  * usb_deregister_dev() must be called when the driver is done with
 121  * the minor numbers given out by this function.
 122  *
 123  * Returns -EINVAL if something bad happens with trying to register a
 124  * device, and 0 on success.
 125  */
 126 int usb_register_dev(struct usb_interface *intf,
 127                      struct usb_class_driver *class_driver)
 128 {
 129         int retval = -EINVAL;
 130         int minor_base = class_driver->minor_base;
 131         int minor = 0;
 132         char name[BUS_ID_SIZE];
 133         struct class_device *class_dev;
 134         char *temp;
 135
 136 #ifdef CONFIG_USB_DYNAMIC_MINORS
 137         /*
 138          * We don't care what the device tries to start at, we want to start
 139          * at zero to pack the devices into the smallest available space with
 140          * no holes in the minor range.
 141          */
 142         minor_base = 0;
 143 #endif
 144         intf->minor = -1;
 145
 146         dbg ("looking for a minor, starting at %d", minor_base);
 147
 148         if (class_driver->fops == NULL)
 149                 goto exit;
 150
 151         spin_lock (&minor_lock);
 152         for (minor = minor_base; minor < MAX_USB_MINORS; ++minor) {
 153                 if (usb_minors[minor])
 154                         continue;
 155
 156                 usb_minors[minor] = class_driver->fops;
 157
 158                 retval = 0;
 159                 break;
 160         }
 161         spin_unlock (&minor_lock);
 162
 163         if (retval)
 164                 goto exit;
 165
 166         intf->minor = minor;
 167
 168         /* handle the devfs registration */
 169         snprintf(name, BUS_ID_SIZE, class_driver->name, minor - minor_base);
 170         devfs_mk_cdev(MKDEV(USB_MAJOR, minor), class_driver->mode, name);
 171
 172         /* create a usb class device for this usb interface */
 173         class_dev = kmalloc(sizeof(*class_dev), GFP_KERNEL);
 174         if (class_dev) {
 175                 memset(class_dev, 0x00, sizeof(struct class_device));
 176                 class_dev->class = &usb_class;
 177                 class_dev->dev = &intf->dev;
 178
 179                 temp = strrchr(name, '/');
 180                 if (temp && (temp[1] != 0x00))
 181                         ++temp;
 182                 else
 183                         temp = name;
 184                 snprintf(class_dev->class_id, BUS_ID_SIZE, "%s", temp);
 185                 class_set_devdata(class_dev, (void *)(long)intf->minor);
 186                 class_device_register(class_dev);
 187                 class_device_create_file(class_dev, &class_device_attr_dev);
 188                 intf->class_dev = class_dev;
 189         }
 190 exit:
 191         return retval;
 192 }
 193 EXPORT_SYMBOL(usb_register_dev);
 194
 195 /**
 196  * usb_deregister_dev - deregister a USB device's dynamic minor.
 197  * @intf: pointer to the usb_interface that is being deregistered
 198  * @class_driver: pointer to the usb_class_driver for this device
 199  *
 200  * Used in conjunction with usb_register_dev().  This function is called
 201  * when the USB driver is finished with the minor numbers gotten from a
 202  * call to usb_register_dev() (usually when the device is disconnected
 203  * from the system.)
 204  *
 205  * This function also cleans up the devfs file for the usb device, if devfs
 206  * is enabled, and removes the usb class device from the sysfs tree.
 207  *
 208  * This should be called by all drivers that use the USB major number.
 209  */
 210 void usb_deregister_dev(struct usb_interface *intf,
 211                         struct usb_class_driver *class_driver)
 212 {
 213         int minor_base = class_driver->minor_base;
 214         char name[BUS_ID_SIZE];
 215
 216 #ifdef CONFIG_USB_DYNAMIC_MINORS
 217         minor_base = 0;
 218 #endif
 219
 220         if (intf->minor == -1)
 221                 return;
 222
 223         dbg ("removing %d minor", intf->minor);
 224
 225         spin_lock (&minor_lock);
 226         usb_minors[intf->minor] = NULL;
 227         spin_unlock (&minor_lock);
 228
 229         snprintf(name, BUS_ID_SIZE, class_driver->name, intf->minor - minor_base);
 230         devfs_remove (name);
 231
 232         if (intf->class_dev) {
 233                 class_device_unregister(intf->class_dev);
 234                 intf->class_dev = NULL;
 235         }
 236         intf->minor = -1;
 237 }
 238 EXPORT_SYMBOL(usb_deregister_dev);
 239
 240