VxWorks API Reference : USB libraries

usbTargKbdLib [USB]

NAME

usbTargKbdLib [USB] - USB keyboard target exerciser/demonstration

ROUTINES

usbTargKbdCallbackInfo( ) - returns usbTargKbdLib callback table
usbTargKbdInjectReport( ) - injects a "boot report" into the interrupt pipe

DESCRIPTION

This module contains code to exercise the usbTargLib by emulating a rudimentary USB keyboard. This module will generally be invoked by usbTool or a similar USB test/exerciser application.

It is the caller's responsibility to initialize usbTargLib and attach a USB TCD to it. When attaching a TCD to usbTargLib, the caller must pass a pointer to a table of callbacks required by usbTargLib. The address of this table and the "callback parameter" required by these callbacks may be obtained by calling usbTargKbdCallbackInfo( ). It is not necessary to initialize the usbTartKbdLib or to shut it down. It performs all of its operations in response to callbacks from usbTargLib.

This module also exports a function called usbTargKbdInjectReport( ). This function allows the caller to inject a "boot report" into the interrupt pipe. This allows for rudimentary emulation of keystrokes.


USB libraries : Routines

usbTargKbdCallbackInfo( )

NAME

usbTargKbdCallbackInfo( ) - returns usbTargKbdLib callback table

SYNOPSIS

VOID usbTargKbdCallbackInfo
    (
    pUSB_TARG_CALLBACK_TABLE * ppCallbacks,
    pVOID *                    pCallbackParam
    )

DESCRIPTION

RETURNS

N/A

SEE ALSO

usbTargKbdLib


USB libraries : Routines

usbTargKbdInjectReport( )

NAME

usbTargKbdInjectReport( ) - injects a "boot report" into the interrupt pipe

SYNOPSIS

STATUS usbTargKbdInjectReport
    (
    pHID_KBD_BOOT_REPORT pReport,
    UINT16               reportLen
    )

DESCRIPTION

RETURNS

OK, or ERROR if unable to inject report

SEE ALSO

usbTargKbdLib