diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-02-06 17:40:24 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-02-06 17:40:24 +0000 |
commit | 1ddd49eec7be60413d5054937ee1a1c001842769 (patch) | |
tree | 4826e224810d14ba396582952cd614bb9f2da925 /ports/ARMCM3-STM32F103/stm32_serial.h | |
parent | 87805ba16625d490475be626372a87d7c53e700c (diff) | |
download | ChibiOS-1ddd49eec7be60413d5054937ee1a1c001842769.tar.gz ChibiOS-1ddd49eec7be60413d5054937ee1a1c001842769.tar.bz2 ChibiOS-1ddd49eec7be60413d5054937ee1a1c001842769.zip |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@725 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'ports/ARMCM3-STM32F103/stm32_serial.h')
-rw-r--r-- | ports/ARMCM3-STM32F103/stm32_serial.h | 177 |
1 files changed, 113 insertions, 64 deletions
diff --git a/ports/ARMCM3-STM32F103/stm32_serial.h b/ports/ARMCM3-STM32F103/stm32_serial.h index 93163dc50..4f0c622b2 100644 --- a/ports/ARMCM3-STM32F103/stm32_serial.h +++ b/ports/ARMCM3-STM32F103/stm32_serial.h @@ -17,88 +17,135 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * @file ports/ARMCM3-STM32F103/stm32_serial.h
+ * @brief STM32F103 Serial driver macros and structures.
+ * @addtogroup STM32F103_SERIAL
+ * @{
+ */
+
#ifndef _STM32_SERIAL_H_
#define _STM32_SERIAL_H_
-//#define USE_USART1
-#define USE_USART2
-//#define USE_USART3
-
-/*
- * Configuration parameter, you can change the depth of the queue buffers
- * depending on the requirements of your application.
+/**
+ * @brief Serial buffers size.
+ * @details Configuration parameter, you can change the depth of the queue
+ * buffers depending on the requirements of your application.
+ * @note The default is 128 bytes for both the transmission and receive buffers.
*/
+#if !defined(SERIAL_BUFFERS_SIZE) || defined(__DOXYGEN__)
#define SERIAL_BUFFERS_SIZE 128
+#endif
+
+/**
+ * @brief Default bit rate.
+ * @details Configuration parameter, at startup the USARTs are configured at
+ * this speed.
+ * @note It is possible to use @p SetUSART() in order to change the working
+ * parameters at runtime.
+ */
+#if !defined(STM32_USART_BITRATE) || defined(__DOXYGEN__)
+#define STM32_USART_BITRATE 38400
+#endif
+
+/**
+ * @brief USART1 driver enable switch.
+ * @details If set to @p TRUE the support for USART1 is included.
+ * @note The default is @p FALSE.
+ */
+#if !defined(USE_STM32_USART1) || defined(__DOXYGEN__)
+#define USE_STM32_USART1 FALSE
+#endif
+
+/**
+ * @brief USART2 driver enable switch.
+ * @details If set to @p TRUE the support for USART2 is included.
+ * @note The default is @p TRUE.
+ */
+#if !defined(USE_STM32_USART2) || defined(__DOXYGEN__)
+#define USE_STM32_USART2 1
+#endif
+
+/**
+ * @brief USART3 driver enable switch.
+ * @details If set to @p TRUE the support for USART3 is included.
+ * @note The default is @p FALSE.
+ */
+#if !defined(USE_STM32_USART3) || defined(__DOXYGEN__)
+#define USE_STM32_USART3 FALSE
+#endif
/*
- * USARTs definitions here, ST headers are not good enough IMHO.
+ * USARTs definitions here.
*/
-#define SR_PE (1 << 0)
-#define SR_FE (1 << 1)
-#define SR_NE (1 << 2)
-#define SR_ORE (1 << 3)
-#define SR_IDLE (1 << 4)
-#define SR_RXNE (1 << 5)
-#define SR_TC (1 << 6)
-#define SR_TXE (1 << 7)
-#define SR_LBD (1 << 8)
-#define SR_CTS (1 << 9)
-
-#define CR1_SBK (1 << 0)
-#define CR1_RWU (1 << 1)
-#define CR1_RE (1 << 2)
-#define CR1_TE (1 << 3)
-#define CR1_IDLEIE (1 << 4)
-#define CR1_RXNEIE (1 << 5)
-#define CR1_TCIE (1 << 6)
-#define CR1_TXEIE (1 << 7)
-#define CR1_PEIE (1 << 8)
-#define CR1_PS (1 << 9)
-#define CR1_PCE (1 << 10)
-#define CR1_WAKE (1 << 11)
-#define CR1_M (1 << 12)
-#define CR1_UE (1 << 13)
-
-#define CR2_ADD_MASK (15 << 0)
-#define CR2_LBDL (1 << 5)
-#define CR2_LBDIE (1 << 6)
-#define CR2_CBCL (1 << 8)
-#define CR2_CPHA (1 << 9)
-#define CR2_CPOL (1 << 10)
-#define CR2_CLKEN (1 << 11)
-#define CR2_STOP_MASK (3 << 12)
-#define CR2_STOP1_BITS (0 << 12)
-#define CR2_STOP0P5_BITS (1 << 12)
-#define CR2_STOP2_BITS (2 << 12)
-#define CR2_STOP1P5_BITS (3 << 12)
-#define CR2_LINEN (1 << 14)
-
-#define CR3_EIE (1 << 0)
-#define CR3_IREN (1 << 1)
-#define CR3_IRLP (1 << 2)
-#define CR3_HDSEL (1 << 3)
-#define CR3_NACK (1 << 4)
-#define CR3_SCEN (1 << 5)
-#define CR3_DMAR (1 << 6)
-#define CR3_DMAT (1 << 7)
-#define CR3_RTSE (1 << 8)
-#define CR3_CTSE (1 << 9)
-#define CR3_CTSIE (1 << 10)
-
-#ifdef USE_USART1
+#define SR_PE (1 << 0) /**< @brief SR PE bit.*/
+#define SR_FE (1 << 1) /**< @brief SR FE bit.*/
+#define SR_NE (1 << 2) /**< @brief SR NE bit.*/
+#define SR_ORE (1 << 3) /**< @brief SR ORE bit.*/
+#define SR_IDLE (1 << 4) /**< @brief SR IDLE bit.*/
+#define SR_RXNE (1 << 5) /**< @brief SR RXNE bit.*/
+#define SR_TC (1 << 6) /**< @brief SR TC bit.*/
+#define SR_TXE (1 << 7) /**< @brief SR TXE bit.*/
+#define SR_LBD (1 << 8) /**< @brief SR LBD bit.*/
+#define SR_CTS (1 << 9) /**< @brief SR CTS bit.*/
+
+#define CR1_SBK (1 << 0) /**< @brief CR1 SBK bit.*/
+#define CR1_RWU (1 << 1) /**< @brief CR1 RWU bit.*/
+#define CR1_RE (1 << 2) /**< @brief CR1 RE bit.*/
+#define CR1_TE (1 << 3) /**< @brief CR1 TE bit.*/
+#define CR1_IDLEIE (1 << 4) /**< @brief CR1 IDLEIE bit.*/
+#define CR1_RXNEIE (1 << 5) /**< @brief CR1 RXNEIE bit.*/
+#define CR1_TCIE (1 << 6) /**< @brief CR1 TCTE bit.*/
+#define CR1_TXEIE (1 << 7) /**< @brief CR1 TXEIE bit.*/
+#define CR1_PEIE (1 << 8) /**< @brief CR1 PEIE bit.*/
+#define CR1_PS (1 << 9) /**< @brief CR1 PS bit.*/
+#define CR1_PCE (1 << 10) /**< @brief CR1 PCE bit.*/
+#define CR1_WAKE (1 << 11) /**< @brief CR1 WAKE bit.*/
+#define CR1_M (1 << 12) /**< @brief CR1 M bit.*/
+#define CR1_UE (1 << 13) /**< @brief CR1 UE bit.*/
+
+#define CR2_ADD_MASK (15 << 0) /**< @brief CR2 ADD field mask.*/
+#define CR2_LBDL (1 << 5) /**< @brief CR2 LBDL bit.*/
+#define CR2_LBDIE (1 << 6) /**< @brief CR2 LBDIE bit.*/
+#define CR2_CBCL (1 << 8) /**< @brief CR2 CBCL bit.*/
+#define CR2_CPHA (1 << 9) /**< @brief CR2 CPHA bit.*/
+#define CR2_CPOL (1 << 10) /**< @brief CR2 CPOL bit.*/
+#define CR2_CLKEN (1 << 11) /**< @brief CR2 CLKEN bit.*/
+#define CR2_STOP_MASK (3 << 12) /**< @brief CR2 STOP field mask.*/
+#define CR2_STOP1_BITS (0 << 12) /**< @brief CR2 1 stop bit value.*/
+#define CR2_STOP0P5_BITS (1 << 12) /**< @brief CR2 0.5 stop bit value.*/
+#define CR2_STOP2_BITS (2 << 12) /**< @brief CR2 2 stop bit value.*/
+#define CR2_STOP1P5_BITS (3 << 12) /**< @brief CR2 1.5 stop bit value.*/
+#define CR2_LINEN (1 << 14) /**< @brief CR2 LINEN bit.*/
+
+#define CR3_EIE (1 << 0) /**< @brief CR3 EIE bit.*/
+#define CR3_IREN (1 << 1) /**< @brief CR3 IREN bit.*/
+#define CR3_IRLP (1 << 2) /**< @brief CR3 IRLP bit.*/
+#define CR3_HDSEL (1 << 3) /**< @brief CR3 HDSEL bit.*/
+#define CR3_NACK (1 << 4) /**< @brief CR3 NACK bit.*/
+#define CR3_SCEN (1 << 5) /**< @brief CR3 SCEN bit.*/
+#define CR3_DMAR (1 << 6) /**< @brief CR3 DMAR bit.*/
+#define CR3_DMAT (1 << 7) /**< @brief CR3 DMAT bit.*/
+#define CR3_RTSE (1 << 8) /**< @brief CR3 RTSE bit.*/
+#define CR3_CTSE (1 << 9) /**< @brief CR3 CTSE bit.*/
+#define CR3_CTSIE (1 << 10) /**< @brief CR3 CTSIE bit.*/
+
+/** @cond never*/
+#if USE_STM32_USART1
extern FullDuplexDriver COM1;
#endif
-#ifdef USE_USART2
+#if USE_STM32_USART2
extern FullDuplexDriver COM2;
#endif
-#ifdef USE_USART3
+#if USE_STM32_USART3
extern FullDuplexDriver COM3;
#endif
+/** @endcond*/
#ifdef __cplusplus
extern "C" {
#endif
- void InitSerial(uint32_t prio1, uint32_t prio2, uint32_t prio3);
+ void stm32_serial_init(uint32_t prio1, uint32_t prio2, uint32_t prio3);
void SetUSART(USART_TypeDef *u, uint32_t speed, uint16_t cr1,
uint16_t cr2, uint16_t cr3);
#ifdef __cplusplus
@@ -106,3 +153,5 @@ extern "C" { #endif
#endif /* _STM32_SERIAL_H_ */
+
+/** @} */
|