From 9f95ff5b6ba01db09552b84a0ab79607060a2666 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Wed, 11 Dec 2019 08:59:21 +0100 Subject: Official ARM version: v5.4.0 Add CMSIS V5.4.0, please refer to index.html available under \docs folder. Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure used in existing projects, and thus avoid projects mass update Note: the following components have been removed from ARM original delivery (as not used in ST packages) - CMSIS_EW2018.pdf - .gitattributes - .gitignore - \Device - \CMSIS - \CoreValidation - \DAP - \Documentation - \DoxyGen - \Driver - \Pack - \RTOS\CMSIS_RTOS_Tutorial.pdf - \RTOS\RTX - \RTOS\Template - \RTOS2\RTX - \Utilities - All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2 Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3 --- .../Driver/html/group__sai__execution__status.html | 453 +++++++++++++++++++++ 1 file changed, 453 insertions(+) create mode 100644 docs/Driver/html/group__sai__execution__status.html (limited to 'docs/Driver/html/group__sai__execution__status.html') diff --git a/docs/Driver/html/group__sai__execution__status.html b/docs/Driver/html/group__sai__execution__status.html new file mode 100644 index 0000000..7d1a260 --- /dev/null +++ b/docs/Driver/html/group__sai__execution__status.html @@ -0,0 +1,453 @@ + + + + + +Status Error Codes +CMSIS-Driver: Status Error Codes + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-Driver +  Version 2.6.0 +
+
Peripheral Interface for Middleware and Application Code
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Macros
+
+
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. More...
 
#define ARM_SAI_ERROR_PROTOCOL   (ARM_DRIVER_ERROR_SPECIFIC - 2)
 Specified Protocol not supported. More...
 
#define ARM_SAI_ERROR_DATA_SIZE   (ARM_DRIVER_ERROR_SPECIFIC - 3)
 Specified Data size not supported. More...
 
#define ARM_SAI_ERROR_BIT_ORDER   (ARM_DRIVER_ERROR_SPECIFIC - 4)
 Specified Bit order not supported. More...
 
#define ARM_SAI_ERROR_MONO_MODE   (ARM_DRIVER_ERROR_SPECIFIC - 5)
 Specified Mono mode not supported. More...
 
#define ARM_SAI_ERROR_COMPANDING   (ARM_DRIVER_ERROR_SPECIFIC - 6)
 Specified Companding not supported. More...
 
#define ARM_SAI_ERROR_CLOCK_POLARITY   (ARM_DRIVER_ERROR_SPECIFIC - 7)
 Specified Clock polarity not supported. More...
 
#define ARM_SAI_ERROR_AUDIO_FREQ   (ARM_DRIVER_ERROR_SPECIFIC - 8)
 Specified Audio frequency not supported. More...
 
#define ARM_SAI_ERROR_MCLK_PIN   (ARM_DRIVER_ERROR_SPECIFIC - 9)
 Specified MCLK Pin setting not supported. More...
 
#define ARM_SAI_ERROR_MCLK_PRESCALER   (ARM_DRIVER_ERROR_SPECIFIC - 10)
 Specified MCLK Prescaler not supported. More...
 
#define ARM_SAI_ERROR_FRAME_LENGHT   (ARM_DRIVER_ERROR_SPECIFIC - 11)
 Specified Frame length not supported. More...
 
#define ARM_SAI_ERROR_FRAME_SYNC_WIDTH   (ARM_DRIVER_ERROR_SPECIFIC - 12)
 Specified Frame Sync width not supported. More...
 
#define ARM_SAI_ERROR_FRAME_SYNC_POLARITY   (ARM_DRIVER_ERROR_SPECIFIC - 13)
 Specified Frame Sync polarity not supported. More...
 
#define ARM_SAI_ERROR_FRAME_SYNC_EARLY   (ARM_DRIVER_ERROR_SPECIFIC - 14)
 Specified Frame Sync early not supported. More...
 
#define ARM_SAI_ERROR_SLOT_COUNT   (ARM_DRIVER_ERROR_SPECIFIC - 15)
 Specified Slot count not supported. More...
 
#define ARM_SAI_ERROR_SLOT_SIZE   (ARM_DRIVER_ERROR_SPECIFIC - 16)
 Specified Slot size not supported. More...
 
#define ARM_SAI_ERROR_SLOT_OFFESET   (ARM_DRIVER_ERROR_SPECIFIC - 17)
 Specified Slot offset not supported. More...
 
+

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

+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#define ARM_SAI_ERROR_FRAME_LENGHT   (ARM_DRIVER_ERROR_SPECIFIC - 11)
+
+ +

Specified Frame length not supported.

+

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

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+ +
+
+ + + + +
#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.

+ +
+
+
+
+ + + + -- cgit