Index: firmware/App/Services/FPGA.h =================================================================== diff -u -rfc99f47309c9d96f73a2d4696b42d6d302f334a7 -rc74c1d99a011dd0fb7f98f183faecda675221fce --- firmware/App/Services/FPGA.h (.../FPGA.h) (revision fc99f47309c9d96f73a2d4696b42d6d302f334a7) +++ firmware/App/Services/FPGA.h (.../FPGA.h) (revision c74c1d99a011dd0fb7f98f183faecda675221fce) @@ -1,15 +1,27 @@ -/* - * FPGA.h - * - * Created on: Aug 15, 2024 - * Author: fw - */ #ifndef __FPGA_H__ #define __FPGA_H__ #include "BLCommon.h" +/** + * @defgroup FPGA FPGA + * @brief FPGA service unit. + * The FPGA unit manages communication between the bootloader and the FPGA via UART. + * This unit is driven by the Priority Task via calls to two FPGA executive functions: + * 1) Writes update data to the FPGA flash + * 2) Reads header, update register, FIFO count as well as the flash status + * This unit first reads the header record that includes the FPGA ID and revision and + * verifies the FPGA ID to check FPGA communication. + * + * @addtogroup FPGA + * @{ + */ + +// ********** public definitions ********** + +// ********** public function prototypes ********** + void initFPGA( void ); void execFPGA( void ); @@ -24,4 +36,6 @@ void signalFPGAToWriteToFlash( U08* data, U32 len ); void signalFPGAToSelfConfigure( void ); +/**@}*/ + #endif