From e2de640f0142aeffad86254ce09be1623c9cd660 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joachim=20Str=C3=B6mbergson?= Date: Tue, 20 Aug 2024 13:32:13 +0200 Subject: [PATCH] Doc: Add README for the fw_ram. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Joachim Strömbergson --- hw/application_fpga/core/fw_ram/README.md | 25 +++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 hw/application_fpga/core/fw_ram/README.md diff --git a/hw/application_fpga/core/fw_ram/README.md b/hw/application_fpga/core/fw_ram/README.md new file mode 100644 index 0000000..fc06273 --- /dev/null +++ b/hw/application_fpga/core/fw_ram/README.md @@ -0,0 +1,25 @@ +# fw_ram +RAM for the firmware (FW). + + +## Introduction +This core implements the RAM exclusive to the FW. This allows the FW +to execute without having to use the application RAM. The core +supports mode based lock down to prevent any access in application +mode. + + +## API +The core does not have an API. + + +## Implementation Details +The core is implemented by explicitly instantiating one or more pairs +of SB_RAM40_4K RAM cores in the FPGA. + +The contents of the fw_ram is cleared when the FPGA is powered up and +configured by the bitstream. The contents is not cleared by a system +reset. + +If the fw_app_mode input is set, no memory accesses are allowed. Any +reads when the fw_app_mode is set will retun an all zero word.