Wilson Tang / Mbed OS HSP_RPC_GUI

Fork of the offical HSP_RPC_GUI firmware

Dependencies:   USBDevice

Fork of MAXREFDES100 firmware for MAX32620HSP

HSP/RpcServer/RpcServer.h@4:18155622d30a, 2020-01-28 (annotated)

Committer:
wt8008
Date:
Tue Jan 28 20:22:16 2020 +0000
Revision:
4:18155622d30a
Parent:
3:8e9b9f5818aa 
Update Maxim's USBDevice project to the latest version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jbradshaw 0:e4a10ed6eb92 1 /*******************************************************************************
jbradshaw 0:e4a10ed6eb92 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
jbradshaw 0:e4a10ed6eb92 3 *
jbradshaw 0:e4a10ed6eb92 4 * Permission is hereby granted, free of charge, to any person obtaining a
jbradshaw 0:e4a10ed6eb92 5 * copy of this software and associated documentation files (the "Software"),
jbradshaw 0:e4a10ed6eb92 6 * to deal in the Software without restriction, including without limitation
jbradshaw 0:e4a10ed6eb92 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
jbradshaw 0:e4a10ed6eb92 8 * and/or sell copies of the Software, and to permit persons to whom the
jbradshaw 0:e4a10ed6eb92 9 * Software is furnished to do so, subject to the following conditions:
jbradshaw 0:e4a10ed6eb92 10 *
jbradshaw 0:e4a10ed6eb92 11 * The above copyright notice and this permission notice shall be included
jbradshaw 0:e4a10ed6eb92 12 * in all copies or substantial portions of the Software.
jbradshaw 0:e4a10ed6eb92 13 *
jbradshaw 0:e4a10ed6eb92 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
jbradshaw 0:e4a10ed6eb92 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jbradshaw 0:e4a10ed6eb92 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
jbradshaw 0:e4a10ed6eb92 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
jbradshaw 0:e4a10ed6eb92 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
jbradshaw 0:e4a10ed6eb92 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
jbradshaw 0:e4a10ed6eb92 20 * OTHER DEALINGS IN THE SOFTWARE.
jbradshaw 0:e4a10ed6eb92 21 *
jbradshaw 0:e4a10ed6eb92 22 * Except as contained in this notice, the name of Maxim Integrated
jbradshaw 0:e4a10ed6eb92 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
jbradshaw 0:e4a10ed6eb92 24 * Products, Inc. Branding Policy.
jbradshaw 0:e4a10ed6eb92 25 *
jbradshaw 0:e4a10ed6eb92 26 * The mere transfer of this software does not imply any licenses
jbradshaw 0:e4a10ed6eb92 27 * of trade secrets, proprietary technology, copyrights, patents,
jbradshaw 0:e4a10ed6eb92 28 * trademarks, maskwork rights, or any other form of intellectual
jbradshaw 0:e4a10ed6eb92 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
jbradshaw 0:e4a10ed6eb92 30 * ownership rights.
jbradshaw 0:e4a10ed6eb92 31 *******************************************************************************
jbradshaw 0:e4a10ed6eb92 32 */
jbradshaw 0:e4a10ed6eb92 33 #ifndef _RPCSERVER_H_
jbradshaw 0:e4a10ed6eb92 34 #define _RPCSERVER_H_
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 37 #include "RpcFifo.h"
jbradshaw 0:e4a10ed6eb92 38 #include "Device_Logging.h"
jbradshaw 0:e4a10ed6eb92 39
jbradshaw 0:e4a10ed6eb92 40 /**
jbradshaw 0:e4a10ed6eb92 41 * @brief Reads the Version of the HSP FCache_Writel
jbradshaw 0:e4a10ed6eb92 42 */
jbradshaw 0:e4a10ed6eb92 43 int System_ReadVer(char argStrs[32][32], char replyStrs[32][32]);
jbradshaw 0:e4a10ed6eb92 44 /**
jbradshaw 0:e4a10ed6eb92 45 * @brief Reads the built time of the RPC FW
jbradshaw 0:e4a10ed6eb92 46 */
jbradshaw 0:e4a10ed6eb92 47 int System_ReadBuildTime(char argStrs[32][32], char replyStrs[32][32]);
jbradshaw 0:e4a10ed6eb92 48
jbradshaw 0:e4a10ed6eb92 49 void RPC__init(void);
jbradshaw 0:e4a10ed6eb92 50 void RPC__call(char *request, char *reply);
jbradshaw 0:e4a10ed6eb92 51 fifo_t *GetUSBIncomingFifo(void);
jbradshaw 0:e4a10ed6eb92 52 fifo_t *GetStreamOutFifo(void);
jbradshaw 3:8e9b9f5818aa 53
jbradshaw 0:e4a10ed6eb92 54 /**
jbradshaw 0:e4a10ed6eb92 55 * @brief Batch process RPC commands
jbradshaw 0:e4a10ed6eb92 56 */
jbradshaw 0:e4a10ed6eb92 57 void RPC_ProcessCmds(char *cmds);
jbradshaw 3:8e9b9f5818aa 58
jbradshaw 0:e4a10ed6eb92 59 /**
jbradshaw 0:e4a10ed6eb92 60 * @brief Initialize the RPC server with all of the commands that it supports
jbradshaw 0:e4a10ed6eb92 61 */
jbradshaw 0:e4a10ed6eb92 62 void RPC_init(void);
jbradshaw 3:8e9b9f5818aa 63
jbradshaw 0:e4a10ed6eb92 64 /**
jbradshaw 0:e4a10ed6eb92 65 * @brief Initialize the RPC server with all of the commands that it supports
jbradshaw 0:e4a10ed6eb92 66 */
jbradshaw 0:e4a10ed6eb92 67 void RPC_call(char *request, char *reply);
jbradshaw 0:e4a10ed6eb92 68
jbradshaw 3:8e9b9f5818aa 69 /**
jbradshaw 3:8e9b9f5818aa 70 * @brief Query to determine if flash pages are being transfered via RPC
jbradshaw 3:8e9b9f5818aa 71 */
jbradshaw 3:8e9b9f5818aa 72 bool RPC_IsTransferingFlashPages(void);
jbradshaw 3:8e9b9f5818aa 73
jbradshaw 3:8e9b9f5818aa 74 /**
jbradshaw 3:8e9b9f5818aa 75 * @brief Called to indicate that a flash page is being transfered via RPC, this reset a timer to detect multiple page transfers over time
jbradshaw 3:8e9b9f5818aa 76 */
jbradshaw 3:8e9b9f5818aa 77 void RPC_TransferingFlashPages(void) ;
jbradshaw 3:8e9b9f5818aa 78
jbradshaw 0:e4a10ed6eb92 79 #endif // _RPCSERVER_H_