2 * USB device properties and persistent device path
4 * Copyright (c) 2005 SUSE Linux Products GmbH, Germany
5 * Author: Hannes Reinecke <hare@suse.de>
7 * Copyright (C) 2005-2011 Kay Sievers <kay@vrfy.org>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 static void set_usb_iftype(char *to, int if_class_num, size_t len)
36 const char *type = "generic";
38 switch (if_class_num) {
42 case 2: /* CDC-Control */
47 case 5: /* Physical */
61 case 0x0a: /* CDC-Data */
63 case 0x0b: /* Chip/Smart Card */
65 case 0x0d: /* Content Security */
70 case 0xdc: /* Diagnostic Device */
72 case 0xe0: /* Wireless Controller */
74 case 0xfe: /* Application-specific */
76 case 0xff: /* Vendor-specific */
81 strncpy(to, type, len);
85 static int set_usb_mass_storage_ifsubtype(char *to, const char *from, size_t len)
89 const char *type = "generic";
91 type_num = strtoul(from, &eptr, 0);
94 case 1: /* RBC devices */
106 case 6: /* Transparent SPC-2 devices */
113 strscpy(to, len, type);
117 static void set_scsi_type(char *to, const char *from, size_t len)
121 const char *type = "generic";
123 type_num = strtoul(from, &eptr, 0);
145 strscpy(to, len, type);
148 #define USB_DT_DEVICE 0x01
149 #define USB_DT_INTERFACE 0x04
151 static int dev_if_packed_info(struct udev_device *dev, char *ifs_str, size_t len)
153 _cleanup_free_ char *filename = NULL;
154 _cleanup_close_ int fd = -1;
156 unsigned char buf[18 + 65535];
159 struct usb_interface_descriptor {
161 u_int8_t bDescriptorType;
162 u_int8_t bInterfaceNumber;
163 u_int8_t bAlternateSetting;
164 u_int8_t bNumEndpoints;
165 u_int8_t bInterfaceClass;
166 u_int8_t bInterfaceSubClass;
167 u_int8_t bInterfaceProtocol;
169 } __attribute__((packed));
171 if (asprintf(&filename, "%s/descriptors", udev_device_get_syspath(dev)) < 0)
174 fd = open(filename, O_RDONLY|O_CLOEXEC);
176 fprintf(stderr, "error opening USB device 'descriptors' file\n");
180 size = read(fd, buf, sizeof(buf));
181 if (size < 18 || size == sizeof(buf))
185 while (pos < size && strpos+7 < len-2) {
186 struct usb_interface_descriptor *desc;
189 desc = (struct usb_interface_descriptor *) &buf[pos];
190 if (desc->bLength < 3)
192 pos += desc->bLength;
194 if (desc->bDescriptorType != USB_DT_INTERFACE)
197 if (snprintf(if_str, 8, ":%02x%02x%02x",
198 desc->bInterfaceClass,
199 desc->bInterfaceSubClass,
200 desc->bInterfaceProtocol) != 7)
203 if (strstr(ifs_str, if_str) != NULL)
206 memcpy(&ifs_str[strpos], if_str, 8),
211 ifs_str[strpos++] = ':';
212 ifs_str[strpos++] = '\0';
219 * A unique USB identification is generated like this:
221 * 1.) Get the USB device type from InterfaceClass and InterfaceSubClass
222 * 2.) If the device type is 'Mass-Storage/SPC-2' or 'Mass-Storage/RBC'
223 * use the SCSI vendor and model as USB-Vendor and USB-model.
224 * 3.) Otherwise use the USB manufacturer and product as
225 * USB-Vendor and USB-model. Any non-printable characters
226 * in those strings will be skipped; a slash '/' will be converted
227 * into a full stop '.'.
228 * 4.) If that fails, too, we will use idVendor and idProduct
229 * as USB-Vendor and USB-model.
230 * 5.) The USB identification is the USB-vendor and USB-model
231 * string concatenated with an underscore '_'.
232 * 6.) If the device supplies a serial number, this number
233 * is concatenated with the identification with an underscore '_'.
235 static int builtin_usb_id(struct udev_device *dev, int argc, char *argv[], bool test)
238 char vendor_str_enc[256];
239 const char *vendor_id;
241 char model_str_enc[256];
242 const char *product_id;
243 char serial_str[UTIL_NAME_SIZE];
244 char packed_if_str[UTIL_NAME_SIZE];
245 char revision_str[64];
247 char instance_str[64];
248 const char *ifnum = NULL;
249 const char *driver = NULL;
252 struct udev_device *dev_interface = NULL;
253 struct udev_device *dev_usb = NULL;
254 const char *if_class, *if_subclass;
260 vendor_str[0] = '\0';
262 serial_str[0] = '\0';
263 packed_if_str[0] = '\0';
264 revision_str[0] = '\0';
266 instance_str[0] = '\0';
268 /* shortcut, if we are called directly for a "usb_device" type */
269 if (udev_device_get_devtype(dev) != NULL && streq(udev_device_get_devtype(dev), "usb_device")) {
270 dev_if_packed_info(dev, packed_if_str, sizeof(packed_if_str));
275 /* usb interface directory */
276 dev_interface = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
277 if (dev_interface == NULL) {
278 log_debug("unable to access usb_interface device of '%s'\n",
279 udev_device_get_syspath(dev));
283 ifnum = udev_device_get_sysattr_value(dev_interface, "bInterfaceNumber");
284 driver = udev_device_get_sysattr_value(dev_interface, "driver");
286 if_class = udev_device_get_sysattr_value(dev_interface, "bInterfaceClass");
288 log_debug("%s: cannot get bInterfaceClass attribute\n",
289 udev_device_get_sysname(dev));
293 if_class_num = strtoul(if_class, NULL, 16);
294 if (if_class_num == 8) {
296 if_subclass = udev_device_get_sysattr_value(dev_interface, "bInterfaceSubClass");
297 if (if_subclass != NULL)
298 protocol = set_usb_mass_storage_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
300 set_usb_iftype(type_str, if_class_num, sizeof(type_str)-1);
303 log_debug("%s: if_class %d protocol %d\n",
304 udev_device_get_syspath(dev_interface), if_class_num, protocol);
306 /* usb device directory */
307 dev_usb = udev_device_get_parent_with_subsystem_devtype(dev_interface, "usb", "usb_device");
309 log_debug("unable to find parent 'usb' device of '%s'\n",
310 udev_device_get_syspath(dev));
314 /* all interfaces of the device in a single string */
315 dev_if_packed_info(dev_usb, packed_if_str, sizeof(packed_if_str));
317 /* mass storage : SCSI or ATAPI */
318 if ((protocol == 6 || protocol == 2)) {
319 struct udev_device *dev_scsi;
320 const char *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
321 int host, bus, target, lun;
323 /* get scsi device */
324 dev_scsi = udev_device_get_parent_with_subsystem_devtype(dev, "scsi", "scsi_device");
325 if (dev_scsi == NULL) {
326 log_debug("unable to find parent 'scsi' device of '%s'\n",
327 udev_device_get_syspath(dev));
330 if (sscanf(udev_device_get_sysname(dev_scsi), "%d:%d:%d:%d", &host, &bus, &target, &lun) != 4) {
331 log_debug("invalid scsi device '%s'\n", udev_device_get_sysname(dev_scsi));
335 /* Generic SPC-2 device */
336 scsi_vendor = udev_device_get_sysattr_value(dev_scsi, "vendor");
338 log_debug("%s: cannot get SCSI vendor attribute\n",
339 udev_device_get_sysname(dev_scsi));
342 udev_util_encode_string(scsi_vendor, vendor_str_enc, sizeof(vendor_str_enc));
343 util_replace_whitespace(scsi_vendor, vendor_str, sizeof(vendor_str)-1);
344 util_replace_chars(vendor_str, NULL);
346 scsi_model = udev_device_get_sysattr_value(dev_scsi, "model");
348 log_debug("%s: cannot get SCSI model attribute\n",
349 udev_device_get_sysname(dev_scsi));
352 udev_util_encode_string(scsi_model, model_str_enc, sizeof(model_str_enc));
353 util_replace_whitespace(scsi_model, model_str, sizeof(model_str)-1);
354 util_replace_chars(model_str, NULL);
356 scsi_type = udev_device_get_sysattr_value(dev_scsi, "type");
358 log_debug("%s: cannot get SCSI type attribute\n",
359 udev_device_get_sysname(dev_scsi));
362 set_scsi_type(type_str, scsi_type, sizeof(type_str)-1);
364 scsi_rev = udev_device_get_sysattr_value(dev_scsi, "rev");
366 log_debug("%s: cannot get SCSI revision attribute\n",
367 udev_device_get_sysname(dev_scsi));
370 util_replace_whitespace(scsi_rev, revision_str, sizeof(revision_str)-1);
371 util_replace_chars(revision_str, NULL);
374 * some broken devices have the same identifiers
375 * for all luns, export the target:lun number
377 sprintf(instance_str, "%d:%d", target, lun);
381 vendor_id = udev_device_get_sysattr_value(dev_usb, "idVendor");
382 product_id = udev_device_get_sysattr_value(dev_usb, "idProduct");
384 /* fallback to USB vendor & device */
385 if (vendor_str[0] == '\0') {
386 const char *usb_vendor = NULL;
388 usb_vendor = udev_device_get_sysattr_value(dev_usb, "manufacturer");
390 usb_vendor = vendor_id;
392 log_debug("No USB vendor information available\n");
395 udev_util_encode_string(usb_vendor, vendor_str_enc, sizeof(vendor_str_enc));
396 util_replace_whitespace(usb_vendor, vendor_str, sizeof(vendor_str)-1);
397 util_replace_chars(vendor_str, NULL);
400 if (model_str[0] == '\0') {
401 const char *usb_model = NULL;
403 usb_model = udev_device_get_sysattr_value(dev_usb, "product");
405 usb_model = product_id;
408 udev_util_encode_string(usb_model, model_str_enc, sizeof(model_str_enc));
409 util_replace_whitespace(usb_model, model_str, sizeof(model_str)-1);
410 util_replace_chars(model_str, NULL);
413 if (revision_str[0] == '\0') {
416 usb_rev = udev_device_get_sysattr_value(dev_usb, "bcdDevice");
418 util_replace_whitespace(usb_rev, revision_str, sizeof(revision_str)-1);
419 util_replace_chars(revision_str, NULL);
423 if (serial_str[0] == '\0') {
424 const char *usb_serial;
426 usb_serial = udev_device_get_sysattr_value(dev_usb, "serial");
428 const unsigned char *p;
430 /* http://msdn.microsoft.com/en-us/library/windows/hardware/gg487321.aspx */
431 for (p = (unsigned char *)usb_serial; *p != '\0'; p++)
432 if (*p < 0x20 || *p > 0x7f || *p == ',') {
439 util_replace_whitespace(usb_serial, serial_str, sizeof(serial_str)-1);
440 util_replace_chars(serial_str, NULL);
445 l = strpcpyl(&s, sizeof(serial), vendor_str, "_", model_str, NULL);
446 if (serial_str[0] != '\0')
447 l = strpcpyl(&s, l, "_", serial_str, NULL);
449 if (instance_str[0] != '\0')
450 strpcpyl(&s, l, "-", instance_str, NULL);
452 udev_builtin_add_property(dev, test, "ID_VENDOR", vendor_str);
453 udev_builtin_add_property(dev, test, "ID_VENDOR_ENC", vendor_str_enc);
454 udev_builtin_add_property(dev, test, "ID_VENDOR_ID", vendor_id);
455 udev_builtin_add_property(dev, test, "ID_MODEL", model_str);
456 udev_builtin_add_property(dev, test, "ID_MODEL_ENC", model_str_enc);
457 udev_builtin_add_property(dev, test, "ID_MODEL_ID", product_id);
458 udev_builtin_add_property(dev, test, "ID_REVISION", revision_str);
459 udev_builtin_add_property(dev, test, "ID_SERIAL", serial);
460 if (serial_str[0] != '\0')
461 udev_builtin_add_property(dev, test, "ID_SERIAL_SHORT", serial_str);
462 if (type_str[0] != '\0')
463 udev_builtin_add_property(dev, test, "ID_TYPE", type_str);
464 if (instance_str[0] != '\0')
465 udev_builtin_add_property(dev, test, "ID_INSTANCE", instance_str);
466 udev_builtin_add_property(dev, test, "ID_BUS", "usb");
467 if (packed_if_str[0] != '\0')
468 udev_builtin_add_property(dev, test, "ID_USB_INTERFACES", packed_if_str);
470 udev_builtin_add_property(dev, test, "ID_USB_INTERFACE_NUM", ifnum);
472 udev_builtin_add_property(dev, test, "ID_USB_DRIVER", driver);
476 const struct udev_builtin udev_builtin_usb_id = {
478 .cmd = builtin_usb_id,
479 .help = "usb device properties",