CuVoodoo STM32F1 firmware template
busvoodoo_rs485.c
Go to the documentation of this file.
1 /* This program is free software: you can redistribute it and/or modify
2  * it under the terms of the GNU General Public License as published by
3  * the Free Software Foundation, either version 3 of the License, or
4  * (at your option) any later version.
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program. If not, see <http://www.gnu.org/licenses/>.
13  *
14  */
21 /* standard libraries */
22 #include <stdint.h> // standard integer types
23 #include <stdlib.h> // standard utilities
24 #include <string.h> // string utilities
25 
26 /* STM32 (including CM3) libraries */
27 #include <libopencm3/cm3/nvic.h> // interrupt utilities
28 #include <libopencm3/stm32/gpio.h> // general purpose input output library
29 #include <libopencm3/stm32/rcc.h> // real-time control clock library
30 #include <libopencm3/stm32/usart.h> // USART utilities
31 
32 /* own libraries */
33 #include "global.h" // board definitions
34 #include "print.h" // printing utilities
35 #include "menu.h" // menu definitions
36 #include "busvoodoo_global.h" // BusVoodoo definitions
37 #include "busvoodoo_oled.h" // OLED utilities
38 #include "busvoodoo_uart_generic.h" // generic UART mode
39 #include "busvoodoo_rs485.h" // own definitions
40 
44 #define BUSVOODOO_RS485_USART 2
48 static void busvoodoo_rs485_drive_enable(void)
49 {
50  gpio_set(GPIO(BUSVOODOO_RS485_DE_PORT), GPIO(BUSVOODOO_RS485_DE_PIN)); // set high to enable RS-485 transceiver driver
51 }
52 
55 {
56  gpio_clear(GPIO(BUSVOODOO_RS485_DE_PORT), GPIO(BUSVOODOO_RS485_DE_PIN)); // set low to disable RS-485 transceiver driver
57 }
58 
61 {
62  gpio_clear(GPIO(BUSVOODOO_RS485_RE_PORT), GPIO(BUSVOODOO_RS485_RE_PIN)); // set high to low enable RS-485 transceiver receiver
63 }
64 
67 {
68  gpio_set(GPIO(BUSVOODOO_RS485_RE_PORT), GPIO(BUSVOODOO_RS485_RE_PIN)); // set high to disable RS-485 transceiver receiver
69 }
70 
71 #define BUSVOODOO_RS485_RX_TIMER 2
72 #define BUSVOODOO_RS485_RX_CHANNEL 4
75 static const struct busvoodoo_uart_generic_specific_t busvoodoo_uart_generic_rs485 = {
76  .usart = USART(BUSVOODOO_RS485_USART),
77  .usart_rcc = RCC_USART(BUSVOODOO_RS485_USART),
78  .usart_rst = RST_USART(BUSVOODOO_RS485_USART),
79  .multidrive = false,
90  .hwflowctl = false,
91  .rts_port = 0,
92  .rts_pin = 0,
93  .rts_rcc = 0,
94  .cts_port = 0,
95  .cts_pin = 0,
96  .cts_rcc = 0,
97  .timer = TIM(BUSVOODOO_RS485_RX_TIMER),
98  .timer_rcc = RCC_TIM(BUSVOODOO_RS485_RX_TIMER),
102  .timer_ic = TIM_IC(BUSVOODOO_RS485_RX_CHANNEL),
103  .timer_ic_in_ti = TIM_IC_IN_TI(BUSVOODOO_RS485_RX_CHANNEL),
104  .timer_sr_ccif = TIM_SR_CCIF(BUSVOODOO_RS485_RX_CHANNEL),
105  .timer_sr_ccof = TIM_SR_CCOF(BUSVOODOO_RS485_RX_CHANNEL),
107  .timer_dier_ccie = TIM_DIER_CCIE(BUSVOODOO_RS485_RX_CHANNEL),
108  .timer_nvic_irq = NVIC_TIM_IRQ(BUSVOODOO_RS485_RX_TIMER),
109 };
110 
116 static bool busvoodoo_rs485_setup(char** prefix, const char* line)
117 {
118  bool complete = false; // is the setup complete
119  if (NULL==line) { // first call
120  busvoodoo_uart_generic_configure(&busvoodoo_uart_generic_rs485); // provide the RS-485 specific information
121  }
122  complete = busvoodoo_uart_generic_setup(prefix, line); // configure underlying generic UART
123  if (complete) { // generic configuration finished
124  gpio_clear(GPIO(BUSVOODOO_RS485_DE_PORT), GPIO(BUSVOODOO_RS485_DE_PIN)); // set low to disable RS-485 transceiver drive
125  gpio_set_mode(GPIO(BUSVOODOO_RS485_DE_PORT), GPIO_MODE_OUTPUT_10_MHZ, GPIO_CNF_OUTPUT_PUSHPULL, GPIO(BUSVOODOO_RS485_DE_PIN)); // setup RS-485 Drive Enable GPIO as output (pulled low to disable by default)
126  gpio_set(GPIO(BUSVOODOO_RS485_RE_PORT), GPIO(BUSVOODOO_RS485_RE_PIN)); // set RS-485 transceiver Receive Enable pin high to disable received
127  gpio_set_mode(GPIO(BUSVOODOO_RS485_RE_PORT), GPIO_MODE_OUTPUT_10_MHZ, GPIO_CNF_OUTPUT_OPENDRAIN, GPIO(BUSVOODOO_RS485_RE_PIN)); // setup RS-485 Receive Enable GPIO as output (pulled high to disable by default)
128  busvoodoo_led_blue_off(); // disable blue LED because there is no activity
129  *prefix = "RS-485/422"; // display mode
130  busvoodoo_oled_text_left(*prefix); // set mode title on OLED display
131  const char* pinout_io[10] = {"GND", "5V", "3V3", "LV", NULL, NULL, NULL, NULL, NULL, NULL}; // RS-485 mode I/O pinout
132  for (uint8_t i=0; i<LENGTH(pinout_io) && i<LENGTH(busvoodoo_global_pinout_io); i++) {
133  busvoodoo_global_pinout_io[i] = pinout_io[i]; // set pin names
134  }
135 #if BUSVOODOO_HARDWARE_VERSION==0
136  const char* pinout_rscan[5] = {"HV", NULL, NULL, "B", "A"}; // RS-485 mode RS/CAN pinout for hardware version 0
137 #else
138  const char* pinout_rscan[5] = {"HV", NULL, "A", "B", NULL}; // RS-485 mode RS/CAN pinout
139 #endif
140  for (uint8_t i=0; i<LENGTH(pinout_rscan) && i<LENGTH(busvoodoo_global_pinout_rscan); i++) {
141  busvoodoo_global_pinout_rscan[i] = pinout_rscan[i]; // set pin names
142  }
143  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
144  busvoodoo_oled_text_pinout((const char**)pinout, false); // set pinout on display
145  busvoodoo_oled_update(); // update display to show text and pinout
146  }
147  return complete;
148 }
149 
152 static void busvoodoo_rs485_exit(void)
153 {
154  busvoodoo_uart_generic_exit(); // exiting the underlying generic UART does everything we need
155  gpio_set(GPIO(BUSVOODOO_RS485_RE_PORT), GPIO(BUSVOODOO_RS485_RE_PIN)); // set high to disable RS-485 transceiver receiver
156  gpio_clear(GPIO(BUSVOODOO_RS485_DE_PORT), GPIO(BUSVOODOO_RS485_DE_PIN)); // set low to disable RS-485 transceiver driver
157 }
158 
160  .name = "rs485",
161  .description = "Recommended Standard 485/422",
162  .full_only = true,
163  .setup = &busvoodoo_rs485_setup,
165  .commands_nb = busvoodoo_uart_generic_commands_nb,
166  .exit = &busvoodoo_rs485_exit,
167 };
#define USART_TX_PORT(x)
get port for USART transmit pin based on USART identifier
Definition: global.h:194
#define RCC_USART(x)
get RCC for USART based on USART identifier
Definition: global.h:186
#define RCC_TIM_CH(x, y)
get RCC for port based on TIMx_CHy identifier
Definition: global.h:119
bool busvoodoo_uart_generic_setup(char **prefix, const char *line)
setup generic UART mode
BusVoodoo global definitions and methods (API)
void busvoodoo_oled_text_pinout(const char *pins[10], bool io_connector)
draw pin names on bottom (blue) part in display buffer
const char * name
name of the mode (i.e.
#define TIM_SR_CCOF(x)
get TIM_SR_CCxOF based on CHx identifier
Definition: global.h:150
static void busvoodoo_rs485_receive_enable(void)
enable RS-485 transceiver received to allow receiving
#define NVIC_TIM_IRQ(x)
get NVIC IRQ for timer base on TIM identifier
Definition: global.h:111
#define BUSVOODOO_RS485_RX_TIMER
timer ID to capture RX edges
#define RCC_USART_PORT(x)
get RCC for USART port based on USART identifier
Definition: global.h:210
void busvoodoo_oled_update(void)
update OLED display RAM with current display buffer
#define TIM_SR_CCIF(x)
get TIM_SR_CCxIF based on CHx identifier
Definition: global.h:148
const char * busvoodoo_global_pinout_rscan[5]
RS/CAN connector pinout.
#define TIM_DIER_CCIE(x)
get TIM_DIER_CCxIE based on CHx identifier
Definition: global.h:152
global definitions and methods (API)
#define GPIO(x)
get GPIO based on GPIO identifier
Definition: global.h:103
#define TIM_CCR(x, y)
get TIM_CCRy register based on TIMx_CHy identifier
Definition: global.h:154
#define BUSVOODOO_RS485_RE_PORT
RS-485 pin to enable receiver (active low, pulled up)
#define RCC_TIM(x)
get RCC for timer based on TIM identifier
Definition: global.h:109
#define TIM_CH_PIN(x, y)
get pin based on TIMx_CHy identifier
Definition: global.h:117
static bool busvoodoo_rs485_setup(char **prefix, const char *line)
setup RS-485 mode
void busvoodoo_led_blue_off(void)
switch off blue LED
static void busvoodoo_rs485_drive_enable(void)
enable RS-485 transceiver driver to allow transmitting
#define USART_RX_PIN(x)
get pin for USART receive pin based on USART identifier
Definition: global.h:204
#define USART_TX_PIN(x)
get pin for USART transmit pin based on USART identifier
Definition: global.h:202
#define TIM_IC(x)
get TIM_IC based on CHx identifier
Definition: global.h:144
#define RST_USART(x)
get RST for USART based on USART identifier
Definition: global.h:188
#define USART(x)
get USART based on USART identifier
Definition: global.h:184
#define BUSVOODOO_RS485_DE_PORT
RS-485 pin to enable transmitter (active high, pulled low)
void busvoodoo_uart_generic_exit(void)
exit genetic UART mode
#define TIM_IC_IN_TI(x)
get TIM_IC_IN_TI based on CHx identifier
Definition: global.h:146
const char * busvoodoo_global_pinout_io[10]
I/O connector pinout.
#define busvoodoo_uart_generic_commands_nb
number of commands supported by the generic UART mode
#define TIM_CH_PORT(x, y)
get port based on TIMx_CHy identifier
Definition: global.h:115
#define USART_RX_PORT(x)
get port for USART receive pin based on USART identifier
Definition: global.h:196
bool busvoodoo_uart_generic_configure(const struct busvoodoo_uart_generic_specific_t *conf)
provide the generic USART with mode specific information
static void busvoodoo_rs485_receive_disable(void)
enable RS-485 transceiver received to allow receiving
BusVoodoo generic UART mode (API)
#define BUSVOODOO_RS485_DE_PIN
RS-485 pin to enable transmitter (active high, pulled low)
void busvoodoo_oled_text_left(char *text)
draw mode text on top (yellow) left side in display buffer
const struct menu_command_t busvoodoo_uart_generic_commands[busvoodoo_uart_generic_commands_nb]
commands supported by the generic UART mode
#define LENGTH(x)
get the length of an array
Definition: global.h:26
static void busvoodoo_rs485_drive_disable(void)
enable RS-485 transceiver driver to allow transmitting
#define BUSVOODOO_RS485_RE_PIN
RS-485 pin to enable receiver (active low, pulled up)
#define TIM(x)
get TIM based on TIM identifier
Definition: global.h:107
#define BUSVOODOO_RS485_RX_CHANNEL
channel ID used as input capture to capture RX edges
static const struct busvoodoo_uart_generic_specific_t busvoodoo_uart_generic_rs485
RS-485 specific methods that will be called by the generic methods.
library to show BusVoodoo mode information on SSD1306 OLED display: name, activity, pinout (API)
BusVoodoo mode interface.
BusVoodoo RS-485/422 mode (API)
static void busvoodoo_rs485_exit(void)
exit RS-485 mode
#define BUSVOODOO_RS485_USART
USART peripheral.
const struct busvoodoo_mode_t busvoodoo_rs485_mode
RS-485 mode interface definition.