Scroll to navigation

USB_STRING(9) USB Core APIs USB_STRING(9)

NAME

usb_string - returns UTF-8 version of a string descriptor

SYNOPSIS

int usb_string(struct usb_device * dev, int index, char * buf, size_t size);

ARGUMENTS

dev

the device whose string descriptor is being retrieved

index

the number of the descriptor

buf

where to put the string

size

how big is “buf”?

CONTEXT

!in_interrupt ()

DESCRIPTION

This converts the UTF-16LE encoded strings returned by devices, from usb_get_string_descriptor, to null-terminated UTF-8 encoded ones that are more usable in most kernel contexts. Note that this function chooses strings in the first language supported by the device.

This call is synchronous, and may not be used in an interrupt context.

RETURN

length of the string (>= 0) or usb_control_msg status (< 0).

COPYRIGHT

June 2024 Kernel Hackers Manual 3.10