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"
38 cli_rx_fpt cli_rx = NULL;
39 cli_tx_fpt cli_tx = NULL;
42 void cli_putc(char c){
47 uint16_t cli_getc(void){
50 return ((uint16_t)-1);
54 uint16_t cli_getc_cecho(void){
58 if(cli_tx && cli_echo)
62 return ((uint16_t)-1);
65 void cli_putstr(char* s){
72 void cli_putstr_P(PGM_P s){
77 c = pgm_read_byte(s++);
84 uint8_t cli_getsn(char* s, uint16_t n){
88 while((c=cli_getc_cecho())!='\0' && c!='\r' && n--){
95 void cli_hexdump(void* data, uint16_t length){
96 char hex_tab[] = {'0', '1', '2', '3',
103 cli_tx(hex_tab[(*((uint8_t*)data))>>4]);
104 cli_tx(hex_tab[(*((uint8_t*)data))&0xf]);
105 data = (uint8_t*)data +1;
109 void cli_hexdump2(void* data, uint16_t length){
110 char hex_tab[] = {'0', '1', '2', '3',
117 cli_tx(hex_tab[(*((uint8_t*)data))>>4]);
118 cli_tx(hex_tab[(*((uint8_t*)data))&0xf]);
120 data = (uint8_t*)data +1;
125 void cli_auto_help(uint16_t maxcmdlength, PGM_VOID_P cmdlist){
126 cmdlist_entry_t item;
131 cli_putstr_P(PSTR("\r\n[auto help] available commands:\r\n"
132 " <command> - <params> - <address>\r\n"));
134 item.cmd_name = (void*)pgm_read_word(cmdlist+0);
135 item.cmd_param_str = (void*)pgm_read_word(cmdlist+2);
136 item.cmd_function = (void_fpt)pgm_read_word(cmdlist+4);
137 cmdlist = (uint8_t*)cmdlist+CMDLIST_ENTRY_SIZE;
138 if(item.cmd_name==NULL){
142 cli_putstr_P(item.cmd_name);
143 i=maxcmdlength-strlen_P(item.cmd_name);
146 cli_putstr_P(PSTR(" - "));
147 if(item.cmd_param_str==NULL){
148 cli_putstr_P(PSTR("none \t- 0x"));
150 if(item.cmd_param_str==(void*)1){
151 cli_putstr_P(PSTR("yes \t- 0x"));
153 cli_putstr_P(item.cmd_param_str);
154 cli_putstr_P(PSTR(" \t- 0x"));
157 cli_hexdump(&item.cmd_function, 2);
158 cli_putstr_P(PSTR("\r\n"));
162 void echo_ctrl(char* s){
164 if(s==NULL || *s=='\0'){
165 cli_putstr_P(PSTR("\r\necho is "));
166 cli_putstr_P(cli_echo?PSTR("on"):PSTR("off"));
167 cli_putstr_P(PSTR("\r\n"));
170 if(!strcmp_P(s, PSTR("true")) || !strcmp_P(s, PSTR("on")) || *s=='1'){
173 if(!strcmp_P(s, PSTR("false")) || !strcmp_P(s, PSTR("off")) || *s=='0'){
178 typedef void(*str_fpt)(char*);
180 #define CLI_BACKSPACE 8
181 #define CLI_TABULATOR 9
183 int8_t search_and_call(char* cmd, uint16_t maxcmdlength, PGM_VOID_P cmdlist){
184 PGM_VOID_P cmdlist_orig = cmdlist;
185 if(*cmd=='\0' || *cmd=='#')
187 if(!strcmp_P(cmd, PSTR("exit")))
189 if((!strcmp_P(cmd, PSTR("help"))) || (!strcmp_P(cmd, PSTR("?")))){
190 cli_auto_help(maxcmdlength, cmdlist);
193 uint16_t fwlength=firstword_length(cmd);
195 memcpy(fw, cmd, fwlength);
197 cmdlist_entry_t item;
199 item.cmd_name = (void*)pgm_read_word(cmdlist+0);
200 item.cmd_param_str = (void*)pgm_read_word(cmdlist+2);
201 item.cmd_function = (void_fpt)pgm_read_word(cmdlist+4);
202 cmdlist = (uint8_t*)cmdlist+CMDLIST_ENTRY_SIZE;
203 }while(item.cmd_name!=NULL && strcmp_P(fw, item.cmd_name));
204 if(item.cmd_name==NULL){
205 cli_auto_help(maxcmdlength, cmdlist_orig);
207 if(item.cmd_function==NULL)
209 switch((uint16_t)item.cmd_param_str){
214 if(cmd[fwlength]=='\0'){
215 ((str_fpt)item.cmd_function)(cmd+fwlength);
217 ((str_fpt)item.cmd_function)(cmd+fwlength+1);
221 cli_putstr_P(PSTR("\r\nparam parsing currently not implemented!\r\n"));
229 uint16_t max_cmd_length(PGM_VOID_P cmdlist){
233 str = (char*)pgm_read_word(cmdlist);
234 cmdlist = (uint8_t*)cmdlist + CMDLIST_ENTRY_SIZE;
243 uint8_t cli_completion(char* buffer, uint16_t maxcmdlength, PGM_VOID_P cmdlist){
245 char ref[maxcmdlength+1];
248 /* check if we are behind the first word */
250 if(!isgraph(buffer[i++]))
254 itemstr = (char*)pgm_read_word(cmdlist);
257 cmdlist = (uint8_t*)cmdlist +CMDLIST_ENTRY_SIZE;
258 if(!strncmp_P(buffer, itemstr, i)){
260 strcpy_P(ref, itemstr);
262 ref[stridentcnt_P(ref, itemstr)]='\0';
266 i = strcmp(buffer, ref);
272 void cli_option_listing(char* buffer, PGM_VOID_P cmdlist){
274 uint16_t len=strlen(buffer);
276 itemstr = (char*)pgm_read_word(cmdlist);
278 cli_putstr_P(PSTR("\r\n>"));
282 cmdlist = (uint8_t*)cmdlist +CMDLIST_ENTRY_SIZE;
283 if(!strncmp_P(buffer, itemstr, len)){
284 cli_putstr_P(PSTR("\r\n "));
285 cli_putstr_P(itemstr);
290 int8_t cmd_interface(PGM_VOID_P cmd_desc){
291 uint16_t cli_buffer_size;
292 uint16_t cli_buffer_index;
294 uint8_t completion_failed=0;
297 uint16_t maxcmdlength = max_cmd_length(cmd_desc);
298 cli_buffer = calloc(1,cli_buffer_size=maxcmdlength+2);
308 if((exit_code=search_and_call(cli_buffer, maxcmdlength, cmd_desc))<=0){
312 memset(cli_buffer, 0, cli_buffer_size);
314 cli_putstr_P(PSTR("\r\n>"));
319 if(cli_buffer_index==0)
322 cli_buffer[cli_buffer_index] = '\0';
323 if(cli_echo && cli_tx){
328 if(completion_failed || cli_buffer_index==0){
330 cli_option_listing(cli_buffer, cmd_desc);
332 uint16_t old_idx = cli_buffer_index;
334 ~cli_completion(cli_buffer, maxcmdlength, cmd_desc);
335 cli_buffer_index = strlen(cli_buffer);
336 if(cli_echo && cli_tx){
337 while(old_idx<cli_buffer_index){
338 cli_tx(cli_buffer[old_idx++]);
345 if(cli_echo && cli_tx){
348 if(cli_buffer_index+1==cli_buffer_size){
349 cli_buffer = realloc(cli_buffer, cli_buffer_size+=CLI_BUFFER_BS);
353 memset(cli_buffer+cli_buffer_index+1, 0, CLI_BUFFER_BS);
355 cli_buffer[cli_buffer_index++] = c;