chiark / gitweb /
Merge branch 'master' of git+ssh://master.kernel.org/pub/scm/linux/hotplug/udev
[elogind.git] / extras / usb_id / usb_id.c
index 22f075b5d96aefd28d8d7fe1e354cfdccba3cd22..b412598d35a8ea56749f3a27dcbeeede1aa29259 100644 (file)
 #include <unistd.h>
 #include <string.h>
 #include <ctype.h>
+#include <fcntl.h>
 #include <errno.h>
 #include <getopt.h>
 
-#include "../../udev/udev.h"
+#include "libudev.h"
+#include "libudev-private.h"
 
 int debug;
 
@@ -37,53 +39,22 @@ static void log_fn(struct udev *udev, int priority,
 }
 
 static char vendor_str[64];
+static char vendor_str_enc[256];
+static const char *vendor_id = "";
 static char model_str[64];
+static char model_str_enc[256];
+static const char *product_id = "";
 static char serial_str[UTIL_NAME_SIZE];
+static char packed_if_str[UTIL_NAME_SIZE];
 static char revision_str[64];
 static char type_str[64];
 static char instance_str[64];
+static const char *ifnum;
+static const char *driver;
 
 static int use_usb_info;
 static int use_num_info;
 
-static void set_str(char *to, const char *from, size_t count)
-{
-       size_t i, j, len;
-
-       /* strip trailing whitespace */
-       len = strnlen(from, count);
-       while (len && isspace(from[len-1]))
-               len--;
-
-       /* strip leading whitespace */
-       i = 0;
-       while (isspace(from[i]) && (i < len))
-               i++;
-
-       j = 0;
-       while (i < len) {
-               /* substitute multiple whitespace */
-               if (isspace(from[i])) {
-                       while (isspace(from[i]))
-                               i++;
-                       to[j++] = '_';
-               }
-               /* Replace '/' with '.' */
-               if (from[i] == '/') {
-                       to[j++] = '.';
-                       i++;
-                       continue;
-               }
-               /* skip non-printable chars */
-               if (!isalnum(from[i]) && !ispunct(from[i])) {
-                       i++;
-                       continue;
-               }
-               to[j++] = from[i++];
-       }
-       to[j] = '\0';
-}
-
 static void set_usb_iftype(char *to, int if_class_num, size_t len)
 {
        char *type = "generic";
@@ -92,26 +63,40 @@ static void set_usb_iftype(char *to, int if_class_num, size_t len)
        case 1:
                type = "audio";
                break;
+       case 2: /* CDC-Control */
+               break;
        case 3:
                type = "hid";
                break;
+       case 5: /* Physical */
+               break;
+       case 6:
+               type = "media";
+               break;
        case 7:
                type = "printer";
                break;
        case 8:
                type = "storage";
                break;
-       case 2: /* CDC-Control */
-       case 5: /* Physical */
-       case 6: /* Image */
-       case 9: /* HUB */
+       case 9:
+               type = "hub";
+               break;
        case 0x0a: /* CDC-Data */
+               break;
        case 0x0b: /* Chip/Smart Card */
+               break;
        case 0x0d: /* Content Security */
-       case 0x0e: /* Video */
+               break;
+       case 0x0e:
+               type = "video";
+               break;
        case 0xdc: /* Diagnostic Device */
+               break;
        case 0xe0: /* Wireless Controller */
-       case 0xf2: /* Application-specific */
+               break;
+       case 0xfe: /* Application-specific */
+               break;
        case 0xff: /* Vendor-specific */
                break;
        default:
@@ -131,7 +116,7 @@ static int set_usb_mass_storage_ifsubtype(char *to, const char *from, size_t len
        if (eptr != from) {
                switch (type_num) {
                case 2:
-                       type = "cd";
+                       type = "atapi";
                        break;
                case 3:
                        type = "tape";
@@ -141,15 +126,16 @@ static int set_usb_mass_storage_ifsubtype(char *to, const char *from, size_t len
                        type = "floppy";
                        break;
                case 1: /* RBC devices */
+                       type = "rbc";
+                       break;
                case 6: /* Transparent SPC-2 devices */
-                       type = "disk";
+                       type = "scsi";
                        break;
                default:
                        break;
                }
        }
-       util_strlcpy(to, type, len);
-
+       util_strscpy(to, len, type);
        return type_num;
 }
 
@@ -181,14 +167,84 @@ static void set_scsi_type(char *to, const char *from, size_t len)
                        break;
                }
        }
-       util_strlcpy(to, type, len);
+       util_strscpy(to, len, type);
+}
+
+#define USB_DT_DEVICE                  0x01
+#define USB_DT_INTERFACE               0x04
+
+static int dev_if_packed_info(struct udev_device *dev, char *ifs_str, size_t len)
+{
+       char *filename = NULL;
+       int fd;
+       ssize_t size;
+       unsigned char buf[18 + 65535];
+       unsigned int pos, strpos;
+       struct usb_interface_descriptor {
+               u_int8_t        bLength;
+               u_int8_t        bDescriptorType;
+               u_int8_t        bInterfaceNumber;
+               u_int8_t        bAlternateSetting;
+               u_int8_t        bNumEndpoints;
+               u_int8_t        bInterfaceClass;
+               u_int8_t        bInterfaceSubClass;
+               u_int8_t        bInterfaceProtocol;
+               u_int8_t        iInterface;
+       } __attribute__((packed));
+       int err = 0;
+
+       if (asprintf(&filename, "%s/descriptors", udev_device_get_syspath(dev)) < 0) {
+               err = -1;
+               goto out;
+       }
+       fd = open(filename, O_RDONLY);
+       if (fd < 0) {
+               fprintf(stderr, "error opening USB device 'descriptors' file\n");
+               err = -1;
+               goto out;
+       }
+       size = read(fd, buf, sizeof(buf));
+       close(fd);
+       if (size < 18 || size == sizeof(buf)) {
+               err = -1;
+               goto out;
+       }
+
+       pos = 0;
+       strpos = 0;
+       while (pos < sizeof(buf) && strpos+7 < len) {
+               struct usb_interface_descriptor *desc;
+               char if_str[8];
+
+               desc = (struct usb_interface_descriptor *) &buf[pos];
+               if (desc->bLength < 3)
+                       break;
+               pos += desc->bLength;
+
+               if (desc->bDescriptorType != USB_DT_INTERFACE)
+                       continue;
+
+               if (snprintf(if_str, 8, "%02x%02x%02x:",
+                            desc->bInterfaceClass,
+                            desc->bInterfaceSubClass,
+                            desc->bInterfaceProtocol) != 7)
+                       continue;
+
+               if (strstr(ifs_str, if_str) != NULL)
+                       continue;
+
+               memcpy(&ifs_str[strpos], if_str, 8),
+               strpos += 7;
+       }
+out:
+       free(filename);
+       return err;
 }
 
 /*
  * A unique USB identification is generated like this:
  *
- * 1.) Get the USB device type from DeviceClass, InterfaceClass
- *     and InterfaceSubClass
+ * 1.) Get the USB device type from InterfaceClass and InterfaceSubClass
  * 2.) If the device type is 'Mass-Storage/SPC-2' or 'Mass-Storage/RBC'
  *     use the SCSI vendor and model as USB-Vendor and USB-model.
  * 3.) Otherwise use the USB manufacturer and product as
@@ -205,30 +261,42 @@ static void set_scsi_type(char *to, const char *from, size_t len)
 static int usb_id(struct udev_device *dev)
 {
        struct udev *udev = udev_device_get_udev(dev);
-       struct udev_device *dev_interface;
-       struct udev_device *dev_usb;
+       struct udev_device *dev_interface = NULL;
+       struct udev_device *dev_usb = NULL;
        const char *if_class, *if_subclass;
        int if_class_num;
        int protocol = 0;
 
        dbg(udev, "syspath %s\n", udev_device_get_syspath(dev));
 
+       /* shortcut, if we are called directly for a "usb_device" type */
+       if (udev_device_get_devtype(dev) != NULL && strcmp(udev_device_get_devtype(dev), "usb_device") == 0) {
+               dev_if_packed_info(dev, packed_if_str, sizeof(packed_if_str));
+               dev_usb = dev;
+               goto fallback;
+       }
+
        /* usb interface directory */
-       dev_interface = udev_device_get_parent_with_subsystem(dev, "usb");
+       dev_interface = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
        if (dev_interface == NULL) {
                info(udev, "unable to access usb_interface device of '%s'\n",
                     udev_device_get_syspath(dev));
                return 1;
        }
 
+       ifnum = udev_device_get_sysattr_value(dev_interface, "bInterfaceNumber");
+       driver = udev_device_get_sysattr_value(dev_interface, "driver");
+
        if_class = udev_device_get_sysattr_value(dev_interface, "bInterfaceClass");
        if (!if_class) {
                info(udev, "%s: cannot get bInterfaceClass attribute\n",
                     udev_device_get_sysname(dev));
                return 1;
        }
+
        if_class_num = strtoul(if_class, NULL, 16);
        if (if_class_num == 8) {
+               /* mass storage */
                if_subclass = udev_device_get_sysattr_value(dev_interface, "bInterfaceSubClass");
                if (if_subclass != NULL)
                        protocol = set_usb_mass_storage_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
@@ -240,21 +308,24 @@ static int usb_id(struct udev_device *dev)
             udev_device_get_syspath(dev_interface), if_class_num, protocol);
 
        /* usb device directory */
-       dev_usb = udev_device_get_parent_with_subsystem(dev_interface, "usb");
+       dev_usb = udev_device_get_parent_with_subsystem_devtype(dev_interface, "usb", "usb_device");
        if (!dev_usb) {
                info(udev, "unable to find parent 'usb' device of '%s'\n",
                     udev_device_get_syspath(dev));
                return 1;
        }
 
-       /* mass storage */
-       if (protocol == 6 && !use_usb_info) {
+       /* all interfaces of the device in a single string */
+       dev_if_packed_info(dev_usb, packed_if_str, sizeof(packed_if_str));
+
+       /* mass storage : SCSI or ATAPI */
+       if ((protocol == 6 || protocol == 2) && !use_usb_info) {
                struct udev_device *dev_scsi;
                const char *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
                int host, bus, target, lun;
 
                /* get scsi device */
-               dev_scsi = udev_device_get_parent_with_subsystem(dev, "scsi");
+               dev_scsi = udev_device_get_parent_with_subsystem_devtype(dev, "scsi", "scsi_device");
                if (dev_scsi == NULL) {
                        info(udev, "unable to find parent 'scsi' device of '%s'\n",
                             udev_device_get_syspath(dev));
@@ -272,7 +343,9 @@ static int usb_id(struct udev_device *dev)
                             udev_device_get_sysname(dev_scsi));
                        goto fallback;
                }
-               set_str(vendor_str, scsi_vendor, sizeof(vendor_str)-1);
+               udev_util_encode_string(scsi_vendor, vendor_str_enc, sizeof(vendor_str_enc));
+               udev_util_replace_whitespace(scsi_vendor, vendor_str, sizeof(vendor_str)-1);
+               udev_util_replace_chars(vendor_str, NULL);
 
                scsi_model = udev_device_get_sysattr_value(dev_scsi, "model");
                if (!scsi_model) {
@@ -280,7 +353,9 @@ static int usb_id(struct udev_device *dev)
                             udev_device_get_sysname(dev_scsi));
                        goto fallback;
                }
-               set_str(model_str, scsi_model, sizeof(model_str)-1);
+               udev_util_encode_string(scsi_model, model_str_enc, sizeof(model_str_enc));
+               udev_util_replace_whitespace(scsi_model, model_str, sizeof(model_str)-1);
+               udev_util_replace_chars(model_str, NULL);
 
                scsi_type = udev_device_get_sysattr_value(dev_scsi, "type");
                if (!scsi_type) {
@@ -296,7 +371,8 @@ static int usb_id(struct udev_device *dev)
                             udev_device_get_sysname(dev_scsi));
                        goto fallback;
                }
-               set_str(revision_str, scsi_rev, sizeof(revision_str)-1);
+               udev_util_replace_whitespace(scsi_rev, revision_str, sizeof(revision_str)-1);
+               udev_util_replace_chars(revision_str, NULL);
 
                /*
                 * some broken devices have the same identifiers
@@ -306,6 +382,9 @@ static int usb_id(struct udev_device *dev)
        }
 
 fallback:
+       vendor_id = udev_device_get_sysattr_value(dev_usb, "idVendor");
+       product_id = udev_device_get_sysattr_value(dev_usb, "idProduct");
+
        /* fallback to USB vendor & device */
        if (vendor_str[0] == '\0') {
                const char *usb_vendor = NULL;
@@ -314,13 +393,15 @@ fallback:
                        usb_vendor = udev_device_get_sysattr_value(dev_usb, "manufacturer");
 
                if (!usb_vendor)
-                       usb_vendor = udev_device_get_sysattr_value(dev_usb, "idVendor");
+                       usb_vendor = vendor_id;
 
                if (!usb_vendor) {
                        info(udev, "No USB vendor information available\n");
                        return 1;
                }
-               set_str(vendor_str, usb_vendor, sizeof(vendor_str)-1);
+               udev_util_encode_string(usb_vendor, vendor_str_enc, sizeof(vendor_str_enc));
+               udev_util_replace_whitespace(usb_vendor, vendor_str, sizeof(vendor_str)-1);
+               udev_util_replace_chars(vendor_str, NULL);
        }
 
        if (model_str[0] == '\0') {
@@ -330,29 +411,35 @@ fallback:
                        usb_model = udev_device_get_sysattr_value(dev_usb, "product");
 
                if (!usb_model)
-                       usb_model = udev_device_get_sysattr_value(dev_usb, "idProduct");
+                       usb_model = product_id;
 
                if (!usb_model) {
                        dbg(udev, "No USB model information available\n");
                        return 1;
                }
-               set_str(model_str, usb_model, sizeof(model_str)-1);
+               udev_util_encode_string(usb_model, model_str_enc, sizeof(model_str_enc));
+               udev_util_replace_whitespace(usb_model, model_str, sizeof(model_str)-1);
+               udev_util_replace_chars(model_str, NULL);
        }
 
        if (revision_str[0] == '\0') {
                const char *usb_rev;
 
                usb_rev = udev_device_get_sysattr_value(dev_usb, "bcdDevice");
-               if (usb_rev)
-                       set_str(revision_str, usb_rev, sizeof(revision_str)-1);
+               if (usb_rev) {
+                       udev_util_replace_whitespace(usb_rev, revision_str, sizeof(revision_str)-1);
+                       udev_util_replace_chars(revision_str, NULL);
+               }
        }
 
        if (serial_str[0] == '\0') {
                const char *usb_serial;
 
                usb_serial = udev_device_get_sysattr_value(dev_usb, "serial");
-               if (usb_serial)
-                       set_str(serial_str, usb_serial, sizeof(serial_str)-1);
+               if (usb_serial) {
+                       udev_util_replace_whitespace(usb_serial, serial_str, sizeof(serial_str)-1);
+                       udev_util_replace_chars(serial_str, NULL);
+               }
        }
        return 0;
 }
@@ -378,7 +465,7 @@ int main(int argc, char **argv)
        if (udev == NULL)
                goto exit;
 
-       logging_init("usb_id");
+       udev_log_init("usb_id");
        udev_set_log_fn(udev, log_fn);
 
        while (1) {
@@ -408,7 +495,7 @@ int main(int argc, char **argv)
                        printf("Usage: usb_id [--usb-info] [--num-info] [--export] [--help] <devpath>\n"
                               "  --usb-info  use usb strings instead\n"
                               "  --num-info  use numerical values\n"
-                              "  --export    print values as environemt keys\n"
+                              "  --export    print values as environment keys\n"
                               "  --help      print this help text\n\n");
                default:
                        retval = 1;
@@ -416,17 +503,14 @@ int main(int argc, char **argv)
                }
        }
 
-       devpath = getenv("DEVPATH");
-       if (devpath == NULL)
-               devpath = argv[optind];
+       devpath = argv[optind];
        if (devpath == NULL) {
                fprintf(stderr, "No device specified\n");
                retval = 1;
                goto exit;
        }
 
-       util_strlcpy(syspath, udev_get_sys_path(udev), sizeof(syspath));
-       util_strlcat(syspath, devpath, sizeof(syspath));
+       util_strscpyl(syspath, sizeof(syspath), udev_get_sys_path(udev), devpath, NULL);
        dev = udev_device_new_from_syspath(udev, syspath);
        if (dev == NULL) {
                err(udev, "unable to access '%s'\n", devpath);
@@ -436,30 +520,38 @@ int main(int argc, char **argv)
        retval = usb_id(dev);
        if (retval == 0) {
                char serial[256];
+               size_t l;
+               char *s;
 
-               util_strlcpy(serial, vendor_str, sizeof(serial));
-               util_strlcat(serial, "_", sizeof(serial));
-               util_strlcat(serial, model_str, sizeof(serial));
-               if (serial_str[0] != '\0') {
-                       util_strlcat(serial, "_", sizeof(serial));
-                       util_strlcat(serial, serial_str, sizeof(serial));
-               }
-               if (instance_str[0] != '\0') {
-                       util_strlcat(serial, "-", sizeof(serial));
-                       util_strlcat(serial, instance_str, sizeof(serial));
-               }
+               s = serial;
+               l = util_strpcpyl(&s, sizeof(serial), vendor_str, "_", model_str, NULL);
+               if (serial_str[0] != '\0')
+                       l = util_strpcpyl(&s, l, "_", serial_str, NULL);
+               if (instance_str[0] != '\0')
+                       util_strpcpyl(&s, l, "-", instance_str, NULL);
 
                if (export) {
                        printf("ID_VENDOR=%s\n", vendor_str);
+                       printf("ID_VENDOR_ENC=%s\n", vendor_str_enc);
+                       printf("ID_VENDOR_ID=%s\n", vendor_id);
                        printf("ID_MODEL=%s\n", model_str);
+                       printf("ID_MODEL_ENC=%s\n", model_str_enc);
+                       printf("ID_MODEL_ID=%s\n", product_id);
                        printf("ID_REVISION=%s\n", revision_str);
                        printf("ID_SERIAL=%s\n", serial);
                        if (serial_str[0] != '\0')
                                printf("ID_SERIAL_SHORT=%s\n", serial_str);
-                       printf("ID_TYPE=%s\n", type_str);
+                       if (type_str[0] != '\0')
+                               printf("ID_TYPE=%s\n", type_str);
                        if (instance_str[0] != '\0')
                                printf("ID_INSTANCE=%s\n", instance_str);
                        printf("ID_BUS=usb\n");
+                       if (packed_if_str[0] != '\0')
+                               printf("ID_USB_INTERFACES=:%s\n", packed_if_str);
+                       if (ifnum != NULL)
+                               printf("ID_USB_INTERFACE_NUM=%s\n", ifnum);
+                       if (driver != NULL)
+                               printf("ID_USB_DRIVER=%s\n", driver);
                } else
                        printf("%s\n", serial);
        }
@@ -467,6 +559,6 @@ int main(int argc, char **argv)
 exit:
        udev_device_unref(dev);
        udev_unref(udev);
-       logging_close();
+       udev_log_close();
        return retval;
 }