4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
34 * \brief Implementation of the command protocol between the board and the host
39 * \author Giovanni Bajo <rasky@develer.com>
40 * \author Marco Benelli <marco@develer.com>
41 * \author Bernie Innocenti <bernie@codewiz.org>
42 * \author Daniele Basile <asterix@develer.com>
46 #include "cmd_ctor.h" // MAKE_CMD, REGISTER_CMD
48 #include "hw/hw_adc.h"
49 #include "hw/hw_input.h"
51 #include <drv/timer.h>
55 #include <drv/buzzer.h>
57 #include <mware/readline.h>
58 #include <mware/parser.h>
60 #include <cfg/compiler.h>
61 #include <cfg/debug.h>
63 #include <kern/kfile.h>
68 // Define the format string for ADC
69 #define ADC_FORMAT_STR "dddd"
71 // DEBUG: set to 1 to force interactive mode
72 #define FORCE_INTERACTIVE 1
75 * True if we are in interactive mode, false if we are in protocol mode.
76 * In interactive mode, commands are read through readline() (prompt,
77 * completion, history) without IDs, and replies/errors are sent to the serial
79 * In protocol mode, we implement the default protocol
81 static bool interactive;
83 /// Readline context, used for interactive mode.
84 static struct RLContext rl_ctx;
86 uint8_t reg_status_dout;
88 * Send a NAK asking the host to send the current message again.
90 * \a fd kfile handler for serial.
91 * \a err human-readable description of the error for debug purposes.
93 INLINE void NAK(KFile *fd, const char *err)
96 kfile_printf(fd, "NAK \"%s\"\r\n", err);
98 kfile_printf(fd, "NAK\r\n");
102 static void protocol_prompt(KFile *fd)
104 kfile_print(fd, ">> ");
108 * Print args on s, with format specified in t->result_fmt.
109 * Return number of valid arguments or -1 in case of error.
111 static bool protocol_reply(KFile *fd, const struct CmdTemplate *t,
114 unsigned short offset = strlen(t->arg_fmt) + 1;
115 unsigned short nres = strlen(t->result_fmt);
117 for (unsigned short i = 0; i < nres; ++i)
119 if (t->result_fmt[i] == 'd')
121 kfile_printf(fd, " %ld", args[offset+i].l);
123 else if (t->result_fmt[i] == 's')
125 kfile_printf(fd, " %s", args[offset+i].s);
133 kfile_printf(fd, "\r\n");
137 static void protocol_parse(KFile *fd, const char *buf)
139 const struct CmdTemplate *templ;
142 templ = parser_get_cmd_template(buf);
145 kfile_print(fd, "-1 Invalid command.\r\n");
150 parms args[PARSER_MAX_ARGS];
152 /* Args Check. TODO: Handle different case. see doc/PROTOCOL . */
153 if (!parser_get_cmd_arguments(buf, templ, args))
155 kfile_print(fd, "-2 Invalid arguments.\r\n");
161 if(!parser_execute_cmd(templ, args))
163 NAK(fd, "Error in executing command.");
165 if (!protocol_reply(fd, templ, args))
167 NAK(fd, "Invalid return format.");
174 void protocol_run(KFile *fd)
177 * \todo to be removed, we could probably access the serial FIFO
180 static char linebuf[80];
184 kfile_gets(fd, linebuf, sizeof(linebuf));
186 // reset serial port error anyway
189 // check message minimum length
192 /* If we enter lines beginning with sharp(#)
193 they are stripped out from commands */
194 if(linebuf[0] != '#')
196 if (linebuf[0] == 0x1B && linebuf[1] == 0x1B) // ESC
199 kfile_printf(fd, "Entering interactive mode\r\n");
203 protocol_parse(fd, linebuf);
213 * Read a line from serial. We use a temporary buffer
214 * because otherwise we would have to extract a message
215 * from the port immediately: there might not be any
216 * available, and one might get free while we read
217 * the line. We also add a fake ID at the start to
220 buf = rl_readline(&rl_ctx);
222 /* If we enter lines beginning with sharp(#)
223 they are stripped out from commands */
224 if(buf && buf[0] != '#')
228 // exit special case to immediately change serial input
229 if (!strcmp(buf, "exit") || !strcmp(buf, "quit"))
231 rl_clear_history(&rl_ctx);
232 kfile_printf(fd, "Leaving interactive mode...\r\n");
233 interactive = FORCE_INTERACTIVE;
237 //TODO: remove sequence numbers
241 strncpy(linebuf + 2, buf, sizeof(linebuf) - 3);
242 linebuf[sizeof(linebuf) - 1] = '\0';
243 protocol_parse(fd, linebuf);
252 * TODO: Command declarations and definitions should be in another file(s).
253 * Maybe we should use CMD_HUNK_TEMPLATE.
257 MAKE_CMD(ver, "", "ddd",
259 args[1].l = VERS_MAJOR;
260 args[2].l = VERS_MINOR;
261 args[3].l = VERS_REV;
265 /* Sleep. Example of declaring function body directly in macro call. */
266 MAKE_CMD(sleep, "d", "",
268 timer_delay((mtime_t)args[1].l);
273 MAKE_CMD(ping, "", "",
275 //Silence "args not used" warning.
281 MAKE_CMD(dout, "d", "",
283 sipo_putchar((uint8_t)args[1].l);
285 //Store status of dout ports.
286 reg_status_dout = (uint8_t)args[1].l;
290 /* rdout read the status of out ports.*/
291 MAKE_CMD(rdout, "", "d",
293 args[1].l = reg_status_dout;
299 MAKE_CMD(reset, "", "",
301 //Silence "args not used" warning.
306 /*We want to have an infinite loop that lock access on watchdog timer.
307 This piece of code it's equivalent to a while(true), but we have done this because
308 gcc generate a warning message that suggest to use "noreturn" parameter in function reset.*/
316 MAKE_CMD(din, "", "d",
318 args[1].l = INPUT_GET();
325 MAKE_CMD(ain, "", ADC_FORMAT_STR,
327 STATIC_ASSERT((sizeof(ADC_FORMAT_STR) - 1) == ADC_CHANNEL_NUM);
328 for(int i = 0; i < ADC_CHANNEL_NUM; i++)
329 args[i+1].l = adc_read_ai_channel(i);
335 MAKE_CMD(beep, "d", "",
341 /* Register commands. */
342 static void protocol_registerCmds(void)
348 //Set off all dout ports.
357 /* Initialization: readline context, parser and register commands. */
358 void protocol_init(KFile *fd)
360 interactive = FORCE_INTERACTIVE;
362 rl_init_ctx(&rl_ctx);
363 //rl_setprompt(&rl_ctx, ">> ");
364 rl_sethook_get(&rl_ctx, (getc_hook)kfile_getc, fd);
365 rl_sethook_put(&rl_ctx, (putc_hook)kfile_putc, fd);
366 rl_sethook_match(&rl_ctx, parser_rl_match, NULL);
367 rl_sethook_clear(&rl_ctx, (clear_hook)kfile_clearerr,fd);
371 protocol_registerCmds();