Differences

This shows you the differences between two versions of the page.

--- code:code [2024/04/02 08:41] – Igor Yefmov
+++ code:code [2024/06/07 15:00] (current) – [Firmware version info C/C++-struct] Igor Yefmov
@@ Line 60: / Line 60: @@
 ===== Firmware version info C/C++-struct =====
-The FX3 version structure is as follows (little-endian memory layout):
+Both FX3 and FPGA version structures are as follows (little-endian memory layout):
 <code cpp firmware-version.h>
@@ Line 70: / Line 70: @@
     unsigned buildNo     : 13;
 };
+// [0, 3] = [hhhh'hvvv, pppp'pppp, bbbb'brrr, BBBB'BBBB]
 static_assert(sizeof(FwVersion) == 4);
 </code>
+For example the following sequence of bytes:
+<code>[0,3] = 0x0A 0x06 0x08 0x00</code> corresponds to:
+<code>vendor id  = 2
+H/W config = 1
+product    = 6
+build type = 0
+build#     = 1
+</code>
+and in little-endian memory layout is equivalent to a ''uint32_t'' value of ''0x0008`060A''
 ===== FX3 Version Info =====
 The version id is also encoded into the firmware image file name as:
@@ Line 90: / Line 100: @@
 |5|Gen 4 camera, a.k.a. "Vitreledonella"|
 |6|Gen 5 camera, either "Square One" or "Studio"|
-^  Release type  ^^
-|0|Private build: Private build for debugging and similar purposes |
-|1|Alpha: feature-incomplete early development cycle "somewhat stable" build |
-|2|Beta: feature-complete, but not very stable build (lots of bugs) |
-|3|Evaluation: Tech preview |
-|4|Release candidate: feature complete and stable |
-|5|Release: general availability |
-|6|Backport: backport of a feature from next gen camera |
-|7|Emergency bug fix: a critical post-release bugfix |
-^  Build number  ^^
-|#|Increments on each build|
 ===== FPGA Version Info =====
@@ Line 109: / Line 107: @@
 ====  Vendor ID that represents a vendor of the main computation unit  ====
 |Code |Value |
+^  Vendor ID((represents a vendor of the main computation unit))  ^^
 |1|Xilinx (AMD)|
 |2|Altera (Intel)|
+^  Hardware ID for %%VendorId%% ''1'' (Xylinx)  ^^
-====  Hardware ID for VendorId 1 (Xylinx)  ====
-|Code |Value |
 |1|Artix-7 100T|
 |2|Artix-7 200T|
 |3|Artix %%UltraScale+%% XCAU25P|
+^  Hardware ID for %%VendorId%% ''2'' (Altera)  ^^
-====  Hardware ID for VendorId 2 (Altera)  ====
-|Code |Value |
 |1|Cyclone 10 GX|
+^  Product ID  ^^
-====  Product ID  ====
-|Code |Value |
 |1|reserved|
 |2|reserved|
@@ Line 132: / Line 125: @@
 |7|Gen 5 camera, professional grade "Studio"|
-====  Release type  ====
+===== Shared parts of the Version Info =====
+Both types of Version Infor (FX3 and FPGA) share the same codes for defining build type and build number:
 |Code |Value |
-|0|Private build|
+^  Release type  ^^
-|1|Alpha|
+|0|Private build: Private build for debugging and similar purposes |
-|2|Beta|
+|1|Alpha: feature-incomplete early development cycle "somewhat stable" build |
-|3|Eval/Tech preview|
+|2|Beta: feature-complete, but not very stable build (lots of bugs) |
-|4|Release candidate|
+|3|Evaluation: Tech preview |
-|5|Release|
+|4|Release candidate: feature complete and stable |
-|6|Backport|
+|5|Release: general availability |
-|7|Emergency bug fix|
+|6|Backport: backport of a feature from next gen camera |
+|7|Emergency bug fix: a critical post-release bugfix |
-====  Build number  ====
+^  Build number  ^^
-|Code |Value |
+|#|''13'' bits of a build number (the range is ''1..8191''). Increments on each build|
-|#|''11'' bits of a build number (the range is ''1..2047''). Increments on each build|
@@ Line 151: / Line 144: @@
 Previous iterations had different bit layout for the Version Info, see details here: [[Firmware Versioning Evolution]]
 ----
-===== Vendor ID =====
-^Code ^Value ^
-|1|Cypress|
-===== Hardware ID =====
-^Code ^Value ^
-|1|FX3|
-===== Product ID =====
-^Code ^Value ^
-|1|reserved for Gen 1 camera, a.k.a. "Moon landing"|
-|2|reserved for Gen 2 camera, a.k.a. "Piggy"|
-|3|Gen 3 camera (Alpha), a.k.a. "Frankie" (from Frankenstein's Monster)|
-|4|Gen 3 camera, Production|
-|5|Gen 4 camera, a.k.a. "Vitreledonella"|
-|6|Gen 5 camera, either "Square One" or "Studio"|
-===== Release type =====
-^ Code ^ Name ^ Meaning ^
-|0|Private build| Private build for debugging and similar purposes |
-|1|Alpha| feature-incomplete early development cycle "somewhat stable" build |
-|2|Beta| feature-complete, but not very stable build (lots of bugs) |
-|3|Evaluation| Tech preview |
-|4|Release candidate| feature complete and stable |
-|5|Release| general availability |
-|6|Backport| backport of a feature from next gen camera |
-|7|Emergency bug fix| a critical post-release bugfix |
-===== Build number =====
-^Code ^Value ^
-|#|Increments on each build|
-====== FPGA Version Info ======
-The version id is also encoded into the firmware image file name as:
-<code><VendorID>_<HardwareID>_<ProductID>_<ReleaseType>_<BuildNumber></code>
-===== Vendor ID =====
-A ''3''-bit number that represents a vendor of the main computation unit
-^Code ^Value ^
-|1|Xilinx (AMD)|
-|2|Altera (Intel)|
-===== Hardware ID =====
-A ''5''-bit number that represents a model from the list in the following table:
-^%%VendorId%%^Code ^Value ^
-|1|1|Artix-7 100T|
-|1|2|Artix-7 200T|
-|1|3|Artix %%UltraScale+%% XCAU25P|
-|2|1|Cyclone 10 GX|
-===== Product ID =====
-An ''8''-bit number, unique to each product type from the table below:
-^Code ^Value ^
-|1|reserved|
-|2|reserved|
-|3|Gen 3 camera (Alpha), a.k.a. "Frankie"|
-|4|Gen 3 camera, Production|
-|5|Gen 4 camera, a.k.a. “Vitreledonella”|
-|6|Gen 5 camera, prosumer grade "Square One"|
-|7|Gen 5 camera, professional grade "Studio"|
-===== Release type =====
-Lower ''3'' bits of this ''5''-bit value map to a type of build below, the upper ''2'' bits are reserved for future use and must be ''b00''
-^Code ^Value ^
-|0|Private build|
-|1|Alpha|
-|2|Beta|
-|3|Eval/Tech preview|
-|4|Release candidate|
-|5|Release|
-|6|Backport|
-|7|Emergency bug fix|
-===== Build number =====
-''11'' bits of a build number (the range is ''1..2047'')
-^Code ^Value ^
-|#|Increments on each build|
 ====== FPGA config status - SPI codes ======

SUB2r

User Tools

Differences