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>
37 int16_t findstring_d0(const char* str, const char* v){
43 while(*v++) /* go to the next string */
52 int16_t findstring_d0_P(const char* str, PGM_P v){
54 while(pgm_read_byte(v)){
55 if(!strcmp_P(str, v)){
58 while(pgm_read_byte(v++)) /* go to the next string */
68 void cli_auto_help_P(PGM_P dbzstr){
70 uart_putstr_P(PSTR("\r\n[auto help] available commands are:\r\n\t"));
72 while((c=pgm_read_byte(dbzstr++))!=0){
75 uart_putstr_P(PSTR("\r\n\t"));
76 }while((c=pgm_read_byte(dbzstr))!=0);
77 uart_putstr_P(PSTR("\r\n"));
80 int16_t execcommand_d0_P(const char* str, PGM_P v, void(*fpt[])(void) ){
82 i=findstring_d0_P(str, v);
97 cli_rx_fpt cli_rx = NULL;
98 cli_tx_fpt cli_tx = NULL;
101 void cli_putstr(char* s){
108 void cli_putstr_P(PGM_P s){
113 c = pgm_read_byte(s++);
120 void cli_hexdump(void* data, uint16_t length){
121 char hex_tab[] = {'0', '1', '2', '3',
128 cli_tx(hex_tab[(*((uint8_t*)data))>>4]);
129 cli_tx(hex_tab[(*((uint8_t*)data))&0xf]);
130 data = (uint8_t*)data +1;
134 void cli_auto_help(uint16_t maxcmdlength, PGM_VOID_P cmdlist){
135 cmdlist_entry_t item;
140 cli_putstr_P(PSTR("\r\n[auto help] available commands:\r\n"
141 " <command> - <params> - <address>\r\n"));
143 item.cmd_name = (void*)pgm_read_word(cmdlist+0);
144 item.cmd_param_str = (void*)pgm_read_word(cmdlist+2);
145 item.cmd_function = (void_fpt)pgm_read_word(cmdlist+4);
146 cmdlist = (uint8_t*)cmdlist+6;
147 if(item.cmd_name==NULL){
151 cli_putstr_P(item.cmd_name);
152 i=maxcmdlength-strlen_P(item.cmd_name);
155 cli_putstr_P(PSTR(" - "));
156 if(item.cmd_param_str==NULL){
157 cli_putstr_P(PSTR("none \t- 0x"));
159 if(item.cmd_param_str==(void*)1){
160 cli_putstr_P(PSTR("yes \t- 0x"));
162 cli_putstr_P(item.cmd_param_str);
163 cli_putstr_P(PSTR(" \t- 0x"));
166 cli_hexdump(&item.cmd_function, 2);
167 cli_putstr_P(PSTR("\r\n"));
171 uint16_t firstword_length(char* s){
178 void echo_ctrl(char* s){
179 if(s==NULL || *s=='\0'){
180 cli_putstr_P(PSTR("\r\necho is "));
181 cli_putstr_P(cli_echo?PSTR("on"):PSTR("off"));
182 cli_putstr_P(PSTR("\r\n"));
185 if(!strcmp_P(s, PSTR("true")) || !strcmp_P(s, PSTR("on")) || *s=='1'){
188 if(!strcmp_P(s, PSTR("false")) || !strcmp_P(s, PSTR("off")) || *s=='0'){
193 typedef void(*str_fpt)(char*);
195 #define CLI_BACKSPACE 8
196 #define CLI_TABULATOR 9
198 int8_t search_and_call(char* cmd, uint16_t maxcmdlength, PGM_VOID_P cmdlist){
199 PGM_VOID_P cmdlist_orig = cmdlist;
200 if(*cmd=='\0' || *cmd=='#')
202 if(!strcmp_P(cmd, PSTR("exit")))
204 if((!strcmp_P(cmd, PSTR("help"))) || (!strcmp_P(cmd, PSTR("?")))){
205 cli_auto_help(maxcmdlength, cmdlist);
208 uint16_t fwlength=firstword_length(cmd);
210 memcpy(fw, cmd, fwlength);
212 cmdlist_entry_t item;
214 item.cmd_name = (void*)pgm_read_word(cmdlist+0);
215 item.cmd_param_str = (void*)pgm_read_word(cmdlist+2);
216 item.cmd_function = (void_fpt)pgm_read_word(cmdlist+4);
217 cmdlist = (uint8_t*)cmdlist+6;
218 }while(item.cmd_name!=NULL && strcmp_P(fw, item.cmd_name));
219 if(item.cmd_name==NULL){
220 cli_auto_help(maxcmdlength, cmdlist_orig);
222 if(item.cmd_function==NULL)
224 switch((uint16_t)item.cmd_param_str){
229 if(cmd[fwlength]=='\0'){
230 ((str_fpt)item.cmd_function)(cmd+fwlength);
232 ((str_fpt)item.cmd_function)(cmd+fwlength+1);
236 cli_putstr_P(PSTR("\r\nparam parsing currently not implemented!\r\n"));
244 uint16_t max_cmd_length(PGM_VOID_P cmdlist){
248 str = (char*)pgm_read_word(cmdlist);
249 cmdlist = (uint8_t*)cmdlist + 6;
258 uint16_t stridentcnt_P(char* a, PGM_P b){
262 c = pgm_read_byte(b++);
263 if(*a != c || c=='\0')
270 uint8_t cli_completion(char* buffer, uint16_t maxcmdlength, PGM_VOID_P cmdlist){
272 char ref[maxcmdlength+1];
275 /* check if we are behind the first word */
277 if(!isalnum(buffer[i++]))
281 itemstr = (char*)pgm_read_word(cmdlist);
284 cmdlist = (uint8_t*)cmdlist +6;
285 if(!strncmp_P(buffer, itemstr, i)){
287 strcpy_P(ref, itemstr);
289 ref[stridentcnt_P(ref, itemstr)]='\0';
293 i = strcmp(buffer, ref);
299 void cli_option_listing(char* buffer, PGM_VOID_P cmdlist){
301 uint16_t len=strlen(buffer);
303 itemstr = (char*)pgm_read_word(cmdlist);
305 cli_putstr_P(PSTR("\r\n>"));
309 cmdlist = (uint8_t*)cmdlist +6;
310 if(!strncmp_P(buffer, itemstr, len)){
311 cli_putstr_P(PSTR("\r\n "));
312 cli_putstr_P(itemstr);
317 int8_t cmd_interface(PGM_VOID_P cmd_desc){
318 uint16_t cli_buffer_size;
319 uint16_t cli_buffer_index;
321 uint8_t completion_failed=0;
324 uint16_t maxcmdlength = max_cmd_length(cmd_desc);
325 cli_buffer = calloc(1,cli_buffer_size=maxcmdlength+2);
335 if((exit_code=search_and_call(cli_buffer, maxcmdlength, cmd_desc))<=0){
339 memset(cli_buffer, 0, cli_buffer_size);
341 cli_putstr_P(PSTR("\r\n>"));
346 if(cli_buffer_index==0)
349 cli_buffer[cli_buffer_index] = '\0';
350 if(cli_echo && cli_tx){
355 if(completion_failed || cli_buffer_index==0){
357 cli_option_listing(cli_buffer, cmd_desc);
359 uint16_t old_idx = cli_buffer_index;
361 ~cli_completion(cli_buffer, maxcmdlength, cmd_desc);
362 cli_buffer_index = strlen(cli_buffer);
363 if(cli_echo && cli_tx){
364 while(old_idx<cli_buffer_index){
365 cli_tx(cli_buffer[old_idx++]);
372 if(cli_echo && cli_tx){
375 if(cli_buffer_index+1==cli_buffer_size){
376 cli_buffer = realloc(cli_buffer, cli_buffer_size+=CLI_BUFFER_BS);
380 memset(cli_buffer+cli_buffer_index+1, 0, CLI_BUFFER_BS);
382 cli_buffer[cli_buffer_index++] = c;