2016-01-17 14:54:54 +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/>.
*
*/
2019-11-19 18:46:13 +01:00
/** CuVoodoo USB cable tester firmware
2020-02-17 18:08:17 +01:00
* @ file
2016-08-14 21:02:38 +02:00
* @ author King Kévin < kingkevin @ cuvoodoo . info >
2020-02-17 18:08:17 +01:00
* @ date 2016 - 2020
2016-08-14 21:02:38 +02:00
*/
2016-01-17 14:54:54 +01:00
/* standard libraries */
# include <stdint.h> // standard integer types
# include <stdlib.h> // standard utilities
2016-08-14 21:02:38 +02:00
# include <string.h> // string utilities
2019-06-18 17:43:43 +02:00
# include <time.h> // date/time utilities
# include <ctype.h> // utilities to check chars
2016-01-17 14:54:54 +01:00
/* STM32 (including CM3) libraries */
2016-01-18 16:23:35 +01:00
# include <libopencmsis/core_cm3.h> // Cortex M3 utilities
2016-10-23 17:42:27 +02:00
# include <libopencm3/cm3/scb.h> // vector table definition
2016-01-29 11:25:30 +01:00
# include <libopencm3/cm3/nvic.h> // interrupt utilities
2016-10-23 17:42:27 +02:00
# include <libopencm3/stm32/gpio.h> // general purpose input output library
# include <libopencm3/stm32/rcc.h> // real-time control clock library
2016-01-29 11:25:30 +01:00
# include <libopencm3/stm32/exti.h> // external interrupt utilities
2016-08-14 21:02:38 +02:00
# include <libopencm3/stm32/rtc.h> // real time clock utilities
2016-10-23 17:42:27 +02:00
# include <libopencm3/stm32/iwdg.h> // independent watchdog utilities
# include <libopencm3/stm32/dbgmcu.h> // debug utilities
2018-04-06 17:37:17 +02:00
# include <libopencm3/stm32/desig.h> // design utilities
2016-10-23 17:42:27 +02:00
# include <libopencm3/stm32/flash.h> // flash utilities
2019-12-21 19:28:39 +01:00
# include <libopencm3/stm32/f1/bkp.h> // access to backup registers
2016-01-17 14:54:54 +01:00
/* own libraries */
2016-01-28 21:21:50 +01:00
# include "global.h" // board definitions
2017-04-03 13:32:45 +02:00
# include "print.h" // printing utilities
2016-01-18 16:23:35 +01:00
# include "usb_cdcacm.h" // USB CDC ACM utilities
2018-04-06 17:37:17 +02:00
# include "terminal.h" // handle the terminal interface
# include "menu.h" // menu utilities
2019-11-19 18:46:13 +01:00
# include "usb_cables.h" // USB cables definition
2019-12-12 19:00:13 +01:00
# include "lcd_hd44780.h" // LCD utilities
2016-01-17 14:54:54 +01:00
2020-02-02 21:19:03 +01:00
/** watchdog period in ms */
# define WATCHDOG_PERIOD 10000
2019-06-18 17:43:43 +02:00
/** set to 0 if the RTC is reset when the board is powered on, only indicates the uptime
* set to 1 if VBAT can keep the RTC running when the board is unpowered , indicating the date and time
*/
2020-02-02 21:19:03 +01:00
# define RTC_DATE_TIME 0
/** number of RTC ticks per second
* @ note use integer divider of oscillator to keep second precision
*/
# define RTC_TICKS_SECOND 4
2019-06-18 17:43:43 +02:00
/** RTC time when device is started */
static time_t time_start = 0 ;
2016-10-23 17:42:27 +02:00
2016-08-14 21:02:38 +02:00
/** @defgroup main_flags flag set in interrupts to be processed in main task
* @ {
*/
volatile bool rtc_internal_tick_flag = false ; /**< flag set when internal RTC ticked */
/** @} */
2019-12-21 15:40:13 +01:00
/** to disable the console print */
bool disable_print = false ;
2019-12-21 14:23:35 +01:00
/** activity timeout before switching off (in seconds) */
2019-12-22 11:24:04 +01:00
# define SHUTDOWN_TIMEOUT 10
2019-12-21 14:23:35 +01:00
2019-12-22 11:24:04 +01:00
// ====================
// = common functions =
// ====================
2019-12-21 15:40:13 +01:00
2017-04-03 13:32:45 +02:00
size_t putc ( char c )
2016-01-17 14:54:54 +01:00
{
2019-12-21 15:40:13 +01:00
if ( disable_print ) {
return 0 ;
}
2017-04-03 13:32:45 +02:00
size_t length = 0 ; // number of characters printed
2018-04-06 17:37:17 +02:00
static char last_c = 0 ; // to remember on which character we last sent
if ( ' \n ' = = c ) { // send carriage return (CR) + line feed (LF) newline for each LF
if ( ' \r ' ! = last_c ) { // CR has not already been sent
2017-04-19 16:24:07 +02:00
usb_cdcacm_putchar ( ' \r ' ) ; // send CR over USB
2018-04-06 17:37:17 +02:00
length + + ; // remember we printed 1 character
2016-01-17 14:54:54 +01:00
}
}
2018-04-06 17:37:17 +02:00
usb_cdcacm_putchar ( c ) ; // send byte over USB
length + + ; // remember we printed 1 character
last_c = c ; // remember last character
2019-03-26 19:27:40 +01:00
return length ; // return number of characters printed
2016-01-17 14:54:54 +01:00
}
2019-12-22 11:24:04 +01:00
/** switch on power to display */
inline static void display_on ( void )
{
gpio_clear ( GPIO_PORT ( DISPLAY_POWER_PIN ) , GPIO_PIN ( DISPLAY_POWER_PIN ) ) ;
}
/** switch off power to display */
inline static void display_off ( void )
{
gpio_set ( GPIO_PORT ( DISPLAY_POWER_PIN ) , GPIO_PIN ( DISPLAY_POWER_PIN ) ) ;
}
/** go into standby mode */
static void standby ( void )
{
while ( true ) { // try until success
SCB_SCR | = SCB_SCR_SLEEPDEEP ; // Cortex-M3 standby setting
pwr_set_standby_mode ( ) ; // power setting
pwr_clear_wakeup_flag ( ) ; // clear wake-up flag to be able to sleep
__WFI ( ) ; // go to standby (e.g. shut down)
}
}
2019-11-19 18:46:13 +01:00
/** put all pins of all connectors to float */
static void usb_pins_float ( void )
{
usb_cables_connectors_float ( usb_connectors , LENGTH ( usb_connectors ) ) ; // put every pin of every connector in floating mode
}
2019-12-22 11:24:04 +01:00
// ===================
// = cable utilities =
// ===================
/** the current cable state */
struct cable_t {
uint16_t connections_nb ; // number of connections the cable has
uint8_t ( * connections ) [ 2 ] ; // the cable connections (pin pairs)
uint8_t connectors_nb ; // number of connectors the cable has
bool connectors [ LENGTH ( usb_connectors ) ] ; // which connectors the cable connects
2019-12-26 18:03:47 +01:00
bool load ; // if there is a load on the cable
2019-12-22 11:24:04 +01:00
uint8_t cables_nb ; // number of cable definitions the connectors set match to
bool cables [ LENGTH ( usb_cables ) ] ; // cable definitions the connectors set match to
uint16_t unconnected_nb [ LENGTH ( usb_cables ) ] ; // number of unconnected pairs which should be connected according to cable specification
uint16_t unspecified_nb [ LENGTH ( usb_cables ) ] ; // number of connected pairs which are not specified by cable
uint8_t cable_best ; // best matching cable index (e.g. with lowest score)
uint8_t ( * unconnected ) [ 2 ] ; // unconnected pairs which should be connected according to best cable specification
uint8_t ( * unspecified ) [ 2 ] ; // connected pairs which are not specified by best cable
} ;
2019-12-21 15:40:13 +01:00
/** clear the cable information
* @ param [ out ] cable structure to be cleared
*/
static void cable_clear ( struct cable_t * cable )
{
// check input arguments
if ( NULL = = cable ) {
return ;
}
// initialize structure
cable - > connections_nb = 0 ;
if ( cable - > connections ) {
free ( cable - > connections ) ;
cable - > connections = NULL ;
}
cable - > connectors_nb = 0 ;
for ( uint8_t i = 0 ; i < LENGTH ( cable - > connectors ) ; i + + ) {
cable - > connectors [ i ] = false ;
}
2019-12-27 12:48:40 +01:00
cable - > load = false ;
2019-12-21 15:40:13 +01:00
cable - > cables_nb = 0 ;
for ( uint8_t i = 0 ; i < LENGTH ( cable - > cables ) ; i + + ) {
cable - > cables [ i ] = false ;
}
for ( uint8_t i = 0 ; i < LENGTH ( cable - > unconnected_nb ) ; i + + ) {
cable - > unconnected_nb [ i ] = 0 ;
}
for ( uint8_t i = 0 ; i < LENGTH ( cable - > unspecified_nb ) ; i + + ) {
cable - > unspecified_nb [ i ] = 0 ;
}
cable - > cable_best = 0xff ;
if ( cable - > unconnected ) {
free ( cable - > unconnected ) ;
cable - > unconnected = NULL ;
}
if ( cable - > unspecified ) {
free ( cable - > unspecified ) ;
cable - > unspecified = NULL ;
}
}
/** detect cable presence by testing inter-connector ground connections
* @ param [ out ] cable what cable it found
* @ note only sets the ground connections and connections_nb
*/
static void cable_detect ( struct cable_t * cable )
{
// check input arguments
if ( NULL = = cable ) {
return ;
}
usb_pins_float ( ) ; // start with all pins in safe floating state
if ( cable - > connections ) {
free ( cable - > connections ) ;
}
cable - > connections = ( uint8_t ( * ) [ 2 ] ) usb_cables_test_connections ( usb_connectors , LENGTH ( usb_connectors ) , false , true , & cable - > connections_nb ) ; // figure out which connectors are connector by testing ground pin connections
}
/** find which connectors the connections belong to
2019-12-21 19:29:11 +01:00
* @ param [ in , out ] cable cable for which to find which connectors it connects
2019-12-21 15:40:13 +01:00
* @ note only updates connectors_nb and connectors based on connections
*/
static void cable_connectors ( struct cable_t * cable )
{
// check input arguments
if ( NULL = = cable ) {
return ;
}
// initialize relevant structure variables
cable - > connectors_nb = 0 ;
for ( uint8_t i = 0 ; i < LENGTH ( cable - > connectors ) ; i + + ) {
cable - > connectors [ i ] = false ;
}
// ensure connections are available
if ( NULL = = cable - > connections | | 0 = = cable - > connections_nb ) {
return ;
}
// find which connectors the connections belong to
for ( uint16_t connection = 0 ; connection < cable - > connections_nb ; connection + + ) {
const struct usb_connector_t * connector_from = usb_cables_get_connector ( cable - > connections [ connection ] [ 0 ] ) ;
const struct usb_connector_t * connector_to = usb_cables_get_connector ( cable - > connections [ connection ] [ 1 ] ) ;
if ( NULL = = connector_from | | NULL = = connector_to ) {
continue ;
}
for ( uint8_t i = 0 ; i < LENGTH ( cable - > connectors ) & & i < LENGTH ( usb_connectors ) ; i + + ) {
if ( usb_connectors [ i ] = = connector_from | | usb_connectors [ i ] = = connector_to ) {
cable - > connectors [ i ] = true ;
}
}
}
// calculate the numbers of connectors connected
for ( uint8_t i = 0 ; i < LENGTH ( cable - > connectors ) & & i < LENGTH ( usb_connectors ) ; i + + ) {
if ( cable - > connectors [ i ] ) {
cable - > connectors_nb + + ;
}
}
}
2019-12-26 18:03:47 +01:00
/** find if there is a load on any of the connectors of the cable
* @ param [ in , out ] cable cable for which to if there is a load
* @ note only updates load based on connectors
*/
static void cable_load ( struct cable_t * cable )
{
// check input arguments
if ( NULL = = cable ) {
return ;
}
// initialize relevant structure variables
cable - > load = false ;
// ensure connections are available
if ( 0 = = cable - > connectors_nb ) {
return ;
}
// test of there is a load on any of the connectors of the cable
for ( uint8_t i = 0 ; i < LENGTH ( cable - > connectors ) & & i < LENGTH ( usb_connectors ) & & ! cable - > load ; i + + ) {
if ( ! cable - > connectors [ i ] ) {
continue ;
}
const struct usb_connector_t * connector = usb_connectors [ i ] ;
bool load = usb_cables_test_load ( connector ) ;
if ( load ) {
cable - > load = true ;
}
}
}
2019-12-21 15:40:13 +01:00
/** find which cables match the connector set
2019-12-21 19:29:11 +01:00
* @ param [ in , out ] cable cable for which to find matching cable definitions
2019-12-21 15:40:13 +01:00
* @ note only updates cables_nb and cables based on connectors
*/
static void cable_cables ( struct cable_t * cable )
{
// check input arguments
if ( NULL = = cable ) {
return ;
}
// initialize relevant structure variables
cable - > cables_nb = 0 ;
for ( uint8_t i = 0 ; i < LENGTH ( cable - > cables ) ; i + + ) {
cable - > cables [ i ] = false ;
}
// ensure connections are available
if ( 0 = = cable - > connectors_nb ) {
return ;
}
// find cable with matching connector set
for ( uint8_t cable_i = 0 ; cable_i < LENGTH ( cable - > cables ) & & cable_i < LENGTH ( usb_cables ) ; cable_i + + ) {
cable - > cables [ cable_i ] = false ; // start with not matching, and test if it matches
// ensure we have the same number of connections as the cable
if ( usb_cables [ cable_i ] . connectors_nb ! = cable - > connectors_nb ) {
continue ;
}
// ensure all the connectors we have are also in the cable
bool match = true ;
for ( uint8_t i = 0 ; i < LENGTH ( usb_connectors ) & & match ; i + + ) {
if ( ! cable - > connectors [ i ] ) {
continue ;
}
bool found = false ;
for ( uint8_t j = 0 ; j < usb_cables [ cable_i ] . connectors_nb & & ! found ; j + + ) {
if ( usb_connectors [ i ] = = usb_cables [ cable_i ] . connectors [ j ] ) {
found = true ;
}
}
if ( ! found ) {
match = false ;
}
}
// ensure we also have all the connectors which are in the cable
for ( uint8_t i = 0 ; i < usb_cables [ cable_i ] . connectors_nb & & match ; i + + ) {
bool found = false ;
for ( uint8_t j = 0 ; j < LENGTH ( usb_connectors ) & & ! found ; j + + ) {
if ( ! cable - > connectors [ j ] ) {
continue ;
}
if ( usb_connectors [ j ] = = usb_cables [ cable_i ] . connectors [ i ] ) {
found = true ;
}
}
if ( ! found ) {
match = false ;
}
}
cable - > cables [ cable_i ] = match ;
if ( match ) {
cable - > cables_nb + + ;
}
}
}
/** calculate number of issues for matching cables
2019-12-21 19:29:11 +01:00
* @ param [ in , out ] cable cable for which to find the number of issues
2019-12-27 12:48:40 +01:00
* @ note resets connections and connections_nb , sets unconnected_nb , unspecified_nb , and cable_best based on cables
2019-12-21 15:40:13 +01:00
*/
static void cable_issues_nb ( struct cable_t * cable )
{
// check input arguments
if ( NULL = = cable ) {
return ;
}
// initialize relevant structure variables
for ( uint8_t i = 0 ; i < LENGTH ( cable - > unconnected_nb ) ; i + + ) {
cable - > unconnected_nb [ i ] = 0 ;
}
for ( uint8_t i = 0 ; i < LENGTH ( cable - > unspecified_nb ) ; i + + ) {
cable - > unspecified_nb [ i ] = 0 ;
}
cable - > cable_best = 0xff ;
// ensure connections are available
if ( 0 = = cable - > cables_nb ) {
return ;
}
// get the connectors
const struct usb_connector_t * connectors [ LENGTH ( usb_connectors ) ] ;
uint8_t connectors_nb = 0 ;
for ( uint8_t i = 0 ; i < LENGTH ( usb_connectors ) & & i < LENGTH ( connectors ) & & i < LENGTH ( cable - > connectors ) & & connectors_nb < cable - > connectors_nb ; i + + ) {
if ( cable - > connectors [ i ] ) {
connectors [ connectors_nb + + ] = usb_connectors [ i ] ;
}
}
// get all connections once
if ( cable - > connections ) {
free ( cable - > connections ) ;
cable - > connections = NULL ;
}
cable - > connections = ( uint8_t ( * ) [ 2 ] ) usb_cables_test_connections ( connectors , connectors_nb , true , false , & cable - > connections_nb ) ;
if ( NULL = = cable - > connections | | 0 = = cable - > connections_nb ) {
return ;
}
// calculate score for cables
uint16_t best_score = UINT16_MAX ; // best cable score
for ( uint8_t cable_i = 0 ; cable_i < LENGTH ( usb_cables ) & & cable_i < LENGTH ( cable - > cables ) & & cable_i < LENGTH ( cable - > unconnected_nb ) & & cable_i < LENGTH ( cable - > unspecified_nb ) ; cable_i + + ) {
if ( ! cable - > cables [ cable_i ] ) { // skip if the cable connectors do not match
continue ;
}
const struct usb_cable_t * usb_cable = & usb_cables [ cable_i ] ;
cable - > unconnected_nb [ cable_i ] = usb_cable - > pin_pairs_nb ;
cable - > unspecified_nb [ cable_i ] = 0 ;
for ( uint16_t i = 0 ; i < cable - > connections_nb ; i + + ) {
bool match = false ;
for ( uint8_t j = 0 ; j < usb_cable - > pin_pairs_nb ; j + + ) {
if ( cable - > connections [ i ] [ 0 ] = = usb_cable - > pin_pairs [ j ] [ 0 ] & & cable - > connections [ i ] [ 1 ] = = usb_cable - > pin_pairs [ j ] [ 1 ] ) {
match = true ;
} else if ( cable - > connections [ i ] [ 0 ] = = usb_cable - > pin_pairs [ j ] [ 1 ] & & cable - > connections [ i ] [ 1 ] = = usb_cable - > pin_pairs [ j ] [ 0 ] ) {
match = true ;
}
}
if ( match ) {
cable - > unconnected_nb [ cable_i ] - - ;
} else {
cable - > unspecified_nb [ cable_i ] + + ;
}
}
uint16_t score = cable - > unconnected_nb [ cable_i ] + cable - > unspecified_nb [ cable_i ] ;
if ( score < best_score ) {
best_score = score ;
cable - > cable_best = cable_i ;
}
}
}
/** list issues for best matching cable
2019-12-21 19:29:11 +01:00
* @ param [ in , out ] cable cable for which to calculate the score
2019-12-21 15:40:13 +01:00
* @ note set unconnected and unspecified based on cable_best
*/
static void cable_issues ( struct cable_t * cable )
{
// check input arguments
if ( NULL = = cable ) {
return ;
}
if ( cable - > cable_best > = LENGTH ( usb_cables ) | | cable - > cable_best > = LENGTH ( cable - > cables ) | | ! cable - > cables [ cable - > cable_best ] | | cable - > cable_best > = LENGTH ( cable - > unconnected_nb ) | | cable - > cable_best > = LENGTH ( cable - > unspecified_nb ) ) {
return ;
}
// initialize relevant variables
if ( cable - > unconnected ) {
free ( cable - > unconnected ) ;
cable - > unconnected = NULL ;
}
cable - > unconnected_nb [ cable - > cable_best ] = 0 ;
if ( cable - > unspecified ) {
free ( cable - > unspecified ) ;
cable - > unspecified = NULL ;
}
cable - > unspecified_nb [ cable - > cable_best ] = 0 ;
// find if cable pairs are actual connection
const struct usb_cable_t * usb_cable = & usb_cables [ cable - > cable_best ] ;
for ( uint16_t i = 0 ; i < usb_cable - > pin_pairs_nb ; i + + ) {
bool match = false ;
for ( uint8_t j = 0 ; j < cable - > connections_nb ; j + + ) {
if ( cable - > connections [ j ] [ 0 ] = = usb_cable - > pin_pairs [ i ] [ 0 ] & & cable - > connections [ j ] [ 1 ] = = usb_cable - > pin_pairs [ i ] [ 1 ] ) {
match = true ;
} else if ( cable - > connections [ j ] [ 0 ] = = usb_cable - > pin_pairs [ i ] [ 1 ] & & cable - > connections [ j ] [ 1 ] = = usb_cable - > pin_pairs [ i ] [ 0 ] ) {
match = true ;
}
}
if ( ! match ) {
cable - > unconnected_nb [ cable - > cable_best ] + + ;
uint8_t ( * new_connections ) [ 2 ] = realloc ( cable - > unconnected , cable - > unconnected_nb [ cable - > cable_best ] * sizeof ( uint8_t [ 2 ] ) ) ; // no integer overflow is possible because of the max number of connections
if ( NULL = = new_connections ) { // allocation failed
if ( cable - > unconnected ) {
free ( cable - > unconnected ) ;
}
cable - > unconnected = NULL ;
cable - > unconnected_nb [ cable - > cable_best ] = 0 ;
return ; // fail-safe return (without indicating error)
}
cable - > unconnected = new_connections ;
cable - > unconnected [ cable - > unconnected_nb [ cable - > cable_best ] - 1 ] [ 0 ] = usb_cable - > pin_pairs [ i ] [ 0 ] ;
cable - > unconnected [ cable - > unconnected_nb [ cable - > cable_best ] - 1 ] [ 1 ] = usb_cable - > pin_pairs [ i ] [ 1 ] ;
}
}
// find if connection is defined in cable
for ( uint16_t i = 0 ; i < cable - > connections_nb ; i + + ) {
bool match = false ;
for ( uint8_t j = 0 ; j < usb_cable - > pin_pairs_nb ; j + + ) {
if ( cable - > connections [ i ] [ 0 ] = = usb_cable - > pin_pairs [ j ] [ 0 ] & & cable - > connections [ i ] [ 1 ] = = usb_cable - > pin_pairs [ j ] [ 1 ] ) {
match = true ;
} else if ( cable - > connections [ i ] [ 0 ] = = usb_cable - > pin_pairs [ j ] [ 1 ] & & cable - > connections [ i ] [ 1 ] = = usb_cable - > pin_pairs [ j ] [ 0 ] ) {
match = true ;
}
}
if ( ! match ) {
cable - > unspecified_nb [ cable - > cable_best ] + + ;
uint8_t ( * new_connections ) [ 2 ] = realloc ( cable - > unspecified , cable - > unspecified_nb [ cable - > cable_best ] * sizeof ( uint8_t [ 2 ] ) ) ; // no integer overflow is possible because of the max number of connections
if ( NULL = = new_connections ) { // allocation failed
if ( cable - > unspecified ) {
free ( cable - > unspecified ) ;
}
cable - > unspecified = NULL ;
cable - > unspecified_nb [ cable - > cable_best ] = 0 ;
return ; // fail-safe return (without indicating error)
}
cable - > unspecified = new_connections ;
cable - > unspecified [ cable - > unspecified_nb [ cable - > cable_best ] - 1 ] [ 0 ] = cable - > connections [ i ] [ 0 ] ;
cable - > unspecified [ cable - > unspecified_nb [ cable - > cable_best ] - 1 ] [ 1 ] = cable - > connections [ i ] [ 1 ] ;
}
}
}
2019-12-22 11:24:04 +01:00
// ================================
// = generic commands definitions =
// ================================
2019-12-21 15:40:13 +01:00
2018-04-06 17:37:17 +02:00
/** display available commands
* @ param [ in ] argument no argument required
*/
static void command_help ( void * argument ) ;
/** show software and hardware version
* @ param [ in ] argument no argument required
*/
static void command_version ( void * argument ) ;
/** show uptime
* @ param [ in ] argument no argument required
*/
static void command_uptime ( void * argument ) ;
2019-06-18 17:43:43 +02:00
# if RTC_DATE_TIME
/** show date and time
* @ param [ in ] argument date and time to set
*/
static void command_datetime ( void * argument ) ;
# endif
2018-04-06 17:37:17 +02:00
/** reset board
* @ param [ in ] argument no argument required
*/
static void command_reset ( void * argument ) ;
/** switch to DFU bootloader
* @ param [ in ] argument no argument required
*/
static void command_bootloader ( void * argument ) ;
2019-12-22 11:24:04 +01:00
// ===================
// = custom commands =
// ===================
2019-11-20 00:31:45 +01:00
/** test USB cables
* @ param [ in ] argument no argument required
*/
static void command_cables ( void * argument )
{
2019-12-12 19:00:13 +01:00
// get cable number
uint8_t cable_i = 0xff ;
if ( argument ) {
cable_i = * ( uint32_t * ) argument ;
if ( cable_i > = LENGTH ( usb_cables ) ) {
printf ( " cable number %u out of range 0-%u \n " , cable_i , LENGTH ( usb_cables ) - 1 ) ;
return ;
}
}
2019-11-20 00:31:45 +01:00
( void ) argument ; // we won't use the argument
usb_pins_float ( ) ; // start with all pins in safe floating state
2019-11-19 18:47:00 +01:00
// step 2: check for known cable configuration
printf ( " = cable check = \n " ) ;
2019-11-20 00:31:45 +01:00
for ( uint8_t cable = 0 ; cable < LENGTH ( usb_cables ) ; cable + + ) { // test every cable
2019-12-12 19:00:13 +01:00
if ( 0xff = = cable_i | | cable = = cable_i ) {
uint8_t pair_defined , pair_undefined ;
2019-12-22 11:45:31 +01:00
bool result = usb_cables_test_cable ( & usb_cables [ cable ] , & pair_defined , & pair_undefined , false ) ;
2019-12-12 19:00:13 +01:00
printf ( " %02u %s: %s (defined=%u/%u, undefined=%u) \n " , cable , result ? " OK " : " KO " , usb_cables [ cable ] . name , pair_defined , usb_cables [ cable ] . pin_pairs_nb , pair_undefined ) ;
}
2019-11-19 18:47:00 +01:00
}
2019-11-20 00:31:45 +01:00
usb_pins_float ( ) ; // put all pins back in safe floating state
}
/** find out which USB cable is connected
2019-12-21 15:40:13 +01:00
* @ param [ in ] argument NULL to print on console , " lcd " to print on LCD
2019-11-20 00:31:45 +01:00
*/
static void command_find ( void * argument )
{
2019-12-21 15:40:13 +01:00
char * arg = ( char * ) argument ; // we won't use the argument
bool print_lcd = false ;
2019-11-20 00:31:45 +01:00
2019-12-21 15:40:13 +01:00
if ( arg ) {
if ( 0 = = strcmp ( arg , " lcd " ) ) {
print_lcd = true ;
disable_print = true ;
2019-12-13 17:23:19 +01:00
} else {
2019-12-21 15:40:13 +01:00
printf ( " unknown argument %s \n " , arg ) ;
return ;
2019-12-13 17:23:19 +01:00
}
}
2019-12-21 15:40:13 +01:00
printf ( " = finding cable = \n " ) ;
struct cable_t cable ; // to store the cable finding results
memset ( & cable , 0 , sizeof ( struct cable_t ) ) ; // initialize cable structure
cable_clear ( & cable ) ; // initialize rest of cable structure
// find if cable is connected
cable_detect ( & cable ) ;
if ( NULL = = cable . connections ) {
if ( cable . connections_nb ) {
printf ( " no memory available \n " ) ;
if ( print_lcd ) {
lcd_hd44780_clear_display ( ) ;
char lcd_str [ ] = " testing error " ;
lcd_hd44780_write_line ( false , lcd_str , strlen ( lcd_str ) ) ;
2019-12-13 17:23:19 +01:00
}
2019-12-21 15:40:13 +01:00
} else {
if ( ! print_lcd ) {
printf ( " no ground connections between connectors found \n " ) ;
2019-12-13 17:23:19 +01:00
}
}
2019-12-21 15:40:13 +01:00
goto end ;
2019-12-13 17:23:19 +01:00
}
2019-12-21 15:40:13 +01:00
// find connected connectors
cable_connectors ( & cable ) ;
printf ( " %u connectors connected: \n " , cable . connectors_nb ) ;
for ( uint8_t i = 0 ; i < LENGTH ( cable . connectors ) & & i < LENGTH ( usb_connectors ) ; i + + ) {
if ( cable . connectors [ i ] ) {
2019-12-13 09:45:00 +01:00
printf ( " - %s " , usb_connectors [ i ] - > name ) ;
if ( usb_connectors [ i ] - > variant ) {
printf ( " (%s) " , usb_connectors [ i ] - > variant ) ;
}
putc ( ' \n ' ) ;
2019-11-20 00:31:45 +01:00
}
}
2019-12-09 20:26:50 +01:00
// find cable with matching connector set
2019-12-21 15:40:13 +01:00
cable_cables ( & cable ) ;
if ( 0 = = cable . cables_nb ) {
2019-12-13 17:23:19 +01:00
printf ( " found no cable with matching connector set \n " ) ;
2019-12-21 15:40:13 +01:00
if ( print_lcd ) {
lcd_hd44780_clear_display ( ) ;
char lcd_str [ ] = " unknown cable " ;
lcd_hd44780_write_line ( false , lcd_str , strlen ( lcd_str ) ) ;
2019-11-20 00:31:45 +01:00
}
2019-12-21 15:40:13 +01:00
goto end ;
2019-12-13 17:23:19 +01:00
}
2019-12-21 15:40:13 +01:00
printf ( " found %u cable(s) with matching connectors: \n " , cable . cables_nb ) ;
for ( uint8_t cable_i = 0 ; cable_i < LENGTH ( cable . cables ) & & cable_i < LENGTH ( usb_cables ) ; cable_i + + ) {
if ( ! cable . cables [ cable_i ] ) { // skip if the cable connectors do not match
continue ;
2019-11-20 00:31:45 +01:00
}
2019-12-21 15:40:13 +01:00
printf ( " - %02u %s \n " , cable_i , usb_cables [ cable_i ] . name ) ;
2019-11-20 00:31:45 +01:00
}
2019-12-09 20:26:50 +01:00
2019-12-26 18:03:47 +01:00
// check if there is a load
cable_load ( & cable ) ;
2019-12-13 17:23:19 +01:00
// calculate score for cables
2019-12-21 15:40:13 +01:00
cable_issues_nb ( & cable ) ;
if ( ! print_lcd ) {
printf ( " cable connection issue(s): \n " ) ;
for ( uint8_t cable_i = 0 ; cable_i < LENGTH ( usb_cables ) & & cable_i < LENGTH ( cable . cables ) & & cable_i < LENGTH ( cable . unconnected_nb ) & & cable_i < LENGTH ( cable . unspecified_nb ) ; cable_i + + ) {
if ( ! cable . cables [ cable_i ] ) { // skip if the cable connectors do not match
continue ;
2019-12-13 17:23:19 +01:00
}
2019-12-21 15:40:13 +01:00
uint16_t issues = cable . unconnected_nb [ cable_i ] + cable . unspecified_nb [ cable_i ] ;
printf ( " - %02u %s: %u (unconnected=%u/%u, undefined=%u) \n " , cable_i , usb_cables [ cable_i ] . name , issues , cable . unconnected_nb [ cable_i ] , usb_cables [ cable_i ] . pin_pairs_nb , cable . unspecified_nb [ cable_i ] ) ;
2019-12-13 17:23:19 +01:00
}
2019-12-09 20:26:50 +01:00
}
2019-12-13 17:23:19 +01:00
2019-12-21 15:40:13 +01:00
// print result to LCD
if ( print_lcd ) {
lcd_hd44780_clear_display ( ) ;
2019-12-27 12:48:40 +01:00
if ( cable . cable_best < LENGTH ( usb_cables ) & & cable . cable_best < LENGTH ( cable . unconnected_nb ) & & cable . cable_best < LENGTH ( cable . unspecified_nb ) ) {
2019-12-21 15:40:13 +01:00
const struct usb_cable_t * usb_cable = & usb_cables [ cable . cable_best ] ;
lcd_hd44780_write_line ( false , usb_cable - > name , strlen ( usb_cable - > name ) ) ;
uint16_t issues = cable . unconnected_nb [ cable . cable_best ] + cable . unspecified_nb [ cable . cable_best ] ;
if ( 0 = = issues ) {
lcd_hd44780_write_line ( true , " perfect match " , 13 ) ;
} else {
char score_str [ 17 ] ;
uint8_t str_len = snprintf ( score_str , LENGTH ( score_str ) , " issues: %u " , issues ) ;
if ( str_len ) {
lcd_hd44780_write_line ( true , score_str , str_len ) ;
2019-12-13 17:23:19 +01:00
}
}
2019-12-21 15:40:13 +01:00
} else {
lcd_hd44780_write_line ( false , " no matching " , 11 ) ;
lcd_hd44780_write_line ( true , " cable found " , 11 ) ;
2019-12-09 20:26:50 +01:00
}
2019-12-21 15:40:13 +01:00
goto end ;
}
// print connection details
cable_issues ( & cable ) ;
if ( cable . cable_best < LENGTH ( usb_cables ) & & cable . cable_best < LENGTH ( cable . unconnected_nb ) & & cable . cable_best < LENGTH ( cable . unconnected_nb ) & & cable . cables [ cable . cable_best ] ) {
// there is a matching cable
2019-12-13 17:23:19 +01:00
} else {
printf ( " no matching cable found \n " ) ;
2019-12-21 15:40:13 +01:00
goto end ;
2019-12-13 17:23:19 +01:00
}
2019-12-21 15:40:13 +01:00
const struct usb_cable_t * usb_cable = & usb_cables [ cable . cable_best ] ;
const uint16_t issues = cable . unconnected_nb [ cable . cable_best ] + cable . unspecified_nb [ cable . cable_best ] ;
if ( 0 = = issues ) {
printf ( " perfect matching cable: %s \n " , usb_cable - > name ) ;
goto end ;
2019-12-13 17:23:19 +01:00
}
2019-12-21 15:40:13 +01:00
printf ( " closes matching cable: %s \n " , usb_cable - > name ) ;
printf ( " %u connection issue(s) (%u unconnected, %u unspecified) \n " , issues , cable . unconnected_nb [ cable . cable_best ] , cable . unspecified_nb [ cable . cable_best ] ) ;
if ( cable . unconnected_nb [ cable . cable_best ] > 0 ) {
printf ( " unconnected pins: \n " ) ;
for ( uint16_t i = 0 ; i < cable . unconnected_nb [ cable . cable_best ] ; i + + ) {
const struct usb_connector_t * connector_from = usb_cables_get_connector ( cable . unconnected [ i ] [ 0 ] ) ;
const struct usb_connector_t * connector_to = usb_cables_get_connector ( cable . unconnected [ i ] [ 1 ] ) ;
if ( NULL = = connector_from | | NULL = = connector_to ) {
continue ;
}
printf ( " - %s " , connector_from - > name ) ;
if ( connector_from - > variant ) {
printf ( " (%s) " , connector_from - > variant ) ;
}
printf ( " %s to %s " , usb_pins [ cable . unconnected [ i ] [ 0 ] ] . name , connector_to - > name ) ;
if ( connector_to - > variant ) {
printf ( " (%s) " , connector_from - > variant ) ;
2019-12-12 14:23:52 +01:00
}
2019-12-21 15:40:13 +01:00
printf ( " %s \n " , usb_pins [ cable . unconnected [ i ] [ 1 ] ] . name ) ;
}
}
if ( cable . unspecified_nb [ cable . cable_best ] > 0 ) {
printf ( " unspecified pins connections: \n " ) ;
for ( uint16_t i = 0 ; i < cable . unspecified_nb [ cable . cable_best ] ; i + + ) {
const struct usb_connector_t * connector_from = usb_cables_get_connector ( cable . unspecified [ i ] [ 0 ] ) ;
const struct usb_connector_t * connector_to = usb_cables_get_connector ( cable . unspecified [ i ] [ 1 ] ) ;
if ( NULL = = connector_from | | NULL = = connector_to ) {
continue ;
}
printf ( " - %s " , connector_from - > name ) ;
if ( connector_from - > variant ) {
printf ( " (%s) " , connector_from - > variant ) ;
}
printf ( " %s to %s " , usb_pins [ cable . unspecified [ i ] [ 0 ] ] . name , connector_to - > name ) ;
if ( connector_to - > variant ) {
printf ( " (%s) " , connector_from - > variant ) ;
}
printf ( " %s \n " , usb_pins [ cable . unspecified [ i ] [ 1 ] ] . name ) ;
2019-12-09 20:26:50 +01:00
}
}
2019-12-26 18:03:47 +01:00
printf ( " there is %s load in the cable \n " , cable . load ? " a " : " no " ) ;
2019-11-20 00:31:45 +01:00
2019-12-21 15:40:13 +01:00
end :
2019-11-20 00:31:45 +01:00
usb_pins_float ( ) ; // put all pins back in safe floating state
2019-12-21 15:40:13 +01:00
cable_clear ( & cable ) ; // free allocated memory
disable_print = false ; // enable serial print again
2019-11-19 18:47:00 +01:00
}
2019-12-05 14:43:47 +01:00
/** set or show pin value
* @ param [ in ] argument pin number and level
*/
static void command_pin ( void * argument )
{
char * pin_str = NULL ; // to parse the pin number
char * pin_level = NULL ; // to parse the pin level
const char * delimiter = " " ; // words are separated by spaces
uint8_t pin_nb = 0 ; // parsed pin number
if ( argument ) { // pin number and level might have been provided
pin_str = strtok ( ( char * ) argument , delimiter ) ; // get pin number string
if ( pin_str ) {
pin_nb = strtoul ( pin_str , NULL , 10 ) ; // parse pin number
pin_level = strtok ( NULL , delimiter ) ; // get pin level
}
}
2019-12-12 14:38:59 +01:00
if ( pin_str & & pin_nb > = LENGTH ( usb_pins ) ) {
printf ( " pin %u out of range 0-%u \n " , pin_nb , LENGTH ( usb_pins ) - 1 ) ;
return ;
}
2019-12-05 14:43:47 +01:00
2019-12-12 14:38:59 +01:00
// set pin
if ( pin_str & & pin_level ) {
const struct usb_pin_t * usb_pin = & usb_pins [ pin_nb ] ;
switch ( pin_level [ 0 ] ) {
case ' h ' :
gpio_set ( usb_pin - > port , usb_pin - > pin ) ;
gpio_set_mode ( usb_pin - > port , GPIO_MODE_INPUT , GPIO_CNF_INPUT_PULL_UPDOWN , usb_pin - > pin ) ;
break ;
case ' H ' :
gpio_set ( usb_pin - > port , usb_pin - > pin ) ;
gpio_set_mode ( usb_pin - > port , GPIO_MODE_OUTPUT_2_MHZ , GPIO_CNF_OUTPUT_PUSHPULL , usb_pin - > pin ) ;
break ;
case ' l ' :
gpio_clear ( usb_pin - > port , usb_pin - > pin ) ;
gpio_set_mode ( usb_pin - > port , GPIO_MODE_INPUT , GPIO_CNF_INPUT_PULL_UPDOWN , usb_pin - > pin ) ;
break ;
case ' L ' :
gpio_clear ( usb_pin - > port , usb_pin - > pin ) ;
gpio_set_mode ( usb_pin - > port , GPIO_MODE_OUTPUT_2_MHZ , GPIO_CNF_OUTPUT_PUSHPULL , usb_pin - > pin ) ;
break ;
case ' x ' :
default :
gpio_set_mode ( usb_pin - > port , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , usb_pin - > pin ) ;
}
2019-12-05 14:43:47 +01:00
}
2019-12-06 16:24:19 +01:00
2019-12-12 14:38:59 +01:00
// print pin level
printf ( " pin state (H: out high, L: out low, h in high, l in low, x in floating) and actual level \n " ) ; // output meaning
2019-12-05 14:43:47 +01:00
uint8_t pin_i = 0 ; // current pin
for ( uint8_t connector = 0 ; connector < LENGTH ( usb_connectors ) ; connector + + ) { // test every connector
2019-12-06 21:46:11 +01:00
bool connector_print = ( ! pin_str | | ( pin_str & & pin_nb > = pin_i & & pin_nb < pin_i + usb_connectors [ connector ] - > pins_nb ) ) ; // if a pin information will be printed for this connector
2019-12-05 14:43:47 +01:00
if ( connector_print ) {
2019-12-13 09:45:00 +01:00
printf ( " %s " , usb_connectors [ connector ] - > name ) ;
if ( usb_connectors [ connector ] - > variant ) {
printf ( " (%s) " , usb_connectors [ connector ] - > variant ) ;
}
printf ( " : \n " ) ;
2019-12-05 14:43:47 +01:00
}
for ( uint8_t pin = 0 ; pin < usb_connectors [ connector ] - > pins_nb ; pin + + ) { // test every pin
2019-12-10 22:33:32 +01:00
const struct usb_pin_t * usb_pin = & usb_pins [ usb_connectors [ connector ] - > pins [ pin ] ] ; // get pin
2019-12-12 14:38:59 +01:00
if ( ! pin_str | | pin_nb = = pin_i ) { // show pin state
2019-12-10 22:33:32 +01:00
printf ( " %03u %s: " , pin_i , usb_pin - > name ) ; // print USB pin number
uint8_t pin_pos = __builtin_ctz ( usb_pin - > pin ) ; // get the pin number (position of the 1 in the 16-bit)
2019-12-06 16:24:19 +01:00
uint8_t offset = ( pin_pos < 8 ) ? ( pin_pos * 4 ) : ( ( pin_pos - 8 ) * 4 ) ; // get pin offset within port
2019-12-10 22:33:32 +01:00
uint8_t mode = ( ( ( pin_pos < 8 ) ? GPIO_CRL ( usb_pin - > port ) : GPIO_CRH ( usb_pin - > port ) ) > > ( offset + 0 ) ) & 0x3 ; // get mode from pin for port
uint8_t conf = ( ( ( pin_pos < 8 ) ? GPIO_CRL ( usb_pin - > port ) : GPIO_CRH ( usb_pin - > port ) ) > > ( offset + 2 ) ) & 0x3 ; // get configuration from pin for port
2019-12-06 16:24:19 +01:00
// show set value
if ( 0 = = mode ) { // pin configured as input
if ( 1 = = conf ) { // pin is in floating configuration
putc ( ' x ' ) ;
2019-12-10 22:33:32 +01:00
} else if ( 0 = = ( GPIO_ODR ( usb_pin - > port ) & usb_pin - > pin ) ) {
2019-12-06 16:24:19 +01:00
putc ( ' l ' ) ;
} else {
putc ( ' h ' ) ;
}
} else { // pin configured as output
2019-12-10 22:33:32 +01:00
if ( 0 = = ( GPIO_ODR ( usb_pin - > port ) & usb_pin - > pin ) ) {
2019-12-06 16:24:19 +01:00
putc ( ' L ' ) ;
} else {
putc ( ' H ' ) ;
}
}
// show actual value
2019-12-10 22:33:32 +01:00
if ( gpio_get ( usb_pin - > port , usb_pin - > pin ) ) {
2019-12-12 14:38:59 +01:00
putc ( 0 = = mode ? ' h ' : ' H ' ) ;
2019-12-09 23:15:23 +01:00
} else {
2019-12-12 14:38:59 +01:00
putc ( 0 = = mode ? ' l ' : ' L ' ) ;
2019-12-05 14:43:47 +01:00
}
putc ( ' \n ' ) ;
}
pin_i + + ; // increase global pin number
} // pin
if ( connector_print ) {
putc ( ' \n ' ) ; // separate connectors for readability
}
} // connector
}
2019-12-07 17:02:54 +01:00
/** run self test to test board connection to connectors
* @ param [ in ] argument no argument required
*/
static void command_test ( void * argument )
{
( void ) argument ; // we won't use the argument
usb_pins_float ( ) ; // start with all pins in safe floating state
printf ( " = test = \n " ) ;
printf ( " run test to check board connections \n " ) ;
printf ( " press any key to interrupt test \n \n " ) ;
// ensure all pins are floating
printf ( " remove all cables from connectors \n " ) ;
bool float_errors = true ; // to test if all pins are floating
while ( float_errors ) {
float_errors = false ; // restart test
for ( uint8_t connector = 0 ; connector < LENGTH ( usb_connectors ) ; connector + + ) { // test every connector
for ( uint8_t pin = 0 ; pin < usb_connectors [ connector ] - > pins_nb ; pin + + ) { // test every pin
2019-12-10 22:33:32 +01:00
const struct usb_pin_t * usb_pin = & usb_pins [ usb_connectors [ connector ] - > pins [ pin ] ] ; // get pin
gpio_set_mode ( usb_pin - > port , GPIO_MODE_INPUT , GPIO_CNF_INPUT_PULL_UPDOWN , usb_pin - > pin ) ; // we will test if the input is floating by checking against a pull up and down
gpio_set ( usb_pin - > port , usb_pin - > pin ) ; // pull up
2019-12-07 17:02:54 +01:00
sleep_us ( 10 ) ; // wait for GPIO/line to settle
2019-12-10 22:33:32 +01:00
bool high = ( 0 ! = gpio_get ( usb_pin - > port , usb_pin - > pin ) ) ; // test if pin is high
gpio_clear ( usb_pin - > port , usb_pin - > pin ) ; // pull down
2019-12-07 17:02:54 +01:00
sleep_us ( 10 ) ; // wait for GPIO/line to settle
2019-12-10 22:33:32 +01:00
bool low = ( 0 = = gpio_get ( usb_pin - > port , usb_pin - > pin ) ) ; // test if pin is low
gpio_set_mode ( usb_pin - > port , GPIO_MODE_INPUT , GPIO_CNF_INPUT_FLOAT , usb_pin - > pin ) ; // put back to floating
2019-12-07 17:02:54 +01:00
if ( high & & low ) { // pull up and down worked
} else { // pull up or down did not work
2019-12-13 09:45:00 +01:00
printf ( " %s " , usb_connectors [ connector ] - > name ) ;
if ( usb_connectors [ connector ] - > variant ) {
printf ( " (%s) " , usb_connectors [ connector ] - > variant ) ;
}
printf ( " %s is not floating \n " , usb_pin - > name ) ; // print erroneous pin
2019-12-07 17:02:54 +01:00
float_errors = true ; // remember there is an error
}
} // pin
} // connector
if ( float_errors ) {
if ( user_input_available ) { // user interruption
goto end ;
}
sleep_ms ( 500 ) ; // wait a bit before retesting
if ( user_input_available ) { // user interruption
goto end ;
}
}
} // float_errors
2019-12-07 23:46:57 +01:00
printf ( " all pins are floating \n \n " ) ;
2019-12-07 17:02:54 +01:00
// cables to test
const struct usb_cable_t test_cables [ ] = {
2019-12-13 13:36:56 +01:00
usb_cables [ 2 ] , // A (host) - B 3.0 shielded cable
usb_cables [ 5 ] , // A (device) - B 3.0 shielded cable
usb_cables [ 12 ] , // A (host) - miniB 2.0 shielded cable
usb_cables [ 19 ] , // A (host) - microB 3.0 shielded cable
usb_cables [ 23 ] , // C (host) shunt
usb_cables [ 24 ] , // C (device) shunt
2019-12-07 17:02:54 +01:00
} ;
for ( uint8_t cable = 0 ; cable < LENGTH ( test_cables ) ; cable + + ) {
printf ( " connect %s cable to connectors: \n " , test_cables [ cable ] . name ) ;
for ( uint8_t connector = 0 ; connector < test_cables [ cable ] . connectors_nb ; connector + + ) {
2019-12-13 09:45:00 +01:00
printf ( " - %s " , usb_connectors [ connector ] - > name ) ;
if ( usb_connectors [ connector ] - > variant ) {
printf ( " (%s) " , usb_connectors [ connector ] - > variant ) ;
}
putc ( ' \n ' ) ;
2019-12-07 17:02:54 +01:00
}
bool cable_ok = false ; // if the cable is connected
while ( ! cable_ok ) { // wait until all pin pairs of cable are connected
2019-12-09 23:31:13 +01:00
uint8_t defined , undefined ; // pair counting variables
2019-12-22 11:45:31 +01:00
cable_ok = usb_cables_test_cable ( & test_cables [ cable ] , & defined , & undefined , true ) ; // test cable
2019-12-07 17:02:54 +01:00
if ( ! cable_ok & & defined > 0 ) { // not all pairs are connected
2019-12-09 23:31:13 +01:00
printf ( " connection issues: defined=%u/%u, undefined=%u \n " , defined , test_cables [ cable ] . pin_pairs_nb , undefined ) ; // show issue summary
2019-12-07 17:02:54 +01:00
}
if ( ! cable_ok ) {
if ( user_input_available ) { // user interruption
goto end ;
}
sleep_ms ( 500 ) ; // wait a bit before retesting
if ( user_input_available ) { // user interruption
goto end ;
}
}
}
2019-12-07 23:46:57 +01:00
printf ( " cable connections are OK \n \n " ) ;
2019-12-07 17:02:54 +01:00
}
2019-12-07 23:46:57 +01:00
printf ( " all connectors are OK, the board is fine \n " ) ;
2019-12-07 17:02:54 +01:00
end :
usb_pins_float ( ) ; // put pins back to safe state
if ( user_input_available ) {
printf ( " test interrupted \n " ) ;
while ( user_input_available ) { // test has been interrupted
user_input_get ( ) ; // discard input
}
}
}
2019-12-13 15:30:31 +01:00
/** test connection between pins
* @ param [ in ] argument NULL to test all connections , " intra " to test only connection internal connections , " inter " to test only inter - connector connections
2019-12-13 14:47:00 +01:00
*/
static void command_connections ( void * argument )
{
2019-12-13 15:26:10 +01:00
char * str = ( char * ) argument ; // we won't use the argument
2019-12-13 15:30:31 +01:00
bool intra = false ; // test only connection internal connections
bool inter = false ; // test only inter-connector connections
2019-12-13 15:26:10 +01:00
if ( str ) {
if ( 0 = = strcmp ( str , " intra " ) ) {
intra = true ;
} else if ( 0 = = strcmp ( str , " inter " ) ) {
inter = true ;
} else {
printf ( " unknown argument: %s \n " , str ) ;
return ;
}
}
2019-12-13 14:47:00 +01:00
uint16_t connections_nb = 0 ;
2019-12-13 15:26:10 +01:00
uint8_t ( * connections ) [ 2 ] = NULL ;
if ( intra ) {
2019-12-13 15:30:31 +01:00
printf ( " = testing internal connections = \n " ) ;
2019-12-13 15:26:10 +01:00
for ( uint8_t i = 0 ; i < LENGTH ( usb_connectors ) ; i + + ) {
2019-12-26 17:13:24 +01:00
// test pin connections
2019-12-13 15:26:10 +01:00
const struct usb_connector_t * connector = usb_connectors [ i ] ;
2019-12-13 15:32:38 +01:00
connections = ( uint8_t ( * ) [ 2 ] ) usb_cables_test_connections ( & connector , 1 , true , false , & connections_nb ) ;
2019-12-26 17:13:24 +01:00
if ( NULL = = connections & & connections_nb ) {
printf ( " no memory available \n " ) ;
}
// check if there is a load on the cable
bool load = usb_cables_test_load ( connector ) ;
if ( 0 = = connections_nb & & ! load ) {
2019-12-13 15:26:10 +01:00
continue ;
}
2019-12-26 17:13:24 +01:00
printf ( " %s " , connector - > name ) ;
2019-12-13 15:26:10 +01:00
if ( connector - > variant ) {
2019-12-26 17:13:24 +01:00
printf ( " (%s) " , connector - > variant ) ;
2019-12-13 15:26:10 +01:00
}
printf ( " : %u connection(s) \n " , connections_nb ) ;
for ( uint16_t connection = 0 ; connection < connections_nb ; connection + + ) {
printf ( " - %s to %s \n " , usb_pins [ connections [ connection ] [ 0 ] ] . name , usb_pins [ connections [ connection ] [ 1 ] ] . name ) ;
}
2019-12-26 17:13:24 +01:00
printf ( " there is %s load on the connector \n " , load ? " a " : " no " ) ;
2019-12-13 15:26:10 +01:00
if ( connections ) {
free ( connections ) ;
connections = NULL ;
}
}
} else {
if ( inter ) {
2019-12-13 15:30:31 +01:00
printf ( " = testing connections between connectors = \n " ) ;
2019-12-13 14:47:00 +01:00
} else {
2019-12-13 15:30:31 +01:00
printf ( " = testing all connections = \n " ) ;
2019-12-13 14:47:00 +01:00
}
2019-12-13 15:32:38 +01:00
connections = ( uint8_t ( * ) [ 2 ] ) usb_cables_test_connections ( usb_connectors , LENGTH ( usb_connectors ) , ! inter , false , & connections_nb ) ;
2019-12-13 15:26:10 +01:00
if ( NULL = = connections ) {
if ( connections_nb ) {
printf ( " no memory available \n " ) ;
} else {
printf ( " no connections \n " ) ;
}
return ;
2019-12-13 14:47:00 +01:00
}
2019-12-13 15:26:10 +01:00
printf ( " found %u connections: \n " , connections_nb ) ;
for ( uint16_t i = 0 ; i < connections_nb ; i + + ) {
const struct usb_connector_t * connector_from = usb_cables_get_connector ( connections [ i ] [ 0 ] ) ;
const struct usb_connector_t * connector_to = usb_cables_get_connector ( connections [ i ] [ 1 ] ) ;
if ( NULL = = connector_from | | NULL = = connector_to ) {
printf ( " no connector for a pin pair \n " ) ;
continue ;
}
printf ( " %s " , connector_from - > name ) ;
if ( connector_from - > variant ) {
printf ( " (%s) " , connector_from - > variant ) ;
}
printf ( " %s to %s " , usb_pins [ connections [ i ] [ 0 ] ] . name , connector_to - > name ) ;
if ( connector_to - > variant ) {
printf ( " (%s) " , connector_from - > variant ) ;
}
printf ( " %s \n " , usb_pins [ connections [ i ] [ 1 ] ] . name ) ;
2019-12-13 14:47:00 +01:00
}
2019-12-13 15:26:10 +01:00
if ( connections ) {
free ( connections ) ;
connections = NULL ;
2019-12-13 14:47:00 +01:00
}
}
}
2019-12-22 11:24:04 +01:00
// ====================
// = list of commands =
// ====================
2018-04-06 17:37:17 +02:00
/** list of all supported commands */
static const struct menu_command_t menu_commands [ ] = {
{
. shortcut = ' h ' ,
. name = " help " ,
. command_description = " display help " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & command_help ,
} ,
{
2019-11-19 18:47:32 +01:00
. shortcut = ' V ' ,
2018-04-06 17:37:17 +02:00
. name = " version " ,
. command_description = " show software and hardware version " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & command_version ,
} ,
{
2019-11-19 18:47:32 +01:00
. shortcut = ' U ' ,
2018-04-06 17:37:17 +02:00
. name = " uptime " ,
. command_description = " show uptime " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & command_uptime ,
} ,
2019-06-18 17:43:43 +02:00
# if RTC_DATE_TIME
{
2019-11-19 18:47:32 +01:00
. shortcut = ' D ' ,
2019-06-18 17:43:43 +02:00
. name = " date " ,
2019-07-29 18:33:05 +02:00
. command_description = " show/set date and time " ,
2019-06-18 17:43:43 +02:00
. argument = MENU_ARGUMENT_STRING ,
. argument_description = " [YYYY-MM-DD HH:MM:SS] " ,
. command_handler = & command_datetime ,
} ,
# endif
2018-04-06 17:37:17 +02:00
{
2019-11-19 18:47:32 +01:00
. shortcut = ' R ' ,
2018-04-06 17:37:17 +02:00
. name = " reset " ,
. command_description = " reset board " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & command_reset ,
} ,
{
2019-11-19 18:47:32 +01:00
. shortcut = ' B ' ,
2018-04-06 17:37:17 +02:00
. name = " bootloader " ,
. command_description = " reboot into DFU bootloader " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & command_bootloader ,
} ,
2019-11-20 00:31:45 +01:00
{
. shortcut = ' c ' ,
. name = " cables " ,
2019-12-12 19:00:13 +01:00
. command_description = " test cable(s) " ,
. argument = MENU_ARGUMENT_UNSIGNED ,
. argument_description = " [nb] " ,
2019-11-20 00:31:45 +01:00
. command_handler = & command_cables ,
} ,
{
. shortcut = ' f ' ,
. name = " find " ,
. command_description = " find cable " ,
2019-12-21 15:40:13 +01:00
. argument = MENU_ARGUMENT_STRING ,
. argument_description = " [lcd] " ,
2019-11-20 00:31:45 +01:00
. command_handler = & command_find ,
2019-11-19 18:47:00 +01:00
} ,
2019-12-05 14:43:47 +01:00
{
. shortcut = ' p ' ,
. name = " pin " ,
. command_description = " set/show pin level " ,
. argument = MENU_ARGUMENT_STRING ,
. argument_description = " [nb] [H/L/h/l/x] " ,
. command_handler = & command_pin ,
} ,
2019-12-07 17:02:54 +01:00
{
. shortcut = ' t ' ,
. name = " test " ,
. command_description = " run board test " ,
. argument = MENU_ARGUMENT_NONE ,
. argument_description = NULL ,
. command_handler = & command_test ,
} ,
2019-12-13 14:47:00 +01:00
{
. shortcut = ' x ' ,
. name = " connections " ,
. command_description = " test all pin connections " ,
2019-12-13 15:26:10 +01:00
. argument = MENU_ARGUMENT_STRING ,
. argument_description = " [inter|intra] " ,
2019-12-13 14:47:00 +01:00
. command_handler = & command_connections ,
} ,
2018-04-06 17:37:17 +02:00
} ;
2019-12-22 11:24:04 +01:00
// ====================
// = generic commands =
// ====================
2018-04-06 17:37:17 +02:00
static void command_help ( void * argument )
{
( void ) argument ; // we won't use the argument
printf ( " available commands: \n " ) ;
menu_print_commands ( menu_commands , LENGTH ( menu_commands ) ) ; // print global commands
}
static void command_version ( void * argument )
{
( void ) argument ; // we won't use the argument
printf ( " firmware date: %04u-%02u-%02u \n " , BUILD_YEAR , BUILD_MONTH , BUILD_DAY ) ; // show firmware build date
// get device identifier (DEV_ID)
// 0x412: low-density, 16-32 kB flash
// 0x410: medium-density, 64-128 kB flash
// 0x414: high-density, 256-512 kB flash
// 0x430: XL-density, 768-1024 kB flash
// 0x418: connectivity
2020-02-19 21:16:07 +01:00
puts ( " device family: " ) ;
2019-12-30 17:18:25 +01:00
switch ( DBGMCU_IDCODE & DBGMCU_IDCODE_DEV_ID_MASK ) {
2018-04-06 17:37:17 +02:00
case 0 : // this is a known issue document in STM32F10xxC/D/E Errata sheet, without workaround
2020-02-19 21:16:07 +01:00
puts ( " unreadable \n " ) ;
2018-04-06 17:37:17 +02:00
break ;
case 0x412 :
2020-02-19 21:16:07 +01:00
puts ( " low-density \n " ) ;
2018-04-06 17:37:17 +02:00
break ;
case 0x410 :
2020-02-19 21:16:07 +01:00
puts ( " medium-density \n " ) ;
2018-04-06 17:37:17 +02:00
break ;
case 0x414 :
2020-02-19 21:16:07 +01:00
puts ( " high-density \n " ) ;
2018-04-06 17:37:17 +02:00
break ;
case 0x430 :
2020-02-19 21:16:07 +01:00
puts ( " XL-density \n " ) ;
2018-04-06 17:37:17 +02:00
break ;
case 0x418 :
2020-02-19 21:16:07 +01:00
puts ( " connectivity \n " ) ;
2018-04-06 17:37:17 +02:00
break ;
default :
2020-02-19 21:16:07 +01:00
puts ( " unknown \n " ) ;
2018-04-06 17:37:17 +02:00
break ;
}
// show flash size
2020-02-19 21:16:07 +01:00
puts ( " flash size: " ) ;
2019-06-18 17:44:50 +02:00
if ( 0xffff = = DESIG_FLASH_SIZE ) {
2020-02-19 21:16:07 +01:00
puts ( " unknown (probably a defective micro-controller \n " ) ;
2018-04-06 17:37:17 +02:00
} else {
printf ( " %u KB \n " , DESIG_FLASH_SIZE ) ;
}
// display device identity
printf ( " device id: %08x%08x%08x \n " , DESIG_UNIQUE_ID0 , DESIG_UNIQUE_ID1 , DESIG_UNIQUE_ID2 ) ;
}
static void command_uptime ( void * argument )
{
( void ) argument ; // we won't use the argument
2020-02-17 18:08:17 +01:00
uint32_t uptime = ( rtc_get_counter_val ( ) - time_start ) / RTC_TICKS_SECOND ; // get time from internal RTC
2019-06-18 17:43:43 +02:00
printf ( " uptime: %u.%02u:%02u:%02u \n " , uptime / ( 24 * 60 * 60 ) , ( uptime / ( 60 * 60 ) ) % 24 , ( uptime / 60 ) % 60 , uptime % 60 ) ;
2018-04-06 17:37:17 +02:00
}
2019-06-18 17:43:43 +02:00
# if RTC_DATE_TIME
static void command_datetime ( void * argument )
{
char * datetime = ( char * ) argument ; // argument is optional date time
if ( NULL = = argument ) { // no date and time provided, just show the current day and time
2020-02-17 18:08:17 +01:00
time_t time_rtc = rtc_get_counter_val ( ) / RTC_TICKS_SECOND ; // get time from internal RTC
2019-06-18 17:43:43 +02:00
struct tm * time_tm = localtime ( & time_rtc ) ; // convert time
printf ( " date: %d-%02d-%02d %02d:%02d:%02d \n " , 1900 + time_tm - > tm_year , time_tm - > tm_mon , time_tm - > tm_mday , time_tm - > tm_hour , time_tm - > tm_min , time_tm - > tm_sec ) ;
} else { // date and time provided, set it
const char * malformed = " date and time malformed, expecting YYYY-MM-DD HH:MM:SS \n " ;
struct tm time_tm ; // to store the parsed date time
if ( strlen ( datetime ) ! = ( 4 + 1 + 2 + 1 + 2 ) + 1 + ( 2 + 1 + 2 + 1 + 2 ) ) { // verify date/time is long enough
printf ( malformed ) ;
return ;
}
if ( ! ( isdigit ( ( int8_t ) datetime [ 0 ] ) & & isdigit ( ( int8_t ) datetime [ 1 ] ) & & isdigit ( ( int8_t ) datetime [ 2 ] ) & & isdigit ( ( int8_t ) datetime [ 3 ] ) & & ' - ' = = datetime [ 4 ] & & isdigit ( ( int8_t ) datetime [ 5 ] ) & & isdigit ( ( int8_t ) datetime [ 6 ] ) & & ' - ' = = datetime [ 7 ] & & isdigit ( ( int8_t ) datetime [ 8 ] ) & & isdigit ( ( int8_t ) datetime [ 9 ] ) & & ' ' = = datetime [ 10 ] & & isdigit ( ( int8_t ) datetime [ 11 ] ) & & isdigit ( ( int8_t ) datetime [ 12 ] ) & & ' : ' = = datetime [ 13 ] & & isdigit ( ( int8_t ) datetime [ 14 ] ) & & isdigit ( ( int8_t ) datetime [ 15 ] ) & & ' : ' = = datetime [ 16 ] & & isdigit ( ( int8_t ) datetime [ 17 ] ) & & isdigit ( ( int8_t ) datetime [ 18 ] ) ) ) { // verify format (good enough to not fail parsing)
printf ( malformed ) ;
return ;
}
time_tm . tm_year = strtol ( & datetime [ 0 ] , NULL , 10 ) - 1900 ; // parse year
time_tm . tm_mon = strtol ( & datetime [ 5 ] , NULL , 10 ) ; // parse month
time_tm . tm_mday = strtol ( & datetime [ 8 ] , NULL , 10 ) ; // parse day
time_tm . tm_hour = strtol ( & datetime [ 11 ] , NULL , 10 ) ; // parse hour
time_tm . tm_min = strtol ( & datetime [ 14 ] , NULL , 10 ) ; // parse minutes
time_tm . tm_sec = strtol ( & datetime [ 17 ] , NULL , 10 ) ; // parse seconds
time_t time_rtc = mktime ( & time_tm ) ; // get back seconds
2020-02-17 18:08:17 +01:00
time_start = time_rtc * RTC_TICKS_SECOND + ( rtc_get_counter_val ( ) - time_start ) ; // update uptime with current date
rtc_set_counter_val ( time_rtc * RTC_TICKS_SECOND ) ; // save date/time to internal RTC
2019-06-18 17:43:43 +02:00
printf ( " date and time saved: %d-%02d-%02d %02d:%02d:%02d \n " , 1900 + time_tm . tm_year , time_tm . tm_mon , time_tm . tm_mday , time_tm . tm_hour , time_tm . tm_min , time_tm . tm_sec ) ;
}
}
# endif
2018-04-06 17:37:17 +02:00
static void command_reset ( void * argument )
{
( void ) argument ; // we won't use the argument
scb_reset_system ( ) ; // reset device
while ( true ) ; // wait for the reset to happen
}
static void command_bootloader ( void * argument )
{
( void ) argument ; // we won't use the argument
2020-01-02 13:01:40 +01:00
// set DFU magic to specific RAM location
__dfu_magic [ 0 ] = ' D ' ;
__dfu_magic [ 1 ] = ' F ' ;
__dfu_magic [ 2 ] = ' U ' ;
__dfu_magic [ 3 ] = ' ! ' ;
scb_reset_system ( ) ; // reset system (core and peripherals)
2018-04-06 17:37:17 +02:00
while ( true ) ; // wait for the reset to happen
}
2016-01-17 14:54:54 +01:00
2016-08-14 21:02:38 +02:00
/** process user command
* @ param [ in ] str user command string ( \ 0 ended )
*/
static void process_command ( char * str )
2016-01-17 14:54:54 +01:00
{
2018-04-06 17:37:17 +02:00
// ensure actions are available
2019-06-18 17:44:50 +02:00
if ( NULL = = menu_commands | | 0 = = LENGTH ( menu_commands ) ) {
2018-04-06 17:37:17 +02:00
return ;
2016-08-14 21:02:38 +02:00
}
2018-04-06 17:37:17 +02:00
// don't handle empty lines
2019-06-18 17:44:50 +02:00
if ( ! str | | 0 = = strlen ( str ) ) {
2018-04-06 17:37:17 +02:00
return ;
}
bool command_handled = false ;
if ( ! command_handled ) {
command_handled = menu_handle_command ( str , menu_commands , LENGTH ( menu_commands ) ) ; // try if this is not a global command
}
if ( ! command_handled ) {
printf ( " command not recognized. enter help to list commands \n " ) ;
2016-08-14 21:02:38 +02:00
}
2016-01-17 14:54:54 +01:00
}
2019-12-22 11:24:04 +01:00
// ========
// = main =
// ========
2019-12-21 14:20:10 +01:00
2016-08-14 21:02:38 +02:00
/** program entry point
* this is the firmware function started by the micro - controller
*/
2016-10-23 17:42:27 +02:00
void main ( void ) ;
void main ( void )
2018-04-06 17:37:17 +02:00
{
2016-01-29 00:24:49 +01:00
rcc_clock_setup_in_hse_8mhz_out_72mhz ( ) ; // use 8 MHz high speed external clock to generate 72 MHz internal clock
2016-08-14 21:02:38 +02:00
2016-10-23 17:42:27 +02:00
# if DEBUG
2017-01-30 09:44:51 +01:00
// enable functionalities for easier debug
2016-10-23 17:42:27 +02:00
DBGMCU_CR | = DBGMCU_CR_IWDG_STOP ; // stop independent watchdog counter when code is halted
DBGMCU_CR | = DBGMCU_CR_WWDG_STOP ; // stop window watchdog counter when code is halted
DBGMCU_CR | = DBGMCU_CR_STANDBY ; // allow debug also in standby mode (keep digital part and clock powered)
DBGMCU_CR | = DBGMCU_CR_STOP ; // allow debug also in stop mode (keep clock powered)
DBGMCU_CR | = DBGMCU_CR_SLEEP ; // allow debug also in sleep mode (keep clock powered)
2017-02-06 17:40:28 +01:00
# else
2019-12-21 19:28:39 +01:00
RCC_APB1ENR | = RCC_APB1ENR_BKPEN | RCC_APB1ENR_PWREN ; // enable access to power register
if ( RCC_CSR & RCC_CSR_IWDGRSTF & & 0x22 = = BKP_DR1 ) { // we have been woken up by independent watchdog but actually want to stay in standby mode
RCC_CSR | = RCC_CSR_RMVF ; // clear reset flags
// the reset will have clearer the software set watchdog
2019-12-22 11:24:04 +01:00
standby ( ) ; // go to standby (e.g. shut down)
2019-12-21 19:28:39 +01:00
}
2017-01-30 09:44:51 +01:00
// setup watchdog to reset in case we get stuck (i.e. when an error occurred)
iwdg_set_period_ms ( WATCHDOG_PERIOD ) ; // set independent watchdog period
iwdg_start ( ) ; // start independent watchdog
2019-12-21 19:28:39 +01:00
BKP_DR1 = 0 ; // clear backup register to not indicate we want to stay in stand by
2016-10-23 17:42:27 +02:00
# endif
2017-04-03 13:32:45 +02:00
board_setup ( ) ; // setup board
2019-12-21 14:20:10 +01:00
// setup power to display an pull-up D+ to indicate USB connect
rcc_periph_clock_enable ( GPIO_RCC ( DISPLAY_POWER_PIN ) ) ; // enable clock for GPIO peripheral
gpio_set_mode ( GPIO_PORT ( DISPLAY_POWER_PIN ) , GPIO_MODE_OUTPUT_2_MHZ , GPIO_CNF_OUTPUT_OPENDRAIN , GPIO_PIN ( DISPLAY_POWER_PIN ) ) ; // set pin to output open-drain since it is controlled by pMOS
display_on ( ) ;
2017-04-19 16:26:40 +02:00
usb_cdcacm_setup ( ) ; // setup USB CDC ACM (for printing)
2019-12-21 19:29:38 +01:00
puts ( " \n welcome to the CuVoodoo USB cable tester \n " ) ; // print welcome message
2016-01-29 00:24:49 +01:00
2019-12-21 19:26:27 +01:00
# if DEBUG
// show reset cause
if ( RCC_CSR & ( RCC_CSR_LPWRRSTF | RCC_CSR_WWDGRSTF | RCC_CSR_IWDGRSTF | RCC_CSR_SFTRSTF | RCC_CSR_PORRSTF | RCC_CSR_PINRSTF ) ) {
puts ( " reset cause(s): " ) ;
if ( RCC_CSR & RCC_CSR_LPWRRSTF ) {
puts ( " low-power " ) ;
}
if ( RCC_CSR & RCC_CSR_WWDGRSTF ) {
puts ( " window-watchdog " ) ;
}
if ( RCC_CSR & RCC_CSR_IWDGRSTF ) {
puts ( " independent-watchdog " ) ;
}
if ( RCC_CSR & RCC_CSR_SFTRSTF ) {
puts ( " software " ) ;
}
if ( RCC_CSR & RCC_CSR_PORRSTF ) {
puts ( " POR/PDR " ) ;
}
if ( RCC_CSR & RCC_CSR_PINRSTF ) {
puts ( " pin " ) ;
}
putc ( ' \n ' ) ;
RCC_CSR | = RCC_CSR_RMVF ; // clear reset flags
}
# endif
2019-12-22 11:24:04 +01:00
# if !(DEBUG) && false
2017-01-30 09:44:51 +01:00
// show watchdog information
2019-12-21 19:26:58 +01:00
printf ( " setup watchdog: %.2fs " , WATCHDOG_PERIOD / 1000.0 ) ;
if ( FLASH_OBR & FLASH_OBR_OPTERR ) {
2020-02-19 21:16:07 +01:00
puts ( " (option bytes not set in flash: software wachtdog used, not automatically started at reset) \n " ) ;
2019-12-21 19:26:58 +01:00
} else if ( FLASH_OBR & FLASH_OBR_WDG_SW ) {
2020-02-19 21:16:07 +01:00
puts ( " (software watchdog used, not automatically started at reset) \n " ) ;
2017-01-30 09:44:51 +01:00
} else {
2020-02-19 21:16:07 +01:00
puts ( " (hardware watchdog used, automatically started at reset) \n " ) ;
2017-01-30 09:44:51 +01:00
}
# endif
2016-08-14 21:02:38 +02:00
// setup RTC
2020-02-02 21:19:03 +01:00
rtc_auto_awake ( RCC_HSE , 8000000 / 128 / RTC_TICKS_SECOND - 1 ) ; // use High Speed External oscillator (8 MHz / 128) as RTC clock (VBAT can't be used to keep the RTC running)
2019-11-19 18:46:13 +01:00
rtc_auto_awake ( RCC_HSE , 8000000 / 128 - 1 ) ; // use High Speed External oscillator (8 MHz / 128) as RTC clock (VBAT can't be used to keep the RTC running)
2016-08-14 21:02:38 +02:00
rtc_interrupt_enable ( RTC_SEC ) ; // enable RTC interrupt on "seconds"
nvic_enable_irq ( NVIC_RTC_IRQ ) ; // allow the RTC to interrupt
2019-06-18 17:43:43 +02:00
time_start = rtc_get_counter_val ( ) ; // get start time from internal RTC
2016-08-14 21:02:38 +02:00
2019-12-12 19:00:13 +01:00
// setup LCD display
2019-12-21 15:40:13 +01:00
lcd_hd44780_i2c_addr = 0x3f ; // set LCD backpack I²C slave address
const char * lcd_default_line1 = " USB cable tester " ; // default LCD text, when no cable is connected
const char * lcd_default_line2 = " plug in cable " ; // default LCD text, when no cable is connected
if ( lcd_hd44780_setup ( true , false ) ) { // setup LCD communication
lcd_hd44780_display_control ( true , false , false ) ; // display on, cursor off, blink off
lcd_hd44780_clear_display ( ) ; // be sure the display is cleared
lcd_hd44780_write_line ( false , lcd_default_line1 , strlen ( lcd_default_line1 ) ) ;
lcd_hd44780_write_line ( true , lcd_default_line2 , strlen ( lcd_default_line2 ) ) ;
2019-12-12 19:00:13 +01:00
} else {
2019-12-13 14:44:03 +01:00
printf ( " could not start LCD \n " ) ;
2019-12-12 19:00:13 +01:00
}
2019-11-19 18:46:13 +01:00
// setup USB connectors
gpio_primary_remap ( AFIO_MAPR_SWJ_CFG_JTAG_OFF_SW_ON , 0 ) ; // only use SWD and reuse JTAG pins
2019-12-05 14:41:57 +01:00
rcc_periph_clock_enable ( RCC_GPIOA ) ; // enable clock to all GPIO port domains since we use them all
rcc_periph_clock_enable ( RCC_GPIOB ) ; // enable clock to all GPIO port domains since we use them all
rcc_periph_clock_enable ( RCC_GPIOC ) ; // enable clock to all GPIO port domains since we use them all
rcc_periph_clock_enable ( RCC_GPIOD ) ; // enable clock to all GPIO port domains since we use them all
rcc_periph_clock_enable ( RCC_GPIOE ) ; // enable clock to all GPIO port domains since we use them all
rcc_periph_clock_enable ( RCC_GPIOF ) ; // enable clock to all GPIO port domains since we use them all
rcc_periph_clock_enable ( RCC_GPIOG ) ; // enable clock to all GPIO port domains since we use them all
2019-11-19 18:46:13 +01:00
usb_pins_float ( ) ; // pull all pins to floating
2019-12-21 14:23:35 +01:00
// find cable after power up
command_find ( " lcd " ) ;
2018-04-06 17:37:17 +02:00
// setup terminal
terminal_prefix = " " ; // set default prefix
terminal_process = & process_command ; // set central function to process commands
terminal_setup ( ) ; // start terminal
2016-10-23 17:42:27 +02:00
2018-04-06 17:37:17 +02:00
// start main loop
2019-12-21 14:23:35 +01:00
uint32_t last_connect_time = rtc_get_counter_val ( ) ; // last time a USB cable has been connected/disconnected
bool interactive = false ; // if there is user activity on the serial port
2016-02-18 10:39:08 +01:00
bool action = false ; // if an action has been performed don't go to sleep
2019-12-27 12:50:07 +01:00
struct cable_t * cable_current = calloc ( 1 , sizeof ( struct cable_t ) ) ; // to store the currently detected cable
if ( NULL = = cable_current ) {
printf ( " EOMEM \n " ) ;
while ( true ) ;
}
cable_clear ( cable_current ) ; // initialize rest of cable structure
struct cable_t * cable_next = calloc ( 1 , sizeof ( struct cable_t ) ) ; // to store the next detected cable
if ( NULL = = cable_next ) {
printf ( " EOMEM \n " ) ;
while ( true ) ;
}
cable_clear ( cable_next ) ; // initialize rest of cable structure
bool cable_changed = false ; // if the next cable is not the same as the current
2016-01-29 00:24:49 +01:00
while ( true ) { // infinite loop
2016-10-23 17:42:27 +02:00
iwdg_reset ( ) ; // kick the dog
2019-06-18 17:45:53 +02:00
if ( user_input_available ) { // user input is available
2016-02-18 10:39:08 +01:00
action = true ; // action has been performed
2019-12-21 14:23:35 +01:00
if ( ! interactive ) { // the user takes control
interactive = true ; // remember to not shut down anymore
// show interactive mode on LCD
const char * lcd_interactive_line1 = " interactive mode " ;
const char * lcd_interactive_line2 = " over serial port " ;
lcd_hd44780_clear_display ( ) ;
lcd_hd44780_write_line ( false , lcd_interactive_line1 , strlen ( lcd_interactive_line1 ) ) ;
lcd_hd44780_write_line ( true , lcd_interactive_line2 , strlen ( lcd_interactive_line2 ) ) ;
}
2018-04-06 17:37:17 +02:00
char c = user_input_get ( ) ; // store receive character
terminal_send ( c ) ; // send received character to terminal
2016-08-14 21:02:38 +02:00
}
2019-06-18 17:45:53 +02:00
if ( rtc_internal_tick_flag ) { // the internal RTC ticked
2016-08-14 21:02:38 +02:00
rtc_internal_tick_flag = false ; // reset flag
2017-06-27 15:44:03 +02:00
action = true ; // action has been performed
2019-12-27 12:50:07 +01:00
if ( ! interactive ) { // periodically check cable when not in interactive mode
// start cable detection
cable_clear ( cable_next ) ; // clear definition
cable_detect ( cable_next ) ; // detect connected connectors
if ( NULL = = cable_next - > connections & & cable_next - > connections_nb > 0 ) {
printf ( " EOMEM \n " ) ;
while ( true ) ;
}
// if there is a cable, we need to identify it further
if ( 0 ! = cable_next - > connections_nb ) {
cable_connectors ( cable_next ) ; // first identify the connectors
cable_cables ( cable_next ) ; // find cables with matching connector set
cable_issues_nb ( cable_next ) ; // calculate score for cables (updates the connections)
if ( NULL = = cable_next - > connections | | 0 = = cable_next - > connections_nb ) {
printf ( " EOMEM \n " ) ;
while ( true ) ;
}
}
// compare next to current cable
if ( cable_current - > connections_nb ! = cable_next - > connections_nb ) {
cable_changed = true ; // note it changed, but don't do anything until change is confirmed a second time
} else { // same number of connections
bool match = true ;
for ( uint16_t i = 0 ; i < cable_current - > connections_nb & & i < cable_next - > connections_nb & & match ; i + + ) {
if ( cable_current - > connections [ i ] [ 0 ] ! = cable_next - > connections [ i ] [ 0 ] | | cable_current - > connections [ i ] [ 1 ] ! = cable_next - > connections [ i ] [ 1 ] ) {
match = false ;
}
}
if ( ! match ) { // not the same connections
cable_changed = true ;
} else if ( cable_changed ) { // it's the same cable, and it has been confirmed a second time
cable_changed = false ; // remember it's the same cable
if ( 0 = = cable_current - > connections_nb ) { // no cable plugged in
lcd_hd44780_clear_display ( ) ; // be sure the display is cleared
lcd_hd44780_write_line ( false , lcd_default_line1 , strlen ( lcd_default_line1 ) ) ;
lcd_hd44780_write_line ( true , lcd_default_line2 , strlen ( lcd_default_line2 ) ) ;
} else { // there is a new confirmed cable
cable_load ( cable_next ) ; // check if there is a load
cable_issues ( cable_next ) ; // get the exact issues
lcd_hd44780_clear_display ( ) ; // clear display
if ( cable_next - > cable_best < LENGTH ( usb_cables ) & & cable_next - > cable_best < LENGTH ( cable_next - > unconnected_nb ) & & cable_next - > cable_best < LENGTH ( cable_next - > unspecified_nb ) ) {
const struct usb_cable_t * usb_cable = & usb_cables [ cable_next - > cable_best ] ;
lcd_hd44780_write_line ( false , usb_cable - > name , strlen ( usb_cable - > name ) ) ;
uint16_t issues = cable_next - > unconnected_nb [ cable_next - > cable_best ] + cable_next - > unspecified_nb [ cable_next - > cable_best ] ;
if ( 0 = = issues ) {
lcd_hd44780_write_line ( true , " perfect match " , 13 ) ;
} else {
char score_str [ 17 ] ;
uint8_t str_len = snprintf ( score_str , LENGTH ( score_str ) , " issues: %u " , issues ) ;
if ( str_len ) {
lcd_hd44780_write_line ( true , score_str , str_len ) ;
}
}
} else {
lcd_hd44780_write_line ( false , " no matching " , 11 ) ;
lcd_hd44780_write_line ( true , " cable found " , 11 ) ;
}
}
} else { // the cable did not change
// nothing to do, wait for cable change
}
}
// next cable because the current one (reuse allocated current for the next)
struct cable_t * cable_tmp = cable_current ;
cable_current = cable_next ;
cable_next = cable_tmp ;
} // !interactive
2019-12-21 14:23:35 +01:00
while ( ! interactive & & rtc_get_counter_val ( ) > = last_connect_time + SHUTDOWN_TIMEOUT ) { // time to shut down
2019-12-21 19:28:39 +01:00
# if !DEBUG
2019-12-22 11:24:04 +01:00
BKP_DR1 = 0x22 ; // indicate we want to stay in standby mode (it's not possible to disable the independent watchdog and it will reset the system even in standby mode
2019-12-21 19:28:39 +01:00
# endif
2019-12-21 14:23:35 +01:00
display_off ( ) ; // cut power to displays (at stop D+ pull-up to indicate disconnect)
2019-12-22 11:24:04 +01:00
standby ( ) ; // go into standby mode (shut down)
2019-12-21 14:23:35 +01:00
}
2016-08-14 21:02:38 +02:00
}
if ( action ) { // go to sleep if nothing had to be done, else recheck for activity
2016-02-18 10:39:08 +01:00
action = false ;
} else {
__WFI ( ) ; // go to sleep
}
2016-10-23 17:42:27 +02:00
} // main loop
2016-01-17 14:54:54 +01:00
}
2016-01-29 11:25:30 +01:00
2016-08-14 21:02:38 +02:00
/** @brief interrupt service routine called when tick passed on RTC */
void rtc_isr ( void )
{
rtc_clear_flag ( RTC_SEC ) ; // clear flag
rtc_internal_tick_flag = true ; // notify to show new time
}