From d96ff60ef978c763ef36ee49d459996993a2f235 Mon Sep 17 00:00:00 2001
From: Jason Kridner <jkridner@beagleboard.org>
Date: Wed, 1 May 2024 14:25:43 -0400
Subject: [PATCH] BeagleY-AI: move PCIe NVME demo
Helping out a little bit with https://openbeagle.org/docs/docs.beagleboard.io/-/merge_requests/105
---
boards/beagley/ai/02-quick-start.rst | 7 ++++++-
boards/beagley/ai/04-expansion.rst | 11 ++++++++++-
boards/beagley/ai/05-demos.rst | 7 ++++++-
.../beagley-ai-expansion-nvme.rst} | 8 +++++---
4 files changed, 27 insertions(+), 6 deletions(-)
rename boards/beagley/ai/{expansion/Booting from NVMe HATs.rst => demos/beagley-ai-expansion-nvme.rst} (98%)
diff --git a/boards/beagley/ai/02-quick-start.rst b/boards/beagley/ai/02-quick-start.rst
index bfd57bdc..e6f6338f 100644
--- a/boards/beagley/ai/02-quick-start.rst
+++ b/boards/beagley/ai/02-quick-start.rst
@@ -165,4 +165,9 @@ After successfully attaching the antenna, power up the board. Once booted you ca
.. code::
- ping 8.8.8.8
\ No newline at end of file
+ ping 8.8.8.8
+
+Demos and Tutorials
+*******************
+
+* :ref:`beagley-ai-expansion-nvme`
diff --git a/boards/beagley/ai/04-expansion.rst b/boards/beagley/ai/04-expansion.rst
index 049337b9..d20e9235 100644
--- a/boards/beagley/ai/04-expansion.rst
+++ b/boards/beagley/ai/04-expansion.rst
@@ -3,4 +3,13 @@
Expansion
#########
-* :ref:`beagley-ai-expansion-nvme`
\ No newline at end of file
+.. todo::
+
+ Describe how to build expansion hardware for BeagleY-AI
+
+PCIe
+****
+
+For software reference, you can see how PCIe is used on NVMe HATs.
+
+* :ref:`beagley-ai-expansion-nvme`
diff --git a/boards/beagley/ai/05-demos.rst b/boards/beagley/ai/05-demos.rst
index ff80e4cf..b32bba5d 100644
--- a/boards/beagley/ai/05-demos.rst
+++ b/boards/beagley/ai/05-demos.rst
@@ -1,4 +1,9 @@
.. _beagley-ai-demos:
Demos and tutorials
-####################
\ No newline at end of file
+####################
+
+.. toctree::
+ :maxdepth: 1
+
+ demos/beagley-ai-expansion-nvme
diff --git a/boards/beagley/ai/expansion/Booting from NVMe HATs.rst b/boards/beagley/ai/demos/beagley-ai-expansion-nvme.rst
similarity index 98%
rename from boards/beagley/ai/expansion/Booting from NVMe HATs.rst
rename to boards/beagley/ai/demos/beagley-ai-expansion-nvme.rst
index 9ec83cdd..b1b7761a 100644
--- a/boards/beagley/ai/expansion/Booting from NVMe HATs.rst
+++ b/boards/beagley/ai/demos/beagley-ai-expansion-nvme.rst
@@ -1,10 +1,12 @@
.. _beagley-ai-expansion-nvme:
-.. note:: This page is a work in progress. Further drive testing and images will be added soon
-
Booting from NVMe Drives
##########################
+.. todo:: remove notes about work-in-progress. they just make the site more janky.
+
+.. note:: This page is a work in progress. Further drive testing and images will be added soon
+
BeagleY-AI supports a PCI-Express x1 interface which enables data rates of up to 1GB/s for high speed expansion.
.. note:: While the SoC supports PCI-e Gen 3, the flat-flex connector required by HATs is only rated for PCI-e Gen 2, so, as is the case with other similar boards in this form factor, actual transfer speeds may be limited to Gen 2, depending on a variety of layout and environmental factors
@@ -151,4 +153,4 @@ You should see something similar to below without further errors:
Still having issues?
***
-Post on the (`Forum <https://forum.beagleboard.org/>`_.) and talk to us on Discord.
\ No newline at end of file
+Post on the (`Forum <https://forum.beagleboard.org/>`_.) and talk to us on Discord.
--
GitLab