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){
94 * \brief reads a line or max n characters from the console
95 * Writes characters from the console into the supplied buffer until a '\r'
96 * character is received or until n character a read (whatever happens first).
97 * The string will always be terminated by a '\0' character, so the buffer
98 * should have at least a size of n+1.
100 uint8_t cli_getsn(char* s, uint32_t n){
104 while((c=cli_getc_cecho())!='\0' && c!='\r' && n--){
108 return (c=='\r')?0:1;
112 * \brief reads a line or max n characters from the console and echos the characters back
113 * Writes characters from the console into the supplied buffer until a '\r'
114 * character is received or until n character a read (whatever happens first).
115 * The string will always be terminated by a '\0' character, so the buffer
116 * should have at least a size of n+1.
118 uint8_t cli_getsn_cecho(char* s, uint32_t n){
119 uint8_t echo_backup,r ;
120 echo_backup = cli_echo;
123 cli_echo = echo_backup;
127 void cli_hexdump_byte(uint8_t byte){
128 cli_tx(hexdigit_tab[byte>>4]);
129 cli_tx(hexdigit_tab[byte & 0xf]);
133 * \brief dumps the contents of a buffer to the console
134 * Dumps length bytes from data to the console output. The dump
135 * will have 2*n continuous hexadecimal characters.
137 void cli_hexdump(const void* data, uint32_t length){
141 cli_hexdump_byte(*((uint8_t*)data));
142 data = (uint8_t*)data +1;
147 * \brief dumps the contents of a buffer to the console
148 * This function behaves like cli_hexdump except that the
149 * bytes are dumped in reverse order. This is useful to dump
150 * integers which are in little endian order.
152 void cli_hexdump_rev(const void* data, uint32_t length){
155 data = (uint8_t*)data + length -1;
157 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 seperated with a single space
165 * on the console output.
167 void cli_hexdump2(const void* data, uint32_t length){
171 cli_hexdump_byte(*((uint8_t*)data));
173 data = (uint8_t*)data +1;
178 * \brief dumps the contents of a buffer to the console
179 * Like cli_hexdump but bytes are separated with a single space
180 * on the console output.
182 void cli_hexdump_block(const void* data, uint32_t length, uint8_t indent, uint8_t width){
187 for(i=0; i<length; ++i){
190 for(j=0; j<indent; ++j){
194 cli_hexdump_byte(*((uint8_t*)data));
196 data = (uint8_t*)data +1;
201 void cli_auto_help(uint32_t maxcmdlength, const cmdlist_entry_t* cmdlist){
202 cmdlist_entry_t item;
207 cli_putstr("\r\n[auto help] available commands:\r\n"
208 " <command> - <params> - <address>\r\n");
210 memcpy(&item, cmdlist, sizeof(cmdlist_entry_t));
212 if(item.cmd_name==NULL){
216 cli_putstr(item.cmd_name);
217 i=MAX(maxcmdlength, strlen("<command>"))-strlen(item.cmd_name);
221 if(item.cmd_param_str==NULL){
222 cli_putstr("none \t- 0x");
224 if(item.cmd_param_str==(void*)1){
225 cli_putstr("yes \t- 0x");
227 cli_putstr(item.cmd_param_str);
228 cli_putstr(" \t- 0x");
231 cli_hexdump_rev(&item.cmd_function, sizeof(void*));
236 void echo_ctrl(char* s){
238 if(s==NULL || *s=='\0'){
239 cli_putstr("\r\necho is ");
240 cli_putstr(cli_echo?"on":"off");
244 if(!strcmp(s, "true") || !strcmp(s, "on") || *s=='1'){
247 if(!strcmp(s, "false") || !strcmp(s, "off") || *s=='0'){
253 typedef void(*str_fpt)(char*);
255 #define CLI_BACKSPACE 8
256 #define CLI_TABULATOR 9
259 int8_t search_and_call(char* cmd, uint32_t maxcmdlength, const cmdlist_entry_t* cmdlist){
260 const cmdlist_entry_t* cmdlist_orig = cmdlist;
261 if(*cmd=='\0' || *cmd=='#')
263 if(!strcmp(cmd, "exit"))
265 if((!strcmp(cmd, "help")) || (!strcmp(cmd, "?"))){
266 cli_auto_help(maxcmdlength, cmdlist);
269 uint16_t fwlength=firstword_length(cmd);
271 memcpy(fw, cmd, fwlength);
273 cmdlist_entry_t item;
275 memcpy(&item, cmdlist, sizeof(cmdlist_entry_t));
277 }while(item.cmd_name!=NULL && strcmp(fw, item.cmd_name));
278 if(item.cmd_name==NULL){
279 cli_auto_help(maxcmdlength, cmdlist_orig);
281 if(item.cmd_function==NULL)
283 switch((uint32_t)item.cmd_param_str){
288 if(cmd[fwlength]=='\0'){
289 ((str_fpt)item.cmd_function)(cmd+fwlength);
291 ((str_fpt)item.cmd_function)(cmd+fwlength+1);
295 cli_putstr("\r\nparam parsing currently not implemented!\r\n");
304 uint16_t max_cmd_length(const cmdlist_entry_t* cmdlist){
308 str = cmdlist->cmd_name;
320 uint8_t cli_completion(char* buffer, uint16_t maxcmdlength, const cmdlist_entry_t* cmdlist){
322 char ref[maxcmdlength+1];
325 /* check if we are behind the first word */
327 if(!isgraph((uint8_t)(buffer[i++])))
331 itemstr = cmdlist->cmd_name;
335 if(!strncmp(buffer, itemstr, i)){
337 strcpy(ref, itemstr);
339 ref[stridentcnt(ref, itemstr)]='\0';
343 i = strcmp(buffer, ref);
349 void cli_option_listing(char* buffer, const cmdlist_entry_t* cmdlist){
351 uint16_t len=strlen(buffer);
353 itemstr = cmdlist->cmd_name;
360 if(!strncmp(buffer, itemstr, len)){
367 int8_t cmd_interface(const cmdlist_entry_t* cmd_desc){
368 uint16_t cli_buffer_size;
369 uint16_t cli_buffer_index;
371 uint8_t completion_failed=0;
374 uint16_t maxcmdlength = max_cmd_length(cmd_desc);
375 cli_buffer = calloc(1,cli_buffer_size=maxcmdlength+2);
385 if((exit_code=search_and_call(cli_buffer, maxcmdlength, cmd_desc))<=0){
389 memset(cli_buffer, 0, cli_buffer_size);
396 if(cli_buffer_index==0)
399 cli_buffer[cli_buffer_index] = '\0';
400 if(cli_echo && cli_tx){
405 if(completion_failed || cli_buffer_index==0){
407 cli_option_listing(cli_buffer, cmd_desc);
409 uint16_t old_idx = cli_buffer_index;
411 ~cli_completion(cli_buffer, maxcmdlength, cmd_desc);
412 cli_buffer_index = strlen(cli_buffer);
413 if(cli_echo && cli_tx){
414 while(old_idx<cli_buffer_index){
415 cli_tx(cli_buffer[old_idx++]);
422 if(cli_echo && cli_tx){
425 if(cli_buffer_index+1==cli_buffer_size){
426 cli_buffer = realloc(cli_buffer, cli_buffer_size+=CLI_BUFFER_BS);
430 memset(cli_buffer+cli_buffer_index+1, 0, CLI_BUFFER_BS);
432 cli_buffer[cli_buffer_index++] = c;