| CMSIS-Driver Peripheral Interface for Middleware and Application Code |

Loading...
Searching...
No Matches
Macros
SAI Status Error Codes
SAI Interface

Negative values indicate errors (SAI has specific codes in addition to common Status Error Codes). More...

## Macros
#define | ARM_SAI_ERROR_SYNCHRONIZATION (ARM_DRIVER_ERROR_SPECIFIC - 1)
| Specified Synchronization not supported.
#define | ARM_SAI_ERROR_PROTOCOL (ARM_DRIVER_ERROR_SPECIFIC - 2)
| Specified Protocol not supported.
#define | ARM_SAI_ERROR_DATA_SIZE (ARM_DRIVER_ERROR_SPECIFIC - 3)
| Specified Data size not supported.
#define | ARM_SAI_ERROR_BIT_ORDER (ARM_DRIVER_ERROR_SPECIFIC - 4)
| Specified Bit order not supported.
#define | ARM_SAI_ERROR_MONO_MODE (ARM_DRIVER_ERROR_SPECIFIC - 5)
| Specified Mono mode not supported.
#define | ARM_SAI_ERROR_COMPANDING (ARM_DRIVER_ERROR_SPECIFIC - 6)
| Specified Companding not supported.
#define | ARM_SAI_ERROR_CLOCK_POLARITY (ARM_DRIVER_ERROR_SPECIFIC - 7)
| Specified Clock polarity not supported.
#define | ARM_SAI_ERROR_AUDIO_FREQ (ARM_DRIVER_ERROR_SPECIFIC - 8)
| Specified Audio frequency not supported.
#define | ARM_SAI_ERROR_MCLK_PIN (ARM_DRIVER_ERROR_SPECIFIC - 9)
| Specified MCLK Pin setting not supported.
#define | ARM_SAI_ERROR_MCLK_PRESCALER (ARM_DRIVER_ERROR_SPECIFIC - 10)
| Specified MCLK Prescaler not supported.
#define | ARM_SAI_ERROR_FRAME_LENGTH (ARM_DRIVER_ERROR_SPECIFIC - 11)
| Specified Frame length not supported.
#define | ARM_SAI_ERROR_FRAME_SYNC_WIDTH (ARM_DRIVER_ERROR_SPECIFIC - 12)
| Specified Frame Sync width not supported.
#define | ARM_SAI_ERROR_FRAME_SYNC_POLARITY (ARM_DRIVER_ERROR_SPECIFIC - 13)
| Specified Frame Sync polarity not supported.
#define | ARM_SAI_ERROR_FRAME_SYNC_EARLY (ARM_DRIVER_ERROR_SPECIFIC - 14)
| Specified Frame Sync early not supported.
#define | ARM_SAI_ERROR_SLOT_COUNT (ARM_DRIVER_ERROR_SPECIFIC - 15)
| Specified Slot count not supported.
#define | ARM_SAI_ERROR_SLOT_SIZE (ARM_DRIVER_ERROR_SPECIFIC - 16)
| Specified Slot size not supported.
#define | ARM_SAI_ERROR_SLOT_OFFESET (ARM_DRIVER_ERROR_SPECIFIC - 17)
| Specified Slot offset not supported.

## Description

Negative values indicate errors (SAI has specific codes in addition to common Status Error Codes).

The SAI driver has additional status error codes that are listed below.

Note
  - In case multiple errors exist, only the first encountered error will be reported.
  - errors ARM_SAI_ERROR_BIT_ORDER, ARM_SAI_ERROR_FRAME_SYNC_xxx, ARM_SAI_ERROR_SLOT_xxx will only be reported in User Defined Protocol mode.
  - The SAI driver also returns the common Status Error Codes.

## Macro Definition Documentation

## ◆ ARM_SAI_ERROR_SYNCHRONIZATION

#define ARM_SAI_ERROR_SYNCHRONIZATION (ARM_DRIVER_ERROR_SPECIFIC - 1)

Specified Synchronization not supported.

The synchronization requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_PROTOCOL

#define ARM_SAI_ERROR_PROTOCOL (ARM_DRIVER_ERROR_SPECIFIC - 2)

Specified Protocol not supported.

The protocol requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_DATA_SIZE

#define ARM_SAI_ERROR_DATA_SIZE (ARM_DRIVER_ERROR_SPECIFIC - 3)

Specified Data size not supported.

The data size requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_BIT_ORDER

#define ARM_SAI_ERROR_BIT_ORDER (ARM_DRIVER_ERROR_SPECIFIC - 4)

Specified Bit order not supported.

The bit order requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_MONO_MODE

#define ARM_SAI_ERROR_MONO_MODE (ARM_DRIVER_ERROR_SPECIFIC - 5)

Specified Mono mode not supported.

The mono mode requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_COMPANDING

#define ARM_SAI_ERROR_COMPANDING (ARM_DRIVER_ERROR_SPECIFIC - 6)

Specified Companding not supported.

The companding requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_CLOCK_POLARITY

#define ARM_SAI_ERROR_CLOCK_POLARITY (ARM_DRIVER_ERROR_SPECIFIC - 7)

Specified Clock polarity not supported.

The clock polarity requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_AUDIO_FREQ

#define ARM_SAI_ERROR_AUDIO_FREQ (ARM_DRIVER_ERROR_SPECIFIC - 8)

Specified Audio frequency not supported.

The audio frequency requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_MCLK_PIN

#define ARM_SAI_ERROR_MCLK_PIN (ARM_DRIVER_ERROR_SPECIFIC - 9)

Specified MCLK Pin setting not supported.

The MCLK pin setting requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_MCLK_PRESCALER

#define ARM_SAI_ERROR_MCLK_PRESCALER (ARM_DRIVER_ERROR_SPECIFIC - 10)

Specified MCLK Prescaler not supported.

The MCLK prescaler requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_FRAME_LENGTH

#define ARM_SAI_ERROR_FRAME_LENGTH (ARM_DRIVER_ERROR_SPECIFIC - 11)

Specified Frame length not supported.

The frame length requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_FRAME_SYNC_WIDTH

#define ARM_SAI_ERROR_FRAME_SYNC_WIDTH (ARM_DRIVER_ERROR_SPECIFIC - 12)

Specified Frame Sync width not supported.

The frame sync width requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_FRAME_SYNC_POLARITY

#define ARM_SAI_ERROR_FRAME_SYNC_POLARITY (ARM_DRIVER_ERROR_SPECIFIC - 13)

Specified Frame Sync polarity not supported.

The frame sync polarity requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_FRAME_SYNC_EARLY

#define ARM_SAI_ERROR_FRAME_SYNC_EARLY (ARM_DRIVER_ERROR_SPECIFIC - 14)

Specified Frame Sync early not supported.

The frame sync early requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_SLOT_COUNT

#define ARM_SAI_ERROR_SLOT_COUNT (ARM_DRIVER_ERROR_SPECIFIC - 15)

Specified Slot count not supported.

The slot count requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_SLOT_SIZE

#define ARM_SAI_ERROR_SLOT_SIZE (ARM_DRIVER_ERROR_SPECIFIC - 16)

Specified Slot size not supported.

The slot size requested with the function ARM_SAI_Control is not supported.

## ◆ ARM_SAI_ERROR_SLOT_OFFESET

#define ARM_SAI_ERROR_SLOT_OFFESET (ARM_DRIVER_ERROR_SPECIFIC - 17)

Specified Slot offset not supported.

The slot offset requested with the function ARM_SAI_Control is not supported.