1 /* $FreeBSD: head/usr.sbin/usbconfig/dump.c 246789 2013-02-14 12:22:40Z hselasky $ */
3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #include <libusb20_desc.h>
41 #define DUMP0(n,type,field,...) dump_field(pdev, " ", #field, n->field);
42 #define DUMP1(n,type,field,...) dump_field(pdev, " ", #field, n->field);
43 #define DUMP2(n,type,field,...) dump_field(pdev, " ", #field, n->field);
44 #define DUMP3(n,type,field,...) dump_field(pdev, " ", #field, n->field);
47 dump_mode(uint8_t value)
49 if (value == LIBUSB20_MODE_HOST)
55 dump_speed(uint8_t value)
59 case LIBUSB20_SPEED_LOW:
60 return ("LOW (1.5Mbps)");
61 case LIBUSB20_SPEED_FULL:
62 return ("FULL (12Mbps)");
63 case LIBUSB20_SPEED_HIGH:
64 return ("HIGH (480Mbps)");
65 case LIBUSB20_SPEED_VARIABLE:
66 return ("VARIABLE (52-480Mbps)");
67 case LIBUSB20_SPEED_SUPER:
68 return ("SUPER (5.0Gbps)");
72 return ("UNKNOWN ()");
76 dump_power_mode(uint8_t value)
80 case LIBUSB20_POWER_OFF:
82 case LIBUSB20_POWER_ON:
84 case LIBUSB20_POWER_SAVE:
86 case LIBUSB20_POWER_SUSPEND:
88 case LIBUSB20_POWER_RESUME:
96 dump_field(struct libusb20_device *pdev, const char *plevel,
97 const char *field, uint32_t value)
99 uint8_t temp_string[256];
101 printf("%s%s = 0x%04x ", plevel, field, value);
103 if (strlen(plevel) == 8) {
104 /* Endpoint Descriptor */
106 if (strcmp(field, "bEndpointAddress") == 0) {
114 if (strcmp(field, "bmAttributes") == 0) {
115 switch (value & 0x03) {
117 printf(" <CONTROL>\n");
120 switch (value & 0x0C) {
122 printf(" <ISOCHRONOUS>\n");
125 printf(" <ASYNC-ISOCHRONOUS>\n");
128 printf(" <ADAPT-ISOCHRONOUS>\n");
131 printf(" <SYNC-ISOCHRONOUS>\n");
139 printf(" <INTERRUPT>\n");
146 if ((field[0] == 'i') && (field[1] != 'd')) {
147 /* Indirect String Descriptor */
149 printf(" <no string>\n");
152 if (libusb20_dev_req_string_simple_sync(pdev, value,
153 temp_string, sizeof(temp_string))) {
154 printf(" <retrieving string failed>\n");
157 printf(" <%s>\n", temp_string);
161 /* No additional information */
166 dump_extra(struct libusb20_me_struct *str, const char *plevel)
173 while ((ptr = libusb20_desc_foreach(str, ptr))) {
174 printf("\n" "%sAdditional Descriptor\n\n", plevel);
175 printf("%sbLength = 0x%02x\n", plevel, ptr[0]);
176 printf("%sbDescriptorType = 0x%02x\n", plevel, ptr[1]);
178 printf("%sbDescriptorSubType = 0x%02x\n",
180 printf("%s RAW dump: ", plevel);
181 for (x = 0; x != ptr[0]; x++) {
183 printf("\n%s 0x%02x | ", plevel, x);
185 printf("0x%02x%s", ptr[x],
186 (x != (ptr[0] - 1)) ? ", " : (x % 8) ? "\n" : "");
194 dump_endpoint(struct libusb20_device *pdev,
195 struct libusb20_endpoint *ep)
197 struct LIBUSB20_ENDPOINT_DESC_DECODED *edesc;
200 LIBUSB20_ENDPOINT_DESC(DUMP3, edesc);
201 dump_extra(&ep->extra, " " " " " ");
206 dump_iface(struct libusb20_device *pdev,
207 struct libusb20_interface *iface)
209 struct LIBUSB20_INTERFACE_DESC_DECODED *idesc;
212 idesc = &iface->desc;
213 LIBUSB20_INTERFACE_DESC(DUMP2, idesc);
214 dump_extra(&iface->extra, " " " " " ");
216 for (z = 0; z != iface->num_endpoints; z++) {
217 printf("\n Endpoint %u\n", z);
218 dump_endpoint(pdev, iface->endpoints + z);
224 dump_device_info(struct libusb20_device *pdev, uint8_t show_ifdrv)
230 usage = libusb20_dev_get_power_usage(pdev);
232 printf("%s, cfg=%u md=%s spd=%s pwr=%s (%umA)\n",
233 libusb20_dev_get_desc(pdev),
234 libusb20_dev_get_config_index(pdev),
235 dump_mode(libusb20_dev_get_mode(pdev)),
236 dump_speed(libusb20_dev_get_speed(pdev)),
237 dump_power_mode(libusb20_dev_get_power_mode(pdev)),
243 for (n = 0; n != 255; n++) {
244 if (libusb20_dev_get_iface_desc(pdev, n, buf, sizeof(buf)))
248 printf("ugen%u.%u.%u: %s\n",
249 libusb20_dev_get_bus_number(pdev),
250 libusb20_dev_get_address(pdev), n, buf);
255 dump_be_quirk_names(struct libusb20_backend *pbe)
257 struct libusb20_quirk q;
261 memset(&q, 0, sizeof(q));
263 printf("\nDumping list of supported quirks:\n\n");
265 for (x = 0; x != 0xFFFF; x++) {
267 error = libusb20_be_get_quirk_name(pbe, x, &q);
270 printf("No quirk names - maybe the USB quirk "
271 "module has not been loaded.\n");
275 if (strcmp(q.quirkname, "UQ_NONE"))
276 printf("%s\n", q.quirkname);
283 dump_be_dev_quirks(struct libusb20_backend *pbe)
285 struct libusb20_quirk q;
289 memset(&q, 0, sizeof(q));
291 printf("\nDumping current device quirks:\n\n");
293 for (x = 0; x != 0xFFFF; x++) {
295 error = libusb20_be_get_dev_quirk(pbe, x, &q);
298 printf("No device quirks - maybe the USB quirk "
299 "module has not been loaded.\n");
303 if (strcmp(q.quirkname, "UQ_NONE")) {
304 printf("VID=0x%04x PID=0x%04x REVLO=0x%04x "
305 "REVHI=0x%04x QUIRK=%s\n",
306 q.vid, q.pid, q.bcdDeviceLow,
307 q.bcdDeviceHigh, q.quirkname);
315 dump_device_desc(struct libusb20_device *pdev)
317 struct LIBUSB20_DEVICE_DESC_DECODED *ddesc;
319 ddesc = libusb20_dev_get_device_desc(pdev);
320 LIBUSB20_DEVICE_DESC(DUMP0, ddesc);
325 dump_config(struct libusb20_device *pdev, uint8_t all_cfg)
327 struct LIBUSB20_CONFIG_DESC_DECODED *cdesc;
328 struct LIBUSB20_DEVICE_DESC_DECODED *ddesc;
329 struct libusb20_config *pcfg = NULL;
331 uint8_t cfg_index_end;
335 ddesc = libusb20_dev_get_device_desc(pdev);
339 cfg_index_end = ddesc->bNumConfigurations;
341 cfg_index = libusb20_dev_get_config_index(pdev);
342 cfg_index_end = cfg_index + 1;
345 for (; cfg_index != cfg_index_end; cfg_index++) {
347 pcfg = libusb20_dev_alloc_config(pdev, cfg_index);
351 printf("\n Configuration index %u\n\n", cfg_index);
352 cdesc = &(pcfg->desc);
353 LIBUSB20_CONFIG_DESC(DUMP1, cdesc);
354 dump_extra(&(pcfg->extra), " " " ");
356 for (x = 0; x != pcfg->num_interface; x++) {
357 printf("\n Interface %u\n", x);
358 dump_iface(pdev, pcfg->interface + x);
360 for (y = 0; y != (pcfg->interface + x)->num_altsetting; y++) {
361 printf("\n Interface %u Alt %u\n", x, y + 1);
363 (pcfg->interface + x)->altsetting + y);
374 dump_string_by_index(struct libusb20_device *pdev, uint8_t str_index)
382 err(1, "out of memory");
384 if (str_index == 0) {
386 if (libusb20_dev_req_string_sync(pdev,
387 str_index, 0, pbuf, 256)) {
388 printf("STRING_0x%02x = <read error>\n", str_index);
390 printf("STRING_0x%02x = ", str_index);
391 len = (uint8_t)pbuf[0];
392 for (n = 0; n != len; n++) {
393 printf("0x%02x%s", (uint8_t)pbuf[n],
394 (n != (len-1)) ? ", " : "");
399 /* ordinary string */
400 if (libusb20_dev_req_string_simple_sync(pdev,
401 str_index, pbuf, 256)) {
402 printf("STRING_0x%02x = <read error>\n", str_index);
404 printf("STRING_0x%02x = <%s>\n", str_index, pbuf);