diff --git a/boards/beaglev/fire/gateware/gateware-howto-find-out-whats-on-the-board.rst b/boards/beaglev/fire/gateware/gateware-howto-find-out-whats-on-the-board.rst new file mode 100644 index 0000000000000000000000000000000000000000..91c267676b0064a48e8cf84d7a5e043df512f8a7 --- /dev/null +++ b/boards/beaglev/fire/gateware/gateware-howto-find-out-whats-on-the-board.rst @@ -0,0 +1,54 @@ +How to find out what gateware is programmed on a BeagleV-Fire +############################################################# + +There are two methods to find out what gateware is programmed on a board. + +Device Tree +=========== +The device tree overlays contains the list of gateware blocks included in the overall gateware design. +You can retrieve that information using the following command: + +.. code-block:: + + tree /proc/device-tree/chosen/overlays/ + +This should give an output similar to the one below. + +.. figure:: media/dts-design-info.png + :align: center + +The gateware version can be retrieve by reading one of the overlay files. For example, the command: + +.. code-block:: + + cat /proc/device-tree/chosen/overlays/ROBOTICS-CAPE-GATEWARE + + +should result in: + +.. figure:: media/dts-design-version.png + :align: center + +where the result of a "git describe" command on the gateware repository is displayed. This provides the +most recent tag on the gateware repository followed by information about additionanl commits if some +exist. In the example above, the gateware was created from a gateware repository hash 3e0d338 which is +5 commits more recent than tag BVF-0.3.0. + +Bootloader messages +=================== +The Hart Software Services display the gateware design name and design version retrieve from the FPGA +at system start-up. + +.. figure:: media/hss-design-info.png + :align: center + +The design name is the name of the build option selected when using the bitstream-builder to generate +the bitstream. The number at the end of the design name is the hash of the gateware repository used +to build the bitstream. + +The design version is specified as part of the bitstream-builder build configuration option. + +Please note that design name "BVF_GATEWARE" indicates that the bitstream used to program the board was +generated directly from the gateware repositories scripts and not the bitstream-builder. You might +see this when customizing the gateware. Seeing "BVF_GATEWARE" as the design name should be a warning +sign that there is a disconnect between the hardware and software on your board. diff --git a/boards/beaglev/fire/gateware/media/dts-design-info.png b/boards/beaglev/fire/gateware/media/dts-design-info.png new file mode 100644 index 0000000000000000000000000000000000000000..a97eb3351c3dc6496f99821f4da5bd0128e50b91 Binary files /dev/null and b/boards/beaglev/fire/gateware/media/dts-design-info.png differ diff --git a/boards/beaglev/fire/gateware/media/dts-design-version.png b/boards/beaglev/fire/gateware/media/dts-design-version.png new file mode 100644 index 0000000000000000000000000000000000000000..a848d98bf719372ae1a1e9e7dceee8026b88e038 Binary files /dev/null and b/boards/beaglev/fire/gateware/media/dts-design-version.png differ diff --git a/boards/beaglev/fire/gateware/media/hss-design-info.png b/boards/beaglev/fire/gateware/media/hss-design-info.png new file mode 100644 index 0000000000000000000000000000000000000000..723a8f4b15f708c30e601defa56748c48c375cd6 Binary files /dev/null and b/boards/beaglev/fire/gateware/media/hss-design-info.png differ