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);
101 case 5: /* SFF-8070i */
104 case 1: /* RBC devices */
107 case 6: /* Transparent SPC-2 devices */
114 strscpy(to, len, type);
118 static void set_scsi_type(char *to, const char *from, size_t len)
122 const char *type = "generic";
124 type_num = strtoul(from, &eptr, 0);
146 strscpy(to, len, type);
149 #define USB_DT_DEVICE 0x01
150 #define USB_DT_INTERFACE 0x04
152 static int dev_if_packed_info(struct udev_device *dev, char *ifs_str, size_t len)
154 _cleanup_free_ char *filename = NULL;
155 _cleanup_close_ int fd = -1;
157 unsigned char buf[18 + 65535];
160 struct usb_interface_descriptor {
162 u_int8_t bDescriptorType;
163 u_int8_t bInterfaceNumber;
164 u_int8_t bAlternateSetting;
165 u_int8_t bNumEndpoints;
166 u_int8_t bInterfaceClass;
167 u_int8_t bInterfaceSubClass;
168 u_int8_t bInterfaceProtocol;
170 } __attribute__((packed));
172 if (asprintf(&filename, "%s/descriptors", udev_device_get_syspath(dev)) < 0)
175 fd = open(filename, O_RDONLY|O_CLOEXEC);
177 fprintf(stderr, "error opening USB device 'descriptors' file\n");
181 size = read(fd, buf, sizeof(buf));
182 if (size < 18 || size == sizeof(buf))
186 while (pos < size && strpos+7 < len-2) {
187 struct usb_interface_descriptor *desc;
190 desc = (struct usb_interface_descriptor *) &buf[pos];
191 if (desc->bLength < 3)
193 pos += desc->bLength;
195 if (desc->bDescriptorType != USB_DT_INTERFACE)
198 if (snprintf(if_str, 8, ":%02x%02x%02x",
199 desc->bInterfaceClass,
200 desc->bInterfaceSubClass,
201 desc->bInterfaceProtocol) != 7)
204 if (strstr(ifs_str, if_str) != NULL)
207 memcpy(&ifs_str[strpos], if_str, 8),
212 ifs_str[strpos++] = ':';
213 ifs_str[strpos++] = '\0';
220 * A unique USB identification is generated like this:
222 * 1.) Get the USB device type from InterfaceClass and InterfaceSubClass
223 * 2.) If the device type is 'Mass-Storage/SPC-2' or 'Mass-Storage/RBC'
224 * use the SCSI vendor and model as USB-Vendor and USB-model.
225 * 3.) Otherwise use the USB manufacturer and product as
226 * USB-Vendor and USB-model. Any non-printable characters
227 * in those strings will be skipped; a slash '/' will be converted
228 * into a full stop '.'.
229 * 4.) If that fails, too, we will use idVendor and idProduct
230 * as USB-Vendor and USB-model.
231 * 5.) The USB identification is the USB-vendor and USB-model
232 * string concatenated with an underscore '_'.
233 * 6.) If the device supplies a serial number, this number
234 * is concatenated with the identification with an underscore '_'.
236 static int builtin_usb_id(struct udev_device *dev, int argc, char *argv[], bool test)
239 char vendor_str_enc[256];
240 const char *vendor_id;
242 char model_str_enc[256];
243 const char *product_id;
244 char serial_str[UTIL_NAME_SIZE];
245 char packed_if_str[UTIL_NAME_SIZE];
246 char revision_str[64];
248 char instance_str[64];
249 const char *ifnum = NULL;
250 const char *driver = NULL;
253 struct udev_device *dev_interface = NULL;
254 struct udev_device *dev_usb = NULL;
255 const char *if_class, *if_subclass;
261 vendor_str[0] = '\0';
263 serial_str[0] = '\0';
264 packed_if_str[0] = '\0';
265 revision_str[0] = '\0';
267 instance_str[0] = '\0';
269 /* shortcut, if we are called directly for a "usb_device" type */
270 if (udev_device_get_devtype(dev) != NULL && streq(udev_device_get_devtype(dev), "usb_device")) {
271 dev_if_packed_info(dev, packed_if_str, sizeof(packed_if_str));
276 /* usb interface directory */
277 dev_interface = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_interface");
278 if (dev_interface == NULL) {
279 log_debug("unable to access usb_interface device of '%s'\n",
280 udev_device_get_syspath(dev));
284 ifnum = udev_device_get_sysattr_value(dev_interface, "bInterfaceNumber");
285 driver = udev_device_get_sysattr_value(dev_interface, "driver");
287 if_class = udev_device_get_sysattr_value(dev_interface, "bInterfaceClass");
289 log_debug("%s: cannot get bInterfaceClass attribute\n",
290 udev_device_get_sysname(dev));
294 if_class_num = strtoul(if_class, NULL, 16);
295 if (if_class_num == 8) {
297 if_subclass = udev_device_get_sysattr_value(dev_interface, "bInterfaceSubClass");
298 if (if_subclass != NULL)
299 protocol = set_usb_mass_storage_ifsubtype(type_str, if_subclass, sizeof(type_str)-1);
301 set_usb_iftype(type_str, if_class_num, sizeof(type_str)-1);
304 log_debug("%s: if_class %d protocol %d\n",
305 udev_device_get_syspath(dev_interface), if_class_num, protocol);
307 /* usb device directory */
308 dev_usb = udev_device_get_parent_with_subsystem_devtype(dev_interface, "usb", "usb_device");
310 log_debug("unable to find parent 'usb' device of '%s'\n",
311 udev_device_get_syspath(dev));
315 /* all interfaces of the device in a single string */
316 dev_if_packed_info(dev_usb, packed_if_str, sizeof(packed_if_str));
318 /* mass storage : SCSI or ATAPI */
319 if ((protocol == 6 || protocol == 2)) {
320 struct udev_device *dev_scsi;
321 const char *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
322 int host, bus, target, lun;
324 /* get scsi device */
325 dev_scsi = udev_device_get_parent_with_subsystem_devtype(dev, "scsi", "scsi_device");
326 if (dev_scsi == NULL) {
327 log_debug("unable to find parent 'scsi' device of '%s'\n",
328 udev_device_get_syspath(dev));
331 if (sscanf(udev_device_get_sysname(dev_scsi), "%d:%d:%d:%d", &host, &bus, &target, &lun) != 4) {
332 log_debug("invalid scsi device '%s'\n", udev_device_get_sysname(dev_scsi));
336 /* Generic SPC-2 device */
337 scsi_vendor = udev_device_get_sysattr_value(dev_scsi, "vendor");
339 log_debug("%s: cannot get SCSI vendor attribute\n",
340 udev_device_get_sysname(dev_scsi));
343 udev_util_encode_string(scsi_vendor, vendor_str_enc, sizeof(vendor_str_enc));
344 util_replace_whitespace(scsi_vendor, vendor_str, sizeof(vendor_str)-1);
345 util_replace_chars(vendor_str, NULL);
347 scsi_model = udev_device_get_sysattr_value(dev_scsi, "model");
349 log_debug("%s: cannot get SCSI model attribute\n",
350 udev_device_get_sysname(dev_scsi));
353 udev_util_encode_string(scsi_model, model_str_enc, sizeof(model_str_enc));
354 util_replace_whitespace(scsi_model, model_str, sizeof(model_str)-1);
355 util_replace_chars(model_str, NULL);
357 scsi_type = udev_device_get_sysattr_value(dev_scsi, "type");
359 log_debug("%s: cannot get SCSI type attribute\n",
360 udev_device_get_sysname(dev_scsi));
363 set_scsi_type(type_str, scsi_type, sizeof(type_str)-1);
365 scsi_rev = udev_device_get_sysattr_value(dev_scsi, "rev");
367 log_debug("%s: cannot get SCSI revision attribute\n",
368 udev_device_get_sysname(dev_scsi));
371 util_replace_whitespace(scsi_rev, revision_str, sizeof(revision_str)-1);
372 util_replace_chars(revision_str, NULL);
375 * some broken devices have the same identifiers
376 * for all luns, export the target:lun number
378 sprintf(instance_str, "%d:%d", target, lun);
382 vendor_id = udev_device_get_sysattr_value(dev_usb, "idVendor");
383 product_id = udev_device_get_sysattr_value(dev_usb, "idProduct");
385 /* fallback to USB vendor & device */
386 if (vendor_str[0] == '\0') {
387 const char *usb_vendor = NULL;
389 usb_vendor = udev_device_get_sysattr_value(dev_usb, "manufacturer");
391 usb_vendor = vendor_id;
393 log_debug("No USB vendor information available\n");
396 udev_util_encode_string(usb_vendor, vendor_str_enc, sizeof(vendor_str_enc));
397 util_replace_whitespace(usb_vendor, vendor_str, sizeof(vendor_str)-1);
398 util_replace_chars(vendor_str, NULL);
401 if (model_str[0] == '\0') {
402 const char *usb_model = NULL;
404 usb_model = udev_device_get_sysattr_value(dev_usb, "product");
406 usb_model = product_id;
409 udev_util_encode_string(usb_model, model_str_enc, sizeof(model_str_enc));
410 util_replace_whitespace(usb_model, model_str, sizeof(model_str)-1);
411 util_replace_chars(model_str, NULL);
414 if (revision_str[0] == '\0') {
417 usb_rev = udev_device_get_sysattr_value(dev_usb, "bcdDevice");
419 util_replace_whitespace(usb_rev, revision_str, sizeof(revision_str)-1);
420 util_replace_chars(revision_str, NULL);
424 if (serial_str[0] == '\0') {
425 const char *usb_serial;
427 usb_serial = udev_device_get_sysattr_value(dev_usb, "serial");
429 const unsigned char *p;
431 /* http://msdn.microsoft.com/en-us/library/windows/hardware/gg487321.aspx */
432 for (p = (unsigned char *)usb_serial; *p != '\0'; p++)
433 if (*p < 0x20 || *p > 0x7f || *p == ',') {
440 util_replace_whitespace(usb_serial, serial_str, sizeof(serial_str)-1);
441 util_replace_chars(serial_str, NULL);
446 l = strpcpyl(&s, sizeof(serial), vendor_str, "_", model_str, NULL);
447 if (serial_str[0] != '\0')
448 l = strpcpyl(&s, l, "_", serial_str, NULL);
450 if (instance_str[0] != '\0')
451 strpcpyl(&s, l, "-", instance_str, NULL);
453 udev_builtin_add_property(dev, test, "ID_VENDOR", vendor_str);
454 udev_builtin_add_property(dev, test, "ID_VENDOR_ENC", vendor_str_enc);
455 udev_builtin_add_property(dev, test, "ID_VENDOR_ID", vendor_id);
456 udev_builtin_add_property(dev, test, "ID_MODEL", model_str);
457 udev_builtin_add_property(dev, test, "ID_MODEL_ENC", model_str_enc);
458 udev_builtin_add_property(dev, test, "ID_MODEL_ID", product_id);
459 udev_builtin_add_property(dev, test, "ID_REVISION", revision_str);
460 udev_builtin_add_property(dev, test, "ID_SERIAL", serial);
461 if (serial_str[0] != '\0')
462 udev_builtin_add_property(dev, test, "ID_SERIAL_SHORT", serial_str);
463 if (type_str[0] != '\0')
464 udev_builtin_add_property(dev, test, "ID_TYPE", type_str);
465 if (instance_str[0] != '\0')
466 udev_builtin_add_property(dev, test, "ID_INSTANCE", instance_str);
467 udev_builtin_add_property(dev, test, "ID_BUS", "usb");
468 if (packed_if_str[0] != '\0')
469 udev_builtin_add_property(dev, test, "ID_USB_INTERFACES", packed_if_str);
471 udev_builtin_add_property(dev, test, "ID_USB_INTERFACE_NUM", ifnum);
473 udev_builtin_add_property(dev, test, "ID_USB_DRIVER", driver);
477 const struct udev_builtin udev_builtin_usb_id = {
479 .cmd = builtin_usb_id,
480 .help = "usb device properties",