Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
code:code [2024/04/01 04:07] – [Preface] Igor Yefmov | code:code [2024/05/18 22:49] – [Firmware version info C/C++-struct] Igor Yefmov | ||
---|---|---|---|
Line 2: | Line 2: | ||
Controlling the camera is done via writing " | Controlling the camera is done via writing " | ||
- | - standard UVC - this one is automagically supported by any UVC 1.1 compliant OS, which in the year 2017 would be "any modern OS". This interface covers the universally standardized controls for [[https:// | + | - [[https:// |
- | | + | |
- [[fx3_api|FX3 Host Vendor Command Interface]] - this interfaces with the Cypress' | - [[fx3_api|FX3 Host Vendor Command Interface]] - this interfaces with the Cypress' | ||
- [[fpga_registers_map|FPGA I²C Access]] - a " | - [[fpga_registers_map|FPGA I²C Access]] - a " | ||
+ | - (Gen 3 and Gen 4) direct I²C access via Cypress' | ||
If you are set on writing your own UI and don't want to be bothered too much with figuring out how to communicate with the camera you have an option of using the [[code: | If you are set on writing your own UI and don't want to be bothered too much with figuring out how to communicate with the camera you have an option of using the [[code: | ||
Line 73: | Line 73: | ||
</ | </ | ||
+ | For example the following sequence of bytes: | ||
+ | < | ||
+ | < | ||
+ | H/W config 1 | ||
+ | product 6 | ||
+ | build type 0 | ||
+ | build# 1 | ||
+ | </ | ||
+ | and in little-endian memory layout is equivalent to a '' | ||
===== FX3 Version Info ===== | ===== FX3 Version Info ===== | ||
The version id is also encoded into the firmware image file name as: | The version id is also encoded into the firmware image file name as: | ||
Line 90: | Line 99: | ||
|5|Gen 4 camera, a.k.a. " | |5|Gen 4 camera, a.k.a. " | ||
|6|Gen 5 camera, either " | |6|Gen 5 camera, either " | ||
- | ^ Release type ^^ | ||
- | |0|Private build: Private build for debugging and similar purposes | | ||
- | |1|Alpha: feature-incomplete early development cycle " | ||
- | |2|Beta: feature-complete, | ||
- | |3|Evaluation: | ||
- | |4|Release candidate: feature complete and stable | | ||
- | |5|Release: general availability | | ||
- | |6|Backport: | ||
- | |7|Emergency bug fix: a critical post-release bugfix | | ||
- | ^ Build number | ||
- | |# | ||
- | |||
===== FPGA Version Info ===== | ===== FPGA Version Info ===== | ||
Line 109: | Line 106: | ||
==== Vendor ID that represents a vendor of the main computation unit ==== | ==== Vendor ID that represents a vendor of the main computation unit ==== | ||
|Code |Value | | |Code |Value | | ||
+ | ^ Vendor ID((represents a vendor of the main computation unit)) | ||
|1|Xilinx (AMD)| | |1|Xilinx (AMD)| | ||
|2|Altera (Intel)| | |2|Altera (Intel)| | ||
- | + | ^ | |
- | ==== | + | |
- | |Code |Value | | + | |
|1|Artix-7 100T| | |1|Artix-7 100T| | ||
|2|Artix-7 200T| | |2|Artix-7 200T| | ||
|3|Artix %%UltraScale+%% XCAU25P| | |3|Artix %%UltraScale+%% XCAU25P| | ||
- | + | ^ | |
- | ==== | + | |
- | |Code |Value | | + | |
|1|Cyclone 10 GX| | |1|Cyclone 10 GX| | ||
- | + | ^ | |
- | ==== | + | |
- | |Code |Value | | + | |
|1|reserved| | |1|reserved| | ||
|2|reserved| | |2|reserved| | ||
Line 132: | Line 124: | ||
|7|Gen 5 camera, professional grade " | |7|Gen 5 camera, professional grade " | ||
- | ==== | + | ===== 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 | | |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 " |
- | |3|Eval/Tech preview| | + | |2|Beta: feature-complete, |
- | |4|Release candidate| | + | |3|Evaluation: |
- | |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 | | + | |# |
- | |# | + | |
---- | ---- | ||
- | ====== Firmware Versioning evolution ====== | + | Previous iterations had different bit layout for the Version Info, see details here: [[Firmware Versioning Evolution]] |
- | + | ---- | |
- | ====== FX3 Version Info ====== | + | |
- | The version id is also encoded into the firmware image file name as: | + | |
- | < | + | |
- | + | ||
- | ===== FX3 version info C/ | + | |
- | The FX3 version structure is as follows (little-endian memory layout): | + | |
- | + | ||
- | <code cpp firmware-version.h> | + | |
- | struct FwVersion{ | + | |
- | unsigned vendorId | + | |
- | unsigned hwCfgId | + | |
- | unsigned productId | + | |
- | #ifdef OLD_VER_FMT | + | |
- | unsigned releaseType : 5; | + | |
- | unsigned buildNo | + | |
- | #else | + | |
- | unsigned releaseType : 3; | + | |
- | unsigned buildNo | + | |
- | #endif | + | |
- | }; | + | |
- | static_assert(sizeof(FwVersion) == 4); | + | |
- | </ | + | |
- | + | ||
- | Prior to FPGA v. 89 there was no standard-compliant way of representing the version info in a C struct though (which is exactly what prompted the rework in the first place). | + | |
- | ==== Bit layout ==== | + | |
- | The bits are laid out in 4 sequential bytes as follows (depending on the version): | + | |
- | ^ version | + | |
- | ^ ::: ^ 7 ^ 6 ^ 5 ^ 4 ^ 3 ^ 2 ^ 1 ^ 0 ^ 7 ^ 6 ^ 5 ^ 4 ^ 3 ^ 2 ^ 1 ^ 0 ^ 7 ^ 6 ^ 5 ^ 4 ^ 3 ^ 2 ^ 1 ^ 0 ^ 7 ^ 6 ^ 5 ^ 4 ^ 3 ^ 2 ^ 1 ^ 0 ^ | + | |
- | | fx3< | + | |
- | | fx3< | + | |
- | | fx3> | + | |
- | + | ||
- | Because of the change in bit layout different byte sequences shown below are needed to produce the same result (exact same component values for the sake of simplicity and only as an illustration): | + | |
- | ^ version | + | |
- | .vendorId = 1 | + | |
- | .hwCfgId = 1 | + | |
- | .productId = 5 | + | |
- | .releaseType = 3 | + | |
- | .buildNo = 0x67</ | + | |
- | | fx3> | + | |
- | | fx3< | + | |
- | | fx3> | + | |
- | + | ||
- | ===== 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. " | + | |
- | |3|Gen 3 camera (Alpha), a.k.a. " | + | |
- | |4|Gen 3 camera, Production| | + | |
- | |5|Gen 4 camera, a.k.a. " | + | |
- | |6|Gen 5 camera, either " | + | |
- | + | ||
- | ===== Release type ===== | + | |
- | ^ Code ^ Name ^ Meaning ^ | + | |
- | |0|Private build| Private build for debugging and similar purposes | | + | |
- | |1|Alpha| feature-incomplete early development cycle " | + | |
- | |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 ^ | + | |
- | |# | + | |
- | + | ||
- | + | ||
- | ====== FPGA Version Info ====== | + | |
- | The version id is also encoded into the firmware image file name as: | + | |
- | < | + | |
- | + | ||
- | + | ||
- | ===== Vendor ID ===== | + | |
- | A '' | + | |
- | ^Code ^Value ^ | + | |
- | |1|Xilinx (AMD)| | + | |
- | |2|Altera (Intel)| | + | |
- | + | ||
- | ===== Hardware ID ===== | + | |
- | A '' | + | |
- | ^%%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 '' | + | |
- | ^Code ^Value ^ | + | |
- | |1|reserved| | + | |
- | |2|reserved| | + | |
- | |3|Gen 3 camera (Alpha), a.k.a. " | + | |
- | |4|Gen 3 camera, Production| | + | |
- | |5|Gen 4 camera, a.k.a. “Vitreledonella”| | + | |
- | |6|Gen 5 camera, prosumer grade " | + | |
- | |7|Gen 5 camera, professional grade " | + | |
- | ===== Release type ===== | + | |
- | Lower '' | + | |
- | ^Code ^Value ^ | + | |
- | |0|Private build| | + | |
- | |1|Alpha| | + | |
- | |2|Beta| | + | |
- | |3|Eval/ | + | |
- | |4|Release candidate| | + | |
- | |5|Release| | + | |
- | |6|Backport| | + | |
- | |7|Emergency bug fix| | + | |
- | + | ||
- | ===== Build number ===== | + | |
- | '' | + | |
- | ^Code ^Value ^ | + | |
- | |# | + | |
====== FPGA config status - SPI codes ====== | ====== FPGA config status - SPI codes ====== |