protocol.c

Go to the documentation of this file.

#include "protocol.h"
#include "cmd_ctor.h"  // MAKE_CMD, REGISTER_CMD
#include "verstag.h"
#include "hw/hw_adc.h"
#include "hw/hw_input.h"

#include <drv/timer.h>
#include <drv/ser.h>
#include <drv/sipo.h>
#include <drv/wdt.h>
#include <drv/buzzer.h>

#include <mware/readline.h>
#include <mware/parser.h>

#include <cfg/compiler.h>
#include <cfg/debug.h>

#include <kern/kfile.h>

#include <stdlib.h>
#include <string.h>

// Define the format string for ADC
#define ADC_FORMAT_STR "dddd"

// DEBUG: set to 1 to force interactive mode
#define FORCE_INTERACTIVE         1

static bool interactive;

static struct RLContext rl_ctx;

uint8_t reg_status_dout;
INLINE void NAK(KFile *fd, const char *err)
{
#ifdef _DEBUG
    kfile_printf(fd, "NAK \"%s\"\r\n", err);
#else
    kfile_printf(fd, "NAK\r\n");
#endif
}

static void protocol_prompt(KFile *fd)
{
    kfile_print(fd, ">> ");
}

/*
 * Print args on s, with format specified in t->result_fmt.
 * Return number of valid arguments or -1 in case of error.
 */
static bool protocol_reply(KFile *fd, const struct CmdTemplate *t,
              const parms *args)
{
    unsigned short offset = strlen(t->arg_fmt) + 1;
    unsigned short nres = strlen(t->result_fmt);

    for (unsigned short i = 0; i < nres; ++i)
    {
        if (t->result_fmt[i] == 'd')
        {
            kfile_printf(fd, " %ld", args[offset+i].l);
        }
        else if (t->result_fmt[i] == 's')
        {
            kfile_printf(fd, " %s", args[offset+i].s);
        }

        else
        {
            abort();
        }
    }
    kfile_printf(fd, "\r\n");
    return true;
}

static void protocol_parse(KFile *fd, const char *buf)
{
    const struct CmdTemplate *templ;

    /* Command check.  */
    templ = parser_get_cmd_template(buf);
    if (!templ)
    {
        kfile_print(fd, "-1 Invalid command.\r\n");
        protocol_prompt(fd);
        return;
    }

    parms args[PARSER_MAX_ARGS];

    /* Args Check.  TODO: Handle different case. see doc/PROTOCOL .  */
    if (!parser_get_cmd_arguments(buf, templ, args))
    {
        kfile_print(fd, "-2 Invalid arguments.\r\n");
        protocol_prompt(fd);
        return;
    }

    /* Execute. */
    if(!parser_execute_cmd(templ, args))
    {
        NAK(fd, "Error in executing command.");
    }
    if (!protocol_reply(fd, templ, args))
    {
        NAK(fd, "Invalid return format.");
    }

    protocol_prompt(fd);
    return;
}

void protocol_run(KFile *fd)
{
    static char linebuf[80];

    if (!interactive)
    {
        kfile_gets(fd, linebuf, sizeof(linebuf));

        // reset serial port error anyway
        kfile_clearerr(fd);

        // check message minimum length
        if (linebuf[0])
        {
            /* If we enter lines beginning with sharp(#)
            they are stripped out from commands */
            if(linebuf[0] != '#')
            {
                if (linebuf[0] == 0x1B && linebuf[1] == 0x1B)  // ESC
                {
                    interactive = true;
                    kfile_printf(fd, "Entering interactive mode\r\n");
                }
                else
                {
                    protocol_parse(fd, linebuf);
                }
            }
        }
    }
    else
    {
        const char *buf;

        /*
         * Read a line from serial. We use a temporary buffer
         * because otherwise we would have to extract a message
         * from the port immediately: there might not be any
         * available, and one might get free while we read
         * the line. We also add a fake ID at the start to
         * fool the parser.
         */
        buf = rl_readline(&rl_ctx);

        /* If we enter lines beginning with sharp(#)
        they are stripped out from commands */
        if(buf && buf[0] != '#')
        {
            if (buf[0] != '\0')
            {
                // exit special case to immediately change serial input
                if (!strcmp(buf, "exit") || !strcmp(buf, "quit"))
                {
                    rl_clear_history(&rl_ctx);
                    kfile_printf(fd, "Leaving interactive mode...\r\n");
                    interactive = FORCE_INTERACTIVE;
                }
                else
                {
                    //TODO: remove sequence numbers
                    linebuf[0] = '0';
                    linebuf[1] = ' ';

                    strncpy(linebuf + 2, buf, sizeof(linebuf) - 3);
                    linebuf[sizeof(linebuf) - 1] = '\0';
                    protocol_parse(fd, linebuf);
                }
            }
        }
    }
}

/*
 * Commands.
 * TODO: Command declarations and definitions should be in another file(s).
 * Maybe we should use CMD_HUNK_TEMPLATE.
 *
 */

MAKE_CMD(ver, "", "ddd",
({
    args[1].l = VERS_MAJOR;
    args[2].l = VERS_MINOR;
    args[3].l = VERS_REV;
    0;
}), 0);

/* Sleep. Example of declaring function body directly in macro call.  */
MAKE_CMD(sleep, "d", "",
({
    timer_delay((mtime_t)args[1].l);
    0;
}), 0)

/* Ping.  */
MAKE_CMD(ping, "", "",
({
    //Silence "args not used" warning.
    (void)args;
    0;
}), 0)

/* Dout  */
MAKE_CMD(dout, "d", "",
({
    sipo_putchar((uint8_t)args[1].l);

    //Store status of dout ports.
    reg_status_dout = (uint8_t)args[1].l;
    0;
}), 0)

/* rdout  read the status of out ports.*/
MAKE_CMD(rdout, "", "d",
({
    args[1].l = reg_status_dout;
    0;
}), 0)


/* Reset */
MAKE_CMD(reset, "", "",
({
    //Silence "args not used" warning.
    (void)args;
    wdt_init(7);
    wdt_start();

    /*We want to have an infinite loop that lock access on watchdog timer.
    This piece of code it's equivalent to a while(true), but we have done this because
    gcc generate a warning message that suggest to use "noreturn" parameter in function reset.*/
    ASSERT(args);
    while(args);
    0;

}), 0)

/* Din */
MAKE_CMD(din, "", "d",
({
    args[1].l = INPUT_GET();
    0;
}), 0)



/* Ain */
MAKE_CMD(ain, "", ADC_FORMAT_STR,
({
    STATIC_ASSERT((sizeof(ADC_FORMAT_STR) - 1) == ADC_CHANNEL_NUM);
    for(int i = 0; i < ADC_CHANNEL_NUM; i++)
        args[i+1].l = adc_read_ai_channel(i);

    0;
}), 0)

/* Beep  */
MAKE_CMD(beep, "d", "",
({
    buz_beep(args[1].l);
    0;
}), 0)

/* Register commands.  */
static void protocol_registerCmds(void)
{
    REGISTER_CMD(ver);
    REGISTER_CMD(sleep);
    REGISTER_CMD(ping);
    REGISTER_CMD(dout);
    //Set off all dout ports.
    reg_status_dout = 0;
    REGISTER_CMD(rdout);
    REGISTER_CMD(reset);
    REGISTER_CMD(din);
    REGISTER_CMD(ain);
    REGISTER_CMD(beep);
}

/* Initialization: readline context, parser and register commands.  */
void protocol_init(KFile *fd)
{
    interactive = FORCE_INTERACTIVE;

    rl_init_ctx(&rl_ctx);
    //rl_setprompt(&rl_ctx, ">> ");
    rl_sethook_get(&rl_ctx, (getc_hook)kfile_getc, fd);
    rl_sethook_put(&rl_ctx, (putc_hook)kfile_putc, fd);
    rl_sethook_match(&rl_ctx, parser_rl_match, NULL);
    rl_sethook_clear(&rl_ctx, (clear_hook)kfile_clearerr,fd);

    parser_init();

    protocol_registerCmds();

    protocol_prompt(fd);
}