key_cmd.h

00001 /*******************************************************************************
00002 * DISCLAIMER
00003 * This software is supplied by Renesas Electronics Corporation and is only
00004 * intended for use with Renesas products. No other uses are authorized. This
00005 * software is owned by Renesas Electronics Corporation and is protected under
00006 * all applicable laws, including copyright laws.
00007 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00008 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
00009 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00010 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
00011 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
00012 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
00013 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
00014 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
00015 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00016 * Renesas reserves the right, without notice, to make changes to this software
00017 * and to discontinue the availability of this software. By using this software,
00018 * you agree to the additional terms and conditions found by accessing the
00019 * following link:
00020 * http://www.renesas.com/disclaimer*
00021 * Copyright (C) 2015 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 
00024 #ifndef KEY_CMD_H
00025 #define KEY_CMD_H
00026 
00027 #include "r_typedefs.h"
00028 #include "system.h"
00029 
00030 /*--- Macro definition ---*/
00031 #define CMD_INPUT_MAX_LEN   (32u)   /* Maximum length of the input from command-line. */
00032                                     /* (Including 'CR' character.) */
00033 
00034 /*--- User defined types ---*/
00035 /* Control data of command-line module */
00036 typedef struct {
00037     char_t          inp_str[CMD_INPUT_MAX_LEN]; /* Input string from command-line. */
00038     uint32_t        inp_len;                    /* Length of input string. */
00039 } cmd_ctrl_t;
00040 
00041 /** Initialises command-line module
00042  *
00043  *  @param p_ctrl Pointer to the control data of command-line module.
00044  */
00045 void cmd_init_proc(cmd_ctrl_t * const p_ctrl);
00046 
00047 /** Executes the main processing of command-line module
00048  *
00049  *  @param p_ctrl Pointer to the control data of command-line module.
00050  *
00051  *  @returns 
00052  *    Key code.
00053  */
00054 SYS_KeyCode cmd_main_proc(cmd_ctrl_t * const p_ctrl);
00055 
00056 #endif /* KEY_CMD_H */