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/02/17 15:28] – Igor Yefmov | code:code [2024/04/02 08:41] – Igor Yefmov | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | Controlling the camera is done via writing " | + | ====== Preface ====== |
- | - 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:// | + | |
- | - (Gen 3 and Gen 4) direct I²C access via Cypress' | + | |
- | - FX3 Host Vendor Command Interface - this interfaces with the Cypress' | + | |
- | - FPGA I²C Access - a " | + | |
- | The last two ([[code:fx3_hvci_and_fpga_i_c_commands# | + | Controlling the camera is done via writing " |
+ | - [[https:// | ||
+ | - [[fx3_api|FX3 Host Vendor Command Interface]] - this interfaces with the Cypress' | ||
+ | - [[fpga_registers_map|FPGA I²C Access]] - a " | ||
+ | - (Gen 3 and Gen 4) direct | ||
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 49: | Line 49: | ||
---- | ---- | ||
+ | |||
+ | ====== Firmware Version Info ====== | ||
+ | This applies to both FX3 and FPGA firmware version info data structures. | ||
+ | |||
+ | ===== Bit layout ===== | ||
+ | The bits are laid out in 4 sequential bytes as follows: | ||
+ | ^ 3 ^^^^^^^^ | ||
+ | ^ 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 ^ | ||
+ | | buildNo[12: | ||
+ | |||
+ | ===== Firmware 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 | ||
+ | unsigned releaseType : 3; | ||
+ | unsigned buildNo | ||
+ | }; | ||
+ | static_assert(sizeof(FwVersion) == 4); | ||
+ | </ | ||
+ | |||
+ | |||
+ | ===== FX3 Version Info ===== | ||
+ | The version id is also encoded into the firmware image file name as: | ||
+ | < | ||
+ | |||
+ | |Code |Value | | ||
+ | ^ Vendor ID ^^ | ||
+ | |1|Cypress| | ||
+ | ^ Hardware ID ^^ | ||
+ | |1|FX3 Gen1| | ||
+ | ^ Product ID ^^ | ||
+ | |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 ^^ | ||
+ | |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 ===== | ||
+ | The version id is also encoded into the firmware image file name as: | ||
+ | < | ||
+ | |||
+ | ==== Vendor ID that represents a vendor of the main computation unit ==== | ||
+ | |Code |Value | | ||
+ | |1|Xilinx (AMD)| | ||
+ | |2|Altera (Intel)| | ||
+ | |||
+ | ==== 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) | ||
+ | |Code |Value | | ||
+ | |1|Cyclone 10 GX| | ||
+ | |||
+ | ==== Product ID ==== | ||
+ | |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 ==== | ||
+ | |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 | | ||
+ | |# | ||
+ | |||
+ | |||
+ | ---- | ||
+ | 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. " | ||
+ | |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, | ||
+ | |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 ====== | ||
+ | These are the status bits that indicate the FPGA programming (reconfiguring) process: | ||
+ | ^ Bit name ^ Description ^ | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||
+ | |'' | ||