+BlueMidnightWish

[avr-crypto-lib.git] / test_src / cli.c

diff --git a/test_src/cli.c b/test_src/cli.c
index 5fe4c8eac3e6257aa92b50c1d729fa22735a8b3e..95b027215edaf495ce724af25af67eb0894544e4 100644 (file)
--- a/test_src/cli.c
+++ b/test_src/cli.c
@@ -34,23 +34,38 @@
 #include "string-extras.h"
 #include "cli.h"
 #include "config.h"
+#include "hexdigit_tab.h"
 
 cli_rx_fpt cli_rx = NULL;
 cli_tx_fpt cli_tx = NULL;
 uint8_t cli_echo=1;
 
+/**
+ * \brief output a character to the console
+ * 
+ */
+
 void cli_putc(char c){
        if(cli_tx)
                cli_tx(c);
 }
 
+/**
+ * \brief get a character from the console
+ * Gets a character from the console input and blocks
+ * until a character is recieved
+ */
 uint16_t cli_getc(void){
        if(cli_rx)
                return cli_rx();
        return ((uint16_t)-1);
 }
 
-
+/**
+ * \brief get a character from the console
+ * Gets a char from the console input (like cli_getc())
+ * and echos it back to the console if echo is enabled.
+ */
 uint16_t cli_getc_cecho(void){
        char c;
        if(cli_rx){
@@ -62,13 +77,20 @@ uint16_t cli_getc_cecho(void){
        return ((uint16_t)-1);
 }
 
-void cli_putstr(char* s){
+/**
+ * \brief ouputs a zero-terminated string from ram to the console 
+ */
+void cli_putstr(const char* s){
        if(!cli_tx)
                return;
        while(*s)
                cli_tx(*s++);
 }
 
+
+/**
+ * \brief ouputs a zero-terminated string from flash to the console 
+ */
 void cli_putstr_P(PGM_P s){
        char c;
        if(!cli_tx)
@@ -81,30 +103,91 @@ void cli_putstr_P(PGM_P s){
        }
 }
 
-void cli_hexdump(void* data, uint16_t length){
-       char hex_tab[] = {'0', '1', '2', '3', 
-                         '4', '5', '6', '7', 
-                                         '8', '9', 'A', 'B', 
-                                         'C', 'D', 'E', 'F'};
+/**
+ * \brief reads a line or max n characters from the console
+ * Writes characters from the console into the supplyed buffer until a '\r'
+ * character is recieved or until n character a read (whatever happens first).
+ * The string will always be terminated by a '\0' character, so the buffer
+ * should have at least a size of n+1. 
+ */
+uint8_t cli_getsn(char* s, uint16_t n){
+       char c;
+       if(n==0)
+               return 2;
+       while((c=cli_getc_cecho())!='\0' && c!='\r' && n--){
+               *s++=c;
+       }
+       *s='\0';
+       return (c=='\r')?0:1;
+}
+
+/**
+ * \brief dumps the contents of a buffer to the console
+ * Dumps length bytes from data to the console ouput. The dump
+ * will have 2*n continous hexadecimal characters.
+ */
+void cli_hexdump(const void* data, uint16_t length){
        if(!cli_tx)
                return;
        while(length--){
-               cli_tx(hex_tab[(*((uint8_t*)data))>>4]);
-               cli_tx(hex_tab[(*((uint8_t*)data))&0xf]);
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))>>4)));
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))&0xf)));
                data = (uint8_t*)data +1;
        }
 }
 
-void cli_hexdump2(void* data, uint16_t length){
-       char hex_tab[] = {'0', '1', '2', '3', 
-                         '4', '5', '6', '7', 
-                                         '8', '9', 'A', 'B', 
-                                         'C', 'D', 'E', 'F'};
+/**
+ * \brief dumps the contents of a buffer to the console
+ * This function behaves like cli_hexdump except that the
+ * bytes are dumped in reverse order. This is usefull to dump
+ * integers which ar e in little endian order.
+ */
+void cli_hexdump_rev(const void* data, uint16_t length){
+       if(!cli_tx)
+               return;
+       data = (uint8_t*)data + length -1;
+       while(length--){
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))>>4)));
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))&0xf)));
+               data = (uint8_t*)data -1;
+       }
+}
+
+/**
+ * \brief dumps the contents of a buffer to the console
+ * Like cli_hexdump but bytes are seperated with a single space
+ * on the console output.
+ */
+void cli_hexdump2(const void* data, uint16_t length){
        if(!cli_tx)
                return;
        while(length--){
-               cli_tx(hex_tab[(*((uint8_t*)data))>>4]);
-               cli_tx(hex_tab[(*((uint8_t*)data))&0xf]);
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))>>4)));
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))&0xf)));
+               cli_tx(' ');
+               data = (uint8_t*)data +1;
+       }
+}
+
+/**
+ * \brief dumps the contents of a buffer to the console
+ * Like cli_hexdump but bytes are seperated with a single space
+ * on the console output.
+ */
+void cli_hexdump_block(const void* data, uint16_t length, uint8_t indent, uint8_t width){
+       uint16_t i;
+       uint8_t  j;
+       if(!cli_tx)
+               return;
+       for(i=0; i<length; ++i){
+               if(i%width==0){
+                       cli_putstr_P(PSTR("\r\n"));
+                       for(j=0; j<indent; ++j){
+                               cli_tx(' ');
+                       }
+               }
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))>>4)));
+               cli_tx(pgm_read_byte(hexdigit_tab_P +((*((uint8_t*)data))&0xf)));
                cli_tx(' ');
                data = (uint8_t*)data +1;
        }
@@ -143,7 +226,7 @@ void cli_auto_help(uint16_t maxcmdlength, PGM_VOID_P cmdlist){
                                cli_putstr_P(PSTR(" \t- 0x"));
                        }
                }
-               cli_hexdump(&item.cmd_function, 2);     
+               cli_hexdump_rev(&item.cmd_function, 2); 
                cli_putstr_P(PSTR("\r\n"));
        }
 }