Refactor to use new protocol module and sipo.
[bertos.git] / bertos / cpu / cortex-m3 / drv / ser_stm32.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief STM32F10xx UART interface driver.
34  *
35  * \author Daniele Basile <asterix@develer.com>
36  */
37
38 #ifndef SER_STM32_H
39 #define SER_STM32_H
40
41 #include <cfg/debug.h>
42
43 #include <cpu/power.h> /* cpu_relax() */
44
45 #include <io/stm32.h>
46
47 /* Serial hardware numbers */
48 enum
49 {
50         SER_UART1 = 0,
51         SER_UART2,
52 #if CPU_CM3_STM32F103RB || CPU_CM3_STM32F103RE
53         SER_UART3,
54 #endif
55         SER_CNT //< Number of serial ports
56 };
57
58 /* Software errors */
59 #define SERRF_RXFIFOOVERRUN  BV(6) //< Rx FIFO buffer overrun
60 #define SERRF_RXTIMEOUT      BV(5) //< Receive timeout
61 #define SERRF_TXTIMEOUT      BV(4) //< Transmit timeout
62
63 /*
64  * Hardware errors.
65  */
66 #define SERRF_RXSROVERRUN    SR_ORE      //< Input overrun
67 #define SERRF_FRAMEERROR     SR_FE   //< Stop bit missing
68 #define SERRF_PARITYERROR    SR_PE   //< Parity error
69 #define SERRF_NOISEERROR     SR_NE   //< Noise error
70
71 /* Serial error/status flags */
72 typedef uint32_t serstatus_t;
73
74 INLINE void stm32_uartDisable(uint32_t base)
75 {
76         struct stm32_usart *_base = (struct stm32_usart *)base;
77         _base->CR1 &= ~CR1_RUN_RESET;
78 }
79
80 INLINE void stm32_uartEnable(uint32_t base)
81 {
82         struct stm32_usart *_base = (struct stm32_usart *)base;
83         _base->CR1 |= CR1_RUN_SET;
84 }
85
86 /* Clear the flags register */
87 INLINE void stm32_uartClear(uint32_t base)
88 {
89         struct stm32_usart *_base = (struct stm32_usart *)base;
90         _base->SR &= ~USART_FLAG_MASK;
91 }
92
93 INLINE bool stm32_uartTxDone(uint32_t base)
94 {
95         struct stm32_usart *_base = (struct stm32_usart *)base;
96         return (_base->SR & USART_FLAG_TC);
97 }
98
99 INLINE bool stm32_uartTxReady(uint32_t base)
100 {
101         struct stm32_usart *_base = (struct stm32_usart *)base;
102         return (_base->SR & (BV(CR1_TXEIE) | BV(CR1_TCIE)));
103 }
104
105 INLINE bool stm32_uartRxReady(uint32_t base)
106 {
107         struct stm32_usart *_base = (struct stm32_usart *)base;
108         return (_base->SR & BV(CR1_RXNEIE));
109 }
110
111 INLINE int stm32_uartPutChar(uint32_t base, unsigned char c)
112 {
113         struct stm32_usart *_base = (struct stm32_usart *)base;
114         while (!stm32_uartTxReady(base))
115                 cpu_relax();
116         _base->DR = c;
117         return c;
118 }
119
120 INLINE int stm32_uartGetChar(uint32_t base)
121 {
122         struct stm32_usart * _base = (struct stm32_usart *)base;
123         return _base->DR;
124 }
125
126 void stm32_uartSetBaudRate(uint32_t base, unsigned long baud);
127 void stm32_uartSetParity(uint32_t base, int parity);
128 void stm32_uartInit(int port);
129
130 #endif /* SER_STM32_H */