shell.h

/******************************************************************************
* File Name:   shell.h
*
* Description: This is the source code for the XMC MCU: Flash Protection
*              Example for ModusToolbox. This file includes the shell
*              command function declarations used to process user serial terminal
*              input.
*
* Related Document: See README.md
*
******************************************************************************
*
* Copyright (c) 2015-2021, Infineon Technologies AG
* All rights reserved.
*
* Boost Software License - Version 1.0 - August 17th, 2003
*
* Permission is hereby granted, free of charge, to any person or organization
* obtaining a copy of the software and accompanying documentation covered by
* this license (the "Software") to use, reproduce, display, distribute,
* execute, and transmit the Software, and to prepare derivative works of the
* Software, and to permit third-parties to whom the Software is furnished to
* do so, all subject to the following:
*
* The copyright notices in the Software and this entire statement, including
* the above license grant, this restriction and the following disclaimer,
* must be included in all copies of the Software, in whole or in part, and
* all derivative works of the Software, unless such copies or derivative
* works are solely in the form of machine-executable object code generated by
* a source language processor.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
* SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
* FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*****************************************************************************/

#ifndef SHELL_H_
#define SHELL_H_

#include <stdint.h>
#include <stdbool.h>

/*******************************************************************************
* Typedefs
*******************************************************************************/
typedef void (*shell_cmd_function_t) (int32_t argc, char **argv);

typedef struct {
    char *name;                         /* Command name */
    uint8_t min_args;                   /* Command minimum arguments needed */
    uint8_t max_args;                   /* Command maximum arguments supported */
    shell_cmd_function_t function;      /* Command function to be executed */
    char *description;                  /* Command description */
    char *syntax;                       /* Command Syntax */
} shell_cmd_t;

/*******************************************************************************
* Function prototypes
*******************************************************************************/
void shell_init(const shell_cmd_t *const cmd_table, void (*init)(void));
void shell_process_input(void);
void shell_help(void);
void shell_print(const char *format, ... );

#endif /* SHELL_H_ */

/* [] END OF FILE */