src/udev/udev-builtin-usb_id.c

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * USB device properties and persistent device path
   4  *
   5  * Copyright (c) 2005 SUSE Linux Products GmbH, Germany
   6  *   Author: Hannes Reinecke <hare@suse.de>
   7  */
   8
   9 #include <ctype.h>
  10 #include <errno.h>
  11 #include <fcntl.h>
  12 #include <stdarg.h>
  13 #include <stdio.h>
  14 #include <unistd.h>
  15
  16 #include "alloc-util.h"
  17 #include "device-nodes.h"
  18 #include "device-util.h"
  19 #include "fd-util.h"
  20 #include "parse-util.h"
  21 #include "string-util.h"
  22 #include "strxcpyx.h"
  23 #include "udev-builtin.h"
  24 #include "udev-util.h"
  25
  26 static void set_usb_iftype(char *to, int if_class_num, size_t len) {
  27         const char *type = "generic";
  28
  29         switch (if_class_num) {
  30         case 1:
  31                 type = "audio";
  32                 break;
  33         case 2: /* CDC-Control */
  34                 break;
  35         case 3:
  36                 type = "hid";
  37                 break;
  38         case 5: /* Physical */
  39                 break;
  40         case 6:
  41                 type = "media";
  42                 break;
  43         case 7:
  44                 type = "printer";
  45                 break;
  46         case 8:
  47                 type = "storage";
  48                 break;
  49         case 9:
  50                 type = "hub";
  51                 break;
  52         case 0x0a: /* CDC-Data */
  53                 break;
  54         case 0x0b: /* Chip/Smart Card */
  55                 break;
  56         case 0x0d: /* Content Security */
  57                 break;
  58         case 0x0e:
  59                 type = "video";
  60                 break;
  61         case 0xdc: /* Diagnostic Device */
  62                 break;
  63         case 0xe0: /* Wireless Controller */
  64                 break;
  65         case 0xfe: /* Application-specific */
  66                 break;
  67         case 0xff: /* Vendor-specific */
  68                 break;
  69         default:
  70                 break;
  71         }
  72         strncpy(to, type, len);
  73         to[len-1] = '\0';
  74 }
  75
  76 static int set_usb_mass_storage_ifsubtype(char *to, const char *from, size_t len) {
  77         int type_num = 0;
  78         const char *type = "generic";
  79
  80         if (safe_atoi(from, &type_num) >= 0) {
  81                 switch (type_num) {
  82                 case 1: /* RBC devices */
  83                         type = "rbc";
  84                         break;
  85                 case 2:
  86                         type = "atapi";
  87                         break;
  88                 case 3:
  89                         type = "tape";
  90                         break;
  91                 case 4: /* UFI */
  92                         type = "floppy";
  93                         break;
  94                 case 6: /* Transparent SPC-2 devices */
  95                         type = "scsi";
  96                         break;
  97                 default:
  98                         break;
  99                 }
 100         }
 101         strscpy(to, len, type);
 102         return type_num;
 103 }
 104
 105 static void set_scsi_type(char *to, const char *from, size_t len) {
 106         unsigned type_num;
 107         const char *type = "generic";
 108
 109         if (safe_atou(from, &type_num) >= 0) {
 110                 switch (type_num) {
 111                 case 0:
 112                 case 0xe:
 113                         type = "disk";
 114                         break;
 115                 case 1:
 116                         type = "tape";
 117                         break;
 118                 case 4:
 119                 case 7:
 120                 case 0xf:
 121                         type = "optical";
 122                         break;
 123                 case 5:
 124                         type = "cd";
 125                         break;
 126                 default:
 127                         break;
 128                 }
 129         }
 130         strscpy(to, len, type);
 131 }
 132
 133 #define USB_DT_DEVICE                        0x01
 134 #define USB_DT_INTERFACE                0x04
 135
 136 static int dev_if_packed_info(sd_device *dev, char *ifs_str, size_t len) {
 137         _cleanup_close_ int fd = -EBADF;
 138         ssize_t size;
 139         unsigned char buf[18 + 65535];
 140         size_t pos = 0;
 141         unsigned strpos = 0;
 142         const char *filename, *syspath;
 143         int r;
 144         struct usb_interface_descriptor {
 145                 uint8_t bLength;
 146                 uint8_t bDescriptorType;
 147                 uint8_t bInterfaceNumber;
 148                 uint8_t bAlternateSetting;
 149                 uint8_t bNumEndpoints;
 150                 uint8_t bInterfaceClass;
 151                 uint8_t bInterfaceSubClass;
 152                 uint8_t bInterfaceProtocol;
 153                 uint8_t iInterface;
 154         } _packed_;
 155
 156         r = sd_device_get_syspath(dev, &syspath);
 157         if (r < 0)
 158                 return r;
 159
 160         filename = strjoina(syspath, "/descriptors");
 161         fd = open(filename, O_RDONLY|O_CLOEXEC|O_NOCTTY);
 162         if (fd < 0)
 163                 return log_device_debug_errno(dev, errno, "Failed to open \"%s\": %m", filename);
 164
 165         size = read(fd, buf, sizeof(buf));
 166         if (size < 18)
 167                 return log_device_warning_errno(dev, SYNTHETIC_ERRNO(EIO),
 168                                                 "Short read from \"%s\"", filename);
 169         assert((size_t) size <= sizeof buf);
 170
 171         ifs_str[0] = '\0';
 172         while (pos + sizeof(struct usb_interface_descriptor) < (size_t) size &&
 173                strpos + 7 < len - 2) {
 174
 175                 struct usb_interface_descriptor *desc;
 176                 char if_str[8];
 177
 178                 desc = (struct usb_interface_descriptor *) (buf + pos);
 179                 if (desc->bLength < 3)
 180                         break;
 181                 if (desc->bLength > size - sizeof(struct usb_interface_descriptor))
 182                         return log_device_debug_errno(dev, SYNTHETIC_ERRNO(EIO),
 183                                                       "Corrupt data read from \"%s\"", filename);
 184                 pos += desc->bLength;
 185
 186                 if (desc->bDescriptorType != USB_DT_INTERFACE)
 187                         continue;
 188
 189                 if (snprintf(if_str, 8, ":%02x%02x%02x",
 190                              desc->bInterfaceClass,
 191                              desc->bInterfaceSubClass,
 192                              desc->bInterfaceProtocol) != 7)
 193                         continue;
 194
 195                 if (strstr(ifs_str, if_str))
 196                         continue;
 197
 198                 memcpy(&ifs_str[strpos], if_str, 8),
 199                 strpos += 7;
 200         }
 201
 202         if (strpos > 0) {
 203                 ifs_str[strpos++] = ':';
 204                 ifs_str[strpos++] = '\0';
 205         }
 206
 207         return 0;
 208 }
 209
 210 /*
 211  * A unique USB identification is generated like this:
 212  *
 213  * 1.) Get the USB device type from InterfaceClass and InterfaceSubClass
 214  * 2.) If the device type is 'Mass-Storage/SPC-2' or 'Mass-Storage/RBC',
 215  *     use the SCSI vendor and model as USB-Vendor and USB-model.
 216  * 3.) Otherwise, use the USB manufacturer and product as
 217  *     USB-Vendor and USB-model. Any non-printable characters
 218  *     in those strings will be skipped; a slash '/' will be converted
 219  *     into a full stop '.'.
 220  * 4.) If that fails, too, we will use idVendor and idProduct
 221  *     as USB-Vendor and USB-model.
 222  * 5.) The USB identification is the USB-vendor and USB-model
 223  *     string concatenated with an underscore '_'.
 224  * 6.) If the device supplies a serial number, this number
 225  *     is concatenated with the identification with an underscore '_'.
 226  */
 227 static int builtin_usb_id(UdevEvent *event, int argc, char *argv[]) {
 228         sd_device *dev = ASSERT_PTR(ASSERT_PTR(event)->dev);
 229         char vendor_str[64] = "";
 230         char vendor_str_enc[256];
 231         const char *vendor_id;
 232         char model_str[64] = "";
 233         char model_str_enc[256];
 234         const char *product_id;
 235         char serial_str[UDEV_NAME_SIZE] = "";
 236         char packed_if_str[UDEV_NAME_SIZE] = "";
 237         char revision_str[64] = "";
 238         char type_str[64] = "";
 239         char instance_str[64] = "";
 240         const char *ifnum = NULL;
 241         const char *driver = NULL;
 242         char serial[256];
 243
 244         sd_device *dev_interface, *dev_usb;
 245         const char *if_class, *if_subclass;
 246         unsigned if_class_num;
 247         int protocol = 0;
 248         size_t l;
 249         char *s;
 250
 251         const char *syspath, *sysname, *interface_syspath;
 252         int r;
 253
 254         r = sd_device_get_syspath(dev, &syspath);
 255         if (r < 0)
 256                 return r;
 257
 258         r = sd_device_get_sysname(dev, &sysname);
 259         if (r < 0)
 260                 return r;
 261
 262         /* shortcut, if we are called directly for a "usb_device" type */
 263         if (device_is_devtype(dev, "usb_device")) {
 264                 dev_if_packed_info(dev, packed_if_str, sizeof(packed_if_str));
 265                 dev_usb = dev;
 266                 goto fallback;
 267         }
 268
 269         /* usb interface directory */
 270         r = sd_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface", &dev_interface);
 271         if (r < 0)
 272                 return log_device_debug_errno(dev, r, "Failed to access usb_interface: %m");
 273
 274         r = sd_device_get_syspath(dev_interface, &interface_syspath);
 275         if (r < 0)
 276                 return log_device_debug_errno(dev_interface, r, "Failed to get syspath: %m");
 277         (void) sd_device_get_sysattr_value(dev_interface, "bInterfaceNumber", &ifnum);
 278         (void) sd_device_get_sysattr_value(dev_interface, "driver", &driver);
 279
 280         r = sd_device_get_sysattr_value(dev_interface, "bInterfaceClass", &if_class);
 281         if (r < 0)
 282                 return log_device_debug_errno(dev_interface, r, "Failed to get bInterfaceClass attribute: %m");
 283
 284         r = safe_atou_full(if_class, 16, &if_class_num);
 285         if (r < 0)
 286                 return log_device_debug_errno(dev_interface, r, "Failed to parse if_class: %m");
 287         if (if_class_num == 8) {
 288                 /* mass storage */
 289                 if (sd_device_get_sysattr_value(dev_interface, "bInterfaceSubClass", &if_subclass) >= 0)
 290                         protocol = set_usb_mass_storage_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
 291         } else
 292                 set_usb_iftype(type_str, if_class_num, sizeof(type_str)-1);
 293
 294         log_device_debug(dev_interface, "if_class:%u protocol:%i", if_class_num, protocol);
 295
 296         /* usb device directory */
 297         r = sd_device_get_parent_with_subsystem_devtype(dev_interface, "usb", "usb_device", &dev_usb);
 298         if (r < 0)
 299                 return log_device_debug_errno(dev_interface, r, "Failed to find parent 'usb' device");
 300
 301         /* all interfaces of the device in a single string */
 302         dev_if_packed_info(dev_usb, packed_if_str, sizeof(packed_if_str));
 303
 304         /* mass storage : SCSI or ATAPI */
 305         if (IN_SET(protocol, 6, 2)) {
 306                 sd_device *dev_scsi;
 307                 const char *scsi_sysname, *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
 308                 int host, bus, target, lun;
 309
 310                 /* get scsi device */
 311                 r = sd_device_get_parent_with_subsystem_devtype(dev, "scsi", "scsi_device", &dev_scsi);
 312                 if (r < 0) {
 313                         log_device_debug_errno(dev, r, "Unable to find parent SCSI device");
 314                         goto fallback;
 315                 }
 316                 if (sd_device_get_sysname(dev_scsi, &scsi_sysname) < 0)
 317                         goto fallback;
 318                 if (sscanf(scsi_sysname, "%d:%d:%d:%d", &host, &bus, &target, &lun) != 4) {
 319                         log_device_debug(dev_scsi, "Invalid SCSI device");
 320                         goto fallback;
 321                 }
 322
 323                 /* Generic SPC-2 device */
 324                 r = sd_device_get_sysattr_value(dev_scsi, "vendor", &scsi_vendor);
 325                 if (r < 0) {
 326                         log_device_debug_errno(dev_scsi, r, "Failed to get SCSI vendor attribute: %m");
 327                         goto fallback;
 328                 }
 329                 encode_devnode_name(scsi_vendor, vendor_str_enc, sizeof(vendor_str_enc));
 330                 udev_replace_whitespace(scsi_vendor, vendor_str, sizeof(vendor_str)-1);
 331                 udev_replace_chars(vendor_str, NULL);
 332
 333                 r = sd_device_get_sysattr_value(dev_scsi, "model", &scsi_model);
 334                 if (r < 0) {
 335                         log_device_debug_errno(dev_scsi, r, "Failed to get SCSI model attribute: %m");
 336                         goto fallback;
 337                 }
 338                 encode_devnode_name(scsi_model, model_str_enc, sizeof(model_str_enc));
 339                 udev_replace_whitespace(scsi_model, model_str, sizeof(model_str)-1);
 340                 udev_replace_chars(model_str, NULL);
 341
 342                 r = sd_device_get_sysattr_value(dev_scsi, "type", &scsi_type);
 343                 if (r < 0) {
 344                         log_device_debug_errno(dev_scsi, r, "Failed to get SCSI type attribute: %m");
 345                         goto fallback;
 346                 }
 347                 set_scsi_type(type_str, scsi_type, sizeof(type_str)-1);
 348
 349                 r = sd_device_get_sysattr_value(dev_scsi, "rev", &scsi_rev);
 350                 if (r < 0) {
 351                         log_device_debug_errno(dev_scsi, r, "Failed to get SCSI revision attribute: %m");
 352                         goto fallback;
 353                 }
 354                 udev_replace_whitespace(scsi_rev, revision_str, sizeof(revision_str)-1);
 355                 udev_replace_chars(revision_str, NULL);
 356
 357                 /*
 358                  * some broken devices have the same identifiers
 359                  * for all luns, export the target:lun number
 360                  */
 361                 sprintf(instance_str, "%d:%d", target, lun);
 362         }
 363
 364 fallback:
 365         r = sd_device_get_sysattr_value(dev_usb, "idVendor", &vendor_id);
 366         if (r < 0)
 367                 return log_device_debug_errno(dev_usb, r, "Failed to get idVendor attribute: %m");
 368
 369         r = sd_device_get_sysattr_value(dev_usb, "idProduct", &product_id);
 370         if (r < 0)
 371                 return log_device_debug_errno(dev_usb, r, "Failed to get idProduct attribute: %m");
 372
 373         /* fall back to USB vendor & device */
 374         if (vendor_str[0] == '\0') {
 375                 const char *usb_vendor;
 376
 377                 if (sd_device_get_sysattr_value(dev_usb, "manufacturer", &usb_vendor) < 0)
 378                         usb_vendor = vendor_id;
 379                 encode_devnode_name(usb_vendor, vendor_str_enc, sizeof(vendor_str_enc));
 380                 udev_replace_whitespace(usb_vendor, vendor_str, sizeof(vendor_str)-1);
 381                 udev_replace_chars(vendor_str, NULL);
 382         }
 383
 384         if (model_str[0] == '\0') {
 385                 const char *usb_model;
 386
 387                 if (sd_device_get_sysattr_value(dev_usb, "product", &usb_model) < 0)
 388                         usb_model = product_id;
 389                 encode_devnode_name(usb_model, model_str_enc, sizeof(model_str_enc));
 390                 udev_replace_whitespace(usb_model, model_str, sizeof(model_str)-1);
 391                 udev_replace_chars(model_str, NULL);
 392         }
 393
 394         if (revision_str[0] == '\0') {
 395                 const char *usb_rev;
 396
 397                 if (sd_device_get_sysattr_value(dev_usb, "bcdDevice", &usb_rev) >= 0) {
 398                         udev_replace_whitespace(usb_rev, revision_str, sizeof(revision_str)-1);
 399                         udev_replace_chars(revision_str, NULL);
 400                 }
 401         }
 402
 403         if (serial_str[0] == '\0') {
 404                 const char *usb_serial;
 405
 406                 if (sd_device_get_sysattr_value(dev_usb, "serial", &usb_serial) >= 0) {
 407                         /* http://msdn.microsoft.com/en-us/library/windows/hardware/gg487321.aspx */
 408                         for (const unsigned char *p = (unsigned char*) usb_serial; *p != '\0'; p++)
 409                                 if (*p < 0x20 || *p > 0x7f || *p == ',') {
 410                                         usb_serial = NULL;
 411                                         break;
 412                                 }
 413
 414                         if (usb_serial) {
 415                                 udev_replace_whitespace(usb_serial, serial_str, sizeof(serial_str)-1);
 416                                 udev_replace_chars(serial_str, NULL);
 417                         }
 418                 }
 419         }
 420
 421         s = serial;
 422         l = strpcpyl(&s, sizeof(serial), vendor_str, "_", model_str, NULL);
 423         if (!isempty(serial_str))
 424                 l = strpcpyl(&s, l, "_", serial_str, NULL);
 425
 426         if (!isempty(instance_str))
 427                 strpcpyl(&s, l, "-", instance_str, NULL);
 428
 429         if (sd_device_get_property_value(dev, "ID_BUS", NULL) >= 0)
 430                 log_device_debug(dev, "ID_BUS property is already set, setting only properties prefixed with \"ID_USB_\".");
 431         else {
 432                 udev_builtin_add_property(dev, event->event_mode, "ID_BUS", "usb");
 433
 434                 udev_builtin_add_property(dev, event->event_mode, "ID_MODEL", model_str);
 435                 udev_builtin_add_property(dev, event->event_mode, "ID_MODEL_ENC", model_str_enc);
 436                 udev_builtin_add_property(dev, event->event_mode, "ID_MODEL_ID", product_id);
 437
 438                 udev_builtin_add_property(dev, event->event_mode, "ID_SERIAL", serial);
 439                 if (!isempty(serial_str))
 440                         udev_builtin_add_property(dev, event->event_mode, "ID_SERIAL_SHORT", serial_str);
 441
 442                 udev_builtin_add_property(dev, event->event_mode, "ID_VENDOR", vendor_str);
 443                 udev_builtin_add_property(dev, event->event_mode, "ID_VENDOR_ENC", vendor_str_enc);
 444                 udev_builtin_add_property(dev, event->event_mode, "ID_VENDOR_ID", vendor_id);
 445
 446                 udev_builtin_add_property(dev, event->event_mode, "ID_REVISION", revision_str);
 447
 448                 if (!isempty(type_str))
 449                         udev_builtin_add_property(dev, event->event_mode, "ID_TYPE", type_str);
 450
 451                 if (!isempty(instance_str))
 452                         udev_builtin_add_property(dev, event->event_mode, "ID_INSTANCE", instance_str);
 453         }
 454
 455         /* Also export the same values in the above by prefixing ID_USB_. */
 456         udev_builtin_add_property(dev, event->event_mode, "ID_USB_MODEL", model_str);
 457         udev_builtin_add_property(dev, event->event_mode, "ID_USB_MODEL_ENC", model_str_enc);
 458         udev_builtin_add_property(dev, event->event_mode, "ID_USB_MODEL_ID", product_id);
 459         udev_builtin_add_property(dev, event->event_mode, "ID_USB_SERIAL", serial);
 460         if (!isempty(serial_str))
 461                 udev_builtin_add_property(dev, event->event_mode, "ID_USB_SERIAL_SHORT", serial_str);
 462
 463         udev_builtin_add_property(dev, event->event_mode, "ID_USB_VENDOR", vendor_str);
 464         udev_builtin_add_property(dev, event->event_mode, "ID_USB_VENDOR_ENC", vendor_str_enc);
 465         udev_builtin_add_property(dev, event->event_mode, "ID_USB_VENDOR_ID", vendor_id);
 466
 467         udev_builtin_add_property(dev, event->event_mode, "ID_USB_REVISION", revision_str);
 468
 469         if (!isempty(type_str))
 470                 udev_builtin_add_property(dev, event->event_mode, "ID_USB_TYPE", type_str);
 471
 472         if (!isempty(instance_str))
 473                 udev_builtin_add_property(dev, event->event_mode, "ID_USB_INSTANCE", instance_str);
 474
 475         if (!isempty(packed_if_str))
 476                 udev_builtin_add_property(dev, event->event_mode, "ID_USB_INTERFACES", packed_if_str);
 477         if (ifnum)
 478                 udev_builtin_add_property(dev, event->event_mode, "ID_USB_INTERFACE_NUM", ifnum);
 479         if (driver)
 480                 udev_builtin_add_property(dev, event->event_mode, "ID_USB_DRIVER", driver);
 481         return 0;
 482 }
 483
 484 const UdevBuiltin udev_builtin_usb_id = {
 485         .name = "usb_id",
 486         .cmd = builtin_usb_id,
 487         .help = "USB device properties",
 488         .run_once = true,
 489 };