3 This file is part of the AVR-Crypto-Lib.
4 Copyright (C) 2008 Daniel Otte (daniel.otte@rub.de)
6 This program 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 3 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, see <http://www.gnu.org/licenses/>.
22 * email: daniel.otte@rub.de
23 * license: GPLv3 or later
25 * components to help implementing simple command based interaction
33 #include <avr/pgmspace.h>
34 #include "string-extras.h"
37 #include "hexdigit_tab.h"
39 cli_rx_fpt cli_rx = NULL;
40 cli_tx_fpt cli_tx = NULL;
44 * \brief output a character to the console
48 void cli_putc(char c){
54 * \brief get a character from the console
55 * Gets a character from the console input and blocks
56 * until a character is recieved
58 uint16_t cli_getc(void){
61 return ((uint16_t)-1);
65 * \brief get a character from the console
66 * Gets a char from the console input (like cli_getc())
67 * and echos it back to the console if echo is enabled.
69 uint16_t cli_getc_cecho(void){
73 if(cli_tx && cli_echo)
77 return ((uint16_t)-1);
81 * \brief ouputs a zero-terminated string from ram to the console
83 void cli_putstr(char* s){
92 * \brief ouputs a zero-terminated string from flash to the console
94 void cli_putstr_P(PGM_P s){
99 c = pgm_read_byte(s++);
107 * \brief reads a line or max n characters from the console
108 * Writes characters from the console into the supplyed buffer until a '\r'
109 * character is recieved or until n character a read (whatever happens first).
110 * The string will always be terminated by a '\0' character, so the buffer
111 * should have at least a size of n+1.
113 uint8_t cli_getsn(char* s, uint16_t n){
117 while((c=cli_getc_cecho())!='\0' && c!='\r' && n--){
121 return (c=='\r')?0:1;
125 * \brief dumps the contents of a buffer to the console
126 * Dumps length bytes from data to the console ouput. The dump
127 * will have 2*n continous hexadecimal characters.
129 void cli_hexdump(void* data, uint16_t length){
133 cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))>>4)));
134 cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))&0xf)));
135 data = (uint8_t*)data +1;
140 * \brief dumps the contents of a buffer to the console
141 * This function behaves like cli_hexdump except that the
142 * bytes are dumped in reverse order. This is usefull to dump
143 * integers which ar e in little endian order.
145 void cli_hexdump_rev(void* data, uint16_t length){
148 data = (uint8_t*)data + length -1;
150 cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))>>4)));
151 cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))&0xf)));
152 data = (uint8_t*)data -1;
157 * \brief dumps the contents of a buffer to the console
158 * Like cli_hexdump but bytes are seperated with a single space
159 * on the console output.
161 void cli_hexdump2(void* data, uint16_t length){
165 cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))>>4)));
166 cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))&0xf)));
168 data = (uint8_t*)data +1;
174 void cli_auto_help(uint16_t maxcmdlength, PGM_VOID_P cmdlist){
175 cmdlist_entry_t item;
180 cli_putstr_P(PSTR("\r\n[auto help] available commands:\r\n"
181 " <command> - <params> - <address>\r\n"));
183 item.cmd_name = (void*)pgm_read_word(cmdlist+0);
184 item.cmd_param_str = (void*)pgm_read_word(cmdlist+2);
185 item.cmd_function = (void_fpt)pgm_read_word(cmdlist+4);
186 cmdlist = (uint8_t*)cmdlist+CMDLIST_ENTRY_SIZE;
187 if(item.cmd_name==NULL){
191 cli_putstr_P(item.cmd_name);
192 i=maxcmdlength-strlen_P(item.cmd_name);
195 cli_putstr_P(PSTR(" - "));
196 if(item.cmd_param_str==NULL){
197 cli_putstr_P(PSTR("none \t- 0x"));
199 if(item.cmd_param_str==(void*)1){
200 cli_putstr_P(PSTR("yes \t- 0x"));
202 cli_putstr_P(item.cmd_param_str);
203 cli_putstr_P(PSTR(" \t- 0x"));
206 cli_hexdump_rev(&item.cmd_function, 2);
207 cli_putstr_P(PSTR("\r\n"));
211 void echo_ctrl(char* s){
213 if(s==NULL || *s=='\0'){
214 cli_putstr_P(PSTR("\r\necho is "));
215 cli_putstr_P(cli_echo?PSTR("on"):PSTR("off"));
216 cli_putstr_P(PSTR("\r\n"));
219 if(!strcmp_P(s, PSTR("true")) || !strcmp_P(s, PSTR("on")) || *s=='1'){
222 if(!strcmp_P(s, PSTR("false")) || !strcmp_P(s, PSTR("off")) || *s=='0'){
227 typedef void(*str_fpt)(char*);
229 #define CLI_BACKSPACE 8
230 #define CLI_TABULATOR 9
232 int8_t search_and_call(char* cmd, uint16_t maxcmdlength, PGM_VOID_P cmdlist){
233 PGM_VOID_P cmdlist_orig = cmdlist;
234 if(*cmd=='\0' || *cmd=='#')
236 if(!strcmp_P(cmd, PSTR("exit")))
238 if((!strcmp_P(cmd, PSTR("help"))) || (!strcmp_P(cmd, PSTR("?")))){
239 cli_auto_help(maxcmdlength, cmdlist);
242 uint16_t fwlength=firstword_length(cmd);
244 memcpy(fw, cmd, fwlength);
246 cmdlist_entry_t item;
248 item.cmd_name = (void*)pgm_read_word(cmdlist+0);
249 item.cmd_param_str = (void*)pgm_read_word(cmdlist+2);
250 item.cmd_function = (void_fpt)pgm_read_word(cmdlist+4);
251 cmdlist = (uint8_t*)cmdlist+CMDLIST_ENTRY_SIZE;
252 }while(item.cmd_name!=NULL && strcmp_P(fw, item.cmd_name));
253 if(item.cmd_name==NULL){
254 cli_auto_help(maxcmdlength, cmdlist_orig);
256 if(item.cmd_function==NULL)
258 switch((uint16_t)item.cmd_param_str){
263 if(cmd[fwlength]=='\0'){
264 ((str_fpt)item.cmd_function)(cmd+fwlength);
266 ((str_fpt)item.cmd_function)(cmd+fwlength+1);
270 cli_putstr_P(PSTR("\r\nparam parsing currently not implemented!\r\n"));
278 uint16_t max_cmd_length(PGM_VOID_P cmdlist){
282 str = (char*)pgm_read_word(cmdlist);
283 cmdlist = (uint8_t*)cmdlist + CMDLIST_ENTRY_SIZE;
292 uint8_t cli_completion(char* buffer, uint16_t maxcmdlength, PGM_VOID_P cmdlist){
294 char ref[maxcmdlength+1];
297 /* check if we are behind the first word */
299 if(!isgraph(buffer[i++]))
303 itemstr = (char*)pgm_read_word(cmdlist);
306 cmdlist = (uint8_t*)cmdlist +CMDLIST_ENTRY_SIZE;
307 if(!strncmp_P(buffer, itemstr, i)){
309 strcpy_P(ref, itemstr);
311 ref[stridentcnt_P(ref, itemstr)]='\0';
315 i = strcmp(buffer, ref);
321 void cli_option_listing(char* buffer, PGM_VOID_P cmdlist){
323 uint16_t len=strlen(buffer);
325 itemstr = (char*)pgm_read_word(cmdlist);
327 cli_putstr_P(PSTR("\r\n>"));
331 cmdlist = (uint8_t*)cmdlist +CMDLIST_ENTRY_SIZE;
332 if(!strncmp_P(buffer, itemstr, len)){
333 cli_putstr_P(PSTR("\r\n "));
334 cli_putstr_P(itemstr);
339 int8_t cmd_interface(PGM_VOID_P cmd_desc){
340 uint16_t cli_buffer_size;
341 uint16_t cli_buffer_index;
343 uint8_t completion_failed=0;
346 uint16_t maxcmdlength = max_cmd_length(cmd_desc);
347 cli_buffer = calloc(1,cli_buffer_size=maxcmdlength+2);
357 if((exit_code=search_and_call(cli_buffer, maxcmdlength, cmd_desc))<=0){
361 memset(cli_buffer, 0, cli_buffer_size);
363 cli_putstr_P(PSTR("\r\n>"));
368 if(cli_buffer_index==0)
371 cli_buffer[cli_buffer_index] = '\0';
372 if(cli_echo && cli_tx){
377 if(completion_failed || cli_buffer_index==0){
379 cli_option_listing(cli_buffer, cmd_desc);
381 uint16_t old_idx = cli_buffer_index;
383 ~cli_completion(cli_buffer, maxcmdlength, cmd_desc);
384 cli_buffer_index = strlen(cli_buffer);
385 if(cli_echo && cli_tx){
386 while(old_idx<cli_buffer_index){
387 cli_tx(cli_buffer[old_idx++]);
394 if(cli_echo && cli_tx){
397 if(cli_buffer_index+1==cli_buffer_size){
398 cli_buffer = realloc(cli_buffer, cli_buffer_size+=CLI_BUFFER_BS);
402 memset(cli_buffer+cli_buffer_index+1, 0, CLI_BUFFER_BS);
404 cli_buffer[cli_buffer_index++] = c;