Chapter 3. usb/lib

Table of Contents

3.1. data-fast.h
3.2. data.h
3.3. dev-utils.h
3.4. lib.h
3.5. pipe-utils.h
3.6. log.h
3.7. time.h
3.8. devmgr.h
3.9. decode.h
3.10. ctrlmsg.h
3.11. selectif.h
3.12. getnewdev.h
3.13. parsecmd.h

Header files in the usb/lib directory

3.1. data-fast.h

Table of Contents

get_u8 - get unsigned 8bit value from the given pointer
get_u16 - get unsigned 16bit value from the given pointer
usb_addrof - convert the arguments into an 'unsigned long' pointing to the item of data in question
usb_do_dcg - version of usb_data_content_get() without any checks
usb_fast_dca - fast version of usb_data_content_address()
usb_fast_dcg - fast version of usb_data_content_get
get_off - convert off and arry paramters to a 'real' offset
usb_fast_dcs - Fast version of usb_data_content_set.

Synopsis of function. macros and structures contained in data-fast.h

3.2. data.h

Table of Contents

usblib_data_content_get - usblib_data_content_get
usblib_data_content_set - usblib_data_content_set
usblib_data_content_address - usblib_data_content_address
usb_data_content_get - general usb_data_content_get function call - switched between a function or macro depending on USB_DATA_FAST
usb_data_content_set - general usb_data_content_set function call - switched between a function or macro depending on USB_DATA_FAST
usb_data_content_address - general usb_data_content_address function call - switched between a function or macro depending on USB_DATA_FAST

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

3.3. dev-utils.h

Table of Contents

usb_find_device_ref - Obtains a device reference

Synopsis of function. macros and structures contained in dev-utils.h

3.4. lib.h

Table of Contents

usblib_init - USB Library initialisation
usblib_stop - USB Library finalisation
usblib_core_start - USB Library Core starting notification
usblib_core_stop - USB Library core stopping notifications
usblib_get_version - USB library version information

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

3.5. pipe-utils.h

Table of Contents

usb_get_default_pipe - Obtains the default pipe on an endpoint

Synopsis of function. macros and structures contained in pipe-utils.h

3.6. log.h

Table of Contents

usb_log_create - creates a usb logging endpoint
usb_log_create_sub - creates a usb sub logging filehandle
usb_log_free - frees a logging filehandle
usb_log_restart - restarts a log
usb_log_clear - clears all memory resident entries from a log
usb_log_show_to_file - a function for usb_show_log to write current entries to the log's file
usb_show_log - send all currently memory buffered log entries to the supplied routine
usb_logf - logs a formated string to a log file

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

3.7. time.h

Table of Contents

usb_time_cs - obtains the time in teh usb system

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

3.8. devmgr.h

Table of Contents

usb_devmgr_drop - device manager: drop an device from the pool of registered devices
usb_devmgr_release - device manager: release a claim of a device
usb_devmgr_claim - device manager: claim a device
usb_devmgr_find_free - device manager: find unclaimed devices
usblib_devmgr_findrelated - library function to find other interfaces on the same device

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

3.9. decode.h

Table of Contents

usb_decode_transaction_result - usb_decode_transaction_result
usb_decode_result - decode a result returned from an USB function call

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

3.10. ctrlmsg.h

Table of Contents

usblib_ctrl_msg - Sends an USB standard contrl message

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

3.11. selectif.h

Table of Contents

usblib_select_if - Select an setting for an interface of a device

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

3.12. getnewdev.h

Table of Contents

usblib_init_getdevice - find a new device either from command line or from unclaimed pool

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

3.13. parsecmd.h

Table of Contents

*usblib_parse_cmd_line - Parse command line for details of usb device

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