chiark / gitweb /
use libudev code, unify logging, pass udev context around everywhere
[elogind.git] / extras / usb_id / usb_id.c
index 62aa1506d7b4d3d6d1261b61cef43bae5754541a..fb4c28ac3eecdd2c36c3209fdb8cccd5e893cd29 100644 (file)
@@ -1,7 +1,5 @@
 /*
- * usb_id.c
- *
- * Identify an USB (block) device
+ * usb_id - identify an USB device
  *
  * Copyright (c) 2005 SUSE Linux Products GmbH, Germany
  *
@@ -13,6 +11,8 @@
  *     Free Software Foundation version 2 of the License.
  */
 
+#include <config.h>
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdarg.h>
 #include <string.h>
 #include <ctype.h>
 #include <errno.h>
+#include <getopt.h>
 
-#include "../../udev.h"
+#include "../../udev/udev.h"
 
 #define MAX_PATH_LEN                   512
 #define MAX_SERIAL_LEN                 256
 #define BLKGETSIZE64 _IOR(0x12,114,size_t)
 
-#ifdef USE_LOG
-void log_message(int priority, const char *format, ...)
+static void log_fn(struct udev *udev, int priority,
+                  const char *file, int line, const char *fn,
+                  const char *format, va_list args)
 {
-       va_list args;
-       static int udev_log = -1;
-
-       if (udev_log == -1) {
-               const char *value;
-
-               value = getenv("UDEV_LOG");
-               if (value)
-                       udev_log = log_priority(value);
-               else
-                       udev_log = LOG_ERR;
-       }
-
-       if (priority > udev_log)
-               return;
-
-       va_start(args, format);
        vsyslog(priority, format, args);
-       va_end(args);
 }
-#endif
 
 static char vendor_str[64];
 static char model_str[64];
 static char serial_str[MAX_SERIAL_LEN];
-static char revision_str[16];
-static char type_str[16];
+static char revision_str[64];
+static char type_str[64];
+static char instance_str[64];
 
 static int use_usb_info;
 static int use_num_info;
-static int export;
-static int debug;
 
 static void set_str(char *to, const char *from, size_t count)
 {
@@ -101,59 +83,44 @@ static void set_str(char *to, const char *from, size_t count)
        to[j] = '\0';
 }
 
-/*
- * set_usb_iftype
- *
- * Set the type based on the USB interface class
- */
-static void set_usb_iftype(char *to, const char *from, size_t len)
+static void set_usb_iftype(char *to, int if_class_num, size_t len)
 {
-       int type_num;
-       char *eptr;
        char *type = "generic";
 
-       type_num = strtoul(from, &eptr, 0);
-       if (eptr != from) {
-               switch (type_num) {
-               case 1:
-                       type = "audio";
-                       break;
-               case 3:
-                       type = "hid";
-                       break;
-               case 7:
-                       type = "printer";
-                       break;
-               case 8:
-                       type = "disk";
-                       break;
-               case 2: /* CDC-Control */
-               case 5: /* Physical */
-               case 6: /* Image */
-               case 9: /* HUB */
-               case 0x0a: /* CDC-Data */
-               case 0x0b: /* Chip/Smart Card */
-               case 0x0d: /* Content Security */
-               case 0x0e: /* Video */
-               case 0xdc: /* Diagnostic Device */
-               case 0xe0: /* Wireless Controller */
-               case 0xf2: /* Application-specific */
-               case 0xff: /* Vendor-specific */
-               default:
-                       break;
-               }
+       switch (if_class_num) {
+       case 1:
+               type = "audio";
+               break;
+       case 3:
+               type = "hid";
+               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 0x0a: /* CDC-Data */
+       case 0x0b: /* Chip/Smart Card */
+       case 0x0d: /* Content Security */
+       case 0x0e: /* Video */
+       case 0xdc: /* Diagnostic Device */
+       case 0xe0: /* Wireless Controller */
+       case 0xf2: /* Application-specific */
+       case 0xff: /* Vendor-specific */
+               break;
+       default:
+               break;
        }
        strncpy(to, type, len);
        to[len-1] = '\0';
 }
 
-/*
- * set_usb_ifsybtype
- *
- * Set the type base on the interfaceSubClass.
- * Valid for Mass-Storage devices (type 8) only.
- */
-static int set_usb_ifsubtype(char *to, const char *from, size_t len)
+static int set_usb_mass_storage_ifsubtype(char *to, const char *from, size_t len)
 {
        int type_num = 0;
        char *eptr;
@@ -180,48 +147,40 @@ static int set_usb_ifsubtype(char *to, const char *from, size_t len)
                        break;
                }
        }
-       strncpy(to, type, len);
-       to[len-1] = '\0';
+       strlcpy(to, type, len);
 
        return type_num;
 }
 
-static void set_scsi_type(char *to, const char *from, int count)
+static void set_scsi_type(char *to, const char *from, size_t len)
 {
        int type_num;
        char *eptr;
+       char *type = "generic";
 
        type_num = strtoul(from, &eptr, 0);
        if (eptr != from) {
                switch (type_num) {
                case 0:
-                       sprintf(to, "disk");
+               case 0xe:
+                       type = "disk";
                        break;
                case 1:
-                       sprintf(to, "tape");
+                       type = "tape";
                        break;
                case 4:
-                       sprintf(to, "optical");
-                       break;
-               case 5:
-                       sprintf(to, "cd");
-                       break;
                case 7:
-                       sprintf(to, "optical");
-                       break;
-               case 0xe:
-                       sprintf(to, "disk");
-                       break;
                case 0xf:
-                       sprintf(to, "optical");
+                       type = "optical";
+                       break;
+               case 5:
+                       type = "cd";
                        break;
                default:
-                       sprintf(to, "generic");
                        break;
                }
-       } else {
-               sprintf(to, "generic");
        }
+       strlcpy(to, type, len);
 }
 
 /*
@@ -242,144 +201,152 @@ static void set_scsi_type(char *to, const char *from, int count)
  * 6.) If the device supplies a serial number, this number
  *     is concatenated with the identification with an underscore '_'.
  */
-static int usb_id(const char *devpath)
+static int usb_id(struct udev *udev, const char *devpath)
 {
        struct sysfs_device *dev;
-       struct sysfs_device *dev_scsi;
-       struct sysfs_device *dev_target;
-       struct sysfs_device *dev_host;
        struct sysfs_device *dev_interface;
        struct sysfs_device *dev_usb;
-       const char *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
-       const char *usb_model = NULL, *usb_vendor = NULL, *usb_rev, *usb_serial;
        const char *if_class, *if_subclass;
        int if_class_num;
        int protocol = 0;
 
        dbg("devpath %s\n", devpath);
 
-       dev = sysfs_device_get(devpath);
+       /* get all usb specific information: dev_interface, if_class, dev_usb */
+       dev = sysfs_device_get(udev, devpath);
        if (dev == NULL) {
-               err("unable to access '%s'", devpath);
+               err(udev, "unable to access '%s'\n", devpath);
                return 1;
        }
 
-       /* get scsi parent device */
-       dev_scsi = sysfs_device_get_parent_with_subsystem(dev, "scsi");
-       if (dev_scsi == NULL) {
-               err("unable to find parent 'scsi' device of '%s'", devpath);
-               return 1;
-       }
-
-       /* target directory */
-       dev_target = sysfs_device_get_parent(dev_scsi);
-       if (dev_target == NULL) {
-               err("unable to access parent device of '%s'", devpath);
+       /* usb interface directory */
+       dev_interface = sysfs_device_get_parent_with_subsystem(udev, dev, "usb");
+       if (dev_interface == NULL) {
+               info(udev, "unable to access usb_interface device of '%s'\n", devpath);
                return 1;
        }
 
-       /* host directory */
-       dev_host = sysfs_device_get_parent(dev_target);
-       if (dev_host == NULL) {
-               err("unable to access parent device of '%s'", devpath);
+       if_class = sysfs_attr_get_value(udev, dev_interface->devpath, "bInterfaceClass");
+       if (!if_class) {
+               info(udev, "%s: cannot get bInterfaceClass attribute\n", dev_interface->kernel);
                return 1;
        }
+       if_class_num = strtoul(if_class, NULL, 16);
+       if (if_class_num == 8) {
+               if_subclass = sysfs_attr_get_value(udev, dev_interface->devpath, "bInterfaceSubClass");
+               if (if_subclass != NULL)
+                       protocol = set_usb_mass_storage_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
+       } else
+               set_usb_iftype(type_str, if_class_num, sizeof(type_str)-1);
 
-       /* usb interface directory */
-       dev_interface = sysfs_device_get_parent_with_subsystem(dev_host, "usb");
-       if (dev_interface == NULL) {
-               err("unable to access parent device of '%s'", devpath);
-               return 1;
-       }
+       info(udev, "%s: if_class %d protocol %d\n", dev_interface->devpath, if_class_num, protocol);
 
        /* usb device directory */
-       dev_usb = sysfs_device_get_parent_with_subsystem(dev_interface, "usb");
-       if (dev_usb == NULL) {
-               err("unable to find parent 'usb' device of '%s'", devpath);
+       dev_usb = sysfs_device_get_parent_with_subsystem(udev, dev_interface, "usb");
+       if (!dev_usb) {
+               info(udev, "unable to find parent 'usb' device of '%s'\n", devpath);
                return 1;
        }
 
-       if_class = sysfs_attr_get_value(dev_interface->devpath, "bInterfaceClass");
-       if (!if_class) {
-               info("%s: cannot get bInterfaceClass attribute", dev_interface->kernel_name);
-               return 1;
-       }
-       if_class_num = strtoul(if_class, NULL, 16);
-       if (if_class_num != 8) {
-               set_usb_iftype(type_str, if_class, sizeof(type_str)-1);
-               protocol = 0;
-       } else {
-               if_subclass = sysfs_attr_get_value(dev_interface->devpath, "bInterfaceSubClass");
-               protocol = set_usb_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
-       }
+       /* mass storage */
+       if (protocol == 6 && !use_usb_info) {
+               struct sysfs_device *dev_scsi;
+               const char *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
+               int host, bus, target, lun;
+
+               /* get scsi device */
+               dev_scsi = sysfs_device_get_parent_with_subsystem(udev, dev, "scsi");
+               if (dev_scsi == NULL) {
+                       info(udev, "unable to find parent 'scsi' device of '%s'\n", devpath);
+                       goto fallback;
+               }
+               if (sscanf(dev_scsi->kernel, "%d:%d:%d:%d", &host, &bus, &target, &lun) != 4) {
+                       info(udev, "invalid scsi device '%s'\n", dev_scsi->kernel);
+                       goto fallback;
+               }
 
-       if (!use_usb_info && protocol == 6) {
                /* Generic SPC-2 device */
-               scsi_vendor = sysfs_attr_get_value(dev_scsi->devpath, "vendor");
+               scsi_vendor = sysfs_attr_get_value(udev, dev_scsi->devpath, "vendor");
                if (!scsi_vendor) {
-                       info("%s: cannot get SCSI vendor attribute", dev_scsi->kernel_name);
-                       return 1;
+                       info(udev, "%s: cannot get SCSI vendor attribute\n", dev_scsi->kernel);
+                       goto fallback;
                }
                set_str(vendor_str, scsi_vendor, sizeof(vendor_str)-1);
 
-               scsi_model = sysfs_attr_get_value(dev_scsi->devpath, "model");
+               scsi_model = sysfs_attr_get_value(udev, dev_scsi->devpath, "model");
                if (!scsi_model) {
-                       info("%s: cannot get SCSI model attribute", dev_scsi->kernel_name);
-                       return 1;
+                       info(udev, "%s: cannot get SCSI model attribute\n", dev_scsi->kernel);
+                       goto fallback;
                }
                set_str(model_str, scsi_model, sizeof(model_str)-1);
 
-               scsi_type = sysfs_attr_get_value(dev_scsi->devpath, "type");
+               scsi_type = sysfs_attr_get_value(udev, dev_scsi->devpath, "type");
                if (!scsi_type) {
-                       info("%s: cannot get SCSI type attribute", dev_scsi->kernel_name);
-                       return 1;
+                       info(udev, "%s: cannot get SCSI type attribute\n", dev_scsi->kernel);
+                       goto fallback;
                }
                set_scsi_type(type_str, scsi_type, sizeof(type_str)-1);
 
-               scsi_rev = sysfs_attr_get_value(dev_scsi->devpath, "rev");
+               scsi_rev = sysfs_attr_get_value(udev, dev_scsi->devpath, "rev");
                if (!scsi_rev) {
-                       info("%s: cannot get SCSI revision attribute", dev_scsi->kernel_name);
-                       return 1;
+                       info(udev, "%s: cannot get SCSI revision attribute\n", dev_scsi->kernel);
+                       goto fallback;
                }
                set_str(revision_str, scsi_rev, sizeof(revision_str)-1);
 
+               /*
+                * some broken devices have the same identifiers
+                * for all luns, export the target:lun number
+                */
+               sprintf(instance_str, "%d:%d", target, lun);
        }
 
-       /* Fallback to USB vendor & device */
+fallback:
+       /* fallback to USB vendor & device */
        if (vendor_str[0] == '\0') {
+               const char *usb_vendor = NULL;
+
                if (!use_num_info)
-                       if (!(usb_vendor = sysfs_attr_get_value(dev_usb->devpath, "manufacturer")))
-                               dbg("No USB vendor string found, using idVendor");
+                       usb_vendor = sysfs_attr_get_value(udev, dev_usb->devpath, "manufacturer");
+
+               if (!usb_vendor)
+                       usb_vendor = sysfs_attr_get_value(udev, dev_usb->devpath, "idVendor");
 
                if (!usb_vendor) {
-                       if (!(usb_vendor = sysfs_attr_get_value(dev_usb->devpath, "idVendor"))) {
-                               dbg("No USB vendor information available\n");
-                               sprintf(vendor_str,"0000");
-                       }
+                       info(udev, "No USB vendor information available\n");
+                       return 1;
                }
-               set_str(vendor_str,usb_vendor, sizeof(vendor_str) - 1);
+               set_str(vendor_str, usb_vendor, sizeof(vendor_str)-1);
        }
-       
+
        if (model_str[0] == '\0') {
+               const char *usb_model = NULL;
+
                if (!use_num_info)
-                       if (!(usb_model = sysfs_attr_get_value(dev_usb->devpath, "product")))
-                               dbg("No USB model string found, using idProduct");
-               
+                       usb_model = sysfs_attr_get_value(udev, dev_usb->devpath, "product");
+
+               if (!usb_model)
+                       usb_model = sysfs_attr_get_value(udev, dev_usb->devpath, "idProduct");
+
                if (!usb_model) {
-                       if (!(usb_model = sysfs_attr_get_value(dev_usb->devpath, "idProduct")))
-                               dbg("No USB model information available\n"); sprintf(model_str,"0000");
+                       dbg("No USB model information available\n");
+                       return 1;
                }
-               set_str(model_str, usb_model, sizeof(model_str) - 1);
+               set_str(model_str, usb_model, sizeof(model_str)-1);
        }
 
        if (revision_str[0] == '\0') {
-               usb_rev = sysfs_attr_get_value(dev_usb->devpath, "bcdDevice");
+               const char *usb_rev;
+
+               usb_rev = sysfs_attr_get_value(udev, dev_usb->devpath, "bcdDevice");
                if (usb_rev)
                        set_str(revision_str, usb_rev, sizeof(revision_str)-1);
        }
 
        if (serial_str[0] == '\0') {
-               usb_serial = sysfs_attr_get_value(dev_usb->devpath, "serial");
+               const char *usb_serial;
+
+               usb_serial = sysfs_attr_get_value(udev, dev_usb->devpath, "serial");
                if (usb_serial)
                        set_str(serial_str, usb_serial, sizeof(serial_str)-1);
        }
@@ -388,34 +355,35 @@ static int usb_id(const char *devpath)
 
 int main(int argc, char **argv)
 {
+       struct udev *udev;
        int retval = 0;
        const char *env;
        char devpath[MAX_PATH_LEN];
-       int option;
+       static int export;
+       static const struct option options[] = {
+               { "usb-info", 0, NULL, 'u' },
+               { "num-info", 0, NULL, 'n' },
+               { "export", 0, NULL, 'x' },
+               { "help", 0, NULL, 'h' },
+               {}
+       };
+
+       udev = udev_new();
+       if (udev == NULL)
+               goto exit;
 
        logging_init("usb_id");
+       udev_set_log_fn(udev, log_fn);
        sysfs_init();
 
-       dbg("argc is %d", argc);
+       while (1) {
+               int option;
 
-       /* sysfs path can be overridden for testing */
-       env = getenv("SYSFS_PATH");
-       if (env) {
-               strlcpy(sysfs_path, env, sizeof(sysfs_path));
-               remove_trailing_chars(sysfs_path, '/');
-       } else
-               strcpy(sysfs_path, "/sys");
-
-       while ((option = getopt(argc, argv, "dnux")) != -1 ) {
-               if (optarg)
-                       dbg("option '%c' arg '%s'", option, optarg);
-               else
-                       dbg("option '%c'", option);
+               option = getopt_long(argc, argv, "nuxh", options, NULL);
+               if (option == -1)
+                       break;
 
                switch (option) {
-               case 'd':
-                       debug = 1;
-                       break;
                case 'n':
                        use_num_info = 1;
                        use_usb_info = 1;
@@ -426,10 +394,15 @@ int main(int argc, char **argv)
                case 'x':
                        export = 1;
                        break;
+               case 'h':
+                       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"
+                              "  --help      print this help text\n\n");
                default:
-                       info("Unknown or bad option '%c' (0x%x)", option, option);
                        retval = 1;
-                       break;
+                       goto exit;
                }
        }
 
@@ -437,7 +410,7 @@ int main(int argc, char **argv)
        if (env != NULL)
                strlcpy(devpath, env, sizeof(devpath));
        else {
-               if (optind == argc) {
+               if (argv[optind] == NULL) {
                        fprintf(stderr, "No device specified\n");
                        retval = 1;
                        goto exit;
@@ -445,34 +418,40 @@ int main(int argc, char **argv)
                strlcpy(devpath, argv[optind], sizeof(devpath));
        }
 
-       retval = usb_id(devpath);
+       retval = usb_id(udev, devpath);
 
        if (retval == 0) {
+               char serial[256];
+
+               strlcpy(serial, vendor_str, sizeof(serial));
+               strlcat(serial, "_", sizeof(serial));
+               strlcat(serial, model_str, sizeof(serial));
+               if (serial_str[0] != '\0') {
+                       strlcat(serial, "_", sizeof(serial));
+                       strlcat(serial, serial_str, sizeof(serial));
+               }
+               if (instance_str[0] != '\0') {
+                       strlcat(serial, "-", sizeof(serial));
+                       strlcat(serial, instance_str, sizeof(serial));
+               }
+
                if (export) {
                        printf("ID_VENDOR=%s\n", vendor_str);
                        printf("ID_MODEL=%s\n", model_str);
                        printf("ID_REVISION=%s\n", revision_str);
-                       if (serial_str[0] == '\0') {
-                               printf("ID_SERIAL=%s_%s\n", 
-                                      vendor_str, model_str);
-                       } else {
-                               printf("ID_SERIAL=%s_%s_%s\n", 
-                                      vendor_str, model_str, serial_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 (instance_str[0] != '\0')
+                               printf("ID_INSTANCE=%s\n", instance_str);
                        printf("ID_BUS=usb\n");
-               } else {
-                       if (serial_str[0] == '\0') {
-                               printf("%s_%s\n", 
-                                      vendor_str, model_str);
-                       } else {
-                               printf("%s_%s_%s\n", 
-                                      vendor_str, model_str, serial_str);
-                       }
-               }
+               } else
+                       printf("%s\n", serial);
        }
 
 exit:
+       udev_unref(udev);
        sysfs_cleanup();
        logging_close();
        return retval;