My Project
Loading...
Searching...
No Matches
stm32f3xx_hal_uart.h
Go to the documentation of this file.
1
19/* Define to prevent recursive inclusion -------------------------------------*/
20#ifndef STM32F3xx_HAL_UART_H
21#define STM32F3xx_HAL_UART_H
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27/* Includes ------------------------------------------------------------------*/
28#include "stm32f3xx_hal_def.h"
29
38/* Exported types ------------------------------------------------------------*/
46typedef struct
47{
48 uint32_t BaudRate;
60 uint32_t WordLength;
63 uint32_t StopBits;
66 uint32_t Parity;
73 uint32_t Mode;
76 uint32_t HwFlowCtl;
80 uint32_t OverSampling;
84 uint32_t OneBitSampling;
90
94typedef struct
95{
96 uint32_t AdvFeatureInit;
107 uint32_t DataInvert;
111 uint32_t Swap;
114 uint32_t OverrunDisable;
127 uint32_t MSBFirst;
130
171typedef uint32_t HAL_UART_StateTypeDef;
172
176typedef enum
177{
185
195typedef uint32_t HAL_UART_RxTypeTypeDef;
196
207
212{
219 const uint8_t *pTxBuffPtr;
221 uint16_t TxXferSize;
223 __IO uint16_t TxXferCount;
225 uint8_t *pRxBuffPtr;
227 uint16_t RxXferSize;
229 __IO uint16_t RxXferCount;
231 uint16_t Mask;
237 void (*RxISR)(struct __UART_HandleTypeDef *huart);
239 void (*TxISR)(struct __UART_HandleTypeDef *huart);
254 __IO uint32_t ErrorCode;
256#if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
257 void (* TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart);
258 void (* TxCpltCallback)(struct __UART_HandleTypeDef *huart);
259 void (* RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart);
260 void (* RxCpltCallback)(struct __UART_HandleTypeDef *huart);
261 void (* ErrorCallback)(struct __UART_HandleTypeDef *huart);
262 void (* AbortCpltCallback)(struct __UART_HandleTypeDef *huart);
263 void (* AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart);
264 void (* AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart);
265 void (* WakeupCallback)(struct __UART_HandleTypeDef *huart);
266 void (* RxEventCallback)(struct __UART_HandleTypeDef *huart, uint16_t Pos);
268 void (* MspInitCallback)(struct __UART_HandleTypeDef *huart);
269 void (* MspDeInitCallback)(struct __UART_HandleTypeDef *huart);
270#endif /* USE_HAL_UART_REGISTER_CALLBACKS */
271
273
274#if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
278typedef enum
279{
280 HAL_UART_TX_HALFCOMPLETE_CB_ID = 0x00U,
281 HAL_UART_TX_COMPLETE_CB_ID = 0x01U,
282 HAL_UART_RX_HALFCOMPLETE_CB_ID = 0x02U,
283 HAL_UART_RX_COMPLETE_CB_ID = 0x03U,
284 HAL_UART_ERROR_CB_ID = 0x04U,
285 HAL_UART_ABORT_COMPLETE_CB_ID = 0x05U,
286 HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U,
287 HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U,
288 HAL_UART_WAKEUP_CB_ID = 0x08U,
290 HAL_UART_MSPINIT_CB_ID = 0x0BU,
291 HAL_UART_MSPDEINIT_CB_ID = 0x0CU
293} HAL_UART_CallbackIDTypeDef;
294
298typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart);
299typedef void (*pUART_RxEventCallbackTypeDef)
300(struct __UART_HandleTypeDef *huart, uint16_t Pos);
302#endif /* USE_HAL_UART_REGISTER_CALLBACKS */
303
308/* Exported constants --------------------------------------------------------*/
316#define HAL_UART_STATE_RESET 0x00000000U
318#define HAL_UART_STATE_READY 0x00000020U
320#define HAL_UART_STATE_BUSY 0x00000024U
322#define HAL_UART_STATE_BUSY_TX 0x00000021U
324#define HAL_UART_STATE_BUSY_RX 0x00000022U
326#define HAL_UART_STATE_BUSY_TX_RX 0x00000023U
329#define HAL_UART_STATE_TIMEOUT 0x000000A0U
331#define HAL_UART_STATE_ERROR 0x000000E0U
340#define HAL_UART_ERROR_NONE (0x00000000U)
341#define HAL_UART_ERROR_PE (0x00000001U)
342#define HAL_UART_ERROR_NE (0x00000002U)
343#define HAL_UART_ERROR_FE (0x00000004U)
344#define HAL_UART_ERROR_ORE (0x00000008U)
345#define HAL_UART_ERROR_DMA (0x00000010U)
346#define HAL_UART_ERROR_RTO (0x00000020U)
348#if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
349#define HAL_UART_ERROR_INVALID_CALLBACK (0x00000040U)
350#endif /* USE_HAL_UART_REGISTER_CALLBACKS */
358#define UART_STOPBITS_0_5 USART_CR2_STOP_0
359#define UART_STOPBITS_1 0x00000000U
360#define UART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1)
361#define UART_STOPBITS_2 USART_CR2_STOP_1
369#define UART_PARITY_NONE 0x00000000U
370#define UART_PARITY_EVEN USART_CR1_PCE
371#define UART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS)
379#define UART_HWCONTROL_NONE 0x00000000U
380#define UART_HWCONTROL_RTS USART_CR3_RTSE
381#define UART_HWCONTROL_CTS USART_CR3_CTSE
382#define UART_HWCONTROL_RTS_CTS (USART_CR3_RTSE | USART_CR3_CTSE)
390#define UART_MODE_RX USART_CR1_RE
391#define UART_MODE_TX USART_CR1_TE
392#define UART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE)
400#define UART_STATE_DISABLE 0x00000000U
401#define UART_STATE_ENABLE USART_CR1_UE
409#define UART_OVERSAMPLING_16 0x00000000U
410#define UART_OVERSAMPLING_8 USART_CR1_OVER8
418#define UART_ONE_BIT_SAMPLE_DISABLE 0x00000000U
419#define UART_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT
427#define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT 0x00000000U
429#define UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE USART_CR2_ABRMODE_0
431#define UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME USART_CR2_ABRMODE_1
433#define UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME USART_CR2_ABRMODE
442#define UART_RECEIVER_TIMEOUT_DISABLE 0x00000000U
443#define UART_RECEIVER_TIMEOUT_ENABLE USART_CR2_RTOEN
451#define UART_LIN_DISABLE 0x00000000U
452#define UART_LIN_ENABLE USART_CR2_LINEN
460#define UART_LINBREAKDETECTLENGTH_10B 0x00000000U
461#define UART_LINBREAKDETECTLENGTH_11B USART_CR2_LBDL
469#define UART_DMA_TX_DISABLE 0x00000000U
470#define UART_DMA_TX_ENABLE USART_CR3_DMAT
478#define UART_DMA_RX_DISABLE 0x00000000U
479#define UART_DMA_RX_ENABLE USART_CR3_DMAR
487#define UART_HALF_DUPLEX_DISABLE 0x00000000U
488#define UART_HALF_DUPLEX_ENABLE USART_CR3_HDSEL
496#define UART_WAKEUPMETHOD_IDLELINE 0x00000000U
497#define UART_WAKEUPMETHOD_ADDRESSMARK USART_CR1_WAKE
505#define UART_AUTOBAUD_REQUEST USART_RQR_ABRRQ
506#define UART_SENDBREAK_REQUEST USART_RQR_SBKRQ
507#define UART_MUTE_MODE_REQUEST USART_RQR_MMRQ
508#define UART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ
509#define UART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ
517#define UART_ADVFEATURE_NO_INIT 0x00000000U
518#define UART_ADVFEATURE_TXINVERT_INIT 0x00000001U
519#define UART_ADVFEATURE_RXINVERT_INIT 0x00000002U
520#define UART_ADVFEATURE_DATAINVERT_INIT 0x00000004U
521#define UART_ADVFEATURE_SWAP_INIT 0x00000008U
522#define UART_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U
523#define UART_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U
524#define UART_ADVFEATURE_AUTOBAUDRATE_INIT 0x00000040U
525#define UART_ADVFEATURE_MSBFIRST_INIT 0x00000080U
533#define UART_ADVFEATURE_TXINV_DISABLE 0x00000000U
534#define UART_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV
542#define UART_ADVFEATURE_RXINV_DISABLE 0x00000000U
543#define UART_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV
551#define UART_ADVFEATURE_DATAINV_DISABLE 0x00000000U
552#define UART_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV
560#define UART_ADVFEATURE_SWAP_DISABLE 0x00000000U
561#define UART_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP
569#define UART_ADVFEATURE_OVERRUN_ENABLE 0x00000000U
570#define UART_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS
578#define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE 0x00000000U
579#define UART_ADVFEATURE_AUTOBAUDRATE_ENABLE USART_CR2_ABREN
587#define UART_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U
588#define UART_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE
596#define UART_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U
598#define UART_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST
607#define UART_ADVFEATURE_STOPMODE_DISABLE 0x00000000U
608#define UART_ADVFEATURE_STOPMODE_ENABLE USART_CR1_UESM
616#define UART_ADVFEATURE_MUTEMODE_DISABLE 0x00000000U
617#define UART_ADVFEATURE_MUTEMODE_ENABLE USART_CR1_MME
625#define UART_CR2_ADDRESS_LSB_POS 24U
633#define UART_WAKEUP_ON_ADDRESS 0x00000000U
634#define UART_WAKEUP_ON_STARTBIT USART_CR3_WUS_1
635#define UART_WAKEUP_ON_READDATA_NONEMPTY USART_CR3_WUS
644#define UART_DE_POLARITY_HIGH 0x00000000U
645#define UART_DE_POLARITY_LOW USART_CR3_DEP
653#define UART_CR1_DEAT_ADDRESS_LSB_POS 21U
662#define UART_CR1_DEDT_ADDRESS_LSB_POS 16U
671#define UART_IT_MASK 0x001FU
679#define HAL_UART_TIMEOUT_VALUE 0x1FFFFFFU
689#define UART_FLAG_REACK USART_ISR_REACK
690#define UART_FLAG_TEACK USART_ISR_TEACK
691#define UART_FLAG_WUF USART_ISR_WUF
692#define UART_FLAG_RWU USART_ISR_RWU
693#define UART_FLAG_SBKF USART_ISR_SBKF
694#define UART_FLAG_CMF USART_ISR_CMF
695#define UART_FLAG_BUSY USART_ISR_BUSY
696#define UART_FLAG_ABRF USART_ISR_ABRF
697#define UART_FLAG_ABRE USART_ISR_ABRE
698#define UART_FLAG_RTOF USART_ISR_RTOF
699#define UART_FLAG_CTS USART_ISR_CTS
700#define UART_FLAG_CTSIF USART_ISR_CTSIF
701#define UART_FLAG_LBDF USART_ISR_LBDF
702#define UART_FLAG_TXE USART_ISR_TXE
703#define UART_FLAG_TC USART_ISR_TC
704#define UART_FLAG_RXNE USART_ISR_RXNE
705#define UART_FLAG_IDLE USART_ISR_IDLE
706#define UART_FLAG_ORE USART_ISR_ORE
707#define UART_FLAG_NE USART_ISR_NE
708#define UART_FLAG_FE USART_ISR_FE
709#define UART_FLAG_PE USART_ISR_PE
732#define UART_IT_PE 0x0028U
733#define UART_IT_TXE 0x0727U
734#define UART_IT_TC 0x0626U
735#define UART_IT_RXNE 0x0525U
736#define UART_IT_IDLE 0x0424U
737#define UART_IT_LBD 0x0846U
738#define UART_IT_CTS 0x096AU
739#define UART_IT_CM 0x112EU
740#define UART_IT_WUF 0x1476U
741#define UART_IT_RTO 0x0B3AU
743#define UART_IT_ERR 0x0060U
745#define UART_IT_ORE 0x0300U
746#define UART_IT_NE 0x0200U
747#define UART_IT_FE 0x0100U
755#define UART_CLEAR_PEF USART_ICR_PECF
756#define UART_CLEAR_FEF USART_ICR_FECF
757#define UART_CLEAR_NEF USART_ICR_NCF
758#define UART_CLEAR_OREF USART_ICR_ORECF
759#define UART_CLEAR_IDLEF USART_ICR_IDLECF
760#define UART_CLEAR_TCF USART_ICR_TCCF
761#define UART_CLEAR_LBDF USART_ICR_LBDCF
762#define UART_CLEAR_CTSF USART_ICR_CTSCF
763#define UART_CLEAR_CMF USART_ICR_CMCF
764#define UART_CLEAR_WUF USART_ICR_WUCF
765#define UART_CLEAR_RTOF USART_ICR_RTOCF
773#define HAL_UART_RECEPTION_STANDARD (0x00000000U)
774#define HAL_UART_RECEPTION_TOIDLE (0x00000001U)
775#define HAL_UART_RECEPTION_TORTO (0x00000002U)
776#define HAL_UART_RECEPTION_TOCHARMATCH (0x00000003U)
784#define HAL_UART_RXEVENT_TC (0x00000000U)
785#define HAL_UART_RXEVENT_HT (0x00000001U)
786#define HAL_UART_RXEVENT_IDLE (0x00000002U)
795/* Exported macros -----------------------------------------------------------*/
804#if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
805#define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
806 (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
807 (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
808 (__HANDLE__)->MspInitCallback = NULL; \
809 (__HANDLE__)->MspDeInitCallback = NULL; \
810 } while(0U)
811#else
812#define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
813 (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
814 (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
815 } while(0U)
816#endif /*USE_HAL_UART_REGISTER_CALLBACKS */
817
822#define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) \
823 do{ \
824 SET_BIT((__HANDLE__)->Instance->RQR, UART_RXDATA_FLUSH_REQUEST); \
825 SET_BIT((__HANDLE__)->Instance->RQR, UART_TXDATA_FLUSH_REQUEST); \
826 } while(0U)
827
845#define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
846
851#define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)
852
857#define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)
858
863#define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)
864
869#define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)
870
875#define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)
876
877
904#define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
905
923#define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (\
924 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\
925 ((__HANDLE__)->Instance->CR1 |= (1U <<\
926 ((__INTERRUPT__) & UART_IT_MASK))): \
927 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\
928 ((__HANDLE__)->Instance->CR2 |= (1U <<\
929 ((__INTERRUPT__) & UART_IT_MASK))): \
930 ((__HANDLE__)->Instance->CR3 |= (1U <<\
931 ((__INTERRUPT__) & UART_IT_MASK))))
932
950#define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (\
951 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\
952 ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\
953 ((__INTERRUPT__) & UART_IT_MASK))): \
954 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\
955 ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\
956 ((__INTERRUPT__) & UART_IT_MASK))): \
957 ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\
958 ((__INTERRUPT__) & UART_IT_MASK))))
959
977#define __HAL_UART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR\
978 & (1U << ((__INTERRUPT__)>> 8U))) != RESET) ? SET : RESET)
979
997#define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U) ?\
998 (__HANDLE__)->Instance->CR1 : \
999 (((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U) ?\
1000 (__HANDLE__)->Instance->CR2 : \
1001 (__HANDLE__)->Instance->CR3)) & (1U <<\
1002 (((uint16_t)(__INTERRUPT__)) &\
1003 UART_IT_MASK))) != RESET) ? SET : RESET)
1004
1023#define __HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
1024
1036#define __HAL_UART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
1037
1042#define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
1043
1048#define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
1049
1054#define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
1055
1060#define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
1061
1075#define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \
1076 do{ \
1077 ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
1078 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \
1079 } while(0U)
1080
1094#define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \
1095 do{ \
1096 ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
1097 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \
1098 } while(0U)
1099
1113#define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \
1114 do{ \
1115 ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
1116 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \
1117 } while(0U)
1118
1132#define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \
1133 do{ \
1134 ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
1135 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \
1136 } while(0U)
1141/* Private macros --------------------------------------------------------*/
1152#define UART_DIV_SAMPLING8(__PCLK__, __BAUD__) ((((__PCLK__)*2U) + ((__BAUD__)/2U)) / (__BAUD__))
1153
1159#define UART_DIV_SAMPLING16(__PCLK__, __BAUD__) (((__PCLK__) + ((__BAUD__)/2U)) / (__BAUD__))
1160
1161
1168#define IS_UART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 9000001U)
1169
1174#define IS_UART_ASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
1175
1180#define IS_UART_DEASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
1181
1187#define IS_UART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_0_5) || \
1188 ((__STOPBITS__) == UART_STOPBITS_1) || \
1189 ((__STOPBITS__) == UART_STOPBITS_1_5) || \
1190 ((__STOPBITS__) == UART_STOPBITS_2))
1191
1192
1198#define IS_UART_PARITY(__PARITY__) (((__PARITY__) == UART_PARITY_NONE) || \
1199 ((__PARITY__) == UART_PARITY_EVEN) || \
1200 ((__PARITY__) == UART_PARITY_ODD))
1201
1207#define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)\
1208 (((__CONTROL__) == UART_HWCONTROL_NONE) || \
1209 ((__CONTROL__) == UART_HWCONTROL_RTS) || \
1210 ((__CONTROL__) == UART_HWCONTROL_CTS) || \
1211 ((__CONTROL__) == UART_HWCONTROL_RTS_CTS))
1212
1218#define IS_UART_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(UART_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
1219
1225#define IS_UART_STATE(__STATE__) (((__STATE__) == UART_STATE_DISABLE) || \
1226 ((__STATE__) == UART_STATE_ENABLE))
1227
1233#define IS_UART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == UART_OVERSAMPLING_16) || \
1234 ((__SAMPLING__) == UART_OVERSAMPLING_8))
1235
1241#define IS_UART_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == UART_ONE_BIT_SAMPLE_DISABLE) || \
1242 ((__ONEBIT__) == UART_ONE_BIT_SAMPLE_ENABLE))
1243
1249#define IS_UART_ADVFEATURE_AUTOBAUDRATEMODE(__MODE__) (((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT) || \
1250 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE) || \
1251 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME) || \
1252 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME))
1253
1259#define IS_UART_RECEIVER_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_DISABLE) || \
1260 ((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_ENABLE))
1261
1267#define IS_UART_RECEIVER_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU)
1268
1274#define IS_UART_LIN(__LIN__) (((__LIN__) == UART_LIN_DISABLE) || \
1275 ((__LIN__) == UART_LIN_ENABLE))
1276
1282#define IS_UART_LIN_BREAK_DETECT_LENGTH(__LENGTH__) (((__LENGTH__) == UART_LINBREAKDETECTLENGTH_10B) || \
1283 ((__LENGTH__) == UART_LINBREAKDETECTLENGTH_11B))
1284
1290#define IS_UART_DMA_TX(__DMATX__) (((__DMATX__) == UART_DMA_TX_DISABLE) || \
1291 ((__DMATX__) == UART_DMA_TX_ENABLE))
1292
1298#define IS_UART_DMA_RX(__DMARX__) (((__DMARX__) == UART_DMA_RX_DISABLE) || \
1299 ((__DMARX__) == UART_DMA_RX_ENABLE))
1300
1306#define IS_UART_HALF_DUPLEX(__HDSEL__) (((__HDSEL__) == UART_HALF_DUPLEX_DISABLE) || \
1307 ((__HDSEL__) == UART_HALF_DUPLEX_ENABLE))
1308
1314#define IS_UART_WAKEUPMETHOD(__WAKEUP__) (((__WAKEUP__) == UART_WAKEUPMETHOD_IDLELINE) || \
1315 ((__WAKEUP__) == UART_WAKEUPMETHOD_ADDRESSMARK))
1316
1322#define IS_UART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == UART_AUTOBAUD_REQUEST) || \
1323 ((__PARAM__) == UART_SENDBREAK_REQUEST) || \
1324 ((__PARAM__) == UART_MUTE_MODE_REQUEST) || \
1325 ((__PARAM__) == UART_RXDATA_FLUSH_REQUEST) || \
1326 ((__PARAM__) == UART_TXDATA_FLUSH_REQUEST))
1327
1333#define IS_UART_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (UART_ADVFEATURE_NO_INIT | \
1334 UART_ADVFEATURE_TXINVERT_INIT | \
1335 UART_ADVFEATURE_RXINVERT_INIT | \
1336 UART_ADVFEATURE_DATAINVERT_INIT | \
1337 UART_ADVFEATURE_SWAP_INIT | \
1338 UART_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
1339 UART_ADVFEATURE_DMADISABLEONERROR_INIT | \
1340 UART_ADVFEATURE_AUTOBAUDRATE_INIT | \
1341 UART_ADVFEATURE_MSBFIRST_INIT))
1342
1348#define IS_UART_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == UART_ADVFEATURE_TXINV_DISABLE) || \
1349 ((__TXINV__) == UART_ADVFEATURE_TXINV_ENABLE))
1350
1356#define IS_UART_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == UART_ADVFEATURE_RXINV_DISABLE) || \
1357 ((__RXINV__) == UART_ADVFEATURE_RXINV_ENABLE))
1358
1364#define IS_UART_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == UART_ADVFEATURE_DATAINV_DISABLE) || \
1365 ((__DATAINV__) == UART_ADVFEATURE_DATAINV_ENABLE))
1366
1372#define IS_UART_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == UART_ADVFEATURE_SWAP_DISABLE) || \
1373 ((__SWAP__) == UART_ADVFEATURE_SWAP_ENABLE))
1374
1380#define IS_UART_OVERRUN(__OVERRUN__) (((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_ENABLE) || \
1381 ((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_DISABLE))
1382
1388#define IS_UART_ADVFEATURE_AUTOBAUDRATE(__AUTOBAUDRATE__) (((__AUTOBAUDRATE__) == \
1389 UART_ADVFEATURE_AUTOBAUDRATE_DISABLE) || \
1390 ((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_ENABLE))
1391
1397#define IS_UART_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == UART_ADVFEATURE_DMA_ENABLEONRXERROR) || \
1398 ((__DMA__) == UART_ADVFEATURE_DMA_DISABLEONRXERROR))
1399
1405#define IS_UART_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_DISABLE) || \
1406 ((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_ENABLE))
1407
1413#define IS_UART_ADVFEATURE_STOPMODE(__STOPMODE__) (((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_DISABLE) || \
1414 ((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_ENABLE))
1415
1421#define IS_UART_MUTE_MODE(__MUTE__) (((__MUTE__) == UART_ADVFEATURE_MUTEMODE_DISABLE) || \
1422 ((__MUTE__) == UART_ADVFEATURE_MUTEMODE_ENABLE))
1423
1429#define IS_UART_WAKEUP_SELECTION(__WAKE__) (((__WAKE__) == UART_WAKEUP_ON_ADDRESS) || \
1430 ((__WAKE__) == UART_WAKEUP_ON_STARTBIT) || \
1431 ((__WAKE__) == UART_WAKEUP_ON_READDATA_NONEMPTY))
1432
1438#define IS_UART_DE_POLARITY(__POLARITY__) (((__POLARITY__) == UART_DE_POLARITY_HIGH) || \
1439 ((__POLARITY__) == UART_DE_POLARITY_LOW))
1440
1441
1446/* Include UART HAL Extended module */
1447#include "stm32f3xx_hal_uart_ex.h"
1448
1449/* Exported functions --------------------------------------------------------*/
1458/* Initialization and de-initialization functions ****************************/
1461HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
1462HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
1466
1467/* Callbacks Register/UnRegister functions ***********************************/
1468#if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
1469HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID,
1470 pUART_CallbackTypeDef pCallback);
1471HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID);
1472
1473HAL_StatusTypeDef HAL_UART_RegisterRxEventCallback(UART_HandleTypeDef *huart, pUART_RxEventCallbackTypeDef pCallback);
1474HAL_StatusTypeDef HAL_UART_UnRegisterRxEventCallback(UART_HandleTypeDef *huart);
1475#endif /* USE_HAL_UART_REGISTER_CALLBACKS */
1476
1485/* IO operation functions *****************************************************/
1486HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size, uint32_t Timeout);
1487HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
1488HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size);
1489HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1490HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size);
1491HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1495/* Transfer Abort functions */
1502
1512
1514
1523/* Peripheral Control functions ************************************************/
1524void HAL_UART_ReceiverTimeout_Config(UART_HandleTypeDef *huart, uint32_t TimeoutValue);
1527
1534
1543/* Peripheral State and Errors functions **************************************************/
1546
1555/* Private functions -----------------------------------------------------------*/
1559#if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
1560void UART_InitCallbacksToDefault(UART_HandleTypeDef *huart);
1561#endif /* USE_HAL_UART_REGISTER_CALLBACKS */
1565 uint32_t Tickstart, uint32_t Timeout);
1567HAL_StatusTypeDef UART_Start_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1568HAL_StatusTypeDef UART_Start_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1569
1574/* Private variables -----------------------------------------------------------*/
1583#ifdef __cplusplus
1584}
1585#endif
1586
1587#endif /* STM32F3xx_HAL_UART_H */
1588
#define __IO
Definition: core_armv8mbl.h:196
FlagStatus
Definition: stm32f3xx.h:164
void HAL_UART_MspInit(UART_HandleTypeDef *huart)
UART MSP Initialization This function configures the hardware resources used in this example.
Definition: stm32f3xx_hal_msp.c:223
HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength)
void HAL_UART_MspDeInit(UART_HandleTypeDef *huart)
UART MSP De-Initialization This function freeze the hardware resources used in this example.
Definition: stm32f3xx_hal_msp.c:259
HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod)
HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size, uint32_t Timeout)
void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart)
void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart)
void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart)
void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size)
HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size)
HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart)
void HAL_UARTEx_RxEventCallback(UART_HandleTypeDef *huart, uint16_t Size)
HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart)
void HAL_UART_IRQHandler(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout)
void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart)
void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart)
void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode(UART_HandleTypeDef *huart)
void HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_DisableReceiverTimeout(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_UART_EnableReceiverTimeout(UART_HandleTypeDef *huart)
HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode(UART_HandleTypeDef *huart)
void HAL_UART_ReceiverTimeout_Config(UART_HandleTypeDef *huart, uint32_t TimeoutValue)
HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart)
uint32_t HAL_UART_GetError(const UART_HandleTypeDef *huart)
HAL_UART_StateTypeDef HAL_UART_GetState(const UART_HandleTypeDef *huart)
struct __UART_HandleTypeDef UART_HandleTypeDef
UART handle Structure definition.
uint32_t HAL_UART_StateTypeDef
HAL UART State definition.
Definition: stm32f3xx_hal_uart.h:171
uint32_t HAL_UART_RxTypeTypeDef
HAL UART Reception type definition.
Definition: stm32f3xx_hal_uart.h:195
UART_ClockSourceTypeDef
UART clock sources definition.
Definition: stm32f3xx_hal_uart.h:177
uint32_t HAL_UART_RxEventTypeTypeDef
HAL UART Rx Event type definition.
Definition: stm32f3xx_hal_uart.h:206
@ UART_CLOCKSOURCE_UNDEFINED
Definition: stm32f3xx_hal_uart.h:183
@ UART_CLOCKSOURCE_PCLK1
Definition: stm32f3xx_hal_uart.h:178
@ UART_CLOCKSOURCE_PCLK2
Definition: stm32f3xx_hal_uart.h:179
@ UART_CLOCKSOURCE_LSE
Definition: stm32f3xx_hal_uart.h:182
@ UART_CLOCKSOURCE_SYSCLK
Definition: stm32f3xx_hal_uart.h:181
@ UART_CLOCKSOURCE_HSI
Definition: stm32f3xx_hal_uart.h:180
HAL_StatusTypeDef UART_Start_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
HAL_StatusTypeDef UART_SetConfig(UART_HandleTypeDef *huart)
HAL_StatusTypeDef UART_Start_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
void UART_AdvFeatureConfig(UART_HandleTypeDef *huart)
HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout(UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
HAL_StatusTypeDef UART_CheckIdleState(UART_HandleTypeDef *huart)
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_StatusTypeDef
HAL Status structures definition
Definition: stm32f3xx_hal_def.h:39
HAL_LockTypeDef
HAL Lock structures definition
Definition: stm32f3xx_hal_def.h:50
Header file of UART HAL Extended module.
UART Advanced Features initialization structure definition.
Definition: stm32f3xx_hal_uart.h:95
uint32_t Swap
Definition: stm32f3xx_hal_uart.h:111
uint32_t AutoBaudRateMode
Definition: stm32f3xx_hal_uart.h:123
uint32_t AdvFeatureInit
Definition: stm32f3xx_hal_uart.h:96
uint32_t DMADisableonRxError
Definition: stm32f3xx_hal_uart.h:117
uint32_t MSBFirst
Definition: stm32f3xx_hal_uart.h:127
uint32_t RxPinLevelInvert
Definition: stm32f3xx_hal_uart.h:104
uint32_t AutoBaudRateEnable
Definition: stm32f3xx_hal_uart.h:120
uint32_t TxPinLevelInvert
Definition: stm32f3xx_hal_uart.h:101
uint32_t DataInvert
Definition: stm32f3xx_hal_uart.h:107
uint32_t OverrunDisable
Definition: stm32f3xx_hal_uart.h:114
UART Init Structure definition.
Definition: stm32f3xx_hal_uart.h:47
uint32_t WordLength
Definition: stm32f3xx_hal_uart.h:60
uint32_t OneBitSampling
Definition: stm32f3xx_hal_uart.h:84
uint32_t StopBits
Definition: stm32f3xx_hal_uart.h:63
uint32_t OverSampling
Definition: stm32f3xx_hal_uart.h:80
uint32_t Mode
Definition: stm32f3xx_hal_uart.h:73
uint32_t HwFlowCtl
Definition: stm32f3xx_hal_uart.h:76
uint32_t Parity
Definition: stm32f3xx_hal_uart.h:66
uint32_t BaudRate
Definition: stm32f3xx_hal_uart.h:48
Universal Synchronous Asynchronous Receiver Transmitter.
Definition: stm32f303xe.h:704
DMA handle Structure definition
Definition: stm32f3xx_hal_dma.h:110
UART handle Structure definition.
Definition: stm32f3xx_hal_uart.h:212
__IO HAL_UART_RxEventTypeTypeDef RxEventType
Definition: stm32f3xx_hal_uart.h:235
__IO uint32_t ErrorCode
Definition: stm32f3xx_hal_uart.h:254
__IO uint16_t RxXferCount
Definition: stm32f3xx_hal_uart.h:229
__IO HAL_UART_StateTypeDef gState
Definition: stm32f3xx_hal_uart.h:247
__IO HAL_UART_StateTypeDef RxState
Definition: stm32f3xx_hal_uart.h:251
uint16_t TxXferSize
Definition: stm32f3xx_hal_uart.h:221
HAL_LockTypeDef Lock
Definition: stm32f3xx_hal_uart.h:245
void(* TxISR)(struct __UART_HandleTypeDef *huart)
Definition: stm32f3xx_hal_uart.h:239
uint8_t * pRxBuffPtr
Definition: stm32f3xx_hal_uart.h:225
uint16_t Mask
Definition: stm32f3xx_hal_uart.h:231
UART_InitTypeDef Init
Definition: stm32f3xx_hal_uart.h:215
__IO uint16_t TxXferCount
Definition: stm32f3xx_hal_uart.h:223
void(* RxISR)(struct __UART_HandleTypeDef *huart)
Definition: stm32f3xx_hal_uart.h:237
UART_AdvFeatureInitTypeDef AdvancedInit
Definition: stm32f3xx_hal_uart.h:217
DMA_HandleTypeDef * hdmarx
Definition: stm32f3xx_hal_uart.h:243
USART_TypeDef * Instance
Definition: stm32f3xx_hal_uart.h:213
const uint8_t * pTxBuffPtr
Definition: stm32f3xx_hal_uart.h:219
__IO HAL_UART_RxTypeTypeDef ReceptionType
Definition: stm32f3xx_hal_uart.h:233
uint16_t RxXferSize
Definition: stm32f3xx_hal_uart.h:227
DMA_HandleTypeDef * hdmatx
Definition: stm32f3xx_hal_uart.h:241