chiark / gitweb /
scsi_id, usb_id: request device parent by subsystem
[elogind.git] / extras / usb_id / usb_id.c
index 1eb45b911412ca28b0f27a3a7f132bc01dae2d55..62aa1506d7b4d3d6d1261b61cef43bae5754541a 100644 (file)
@@ -4,23 +4,13 @@
  * Identify an USB (block) device
  *
  * Copyright (c) 2005 SUSE Linux Products GmbH, Germany
+ *
  * Author:
  *     Hannes Reinecke <hare@suse.de>
  *
- *  This library is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU Lesser General Public License as
- *  published by the Free Software Foundation; either version 2.1 of the
- *  License, or (at your option) any later version.
- *
- *  This library is distributed in the hope that it will be useful, but
- *  WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- *  Lesser General Public License for more details.
- *
- *  You should have received a copy of the GNU Lesser General Public
- *  License along with this library; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- *  USA
+ *     This program is free software; you can redistribute it and/or modify it
+ *     under the terms of the GNU General Public License as published by the
+ *     Free Software Foundation version 2 of the License.
  */
 
 #include <stdio.h>
 #include <ctype.h>
 #include <errno.h>
 
-#include <../../libsysfs/sysfs/libsysfs.h>
-#include "../../udev_utils.h"
-#include "../../logging.h"
+#include "../../udev.h"
 
-#define        MAX_NAME_LEN                    72
-#define        MAX_SERIAL_LEN                  256
+#define MAX_PATH_LEN                   512
+#define MAX_SERIAL_LEN                 256
 #define BLKGETSIZE64 _IOR(0x12,114,size_t)
 
 #ifdef USE_LOG
@@ -64,7 +52,6 @@ void log_message(int priority, const char *format, ...)
 }
 #endif
 
-char sysfs_mnt_path[SYSFS_PATH_MAX];
 static char vendor_str[64];
 static char model_str[64];
 static char serial_str[MAX_SERIAL_LEN];
@@ -76,14 +63,13 @@ static int use_num_info;
 static int export;
 static int debug;
 
-static void set_str(char *to, const unsigned char *from, int count)
+static void set_str(char *to, const char *from, size_t count)
 {
-       int i, j;
-       int len;
+       size_t i, j, len;
 
        /* strip trailing whitespace */
        len = strnlen(from, count);
-       while (isspace(from[len-1]))
+       while (len && isspace(from[len-1]))
                len--;
 
        /* strip leading whitespace */
@@ -120,25 +106,26 @@ static void set_str(char *to, const unsigned char *from, int count)
  *
  * Set the type based on the USB interface class
  */
-static void set_usb_iftype(char *to, const char *from, int count)
+static void set_usb_iftype(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 1:
-                       sprintf(to, "audio");
+                       type = "audio";
                        break;
                case 3:
-                       sprintf(to, "hid");
+                       type = "hid";
                        break;
                case 7:
-                       sprintf(to, "printer");
+                       type = "printer";
                        break;
                case 8:
-                       sprintf(to, "disk");
+                       type = "disk";
                        break;
                case 2: /* CDC-Control */
                case 5: /* Physical */
@@ -153,12 +140,11 @@ static void set_usb_iftype(char *to, const char *from, int count)
                case 0xf2: /* Application-specific */
                case 0xff: /* Vendor-specific */
                default:
-                       sprintf(to, "generic");
                        break;
                }
-       } else {
-               sprintf(to, "generic");
        }
+       strncpy(to, type, len);
+       to[len-1] = '\0';
 }
 
 /*
@@ -167,32 +153,35 @@ static void set_usb_iftype(char *to, const char *from, int count)
  * 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, int count)
+static int set_usb_ifsubtype(char *to, const char *from, size_t len)
 {
        int type_num = 0;
        char *eptr;
+       char *type = "generic";
 
        type_num = strtoul(from, &eptr, 0);
        if (eptr != from) {
                switch (type_num) {
                case 2:
-                       sprintf(to, "cd");
+                       type = "cd";
                        break;
                case 3:
-                       sprintf(to, "tape");
+                       type = "tape";
                        break;
                case 4: /* UFI */
                case 5: /* SFF-8070i */
-                       sprintf(to, "floppy");
+                       type = "floppy";
                        break;
                case 1: /* RBC devices */
                case 6: /* Transparent SPC-2 devices */
-                       sprintf(to, "disk");
+                       type = "disk";
+                       break;
+               default:
                        break;
                }
-       } else {
-               sprintf(to, "generic");
        }
+       strncpy(to, type, len);
+       to[len-1] = '\0';
 
        return type_num;
 }
@@ -253,182 +242,169 @@ 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 *target_path)
+static int usb_id(const char *devpath)
 {
-       struct sysfs_class_device *class_dev; /* of target_path */
-       struct sysfs_class_device *class_dev_parent; /* for partitions */
-       struct sysfs_device *scsi_dev; /* the scsi_device */
-       struct sysfs_device *target_dev;
-       struct sysfs_device *host_dev, *interface_dev, *usb_dev;
-       struct sysfs_attribute *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
-       struct sysfs_attribute *usb_model = NULL, *usb_vendor = NULL, *usb_rev, *usb_serial;
-       struct sysfs_attribute *if_class, *if_subclass;
+       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;
 
-       class_dev = sysfs_open_class_device_path(target_path);
-       if (!class_dev) {
-               info("open class %s failed: %s", target_path, strerror(errno));
+       dbg("devpath %s\n", devpath);
+
+       dev = sysfs_device_get(devpath);
+       if (dev == NULL) {
+               err("unable to access '%s'", devpath);
                return 1;
        }
-       class_dev_parent = sysfs_get_classdev_parent(class_dev);
-       if (class_dev_parent) {
-               scsi_dev = sysfs_get_classdev_device(class_dev_parent);
-       } else {
-               scsi_dev = sysfs_get_classdev_device(class_dev);
-       }
 
-       /*
-        * The close of scsi_dev will close class_dev or class_dev_parent.
-        */
-
-       /*
-        * We assume we are called after the device is completely ready,
-        * so we don't have to loop here like udev. (And we are usually
-        * called via udev.)
-        */
-       if (!scsi_dev) {
-               /*
-                * errno is not set if we can't find the device link, so
-                * don't print it out here.
-                */
-               info("Cannot find sysfs device associated with %s", target_path);
+       /* 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;
        }
 
-       /*
-        * Allow only scsi devices.
-        *
-        * Other block devices can support SG IO, but only ide-cd does, so
-        * for now, don't bother with anything else.
-        */
-       if (strcmp(scsi_dev->bus, "scsi") != 0) {
-               info("%s is not a scsi device", target_path);
+       /* target directory */
+       dev_target = sysfs_device_get_parent(dev_scsi);
+       if (dev_target == NULL) {
+               err("unable to access parent device of '%s'", devpath);
                return 1;
        }
 
-       /* target directory */
-       target_dev = sysfs_get_device_parent(scsi_dev);
        /* host directory */
-       host_dev = sysfs_get_device_parent(target_dev);
+       dev_host = sysfs_device_get_parent(dev_target);
+       if (dev_host == NULL) {
+               err("unable to access parent device of '%s'", devpath);
+               return 1;
+       }
+
        /* usb interface directory */
-       interface_dev = sysfs_get_device_parent(host_dev);
-       /* usb device directory */
-       usb_dev = sysfs_get_device_parent(interface_dev);
+       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;
+       }
 
-       if (!strcmp(interface_dev->bus, "bus") != 0) {
-               info("%s is not an usb device", target_path);
+       /* 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);
                return 1;
        }
-       
-       if_class = sysfs_get_device_attr(interface_dev, "bInterfaceClass");
+
+       if_class = sysfs_attr_get_value(dev_interface->devpath, "bInterfaceClass");
        if (!if_class) {
-               info("%s: cannot get bInterfaceClass attribute", interface_dev->name);
+               info("%s: cannot get bInterfaceClass attribute", dev_interface->kernel_name);
                return 1;
        }
-       if_class_num = strtoul(if_class->value, NULL, 16);
+       if_class_num = strtoul(if_class, NULL, 16);
        if (if_class_num != 8) {
-               set_usb_iftype(type_str, if_class->value, sizeof(type_str) - 1);
+               set_usb_iftype(type_str, if_class, sizeof(type_str)-1);
                protocol = 0;
        } else {
-               if_subclass = sysfs_get_device_attr(interface_dev, 
-                                                   "bInterfaceSubClass");
-               protocol = set_usb_ifsubtype(type_str, if_subclass->value, 
-                                            sizeof(type_str) -1 );
+               if_subclass = sysfs_attr_get_value(dev_interface->devpath, "bInterfaceSubClass");
+               protocol = set_usb_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
        }
 
        if (!use_usb_info && protocol == 6) {
                /* Generic SPC-2 device */
-               scsi_vendor = sysfs_get_device_attr(scsi_dev, "vendor");
+               scsi_vendor = sysfs_attr_get_value(dev_scsi->devpath, "vendor");
                if (!scsi_vendor) {
-                       info("%s: cannot get SCSI vendor attribute", scsi_dev->name);
+                       info("%s: cannot get SCSI vendor attribute", dev_scsi->kernel_name);
                        return 1;
                }
-               set_str(vendor_str, scsi_vendor->value, sizeof(vendor_str)-1);
+               set_str(vendor_str, scsi_vendor, sizeof(vendor_str)-1);
 
-               scsi_model = sysfs_get_device_attr(scsi_dev, "model");
+               scsi_model = sysfs_attr_get_value(dev_scsi->devpath, "model");
                if (!scsi_model) {
-                       info("%s: cannot get SCSI model attribute", scsi_dev->name);
+                       info("%s: cannot get SCSI model attribute", dev_scsi->kernel_name);
                        return 1;
                }
-               set_str(model_str, scsi_model->value, sizeof(model_str)-1);
+               set_str(model_str, scsi_model, sizeof(model_str)-1);
 
-               scsi_type = sysfs_get_device_attr(scsi_dev, "type");
+               scsi_type = sysfs_attr_get_value(dev_scsi->devpath, "type");
                if (!scsi_type) {
-                       info("%s: cannot get SCSI type attribute", scsi_dev->name);
+                       info("%s: cannot get SCSI type attribute", dev_scsi->kernel_name);
                        return 1;
                }
-               set_scsi_type(type_str, scsi_type->value, sizeof(type_str)-1);
+               set_scsi_type(type_str, scsi_type, sizeof(type_str)-1);
 
-               scsi_rev = sysfs_get_device_attr(scsi_dev, "rev");
+               scsi_rev = sysfs_attr_get_value(dev_scsi->devpath, "rev");
                if (!scsi_rev) {
-                       info("%s: cannot get SCSI revision attribute", scsi_dev->name);
+                       info("%s: cannot get SCSI revision attribute", dev_scsi->kernel_name);
                        return 1;
                }
-               set_str(revision_str, scsi_rev->value, sizeof(revision_str)-1);
+               set_str(revision_str, scsi_rev, sizeof(revision_str)-1);
 
        }
 
        /* Fallback to USB vendor & device */
        if (vendor_str[0] == '\0') {
                if (!use_num_info)
-                       if (!(usb_vendor = sysfs_get_device_attr(usb_dev, "manufacturer")))
+                       if (!(usb_vendor = sysfs_attr_get_value(dev_usb->devpath, "manufacturer")))
                                dbg("No USB vendor string found, using idVendor");
 
                if (!usb_vendor) {
-                       if (!(usb_vendor = sysfs_get_device_attr(usb_dev, "idVendor"))) {
+                       if (!(usb_vendor = sysfs_attr_get_value(dev_usb->devpath, "idVendor"))) {
                                dbg("No USB vendor information available\n");
                                sprintf(vendor_str,"0000");
                        }
                }
-               set_str(vendor_str,usb_vendor->value, sizeof(vendor_str) - 1);
+               set_str(vendor_str,usb_vendor, sizeof(vendor_str) - 1);
        }
        
        if (model_str[0] == '\0') {
                if (!use_num_info)
-                       if (!(usb_model = sysfs_get_device_attr(usb_dev, "product")))
+                       if (!(usb_model = sysfs_attr_get_value(dev_usb->devpath, "product")))
                                dbg("No USB model string found, using idProduct");
                
                if (!usb_model) {
-                       if (!(usb_model = sysfs_get_device_attr(usb_dev, "idProduct"))) {
-                               dbg("No USB model information available\n");
-                               sprintf(model_str,"0000");
-                       }
+                       if (!(usb_model = sysfs_attr_get_value(dev_usb->devpath, "idProduct")))
+                               dbg("No USB model information available\n"); sprintf(model_str,"0000");
                }
-               set_str(model_str, usb_model->value, sizeof(model_str) - 1);
+               set_str(model_str, usb_model, sizeof(model_str) - 1);
        }
 
        if (revision_str[0] == '\0') {
-               usb_rev = sysfs_get_device_attr(usb_dev, "bcdDevice");
-               if (usb_rev) {
-                       set_str(revision_str, usb_rev->value, 
-                               sizeof(revision_str) - 1);
-               }
+               usb_rev = sysfs_attr_get_value(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_get_device_attr(usb_dev, "serial");
-               if (usb_serial) {
-                       set_str(serial_str, usb_serial->value,
-                               sizeof(serial_str) - 1);
-               }
+               usb_serial = sysfs_attr_get_value(dev_usb->devpath, "serial");
+               if (usb_serial)
+                       set_str(serial_str, usb_serial, sizeof(serial_str)-1);
        }
        return 0;
 }
 
 int main(int argc, char **argv)
 {
-       int retval;
-       char *devpath;
-       char target_path[MAX_NAME_LEN];
+       int retval = 0;
+       const char *env;
+       char devpath[MAX_PATH_LEN];
        int option;
 
+       logging_init("usb_id");
+       sysfs_init();
+
        dbg("argc is %d", argc);
-       if (sysfs_get_mnt_path(sysfs_mnt_path, MAX_NAME_LEN)) {
-               info("sysfs_get_mnt_path failed: %s",
-                       strerror(errno));
-               exit(1);
-       }
+
+       /* 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)
@@ -441,14 +417,14 @@ int main(int argc, char **argv)
                        debug = 1;
                        break;
                case 'n':
-                       use_num_info=1;
-                       use_usb_info=1;
+                       use_num_info = 1;
+                       use_usb_info = 1;
                        break;
                case 'u':
-                       use_usb_info=1;
+                       use_usb_info = 1;
                        break;
                case 'x':
-                       export=1;
+                       export = 1;
                        break;
                default:
                        info("Unknown or bad option '%c' (0x%x)", option, option);
@@ -457,20 +433,19 @@ int main(int argc, char **argv)
                }
        }
 
-       devpath = getenv("DEVPATH");
-       if (devpath) {
-               strncpy(target_path, sysfs_mnt_path, MAX_NAME_LEN);
-               strncat(target_path, devpath, MAX_NAME_LEN);
-       } else {
+       env = getenv("DEVPATH");
+       if (env != NULL)
+               strlcpy(devpath, env, sizeof(devpath));
+       else {
                if (optind == argc) {
                        fprintf(stderr, "No device specified\n");
-                       exit(1);
+                       retval = 1;
+                       goto exit;
                }
-               devpath = argv[optind];
-               strncpy(target_path, devpath, MAX_NAME_LEN);
+               strlcpy(devpath, argv[optind], sizeof(devpath));
        }
 
-       retval = usb_id(target_path);
+       retval = usb_id(devpath);
 
        if (retval == 0) {
                if (export) {
@@ -496,5 +471,9 @@ int main(int argc, char **argv)
                        }
                }
        }
-       exit(retval);
+
+exit:
+       sysfs_cleanup();
+       logging_close();
+       return retval;
 }