Chapter 2. usb/sys

Table of Contents

2.1. ccall.h
2.2. errors.h
2.3. memory.h
2.4. events.h
2.5. fastacc.h
2.6. usb-defs.h
2.7. waiting.h

Header files in the usb/sys directory

2.1. ccall.h

Table of Contents

ccall_create - Inter C module calling wrapper.
ccall_free - Free inter C module calling wrapper.

Synopsis of function. macros and structures contained in ccall.h

2.2. errors.h

Table of Contents

USB_RESULT_OK - USB Error OK.
USB_RESULT_ALIAS_FILE_NOT_FOUND - USB Error alias not found.
USB_RESULT_STRUCTUR_DROPPED - USB Error structure dropped.
USB_RESULT_INVALID_PARAMETER - USB Error invalid parameter.
USB_RESULT_CONTROLLER_ALREADY_EXISTS - USB Error controller already exists.
USB_RESULT_BUS_INVALID_INTERNAL_2 - USB Error bus invalid internal 2.
USB_RESULT_ILLEGAL_SPEED - USB Error illegal speed
USB_RESULT_ALL_DEVICES_USED - USB Error all devices used
USB_RESULT_DEVICE_ADDRESS_USED - USB Error device address used
USB_RESULT_ENDPOINT_ADDRESS_USED - USB Error endpoint address used
USB_RESULT_INVALID_PIPE_STATE - USB Error invalid pipe state
USB_RESULT_NO_TRANSACTION_PENDING - USB Error no transaction pending
USB_RESULT_ERROR_GENERATED - USB Error error generated
USB_RESULT_NO_OBJECT_FOUND - USB Error no object found
USB_RESULT_BUS_CAPACITY_TO_SMALL - USB Error bus capacity too small
USB_RESULT_BUS_INVALID_PAYLOAD_SIZE - USB Error bus invalid payload size
USB_RESULT_BUS_INVALID_TRANSFER_TYPE - USB Error invalid transfer type
USB_RESULT_BUS_INVALID_INTERNAL_1 - USB Error invalid internal 1
USB_RESULT_NOT_ENOUGH_MEMORY - USB Error out of memory
USB_RESULT_TEMPORARY_FAILURE - Temporary failiure
USB_RESULT_NOT_AVAILABLE - USB Error - resource not available
USB_RESULT_IN_PROGRESS - USB Result - in progress
USB_RESULT_FAILED - USB Result - a generic failure
USB_RESULT_NO_RESOURCES - USB Result - no resources
USB_RESULT_DEVICE_NOT_FOUND - USB Result - device not found
USB_ERR_LIBRARY - USB Error block - library errors (and errors that where not originally in the core)
USB_RESULT_INVALID_ENDPOINT - USB Error - endpoint is not known / corrupted
USB_RESULT_INVALID_DEVICE - USB Error - device is not known / corrupted
USB_RESULT_INVALID_HC - USB Error - host controller is not known / corrupted
USB_RESULT_INVALID_ARGUMENT - USB Error - argument (generic) is not known / corrupted / bad
USB_RESULT_INVALID_WAITING - USB Error - waiting is not known / corrupted
USB_RESULT_INVALID_URB - USB Error - URB is not known / corrupted
USB_RESULT_INVALID_PIPE - USB Error - Pipe is not known / corrupted
USB_RESULT_DEVMGR_NORESPONSE - USB Error - device manager did not respond (is not available)
USB_RESULT_DEVMGR_FAILED - USB Error - device manager operation failed
USB_RESULT_DEVMGR_ALREADYCLAIMED - USB Error - device manager: device is already claimed
USB_RESULT_DEVMGR_UNKNOWN - USB Error - device manager: unknown error
USB_RESULT_DEVMGR_NODEV - USB Error - device manager: device not found

Synopsis of function. macros and structures contained in errors.h

2.3. memory.h

Table of Contents

usb_dynamic_area_s - USB dynamic area structure

Synopsis of function. macros and structures contained in memory.h

2.4. events.h

Table of Contents

SERVICE_USB - USB system service call number
SERVICE_USB_PIPE_RELEASE - USB system service call reason code
SERVICE_USB_PIPE_EXCLUSIV - USB system service call reason code
SERVICE_USB_CONFIGURATION - USB system service call reason code
SERVICE_USB_INTERFACE - USB system service call reason code
SERVICE_USB_TRANSFER_CAP - USB system service call reason code
SERVICE_USB_POWER_CAP - USB system service call reason code
SERVICE_USB_CONTROLLER_STARTING - USB system service call reason code
SERVICE_USB_CONTROLLER_DYING - USB system service call reason code
SERVICE_USB_MODULE_STARTING - USB system service call reason code
SERVICE_USB_MODULE_DYING - USB system service call reason code
SERVICE_USB_MODULE_WANTS_TO_STOP - USB system service call reason code
SERVICE_USB_MODULE_STOP_RECOVER - USB system service call reason code
SERVICE_USB_HUB_EVENT - USB system service call reason code
SERVICE_USB_ROOT_HUB_EVENT - USB system service call reason code

Synopsis of function. macros and structures contained in events.h

2.5. fastacc.h

Table of Contents

usb_fast_access_init - Initialise fast acces library routines.
usb_fast_access_information - Gets fast access information
usb_endpoint_information - Returns information about a given endpoint.
usb_reqstart - USB request start structure.
usb_fast_access_struct - fast access structure.

Synopsis of function. macros and structures contained in fastacc.h

2.6. usb-defs.h

Table of Contents

USB_DRIVER_BASE - Base path for USB Device Drivers

Synopsis of function. macros and structures contained in usb-defs.h

2.7. waiting.h

Table of Contents

WAITING_TYPE_POLL - Waiting type for taskwindow
WAITING_TYPE_MESSAGE - Waiting type for wimp message
WAITING_TYPE_SWI - Waiting type for SWI
WAITING_TYPE_APCS - Waiting type for APCS function call
WAITING_TYPE_CALLBACK - Waiting type for OS_AddCallback
WAITING_TYPE_POLLWORD - Waiting type for use with Wimp Poll Word Non Zero
waiting_poll_s - poll waiting structure
waiting_message_s - waiting message structure
waiting_swi_s - waiting swi struct
waiting_apcs_s - waiting apcs call struct
waiting_pollword_s - waiting structure for pollword

Synopsis of function. macros and structures contained in waiting.h