]> git.cryptolib.org Git - avr-crypto-lib.git/blob - test_src/cli.h
upgraded svn
[avr-crypto-lib.git] / test_src / cli.h
1 /* cli.h */
2 /*
3     This file is part of the AVR-Crypto-Lib.
4     Copyright (C) 2008  Daniel Otte (daniel.otte@rub.de)
5
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.
10
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.
15
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/>.
18 */
19
20 #ifndef CLI_H_
21 #define CLI_H_
22
23 #include <stdint.h>
24 #include <avr/pgmspace.h>
25
26 #ifndef VOID_FPT
27 #define VOID_FPT
28 typedef void(*void_fpt)(void);
29 #endif
30 typedef char (*cli_rx_fpt)(void);
31 typedef void (*cli_tx_fpt)(char);
32
33 #define CLI_BUFFER_BS 20
34 #define CMDLIST_ENTRY_SIZE 8
35
36 typedef struct {
37         uint16_t   option_flags;
38         PGM_VOID_P options[];
39 } cmdoption_t;
40
41 #define CLI_OPTION_DESC 0x01
42 #define CLI_OPTION_MANP 0x02
43
44 typedef struct {
45         PGM_P        cmd_name;      /* string containing the function name */
46         PGM_P        cmd_param_str; /* param descriptor string */
47         void_fpt     cmd_function;  /* function pointer */
48         cmdoption_t* options;
49 } cmdlist_entry_t;
50
51 extern cli_rx_fpt cli_rx;
52 extern cli_tx_fpt cli_tx;
53 extern uint8_t cli_echo;
54
55
56
57 void cli_putc(char c);
58 uint16_t cli_getc(void);
59 uint16_t cli_getc_cecho(void);
60 uint8_t cli_getsn(char* s, uint16_t n);
61 uint8_t cli_getsn_cecho(char* s, uint16_t n);
62 void cli_putstr(const char* s);
63 void cli_putstr_P(PGM_P s);
64 void cli_hexdump_byte(uint8_t byte);
65 void cli_hexdump(const void* data, uint16_t length);
66 void cli_hexdump_rev(const void* data, uint16_t length);
67 void cli_hexdump2(const void* data, uint16_t length);
68 void cli_hexdump_block(const void* data, uint16_t length, uint8_t indent, uint8_t width);
69
70 void echo_ctrl(char* s);
71 int8_t cmd_interface(PGM_VOID_P cmd_desc);
72
73
74 #endif /*CLI_H_*/