/**************************************************** * RFControlBoard_availableInterface.h * * Header file for the available interface for RFControlBoard * The uplink interface and APIs are realized here * * Created by: Zheqiao Geng, gengzq@slac.stanford.edu * Created on: 2011.04.12 * Description: Initial creation * * Modified by: Zheqiao Geng * Modified on: 2/7/2013 * Description: Specify the driver when creating the board ****************************************************/ #ifndef RF_CONTROL_BOARD_AVAILABLE_INTERFACE_H #define RF_CONTROL_BOARD_AVAILABLE_INTERFACE_H #include "RFControlBoard_main.h" #ifdef __cplusplus extern "C" { #endif /** * APIs that will be used for higher level modules */ /* Management of the modules (NOT REAL-TIME) */ int RFCB_API_createModule(const char *moduleName, const char * driverName); int RFCB_API_deleteModule(const char *moduleName); int RFCB_API_setupModule(const char *moduleName, const char *cmd, const char *dataStr); RFCB_struc_moduleData *RFCB_API_getModule(const char *moduleName); /* Register/buffer access from the board (REAL-TIME) */ #define RFCB_API_readRegister RFCB_func_readRegister /* rename the hardware access functions for API */ #define RFCB_API_writeRegister RFCB_func_writeRegister #define RFCB_API_readBuffer RFCB_func_readBuffer #define RFCB_API_writeBuffer RFCB_func_writeBuffer /* other functions */ #define RFCB_API_configureFPGA RFCB_func_configureFPGA /* FPGA configuration */ #define RFCB_API_pullInterrupt RFCB_func_pullInterrupt /* pull interrupt */ #define RFCB_API_getModuleStatus RFCB_func_getModuleStatus /* get status of the module */ #define RFCB_API_setupDMA RFCB_func_setupDMA #define RFCB_API_getDMADataPoolPtr RFCB_func_getDMADataPoolPtr #ifdef __cplusplus } #endif #endif