RpcServer.h

00001 /*******************************************************************************
00002  * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 #ifndef _RPCSERVER_H_
00034 #define _RPCSERVER_H_
00035 
00036 #include "mbed.h"
00037 #include "RpcFifo.h"
00038 #include "Device_Logging.h"
00039 
00040 /**
00041 * @brief Reads the Version of the HSP FCache_Writel
00042 */
00043 int System_ReadVer(char argStrs[32][32], char replyStrs[32][32]);
00044 /**
00045 * @brief Reads the built time of the RPC FW
00046 */
00047 int System_ReadBuildTime(char argStrs[32][32], char replyStrs[32][32]);
00048 
00049 void RPC__init(void);
00050 void RPC__call(char *request, char *reply);
00051 fifo_t *GetUSBIncomingFifo(void);
00052 fifo_t *GetStreamOutFifo(void);
00053 
00054 /**
00055 * @brief Batch process RPC commands
00056 */
00057 void RPC_ProcessCmds(char *cmds);
00058 
00059 /**
00060 * @brief Initialize the RPC server with all of the commands that it supports
00061 */
00062 void RPC_init(void);
00063 
00064 /**
00065 * @brief Initialize the RPC server with all of the commands that it supports
00066 */
00067 void RPC_call(char *request, char *reply);
00068 
00069 /**
00070 * @brief Query to determine if flash pages are being transfered via RPC
00071 */
00072 bool RPC_IsTransferingFlashPages(void);
00073 
00074 /**
00075 * @brief Called to indicate that a flash page is being transfered via RPC, this reset a timer to detect multiple page transfers over time
00076 */
00077 void RPC_TransferingFlashPages(void) ;
00078 
00079 #endif // _RPCSERVER_H_