usb_ddk_types.h

Overview

Provides the enumerated variables, structures, and macros used in USB DDK APIs.

File to include: <usb/usb_ddk_types.h>

Library: libusb_ndk.z.so

System capability: SystemCapability.Driver.USB.Extension

Since: 10

Related module: UsbDdk

Summary

Structs

Name	typedef Keyword	Description
UsbControlRequestSetup	__attribute__((aligned(8))) UsbControlRequestSetup	Setup data for control transfer. It corresponds to Setup Data in the USB protocol.
UsbDeviceDescriptor	__attribute__((aligned(8))) UsbDeviceDescriptor	Defines standard device descriptors, which correspond to Standard Device Descriptor in the USB protocol.
UsbConfigDescriptor	__attribute__((packed)) UsbConfigDescriptor	Defines standard configuration descriptors, which correspond to Standard Configuration Descriptor in the USB protocol.
UsbInterfaceDescriptor	__attribute__((packed)) UsbInterfaceDescriptor	Defines standard interface descriptors, which correspond to Standard Interface Descriptor in the USB protocol.
UsbEndpointDescriptor	__attribute__((packed)) UsbEndpointDescriptor	Defines standard endpoint descriptors, which correspond to Standard Endpoint Descriptor in the USB protocol.
UsbDdkEndpointDescriptor	UsbDdkEndpointDescriptor	Defines endpoint descriptors.
UsbDdkInterfaceDescriptor	UsbDdkInterfaceDescriptor	Defines USB interface descriptors.
UsbDdkInterface	UsbDdkInterface	Defines a USB DDK API, which is a collection of alternate settings for a particular USB interface.
UsbDdkConfigDescriptor	UsbDdkConfigDescriptor	Defines configuration descriptors.
UsbRequestPipe	__attribute__((aligned(8))) UsbRequestPipe	Defines a USB request pipe.
UsbDeviceMemMap	UsbDeviceMemMap	Device memory map created by calling OH_Usb_CreateDeviceMemMap. A buffer using the device memory map can provide better performance.
Usb_DeviceArray	Usb_DeviceArray	Defines the device ID list, which is used to store the device IDs and device quantity obtained using OH_Usb_GetDevices.
Usb_NonRootHubArray	Usb_NonRootHubArray	Defines the non-root hub list, which is used to store the non-root hub IDs and quantity obtained using OH_Usb_GetNonRootHubs.

Enums

Name	typedef Keyword	Description
UsbDdkErrCode	UsbDdkErrCode	Enumerates the USB DDK error code definitions.

Enum Description

UsbDdkErrCode

enum UsbDdkErrCode

Description

Enumerates the USB DDK error code definitions.

Since: 10

Enum	Description
USB_DDK_SUCCESS = 0	Operation succeeded.
USB_DDK_FAILED = -1	Operation failed. Deprecated from: 16
USB_DDK_NO_PERM = 201	No permission. Since: 14
USB_DDK_INVALID_PARAMETER = 401	Invalid parameter. The value is -2 before API version 16.
USB_DDK_MEMORY_ERROR = 27400001	Memory errors, such as insufficient memory, memory data copy failure, or memory allocation failure. The value is -3 before API version 16.
USB_DDK_INVALID_OPERATION = 27400002	Invalid operation. The value is -4 before API version 16.
USB_DDK_NULL_PTR = -5	Null pointer. Deprecated from: 16
USB_DDK_DEVICE_BUSY = -6	Device busy. Deprecated from: 16
USB_DDK_IO_FAILED = 27400003	Device I/O operation failure. Since: 14
USB_DDK_TIMEOUT = 27400004	Transmission timeout. The value is -7 before API version 16.