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 #ifndef CLI_H_
  20 #define CLI_H_
  21
  22 #include <stdint.h>
  23 #include <avr/pgmspace.h>
  24
  25 #ifndef VOID_FPT
  26 #define VOID_FPT
  27 typedef void(*void_fpt)(void);
  28 #endif
  29 typedef char (*cli_rx_fpt)(void);
  30 typedef void (*cli_tx_fpt)(char);
  31
  32 #define CLI_BUFFER_BS 20
  33 #define CMDLIST_ENTRY_SIZE 8
  34
  35 typedef struct {
  36         PGM_P      cmd_name;      /* string containing the function name */
  37         PGM_P      cmd_param_str; /* param descriptor string */
  38         void_fpt   cmd_function;  /* function pointer */
  39         void_fpt   options;
  40 } cmdlist_entry_t;
  41
  42 extern cli_rx_fpt cli_rx;
  43 extern cli_tx_fpt cli_tx;
  44 extern uint8_t cli_echo;
  45
  46
  47 void cli_putc(char c);
  48 uint16_t cli_getc(void);
  49 uint16_t cli_getc_cecho(void);
  50 void cli_putstr(char* s);
  51 void cli_putstr_P(PGM_P s);
  52 void cli_hexdump(void* data, uint16_t length);
  53 void cli_hexdump2(void* data, uint16_t length);
  54 void echo_ctrl(char* s);
  55 int8_t cmd_interface(PGM_VOID_P cmd_desc);
  56
  57
  58 #endif /*CLI_H_*/