te
Copyright (c) 2004, Sun Microsystems, Inc.,
All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
usb_get_string_descr - Get string descriptor from device

#include <sys/usb/usba.h>



int usb_get_string_descr(dev_info_t *dip,
 uint16_t langid, uint8_t index,
 char *buf, size_t buflen);

illumos DDI specific (illumos DDI) dip langid index buf buflen The usb_get_string_descr() function retrieves a parsed string descriptor from a device. dip specifies the device, while index indicates which descriptor to return.

String descriptors provide information about other descriptors, or information that is encoded in other descriptors, in readable form. Many descriptor types have one or more index fields which identify string descriptors. (See Sections 9.5 and 9.6 of the USB 2.0 specification.) For example, a configuration descriptor's seventh byte contains the string descriptor index describing a specific configuration.

Retrieved descriptors that do not fit into buflen bytes are truncated. All returned descriptors are null-terminated.

USB_SUCCESS USB_INVALID_ARGS USB_FAILURE May be called from user or kernel context.

 /* Get the first string descriptor. */

 char buf[SIZE];

 if (usb_get_string_descr(
 dip, USB_LANG_ID, 0, buf, SIZE) == USB_SUCCESS) {
 cmn_err (CE_NOTE, "%s%d: %s",
 ddi_driver_name(dip), ddi_get_instance(dip), buf);
 }

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Architecture PCI-based systems

Interface stability Committed

attributes(5), usb_get_dev_data(9F), usb_string_descr(9S)