USBD_Audio_OS_RecordReqPend

USBD_Audio_OS_RecordReqPend

Description

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

Files

usbd_audio_os.h / usbd_audio_os.c

Prototype

void *USBD_Audio_OS_RecordReqPend (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 record request, if NO error(s).

Null pointer, otherwise

Callers

Audio Class.

Implementation guidelines

  1. 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 Record Request

Operation result

Error code to assign

No error

USBD_ERR_NONE

Pend timeout

USBD_ERR_OS_TIMEOUT

Pend aborted

USBD_ERR_OS_ABORT

Pend failed for any other reason

USBD_ERR_OS_FAIL