USBD_Audio_OS_PlaybackReqPend

Description

Pend on a request from the playback's task queue.

Files

usbd_audio_os.h / usbd_audio_os.c

Prototype

void  *USBD_Audio_OS_PlaybackReqPend (USBD_ERR  *p_err);


Arguments

p_err

Pointer to variable that will receive the return error code from this function.

USBD_ERR_NONE
USBD_ERR_OS_TIMEOUT
USBD_ERR_OS_ABORT
USBD_ERR_OS_FAIL

Returned Value

Pointer to playback request, if NO error(s).

Null pointer, otherwise.

Callers

Audio Class.

Implementation Guidelines

Typical implementation will consist in pending on a queue.

p_err argument should be assigned as described in following table.

Table - Error Code Assignment for Pending on a Playback Request
Operation resultError code to assign
No errorUSBD_ERR_NONE
Pend timeoutUSBD_ERR_OS_TIMEOUT
Pend abortedUSBD_ERR_OS_ABORT
Pend failed for any other reasonUSBD_ERR_OS_FAIL