fix comment

gullradriel · gullradriel · commit 7ab79fb3da2b · 2026-02-20T08:18:36.000+01:00
diff --git a/firmware/common/fpga_image.c b/firmware/common/fpga_image.c
@@ -75,9 +75,9 @@ static size_t spifi_fpga_read_block_cb(void* _ctx, uint8_t* out_buffer)
 	return lz4_blk_decompress(ctx->buffer, out_buffer, block_sz);
 }
 
-// @brief  Loads the FPGA bitstream from RAM
-// @param index
-// @return
+// @brief Load FPGA bitstream from SPIFI flash memory and program the FPGA.
+// @param index Index of the FPGA bitstream to load from flash.
+// @return true on success, false on failure.
 static bool fpga_image_load_from_spifi(unsigned int index)
 {
 // PRALINE: FPGA bitstream is in flash at 0x380000 (SPIFI mapped at 0x14380000)

Original file line number	Diff line number	Diff line change
`@@ -75,9 +75,9 @@ static size_t spifi_fpga_read_block_cb(void* _ctx, uint8_t* out_buffer)`
`75`	`75`	`return lz4_blk_decompress(ctx->buffer, out_buffer, block_sz);`
`76`	`76`	`}`
`77`	`77`
`78`		`-// @brief Loads the FPGA bitstream from RAM`
`79`		`-// @param index`
`80`		`-// @return`
	`78`	`+// @brief Load FPGA bitstream from SPIFI flash memory and program the FPGA.`
	`79`	`+// @param index Index of the FPGA bitstream to load from flash.`
	`80`	`+// @return true on success, false on failure.`
`81`	`81`	`static bool fpga_image_load_from_spifi(unsigned int index)`
`82`	`82`	`{`
`83`	`83`	`// PRALINE: FPGA bitstream is in flash at 0x380000 (SPIFI mapped at 0x14380000)`