busvoodoo_rs232.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/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 "busvoodoo_global.h" // BusVoodoo definitions
#include "busvoodoo_oled.h" // OLED utilities
#include "busvoodoo_uart_generic.h" // generic UART mode
#include "busvoodoo_rs232.h" // own definitions
#define BUSVOODOO_RS232_USART 2
static const struct busvoodoo_uart_generic_specific_t busvoodoo_uart_generic_rs232 = {
.usart = USART(BUSVOODOO_RS232_USART),
.usart_rcc = RCC_USART(BUSVOODOO_RS232_USART),
.usart_rst = RST_USART(BUSVOODOO_RS232_USART),
.multidrive = false,
.tx_port = USART_TX_PORT(BUSVOODOO_RS232_USART),
.tx_pin = USART_TX_PIN(BUSVOODOO_RS232_USART),
.tx_rcc = RCC_USART_PORT(BUSVOODOO_RS232_USART),
.tx_pre = NULL,
.tx_post = NULL,
.rx_port = USART_RX_PORT(BUSVOODOO_RS232_USART),
.rx_pin = USART_RX_PIN(BUSVOODOO_RS232_USART),
.rx_rcc = RCC_USART_PORT(BUSVOODOO_RS232_USART),
.rx_pre = NULL,
.rx_post = NULL,
.hwflowctl = true,
.rts_port = USART_RTS_PORT(BUSVOODOO_RS232_USART),
.rts_pin = USART_RTS_PIN(BUSVOODOO_RS232_USART),
.rts_rcc = RCC_USART_PORT(BUSVOODOO_RS232_USART),
.cts_port = USART_CTS_PORT(BUSVOODOO_RS232_USART),
.cts_pin = USART_CTS_PIN(BUSVOODOO_RS232_USART),
.cts_rcc = RCC_USART_PORT(BUSVOODOO_RS232_USART),
};
static bool busvoodoo_rs232_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_rs232); // provide the RS-232 specific information
}
complete = busvoodoo_uart_generic_setup(prefix, line); // configure underlying generic UART
if (complete) { // generic configuration finished
gpio_clear(GPIO(BUSVOODOO_RS232_EN_PORT), GPIO(BUSVOODOO_RS232_EN_PIN)); // set low to enable RS-232 transceiver receiver
gpio_set_mode(GPIO(BUSVOODOO_RS232_EN_PORT), GPIO_MODE_OUTPUT_10_MHZ, GPIO_CNF_OUTPUT_PUSHPULL, GPIO(BUSVOODOO_RS232_EN_PIN)); // setup RS-232 enable GPIO as output to enable the receiver (pulled high to disable by default)
gpio_set(GPIO(BUSVOODOO_RS232_SHDN_PORT), GPIO(BUSVOODOO_RS232_SHDN_PIN)); // set high to enable RS-232 transceiver transmitter
gpio_set_mode(GPIO(BUSVOODOO_RS232_SHDN_PORT), GPIO_MODE_OUTPUT_10_MHZ, GPIO_CNF_OUTPUT_PUSHPULL, GPIO(BUSVOODOO_RS232_SHDN_PIN)); // setup RS-232 shutdwon GPIO as output to enable the transmitter (pulled low to disable by default)
busvoodoo_led_blue_off(); // disable blue LED because there is no activity
*prefix = "RS-232"; // display mode
busvoodoo_oled_text_left(*prefix); // set mode title on OLED display
const char* pinout_io[10] = {"GND", "5V", "3V3", "LV", NULL, NULL, NULL, NULL, NULL, NULL}; // RS-232 mode I/O 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
}
const char* pinout_rscan[5] = {"HV", "Rx", "Tx", "CTS", "RTS"}; // RS-232 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
}
const char* pinout[10] = {pinout_rscan[0], pinout_io[0], pinout_rscan[1], pinout_io[2], pinout_rscan[2], pinout_io[4], pinout_rscan[3], pinout_io[6], pinout_rscan[4], pinout_io[8]}; // pinout to display
busvoodoo_oled_text_pinout(pinout, false); // set pinout on display
busvoodoo_oled_update(); // update display to show text and pinout
}
return complete;
}
static void busvoodoo_rs232_exit(void)
{
busvoodoo_uart_generic_exit(); // exiting the underlying generic UART does everything we need
gpio_set(GPIO(BUSVOODOO_RS232_EN_PORT), GPIO(BUSVOODOO_RS232_EN_PIN)); // set high to disable RS-232 transceiver receiver
gpio_clear(GPIO(BUSVOODOO_RS232_SHDN_PORT), GPIO(BUSVOODOO_RS232_SHDN_PIN)); // set low to disable RS-232 transceiver transmitter
}
const struct busvoodoo_mode_t busvoodoo_rs232_mode = {
.name = "rs232",
.description = "Recommended Standard 232",
.full_only = true,
.setup = &busvoodoo_rs232_setup,
.commands = busvoodoo_uart_generic_commands,
.commands_nb = busvoodoo_uart_generic_commands_nb,
.exit = &busvoodoo_rs232_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
busvoodoo_uart_generic_setup
bool busvoodoo_uart_generic_setup(char **prefix, const char *line)
setup generic UART mode
Definition: busvoodoo_uart_generic.c:88
busvoodoo_global.h
BusVoodoo global definitions and methods (API)
busvoodoo_rs232_exit
static void busvoodoo_rs232_exit(void)
exit RS-232 mode
Definition: busvoodoo_rs232.c:108
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:114
BUSVOODOO_RS232_EN_PORT
#define BUSVOODOO_RS232_EN_PORT
RS-232 pin to enable receiver (active low, pulled up)
Definition: busvoodoo_global.h:62
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
busvoodoo_global_pinout_rscan
const char * busvoodoo_global_pinout_rscan[5]
RS/CAN connector pinout.
Definition: busvoodoo_global.c:63
global.h
global definitions and methods (API)
GPIO
#define GPIO(x)
get GPIO based on GPIO identifier
Definition: global.h:103
busvoodoo_rs232_setup
static bool busvoodoo_rs232_setup(char **prefix, const char *line)
setup RS-232 mode
Definition: busvoodoo_rs232.c:76
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
USART_CTS_PORT
#define USART_CTS_PORT(x)
get port for USART CTS pin based on USART identifier
Definition: global.h:200
RST_USART
#define RST_USART(x)
get RST for USART based on USART identifier
Definition: global.h:188
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:274
busvoodoo_global_pinout_io
const char * busvoodoo_global_pinout_io[10]
I/O connector pinout.
Definition: busvoodoo_global.c:62
busvoodoo_uart_generic_rs232
static const struct busvoodoo_uart_generic_specific_t busvoodoo_uart_generic_rs232
RS-232 specific methods that will be called by the generic methods.
Definition: busvoodoo_rs232.c:47
BUSVOODOO_RS232_EN_PIN
#define BUSVOODOO_RS232_EN_PIN
RS-232 pin to enable receiver (active low, pulled up)
Definition: busvoodoo_global.h:63
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:64
BUSVOODOO_RS232_USART
#define BUSVOODOO_RS232_USART
USART peripheral.
Definition: busvoodoo_rs232.c:43
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:69
USART_RTS_PIN
#define USART_RTS_PIN(x)
get pin for USART RTS pin based on USART identifier
Definition: global.h:206
busvoodoo_rs232_mode
const struct busvoodoo_mode_t busvoodoo_rs232_mode
RS-232 mode interface definition.
Definition: busvoodoo_rs232.c:115
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:655
LENGTH
#define LENGTH(x)
get the length of an array
Definition: global.h:26
busvoodoo_rs232.h
BusVoodoo RS-232 mode (API)
busvoodoo_oled.h
library to show BusVoodoo mode information on SSD1306 OLED display: name, activity, pinout (API)
busvoodoo_mode_t
BusVoodoo mode interface.
Definition: busvoodoo_global.h:113
USART_RTS_PORT
#define USART_RTS_PORT(x)
get port for USART RTS pin based on USART identifier
Definition: global.h:198
BUSVOODOO_RS232_SHDN_PORT
#define BUSVOODOO_RS232_SHDN_PORT
RS-232 pin to enable transmitter (active high, pulled low)
Definition: busvoodoo_global.h:64
BUSVOODOO_RS232_SHDN_PIN
#define BUSVOODOO_RS232_SHDN_PIN
RS-232 pin to enable transmitter (active high, pulled low)
Definition: busvoodoo_global.h:65