2018-01-24 16:36:19 +01:00
/* 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/>.
*
*/
/** BusVoodoo UART mode (code)
* @ file busvoodoo_uart . c
* @ author King Kévin < kingkevin @ cuvoodoo . info >
* @ date 2018
* @ note peripherals used : USART @ ref busvoodoo_uart
*/
/* 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
2018-02-06 12:33:00 +01:00
# include "busvoodoo_oled.h" // OLED utilities
2018-01-24 16:36:19 +01:00
# include "busvoodoo_uart.h" // own definitions
/** @defgroup busvoodoo_uart USART peripheral used for UART communication
* @ {
*/
# define BUSVOODOO_USART_ID 3 /**< USART peripheral */
/** @} */
/** mode setup stage */
static enum busvoodoo_uart_setting_t {
BUSVOODOO_UART_SETTING_NONE ,
BUSVOODOO_UART_SETTING_BAUDRATE ,
BUSVOODOO_UART_SETTING_DATABITS ,
BUSVOODOO_UART_SETTING_PARITY ,
BUSVOODOO_UART_SETTING_STOPBITS ,
2018-03-22 13:53:05 +01:00
BUSVOODOO_UART_SETTING_HWFLOWCTL ,
2018-01-24 16:36:19 +01:00
BUSVOODOO_UART_SETTING_DRIVE ,
BUSVOODOO_UART_SETTING_DONE ,
2018-03-22 13:53:05 +01:00
} busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_NONE ; /**< current mode setup stage */
2018-01-24 16:36:19 +01:00
/** UART baud rate (in bps) */
2018-03-15 18:55:52 +01:00
static uint32_t busvoodoo_uart_baudrate = 115200 ;
2018-01-24 16:36:19 +01:00
/** UART data bits */
2018-03-15 18:55:52 +01:00
static uint8_t busvoodoo_uart_databits = 8 ;
2018-01-24 16:36:19 +01:00
/** UART parity setting */
2018-03-22 13:53:05 +01:00
static uint32_t busvoodoo_uart_parity = USART_PARITY_NONE ;
/** UART stop bits setting */
static uint32_t busvoodoo_uart_stopbits = USART_STOPBITS_1 ;
/** UART hardware flow control setting (true = with hardware flow control, false = without hardware flow control */
static bool busvoodoo_uart_hwflowctl = false ;
/** pin drive mode (true = push-pull, false = open-drain) */
static bool busvoodoo_uart_drive = true ;
/** if embedded pull-up resistors are used */
static bool busvoodoo_uart_pullup = false ;
2018-01-24 16:36:19 +01:00
/** setup UART mode
* @ param [ out ] prefix terminal prompt prefix
* @ param [ in ] line terminal prompt line to configure mode
* @ return if setup is complete
*/
static bool busvoodoo_uart_setup ( char * * prefix , const char * line )
{
bool complete = false ; // is the setup complete
if ( NULL = = line ) { // first call
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_NONE ; // re-start configuration
}
switch ( busvoodoo_uart_setting ) {
case BUSVOODOO_UART_SETTING_NONE :
2018-03-15 18:55:52 +01:00
snprintf ( busvoodoo_global_string , LENGTH ( busvoodoo_global_string ) , " baud rate in bps (1-2000000) [%u] " , busvoodoo_uart_baudrate ) ;
* prefix = busvoodoo_global_string ; // ask for baud rate
2018-01-24 16:36:19 +01:00
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_BAUDRATE ;
break ;
case BUSVOODOO_UART_SETTING_BAUDRATE :
if ( NULL = = line | | 0 = = strlen ( line ) ) { // use default setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_DATABITS ; // go to next setting
} else { // setting provided
uint32_t baudrate = atoi ( line ) ; // parse setting
2018-03-15 18:55:52 +01:00
if ( baudrate > 0 & & baudrate < = 2000000 ) { // check setting
2018-01-24 16:36:19 +01:00
busvoodoo_uart_baudrate = baudrate ; // remember setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_DATABITS ; // go to next setting
}
}
if ( BUSVOODOO_UART_SETTING_DATABITS = = busvoodoo_uart_setting ) { // if next setting
2018-03-15 18:55:52 +01:00
snprintf ( busvoodoo_global_string , LENGTH ( busvoodoo_global_string ) , " data bits (8-9) [%u] " , busvoodoo_uart_databits ) ; // prepare next setting
* prefix = busvoodoo_global_string ; // display next setting
2018-01-24 16:36:19 +01:00
}
break ;
case BUSVOODOO_UART_SETTING_DATABITS :
if ( NULL = = line | | 0 = = strlen ( line ) ) { // use default setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_PARITY ; // go to next setting
} else { // setting provided
uint8_t databits = atoi ( line ) ; // parse setting
if ( 8 = = databits | | 9 = = databits ) { // check setting
busvoodoo_uart_databits = databits ; // remember setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_PARITY ; // go to next setting
}
}
if ( BUSVOODOO_UART_SETTING_PARITY = = busvoodoo_uart_setting ) { // if next setting
2018-03-22 13:53:05 +01:00
printf ( " 1) none \n " ) ;
printf ( " 2) even \n " ) ;
printf ( " 3) odd \n " ) ;
snprintf ( busvoodoo_global_string , LENGTH ( busvoodoo_global_string ) , " parity (1,2,3) [%c] " , USART_PARITY_NONE = = busvoodoo_uart_parity ? ' 1 ' : ( USART_PARITY_EVEN = = busvoodoo_uart_parity ? ' 2 ' : ' 3 ' ) ) ; // prepare next setting
2018-03-15 18:55:52 +01:00
* prefix = busvoodoo_global_string ; // display next setting
2018-01-24 16:36:19 +01:00
}
break ;
case BUSVOODOO_UART_SETTING_PARITY :
if ( NULL = = line | | 0 = = strlen ( line ) ) { // use default setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_STOPBITS ; // go to next setting
2018-03-22 13:53:05 +01:00
} else if ( 1 = = strlen ( line ) ) { // setting provided
if ( ' 1 ' = = line [ 0 ] ) { // no parity
busvoodoo_uart_parity = USART_PARITY_NONE ;
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_STOPBITS ; // go to next setting
} else if ( ' 2 ' = = line [ 0 ] ) { // even parity
busvoodoo_uart_parity = USART_PARITY_EVEN ;
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_STOPBITS ; // go to next setting
} else if ( ' 3 ' = = line [ 0 ] ) { // odd parity
busvoodoo_uart_parity = USART_PARITY_ODD ;
2018-01-24 16:36:19 +01:00
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_STOPBITS ; // go to next setting
}
}
if ( BUSVOODOO_UART_SETTING_STOPBITS = = busvoodoo_uart_setting ) { // if next setting
2018-03-22 13:53:05 +01:00
printf ( " 1) 0.5 \n " ) ;
printf ( " 2) 1 \n " ) ;
printf ( " 3) 1.5 \n " ) ;
printf ( " 4) 2 \n " ) ;
snprintf ( busvoodoo_global_string , LENGTH ( busvoodoo_global_string ) , " stop bits (1,2,3,4) [%s] " , USART_STOPBITS_0_5 = = busvoodoo_uart_stopbits ? " 0.5 " : ( USART_STOPBITS_1 = = busvoodoo_uart_stopbits ? " 1 " : ( USART_STOPBITS_1_5 = = busvoodoo_uart_stopbits ? " 1.5 " : " 2.0 " ) ) ) ; // prepare next setting
2018-03-15 18:55:52 +01:00
* prefix = busvoodoo_global_string ; // display next setting
2018-01-24 16:36:19 +01:00
}
break ;
case BUSVOODOO_UART_SETTING_STOPBITS :
2018-03-22 13:53:05 +01:00
if ( NULL = = line | | 0 = = strlen ( line ) ) { // use default setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_HWFLOWCTL ; // go to next setting
} else if ( 1 = = strlen ( line ) ) { // setting provided
if ( ' 1 ' = = line [ 0 ] ) { // 0.5 stop bits
busvoodoo_uart_stopbits = USART_STOPBITS_0_5 ; // remember setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_HWFLOWCTL ; // go to next setting
} else if ( ' 2 ' = = line [ 0 ] ) { // 1 stop bits
busvoodoo_uart_stopbits = USART_STOPBITS_1 ; // remember setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_HWFLOWCTL ; // go to next setting
} else if ( ' 3 ' = = line [ 0 ] ) { // 1.5 stop bits
busvoodoo_uart_stopbits = USART_STOPBITS_1_5 ; // remember setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_HWFLOWCTL ; // go to next setting
} else if ( ' 4 ' = = line [ 0 ] ) { // 2 stop bits
busvoodoo_uart_stopbits = USART_STOPBITS_2 ; // remember setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_HWFLOWCTL ; // go to next setting
}
}
if ( BUSVOODOO_UART_SETTING_HWFLOWCTL = = busvoodoo_uart_setting ) { // if next setting
printf ( " 1) no flow control \n " ) ;
printf ( " 2) RTS/CTS hardware flow control \n " ) ;
snprintf ( busvoodoo_global_string , LENGTH ( busvoodoo_global_string ) , " flow control (1,2) [%c] " , busvoodoo_uart_hwflowctl ? ' 2 ' : ' 1 ' ) ; // prepare next setting
* prefix = busvoodoo_global_string ; // display next setting
}
break ;
case BUSVOODOO_UART_SETTING_HWFLOWCTL :
2018-01-24 16:36:19 +01:00
if ( NULL = = line | | 0 = = strlen ( line ) ) { // use default setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_DRIVE ; // go to next setting
2018-03-22 13:53:05 +01:00
} else if ( 1 = = strlen ( line ) ) { // setting provided
if ( ' 1 ' = = line [ 0 ] | | ' 2 ' = = line [ 0 ] ) { // setting provided
busvoodoo_uart_hwflowctl = ( ' 2 ' = = line [ 0 ] ) ; // remember setting
2018-01-24 16:36:19 +01:00
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_DRIVE ; // go to next setting
}
}
if ( BUSVOODOO_UART_SETTING_DRIVE = = busvoodoo_uart_setting ) { // if next setting
2018-03-22 13:53:05 +01:00
printf ( " 1) push-pull (3.3V) \n " ) ;
printf ( " 2) open-drain, with embedded pull-up resistors (2kO) \n " ) ;
printf ( " 3) open-drain, with external pull-up resistors \n " ) ;
snprintf ( busvoodoo_global_string , LENGTH ( busvoodoo_global_string ) , " drive mode (1,2,3) [%c] " , busvoodoo_uart_drive ? ' 1 ' : ( busvoodoo_uart_pullup ? ' 2 ' : ' 3 ' ) ) ; // show drive mode
2018-03-15 18:55:52 +01:00
* prefix = busvoodoo_global_string ; // display next setting
2018-01-24 16:36:19 +01:00
}
break ;
case BUSVOODOO_UART_SETTING_DRIVE :
if ( NULL = = line | | 0 = = strlen ( line ) ) { // use default setting
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_DONE ; // go to next setting
2018-03-22 13:53:05 +01:00
} else if ( 1 = = strlen ( line ) ) { // setting provided
uint8_t drive = atoi ( line ) ; // parse setting
if ( 1 = = drive | | 2 = = drive | | 3 = = drive ) { // check setting
busvoodoo_uart_drive = ( 1 = = drive ) ; // remember setting
busvoodoo_uart_pullup = ( 2 = = drive ) ; // remember setting
2018-01-24 16:36:19 +01:00
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_DONE ; // go to next setting
}
}
if ( BUSVOODOO_UART_SETTING_DONE = = busvoodoo_uart_setting ) { // we have all settings, configure UART
2018-03-15 18:55:52 +01:00
rcc_periph_clock_enable ( RCC_AFIO ) ; // enable clock for USART alternate function
2018-03-22 13:53:05 +01:00
rcc_periph_clock_enable ( RCC_USART ( BUSVOODOO_USART_ID ) ) ; // enable clock for USART peripheral
2018-01-24 16:36:19 +01:00
usart_set_baudrate ( USART ( BUSVOODOO_USART_ID ) , busvoodoo_uart_baudrate ) ; // set baud rate
usart_set_databits ( USART ( BUSVOODOO_USART_ID ) , busvoodoo_uart_databits ) ; // set data bits
2018-03-22 13:53:05 +01:00
usart_set_parity ( USART ( BUSVOODOO_USART_ID ) , busvoodoo_uart_parity ) ; // set parity
usart_set_stopbits ( USART ( BUSVOODOO_USART_ID ) , busvoodoo_uart_stopbits ) ; // set stop bits
if ( busvoodoo_uart_hwflowctl ) {
usart_set_flow_control ( USART ( BUSVOODOO_USART_ID ) , USART_FLOWCONTROL_RTS_CTS ) ; // set RTS/CTS flow control
} else {
usart_set_flow_control ( USART ( BUSVOODOO_USART_ID ) , USART_FLOWCONTROL_NONE ) ; // set no flow control
2018-01-24 16:36:19 +01:00
}
usart_set_mode ( USART ( BUSVOODOO_USART_ID ) , USART_MODE_TX_RX ) ; // full-duplex communication
2018-03-22 13:53:05 +01:00
rcc_periph_clock_enable ( RCC_USART_PORT ( BUSVOODOO_USART_ID ) ) ; // enable clock for USART GPIO peripheral
if ( busvoodoo_uart_drive ) { // use push-pull drive mode
gpio_set_mode ( USART_TX_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_OUTPUT_10_MHZ , GPIO_CNF_OUTPUT_ALTFN_PUSHPULL , USART_TX_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART transmit
gpio_set ( USART_RX_PORT ( BUSVOODOO_USART_ID ) , USART_RX_PIN ( BUSVOODOO_USART_ID ) ) ; // pull up to avoid noise when not connected
gpio_set_mode ( USART_RX_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_PULL_UPDOWN , USART_RX_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART receive
if ( busvoodoo_uart_hwflowctl ) { // use open drain drive mode
gpio_set_mode ( USART_RTS_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_OUTPUT_10_MHZ , GPIO_CNF_OUTPUT_ALTFN_OPENDRAIN , USART_RTS_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART transmit
gpio_set ( USART_CTS_PORT ( BUSVOODOO_USART_ID ) , USART_CTS_PIN ( BUSVOODOO_USART_ID ) ) ; // pull up to block transmission unless requested
gpio_set_mode ( USART_CTS_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_PULL_UPDOWN , USART_CTS_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART receive
}
} else {
gpio_set_mode ( USART_TX_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_OUTPUT_10_MHZ , GPIO_CNF_OUTPUT_ALTFN_PUSHPULL , USART_TX_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART transmit
gpio_set_mode ( USART_RX_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , USART_RX_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART receive
if ( busvoodoo_uart_hwflowctl ) {
gpio_set_mode ( USART_RTS_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_OUTPUT_10_MHZ , GPIO_CNF_OUTPUT_ALTFN_OPENDRAIN , USART_RTS_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART transmit
gpio_set_mode ( USART_CTS_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , USART_CTS_PIN ( BUSVOODOO_USART_ID ) ) ; // setup GPIO pin USART receive
}
}
if ( ! busvoodoo_uart_drive & & busvoodoo_uart_pullup ) { // enable embedded pull-ups if used
busvoodoo_embedded_pullup ( true ) ; // set embedded pull-ups
printf ( " use LV to set pull-up voltage \n " ) ;
2018-01-24 16:36:19 +01:00
}
usart_enable ( USART ( BUSVOODOO_USART_ID ) ) ; // enable USART
2018-05-03 12:56:09 +02:00
busvoodoo_led_blue_off ( ) ; // disable blue LED because there is no activity
2018-01-24 16:36:19 +01:00
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_NONE ; // restart settings next time
* prefix = " UART " ; // display mode
2018-03-22 13:53:05 +01:00
busvoodoo_oled_text_left ( * prefix ) ; // set mode title on OLED display
char * pinout_io [ 10 ] = { " GND " , " 5V " , " 3V3 " , " LV " , " Rx " , " Tx " , NULL , NULL , NULL , NULL } ; // UART mode pinout
if ( busvoodoo_uart_hwflowctl ) { // hardware flow control is used
pinout_io [ 6 ] = " RTS " ; // update pin name
pinout_io [ 7 ] = " CTS " ; // update pin name
}
2018-02-06 17:35:14 +01:00
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
}
2018-04-04 17:14:36 +02:00
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
}
}
2018-03-22 13:53:05 +01:00
busvoodoo_oled_text_pinout ( ( const char * * ) pinout_io , true ) ; // set pinout on display
2018-02-06 12:33:00 +01:00
busvoodoo_oled_update ( ) ; // update display to show text and pinout
complete = true ; // configuration is complete
2018-01-24 16:36:19 +01:00
}
break ;
default : // unknown case
busvoodoo_uart_setting = BUSVOODOO_UART_SETTING_NONE ; // restart settings next time
break ;
}
return complete ;
}
/** exit UART mode
*/
static void busvoodoo_uart_exit ( void )
{
usart_disable ( USART ( BUSVOODOO_USART_ID ) ) ; // disable USART
2018-03-22 13:53:05 +01:00
rcc_periph_clock_disable ( RCC_USART ( BUSVOODOO_USART_ID ) ) ; // disable domain clock
gpio_set_mode ( USART_TX_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , USART_TX_PIN ( BUSVOODOO_USART_ID ) ) ; // set pin back to floating input
gpio_set_mode ( USART_RX_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , USART_RX_PIN ( BUSVOODOO_USART_ID ) ) ; // set pin back to floating input
gpio_set_mode ( USART_RTS_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , USART_RTS_PIN ( BUSVOODOO_USART_ID ) ) ; // set pin back to floating input
gpio_set_mode ( USART_CTS_PORT ( BUSVOODOO_USART_ID ) , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , USART_CTS_PIN ( BUSVOODOO_USART_ID ) ) ; // set pin back to floating input
2018-01-24 16:36:19 +01:00
busvoodoo_embedded_pullup ( false ) ; // disable embedded pull-ups
}
2018-03-22 15:57:49 +01:00
/** write to UART
* @ param [ in ] value value to write
*/
static void busvoodoo_uart_write ( uint16_t value )
{
while ( ( 0 = = ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_TXE ) & & ! user_input_available ) ) ; // wait for transmit buffer to be empty (or user to interrupt)
if ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_TXE ) { // we can send a character
// remove unused bits
if ( USART_PARITY_NONE = = busvoodoo_uart_parity ) { // no parity bit in frame
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
value & = 0xff ;
} else { // 9-bit frame
value & = 0x1ff ;
}
} else { // MSb is parity bit
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
value & = 0x7f ;
} else { // 9-bit frame
value & = 0xff ;
}
}
// send data
2018-05-03 12:56:09 +02:00
busvoodoo_led_blue_pulse ( BUSVOODOO_LED_PULSE ) ; // pulse blue LED to show transmission
2018-03-22 15:57:49 +01:00
usart_send ( USART ( BUSVOODOO_USART_ID ) , value ) ; // transmit character
// display data send
printf ( " write: '%c'/0x " , value ) ;
if ( ( USART_PARITY_NONE = = busvoodoo_uart_parity ) & & 9 = = busvoodoo_uart_databits ) { // case where the final data is 9 bits long
printf ( " %03x \n " , value ) ;
} else {
printf ( " %02x \n " , value ) ;
}
}
}
/** read from UART
*/
static void busvoodoo_uart_read ( void )
{
printf ( " read: " ) ;
while ( ! ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_RXNE ) & & ! user_input_available ) ; // wait for incoming data to be available (or user input to exit)
if ( ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_RXNE ) ) { // verify if data has been received
busvoodoo_led_blue_pulse ( BUSVOODOO_LED_PULSE ) ; // enable blue LED to show reception
// get the errors
bool error_noise = ( 0 ! = ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_NE ) ) ; // read noise error flag
bool error_framing = ( 0 ! = ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_FE ) ) ; // read frame error flag
bool error_parity = ( 0 ! = ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_PE ) ) ; // read parity error flag
uint16_t c = usart_recv ( USART ( BUSVOODOO_USART_ID ) ) ; // read received character (also clears the error flags)
// remove unused bits
if ( USART_PARITY_NONE = = busvoodoo_uart_parity ) { // no parity bit in frame
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
c & = 0xff ;
} else { // 9-bit frame
c & = 0x1ff ;
}
} else { // MSb is parity bit
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
c & = 0x7f ;
} else { // 9-bit frame
c & = 0xff ;
}
}
// display data
printf ( " '%c'/0x " , c ) ;
if ( ( USART_PARITY_NONE = = busvoodoo_uart_parity ) & & 9 = = busvoodoo_uart_databits ) { // case where the final data is 9 bits long
printf ( " %03x " , c ) ;
} else {
printf ( " %02x " , c ) ;
}
// display errors
printf ( " ( " ) ;
if ( error_noise ) {
printf ( " noise " ) ;
} else if ( error_framing ) {
printf ( " framing " ) ;
} else if ( error_parity ) {
printf ( " parity " ) ;
} else {
printf ( " no " ) ;
}
printf ( " error) " ) ;
}
printf ( " \n " ) ;
}
/** perform UART action
* @ param [ in ] action action to perform
* @ param [ in ] repetition how many times to perform the action
* @ param [ in ] perform the action ( true ) or just check it ( false )
* @ return true if the action has been performed , false if it is malformed
*/
static bool busvoodoo_uart_action ( const char * action , uint32_t repetition , bool perform )
{
uint32_t length = strlen ( action ) ; // remember length since it will be used a number of times
if ( NULL = = action | | 0 = = length ) { // there is nothing to do
return true ;
}
if ( 1 = = length & & ' r ' = = action [ 0 ] ) { // read data
if ( ! perform ) {
return true ;
}
for ( uint32_t i = 0 ; i < repetition ; i + + ) {
busvoodoo_uart_read ( ) ; // read from UART
}
} else if ( 1 = = length & & ' u ' = = action [ 0 ] ) { // sleep us
if ( ! perform ) {
return true ;
}
printf ( " wait for %u us \n " , repetition ) ;
sleep_us ( repetition ) ; // sleep
} else if ( 1 = = length & & ' m ' = = action [ 0 ] ) { // sleep ms
if ( ! perform ) {
return true ;
}
printf ( " wait for %u ms \n " , repetition ) ;
sleep_ms ( repetition ) ; // sleep
} else if ( ' 0 ' = = action [ 0 ] ) { // send digit
if ( 1 = = length ) { // just send 0
if ( ! perform ) {
return true ;
}
for ( uint32_t i = 0 ; i < repetition ; i + + ) {
busvoodoo_uart_write ( 0 ) ; // write to UART
}
} else if ( ' x ' = = action [ 1 ] | | ' b ' = = action [ 1 ] ) { // send hex/binary
return busvoodoo_uart_action ( action + 1 , repetition , perform ) ; // just retry without leading 0
} else if ( action [ 1 ] > = ' 0 ' & & action [ 1 ] < = ' 9 ' ) { // send decimal
return busvoodoo_uart_action ( action + 1 , repetition , perform ) ; // just retry without leading 0
} else { // malformed action
return false ;
}
} else if ( ' x ' = = action [ 0 ] & & length > 1 ) { // send hexadecimal value
for ( uint32_t i = 1 ; i < length ; i + + ) { // check string
if ( ! ( ( action [ i ] > = ' 0 ' & & action [ i ] < = ' 9 ' ) | | ( action [ i ] > = ' a ' & & action [ i ] < = ' f ' ) | | ( action [ i ] > = ' A ' & & action [ i ] < = ' F ' ) ) ) { // check for hexadecimal character
return false ; // not an hexadecimal string
}
}
if ( ! perform ) {
return true ;
}
uint32_t value = strtol ( & action [ 1 ] , NULL , 16 ) ; // get hex value
for ( uint32_t i = 0 ; i < repetition ; i + + ) {
busvoodoo_uart_write ( value ) ; // write to SPI
}
} else if ( ' b ' = = action [ 0 ] & & length > 1 ) { // send binary value
for ( uint32_t i = 1 ; i < length ; i + + ) { // check string
if ( action [ i ] < ' 0 ' | | action [ i ] > ' 1 ' ) { // check for binary character
return false ; // not a binary string
}
}
if ( ! perform ) {
return true ;
}
uint32_t value = strtol ( & action [ 1 ] , NULL , 2 ) ; // get binary value
for ( uint32_t i = 0 ; i < repetition ; i + + ) {
busvoodoo_uart_write ( value ) ; // write to SPI
}
} else if ( action [ 0 ] > = ' 1 ' & & action [ 0 ] < = ' 9 ' ) { // send decimal value
for ( uint32_t i = 1 ; i < length ; i + + ) { // check string
if ( action [ i ] < ' 0 ' | | action [ i ] > ' 9 ' ) { // check for decimal character
return false ; // not a decimal string
}
}
if ( ! perform ) {
return true ;
}
uint32_t value = strtol ( & action [ 0 ] , NULL , 10 ) ; // get decimal value
for ( uint32_t i = 0 ; i < repetition ; i + + ) {
busvoodoo_uart_write ( value ) ; // write to SPI
}
} else if ( length > = 2 & & ( ' " ' = = action [ 0 ] | | ' \' ' = = action [ 0 ] ) & & ( action [ length - 1 ] = = action [ 0 ] ) ) { // send ASCII character
if ( ! perform ) {
return true ;
}
for ( uint32_t r = 0 ; r < repetition ; r + + ) {
for ( uint32_t i = 1 ; i < length - 1 ; i + + ) { // go through string
busvoodoo_uart_write ( action [ i ] ) ; // write to SPI
}
}
} else { // malformed action
return false ;
}
return true ; // all went well
}
2018-01-24 16:36:19 +01:00
// command handlers
2018-03-22 15:57:49 +01:00
/** command to perform actions
* @ param [ in ] argument actions to perform
*/
static void busvoodoo_uart_command_actions ( void * argument )
{
if ( NULL = = argument | | 0 = = strlen ( argument ) ) {
printf ( " available actions (separated by space or ,): \n " ) ;
printf ( " 0 \t write decimal value \n " ) ;
printf ( " 0x0 \t write hexadecimal value \n " ) ;
printf ( " 0b0 \t write binary value \n " ) ;
printf ( " \" a \" /'a' \t write ASCII characters \n " ) ;
printf ( " r \t read value \n " ) ;
printf ( " u/m \t wait 1 us/ms \n " ) ;
printf ( " :n \t repeat action n times \n " ) ;
return ;
}
// copy argument since it will be modified
char * copy = calloc ( strlen ( argument ) + 1 , sizeof ( char ) ) ;
if ( ! copy ) {
while ( true ) ;
}
strncpy ( copy , argument , strlen ( argument ) + 1 ) ;
// verify and perform actions
if ( ! busvoodoo_global_actions ( copy , false , & busvoodoo_uart_action ) ) { // verify actions
printf ( " malformed action(s) \n " ) ;
} else { // action are ok
printf ( " press any key to exit \n " ) ;
busvoodoo_global_actions ( argument , true , & busvoodoo_uart_action ) ; // perform action
if ( user_input_available ) { // user interrupted flow
user_input_get ( ) ; // discard user input
}
}
free ( copy ) ; // release memory
}
2018-03-22 13:53:05 +01:00
/** command to transmit a string
* @ param [ in ] argument string to transmit ( CR + LF when none provided )
2018-01-24 16:36:19 +01:00
*/
static void busvoodoo_uart_command_transmit ( void * argument )
{
if ( NULL = = argument | | 0 = = strlen ( argument ) ) { // nothing to transmit
2018-03-22 13:53:05 +01:00
argument = " \r \n " ; // transmit CR+LF
}
printf ( " press any key to exit \n " ) ;
for ( uint16_t i = 0 ; ( ( char * ) ( argument ) ) [ i ] & & ! user_input_available ; i + + ) {
while ( ( 0 = = ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_TXE ) & & ! user_input_available ) ) ; // wait for transmit buffer to be empty
if ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_TXE ) { // we can send a character
printf ( " %c " , ( ( char * ) ( argument ) ) [ i ] ) ; // echo character to transmit
2018-05-03 12:56:09 +02:00
busvoodoo_led_blue_pulse ( BUSVOODOO_LED_PULSE ) ; // pulse blue LED to show transmission
2018-03-22 13:53:05 +01:00
usart_send ( USART ( BUSVOODOO_USART_ID ) , ( ( char * ) ( argument ) ) [ i ] ) ; // transmit character
}
}
if ( user_input_available ) { // user interrupted flow
user_input_get ( ) ; // discard user input
2018-01-24 16:36:19 +01:00
}
2018-03-22 13:53:05 +01:00
if ( strcmp ( argument , " \r \n " ) ) {
printf ( " \n " ) ;
2018-01-24 16:36:19 +01:00
}
}
/** command to receive data
2018-03-22 15:05:09 +01:00
* @ param [ in ] argument in which format to display
2018-01-24 16:36:19 +01:00
*/
static void busvoodoo_uart_command_receive ( void * argument )
{
2018-03-22 15:05:09 +01:00
bool display_hex = false ; // display in hex
bool display_bin = false ; // display in bin
if ( NULL ! = argument & & strlen ( argument ) > 0 ) {
if ( 0 = = strcmp ( argument , " h " ) | | 0 = = strcmp ( argument , " hex " ) ) { // user wants hexadecimal display
display_hex = true ; // remember to display in hexadecimal
} else if ( 0 = = strcmp ( argument , " b " ) | | 0 = = strcmp ( argument , " bin " ) ) { // user wants binary display
display_bin = true ; // remember to display in binary
} else {
printf ( " malformed argument \n " ) ;
return ;
}
}
2018-01-25 11:31:27 +01:00
printf ( " press any key to exit \n " ) ;
while ( ! user_input_available ) { // check for user input to exit
if ( ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_RXNE ) ) { // verify if data has been received
2018-03-22 15:05:09 +01:00
uint16_t c = usart_recv ( USART ( BUSVOODOO_USART_ID ) ) ; // receive character
2018-03-22 13:53:05 +01:00
busvoodoo_led_blue_pulse ( BUSVOODOO_LED_PULSE ) ; // enable blue LED to show reception
2018-03-22 15:05:09 +01:00
// remove unused bits (ignore parity bit)
if ( USART_PARITY_NONE = = busvoodoo_uart_parity ) { // no parity bit in frame
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
c & = 0xff ;
} else { // 9-bit frame
c & = 0x1ff ;
}
} else { // MSb is parity bit
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
c & = 0x7f ;
} else { // 9-bit frame
c & = 0xff ;
}
}
if ( display_hex ) { // display data in hex
if ( ( USART_PARITY_NONE = = busvoodoo_uart_parity ) & & 9 = = busvoodoo_uart_databits ) { // case where the final data is 9 bits long
printf ( " %03x " , c ) ;
} else {
printf ( " %02x " , c ) ;
}
} else if ( display_bin ) { // display data in binary
if ( USART_PARITY_NONE = = busvoodoo_uart_parity ) {
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
printf ( " %08b " , c ) ;
} else { // 9-bit frame
printf ( " %09b " , c ) ;
}
} else { // one bit is a parity bit
if ( 8 = = busvoodoo_uart_databits ) { // 8-bit frame
printf ( " %07b " , c ) ;
} else { // 9-bit frame
printf ( " %08b " , c ) ;
}
}
} else { // display in ASCII
printf ( " %c " , c ) ; // print received character
}
2018-01-25 11:31:27 +01:00
}
2018-01-24 16:36:19 +01:00
}
2018-01-25 11:31:27 +01:00
user_input_get ( ) ; // discard user input
printf ( " \n " ) ; // get to next line
}
/** command to transmit and receive data
* @ param [ in ] argument no argument required
*/
static void busvoodoo_uart_command_transceive ( void * argument )
{
( void ) argument ; // we won't use the argument
printf ( " press 5 times escape to exit \n " ) ;
char last_c = 0 ; // last user character received
uint8_t esc_count = 0 ; // number of times escape has press received
2018-03-22 14:30:50 +01:00
while ( true ) { // check for escape sequence
2018-01-25 11:31:27 +01:00
if ( user_input_available ) { // check if user wants to transmit something
char c = user_input_get ( ) ; // get user input
if ( 0x1b = = c ) { // user pressed escape
if ( 0x1b ! = last_c ) { // this is the first escape press
esc_count = 0 ;
}
esc_count + + ; // increment escape count
}
2018-02-06 11:56:18 +01:00
last_c = c ; // remember key press
2018-03-22 14:30:50 +01:00
if ( esc_count < 5 ) { // check for escape sequence
while ( ( 0 = = ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_TXE ) & & ! user_input_available ) ) ; // wait for transmit buffer to be empty
if ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_TXE ) { // we can send a character
usart_send_blocking ( USART ( BUSVOODOO_USART_ID ) , c ) ; // send user character
2018-05-03 12:56:09 +02:00
busvoodoo_led_blue_pulse ( BUSVOODOO_LED_PULSE ) ; // enable blue LED to show transmission
2018-03-22 14:30:50 +01:00
}
} else { // user wants to exit
break ; // exit infinite loop
}
2018-01-25 11:31:27 +01:00
}
if ( ( USART_SR ( USART ( BUSVOODOO_USART_ID ) ) & USART_SR_RXNE ) ) { // verify if data has been received
char c = usart_recv ( USART ( BUSVOODOO_USART_ID ) ) ; // receive character
2018-03-22 13:53:05 +01:00
busvoodoo_led_blue_pulse ( BUSVOODOO_LED_PULSE ) ; // enable blue LED to show reception
2018-01-25 11:31:27 +01:00
printf ( " %c " , c ) ; // print received character
}
}
printf ( " \n " ) ; // get to next line
2018-01-24 16:36:19 +01:00
}
2018-03-22 16:05:06 +01:00
/** command to verify incoming transmission for error
* @ param [ in ] argument argument not required
*/
static void busvoodoo_uart_command_error ( void * argument )
{
( void ) argument ; // argument not used
printf ( " press any key to exit \n " ) ;
while ( ! user_input_available ) { // wait until user interrupt
busvoodoo_uart_read ( ) ; // read incoming data (this also checks for errors
}
user_input_get ( ) ; // discard user input
}
2018-03-22 13:53:05 +01:00
/** UART menu commands */
2018-01-24 16:36:19 +01:00
static const struct menu_command_t busvoodoo_uart_commands [ ] = {
2018-03-22 15:57:49 +01:00
{
2018-04-04 17:14:36 +02:00
. shortcut = ' a ' ,
. name = " action " ,
. command_description = " perform protocol actions " ,
. argument = MENU_ARGUMENT_STRING ,
. argument_description = " [actions] " ,
. command_handler = & busvoodoo_uart_command_actions ,
2018-03-22 15:57:49 +01:00
} ,
2018-01-24 16:36:19 +01:00
{
2018-04-04 17:14:36 +02:00
. shortcut = ' r ' ,
. name = " receive " ,
. command_description = " show incoming data [in hexadecimal or binary] " ,
. argument = MENU_ARGUMENT_STRING ,
. argument_description = " [hex|bin] " ,
. command_handler = & busvoodoo_uart_command_receive ,
2018-01-24 16:36:19 +01:00
} ,
{
2018-04-04 17:14:36 +02:00
. shortcut = ' t ' ,
. name = " transmit " ,
. command_description = " transmit ASCII text (empty for CR+LF) " ,
. argument = MENU_ARGUMENT_STRING ,
. argument_description = " [text] " ,
. command_handler = & busvoodoo_uart_command_transmit ,
2018-01-24 16:36:19 +01:00
} ,
2018-01-25 11:31:27 +01:00
{
2018-04-04 17:14:36 +02:00
. shortcut = ' x ' ,
. name = " transceive " ,
. command_description = " transmit and receive data " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & busvoodoo_uart_command_transceive ,
2018-01-25 11:31:27 +01:00
} ,
2018-03-22 16:05:06 +01:00
{
2018-04-04 17:14:36 +02:00
. shortcut = ' e ' ,
. name = " error " ,
. command_description = " verify incoming transmission for errors " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & busvoodoo_uart_command_error ,
2018-03-22 16:05:06 +01:00
} ,
2018-01-24 16:36:19 +01:00
} ;
2018-04-04 17:14:36 +02:00
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_commands ,
. commands_nb = LENGTH ( busvoodoo_uart_commands ) ,
. exit = & busvoodoo_uart_exit ,
2018-01-24 16:36:19 +01:00
} ;