3 This file is part of the ARM-Crypto-Lib.
4 Copyright (C) 2006-2010 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 "string-extras.h"
35 #include "hexdigit_tab.h"
38 #define MAX(a,b) ((a>b)?(a):(b))
42 cli_rx_fpt cli_rx = NULL;
43 cli_tx_fpt cli_tx = NULL;
47 * \brief output a character to the console
51 void cli_putc(char c){
57 * \brief get a character from the console
58 * Gets a character from the console input and blocks
59 * until a character is recieved
61 uint16_t cli_getc(void){
64 return ((uint16_t)-1);
68 * \brief get a character from the console
69 * Gets a char from the console input (like cli_getc())
70 * and echos it back to the console if echo is enabled.
72 uint16_t cli_getc_cecho(void){
76 if(cli_tx && cli_echo)
80 return ((uint16_t)-1);
84 * \brief outputs a zero-terminated string from ram to the console
86 void cli_putstr(const char* s){
95 * \brief reads a line or max n characters from the console
96 * Writes characters from the console into the supplied buffer until a '\r'
97 * character is received or until n character a read (whatever happens first).
98 * The string will always be terminated by a '\0' character, so the buffer
99 * should have at least a size of n+1.
101 uint8_t cli_getsn(char* s, uint32_t n){
105 while((c=cli_getc_cecho())!='\0' && c!='\r' && n--){
109 return (c=='\r')?0:1;
112 void cli_hexdump_byte(uint8_t byte){
113 cli_tx(hexdigit_tab[byte>>4]);
114 cli_tx(hexdigit_tab[byte & 0xf]);
118 * \brief dumps the contents of a buffer to the console
119 * Dumps length bytes from data to the console output. The dump
120 * will have 2*n continuous hexadecimal characters.
122 void cli_hexdump(const void* data, uint32_t length){
126 cli_hexdump_byte(*((uint8_t*)data));
127 data = (uint8_t*)data +1;
132 * \brief dumps the contents of a buffer to the console
133 * This function behaves like cli_hexdump except that the
134 * bytes are dumped in reverse order. This is useful to dump
135 * integers which are in little endian order.
137 void cli_hexdump_rev(const void* data, uint32_t length){
140 data = (uint8_t*)data + length -1;
142 cli_hexdump_byte(*((uint8_t*)data));
143 data = (uint8_t*)data -1;
148 * \brief dumps the contents of a buffer to the console
149 * Like cli_hexdump but bytes are seperated with a single space
150 * on the console output.
152 void cli_hexdump2(const void* data, uint32_t length){
156 cli_hexdump_byte(*((uint8_t*)data));
158 data = (uint8_t*)data +1;
163 * \brief dumps the contents of a buffer to the console
164 * Like cli_hexdump but bytes are separated with a single space
165 * on the console output.
167 void cli_hexdump_block(const void* data, uint32_t length, uint8_t indent, uint8_t width){
172 for(i=0; i<length; ++i){
175 for(j=0; j<indent; ++j){
179 cli_hexdump_byte(*((uint8_t*)data));
181 data = (uint8_t*)data +1;
186 void cli_auto_help(uint32_t maxcmdlength, const cmdlist_entry_t* cmdlist){
187 cmdlist_entry_t item;
192 cli_putstr("\r\n[auto help] available commands:\r\n"
193 " <command> - <params> - <address>\r\n");
195 memcpy(&item, cmdlist, sizeof(cmdlist_entry_t));
197 if(item.cmd_name==NULL){
201 cli_putstr(item.cmd_name);
202 i=MAX(maxcmdlength, strlen("<command>"))-strlen(item.cmd_name);
206 if(item.cmd_param_str==NULL){
207 cli_putstr("none \t- 0x");
209 if(item.cmd_param_str==(void*)1){
210 cli_putstr("yes \t- 0x");
212 cli_putstr(item.cmd_param_str);
213 cli_putstr(" \t- 0x");
216 cli_hexdump_rev(&item.cmd_function, sizeof(void*));
221 void echo_ctrl(char* s){
223 if(s==NULL || *s=='\0'){
224 cli_putstr("\r\necho is ");
225 cli_putstr(cli_echo?"on":"off");
229 if(!strcmp(s, "true") || !strcmp(s, "on") || *s=='1'){
232 if(!strcmp(s, "false") || !strcmp(s, "off") || *s=='0'){
238 typedef void(*str_fpt)(char*);
240 #define CLI_BACKSPACE 8
241 #define CLI_TABULATOR 9
244 int8_t search_and_call(char* cmd, uint32_t maxcmdlength, const cmdlist_entry_t* cmdlist){
245 const cmdlist_entry_t* cmdlist_orig = cmdlist;
246 if(*cmd=='\0' || *cmd=='#')
248 if(!strcmp(cmd, "exit"))
250 if((!strcmp(cmd, "help")) || (!strcmp(cmd, "?"))){
251 cli_auto_help(maxcmdlength, cmdlist);
254 uint16_t fwlength=firstword_length(cmd);
256 memcpy(fw, cmd, fwlength);
258 cmdlist_entry_t item;
260 memcpy(&item, cmdlist, sizeof(cmdlist_entry_t));
262 }while(item.cmd_name!=NULL && strcmp(fw, item.cmd_name));
263 if(item.cmd_name==NULL){
264 cli_auto_help(maxcmdlength, cmdlist_orig);
266 if(item.cmd_function==NULL)
268 switch((uint32_t)item.cmd_param_str){
273 if(cmd[fwlength]=='\0'){
274 ((str_fpt)item.cmd_function)(cmd+fwlength);
276 ((str_fpt)item.cmd_function)(cmd+fwlength+1);
280 cli_putstr("\r\nparam parsing currently not implemented!\r\n");
289 uint16_t max_cmd_length(const cmdlist_entry_t* cmdlist){
293 str = cmdlist->cmd_name;
305 uint8_t cli_completion(char* buffer, uint16_t maxcmdlength, const cmdlist_entry_t* cmdlist){
307 char ref[maxcmdlength+1];
310 /* check if we are behind the first word */
312 if(!isgraph(buffer[i++]))
316 itemstr = cmdlist->cmd_name;
320 if(!strncmp(buffer, itemstr, i)){
322 strcpy(ref, itemstr);
324 ref[stridentcnt(ref, itemstr)]='\0';
328 i = strcmp(buffer, ref);
334 void cli_option_listing(char* buffer, const cmdlist_entry_t* cmdlist){
336 uint16_t len=strlen(buffer);
338 itemstr = cmdlist->cmd_name;
345 if(!strncmp(buffer, itemstr, len)){
352 int8_t cmd_interface(const cmdlist_entry_t* cmd_desc){
353 uint16_t cli_buffer_size;
354 uint16_t cli_buffer_index;
356 uint8_t completion_failed=0;
359 uint16_t maxcmdlength = max_cmd_length(cmd_desc);
360 cli_buffer = calloc(1,cli_buffer_size=maxcmdlength+2);
370 if((exit_code=search_and_call(cli_buffer, maxcmdlength, cmd_desc))<=0){
374 memset(cli_buffer, 0, cli_buffer_size);
381 if(cli_buffer_index==0)
384 cli_buffer[cli_buffer_index] = '\0';
385 if(cli_echo && cli_tx){
390 if(completion_failed || cli_buffer_index==0){
392 cli_option_listing(cli_buffer, cmd_desc);
394 uint16_t old_idx = cli_buffer_index;
396 ~cli_completion(cli_buffer, maxcmdlength, cmd_desc);
397 cli_buffer_index = strlen(cli_buffer);
398 if(cli_echo && cli_tx){
399 while(old_idx<cli_buffer_index){
400 cli_tx(cli_buffer[old_idx++]);
407 if(cli_echo && cli_tx){
410 if(cli_buffer_index+1==cli_buffer_size){
411 cli_buffer = realloc(cli_buffer, cli_buffer_size+=CLI_BUFFER_BS);
415 memset(cli_buffer+cli_buffer_index+1, 0, CLI_BUFFER_BS);
417 cli_buffer[cli_buffer_index++] = c;