4 * Identify an USB (block) device
6 * Copyright (c) 2005 SUSE Linux Products GmbH, Germany
8 * Hannes Reinecke <hare@suse.de>
10 * This library is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License as
12 * published by the Free Software Foundation; either version 2.1 of the
13 * License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
34 #include <../../libsysfs/sysfs/libsysfs.h>
35 #include "../../udev_utils.h"
36 #include "../../logging.h"
38 #define MAX_NAME_LEN 72
39 #define MAX_SERIAL_LEN 256
40 #define BLKGETSIZE64 _IOR(0x12,114,size_t)
43 void log_message(int priority, const char *format, ...)
46 static int udev_log = -1;
51 value = getenv("UDEV_LOG");
53 udev_log = log_priority(value);
58 if (priority > udev_log)
61 va_start(args, format);
62 vsyslog(priority, format, args);
67 char sysfs_mnt_path[SYSFS_PATH_MAX];
68 static char vendor_str[64];
69 static char model_str[64];
70 static char serial_str[MAX_SERIAL_LEN];
71 static char revision_str[16];
72 static char type_str[16];
74 static int use_usb_info;
77 static void set_str(char *to, const unsigned char *from, int count)
82 /* strip trailing whitespace */
83 len = strnlen(from, count);
84 while (isspace(from[len-1]))
87 /* strip leading whitespace */
89 while (isspace(from[i]) && (i < len))
94 /* substitute multiple whitespace */
95 if (isspace(from[i])) {
96 while (isspace(from[i]))
100 /* Replace '/' with '.' */
101 if (from[i] == '/') {
106 /* skip non-printable chars */
107 if (!isalnum(from[i]) && !ispunct(from[i])) {
119 * Set the type based on the USB interface class
121 static void set_usb_iftype(char *to, const char *from, int count)
126 type_num = strtoul(from, &eptr, 0);
130 sprintf(to, "audio");
136 sprintf(to, "printer");
141 case 2: /* CDC-Control */
142 case 5: /* Physical */
145 case 0x0a: /* CDC-Data */
146 case 0x0b: /* Chip/Smart Card */
147 case 0x0d: /* Content Security */
148 case 0x0e: /* Video */
149 case 0xdc: /* Diagnostic Device */
150 case 0xe0: /* Wireless Controller */
151 case 0xf2: /* Application-specific */
152 case 0xff: /* Vendor-specific */
154 sprintf(to, "generic");
158 sprintf(to, "generic");
165 * Set the type base on the interfaceSubClass.
166 * Valid for Mass-Storage devices (type 8) only.
168 static int set_usb_ifsubtype(char *to, const char *from, int count)
173 type_num = strtoul(from, &eptr, 0);
183 case 5: /* SFF-8070i */
184 sprintf(to, "floppy");
186 case 1: /* RBC devices */
187 case 6: /* Transparent SPC-2 devices */
192 sprintf(to, "generic");
198 static void set_scsi_type(char *to, const char *from, int count)
203 type_num = strtoul(from, &eptr, 0);
213 sprintf(to, "optical");
219 sprintf(to, "optical");
225 sprintf(to, "optical");
228 sprintf(to, "generic");
232 sprintf(to, "generic");
237 * A unique USB identification is generated like this:
239 * 1.) Get the USB device type from DeviceClass, InterfaceClass
240 * and InterfaceSubClass
241 * 2.) If the device type is 'Mass-Storage/SPC-2' or 'Mass-Storage/RBC'
242 * use the SCSI vendor and model as USB-Vendor and USB-model.
243 * 3.) Otherwise use the USB manufacturer and product as
244 * USB-Vendor and USB-model. Any non-printable characters
245 * in those strings will be skipped; a slash '/' will be converted
246 * into a full stop '.'.
247 * 4.) If that fails, too, we will use idVendor and idProduct
248 * as USB-Vendor and USB-model.
249 * 5.) The USB identification is the USB-vendor and USB-model
250 * string concatenated with an underscore '_'.
251 * 6.) If the device supplies a serial number, this number
252 * is concatenated with the identification with an underscore '_'.
254 static int usb_id(const char *target_path)
256 struct sysfs_class_device *class_dev; /* of target_path */
257 struct sysfs_class_device *class_dev_parent; /* for partitions */
258 struct sysfs_device *scsi_dev; /* the scsi_device */
259 struct sysfs_device *target_dev;
260 struct sysfs_device *host_dev, *interface_dev, *usb_dev;
261 struct sysfs_attribute *scsi_model, *scsi_vendor, *scsi_type, *scsi_rev;
262 struct sysfs_attribute *usb_model, *usb_vendor, *usb_rev, *usb_serial;
263 struct sysfs_attribute *if_class, *if_subclass;
267 class_dev = sysfs_open_class_device_path(target_path);
269 info("open class %s failed: %s", target_path, strerror(errno));
272 class_dev_parent = sysfs_get_classdev_parent(class_dev);
273 if (class_dev_parent) {
274 scsi_dev = sysfs_get_classdev_device(class_dev_parent);
276 scsi_dev = sysfs_get_classdev_device(class_dev);
280 * The close of scsi_dev will close class_dev or class_dev_parent.
284 * We assume we are called after the device is completely ready,
285 * so we don't have to loop here like udev. (And we are usually
290 * errno is not set if we can't find the device link, so
291 * don't print it out here.
293 info("Cannot find sysfs device associated with %s", target_path);
298 * Allow only scsi devices.
300 * Other block devices can support SG IO, but only ide-cd does, so
301 * for now, don't bother with anything else.
303 if (strcmp(scsi_dev->bus, "scsi") != 0) {
304 info("%s is not a scsi device", target_path);
308 /* target directory */
309 target_dev = sysfs_get_device_parent(scsi_dev);
311 host_dev = sysfs_get_device_parent(target_dev);
312 /* usb interface directory */
313 interface_dev = sysfs_get_device_parent(host_dev);
314 /* usb device directory */
315 usb_dev = sysfs_get_device_parent(interface_dev);
317 if (!strcmp(interface_dev->bus, "bus") != 0) {
318 info("%s is not an usb device", target_path);
322 if_class = sysfs_get_device_attr(interface_dev, "bInterfaceClass");
324 info("%s: cannot get bInterfaceClass attribute", interface_dev->name);
327 if_class_num = strtoul(if_class->value, NULL, 16);
328 if (if_class_num != 8) {
329 set_usb_iftype(type_str, if_class->value, sizeof(type_str) - 1);
331 if_subclass = sysfs_get_device_attr(interface_dev,
332 "bInterfaceSubClass");
333 protocol = set_usb_ifsubtype(type_str, if_subclass->value,
334 sizeof(type_str) -1 );
337 if (!use_usb_info && protocol == 6) {
338 /* Generic SPC-2 device */
339 scsi_vendor = sysfs_get_device_attr(scsi_dev, "vendor");
341 info("%s: cannot get vendor attribute", scsi_dev->name);
344 set_str(vendor_str, scsi_vendor->value, sizeof(vendor_str)-1);
346 scsi_model = sysfs_get_device_attr(scsi_dev, "model");
348 info("%s: cannot get model attribute", scsi_dev->name);
351 set_str(model_str, scsi_model->value, sizeof(model_str)-1);
353 scsi_type = sysfs_get_device_attr(scsi_dev, "type");
355 info("%s: cannot get type attribute", scsi_dev->name);
358 set_scsi_type(type_str, scsi_type->value, sizeof(type_str)-1);
360 scsi_rev = sysfs_get_device_attr(scsi_dev, "rev");
362 info("%s: cannot get type attribute", scsi_dev->name);
365 set_str(revision_str, scsi_rev->value, sizeof(revision_str)-1);
369 /* Fallback to USB vendor & device */
370 if (vendor_str[0] == '\0') {
371 usb_vendor = sysfs_get_device_attr(usb_dev, "manufacturer");
373 dbg("No USB vendor string found, using idVendor");
374 usb_vendor = sysfs_get_device_attr(usb_dev, "idVendor");
376 set_str(vendor_str,usb_vendor->value, sizeof(vendor_str) - 1);
379 if (model_str[0] == '\0') {
380 usb_model = sysfs_get_device_attr(usb_dev, "product");
382 dbg("No USB model string found, using idProduct");
383 usb_model = sysfs_get_device_attr(usb_dev, "idProduct");
385 set_str(model_str, usb_model->value, sizeof(model_str) - 1);
388 if (revision_str[0] == '\0') {
389 usb_rev = sysfs_get_device_attr(usb_dev, "bcdDevice");
391 set_str(revision_str, usb_rev->value,
392 sizeof(revision_str) - 1);
396 if (serial_str[0] == '\0') {
397 usb_serial = sysfs_get_device_attr(usb_dev, "serial");
399 set_str(serial_str, usb_serial->value,
400 sizeof(serial_str) - 1);
406 int main(int argc, char **argv)
410 char target_path[MAX_NAME_LEN];
413 dbg("argc is %d", argc);
414 if (sysfs_get_mnt_path(sysfs_mnt_path, MAX_NAME_LEN)) {
415 info("sysfs_get_mnt_path failed: %s",
420 while ((option = getopt(argc, argv, "ux")) != -1 ) {
422 dbg("option '%c' arg '%s'", option, optarg);
424 dbg("option '%c'", option);
434 info("Unknown or bad option '%c' (0x%x)", option, option);
440 devpath = getenv("DEVPATH");
442 strncpy(target_path, sysfs_mnt_path, MAX_NAME_LEN);
443 strncat(target_path, devpath, MAX_NAME_LEN);
445 if (optind == argc) {
446 fprintf(stderr, "No device specified\n");
449 devpath = argv[optind];
450 strncpy(target_path, devpath, MAX_NAME_LEN);
453 retval = usb_id(target_path);
456 printf("ID_VENDOR=%s\n", vendor_str);
457 printf("ID_MODEL=%s\n", model_str);
458 printf("ID_REVISION=%s\n", revision_str);
459 if (serial_str[0] == '\0') {
460 printf("ID_SERIAL=%s_%s\n",
461 vendor_str, model_str);
463 printf("ID_SERIAL=%s_%s_%s\n",
464 vendor_str, model_str, serial_str);
466 printf("ID_TYPE=%s\n", type_str);
468 if (serial_str[0] == '\0') {
470 vendor_str, model_str);
473 vendor_str, model_str, serial_str);