forked from PAWPAW-Mirror/lib_xua
50 lines
1.7 KiB
ReStructuredText
50 lines
1.7 KiB
ReStructuredText
|newpage|
|
|
|
|
User Function Definitions
|
|
=========================
|
|
|
|
The following functions can be defined by an application using `lib_xua`.
|
|
|
|
.. note:: Default, empty, implementations of these functions are provided in `lib_xua`. These are marked
|
|
as weak symbols so the application can simply define its own version of them.
|
|
|
|
External Audio Hardware Configuration Functions
|
|
-----------------------------------------------
|
|
|
|
The following functions can be optionally used by the design to configure external audio hardware.
|
|
As a minimum, in most applications, it is expected that a implementation of `AudioHwConfig()` will need
|
|
to be provided.
|
|
|
|
.. doxygenfunction:: AudioHwInit
|
|
.. doxygenfunction:: AudioHwConfig
|
|
.. doxygenfunction:: AudioHwConfig_Mute
|
|
.. doxygenfunction:: AudioHwConfig_UnMute
|
|
|
|
|
|
Audio Stream Start/Stop Functions
|
|
---------------------------------
|
|
|
|
The following functions can be optionally used by the design. They can be useful for mute lines etc.
|
|
|
|
.. doxygenfunction:: UserAudioStreamStart
|
|
.. doxygenfunction:: UserAudioStreamStop
|
|
.. doxygenfunction:: UserAudioInputStreamStart
|
|
.. doxygenfunction:: UserAudioInputStreamStop
|
|
.. doxygenfunction:: UserAudioOutputStreamStart
|
|
.. doxygenfunction:: UserAudioOutputStreamStop
|
|
|
|
Host Active Functions
|
|
---------------------
|
|
|
|
The following function can be used to signal that the device is connected to a valid host.
|
|
|
|
.. doxygenfunction:: UserHostActive
|
|
|
|
HID Controls
|
|
------------
|
|
|
|
The following function is called when the device wishes to read physical user input (buttons etc).
|
|
The function should write relevant HID bits into this array. The bit ordering and functionality is defined by the HID report descriptor used.
|
|
|
|
.. doxygenfunction:: UserHIDGetData
|