From 5e1ef5e23dd3e594072f8f32cbb4a6f392d36e55 Mon Sep 17 00:00:00 2001
From: Amlal El Mahrouss <amlal@nekernel.org>
Date: Fri, 4 Apr 2025 09:05:35 +0200
Subject: fw/modules: add astdx for embdfs.

Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
---
 docs/SPECIFICATION_FIRMWARE.md    | 39 -----------------------------------
 docs/drawio/FIRMWARE.drawio       | 43 +++++++++++++++++++++++++++++++++++++++
 docs/md/SPECIFICATION_FIRMWARE.md | 39 +++++++++++++++++++++++++++++++++++
 3 files changed, 82 insertions(+), 39 deletions(-)
 delete mode 100644 docs/SPECIFICATION_FIRMWARE.md
 create mode 100644 docs/drawio/FIRMWARE.drawio
 create mode 100644 docs/md/SPECIFICATION_FIRMWARE.md

(limited to 'docs')

diff --git a/docs/SPECIFICATION_FIRMWARE.md b/docs/SPECIFICATION_FIRMWARE.md
deleted file mode 100644
index b0b40b4..0000000
--- a/docs/SPECIFICATION_FIRMWARE.md
+++ /dev/null
@@ -1,39 +0,0 @@
-==================================================================
-
-                     Multi Platform Firmware
-
-==================================================================
-
-==================================================================
-0. What we want:
-==================================================================
-
-- Optimized for each target.
-- EPM/GPT compilant.
-- AMD64, PowerPC, RISC-V, 64x0, 32x0 support.
-- SMP support.
-
-==================================================================
-1. How we're going to do that:
-==================================================================
-
-- Abstract Memory and I/O. (pci-tree)
-- Platform Independent Device Tree. (pci-tree)
-- Common Starting point for each core (smp)
-
-==================================================================
-2. Executable Layout:
-==================================================================
-
-- 0x80000000/0x00FF/0x1000: Firmware Startup Code
-- 0x90000000/0x7c00: Executable Information Header or equivalent.
-
-==================================================================
-3. Error Codes:
-==================================================================
-
-- CB0001: Not bootable to Stage2 (or bootloader).
-- CB0003: Bad arch.
-- CB0002: Context returned early.
-
-
diff --git a/docs/drawio/FIRMWARE.drawio b/docs/drawio/FIRMWARE.drawio
new file mode 100644
index 0000000..7cfc174
--- /dev/null
+++ b/docs/drawio/FIRMWARE.drawio
@@ -0,0 +1,43 @@
+<mxfile host="65bd71144e">
+    <diagram id="Y4IiTM2VAUaSzFU077Gh" name="Page-1">
+        <mxGraphModel dx="1144" dy="698" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+            <root>
+                <mxCell id="0"/>
+                <mxCell id="1" parent="0"/>
+                <mxCell id="2" value="EMBDFS (LAST BYTES TO BE LOADED BY BFL)" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="305" y="180" width="240" height="70" as="geometry"/>
+                </mxCell>
+                <mxCell id="5" style="edgeStyle=none;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="3" target="4">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="6" value="Loads Stage2 from" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="5">
+                    <mxGeometry x="-0.1733" relative="1" as="geometry">
+                        <mxPoint as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="7" style="edgeStyle=none;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;" edge="1" parent="1" source="3" target="2">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="8" value="Loads Driver from" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="7">
+                    <mxGeometry x="0.15" y="-2" relative="1" as="geometry">
+                        <mxPoint as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="3" value="BASE FIRMWARE LAYER (FIRST BYTES&lt;div&gt;TO BE LOADED)&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="305" y="370" width="240" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="9" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="4" target="3">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="10" value="If Stage2 part, load it and replace current context&lt;div&gt;with Stage2&lt;/div&gt;" style="edgeLabel;html=1;align=left;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="9">
+                    <mxGeometry x="0.414" y="-2" relative="1" as="geometry">
+                        <mxPoint as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="4" value="EPM Partition" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;" vertex="1" parent="1">
+                    <mxGeometry x="30" y="540" width="190" height="70" as="geometry"/>
+                </mxCell>
+            </root>
+        </mxGraphModel>
+    </diagram>
+</mxfile>
\ No newline at end of file
diff --git a/docs/md/SPECIFICATION_FIRMWARE.md b/docs/md/SPECIFICATION_FIRMWARE.md
new file mode 100644
index 0000000..39aa2a0
--- /dev/null
+++ b/docs/md/SPECIFICATION_FIRMWARE.md
@@ -0,0 +1,39 @@
+==================================================================
+
+                     Multi Platform Firmware
+
+==================================================================
+
+==================================================================
+0. What the objective:
+==================================================================
+
+- Optimized for each target.
+- EPM/GPT compilant.
+- AMD64, PowerPC, RISC-V, 64x0, 32x0 support.
+- SMP support.
+
+==================================================================
+1. How we're going to do that:
+==================================================================
+
+- Abstract Memory and I/O. (pci-tree)
+- Platform Independent Device Tree. (pci-tree)
+- Common Starting point for each core (smp)
+
+==================================================================
+2. Executable Layout:
+==================================================================
+
+- 0x80000000/0x00FF/0x0000: Firmware Startup Code
+- 0x90000000/0x7c00: Linear Header or EPM partition.
+
+==================================================================
+3. Error Codes:
+==================================================================
+
+- CB0001: Not bootable to Stage2 (or bootloader).
+- CB0003: Bad arch.
+- CB0002: Context returned early.
+
+
-- 
cgit v1.2.3