RIOT/sys/shell/cmds/rtt.c

/*
 * Copyright (C) 2020 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @ingroup     sys_shell_commands
 * @{
 *
 * @file
 * @brief       Shell command implementation for the peripheral rtt interface
 *
 * @author  Gunar Schorcht <gunar@schorcht.net>
 *
 * @}
 */

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <stdlib.h>
#include <inttypes.h>

#include "periph/rtt.h"
#include "shell.h"

/*
 * Since some RTT implementations do not implement all API functions, default
 * dummy functions are required to avoid compilation errors.
 */

static inline void _rtt_cmd_not_supported(void)
{
    puts("Command not supported by used RTT implementation.\n");
}

__attribute__((weak)) void rtt_init(void)
{
    _rtt_cmd_not_supported();
}

__attribute__((weak)) void rtt_set_overflow_cb(rtt_cb_t cb, void *arg)
{
    (void)cb;
    (void)arg;
    _rtt_cmd_not_supported();
}

__attribute__((weak)) void rtt_clear_overflow_cb(void)
{
    _rtt_cmd_not_supported();
}

__attribute__((weak)) uint32_t rtt_get_counter(void)
{
    _rtt_cmd_not_supported();
    return 0;
}

__attribute__((weak)) void rtt_set_counter(uint32_t counter)
{
    (void)counter;
    _rtt_cmd_not_supported();
}

__attribute__((weak)) void rtt_set_alarm(uint32_t alarm, rtt_cb_t cb, void *arg)
{
    (void)alarm;
    (void)cb;
    (void)arg;
    _rtt_cmd_not_supported();
}

__attribute__((weak)) uint32_t rtt_get_alarm(void)
{
    _rtt_cmd_not_supported();
    return 0;
}

__attribute__((weak)) void rtt_clear_alarm(void)
{
    _rtt_cmd_not_supported();
}

__attribute__((weak)) void rtt_poweron(void)
{
    _rtt_cmd_not_supported();
}

__attribute__((weak)) void rtt_poweroff(void)
{
    _rtt_cmd_not_supported();
}

static void _alarm_handler(void *arg)
{
    (void) arg;
    puts("The alarm rang");
}

static void _overflow_handler(void *arg)
{
    (void) arg;
    puts("RTT overflow");
}

static int _rtt_cmd_get_alarm(void)
{
    printf("%" PRIu32 "\n", rtt_get_alarm());
    return 0;
}

static int _rtt_cmd_set_alarm(char **argv)
{
    uint32_t alarm = strtoul(argv[0], NULL, 10);
    rtt_set_alarm(alarm, _alarm_handler, NULL);
    return 0;
}

static int _rtt_cmd_get_counter(void)
{
    printf("%" PRIu32 "\n", rtt_get_counter());
    return 0;
}

static int _rtt_cmd_set_counter(char **argv)
{
    uint32_t counter = strtoul(argv[0], NULL, 10);
    rtt_set_counter(counter);
    return 0;
}

static int _rtt_cmd_usage(void)
{
    puts("usage: rtt <command> [arguments]");
    puts("commands:");
    puts("\tinit\t\tinit the interface");
    puts("\tpoweron\t\tpower the interface on");
    puts("\tpoweroff\tpower the interface off");
    puts("\tclearoverflow\tdeactivate the overflow interrupt");
    puts("\tsetoverflow\tset the overflow interrupt");
    puts("\tclearalarm\tdeactivate the alarm");
    puts("\tgetalarm\tprint the current alarm counter value");
    puts("\tsetalarm <val>\tset an alarm for the specified counter value");
    puts("\tget\t\tprint the current counter value");
    puts("\tset\t\tset the current counter value");
    return 0;
}

static int _rtt_handler(int argc, char **argv)
{
    if (argc < 2) {
        _rtt_cmd_usage();
        return 1;
    }
    else if (strncmp(argv[1], "init", 4) == 0) {
        rtt_init();
    }
    else if (strncmp(argv[1], "poweron", 7) == 0) {
        rtt_poweron();
    }
    else if (strncmp(argv[1], "poweroff", 8) == 0) {
        rtt_poweroff();
    }
    else if (strncmp(argv[1], "clearoverflow", 13) == 0) {
        rtt_clear_overflow_cb();
    }
    else if (strncmp(argv[1], "setoverflow", 11) == 0) {
        rtt_set_overflow_cb(_overflow_handler, NULL);
    }
    else if (strncmp(argv[1], "clearalarm", 10) == 0) {
        rtt_clear_alarm();
    }
    else if (strncmp(argv[1], "getalarm", 8) == 0) {
        _rtt_cmd_get_alarm();
    }
    else if ((strncmp(argv[1], "setalarm", 8) == 0) && (argc == 3)) {
        _rtt_cmd_set_alarm(argv + 2);
    }
    else if (strncmp(argv[1], "get", 3) == 0) {
        _rtt_cmd_get_counter();
    }
    else if ((strncmp(argv[1], "set", 3) == 0)  && (argc == 3)) {
        _rtt_cmd_set_counter(argv + 2);
    }
    else {
        printf("unknown command or missing parameters: %s\n\n", argv[1]);
        _rtt_cmd_usage();
        return 1;
    }
    return 0;
}

SHELL_COMMAND(rtt, "control RTT peripheral interface",  _rtt_handler);