From 79fc22b437c8e76a1a0d652e2ffc5bb5c9443343 Mon Sep 17 00:00:00 2001 From: Jason Kridner <jkridner@beagleboard.org> Date: Sat, 4 Nov 2023 17:58:53 -0400 Subject: [PATCH] bvf: add todos to simplify! --- boards/beaglev/fire/02-quick-start.rst | 3 ++- boards/beaglev/fire/05-demos.rst | 4 ++-- .../beaglev/fire/demos-and-tutorials/flashing-board.rst | 6 ++++++ .../mchp-fpga-tools-installation-guide.rst | 9 +++++++++ 4 files changed, 19 insertions(+), 3 deletions(-) diff --git a/boards/beaglev/fire/02-quick-start.rst b/boards/beaglev/fire/02-quick-start.rst index 53f58af2..443a1e3d 100644 --- a/boards/beaglev/fire/02-quick-start.rst +++ b/boards/beaglev/fire/02-quick-start.rst @@ -75,7 +75,8 @@ It will be different for Mac and Windows operatig systems. To find serial port f Demos and Tutorials ******************* -* :ref:`beaglev-fire-flashing-board` * :ref:`beaglev-fire-gateware-version` +* :ref:`beaglev-fire-flashing-board` * :ref:`beaglev-fire-gateware-design` +* :ref:`beaglev-fire-mchp-fpga-tools-installation-guide` diff --git a/boards/beaglev/fire/05-demos.rst b/boards/beaglev/fire/05-demos.rst index 1c2a2c69..ad003fa2 100644 --- a/boards/beaglev/fire/05-demos.rst +++ b/boards/beaglev/fire/05-demos.rst @@ -16,5 +16,5 @@ Demos demos-and-tutorials/flashing-board demos-and-tutorials/mchp-fpga-tools-installation-guide - demos-and-tutorials/gateware - demos-and-tutorials/gateware/how-to-find-out-whats-on-the-board.rst + demos-and-tutorials/gateware/index + demos-and-tutorials/gateware/how-to-find-out-whats-on-the-board diff --git a/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst b/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst index ae933e47..52d52f6a 100644 --- a/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst +++ b/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst @@ -3,6 +3,12 @@ Flashing gateware and Linux image ################################## +.. todo:: + + This is the *hard* way! Special cables and FlashPros are not required when using the firmware we initially ship on the board. This tutorial should be + rescripted as how to _unbrick_ your board. Also, we have other work-arounds using software and GPIOs rather than FlashPros. Let's not put this in user's + face as *the* experience when it is far more painful than using the `change-gateware.sh` script and "hold BOOT button when applying power" solutions we've created! + In this tutorial we are going to learn to flash the gateware image to FPGA and ``sdcard.image`` to eMMC storage. diff --git a/boards/beaglev/fire/demos-and-tutorials/mchp-fpga-tools-installation-guide.rst b/boards/beaglev/fire/demos-and-tutorials/mchp-fpga-tools-installation-guide.rst index a0bfe8c1..eafcae5f 100644 --- a/boards/beaglev/fire/demos-and-tutorials/mchp-fpga-tools-installation-guide.rst +++ b/boards/beaglev/fire/demos-and-tutorials/mchp-fpga-tools-installation-guide.rst @@ -5,6 +5,15 @@ Microchip FPGA Tools Installation Guide Instructions for installing the Microchip FPGA tools on a Ubuntu 20.04 desktop. +.. important:: + + We will be providing instances of Libero that you can run from git.beagleboard.org's gitlab-runners such that you do not need to install the tools on + your local machine. + +.. todo:: + + Make sure people know about the alternative and we provide links to details on that before we send them down this process. + Install Libero 2022.3 ************************ -- GitLab