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, 2006 Develer S.r.l. (http://www.develer.com/)
30 * All Rights Reserved.
35 * \author Bernardo Innocenti <bernie@develer.com>
36 * \author Stefano Fedrigo <aleph@develer.com>
37 * \author Giovanni Bajo <rasky@develer.com>
39 * \brief Serial protocol parser and commands.
41 * This file contains the serial protocol parser and
42 * the definition of the protocol commands. Commands are defined
43 * in a "CmdTemplate" type array, containing:
44 * - the name of the command,
45 * - the arguments it expects to receive,
46 * - the output values,
47 * - the name of the function implementing the command.
49 * The arguments and results are passed to command function
50 * using an union: the element of the union to use for each
51 * argument is determined by format strings present in the
59 #include <stdlib.h> // atol(), NULL
60 #include <string.h> // strchr(), strcmp()
62 #include <mware/hashtable.h>
64 #include "appconfig.h"
69 #define MAX_COMMANDS_NUMBER 128 // 64
71 /// Hashtable hook to extract the key from a command
72 static const void* get_key_from_command(const void* cmd, uint8_t* length);
74 /// Hashtable that handles the commands that can be executed
75 DECLARE_HASHTABLE_STATIC(commands, MAX_COMMANDS_NUMBER, get_key_from_command);
79 * \brief Tokenize one word at a time from a text.
81 * This function is similar to strtok, but does not use any implicit
82 * context, nor it does modify the input buffer in any form.
83 * The word is returned as a STL-like [begin,end) range.
85 * To extract the first word, make both begin and end point at the
86 * start of the text, and call the function. Then, subsequent
87 * calls will return the following words (assuming the begin/end
88 * variable are not modified between calls).
90 * \param begin Will contain the index of the first character of the word
91 * \param end Will contain the index of the character after the last
92 * character of the word
94 * \return True if a word was extracted, false if we got to the end
95 * of the string without extracting any word.
97 static bool get_word(const char **begin, const char **end)
99 const char *cur = *end;
101 while ((*cur == ' ' || *cur == '\t') && *cur)
106 while ((*cur != ' ' && *cur != '\t') && *cur)
111 return (*end != *begin);
116 * \brief Command arguments parser.
118 * Using the format pointed by the argument fmt
119 * parses the input string filling the array argv
120 * with input parameters of the correct type.
122 * \param fmt Parameters format string.
123 * \param input Input string.
124 * \param argv Array filled with parameters.
126 * \return False in case of errors, otherwise true.
128 static bool parseArgs(const char *fmt, const char *input, parms argv[])
130 const char *begin = input, *end = input;
134 // Extract the argument
135 if (!get_word(&begin, &end))
141 (*argv++).l = atol(begin);
149 ASSERT2(0, "Unknown format for argument");
156 /* check if there are remaining args */
157 if (get_word(&begin, &end))
166 * \brief Command result formatting and printing.
168 * Prints out on device fd the values contained
169 * in the array result, using the format specified
172 * \param ser Serial handle.
173 * \param fmt Values format string.
174 * \param result Array containing result to be printed.
176 * \return -1 in case of errors, otherwise 0.
178 static int printResult(struct Serial *ser, const char *fmt, parms result[])
185 if (*fmt >= '0' && *fmt <= '9')
187 /* Collect repeat count digit (left to right order) */
188 repeat_cnt = (repeat_cnt * 10) + (*fmt - '0');
192 /* Set default repeat cnt of 1 when not specified */
196 /* Loop repeat_cnt times */
202 ser_printf(ser, ARG_SEP_S "%ld", (*result).l);
206 ser_print(ser, ARG_SEP_S);
207 ser_print(ser, (*result).s);
211 ser_printf(ser, ARG_SEP_S "%s", (*result).s);
216 ser_printf(ser, ARG_SEP_S "%ld", n);
218 ser_printf(ser, ARG_SEP_S "%ld", (*result).l);
226 while (--repeat_cnt);
229 /* Skip to next format char */
235 ser_print(ser, "\r\n");
238 #endif /* UNUSED_CODE */
240 /// Hook provided by the parser for matching of command names (TAB completion) for readline
241 const char* parser_rl_match(UNUSED_ARG(void *,dummy), const char *word, int word_len)
244 HashIterator end = ht_iter_end(&commands);
245 const char *found = NULL;
247 for (cur = ht_iter_begin(&commands);
248 !ht_iter_cmp(cur, end);
249 cur = ht_iter_next(cur))
251 const struct CmdTemplate* cmdp = (const struct CmdTemplate*)ht_iter_get(cur);
252 if (strncmp(cmdp->name, word, word_len) == 0)
254 // If there was another matching word, it means that we have a multiple
255 // match: then return NULL.
266 bool parser_get_cmd_id(const char* line, unsigned long* ID)
268 const char *begin = line, *end = line;
271 // The first word is the ID
272 if (!get_word(&begin, &end))
275 *ID = strtoul(begin, &end2, 10);
282 const struct CmdTemplate* parser_get_cmd_template(const char *input)
284 // const struct CmdTemplate *cmdp;
286 const char *begin = input, *end = input;
288 // Skip the ID, and get the command
289 if (!get_word(&begin, &end))
291 if (!get_word(&begin, &end))
294 return (const struct CmdTemplate*)ht_find(&commands, begin, end-begin);
297 static const char *skip_to_params(const char *input, const struct CmdTemplate *cmdp)
299 const char *begin = input, *end = input;
301 // Skip the ID, and get the command
302 if (!get_word(&begin, &end))
304 if (!get_word(&begin, &end))
307 ASSERT2(strlen(cmdp->name) == (size_t)(end-begin), "Invalid command template specified");
308 ASSERT2(!strncmp(begin, cmdp->name, end-begin), "Invalid command template specified");
313 bool parser_get_cmd_arguments(const char* input, const struct CmdTemplate* cmdp, parms args[PARSER_MAX_ARGS])
315 input = skip_to_params(input, cmdp);
319 args[0].s = cmdp->name;
320 if (!parseArgs(cmdp->arg_fmt, input, args + 1))
326 static const void* get_key_from_command(const void* cmd, uint8_t* length)
328 const struct CmdTemplate* c = cmd;
329 *length = strlen(c->name);
333 bool parser_process_line(const char* input)
335 const struct CmdTemplate *cmdp;
336 parms args[PARSER_MAX_ARGS];
338 cmdp = parser_get_cmd_template(input);
342 if (!parser_get_cmd_arguments(input, cmdp, args))
345 if (!parser_execute_cmd(cmdp, args))
351 void parser_register_cmd(const struct CmdTemplate* cmd)
353 ht_insert(&commands, cmd);
356 #if CONFIG_INTERNAL_COMMANDS
357 static ResultCode cmd_help(void)
361 // FIXME: There is no way at the moment to access the serial port. Dump
362 // this through JTAG for now
363 for (HashIterator iter = ht_iter_begin(&commands);
364 !ht_iter_cmp(iter, ht_iter_end(&commands));
365 iter = ht_iter_next(iter))
367 struct CmdTemplate* cmd = (struct CmdTemplate*)ht_iter_get(iter);
368 kprintf("%-20s", cmd->name);
369 for (unsigned j = 0; cmd->arg_fmt[j]; ++j)
370 kprintf("%c ", 'a' + j);
378 #include "cmd_hunk.h"
379 DECLARE_CMD_HUNK(help, (NIL), (NIL));
381 #endif // CONFIG_INTERNAL_COMMANDS
384 void parser_init(void)
386 // Initialize the hashtable used to store the command description
389 #if CONFIG_INTERNAL_COMMANDS
390 parser_register_cmd(&CMD_HUNK_TEMPLATE(help));