Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
cubexHal.pdf
Скачиваний:
110
Добавлен:
10.02.2016
Размер:
16.16 Mб
Скачать

HAL SPDIFRX Generic Driver

UM1725

55.2.21HAL_SPDIFRX_CxCpltCallback

Function Name

void HAL_SPDIFRX_CxCpltCallback

 

(SPDIFRX_HandleTypeDef * hspdif)

Function Description

Rx Transfer (Control flow) completed callbacks.

Parameters

 

hspdif: SPDIFRX handle

Return values

 

None

55.2.22HAL_SPDIFRX_ErrorCallback

Function Name

void HAL_SPDIFRX_ErrorCallback (SPDIFRX_HandleTypeDef

 

* hspdif)

Function Description

SPDIFRX error callbacks.

Parameters

 

hspdif: SPDIFRX handle

Return values

 

None

55.2.23HAL_SPDIFRX_GetState

Function Name

HAL_SPDIFRX_StateTypeDef HAL_SPDIFRX_GetState

 

(SPDIFRX_HandleTypeDef * hspdif)

Function Description

Return the SPDIFRX state.

Parameters

 

hspdif: : SPDIFRX handle

Return values

 

HAL state

55.2.24HAL_SPDIFRX_GetError

Function Name

uint32_t HAL_SPDIFRX_GetError (SPDIFRX_HandleTypeDef *

 

hspdif)

Function Description

Return the SPDIFRX error code.

Parameters

 

hspdif: : SPDIFRX handle

Return values

 

SPDIFRX Error Code

55.3SPDIFRX Firmware driver defines

55.3.1SPDIFRX

SPDIFRX Channel Status Mask

SPDIFRX_CHANNELSTATUS_OFF

SPDIFRX_CHANNELSTATUS_ON

SPDIFRX Channel Selection

SPDIFRX_CHANNEL_A

SPDIFRX_CHANNEL_B

SPDIFRX Data Format

SPDIFRX_DATAFORMAT_LSB

750/900

DOCID025834 Rev 2

UM1725

 

HAL SPDIFRX Generic Driver

SPDIFRX_DATAFORMAT_MSB

 

 

SPDIFRX_DATAFORMAT_32BITS

 

 

SPDIFRX Error Code

 

 

HAL_SPDIFRX_ERROR_NONE

No error

 

HAL_SPDIFRX_ERROR_TIMEOUT

Timeout error

HAL_SPDIFRX_ERROR_OVR

OVR error

 

HAL_SPDIFRX_ERROR_PE

Parity error

 

HAL_SPDIFRX_ERROR_DMA

DMA transfer error

HAL_SPDIFRX_ERROR_UNKNOWN

Unknown Error error

SPDIFRX Exported Macros

 

 

__HAL_SPDIFRX_RESET_HANDLE_STATE Description:

 

Reset SPDIFRX handle state.

 

Parameters:

 

 

__HANDLE__: SPDIFRX handle.

 

Return value:

 

 

None

__HAL_SPDIFRX_IDLE

Description:

 

Disable the specified SPDIFRX

 

 

peripheral (IDLE State).

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SPDIFRX Handle.

 

Return value:

 

 

None

__HAL_SPDIFRX_SYNC

Description:

 

Enable the specified SPDIFRX

 

 

peripheral (SYNC State).

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SPDIFRX Handle.

 

Return value:

 

 

None

__HAL_SPDIFRX_RCV

Description:

 

Enable the specified SPDIFRX

 

 

peripheral (RCV State).

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SPDIFRX Handle.

DOCID025834 Rev 2

751/900

HAL SPDIFRX Generic Driver

 

 

UM1725

 

 

Return value:

 

 

 

None

 

__HAL_SPDIFRX_ENABLE_IT

Description:

 

 

Enable or disable the specified

 

 

 

SPDIFRX interrupts.

 

 

Parameters:

 

 

 

__HANDLE__: specifies the

 

 

 

SPDIFRX Handle.

 

 

 

__INTERRUPT__: specifies the

 

 

 

interrupt source to enable or disable.

 

 

 

This parameter can be one of the

 

 

 

following values:

 

 

 

 

SPDIFRX_IT_RXNE

 

 

 

 

SPDIFRX_IT_CSRNE

 

 

 

 

SPDIFRX_IT_PERRIE

 

 

 

 

SPDIFRX_IT_OVRIE

 

 

 

 

SPDIFRX_IT_SBLKIE

 

 

 

 

SPDIFRX_IT_SYNCDIE

 

 

 

SPDIFRX_IT_IFEIE

 

 

Return value:

 

 

 

None

 

__HAL_SPDIFRX_DISABLE_IT

 

 

 

 

__HAL_SPDIFRX_GET_IT_SOURCE

Description:

 

 

Checks if the specified SPDIFRX

 

 

 

interrupt source is enabled or

 

 

 

disabled.

 

 

Parameters:

 

 

 

__HANDLE__: specifies the

 

 

 

SPDIFRX Handle.

 

 

 

__INTERRUPT__: specifies the

 

 

 

SPDIFRX interrupt source to check.

 

 

 

This parameter can be one of the

 

 

 

following values:

 

 

 

 

SPDIFRX_IT_RXNE

 

 

 

 

SPDIFRX_IT_CSRNE

 

 

 

 

SPDIFRX_IT_PERRIE

 

 

 

 

SPDIFRX_IT_OVRIE

 

 

 

 

SPDIFRX_IT_SBLKIE

 

 

 

 

SPDIFRX_IT_SYNCDIE

 

 

 

SPDIFRX_IT_IFEIE

 

 

Return value:

 

 

The: new state of __IT__ (TRUE or

 

 

 

FALSE).

 

__HAL_SPDIFRX_GET_FLAG

Description:

 

 

Checks whether the specified

752/900

DOCID025834 Rev 2

 

 

UM1725

 

 

HAL SPDIFRX Generic Driver

 

 

SPDIFRX flag is set or not.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SPDIFRX Handle.

 

__FLAG__: specifies the flag to

 

 

check. This parameter can be one of

 

 

the following values:

 

 

 

SPDIFRX_FLAG_RXNE

 

 

 

SPDIFRX_FLAG_CSRNE

 

 

 

SPDIFRX_FLAG_PERR

 

 

 

SPDIFRX_FLAG_OVR

 

 

 

SPDIFRX_FLAG_SBD

 

 

 

SPDIFRX_FLAG_SYNCD

 

 

 

SPDIFRX_FLAG_FERR

 

 

 

SPDIFRX_FLAG_SERR

 

 

SPDIFRX_FLAG_TERR

 

Return value:

 

The: new state of __FLAG__ (TRUE

 

 

or FALSE).

__HAL_SPDIFRX_CLEAR_IT

Description:

 

Clears the specified SPDIFRX SR

 

 

flag, in setting the proper IFCR

 

 

register bit.

 

Parameters:

 

__HANDLE__: specifies the USART

 

 

Handle.

 

 

__IT_CLEAR__: specifies the

 

 

interrupt clear register flag that needs

 

 

to be set to clear the corresponding

 

 

interrupt This parameter can be one

 

 

of the following values:

 

 

 

SPDIFRX_FLAG_PERR

 

 

 

SPDIFRX_FLAG_OVR

 

 

 

SPDIFRX_SR_SBD

 

 

SPDIFRX_SR_SYNCD

 

Return value:

 

 

None

SPDIFRX Flags Definition

SPDIFRX_FLAG_RXNE

SPDIFRX_FLAG_CSRNE

SPDIFRX_FLAG_PERR

SPDIFRX_FLAG_OVR

SPDIFRX_FLAG_SBD

SPDIFRX_FLAG_SYNCD

DOCID025834 Rev 2

753/900

HAL SPDIFRX Generic Driver

UM1725

SPDIFRX_FLAG_FERR

SPDIFRX_FLAG_SERR

SPDIFRX_FLAG_TERR

SPDIFRX Input Selection

SPDIFRX_INPUT_IN0

SPDIFRX_INPUT_IN1

SPDIFRX_INPUT_IN2

SPDIFRX_INPUT_IN3

SPDIFRX Interrupts Definition

SPDIFRX_IT_RXNE

SPDIFRX_IT_CSRNE

SPDIFRX_IT_PERRIE

SPDIFRX_IT_OVRIE

SPDIFRX_IT_SBLKIE

SPDIFRX_IT_SYNCDIE

SPDIFRX_IT_IFEIE

SPDIFRX Maximum Retries

SPDIFRX_MAXRETRIES_NONE

SPDIFRX_MAXRETRIES_3

SPDIFRX_MAXRETRIES_15

SPDIFRX_MAXRETRIES_63

SPDIFRX Parity Error Mask

SPDIFRX_PARITYERRORMASK_OFF

SPDIFRX_PARITYERRORMASK_ON

SPDIFRX Private Macros

IS_SPDIFRX_INPUT_SELECT

IS_SPDIFRX_MAX_RETRIES

IS_SPDIFRX_WAIT_FOR_ACTIVITY

IS_PREAMBLE_TYPE_MASK

IS_VALIDITY_MASK

IS_PARITY_ERROR_MASK

IS_SPDIFRX_CHANNEL

IS_SPDIFRX_DATA_FORMAT

IS_STEREO_MODE

IS_CHANNEL_STATUS_MASK

SPDIFRX Preamble Type Mask

754/900

DOCID025834 Rev 2

UM1725 HAL SPDIFRX Generic Driver

SPDIFRX_PREAMBLETYPEMASK_OFF

SPDIFRX_PREAMBLETYPEMASK_ON

SPDIFRX State

SPDIFRX_STATE_IDLE

SPDIFRX_STATE_SYNC

SPDIFRX_STATE_RCV

SPDIFRX Stereo Mode

SPDIFRX_STEREOMODE_DISABLE

SPDIFRX_STEREOMODE_ENABLE

SPDIFRX Validity Mask

SPDIFRX_VALIDITYMASK_OFF

SPDIFRX_VALIDITYMASK_ON

SPDIFRX Wait For Activity

SPDIFRX_WAITFORACTIVITY_OFF

SPDIFRX_WAITFORACTIVITY_ON

DOCID025834 Rev 2

755/900

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]