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

UM1725

 

HAL SAI Generic Driver

Function Description

Return the SAI error code.

Parameters

 

hsai: : pointer to a SAI_HandleTypeDef structure that

 

 

contains the configuration information for the specified SAI

 

 

Block.

Return values

 

SAI Error Code

50.3SAI Firmware driver defines

50.3.1SAI

SAI Audio Frequency

SAI_AUDIO_FREQUENCY_192K

SAI_AUDIO_FREQUENCY_96K

SAI_AUDIO_FREQUENCY_48K

SAI_AUDIO_FREQUENCY_44K

SAI_AUDIO_FREQUENCY_32K

SAI_AUDIO_FREQUENCY_22K

SAI_AUDIO_FREQUENCY_16K

SAI_AUDIO_FREQUENCY_11K

SAI_AUDIO_FREQUENCY_8K

SAI_AUDIO_FREQUENCY_MCKDIV

SAI Block Clock Strobing

SAI_CLOCKSTROBING_FALLINGEDGE

SAI_CLOCKSTROBING_RISINGEDGE

SAI Block Companding Mode

SAI_NOCOMPANDING

SAI_ULAW_1CPL_COMPANDING

SAI_ALAW_1CPL_COMPANDING

SAI_ULAW_2CPL_COMPANDING

SAI_ALAW_2CPL_COMPANDING

SAI Block Data Size

SAI_DATASIZE_8

SAI_DATASIZE_10

SAI_DATASIZE_16

SAI_DATASIZE_20

SAI_DATASIZE_24

SAI_DATASIZE_32

SAI Block Fifo Status Level

SAI_FIFOSTATUS_EMPTY

DOCID025834 Rev 2

679/900

HAL SAI Generic Driver

UM1725

SAI_FIFOSTATUS_LESS1QUARTERFULL

SAI_FIFOSTATUS_1QUARTERFULL

SAI_FIFOSTATUS_HALFFULL

SAI_FIFOSTATUS_3QUARTERFULL

SAI_FIFOSTATUS_FULL

SAI Block Fifo Threshold

SAI_FIFOTHRESHOLD_EMPTY

SAI_FIFOTHRESHOLD_1QF

SAI_FIFOTHRESHOLD_HF

SAI_FIFOTHRESHOLD_3QF

SAI_FIFOTHRESHOLD_FULL

SAI Block Flags Definition

SAI_FLAG_OVRUDR

SAI_FLAG_MUTEDET

SAI_FLAG_WCKCFG

SAI_FLAG_FREQ

SAI_FLAG_CNRDY

SAI_FLAG_AFSDET

SAI_FLAG_LFSDET

SAI Block FS Definition

SAI_FS_STARTFRAME

SAI_FS_CHANNEL_IDENTIFICATION

SAI Block FS Offset

SAI_FS_FIRSTBIT

SAI_FS_BEFOREFIRSTBIT

SAI Block FS Polarity

SAI_FS_ACTIVE_LOW

SAI_FS_ACTIVE_HIGH

SAI Block Interrupts Definition

SAI_IT_OVRUDR

SAI_IT_MUTEDET

SAI_IT_WCKCFG

SAI_IT_FREQ

SAI_IT_CNRDY

SAI_IT_AFSDET

SAI_IT_LFSDET

SAI Block Mode

680/900

DOCID025834 Rev 2

UM1725

HAL SAI Generic Driver

SAI_MODEMASTER_TX

 

SAI_MODEMASTER_RX

 

SAI_MODESLAVE_TX

 

SAI_MODESLAVE_RX

 

SAI Block MSB LSB transmission

 

SAI_FIRSTBIT_MSB

 

SAI_FIRSTBIT_LSB

 

SAI Block Mute Value

 

SAI_ZERO_VALUE

 

SAI_LAST_SENT_VALUE

 

SAI Block NoDivider

 

SAI_MASTERDIVIDER_ENABLE

 

SAI_MASTERDIVIDER_DISABLE

 

SAI Block Output Drive

 

SAI_OUTPUTDRIVE_DISABLE

 

SAI_OUTPUTDRIVE_ENABLE

 

SAI Block Protocol

 

SAI_FREE_PROTOCOL

 

SAI_SPDIF_PROTOCOL

 

SAI_AC97_PROTOCOL

 

SAI Block Slot Active

 

SAI_SLOT_NOTACTIVE

 

SAI_SLOTACTIVE_0

 

SAI_SLOTACTIVE_1

 

SAI_SLOTACTIVE_2

 

SAI_SLOTACTIVE_3

 

SAI_SLOTACTIVE_4

 

SAI_SLOTACTIVE_5

 

SAI_SLOTACTIVE_6

 

SAI_SLOTACTIVE_7

 

SAI_SLOTACTIVE_8

 

SAI_SLOTACTIVE_9

 

SAI_SLOTACTIVE_10

 

SAI_SLOTACTIVE_11

 

SAI_SLOTACTIVE_12

 

SAI_SLOTACTIVE_13

 

DOCID025834 Rev 2

681/900

HAL SAI Generic Driver

UM1725

SAI_SLOTACTIVE_14

SAI_SLOTACTIVE_15

SAI_SLOTACTIVE_ALL

SAI Block Slot Size

SAI_SLOTSIZE_DATASIZE

SAI_SLOTSIZE_16B

SAI_SLOTSIZE_32B

SAI External synchronisation

SAI_SYNCEXT_DISABLE

SAI_SYNCEXT_IN_ENABLE

SAI_SYNCEXT_OUTBLOCKA_ENABLE

SAI_SYNCEXT_OUTBLOCKB_ENABLE

SAI Block Synchronization

 

 

SAI_ASYNCHRONOUS

 

 

SAI_SYNCHRONOUS

 

 

SAI_SYNCHRONOUS_EXT

 

 

SAI Clock Source

 

 

SAI_CLKSOURCE_PLLSAI

 

 

SAI_CLKSOURCE_PLLI2S

 

 

SAI_CLKSOURCE_EXT

 

 

SAI_CLKSOURCE_NA

No applicable for STM32F446xx

SAI Error Code

 

 

HAL_SAI_ERROR_NONE

 

No error

HAL_SAI_ERROR_OVR

 

Overrun Error

HAL_SAI_ERROR_UDR

 

Underrun error

HAL_SAI_ERROR_AFSDET

 

Anticipated Frame synchronisation detection

HAL_SAI_ERROR_LFSDET

 

Late Frame synchronisation detection

HAL_SAI_ERROR_CNREADY

codec not ready

HAL_SAI_ERROR_WCKCFG

 

Wrong clock configuration

HAL_SAI_ERROR_TIMEOUT

 

Timeout error

SAI Exported Macros

 

 

__HAL_SAI_RESET_HANDLE_STATE Description:

Reset SAI handle state.

Parameters:

__HANDLE__: specifies the SAI Handle.

Return value:

682/900

DOCID025834 Rev 2

UM1725

 

HAL SAI Generic Driver

 

 

None

 

__HAL_SAI_ENABLE_IT

Description:

 

 

Enable or disable the specified SAI

 

 

 

interrupts.

 

 

Parameters:

 

 

__HANDLE__: specifies the SAI Handle.

 

__INTERRUPT__: specifies the interrupt

 

 

source to enable or disable. This parameter

 

 

can be one of the following values:

 

 

 

SAI_IT_OVRUDR: Overrun underrun

 

 

interrupt enable

 

 

 

SAI_IT_MUTEDET: Mute detection

 

 

interrupt enable

 

 

 

SAI_IT_WCKCFG: Wrong Clock

 

 

Configuration interrupt enable

 

 

 

SAI_IT_FREQ: FIFO request interrupt

 

 

enable

 

 

 

SAI_IT_CNRDY: Codec not ready

 

 

interrupt enable

 

 

 

SAI_IT_AFSDET: Anticipated frame

 

 

synchronization detection interrupt

 

 

enable

 

 

 

SAI_IT_LFSDET: Late frame

 

 

 

synchronization detection interrupt

 

 

enabl

 

 

Return value:

 

 

 

None

 

__HAL_SAI_DISABLE_IT

 

 

 

__HAL_SAI_GET_IT_SOURCE

Description:

 

 

Check if the specified SAI interrupt source is

 

 

enabled or disabled.

 

 

Parameters:

 

 

__HANDLE__: specifies the SAI Handle.

 

 

This parameter can be SAI where x: 1, 2, or

 

 

3 to select the SAI peripheral.

 

 

__INTERRUPT__: specifies the SAI

 

 

 

interrupt source to check. This parameter

 

 

can be one of the following values:

 

 

 

SAI_IT_TXE: Tx buffer empty interrupt

 

 

enable.

 

 

 

SAI_IT_RXNE: Rx buffer not empty

 

 

interrupt enable.

 

 

 

SAI_IT_ERR: Error interrupt enable.

 

Return value:

 

 

The: new state of __INTERRUPT__ (TRUE

 

 

or FALSE).

 

__HAL_SAI_GET_FLAG

Description:

 

DOCID025834 Rev 2

683/900

HAL SAI Generic Driver

UM1725

 

Check whether the specified SAI flag is set

 

or not.

 

Parameters:

 

__HANDLE__: specifies the SAI Handle.

 

__FLAG__: specifies the flag to check. This

 

parameter can be one of the following

 

values:

 

SAI_FLAG_OVRUDR: Overrun

 

underrun flag.

 

SAI_FLAG_MUTEDET: Mute detection

 

flag.

 

SAI_FLAG_WCKCFG: Wrong Clock

 

Configuration flag.

 

SAI_FLAG_FREQ: FIFO request flag.

 

SAI_FLAG_CNRDY: Codec not ready

 

flag.

 

SAI_FLAG_AFSDET: Anticipated

 

frame synchronization detection flag.

 

SAI_FLAG_LFSDET: Late frame

 

synchronization detection flag.

 

Return value:

 

The: new state of __FLAG__ (TRUE or

 

FALSE).

__HAL_SAI_CLEAR_FLAG

Description:

 

Clears the specified SAI pending flag.

 

Parameters:

 

__HANDLE__: specifies the SAI Handle.

 

__FLAG__: specifies the flag to check. This

 

parameter can be any combination of the

 

following values:

 

SAI_FLAG_OVRUDR: Clear Overrun

 

underrun

 

SAI_FLAG_MUTEDET: Clear Mute

 

detection

 

SAI_FLAG_WCKCFG: Clear Wrong

 

Clock Configuration

 

SAI_FLAG_FREQ: Clear FIFO request

 

SAI_FLAG_CNRDY: Clear Codec not

 

ready

 

SAI_FLAG_AFSDET: Clear Anticipated

 

frame synchronization detection

 

SAI_FLAG_LFSDET: Clear Late frame

 

synchronization detection

 

Return value:

 

None

__HAL_SAI_ENABLE

 

__HAL_SAI_DISABLE

 

684/900

DOCID025834 Rev 2

UM1725

HAL SAI Generic Driver

SAI Mono Stereo Mode

SAI_STEREOMODE

SAI_MONOMODE

SAI Private Constants

SAI_FIFO_SIZE

SAI_DEFAULT_TIMEOUT

SAI_Private_Macros

IS_SAI_BLOCK_SYNCEXT

IS_SAI_SUPPORTED_PROTOCOL

IS_SAI_PROTOCOL_DATASIZE

IS_SAI_CLK_SOURCE

IS_SAI_AUDIO_FREQUENCY

IS_SAI_BLOCK_MODE

IS_SAI_BLOCK_PROTOCOL

IS_SAI_BLOCK_DATASIZE

IS_SAI_BLOCK_FIRST_BIT

IS_SAI_BLOCK_CLOCK_STROBING

IS_SAI_BLOCK_SYNCHRO

IS_SAI_BLOCK_OUTPUT_DRIVE

IS_SAI_BLOCK_NODIVIDER

IS_SAI_BLOCK_FIFO_STATUS

IS_SAI_BLOCK_MUTE_COUNTER

IS_SAI_BLOCK_MUTE_VALUE

IS_SAI_BLOCK_COMPANDING_MODE

IS_SAI_BLOCK_FIFO_THRESHOLD

IS_SAI_BLOCK_TRISTATE_MANAGEMENT

IS_SAI_MONO_STEREO_MODE

IS_SAI_SLOT_ACTIVE

IS_SAI_BLOCK_SLOT_NUMBER

IS_SAI_BLOCK_SLOT_SIZE

IS_SAI_BLOCK_FIRSTBIT_OFFSET

IS_SAI_BLOCK_FS_OFFSET

IS_SAI_BLOCK_FS_POLARITY

IS_SAI_BLOCK_FS_DEFINITION

IS_SAI_BLOCK_MASTER_DIVIDER

IS_SAI_BLOCK_FRAME_LENGTH

DOCID025834 Rev 2

685/900

HAL SAI Generic Driver

UM1725

IS_SAI_BLOCK_ACTIVE_FRAME

 

SAI Supported protocol

SAI_I2S_STANDARD

SAI_I2S_MSBJUSTIFIED

SAI_I2S_LSBJUSTIFIED

SAI_PCM_LONG

SAI_PCM_SHORT

SAI protocol data size

SAI_PROTOCOL_DATASIZE_16BIT

SAI_PROTOCOL_DATASIZE_16BITEXTENDED

SAI_PROTOCOL_DATASIZE_24BIT

SAI_PROTOCOL_DATASIZE_32BIT

SAI TRIState Management

SAI_OUTPUT_NOTRELEASED

SAI_OUTPUT_RELEASED

686/900

DOCID025834 Rev 2

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