documentation

BUILD_WITH_CMAKE.md

@@ -11,8 +11,6 @@ Install
 4. `graphviz`
 5. `rustup`  || Install using your packet manager or alternatively use the rust install script:  `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` (confirm default toolchain | nightly | complete | modify path variable: yes)
 
-
-
 6. At last: Satisfy Rust requirements 
 
 ```sh
@@ -28,8 +26,13 @@ cargo build -Z build-std
 
 FSBL is the First Stage Boot Loader and prepares the CPU and FPGA configuration for booting up the Second Stage Bootloader and finally the flight software.
 
+Before building, the correct `ps7_init.[c;h]` and some other configuration files need to be copied into the misc folder of the FSBL. The FSBL will run without this step, but some interfaces might not work as expected.
+
+These files are specific to the actual hardware used and located in the `bsp_z7/ps7_init` folder. The following examples assumes the zedboard.
+
 ```sh
 cd lib/sw_apps/zynq_fsbl/src
+cp romeo-obsw/bsp_z7/ps7_init/zedboard/* ../misc/zed/
 make BOARD=zed SHELL=/bin/bash
 ```
 

bsp_z7/lwip/README.md

@@ -1,8 +1,9 @@
-We provide two lwip configurations, bare and xilinx_eth. If the cmake option `ROMEO_Z7_USE_XIL_ETH` is selected, the xilinx_eth variant is used, otherwise the bare variant is used.
+We provide two lwip configurations, bare and xilinx_eth.
 
 Bare is the bare-metal minimal implementation. It tries to reduce code size and system complexity, using the bare API and a custom networking thread, handling all networking aspects.
-This configuration is meant to be run on the satellite obsw.
+This configuration is meant to be run on the satellite obsw. It is exported as library `lwip`.
 
-Xilinx_eth supports the xilinx ethernet core of the Zynq PS, inlcuding DMA. Unfortunately, the xilinx drivers require a custom sys_arch port.
+Xilinx_eth supports the xilinx ethernet core of the Zynq PS, inlcuding DMA. Unfortunately, the xilinx drivers require a custom sys_arch port and run a lot of additionals threads. Also, some code seems to be rather improvised. In sum, this code is not considered fit for orbit and kept out of the actual obsw except for special test cases.
-The xilinx_eth configuration is meant to be used with posix compatible calls, using the lwip sockets api and multiple threads running in the background.
+The xilinx_eth configuration is meant to be used with posix compatible calls, using the lwip sockets api.
-This configuration is meant to be run on debugging configurations or support equipment.
+This configuration is mainly used for the simulation interface which relies on an eth interface to communicate with the simulator.
+This code is exported as library `lwip_xil`.

bsp_z7/ps7_init/README.md

@@ -0,0 +1,7 @@
+`ps7_init.c` is used to initialize the hardware of the Zynq Processor.
+
+We try to adjust it so that the actual obsw does not need to configure interface parameters (they are fixed in that we know the parameters and they will not change during runtime).
+
+There might be additional files in the future besides `ps7_init.c`, all of which need to be copied into the ../misc/ folder of the fsbl before compiling.
+
+As these files are hardware dependent, subfolders for the platforms are provided.