extras/usb_id/usb_id.c

   1 /*
   2  * usb_id - identify an USB device
   3  *
   4  * Copyright (c) 2005 SUSE Linux Products GmbH, Germany
   5  *
   6  * Author:
   7  *      Hannes Reinecke <hare@suse.de>
   8  *
   9  *      This program is free software; you can redistribute it and/or modify it
  10  *      under the terms of the GNU General Public License as published by the
  11  *      Free Software Foundation version 2 of the License.
  12  */
  13
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <stdarg.h>
  17 #include <unistd.h>
  18 #include <string.h>
  19 #include <ctype.h>
  20 #include <errno.h>
  21 #include <getopt.h>
  22
  23 #include "../../udev/udev.h"
  24
  25 int debug;
  26
  27 static void log_fn(struct udev *udev, int priority,
  28                    const char *file, int line, const char *fn,
  29                    const char *format, va_list args)
  30 {
  31         if (debug) {
  32                 fprintf(stderr, "%s: ", fn != NULL ? fn : file);
  33                 vfprintf(stderr, format, args);
  34         } else {
  35                 vsyslog(priority, format, args);
  36         }
  37 }
  38
  39 static char vendor_str[64];
  40 static char model_str[64];
  41 static char serial_str[UTIL_NAME_SIZE];
  42 static char revision_str[64];
  43 static char type_str[64];
  44 static char instance_str[64];
  45
  46 static int use_usb_info;
  47 static int use_num_info;
  48
  49 static void set_str(char *to, const char *from, size_t count)
  50 {
  51         size_t i, j, len;
  52
  53         /* strip trailing whitespace */
  54         len = strnlen(from, count);
  55         while (len && isspace(from[len-1]))
  56                 len--;
  57
  58         /* strip leading whitespace */
  59         i = 0;
  60         while (isspace(from[i]) && (i < len))
  61                 i++;
  62
  63         j = 0;
  64         while (i < len) {
  65                 /* substitute multiple whitespace */
  66                 if (isspace(from[i])) {
  67                         while (isspace(from[i]))
  68                                 i++;
  69                         to[j++] = '_';
  70                 }
  71                 /* Replace '/' with '.' */
  72                 if (from[i] == '/') {
  73                         to[j++] = '.';
  74                         i++;
  75                         continue;
  76                 }
  77                 /* skip non-printable chars */
  78                 if (!isalnum(from[i]) && !ispunct(from[i])) {
  79                         i++;
  80                         continue;
  81                 }
  82                 to[j++] = from[i++];
  83         }
  84         to[j] = '\0';
  85 }
  86
  87 static void set_usb_iftype(char *to, int if_class_num, size_t len)
  88 {
  89         char *type = "generic";
  90
  91         switch (if_class_num) {
  92         case 1:
  93                 type = "audio";
  94                 break;
  95         case 3:
  96                 type = "hid";
  97                 break;
  98         case 7:
  99                 type = "printer";
 100                 break;
 101         case 8:
 102                 type = "storage";
 103                 break;
 104         case 2: /* CDC-Control */
 105         case 5: /* Physical */
 106         case 6: /* Image */
 107         case 9: /* HUB */
 108         case 0x0a: /* CDC-Data */
 109         case 0x0b: /* Chip/Smart Card */
 110         case 0x0d: /* Content Security */
 111         case 0x0e: /* Video */
 112         case 0xdc: /* Diagnostic Device */
 113         case 0xe0: /* Wireless Controller */
 114         case 0xf2: /* Application-specific */
 115         case 0xff: /* Vendor-specific */
 116                 break;
 117         default:
 118                 break;
 119         }
 120         strncpy(to, type, len);
 121         to[len-1] = '\0';
 122 }
 123
 124 static int set_usb_mass_storage_ifsubtype(char *to, const char *from, size_t len)
 125 {
 126         int type_num = 0;
 127         char *eptr;
 128         char *type = "generic";
 129
 130         type_num = strtoul(from, &eptr, 0);
 131         if (eptr != from) {
 132                 switch (type_num) {
 133                 case 2:
 134                         type = "cd";
 135                         break;
 136                 case 3:
 137                         type = "tape";
 138                         break;
 139                 case 4: /* UFI */
 140                 case 5: /* SFF-8070i */
 141                         type = "floppy";
 142                         break;
 143                 case 1: /* RBC devices */
 144                 case 6: /* Transparent SPC-2 devices */
 145                         type = "disk";
 146                         break;
 147                 default:
 148                         break;
 149                 }
 150         }
 151         util_strlcpy(to, type, len);
 152
 153         return type_num;
 154 }
 155
 156 static void set_scsi_type(char *to, const char *from, size_t len)
 157 {
 158         int type_num;
 159         char *eptr;
 160         char *type = "generic";
 161
 162         type_num = strtoul(from, &eptr, 0);
 163         if (eptr != from) {
 164                 switch (type_num) {
 165                 case 0:
 166                 case 0xe:
 167                         type = "disk";
 168                         break;
 169                 case 1:
 170                         type = "tape";
 171                         break;
 172                 case 4:
 173                 case 7:
 174                 case 0xf:
 175                         type = "optical";
 176                         break;
 177                 case 5:
 178                         type = "cd";
 179                         break;
 180                 default:
 181                         break;
 182                 }
 183         }
 184         util_strlcpy(to, type, len);
 185 }
 186
 187 /*
 188  * A unique USB identification is generated like this:
 189  *
 190  * 1.) Get the USB device type from DeviceClass, InterfaceClass
 191  *     and InterfaceSubClass
 192  * 2.) If the device type is 'Mass-Storage/SPC-2' or 'Mass-Storage/RBC'
 193  *     use the SCSI vendor and model as USB-Vendor and USB-model.
 194  * 3.) Otherwise use the USB manufacturer and product as
 195  *     USB-Vendor and USB-model. Any non-printable characters
 196  *     in those strings will be skipped; a slash '/' will be converted
 197  *     into a full stop '.'.
 198  * 4.) If that fails, too, we will use idVendor and idProduct
 199  *     as USB-Vendor and USB-model.
 200  * 5.) The USB identification is the USB-vendor and USB-model
 201  *     string concatenated with an underscore '_'.
 202  * 6.) If the device supplies a serial number, this number
 203  *     is concatenated with the identification with an underscore '_'.
 204  */
 205 static int usb_id(struct udev_device *dev)
 206 {
 207         struct udev *udev = udev_device_get_udev(dev);
 208         struct udev_device *dev_interface;
 209         struct udev_device *dev_usb;
 210         const char *if_class, *if_subclass;
 211         int if_class_num;
 212         int protocol = 0;
 213
 214         dbg(udev, "syspath %s\n", udev_device_get_syspath(dev));
 215
 216         /* usb interface directory */
 217         dev_interface = udev_device_get_parent_with_subsystem(dev, "usb");
 218         if (dev_interface == NULL) {
 219                 info(udev, "unable to access usb_interface device of '%s'\n",
 220                      udev_device_get_syspath(dev));
 221                 return 1;
 222         }
 223
 224         if_class = udev_device_get_attr_value(dev_interface, "bInterfaceClass");
 225         if (!if_class) {
 226                 info(udev, "%s: cannot get bInterfaceClass attribute\n",
 227                      udev_device_get_sysname(dev));
 228                 return 1;
 229         }
 230         if_class_num = strtoul(if_class, NULL, 16);
 231         if (if_class_num == 8) {
 232                 if_subclass = udev_device_get_attr_value(dev_interface, "bInterfaceSubClass");
 233                 if (if_subclass != NULL)
 234                         protocol = set_usb_mass_storage_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
 235         } else {
 236                 set_usb_iftype(type_str, if_class_num, sizeof(type_str)-1);
 237         }
 238
 239         info(udev, "%s: if_class %d protocol %d\n",
 240              udev_device_get_syspath(dev_interface), if_class_num, protocol);
 241
 242         /* usb device directory */
 243         dev_usb = udev_device_get_parent_with_subsystem(dev_interface, "usb");
 244         if (!dev_usb) {
 245                 info(udev, "unable to find parent 'usb' device of '%s'\n",
 246                      udev_device_get_syspath(dev));
 247                 return 1;
 248         }
 249
 250         /* mass storage */
 251         if (protocol == 6 && !use_usb_info) {
 252                 struct udev_device *dev_scsi;
 253                 const char *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
 254                 int host, bus, target, lun;
 255
 256                 /* get scsi device */
 257                 dev_scsi = udev_device_get_parent_with_subsystem(dev, "scsi");
 258                 if (dev_scsi == NULL) {
 259                         info(udev, "unable to find parent 'scsi' device of '%s'\n",
 260                              udev_device_get_syspath(dev));
 261                         goto fallback;
 262                 }
 263                 if (sscanf(udev_device_get_sysname(dev_scsi), "%d:%d:%d:%d", &host, &bus, &target, &lun) != 4) {
 264                         info(udev, "invalid scsi device '%s'\n", udev_device_get_sysname(dev_scsi));
 265                         goto fallback;
 266                 }
 267
 268                 /* Generic SPC-2 device */
 269                 scsi_vendor = udev_device_get_attr_value(dev_scsi, "vendor");
 270                 if (!scsi_vendor) {
 271                         info(udev, "%s: cannot get SCSI vendor attribute\n",
 272                              udev_device_get_sysname(dev_scsi));
 273                         goto fallback;
 274                 }
 275                 set_str(vendor_str, scsi_vendor, sizeof(vendor_str)-1);
 276
 277                 scsi_model = udev_device_get_attr_value(dev_scsi, "model");
 278                 if (!scsi_model) {
 279                         info(udev, "%s: cannot get SCSI model attribute\n",
 280                              udev_device_get_sysname(dev_scsi));
 281                         goto fallback;
 282                 }
 283                 set_str(model_str, scsi_model, sizeof(model_str)-1);
 284
 285                 scsi_type = udev_device_get_attr_value(dev_scsi, "type");
 286                 if (!scsi_type) {
 287                         info(udev, "%s: cannot get SCSI type attribute\n",
 288                              udev_device_get_sysname(dev_scsi));
 289                         goto fallback;
 290                 }
 291                 set_scsi_type(type_str, scsi_type, sizeof(type_str)-1);
 292
 293                 scsi_rev = udev_device_get_attr_value(dev_scsi, "rev");
 294                 if (!scsi_rev) {
 295                         info(udev, "%s: cannot get SCSI revision attribute\n",
 296                              udev_device_get_sysname(dev_scsi));
 297                         goto fallback;
 298                 }
 299                 set_str(revision_str, scsi_rev, sizeof(revision_str)-1);
 300
 301                 /*
 302                  * some broken devices have the same identifiers
 303                  * for all luns, export the target:lun number
 304                  */
 305                 sprintf(instance_str, "%d:%d", target, lun);
 306         }
 307
 308 fallback:
 309         /* fallback to USB vendor & device */
 310         if (vendor_str[0] == '\0') {
 311                 const char *usb_vendor = NULL;
 312
 313                 if (!use_num_info)
 314                         usb_vendor = udev_device_get_attr_value(dev_usb, "manufacturer");
 315
 316                 if (!usb_vendor)
 317                         usb_vendor = udev_device_get_attr_value(dev_usb, "idVendor");
 318
 319                 if (!usb_vendor) {
 320                         info(udev, "No USB vendor information available\n");
 321                         return 1;
 322                 }
 323                 set_str(vendor_str, usb_vendor, sizeof(vendor_str)-1);
 324         }
 325
 326         if (model_str[0] == '\0') {
 327                 const char *usb_model = NULL;
 328
 329                 if (!use_num_info)
 330                         usb_model = udev_device_get_attr_value(dev_usb, "product");
 331
 332                 if (!usb_model)
 333                         usb_model = udev_device_get_attr_value(dev_usb, "idProduct");
 334
 335                 if (!usb_model) {
 336                         dbg(udev, "No USB model information available\n");
 337                         return 1;
 338                 }
 339                 set_str(model_str, usb_model, sizeof(model_str)-1);
 340         }
 341
 342         if (revision_str[0] == '\0') {
 343                 const char *usb_rev;
 344
 345                 usb_rev = udev_device_get_attr_value(dev_usb, "bcdDevice");
 346                 if (usb_rev)
 347                         set_str(revision_str, usb_rev, sizeof(revision_str)-1);
 348         }
 349
 350         if (serial_str[0] == '\0') {
 351                 const char *usb_serial;
 352
 353                 usb_serial = udev_device_get_attr_value(dev_usb, "serial");
 354                 if (usb_serial)
 355                         set_str(serial_str, usb_serial, sizeof(serial_str)-1);
 356         }
 357         return 0;
 358 }
 359
 360 int main(int argc, char **argv)
 361 {
 362         static const struct option options[] = {
 363                 { "usb-info", no_argument, NULL, 'u' },
 364                 { "num-info", no_argument, NULL, 'n' },
 365                 { "export", no_argument, NULL, 'x' },
 366                 { "debug", no_argument, NULL, 'd' },
 367                 { "help", no_argument, NULL, 'h' },
 368                 {}
 369         };
 370         struct udev *udev;
 371         struct udev_device *dev;
 372         char syspath[UTIL_PATH_SIZE];
 373         const char *devpath;
 374         static int export;
 375         int retval = 0;
 376
 377         udev = udev_new();
 378         if (udev == NULL)
 379                 goto exit;
 380
 381         logging_init("usb_id");
 382         udev_set_log_fn(udev, log_fn);
 383
 384         while (1) {
 385                 int option;
 386
 387                 option = getopt_long(argc, argv, "dnuxh", options, NULL);
 388                 if (option == -1)
 389                         break;
 390
 391                 switch (option) {
 392                 case 'd':
 393                         debug = 1;
 394                         if (udev_get_log_priority(udev) < LOG_INFO)
 395                                 udev_set_log_priority(udev, LOG_INFO);
 396                         break;
 397                 case 'n':
 398                         use_num_info = 1;
 399                         use_usb_info = 1;
 400                         break;
 401                 case 'u':
 402                         use_usb_info = 1;
 403                         break;
 404                 case 'x':
 405                         export = 1;
 406                         break;
 407                 case 'h':
 408                         printf("Usage: usb_id [--usb-info] [--num-info] [--export] [--help] <devpath>\n"
 409                                "  --usb-info  use usb strings instead\n"
 410                                "  --num-info  use numerical values\n"
 411                                "  --export    print values as environemt keys\n"
 412                                "  --help      print this help text\n\n");
 413                 default:
 414                         retval = 1;
 415                         goto exit;
 416                 }
 417         }
 418
 419         devpath = getenv("DEVPATH");
 420         if (devpath == NULL)
 421                 devpath = argv[optind];
 422         if (devpath == NULL) {
 423                 fprintf(stderr, "No device specified\n");
 424                 retval = 1;
 425                 goto exit;
 426         }
 427
 428         util_strlcpy(syspath, udev_get_sys_path(udev), sizeof(syspath));
 429         util_strlcat(syspath, devpath, sizeof(syspath));
 430         dev = udev_device_new_from_syspath(udev, syspath);
 431         if (dev == NULL) {
 432                 err(udev, "unable to access '%s'\n", devpath);
 433                 return 1;
 434         }
 435
 436         retval = usb_id(dev);
 437         if (retval == 0) {
 438                 char serial[256];
 439
 440                 util_strlcpy(serial, vendor_str, sizeof(serial));
 441                 util_strlcat(serial, "_", sizeof(serial));
 442                 util_strlcat(serial, model_str, sizeof(serial));
 443                 if (serial_str[0] != '\0') {
 444                         util_strlcat(serial, "_", sizeof(serial));
 445                         util_strlcat(serial, serial_str, sizeof(serial));
 446                 }
 447                 if (instance_str[0] != '\0') {
 448                         util_strlcat(serial, "-", sizeof(serial));
 449                         util_strlcat(serial, instance_str, sizeof(serial));
 450                 }
 451
 452                 if (export) {
 453                         printf("ID_VENDOR=%s\n", vendor_str);
 454                         printf("ID_MODEL=%s\n", model_str);
 455                         printf("ID_REVISION=%s\n", revision_str);
 456                         printf("ID_SERIAL=%s\n", serial);
 457                         if (serial_str[0] != '\0')
 458                                 printf("ID_SERIAL_SHORT=%s\n", serial_str);
 459                         printf("ID_TYPE=%s\n", type_str);
 460                         if (instance_str[0] != '\0')
 461                                 printf("ID_INSTANCE=%s\n", instance_str);
 462                         printf("ID_BUS=usb\n");
 463                 } else
 464                         printf("%s\n", serial);
 465         }
 466
 467 exit:
 468         udev_device_unref(dev);
 469         udev_unref(udev);
 470         logging_close();
 471         return retval;
 472 }