IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


USB functions


Detailed Description

This sections describes the various functions defined by the @CHIP-RTOS-PPC USB API.

Functions

UsbError usbHostActivatePort (unsigned port)
 Activate one of the system's USB root ports.
int usbHostInit (const UsbCallback callback, unsigned char classCode, unsigned char subClassCode, unsigned char protocolCode, unsigned short vendorId, unsigned short productId, unsigned short versionBcd)
 Initialize the USB stack and register a driver.
void usbHostDeinit (unsigned char driverId)
 Unregister a user driver and deinitialize the USB stack.
UsbError usbHostIssueToken (unsigned char address, unsigned char epNumber, unsigned char token)
 Issue a USB token.
UsbError usbHostClearQueue (unsigned char address, unsigned char epNumber, UsbBool in)
 Clear and endpoints transfer queue.
UsbError usbHostReserveEp0 (unsigned char driverId, unsigned char address)
 Reserve endpoint 0.
UsbError usbHostReleaseEp0 (unsigned char driverId, unsigned char address)
 Release endpoint 0.
UsbError usbHostGetDeviceInfo (unsigned char address, UsbDevice *info, unsigned char size)
 Get device descriptor.
UsbError usbHostGetConfigInfo (unsigned char address, UsbConfig *info, unsigned char size)
 Get configuration descriptor.
UsbError usbHostGetInterfaceInfo (unsigned char address, unsigned char interfaceId, unsigned char altSettingId, UsbInterface *info, unsigned char size)
 Get interface descriptor.
UsbError usbHostGetEpInfo (unsigned char address, unsigned char altSettingId, unsigned char epNumber, UsbBool in, UsbEp *info, unsigned char size)
 Get endpoint descriptor.
UsbError usbHostGetString (unsigned char driverId, unsigned char address, unsigned char stringId, char *string)
 Get a string from the device.
UsbError usbHostGetStatus (unsigned char driverId, unsigned char address, unsigned char receiver, unsigned char index, unsigned short *status)
 Get status from a device.
UsbError usbHostSetClearFeature (unsigned char driverId, unsigned char address, unsigned char receiver, unsigned char index, unsigned char feature, UsbBool setFeature)
 Set/clear a device feature.
UsbError usbHostSetInterface (unsigned char driverId, unsigned char address, unsigned char interfaceId, unsigned char altSettingId)
 Set an interface.
UsbError usbHostTransfer (unsigned char address, unsigned char epNumber, unsigned char token, unsigned char *buffer, unsigned length)
 Start a USB transfer.
UsbError usbHostTransferIso (unsigned char address, unsigned char epNumber, unsigned char token, unsigned char *buffer, unsigned length, long startingFrame)
 Start a USB transfer on isochronous endpoint.
UsbError usbSend (unsigned char address, unsigned char epNumber, void *buffer, unsigned length, UsbBool less)
 Send data on the USB.
void usbFreeReceiveBuffer (void *buffer)
 Free a receive buffer allocated by the USB stack.
UsbError usbWakeup (void)
 Wake up the bus.
UsbError usbSofNotify (unsigned char driverId, UsbBool enable)
 Enable/disable SOF notification.
unsigned short usbGetFrameN (void)
 Get frame number.
UsbError usbHostSwitchPortPower (unsigned char hubAddress, unsigned port, UsbBool power)
 Switch on/off power at a USB hub port.





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:38 2017 by Doxygen 1.6.1