/*
 * FreeRTOS STM32 Reference Integration
 * Copyright (C) 2020-2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * 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 AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef _CLI_PRIV
#define _CLI_PRIV

#include "semphr.h"
#include "cli.h"

/**
 * Defines the interface for different console implementations. Interface
 * defines the contract of how bytes are transferred between console
 * and FreeRTOS CLI.
 */
typedef struct xConsoleIO
{
    /**
     * Function reads input bytes from the console into a finite length buffer upto the length
     * requested by the second parameter. It returns the number of bytes read which can
     * be less than or equal to the requested value. If no input bytes are available,
     * function can either block or return immediately with 0 bytes read. If there is an error for the
     * read, it returns negative error code.
     * FreeRTOS CLI uses this function to read the command string from input console.
     * The API is not thread-safe.
     *
     */
    int32_t ( * read )( char * const buffer,
                        uint32_t length );

    int32_t ( * read_timeout )( char * const buffer,
                                uint32_t length,
                                TickType_t xTimeout );

    int32_t ( * readline )( char ** const bufferPtr );

    /**
     * Function writes the output of a finite length buffer to the console. If the buffer is a null
     * terminated string, the entire length of the buffer (including null characters) will be sent
     * to the serial port.
     */
    void ( * write )( const void * const pvBuffer,
                      uint32_t length );

    /**
     * Function writes a null terminated string to the console.
     */
    void ( * print )( const char * const pcString );

    void ( * lock )( void );
    void ( * unlock )( void );
} ConsoleIO_t;

/* The prototype to which callback functions used to process command line
 * commands must comply.  pcWriteBuffer is a buffer into which the output from
 * executing the command can be written, xWriteBufferLen is the length, in bytes of
 * the pcWriteBuffer buffer, and pcCommandString is the entire string as input by
 * the user (from which parameters can be extracted).*/
typedef void ( * pdCOMMAND_LINE_CALLBACK) ( ConsoleIO_t * const pxConsoleIO,
                                            uint32_t ulArgc,
                                            char * ppcArgv[] );

/* The structure that defines command line commands.  A command line command
 * should be defined by declaring a const structure of this type. */
typedef struct xCOMMAND_LINE_INPUT
{
    const char * const pcCommand;                       /* The command that causes pxCommandInterpreter to be executed.  For example "help".  Must be all lower case. */
    const char * const pcHelpString;                    /* String that describes how to use the command.  Should start with the command itself, and end with "\r\n".  For example "help: Returns a list of all the commands\r\n". */
    const pdCOMMAND_LINE_CALLBACK pxCommandInterpreter; /* A pointer to the callback function that will return the output generated by the command. */
} CLI_Command_Definition_t;


extern char pcCliScratchBuffer[ CLI_OUTPUT_SCRATCH_BUF_LEN ];

/*
 * Register the command passed in using the pxCommandToRegister parameter.
 * Registering a command adds the command to the list of commands that are
 * handled by the command interpreter.  Once a command has been registered it
 * can be executed from the command line.
 */
BaseType_t FreeRTOS_CLIRegisterCommand( const CLI_Command_Definition_t * const pxCommandToRegister );

/*
 * @brief Runs the command interpreter for the command string "pcCommandInput".
 * @param[in] pxConsoleIO Pointer to a ConsoleIO object for the command to read/write to the console with.
 * @param[in] pcCommandInput Command input string to be parsed.
 */
void FreeRTOS_CLIProcessCommand( ConsoleIO_t * const pxConsoleIO,
                                 char * pcCommandInput );

/*-----------------------------------------------------------*/

/*
 * A buffer into which command outputs can be written is declared in the
 * main command interpreter, rather than in the command console implementation,
 * to allow application that provide access to the command console via multiple
 * interfaces to share a buffer, and therefore save RAM.  Note, however, that
 * the command interpreter itself is not re-entrant, so only one command
 * console interface can be used at any one time.  For that reason, no attempt
 * is made to provide any mutual exclusion mechanism on the output buffer.
 *
 * FreeRTOS_CLIGetOutputBuffer() returns the address of the output buffer.
 */
char * FreeRTOS_CLIGetOutputBuffer( void );

UART_HandleTypeDef * vInitUartEarly( void );

extern const CLI_Command_Definition_t xCommandDef_conf;
extern const CLI_Command_Definition_t xCommandDef_pki;
extern const CLI_Command_Definition_t xCommandDef_ps;
extern const CLI_Command_Definition_t xCommandDef_kill;
extern const CLI_Command_Definition_t xCommandDef_killAll;
extern const CLI_Command_Definition_t xCommandDef_heapStat;
extern const CLI_Command_Definition_t xCommandDef_reset;
extern const CLI_Command_Definition_t xCommandDef_uptime;
extern const CLI_Command_Definition_t xCommandDef_rngtest;
extern const CLI_Command_Definition_t xCommandDef_assert;

#endif /* _CLI_PRIV */