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, 2012 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
34 * \brief Protocol module.
36 * This module supply a simple ascii protocol to send commands to
37 * the device like pc "terminal". To use it we need to define all command
38 * that we want supply, and then we should register they using a user defined
39 * function. All commands can take arguments or/and return a value.
42 * #include "verstag.h"
43 * #include <mware/parser.h>
45 * //Define a function ver, that return 3 int.
46 * //This macro will expand into a fuction named "ver" that not take
47 * //an input and return 3 int (ddd).
48 * MAKE_CMD(ver, "", "ddd",
50 * args[1].l = VERS_MAJOR;
51 * args[2].l = VERS_MINOR;
52 * args[3].l = VERS_REV;
57 * //Define the function to pass at protocol_init, to register
58 * //all defined protocol function.
59 * static void protocol_registerCmds(void)
65 * //Init the protocol module whit comunication channel and
66 * //the callback to register the defined protocol functions.
67 * protocol_init(&socket.fd, protocol_registerCmds);
70 * \author Giovanni Bajo <rasky@develer.com>
71 * \author Marco Benelli <marco@develer.com>
72 * \author Bernie Innocenti <bernie@codewiz.org>
73 * \author Daniele Basile <asterix@develer.com>
78 #include "cfg/cfg_parser.h"
80 #include <cfg/compiler.h>
81 #include <cfg/debug.h>
83 #include <drv/timer.h>
85 #include <mware/readline.h>
86 #include <mware/parser.h>
93 // DEBUG: set to 1 to force interactive mode
94 #define FORCE_INTERACTIVE 1
97 * True if we are in interactive mode, false if we are in protocol mode.
98 * In interactive mode, commands are read through readline() (prompt,
99 * completion, history) and replies/errors are sent to the output channel.
100 * In protocol mode, we implement the default protocol
102 static bool interactive;
104 /// Readline context, used for interactive mode.
105 static struct RLContext rl_ctx;
108 * Send a NAK asking the host to send the current message again.
110 * \a fd kfile handler for serial.
111 * \a err human-readable description of the error for debug purposes.
113 INLINE void NAK(KFile *fd, const char *err)
116 kfile_printf(fd, "NAK \"%s\"\r\n", err);
118 kfile_printf(fd, "NAK\r\n");
122 static void protocol_prompt(KFile *fd)
124 kfile_print(fd, ">> ");
128 * Print args on s, with format specified in t->result_fmt.
129 * Return number of valid arguments or -1 in case of error.
131 static bool protocol_reply(KFile *fd, const struct CmdTemplate *t, const parms *args)
133 unsigned short offset = strlen(t->arg_fmt) + 1;
134 unsigned short nres = strlen(t->result_fmt);
136 for (unsigned short i = 0; i < nres; ++i)
138 if (t->result_fmt[i] == 'd')
140 kfile_printf(fd, " %ld", args[offset+i].l);
142 else if (t->result_fmt[i] == 's')
144 kfile_printf(fd, " %s", args[offset+i].s);
153 kfile_printf(fd, "\r\n");
157 static void protocol_parse(KFile *fd, const char *buf)
159 const struct CmdTemplate *templ;
162 templ = parser_get_cmd_template(buf);
165 kfile_print(fd, "-1 Invalid command.\r\n");
170 parms args[CONFIG_PARSER_MAX_ARGS];
172 /* Args Check. TODO: Handle different case. see doc/PROTOCOL . */
173 if (!parser_get_cmd_arguments(buf, templ, args))
175 kfile_print(fd, "-2 Invalid arguments.\r\n");
181 if(!parser_execute_cmd(templ, args))
183 NAK(fd, "Error in executing command.");
185 if (!protocol_reply(fd, templ, args))
187 NAK(fd, "Invalid return format.");
194 void protocol_run(KFile *fd)
196 static char linebuf[80];
200 kfile_gets(fd, linebuf, sizeof(linebuf));
202 /* Clear errors on channel */
205 /* check message minimum length */
208 /* If we enter lines beginning with sharp(#)
209 they are stripped out from commands */
210 if(linebuf[0] != '#')
212 if (linebuf[0] == 0x1B && linebuf[1] == 0x1B) // ESC
215 kfile_printf(fd, "Entering interactive mode\r\n");
219 protocol_parse(fd, linebuf);
229 * Read a line from channel. We use a temporary buffer
230 * because otherwise we would have to extract a message
231 * from the port immediately: there might not be any
232 * available, and one might get free while we read
233 * the line. We also add a fake ID at the start to
236 buf = rl_readline(&rl_ctx);
238 /* If we enter lines beginning with sharp(#)
239 they are stripped out from commands */
240 if(buf && buf[0] != '#')
244 // exit special case to immediately change serial input
245 if (!strcmp(buf, "exit") || !strcmp(buf, "quit"))
247 rl_clear_history(&rl_ctx);
248 kfile_printf(fd, "Leaving interactive mode...\r\n");
249 interactive = FORCE_INTERACTIVE;
253 //TODO: remove sequence numbers
257 strncpy(linebuf + 2, buf, sizeof(linebuf) - 3);
258 linebuf[sizeof(linebuf) - 1] = '\0';
259 protocol_parse(fd, linebuf);
267 /* Initialization: readline context, parser and register commands. */
268 void protocol_init(KFile *fd, protocol_t cmds_register)
270 interactive = FORCE_INTERACTIVE;
272 rl_init_ctx(&rl_ctx);
273 //rl_setprompt(&rl_ctx, ">> ");
274 rl_sethook_get(&rl_ctx, (getc_hook)kfile_getc, fd);
275 rl_sethook_put(&rl_ctx, (putc_hook)kfile_putc, fd);
276 rl_sethook_match(&rl_ctx, parser_rl_match, NULL);
277 rl_sethook_clear(&rl_ctx, (clear_hook)kfile_clearerr,fd);
280 ASSERT(cmds_register);