1 /* mbed Microcontroller Library
2 *******************************************************************************
3 * Copyright (c) 2014, STMicroelectronics
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *******************************************************************************
30 #include "mbed_assert.h"
31 #include "serial_api.h"
38 #include "PeripheralPins.h"
42 static uint32_t serial_irq_ids[UART_NUM] = {0, 0, 0, 0, 0};
44 static uart_irq_handler irq_handler;
46 UART_HandleTypeDef UartHandle;
48 int stdio_uart_inited = 0;
51 static void init_uart(serial_t *obj)
53 UartHandle.Instance = (USART_TypeDef *)(obj->uart);
55 UartHandle.Init.BaudRate = obj->baudrate;
56 UartHandle.Init.WordLength = obj->databits;
57 UartHandle.Init.StopBits = obj->stopbits;
58 UartHandle.Init.Parity = obj->parity;
59 UartHandle.Init.HwFlowCtl = UART_HWCONTROL_NONE;
61 if (obj->pin_rx == NC) {
62 UartHandle.Init.Mode = UART_MODE_TX;
63 } else if (obj->pin_tx == NC) {
64 UartHandle.Init.Mode = UART_MODE_RX;
66 UartHandle.Init.Mode = UART_MODE_TX_RX;
69 // Disable the reception overrun detection
70 UartHandle.AdvancedInit.AdvFeatureInit = UART_ADVFEATURE_RXOVERRUNDISABLE_INIT;
71 UartHandle.AdvancedInit.OverrunDisable = UART_ADVFEATURE_OVERRUN_DISABLE;
73 HAL_UART_Init(&UartHandle);
76 void serial_init(serial_t *obj, PinName tx, PinName rx)
78 // Determine the UART to use (UART_1, UART_2, ...)
79 UARTName uart_tx = (UARTName)pinmap_peripheral(tx, PinMap_UART_TX);
80 UARTName uart_rx = (UARTName)pinmap_peripheral(rx, PinMap_UART_RX);
82 // Get the peripheral name (UART_1, UART_2, ...) from the pin and assign it to the object
83 obj->uart = (UARTName)pinmap_merge(uart_tx, uart_rx);
84 MBED_ASSERT(obj->uart != (UARTName)NC);
86 // Enable USART clock + switch to SystemClock
87 if (obj->uart == UART_1) {
88 __USART1_CLK_ENABLE();
89 __HAL_RCC_USART1_CONFIG(RCC_USART1CLKSOURCE_SYSCLK);
92 if (obj->uart == UART_2) {
93 __USART2_CLK_ENABLE();
94 __HAL_RCC_USART2_CONFIG(RCC_USART2CLKSOURCE_SYSCLK);
97 if (obj->uart == UART_3) {
98 __USART3_CLK_ENABLE();
99 __HAL_RCC_USART3_CONFIG(RCC_USART3CLKSOURCE_SYSCLK);
102 #if defined(UART4_BASE)
103 if (obj->uart == UART_4) {
104 __UART4_CLK_ENABLE();
105 __HAL_RCC_UART4_CONFIG(RCC_UART4CLKSOURCE_SYSCLK);
109 #if defined(UART5_BASE)
110 if (obj->uart == UART_5) {
111 __UART5_CLK_ENABLE();
112 __HAL_RCC_UART5_CONFIG(RCC_UART5CLKSOURCE_SYSCLK);
117 // Configure the UART pins
118 pinmap_pinout(tx, PinMap_UART_TX);
119 pinmap_pinout(rx, PinMap_UART_RX);
121 pin_mode(tx, PullUp);
124 pin_mode(rx, PullUp);
128 obj->baudrate = 9600;
129 obj->databits = UART_WORDLENGTH_8B;
130 obj->stopbits = UART_STOPBITS_1;
131 obj->parity = UART_PARITY_NONE;
138 // For stdio management
139 if (obj->uart == STDIO_UART) {
140 stdio_uart_inited = 1;
141 memcpy(&stdio_uart, obj, sizeof(serial_t));
145 void serial_free(serial_t *obj)
147 // Reset UART and disable clock
148 if (obj->uart == UART_1) {
149 __USART1_FORCE_RESET();
150 __USART1_RELEASE_RESET();
151 __USART1_CLK_DISABLE();
153 if (obj->uart == UART_2) {
154 __USART2_FORCE_RESET();
155 __USART2_RELEASE_RESET();
156 __USART2_CLK_DISABLE();
158 if (obj->uart == UART_3) {
159 __USART3_FORCE_RESET();
160 __USART3_RELEASE_RESET();
161 __USART3_CLK_DISABLE();
163 #if defined(UART4_BASE)
164 if (obj->uart == UART_4) {
165 __UART4_FORCE_RESET();
166 __UART4_RELEASE_RESET();
167 __UART4_CLK_DISABLE();
170 #if defined(UART5_BASE)
171 if (obj->uart == UART_5) {
172 __UART5_FORCE_RESET();
173 __UART5_RELEASE_RESET();
174 __UART5_CLK_DISABLE();
179 pin_function(obj->pin_tx, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
180 pin_function(obj->pin_rx, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
182 serial_irq_ids[obj->index] = 0;
185 void serial_baud(serial_t *obj, int baudrate)
187 obj->baudrate = baudrate;
191 void serial_format(serial_t *obj, int data_bits, SerialParity parity, int stop_bits)
193 if (data_bits == 9) {
194 obj->databits = UART_WORDLENGTH_9B;
196 obj->databits = UART_WORDLENGTH_8B;
202 obj->parity = UART_PARITY_ODD;
206 obj->parity = UART_PARITY_EVEN;
208 default: // ParityNone
209 obj->parity = UART_PARITY_NONE;
213 if (stop_bits == 2) {
214 obj->stopbits = UART_STOPBITS_2;
216 obj->stopbits = UART_STOPBITS_1;
222 /******************************************************************************
223 * INTERRUPTS HANDLING
224 ******************************************************************************/
226 static void uart_irq(UARTName name, int id)
228 UartHandle.Instance = (USART_TypeDef *)name;
229 if (serial_irq_ids[id] != 0) {
230 if (__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_TC) != RESET) {
231 irq_handler(serial_irq_ids[id], TxIrq);
232 __HAL_UART_CLEAR_IT(&UartHandle, UART_FLAG_TC);
234 if (__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_RXNE) != RESET) {
235 irq_handler(serial_irq_ids[id], RxIrq);
236 volatile uint32_t tmpval = UartHandle.Instance->RDR; // Clear RXNE bit
241 static void uart1_irq(void)
246 static void uart2_irq(void)
251 static void uart3_irq(void)
256 #if defined(UART4_BASE)
257 static void uart4_irq(void)
263 #if defined(UART5_BASE)
264 static void uart5_irq(void)
270 void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id)
272 irq_handler = handler;
273 serial_irq_ids[obj->index] = id;
276 void serial_irq_set(serial_t *obj, SerialIrq irq, uint32_t enable)
278 IRQn_Type irq_n = (IRQn_Type)0;
281 UartHandle.Instance = (USART_TypeDef *)(obj->uart);
283 if (obj->uart == UART_1) {
285 vector = (uint32_t)&uart1_irq;
288 if (obj->uart == UART_2) {
290 vector = (uint32_t)&uart2_irq;
293 if (obj->uart == UART_3) {
295 vector = (uint32_t)&uart3_irq;
298 #if defined(UART4_BASE)
299 if (obj->uart == UART_4) {
301 vector = (uint32_t)&uart4_irq;
305 #if defined(UART5_BASE)
306 if (obj->uart == UART_5) {
308 vector = (uint32_t)&uart5_irq;
315 __HAL_UART_ENABLE_IT(&UartHandle, UART_IT_RXNE);
317 __HAL_UART_ENABLE_IT(&UartHandle, UART_IT_TC);
320 NVIC_SetVector(irq_n, vector);
321 NVIC_EnableIRQ(irq_n);
325 int all_disabled = 0;
328 __HAL_UART_DISABLE_IT(&UartHandle, UART_IT_RXNE);
329 // Check if TxIrq is disabled too
330 if ((UartHandle.Instance->CR1 & USART_CR1_TCIE) == 0) all_disabled = 1;
332 __HAL_UART_DISABLE_IT(&UartHandle, UART_IT_TC);
333 // Check if RxIrq is disabled too
334 if ((UartHandle.Instance->CR1 & USART_CR1_RXNEIE) == 0) all_disabled = 1;
337 if (all_disabled) NVIC_DisableIRQ(irq_n);
342 /******************************************************************************
344 ******************************************************************************/
346 int serial_getc(serial_t *obj)
348 USART_TypeDef *uart = (USART_TypeDef *)(obj->uart);
349 while (!serial_readable(obj));
350 if (obj->databits == UART_WORDLENGTH_8B) {
351 return (int)(uart->RDR & (uint8_t)0xFF);
353 return (int)(uart->RDR & (uint16_t)0x1FF);
357 void serial_putc(serial_t *obj, int c)
359 USART_TypeDef *uart = (USART_TypeDef *)(obj->uart);
360 while (!serial_writable(obj));
361 if (obj->databits == UART_WORDLENGTH_8B) {
362 uart->TDR = (uint8_t)(c & (uint8_t)0xFF);
364 uart->TDR = (uint16_t)(c & (uint16_t)0x1FF);
368 int serial_readable(serial_t *obj)
371 UartHandle.Instance = (USART_TypeDef *)(obj->uart);
372 // Check if data is received
373 status = ((__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_RXNE) != RESET) ? 1 : 0);
377 int serial_writable(serial_t *obj)
380 UartHandle.Instance = (USART_TypeDef *)(obj->uart);
381 // Check if data is transmitted
382 status = ((__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_TXE) != RESET) ? 1 : 0);
386 void serial_clear(serial_t *obj)
388 UartHandle.Instance = (USART_TypeDef *)(obj->uart);
389 __HAL_UART_CLEAR_IT(&UartHandle, UART_FLAG_TC);
390 __HAL_UART_SEND_REQ(&UartHandle, UART_RXDATA_FLUSH_REQUEST);
393 void serial_pinout_tx(PinName tx)
395 pinmap_pinout(tx, PinMap_UART_TX);
398 void serial_break_set(serial_t *obj)
400 UartHandle.Instance = (USART_TypeDef *)(obj->uart);
401 HAL_LIN_SendBreak(&UartHandle);
404 void serial_break_clear(serial_t *obj)