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 --- docs/Driver/html/group__USART__events.html | 380 +++++++++++++++++++++++++++++ 1 file changed, 380 insertions(+) create mode 100644 docs/Driver/html/group__USART__events.html (limited to 'docs/Driver/html/group__USART__events.html') diff --git a/docs/Driver/html/group__USART__events.html b/docs/Driver/html/group__USART__events.html new file mode 100644 index 0000000..4f079dc --- /dev/null +++ b/docs/Driver/html/group__USART__events.html @@ -0,0 +1,380 @@ + + + + + +USART Events +CMSIS-Driver: USART Events + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-Driver +  Version 2.6.0 +
+
Peripheral Interface for Middleware and Application Code
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+ +
+
USART Events
+
+
+ +

The USART driver generates call back events that are notified via the function ARM_USART_SignalEvent. +More...

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define ARM_USART_EVENT_SEND_COMPLETE   (1UL << 0)
 Send completed; however USART may still transmit data. More...
 
#define ARM_USART_EVENT_RECEIVE_COMPLETE   (1UL << 1)
 Receive completed. More...
 
#define ARM_USART_EVENT_TRANSFER_COMPLETE   (1UL << 2)
 Transfer completed. More...
 
#define ARM_USART_EVENT_TX_COMPLETE   (1UL << 3)
 Transmit completed (optional) More...
 
#define ARM_USART_EVENT_TX_UNDERFLOW   (1UL << 4)
 Transmit data not available (Synchronous Slave) More...
 
#define ARM_USART_EVENT_RX_OVERFLOW   (1UL << 5)
 Receive data overflow. More...
 
#define ARM_USART_EVENT_RX_TIMEOUT   (1UL << 6)
 Receive character timeout (optional) More...
 
#define ARM_USART_EVENT_RX_BREAK   (1UL << 7)
 Break detected on receive. More...
 
#define ARM_USART_EVENT_RX_FRAMING_ERROR   (1UL << 8)
 Framing error detected on receive. More...
 
#define ARM_USART_EVENT_RX_PARITY_ERROR   (1UL << 9)
 Parity error detected on receive. More...
 
#define ARM_USART_EVENT_CTS   (1UL << 10)
 CTS state changed (optional) More...
 
#define ARM_USART_EVENT_DSR   (1UL << 11)
 DSR state changed (optional) More...
 
#define ARM_USART_EVENT_DCD   (1UL << 12)
 DCD state changed (optional) More...
 
#define ARM_USART_EVENT_RI   (1UL << 13)
 RI state changed (optional) More...
 
+

Description

+

The USART driver generates call back events that are notified via the function ARM_USART_SignalEvent.

+

This section provides the event values for the ARM_USART_SignalEvent callback function.

+

The following call back notification events are generated:

+

Macro Definition Documentation

+ +
+
+ + + + +
#define ARM_USART_EVENT_SEND_COMPLETE   (1UL << 0)
+
+ +

Send completed; however USART may still transmit data.

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_RECEIVE_COMPLETE   (1UL << 1)
+
+ +

Receive completed.

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_TRANSFER_COMPLETE   (1UL << 2)
+
+ +

Transfer completed.

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_TX_COMPLETE   (1UL << 3)
+
+ +

Transmit completed (optional)

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_TX_UNDERFLOW   (1UL << 4)
+
+ +

Transmit data not available (Synchronous Slave)

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_RX_OVERFLOW   (1UL << 5)
+
+ +

Receive data overflow.

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_RX_TIMEOUT   (1UL << 6)
+
+ +

Receive character timeout (optional)

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_RX_BREAK   (1UL << 7)
+
+ +

Break detected on receive.

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_RX_FRAMING_ERROR   (1UL << 8)
+
+ +

Framing error detected on receive.

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_RX_PARITY_ERROR   (1UL << 9)
+
+ +

Parity error detected on receive.

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_CTS   (1UL << 10)
+
+ +

CTS state changed (optional)

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_DSR   (1UL << 11)
+
+ +

DSR state changed (optional)

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_DCD   (1UL << 12)
+
+ +

DCD state changed (optional)

+ +
+
+ +
+
+ + + + +
#define ARM_USART_EVENT_RI   (1UL << 13)
+
+ +

RI state changed (optional)

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