X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=extras%2Fusb_id%2Fusb_id.c;h=b412598d35a8ea56749f3a27dcbeeede1aa29259;hp=783d546b26288db78ba5c607820714a80da022e2;hb=9ab11b6258abe2c9c0420a70e5b21f3f341c82c5;hpb=f83cccb9798d6ce70c6cc39d2100794813b3615b diff --git a/extras/usb_id/usb_id.c b/extras/usb_id/usb_id.c index 783d546b2..b412598d3 100644 --- a/extras/usb_id/usb_id.c +++ b/extras/usb_id/usb_id.c @@ -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 * @@ -19,87 +17,43 @@ #include #include #include +#include #include +#include -#include "../../udev.h" +#include "libudev.h" +#include "libudev-private.h" -#define MAX_PATH_LEN 512 -#define MAX_SERIAL_LEN 256 -#define BLKGETSIZE64 _IOR(0x12,114,size_t) +int debug; -#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 (debug) { + fprintf(stderr, "%s: ", fn != NULL ? fn : file); + vfprintf(stderr, format, args); + } else { + vsyslog(priority, format, args); } - - if (priority > udev_log) - return; - - va_start(args, format); - vsyslog(priority, format, args); - va_end(args); } -#endif static char vendor_str[64]; +static char vendor_str_enc[256]; +static const char *vendor_id = ""; static char model_str[64]; -static char serial_str[MAX_SERIAL_LEN]; -static char revision_str[16]; -static char type_str[16]; +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 int export; -static int debug; - -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) { @@ -109,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 = "disk"; + type = "storage"; + break; + case 9: + type = "hub"; break; - case 2: /* CDC-Control */ - case 5: /* Physical */ - case 6: /* Image */ - case 9: /* HUB */ 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: @@ -148,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"; @@ -158,62 +126,125 @@ 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; } } - strncpy(to, type, len); - to[len-1] = '\0'; - + util_strscpy(to, len, type); 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"); } + 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 @@ -227,167 +258,228 @@ 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_device *dev) { - struct sysfs_device *dev; - 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; + struct udev *udev = udev_device_get_udev(dev); + 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("devpath %s\n", devpath); + dbg(udev, "syspath %s\n", udev_device_get_syspath(dev)); - /* get all usb specific information: dev_interface, if_class, dev_usb */ - dev = sysfs_device_get(devpath); - if (dev == NULL) { - err("unable to access '%s'", devpath); - return 1; + /* 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 = sysfs_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("unable to access usb_interface device of '%s'", devpath); + info(udev, "unable to access usb_interface device of '%s'\n", + udev_device_get_syspath(dev)); return 1; } - if_class = sysfs_attr_get_value(dev_interface->devpath, "bInterfaceClass"); + 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("%s: cannot get bInterfaceClass attribute", dev_interface->kernel_name); + 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) { - if_subclass = sysfs_attr_get_value(dev_interface->devpath, "bInterfaceSubClass"); + /* 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); - } else + } else { set_usb_iftype(type_str, if_class_num, sizeof(type_str)-1); + } - info("%s: if_class %d protocol %d\n", dev_interface->devpath, if_class_num, protocol); + info(udev, "%s: if_class %d protocol %d\n", + udev_device_get_syspath(dev_interface), if_class_num, protocol); /* usb device directory */ - dev_usb = sysfs_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("unable to find parent 'usb' device of '%s'", devpath); + 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) { - struct sysfs_device *dev_scsi; + /* 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 = sysfs_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("unable to find parent 'scsi' device of '%s'", devpath); + info(udev, "unable to find parent 'scsi' device of '%s'\n", + udev_device_get_syspath(dev)); + goto fallback; + } + if (sscanf(udev_device_get_sysname(dev_scsi), "%d:%d:%d:%d", &host, &bus, &target, &lun) != 4) { + info(udev, "invalid scsi device '%s'\n", udev_device_get_sysname(dev_scsi)); goto fallback; } /* Generic SPC-2 device */ - scsi_vendor = sysfs_attr_get_value(dev_scsi->devpath, "vendor"); + scsi_vendor = udev_device_get_sysattr_value(dev_scsi, "vendor"); if (!scsi_vendor) { - info("%s: cannot get SCSI vendor attribute", dev_scsi->kernel_name); + info(udev, "%s: cannot get SCSI vendor attribute\n", + 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 = sysfs_attr_get_value(dev_scsi->devpath, "model"); + scsi_model = udev_device_get_sysattr_value(dev_scsi, "model"); if (!scsi_model) { - info("%s: cannot get SCSI model attribute", dev_scsi->kernel_name); + info(udev, "%s: cannot get SCSI model attribute\n", + 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 = sysfs_attr_get_value(dev_scsi->devpath, "type"); + scsi_type = udev_device_get_sysattr_value(dev_scsi, "type"); if (!scsi_type) { - info("%s: cannot get SCSI type attribute", dev_scsi->kernel_name); + info(udev, "%s: cannot get SCSI type attribute\n", + udev_device_get_sysname(dev_scsi)); 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 = udev_device_get_sysattr_value(dev_scsi, "rev"); if (!scsi_rev) { - info("%s: cannot get SCSI revision attribute", dev_scsi->kernel_name); + info(udev, "%s: cannot get SCSI revision attribute\n", + 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 + * for all luns, export the target:lun number + */ + sprintf(instance_str, "%d:%d", target, lun); } fallback: - /* Fallback to USB vendor & device */ + 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; + 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 = udev_device_get_sysattr_value(dev_usb, "manufacturer"); + + if (!usb_vendor) + usb_vendor = vendor_id; 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); + 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') { + 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 = udev_device_get_sysattr_value(dev_usb, "product"); + + if (!usb_model) + usb_model = product_id; + 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(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') { - usb_rev = sysfs_attr_get_value(dev_usb->devpath, "bcdDevice"); - if (usb_rev) - set_str(revision_str, usb_rev, sizeof(revision_str)-1); + const char *usb_rev; + + usb_rev = udev_device_get_sysattr_value(dev_usb, "bcdDevice"); + 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') { - usb_serial = sysfs_attr_get_value(dev_usb->devpath, "serial"); - if (usb_serial) - set_str(serial_str, usb_serial, sizeof(serial_str)-1); + const char *usb_serial; + + usb_serial = udev_device_get_sysattr_value(dev_usb, "serial"); + if (usb_serial) { + udev_util_replace_whitespace(usb_serial, serial_str, sizeof(serial_str)-1); + udev_util_replace_chars(serial_str, NULL); + } } return 0; } int main(int argc, char **argv) { + static const struct option options[] = { + { "usb-info", no_argument, NULL, 'u' }, + { "num-info", no_argument, NULL, 'n' }, + { "export", no_argument, NULL, 'x' }, + { "debug", no_argument, NULL, 'd' }, + { "help", no_argument, NULL, 'h' }, + {} + }; + struct udev *udev; + struct udev_device *dev = NULL; + char syspath[UTIL_PATH_SIZE]; + const char *devpath; + static int export; int retval = 0; - const char *env; - char devpath[MAX_PATH_LEN]; - int option; - logging_init("usb_id"); - sysfs_init(); + udev = udev_new(); + if (udev == NULL) + goto exit; - dbg("argc is %d", argc); + udev_log_init("usb_id"); + udev_set_log_fn(udev, log_fn); - /* 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 (1) { + int option; - 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, "dnuxh", options, NULL); + if (option == -1) + break; switch (option) { case 'd': debug = 1; + if (udev_get_log_priority(udev) < LOG_INFO) + udev_set_log_priority(udev, LOG_INFO); break; case 'n': use_num_info = 1; @@ -399,54 +491,74 @@ int main(int argc, char **argv) case 'x': export = 1; break; + case 'h': + printf("Usage: usb_id [--usb-info] [--num-info] [--export] [--help] \n" + " --usb-info use usb strings instead\n" + " --num-info use numerical values\n" + " --export print values as environment 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; } } - env = getenv("DEVPATH"); - if (env != NULL) - strlcpy(devpath, env, sizeof(devpath)); - else { - if (optind == argc) { - fprintf(stderr, "No device specified\n"); - retval = 1; - goto exit; - } - strlcpy(devpath, argv[optind], sizeof(devpath)); + devpath = argv[optind]; + if (devpath == NULL) { + fprintf(stderr, "No device specified\n"); + retval = 1; + goto exit; } - retval = usb_id(devpath); + 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); + return 1; + } + retval = usb_id(dev); if (retval == 0) { + char serial[256]; + size_t l; + char *s; + + 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); - 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_TYPE=%s\n", type_str); + printf("ID_SERIAL=%s\n", serial); + if (serial_str[0] != '\0') + printf("ID_SERIAL_SHORT=%s\n", serial_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"); - } 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); - } - } + 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); } exit: - sysfs_cleanup(); - logging_close(); + udev_device_unref(dev); + udev_unref(udev); + udev_log_close(); return retval; }