/* * Copyright (C) 2015 Freie Universität Berlin * 2015 FreshTemp, LLC. * * This file is subject to the terms and conditions of the GNU Lesser * General Public License v2.1. See the file LICENSE in the top level * directory for more details. */ /** * @ingroup cpu_sam0_common * @ingroup drivers_periph_uart * @{ * * @file * @brief Low-level UART driver implementation * * @author Thomas Eichinger * @author Troels Hoffmeyer * @author Hauke Petersen * @author Dylan Laduranty * * @} */ #include "cpu.h" #include "periph/uart.h" #include "periph/gpio.h" #define ENABLE_DEBUG (0) #include "debug.h" #if defined (CPU_SAML1X) || defined (CPU_SAMD5X) #define UART_HAS_TX_ISR #endif /** * @brief Allocate memory to store the callback functions & buffers */ #ifdef MODULE_PERIPH_UART_NONBLOCKING #include "tsrb.h" static tsrb_t uart_tx_rb[UART_NUMOF]; static uint8_t uart_tx_rb_buf[UART_NUMOF][UART_TXBUF_SIZE]; #endif static uart_isr_ctx_t uart_ctx[UART_NUMOF]; /** * @brief Get the pointer to the base register of the given UART device * * @param[in] dev UART device identifier * * @return base register address */ static inline SercomUsart *dev(uart_t dev) { return uart_config[dev].dev; } int uart_init(uart_t uart, uint32_t baudrate, uart_rx_cb_t rx_cb, void *arg) { if (uart >= UART_NUMOF) { return UART_NODEV; } /* must disable here first to ensure idempotency */ dev(uart)->CTRLA.reg &= ~(SERCOM_USART_CTRLA_ENABLE); #ifdef MODULE_PERIPH_UART_NONBLOCKING /* set up the TX buffer */ tsrb_init(&uart_tx_rb[uart], uart_tx_rb_buf[uart], UART_TXBUF_SIZE); #endif /* configure pins */ if (uart_config[uart].rx_pin != GPIO_UNDEF) { gpio_init(uart_config[uart].rx_pin, GPIO_IN); gpio_init_mux(uart_config[uart].rx_pin, uart_config[uart].mux); } gpio_init(uart_config[uart].tx_pin, GPIO_OUT); gpio_set(uart_config[uart].tx_pin); gpio_init_mux(uart_config[uart].tx_pin, uart_config[uart].mux); #ifdef MODULE_PERIPH_UART_HW_FC /* If RTS/CTS needed, enable them */ if (uart_config[uart].tx_pad == UART_PAD_TX_0_RTS_2_CTS_3) { /* Ensure RTS is defined */ if (uart_config[uart].rts_pin != GPIO_UNDEF) { gpio_init_mux(uart_config[uart].rts_pin, uart_config[uart].mux); } /* Ensure CTS is defined */ if (uart_config[uart].cts_pin != GPIO_UNDEF) { gpio_init_mux(uart_config[uart].cts_pin, uart_config[uart].mux); } } #endif /* enable peripheral clock */ sercom_clk_en(dev(uart)); /* reset the UART device */ dev(uart)->CTRLA.reg = SERCOM_USART_CTRLA_SWRST; while (dev(uart)->SYNCBUSY.bit.SWRST) {} /* configure clock generator */ sercom_set_gen(dev(uart), uart_config[uart].gclk_src); /* set asynchronous mode w/o parity, LSB first, TX and RX pad as specified * by the board in the periph_conf.h, x16 sampling and use internal clock */ dev(uart)->CTRLA.reg = (SERCOM_USART_CTRLA_DORD | SERCOM_USART_CTRLA_SAMPR(0x1) | SERCOM_USART_CTRLA_TXPO(uart_config[uart].tx_pad) | SERCOM_USART_CTRLA_RXPO(uart_config[uart].rx_pad) | SERCOM_USART_CTRLA_MODE(0x1)); /* Set run in standby mode if enabled */ if (uart_config[uart].flags & UART_FLAG_RUN_STANDBY) { dev(uart)->CTRLA.reg |= SERCOM_USART_CTRLA_RUNSTDBY; } /* calculate and set baudrate */ uint32_t baud = (((sam0_gclk_freq(uart_config[uart].gclk_src) * 8) / baudrate) / 16); dev(uart)->BAUD.FRAC.FP = (baud % 8); dev(uart)->BAUD.FRAC.BAUD = (baud / 8); /* enable transmitter, and configure 8N1 mode */ dev(uart)->CTRLB.reg = SERCOM_USART_CTRLB_TXEN; /* enable receiver and RX interrupt if configured */ if ((rx_cb) && (uart_config[uart].rx_pin != GPIO_UNDEF)) { uart_ctx[uart].rx_cb = rx_cb; uart_ctx[uart].arg = arg; #ifdef UART_HAS_TX_ISR /* enable RXNE ISR */ NVIC_EnableIRQ(SERCOM0_2_IRQn + (sercom_id(dev(uart)) * 4)); #else /* enable UART ISR */ NVIC_EnableIRQ(SERCOM0_IRQn + sercom_id(dev(uart))); #endif /* UART_HAS_TX_ISR */ dev(uart)->CTRLB.reg |= SERCOM_USART_CTRLB_RXEN; dev(uart)->INTENSET.reg = SERCOM_USART_INTENSET_RXC; /* set wakeup receive from sleep if enabled */ if (uart_config[uart].flags & UART_FLAG_WAKEUP) { dev(uart)->CTRLB.reg |= SERCOM_USART_CTRLB_SFDE; } } #ifdef MODULE_PERIPH_UART_NONBLOCKING #ifndef UART_HAS_TX_ISR else { /* enable UART ISR */ NVIC_EnableIRQ(SERCOM0_IRQn + sercom_id(dev(uart))); } #else /* enable TXE ISR */ NVIC_EnableIRQ(SERCOM0_0_IRQn + (sercom_id(dev(uart)) * 4)); #endif #endif /* MODULE_PERIPH_UART_NONBLOCKING */ while (dev(uart)->SYNCBUSY.bit.CTRLB) {} /* and finally enable the device */ dev(uart)->CTRLA.reg |= SERCOM_USART_CTRLA_ENABLE; return UART_OK; } void uart_write(uart_t uart, const uint8_t *data, size_t len) { #ifdef MODULE_PERIPH_UART_NONBLOCKING for (const void* end = data + len; data != end; ++data) { if (irq_is_in() || __get_PRIMASK()) { /* if ring buffer is full free up a spot */ if (tsrb_full(&uart_tx_rb[uart])) { while (!dev(uart)->INTFLAG.bit.DRE) {} dev(uart)->DATA.reg = tsrb_get_one(&uart_tx_rb[uart]); } tsrb_add_one(&uart_tx_rb[uart], *data); } else { while (tsrb_add_one(&uart_tx_rb[uart], *data) < 0) {} } dev(uart)->INTENSET.reg = SERCOM_USART_INTENSET_DRE; } #else for (const void* end = data + len; data != end; ++data) { while (!dev(uart)->INTFLAG.bit.DRE) {} dev(uart)->DATA.reg = *data; } while (!dev(uart)->INTFLAG.bit.TXC) {} #endif } void uart_poweron(uart_t uart) { sercom_clk_en(dev(uart)); dev(uart)->CTRLA.reg |= SERCOM_USART_CTRLA_ENABLE; } void uart_poweroff(uart_t uart) { dev(uart)->CTRLA.reg &= ~(SERCOM_USART_CTRLA_ENABLE); sercom_clk_dis(dev(uart)); } #ifdef MODULE_PERIPH_UART_MODECFG int uart_mode(uart_t uart, uart_data_bits_t data_bits, uart_parity_t parity, uart_stop_bits_t stop_bits) { if (uart >= UART_NUMOF) { return UART_NODEV; } if (stop_bits != UART_STOP_BITS_1 && stop_bits != UART_STOP_BITS_2) { return UART_NOMODE; } if (parity != UART_PARITY_NONE && parity != UART_PARITY_EVEN && parity != UART_PARITY_ODD) { return UART_NOMODE; } /* Disable UART first to remove write protect */ dev(uart)->CTRLA.bit.ENABLE = 0; while (dev(uart)->SYNCBUSY.bit.ENABLE) {} dev(uart)->CTRLB.bit.CHSIZE = data_bits; if (parity == UART_PARITY_NONE) { dev(uart)->CTRLA.bit.FORM = 0x0; } else { dev(uart)->CTRLA.bit.FORM = 0x1; dev(uart)->CTRLB.bit.PMODE = (parity == UART_PARITY_ODD) ? 1 : 0; } dev(uart)->CTRLB.bit.SBMODE = (stop_bits == UART_STOP_BITS_1) ? 0 : 1; /* Enable UART again */ dev(uart)->CTRLA.bit.ENABLE = 1; while (dev(uart)->SYNCBUSY.bit.ENABLE) {} return UART_OK; } #endif #ifdef MODULE_PERIPH_UART_NONBLOCKING static inline void irq_handler_tx(unsigned uartnum) { /* workaround for saml1x */ int c = tsrb_get_one(&uart_tx_rb[uartnum]); if (c >= 0) { dev(uartnum)->DATA.reg = c; } /* disable the interrupt if there are no more bytes to send */ if (tsrb_empty(&uart_tx_rb[uartnum])) { dev(uartnum)->INTENCLR.reg = SERCOM_USART_INTENSET_DRE; } } #endif static inline void irq_handler(unsigned uartnum) { uint32_t status = dev(uartnum)->INTFLAG.reg; #if !defined(UART_HAS_TX_ISR) && defined(MODULE_PERIPH_UART_NONBLOCKING) if ((status & SERCOM_USART_INTFLAG_DRE) && dev(uartnum)->INTENSET.bit.DRE) { irq_handler_tx(uartnum); } #endif if (status & SERCOM_USART_INTFLAG_RXC) { /* interrupt flag is cleared by reading the data register */ uart_ctx[uartnum].rx_cb(uart_ctx[uartnum].arg, (uint8_t)(dev(uartnum)->DATA.reg)); } else if (status & SERCOM_USART_INTFLAG_ERROR) { /* clear error flag */ dev(uartnum)->INTFLAG.reg = SERCOM_USART_INTFLAG_ERROR; } cortexm_isr_end(); } #ifdef UART_0_ISR void UART_0_ISR(void) { irq_handler(0); } #endif #ifdef UART_1_ISR void UART_1_ISR(void) { irq_handler(1); } #endif #ifdef UART_2_ISR void UART_2_ISR(void) { irq_handler(2); } #endif #ifdef UART_3_ISR void UART_3_ISR(void) { irq_handler(3); } #endif #ifdef UART_4_ISR void UART_4_ISR(void) { irq_handler(4); } #endif #ifdef UART_5_ISR void UART_5_ISR(void) { irq_handler(5); } #endif #ifdef MODULE_PERIPH_UART_NONBLOCKING #ifdef UART_0_ISR_TX void UART_0_ISR_TX(void) { irq_handler_tx(0); } #endif #ifdef UART_1_ISR_TX void UART_1_ISR_TX(void) { irq_handler_tx(1); } #endif #ifdef UART_2_ISR_TX void UART_2_ISR_TX(void) { irq_handler_tx(2); } #endif #ifdef UART_3_ISR_TX void UART_3_ISR_TX(void) { irq_handler_tx(3); } #endif #ifdef UART_4_ISR_TX void UART_4_ISR_TX(void) { irq_handler_tx(4); } #endif #ifdef UART_5_ISR_TX void UART_5_ISR_TX(void) { irq_handler_tx(5); } #endif #endif /* MODULE_PERIPH_UART_NONBLOCKING */