busvoodoo_uart.c
Go to the documentation of this file.
/* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* standard libraries */
#include <stdint.h> // standard integer types
#include <stdlib.h> // standard utilities
#include <string.h> // string utilities
/* STM32 (including CM3) libraries */
#include <libopencm3/cm3/nvic.h> // interrupt definitions
#include <libopencm3/stm32/gpio.h> // general purpose input output library
#include <libopencm3/stm32/rcc.h> // real-time control clock library
#include <libopencm3/stm32/usart.h> // USART utilities
/* own libraries */
#include "global.h" // board definitions
#include "print.h" // printing utilities
#include "menu.h" // menu definitions
#include "usart_enhanced.h" // utilities for USART enhancements
#include "busvoodoo_global.h" // BusVoodoo definitions
#include "busvoodoo_oled.h" // OLED utilities
#include "busvoodoo_uart_generic.h" // generic UART mode
#include "busvoodoo_uart.h" // own definitions
#define BUSVOODOO_UART_USART 3
#define BUSVOODOO_UART_RX_TIMER 2
#define BUSVOODOO_UART_RX_CHANNEL 4
static const struct busvoodoo_uart_generic_specific_t busvoodoo_uart_generic_uart = {
.usart = USART(BUSVOODOO_UART_USART),
.usart_rcc = RCC_USART(BUSVOODOO_UART_USART),
.usart_rst = RST_USART(BUSVOODOO_UART_USART),
.multidrive = true,
.tx_port = USART_TX_PORT(BUSVOODOO_UART_USART),
.tx_pin = USART_TX_PIN(BUSVOODOO_UART_USART),
.tx_rcc = RCC_USART_PORT(BUSVOODOO_UART_USART),
.tx_pre = NULL,
.tx_post = NULL,
.rx_port = USART_RX_PORT(BUSVOODOO_UART_USART),
.rx_pin = USART_RX_PIN(BUSVOODOO_UART_USART),
.rx_rcc = RCC_USART_PORT(BUSVOODOO_UART_USART),
.rx_pre = NULL,
.rx_post = NULL,
.hwflowctl = true,
.rts_port = USART_RTS_PORT(BUSVOODOO_UART_USART),
.rts_pin = USART_RTS_PIN(BUSVOODOO_UART_USART),
.rts_rcc = RCC_USART_PORT(BUSVOODOO_UART_USART),
.cts_port = USART_CTS_PORT(BUSVOODOO_UART_USART),
.cts_pin = USART_CTS_PIN(BUSVOODOO_UART_USART),
.cts_rcc = RCC_USART_PORT(BUSVOODOO_UART_USART),
.timer = TIM(BUSVOODOO_UART_RX_TIMER),
.timer_rcc = RCC_TIM(BUSVOODOO_UART_RX_TIMER),
.timer_port = TIM_CH_PORT(BUSVOODOO_UART_RX_TIMER, BUSVOODOO_UART_RX_CHANNEL),
.timer_port_rcc = RCC_TIM_CH(BUSVOODOO_UART_RX_TIMER, BUSVOODOO_UART_RX_CHANNEL),
.timer_pin = TIM_CH_PIN(BUSVOODOO_UART_RX_TIMER, BUSVOODOO_UART_RX_CHANNEL),
.timer_ic = TIM_IC(BUSVOODOO_UART_RX_CHANNEL),
.timer_ic_in_ti = TIM_IC_IN_TI(BUSVOODOO_UART_RX_CHANNEL),
.timer_sr_ccif = TIM_SR_CCIF(BUSVOODOO_UART_RX_CHANNEL),
.timer_sr_ccof = TIM_SR_CCOF(BUSVOODOO_UART_RX_CHANNEL),
.timer_ccr = &TIM_CCR(BUSVOODOO_UART_RX_TIMER, BUSVOODOO_UART_RX_CHANNEL),
.timer_dier_ccie = TIM_DIER_CCIE(BUSVOODOO_UART_RX_CHANNEL),
.timer_nvic_irq = NVIC_TIM_IRQ(BUSVOODOO_UART_RX_TIMER),
};
static bool busvoodoo_uart_setup(char** prefix, const char* line)
{
bool complete = false; // is the setup complete
if (NULL==line) { // first call
busvoodoo_uart_generic_configure(&busvoodoo_uart_generic_uart); // provide the UART specific information
}
complete = busvoodoo_uart_generic_setup(prefix, line); // configure underlying generic UART
if (complete) { // generic configuration finished
busvoodoo_led_blue_off(); // disable blue LED because there is no activity
gpio_primary_remap(AFIO_MAPR_SWJ_CFG_JTAG_OFF_SW_ON, AFIO_MAPR_TIM2_REMAP_PARTIAL_REMAP2); // remap timer 2 channel 4 to RX to be able to measure the edge timing
*prefix = "UART"; // display mode
busvoodoo_oled_text_left(*prefix); // set mode title on OLED display
const char* pinout_io[10] = {"GND", "5V", "3V3", "LV", "Rx", "Tx", "RTS", "CTS", NULL, NULL}; // UART mode pinout
for (uint8_t i=0; i<LENGTH(pinout_io) && i<LENGTH(busvoodoo_global_pinout_io); i++) {
busvoodoo_global_pinout_io[i] = pinout_io[i]; // set pin names
}
if (busvoodoo_full) {
const char* pinout_rscan[5] = {"HV", NULL, NULL, NULL, NULL}; // HiZ mode RS/CAN pinout
for (uint8_t i=0; i<LENGTH(pinout_rscan) && i<LENGTH(busvoodoo_global_pinout_rscan); i++) {
busvoodoo_global_pinout_rscan[i] = pinout_rscan[i]; // set pin names
}
}
busvoodoo_oled_text_pinout((const char**)pinout_io, true); // set pinout on display
busvoodoo_oled_update(); // update display to show text and pinout
}
return complete;
}
static void busvoodoo_uart_exit(void)
{
busvoodoo_uart_generic_exit(); // exiting the underlying generic UART does everything we need
// disable timer 2 remapping set during configuration
uint32_t remap = AFIO_MAPR; // get the remap setting
remap &= ~AFIO_MAPR_SWJ_MASK; // mask the SWJ setting since they are read only
remap &= ~AFIO_MAPR_TIM2_REMAP_FULL_REMAP; // clear the timer 2 remap
gpio_primary_remap(AFIO_MAPR_SWJ_CFG_JTAG_OFF_SW_ON, remap); // disable timer 2 remapping set during configuration
}
const struct busvoodoo_mode_t busvoodoo_uart_mode = {
.name = "uart",
.description = "Universal Asynchronous Receiver-Transmitter",
.full_only = false,
.setup = &busvoodoo_uart_setup,
.commands = busvoodoo_uart_generic_commands,
.commands_nb = busvoodoo_uart_generic_commands_nb,
.exit = &busvoodoo_uart_exit,
};
USART_TX_PORT
#define USART_TX_PORT(x)
get port for USART transmit pin based on USART identifier
Definition: global.h:194
RCC_USART
#define RCC_USART(x)
get RCC for USART based on USART identifier
Definition: global.h:186
RCC_TIM_CH
#define RCC_TIM_CH(x, y)
get RCC for port based on TIMx_CHy identifier
Definition: global.h:119
busvoodoo_uart_generic_setup
bool busvoodoo_uart_generic_setup(char **prefix, const char *line)
setup generic UART mode
Definition: busvoodoo_uart_generic.c:98
busvoodoo_global.h
BusVoodoo global definitions and methods (API)
busvoodoo_oled_text_pinout
void busvoodoo_oled_text_pinout(const char *pins[10], bool io_connector)
draw pin names on bottom (blue) part in display buffer
Definition: busvoodoo_oled.c:148
busvoodoo_mode_t::name
const char * name
name of the mode (i.e.
Definition: busvoodoo_global.h:116
TIM_SR_CCOF
#define TIM_SR_CCOF(x)
get TIM_SR_CCxOF based on CHx identifier
Definition: global.h:150
NVIC_TIM_IRQ
#define NVIC_TIM_IRQ(x)
get NVIC IRQ for timer base on TIM identifier
Definition: global.h:111
RCC_USART_PORT
#define RCC_USART_PORT(x)
get RCC for USART port based on USART identifier
Definition: global.h:210
busvoodoo_oled_update
void busvoodoo_oled_update(void)
update OLED display RAM with current display buffer
Definition: busvoodoo_oled.c:289
TIM_SR_CCIF
#define TIM_SR_CCIF(x)
get TIM_SR_CCxIF based on CHx identifier
Definition: global.h:148
busvoodoo_global_pinout_rscan
const char * busvoodoo_global_pinout_rscan[5]
RS/CAN connector pinout.
Definition: busvoodoo_global.c:63
TIM_DIER_CCIE
#define TIM_DIER_CCIE(x)
get TIM_DIER_CCxIE based on CHx identifier
Definition: global.h:152
global.h
global definitions and methods (API)
TIM_CCR
#define TIM_CCR(x, y)
get TIM_CCRy register based on TIMx_CHy identifier
Definition: global.h:154
BUSVOODOO_UART_RX_TIMER
#define BUSVOODOO_UART_RX_TIMER
timer ID to capture RX edges
Definition: busvoodoo_uart.c:48
busvoodoo_full
bool busvoodoo_full
is the BusVoodoo board fully populated (with HV voltage regulator, RS-232, RS-485, CAN transceiver on the back side)
Definition: busvoodoo_global.c:70
RCC_TIM
#define RCC_TIM(x)
get RCC for timer based on TIM identifier
Definition: global.h:109
TIM_CH_PIN
#define TIM_CH_PIN(x, y)
get pin based on TIMx_CHy identifier
Definition: global.h:117
busvoodoo_uart_setup
static bool busvoodoo_uart_setup(char **prefix, const char *line)
setup UART mode
Definition: busvoodoo_uart.c:93
busvoodoo_led_blue_off
void busvoodoo_led_blue_off(void)
switch off blue LED
Definition: busvoodoo_global.c:426
USART_RX_PIN
#define USART_RX_PIN(x)
get pin for USART receive pin based on USART identifier
Definition: global.h:204
USART_TX_PIN
#define USART_TX_PIN(x)
get pin for USART transmit pin based on USART identifier
Definition: global.h:202
TIM_IC
#define TIM_IC(x)
get TIM_IC based on CHx identifier
Definition: global.h:144
USART_CTS_PORT
#define USART_CTS_PORT(x)
get port for USART CTS pin based on USART identifier
Definition: global.h:200
BUSVOODOO_UART_USART
#define BUSVOODOO_UART_USART
USART peripheral.
Definition: busvoodoo_uart.c:45
RST_USART
#define RST_USART(x)
get RST for USART based on USART identifier
Definition: global.h:188
busvoodoo_uart_mode
const struct busvoodoo_mode_t busvoodoo_uart_mode
UART mode interface definition.
Definition: busvoodoo_uart.c:133
USART
#define USART(x)
get USART based on USART identifier
Definition: global.h:184
busvoodoo_uart_generic_exit
void busvoodoo_uart_generic_exit(void)
exit genetic UART mode
Definition: busvoodoo_uart_generic.c:287
TIM_IC_IN_TI
#define TIM_IC_IN_TI(x)
get TIM_IC_IN_TI based on CHx identifier
Definition: global.h:146
busvoodoo_global_pinout_io
const char * busvoodoo_global_pinout_io[10]
I/O connector pinout.
Definition: busvoodoo_global.c:62
busvoodoo_uart.h
BusVoodoo UART mode (API)
busvoodoo_uart_generic_commands_nb
#define busvoodoo_uart_generic_commands_nb
number of commands supported by the generic UART mode
Definition: busvoodoo_uart_generic.h:79
TIM_CH_PORT
#define TIM_CH_PORT(x, y)
get port based on TIMx_CHy identifier
Definition: global.h:115
USART_RX_PORT
#define USART_RX_PORT(x)
get port for USART receive pin based on USART identifier
Definition: global.h:196
busvoodoo_uart_generic_configure
bool busvoodoo_uart_generic_configure(const struct busvoodoo_uart_generic_specific_t *conf)
provide the generic USART with mode specific information
Definition: busvoodoo_uart_generic.c:76
USART_RTS_PIN
#define USART_RTS_PIN(x)
get pin for USART RTS pin based on USART identifier
Definition: global.h:206
USART_CTS_PIN
#define USART_CTS_PIN(x)
get pin for USART CTS pin based on USART identifier
Definition: global.h:208
busvoodoo_uart_generic.h
BusVoodoo generic UART mode (API)
print.h
printing utilities to replace the large printf from the standard library (API)
busvoodoo_oled_text_left
void busvoodoo_oled_text_left(char *text)
draw mode text on top (yellow) left side in display buffer
Definition: busvoodoo_oled.c:118
busvoodoo_uart_generic_commands
const struct menu_command_t busvoodoo_uart_generic_commands[busvoodoo_uart_generic_commands_nb]
commands supported by the generic UART mode
Definition: busvoodoo_uart_generic.c:1018
busvoodoo_uart_generic_uart
static const struct busvoodoo_uart_generic_specific_t busvoodoo_uart_generic_uart
UART specific methods that will be called by the generic methods.
Definition: busvoodoo_uart.c:52
BUSVOODOO_UART_RX_CHANNEL
#define BUSVOODOO_UART_RX_CHANNEL
channel ID used as input capture to capture RX edges
Definition: busvoodoo_uart.c:49
LENGTH
#define LENGTH(x)
get the length of an array
Definition: global.h:26
TIM
#define TIM(x)
get TIM based on TIM identifier
Definition: global.h:107
busvoodoo_oled.h
library to show BusVoodoo mode information on SSD1306 OLED display: name, activity, pinout (API)
busvoodoo_uart_exit
static void busvoodoo_uart_exit(void)
exit UART mode
Definition: busvoodoo_uart.c:123
busvoodoo_mode_t
BusVoodoo mode interface.
Definition: busvoodoo_global.h:115
USART_RTS_PORT
#define USART_RTS_PORT(x)
get port for USART RTS pin based on USART identifier
Definition: global.h:198
usart_enhanced.h
library for enhanced USART communication (API)