application: integrate terminal and menu
parent
4a634fb19f
commit
fcbabf1ea7
323
application.c
323
application.c
|
|
@ -15,14 +15,13 @@
|
|||
/** STM32F1 application example
|
||||
* @file application.c
|
||||
* @author King Kévin <kingkevin@cuvoodoo.info>
|
||||
* @date 2016-2017
|
||||
* @date 2016-2018
|
||||
*/
|
||||
|
||||
/* standard libraries */
|
||||
#include <stdint.h> // standard integer types
|
||||
#include <stdlib.h> // standard utilities
|
||||
#include <string.h> // string utilities
|
||||
#include <time.h> // date/time utilities
|
||||
|
||||
/* STM32 (including CM3) libraries */
|
||||
#include <libopencmsis/core_cm3.h> // Cortex M3 utilities
|
||||
|
|
@ -34,6 +33,7 @@
|
|||
#include <libopencm3/stm32/rtc.h> // real time clock utilities
|
||||
#include <libopencm3/stm32/iwdg.h> // independent watchdog utilities
|
||||
#include <libopencm3/stm32/dbgmcu.h> // debug utilities
|
||||
#include <libopencm3/stm32/desig.h> // design utilities
|
||||
#include <libopencm3/stm32/flash.h> // flash utilities
|
||||
|
||||
/* own libraries */
|
||||
|
|
@ -41,6 +41,8 @@
|
|||
#include "print.h" // printing utilities
|
||||
#include "uart.h" // USART utilities
|
||||
#include "usb_cdcacm.h" // USB CDC ACM utilities
|
||||
#include "terminal.h" // handle the terminal interface
|
||||
#include "menu.h" // menu utilities
|
||||
|
||||
#define WATCHDOG_PERIOD 10000 /**< watchdog period in ms */
|
||||
|
||||
|
|
@ -50,126 +52,187 @@
|
|||
volatile bool rtc_internal_tick_flag = false; /**< flag set when internal RTC ticked */
|
||||
/** @} */
|
||||
|
||||
time_t time_rtc = 0; /**< time (seconds since Unix Epoch) */
|
||||
struct tm* time_tm; /**< time in tm format (time zones are not handled for non-POSIX environments) */
|
||||
|
||||
size_t putc(char c)
|
||||
{
|
||||
size_t length = 0; // number of characters printed
|
||||
static char newline = 0; // to remember on which character we sent the newline
|
||||
if (0==c) {
|
||||
length = 0; // don't print string termination character
|
||||
} else if ('\r' == c || '\n' == c) { // send CR+LF newline for most carriage return and line feed combination
|
||||
if (0==newline || c==newline) { // send newline only if not already send (and only once on \r\n or \n\r)
|
||||
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
|
||||
uart_putchar_nonblocking('\r'); // send CR over USART
|
||||
usb_cdcacm_putchar('\r'); // send CR over USB
|
||||
uart_putchar_nonblocking('\n'); // send LF over USART
|
||||
usb_cdcacm_putchar('\n'); // send LF over USB
|
||||
length += 2; // remember we printed 2 characters
|
||||
newline = c; // remember on which character we sent the newline
|
||||
} else {
|
||||
length = 0; // the \r or \n of \n\r or \r\n has already been printed
|
||||
length++; // remember we printed 1 character
|
||||
}
|
||||
} else {
|
||||
uart_putchar_nonblocking(c); // send byte over USART
|
||||
usb_cdcacm_putchar(c); // send byte over USB
|
||||
newline = 0; // clear new line
|
||||
length++; // remember we printed 1 character
|
||||
}
|
||||
uart_putchar_nonblocking(c); // send byte over USART
|
||||
usb_cdcacm_putchar(c); // send byte over USB
|
||||
length++; // remember we printed 1 character
|
||||
last_c = c; // remember last character
|
||||
return length; // return number of characters printed
|
||||
}
|
||||
|
||||
/** user input command */
|
||||
static char command[32] = {0};
|
||||
/** user input command index */
|
||||
uint8_t command_i = 0;
|
||||
/** 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);
|
||||
|
||||
/** 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);
|
||||
|
||||
/** 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,
|
||||
},
|
||||
{
|
||||
.shortcut = 'v',
|
||||
.name = "version",
|
||||
.command_description = "show software and hardware version",
|
||||
.argument = MENU_ARGUMENT_NONE,
|
||||
.argument_description = NULL,
|
||||
.command_handler = &command_version,
|
||||
},
|
||||
{
|
||||
.shortcut = 'u',
|
||||
.name = "uptime",
|
||||
.command_description = "show uptime",
|
||||
.argument = MENU_ARGUMENT_NONE,
|
||||
.argument_description = NULL,
|
||||
.command_handler = &command_uptime,
|
||||
},
|
||||
{
|
||||
.shortcut = 'r',
|
||||
.name = "reset",
|
||||
.command_description = "reset board",
|
||||
.argument = MENU_ARGUMENT_NONE,
|
||||
.argument_description = NULL,
|
||||
.command_handler = &command_reset,
|
||||
},
|
||||
{
|
||||
.shortcut = 'b',
|
||||
.name = "bootloader",
|
||||
.command_description = "reboot into DFU bootloader",
|
||||
.argument = MENU_ARGUMENT_NONE,
|
||||
.argument_description = NULL,
|
||||
.command_handler = &command_bootloader,
|
||||
},
|
||||
};
|
||||
|
||||
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
|
||||
printf("device family: ");
|
||||
switch (DBGMCU_IDCODE&DBGMCU_IDCODE_DEV_ID_MASK) {
|
||||
case 0: // this is a known issue document in STM32F10xxC/D/E Errata sheet, without workaround
|
||||
printf("unreadable\n");
|
||||
break;
|
||||
case 0x412:
|
||||
printf("low-density\n");
|
||||
break;
|
||||
case 0x410:
|
||||
printf("medium-density\n");
|
||||
break;
|
||||
case 0x414:
|
||||
printf("high-density\n");
|
||||
break;
|
||||
case 0x430:
|
||||
printf("XL-density\n");
|
||||
break;
|
||||
case 0x418:
|
||||
printf("connectivity\n");
|
||||
break;
|
||||
default:
|
||||
printf("unknown\n");
|
||||
break;
|
||||
}
|
||||
// show flash size
|
||||
printf("flash size: ");
|
||||
if (0xffff==DESIG_FLASH_SIZE) {
|
||||
printf("unknown (probably a defective micro-controller\n");
|
||||
} 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
|
||||
uint32_t uptime = rtc_get_counter_val(); // get time from internal RTC
|
||||
printf("uptime: %u.%02u:%02u:%02u\n", uptime/(24*60*60), (uptime/(60*60))%24, (uptime/60)%60, uptime%60);
|
||||
}
|
||||
|
||||
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
|
||||
RCC_CSR |= RCC_CSR_RMVF; // clear reset flags
|
||||
scb_reset_core(); // reset core (the bootloader will interpret it as starting into DFU)
|
||||
while (true); // wait for the reset to happen
|
||||
}
|
||||
|
||||
/** process user command
|
||||
* @param[in] str user command string (\0 ended)
|
||||
*/
|
||||
static void process_command(char* str)
|
||||
{
|
||||
// split command
|
||||
const char* delimiter = " ";
|
||||
char* word = strtok(str,delimiter);
|
||||
if (!word) {
|
||||
goto error;
|
||||
// ensure actions are available
|
||||
if (NULL==menu_commands || 0==LENGTH(menu_commands)) {
|
||||
return;
|
||||
}
|
||||
// parse command
|
||||
if (0==strcmp(word,"h") || 0==strcmp(word,"help") || 0==strcmp(word,"?")) {
|
||||
printf("available commands:\n");
|
||||
printf("l|led [on|off|toggle]\n");
|
||||
printf("s|self-test\n");
|
||||
printf("p|pin-test\n");
|
||||
printf("r|reset\n");
|
||||
} else if (0==strcmp(word,"l") || 0==strcmp(word,"led")) {
|
||||
word = strtok(NULL,delimiter);
|
||||
if (!word) {
|
||||
printf("LED is ");
|
||||
if (gpio_get(GPIO(LED_PORT), GPIO(LED_PIN))) {
|
||||
printf("on\n");
|
||||
} else {
|
||||
printf("off\n");
|
||||
}
|
||||
} else if (0==strcmp(word,"on")) {
|
||||
led_on(); // switch LED on
|
||||
printf("LED switched on\n"); // notify user
|
||||
} else if (0==strcmp(word,"off")) {
|
||||
led_off(); // switch LED off
|
||||
printf("LED switched off\n"); // notify user
|
||||
} else if (0==strcmp(word,"toggle")) {
|
||||
led_toggle(); // toggle LED
|
||||
printf("LED toggled\n"); // notify user
|
||||
} else {
|
||||
goto error;
|
||||
}
|
||||
} else if (0==strcmp(word,"time")) {
|
||||
word = strtok(NULL,delimiter);
|
||||
if (!word) {
|
||||
time_rtc = rtc_get_counter_val(); // get time from internal RTC
|
||||
time_tm = localtime(&time_rtc); // convert time
|
||||
printf("time: %02d:%02d:%02d\n", time_tm->tm_hour, time_tm->tm_min, time_tm->tm_sec);
|
||||
} else if (strlen(word)!=8 || word[0]<'0' || word[0]>'2' || word[1]<'0' || word[1]>'9' || word[3]<'0' || word[3]>'5' || word[4]<'0' || word[4]>'9' || word[6]<'0' || word[6]>'5' || word[7]<'0' || word[7]>'9') { // time format is incorrect
|
||||
goto error;
|
||||
} else {
|
||||
time_rtc = rtc_get_counter_val(); // get time from internal RTC
|
||||
time_tm = localtime(&time_rtc); // convert time
|
||||
time_tm->tm_hour = (word[0]-'0')*10+(word[1]-'0')*1; // set hours
|
||||
time_tm->tm_min = (word[3]-'0')*10+(word[4]-'0')*1; // set minutes
|
||||
time_tm->tm_sec = (word[6]-'0')*10+(word[7]-'0')*1; // set seconds
|
||||
time_rtc = mktime(time_tm); // get back seconds
|
||||
rtc_set_counter_val(time_rtc); // save time to internal RTC
|
||||
printf("time set\n");
|
||||
}
|
||||
} else if (0==strcmp(word,"date")) {
|
||||
word = strtok(NULL,delimiter);
|
||||
if (!word) {
|
||||
time_rtc = rtc_get_counter_val(); // get time from internal RTC
|
||||
time_tm = localtime(&time_rtc); // convert time
|
||||
printf("date: %d-%02d-%02d\n", 1900+time_tm->tm_year, time_tm->tm_mon+1, time_tm->tm_mday);
|
||||
} else if (strlen(word)!=10 || word[0]!='2' || word[1]!='0' || word[2]<'0' || word[2]>'9' || word[3]<'0' || word[3]>'9' || word[5]<'0' || word[5]>'1' || word[6]<'0' || word[6]>'9' || word[8]<'0' || word[8]>'3' || word[9]<'0' || word[9]>'9') {
|
||||
goto error;
|
||||
} else {
|
||||
time_rtc = rtc_get_counter_val(); // get time from internal RTC
|
||||
time_tm = localtime(&time_rtc); // convert time
|
||||
time_tm->tm_year = ((word[0]-'0')*1000+(word[1]-'0')*100+(word[2]-'0')*10+(word[3]-'0')*1)-1900; // set year
|
||||
time_tm->tm_mon = (word[5]-'0')*10+(word[6]-'0')*1-1; // set month
|
||||
time_tm->tm_mday = (word[8]-'0')*10+(word[9]-'0')*1; // set day
|
||||
time_rtc = mktime(time_tm); // get back seconds
|
||||
rtc_set_counter_val(time_rtc); // save time to internal RTC
|
||||
printf("date set\n");
|
||||
}
|
||||
} else if (0==strcmp(word,"r") || 0==strcmp(word,"reset")) {
|
||||
scb_reset_system(); // reset device
|
||||
while (true); // wait for the reset to happen
|
||||
} else {
|
||||
goto error;
|
||||
// don't handle empty lines
|
||||
if (!str || 0==strlen(str)) {
|
||||
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");
|
||||
}
|
||||
|
||||
return; // command successfully processed
|
||||
error:
|
||||
printf("command not recognized. enter help to list commands\n");
|
||||
return;
|
||||
}
|
||||
|
||||
/** program entry point
|
||||
|
|
@ -177,10 +240,9 @@ error:
|
|||
*/
|
||||
void main(void);
|
||||
void main(void)
|
||||
{
|
||||
{
|
||||
rcc_clock_setup_in_hse_8mhz_out_72mhz(); // use 8 MHz high speed external clock to generate 72 MHz internal clock
|
||||
|
||||
|
||||
#if DEBUG
|
||||
// enable functionalities for easier debug
|
||||
DBGMCU_CR |= DBGMCU_CR_IWDG_STOP; // stop independent watchdog counter when code is halted
|
||||
|
|
@ -197,17 +259,17 @@ void main(void)
|
|||
board_setup(); // setup board
|
||||
uart_setup(); // setup USART (for printing)
|
||||
usb_cdcacm_setup(); // setup USB CDC ACM (for printing)
|
||||
printf("welcome to the CuVoodoo STM32F1 example application\n"); // print welcome message
|
||||
printf("\nwelcome to the CuVoodoo STM32F1 example application\n"); // print welcome message
|
||||
|
||||
#if !(DEBUG)
|
||||
// show watchdog information
|
||||
printf("watchdog set to (%.2fs)\n",WATCHDOG_PERIOD/1000.0);
|
||||
printf("setup watchdog: %.2fs",WATCHDOG_PERIOD/1000.0);
|
||||
if (FLASH_OBR&FLASH_OBR_OPTERR) {
|
||||
printf("option bytes not set in flash: software wachtdog used (not started at reset)\n");
|
||||
printf(" (option bytes not set in flash: software wachtdog used, not automatically started at reset)\n");
|
||||
} else if (FLASH_OBR&FLASH_OBR_WDG_SW) {
|
||||
printf("software wachtdog used (not started at reset)\n");
|
||||
printf(" (software wachtdog used, not automatically started at reset)\n");
|
||||
} else {
|
||||
printf("hardware wachtdog used (started at reset)\n");
|
||||
printf(" (hardware wachtdog used, automatically started at reset)\n");
|
||||
}
|
||||
#endif
|
||||
|
||||
|
|
@ -218,41 +280,21 @@ void main(void)
|
|||
nvic_enable_irq(NVIC_RTC_IRQ); // allow the RTC to interrupt
|
||||
printf("OK\n");
|
||||
|
||||
time_rtc= rtc_get_counter_val(); // get time from internal RTC
|
||||
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+1, time_tm->tm_mday, time_tm->tm_hour, time_tm->tm_min, time_tm->tm_sec);
|
||||
// setup terminal
|
||||
terminal_prefix = ""; // set default prefix
|
||||
terminal_process = &process_command; // set central function to process commands
|
||||
terminal_setup(); // start terminal
|
||||
|
||||
// main loop
|
||||
printf("command input: ready\n");
|
||||
// start main loop
|
||||
bool action = false; // if an action has been performed don't go to sleep
|
||||
button_flag = false; // reset button flag
|
||||
char c = '\0'; // to store received character
|
||||
bool char_flag = false; // a new character has been received
|
||||
while (true) { // infinite loop
|
||||
iwdg_reset(); // kick the dog
|
||||
while (user_input_available) { // user input is available
|
||||
action = true; // action has been performed
|
||||
led_toggle(); // toggle LED
|
||||
c = user_input_get(); // store receive character
|
||||
char_flag = true; // notify character has been received
|
||||
}
|
||||
while (char_flag) { // user data received
|
||||
char_flag = false; // reset flag
|
||||
action = true; // action has been performed
|
||||
//printf("%c",c); // echo receive character
|
||||
printf("%02x\n",c);
|
||||
if (c=='\r' || c=='\n') { // end of command received
|
||||
if (command_i>0) { // there is a command to process
|
||||
command[command_i] = 0; // end string
|
||||
command_i = 0; // prepare for next command
|
||||
process_command(command); // process user command
|
||||
}
|
||||
} else { // user command input
|
||||
command[command_i] = c; // save command input
|
||||
if (command_i<LENGTH(command)-2) { // verify if there is place to save next character
|
||||
command_i++; // save next character
|
||||
}
|
||||
}
|
||||
char c = user_input_get(); // store receive character
|
||||
terminal_send(c); // send received character to terminal
|
||||
}
|
||||
while (button_flag) { // user pressed button
|
||||
action = true; // action has been performed
|
||||
|
|
@ -269,11 +311,6 @@ void main(void)
|
|||
#if !defined(BLUE_PILL) // on the blue pill the LED is close to the 32.768 kHz oscillator and heavily influences it
|
||||
led_toggle(); // toggle LED (good to indicate if main function is stuck)
|
||||
#endif
|
||||
time_rtc = rtc_get_counter_val(); // get time from internal RTC (seconds since Unix Epoch)
|
||||
time_tm = localtime(&time_rtc); // get time in tm format from Epoch (time zones are not handled for non-POSIX environments)
|
||||
if (0==time_tm->tm_sec) { // new minute
|
||||
printf("time: %02d:%02d:%02d\n", time_tm->tm_hour, time_tm->tm_min, time_tm->tm_sec);
|
||||
}
|
||||
}
|
||||
if (action) { // go to sleep if nothing had to be done, else recheck for activity
|
||||
action = false;
|
||||
|
|
|
|||
Loading…
Reference in New Issue