Skip to content

Feature/axi4 l register interface update #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Paebbels merged 6 commits into from
Feb 17, 2026
Merged

Feature/axi4 l register interface update #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
866e3f6
Add output port for GitVersionRegister with its register content as r…
stefanunrein Nov 23, 2025
ffa6f1b
Add missing sources to TerosHDL project file
stefanunrein Nov 23, 2025
62abd4c
fix function declaration
stefanunrein Nov 24, 2025
bf3b5b0
create function for reading mem-content directly into record-constant
stefanunrein Nov 24, 2025
bcc92dd
Add description for constant usage
stefanunrein Nov 24, 2025
f5bca12
Apply suggestion
stefanunrein Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion prj/TerosHDL/PileOfCores_TerosHDL.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: PileOfCores
project_disk_path: ''
project_type: genericProject
toplevel: ../../src/bus/axi4/AXI4Lite/AXI4Lite_Register.vhdl
toplevel: ../../src/bus/axi4/AXI4Lite/AXI4Lite_GitVersionRegister.vhdl
files:
- name: ../../src/common/common.vhdl
file_type: vhdlSource
Expand Down Expand Up @@ -1909,6 +1909,22 @@ files:
logical_name: PoC
is_manual: true
source_type: none
- name: ../../src/bus/axi4/AXI4Lite/AXI4Lite_GitVersionRegister.vhdl
file_type: vhdlSource
file_version: '2008'
is_include_file: false
include_path: ''
logical_name: PoC
is_manual: true
source_type: none
- name: ../../src/mem/mem_GitVersionRegister.pkg.vhdl
file_type: vhdlSource
file_version: '2008'
is_include_file: false
include_path: ''
logical_name: PoC
is_manual: true
source_type: none
hooks:
pre_build: []
post_build: []
Expand Down
17 changes: 13 additions & 4 deletions src/bus/axi4/AXI4Lite/AXI4Lite_GitVersionRegister.vhdl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@
-- This version register can be auto filled with constants from Git. Software
-- can read from what revision a firmware (bitstream, PL code) was build.
--
-- The Version-out-Port is used to make all values accessible to the PL. This
-- can be used by another interface than AXI4L, if necessary.
-- If you dont need the UID field, use this to directly create a constant out of
-- the mem-file:
-- constant My_Version : T_VersionRegister := to_VersionRegister(MEM_PATH);
--
-- Use the pre-synthesis script from
-- PoC/tools/git/preSynth_GitVersionRegister_Vivado.tcl
-- to create a memory file with all necessary information. Add this file name to
Expand Down Expand Up @@ -62,14 +68,16 @@ entity AXI4Lite_GitVersionRegister is
Reset : in std_logic;

AXI4Lite_m2s : in T_AXI4Lite_BUS_M2S;
AXI4Lite_s2m : out T_AXI4Lite_BUS_S2M
AXI4Lite_s2m : out T_AXI4Lite_BUS_S2M;

Version : out T_VersionRegister
);
end entity;


architecture rtl of AXI4Lite_GitVersionRegister is
constant CONFIG : T_AXI4_Register_Vector := get_Version_Descriptor;
constant VersionData : T_SLVV_32(0 to C_Num_Version_Header - 1) := read_Version_from_mem(PROJECT_DIR & VERSION_FILE_NAME);
constant VersionData : T_SLVV_32(0 to C_Num_VersionHeader - 1) := read_Version_from_mem(PROJECT_DIR & VERSION_FILE_NAME);

signal RegisterFile_ReadPort : T_SLVV(0 to CONFIG'Length -1)(DATA_BITS - 1 downto 0);
signal RegisterFile_WritePort : T_SLVV(0 to CONFIG'Length -1)(DATA_BITS - 1 downto 0);
Expand Down Expand Up @@ -98,8 +106,9 @@ begin
RegisterFile_ReadPort => RegisterFile_ReadPort,
RegisterFile_WritePort => RegisterFile_WritePort
);
RegisterFile_WritePort(0 to C_Num_Version_Header -1) <= VersionData;
RegisterFile_WritePort(C_Num_Version_Header to C_Num_Version_Register -1) <= UID_vec;
RegisterFile_WritePort(0 to C_Num_VersionHeader -1) <= VersionData;
RegisterFile_WritePort(C_Num_VersionHeader to C_Num_VersionRegister -1) <= UID_vec;
Version <= to_VersionRegister(RegisterFile_ReadPort);

---------------------------------
-- Generate data for UID-vector
Expand Down
133 changes: 102 additions & 31 deletions src/mem/mem_GitVersionRegister.pkg.vhdl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,28 @@ package mem_GitVersionRegister is
constant Address_Width : natural := 32;
constant Data_Width : natural := 32;

type T_Version_Register_Common is record
type T_VersionRegister_Common is record
BuildDate_Day : std_logic_vector(7 downto 0);
BuildDate_Month : std_logic_vector(7 downto 0);
BuildDate_Year : std_logic_vector(15 downto 0);

NumberModule : std_logic_vector(23 downto 0);
VersionOfVersionReg : std_logic_vector(7 downto 0);

VivadoVersion_Year : std_logic_vector(15 downto 0);
VivadoVersion_Release : std_logic_vector(7 downto 0);
VivadoVersion_SubRelease : std_logic_vector(7 downto 0);
ToolVersion_Year : std_logic_vector(15 downto 0);
ToolVersion_Release : std_logic_vector(7 downto 0);
ToolVersion_SubRelease : std_logic_vector(7 downto 0);

ProjektName : std_logic_vector(159 downto 0);
end record;

type T_Version_Register_Top is record
type T_VersionRegister_Top is record
Version_Major : std_logic_vector(7 downto 0);
Version_Minor : std_logic_vector(7 downto 0);
Version_Release : std_logic_vector(7 downto 0);
Version_Flags : std_logic_vector(7 downto 0);
Version_CommitsToTag : std_logic_vector(5 downto 0);
Version_DirtyUntracked : std_logic;
Version_DirtyModified : std_logic;

GitHash : std_logic_vector(159 downto 0);

Expand All @@ -88,54 +90,62 @@ package mem_GitVersionRegister is
GitURL : std_logic_vector(1023 downto 0);
end record;

type T_Version_Register_UID is record
type T_VersionRegister_UID is record
UID : std_logic_vector(127 downto 0);
User_eFuse : std_logic_vector(31 downto 0);
User_ID : std_logic_vector(95 downto 0);
end record;

constant C_VERSION_REGISTER_UID_INIT : T_Version_Register_UID := (
type T_VersionRegister is record
Common : T_VersionRegister_Common;
Top : T_VersionRegister_Top;
UID : T_VersionRegister_UID;
end record;

constant C_VersionRegister_UID_INIT : T_VersionRegister_UID := (
UID => (others => '0'),
User_eFuse => (others => '0'),
User_ID => (others => '0')
);

constant C_Num_reg_UID_vec : T_NATVEC := (
0 => C_VERSION_REGISTER_UID_INIT.UID'length / 32,
1 => C_VERSION_REGISTER_UID_INIT.User_eFuse'length / 32,
2 => C_VERSION_REGISTER_UID_INIT.User_ID'length / 32
0 => C_VersionRegister_UID_INIT.UID'length / 32,
1 => C_VersionRegister_UID_INIT.User_eFuse'length / 32,
2 => C_VersionRegister_UID_INIT.User_ID'length / 32
);

constant C_Num_Reg_Common : natural := 8;
constant C_Num_Reg_Top : natural := 56;
constant C_Num_Reg_UID : natural := isum(C_Num_reg_UID_vec);


constant C_Num_Version_Header : natural := C_Num_Reg_Common + C_Num_Reg_Top;
constant C_Num_Version_Register : natural := C_Num_Version_Header + C_Num_Reg_UID;
constant C_Num_VersionHeader : natural := C_Num_Reg_Common + C_Num_Reg_Top;
constant C_Num_VersionRegister : natural := C_Num_VersionHeader + C_Num_Reg_UID;

function to_SLVV_32_Common (data : T_Version_Register_Common) return T_SLVV_32;
function to_SLVV_32_Top (data : T_Version_Register_Top) return T_SLVV_32;
function to_SLVV_32_Common (data : T_VersionRegister_Common) return T_SLVV_32;
function to_SLVV_32_Top (data : T_VersionRegister_Top) return T_SLVV_32;
function to_VersionRegister (registerValues : T_SLVV) return T_VersionRegister;
function get_Dummy_Descriptor(len : natural) return T_AXI4_Register_Vector;

function get_Version_Descriptor return T_AXI4_Register_Vector;

impure function read_Version_from_mem(FileName : string) return T_SLVV_32;
impure function to_VersionRegister (FileName : string) return T_VersionRegister;
end package;


package body mem_GitVersionRegister is

function get_Version_Descriptor return T_AXI4_Register_Vector is
variable temp : T_AXI4_Register_Vector(0 to 127);
variable temp : T_AXI4_Register_Vector(0 to C_Num_VersionRegister -1);
variable pos : natural := 0;
variable addr : natural := 0;
begin
temp(pos) := to_AXI4_Register(Name => "Common.BuildDate", Address => to_unsigned(addr, 32), RegisterMode => ReadOnly_NotRegistered);
addr := addr +4; pos := pos +1;
temp(pos) := to_AXI4_Register(Name => "Common.NumberModule_VersionOfVersionReg", Address => to_unsigned(addr, 32), RegisterMode => ReadOnly_NotRegistered);
addr := addr +4; pos := pos +1;
temp(pos) := to_AXI4_Register(Name => "Common.VivadoVersion", Address => to_unsigned(addr, 32), RegisterMode => ReadOnly_NotRegistered);
temp(pos) := to_AXI4_Register(Name => "Common.ToolVersion", Address => to_unsigned(addr, 32), RegisterMode => ReadOnly_NotRegistered);
addr := addr +4; pos := pos +1;
for i in 0 to 4 loop
temp(pos) := to_AXI4_Register(Name => "Common.ProjektName(" & integer'image(i) & ")", Address => to_unsigned(addr, 32), RegisterMode => ReadOnly_NotRegistered);
Expand Down Expand Up @@ -176,6 +186,55 @@ package body mem_GitVersionRegister is
return temp(0 to pos -1);
end function;

function to_VersionRegister (registerValues : T_SLVV) return T_VersionRegister is
variable temp : T_VersionRegister;
begin
temp.Common.BuildDate_Day := registerValues(0)(31 downto 24);
temp.Common.BuildDate_Month := registerValues(0)(23 downto 16);
temp.Common.BuildDate_Year := registerValues(0)(15 downto 0);
temp.Common.NumberModule := registerValues(1)(31 downto 8);
temp.Common.VersionOfVersionReg := registerValues(1)( 7 downto 0);
temp.Common.ToolVersion_Year := registerValues(2)(31 downto 16);
temp.Common.ToolVersion_Release := registerValues(2)(15 downto 8);
temp.Common.ToolVersion_SubRelease := registerValues(2)( 7 downto 0);
for i in 0 to 4 loop
temp.Common.ProjektName(32 * i +31 downto 32 * i) := registerValues(i + 3);
end loop;

temp.Top.Version_Major := registerValues(8)(31 downto 24);
temp.Top.Version_Minor := registerValues(8)(23 downto 16);
temp.Top.Version_Release := registerValues(8)(15 downto 8);
temp.Top.Version_CommitsToTag := registerValues(8)( 7 downto 2);
temp.Top.Version_DirtyUntracked := registerValues(8)(1);
temp.Top.Version_DirtyModified := registerValues(8)(0);
for i in 0 to 4 loop
temp.Top.GitHash(32 * i +31 downto 32 * i) := registerValues(i + 9);
end loop;
temp.Top.GitDate_Day := registerValues(14)(31 downto 24);
temp.Top.GitDate_Month := registerValues(14)(23 downto 16);
temp.Top.GitDate_Year := registerValues(14)(15 downto 0);
temp.Top.GitTime_Hour := registerValues(15)(31 downto 24);
temp.Top.GitTime_Min := registerValues(15)(23 downto 16);
temp.Top.GitTime_Sec := registerValues(15)(15 downto 8);
temp.Top.GitTime_Zone := registerValues(15)( 7 downto 0);
for i in 0 to 15 loop
temp.Top.BranchName_Tag(32 * i +31 downto 32 * i) := registerValues(i + 16);
end loop;
for i in 0 to 31 loop
temp.Top.GitURL(32 * i +31 downto 32 * i) := registerValues(i + 32);
end loop;

for i in 0 to 3 loop
temp.UID.UID(32 * i +31 downto 32 * i) := registerValues(i + 64);
end loop;
temp.UID.User_eFuse := registerValues(68);
for i in 0 to 2 loop
temp.UID.User_ID(32 * i +31 downto 32 * i) := registerValues(i + 69);
end loop;

return temp;
end function;


function get_Dummy_Descriptor(len : natural) return T_AXI4_Register_Vector is
variable descriptor : T_AXI4_Register_Vector(0 to len -1);
Expand All @@ -190,21 +249,21 @@ package body mem_GitVersionRegister is
end function;


function to_SLVV_32_Common(data : T_Version_Register_Common) return T_SLVV_32 is
function to_SLVV_32_Common(data : T_VersionRegister_Common) return T_SLVV_32 is
variable temp : T_SLVV_32(0 to 7) := (others => (others => '0'));
variable name : T_SLVV_32(4 downto 0) := to_slvv_32(data.ProjektName);
begin
temp(0) := data.BuildDate_Day & data.BuildDate_Month & data.BuildDate_Year;
temp(1) := data.NumberModule & data.VersionOfVersionReg;
temp(2) := data.VivadoVersion_Year & data.VivadoVersion_Release & data.VivadoVersion_SubRelease;
temp(2) := data.ToolVersion_Year & data.ToolVersion_Release & data.ToolVersion_SubRelease;
for i in name'reverse_range loop
temp(i +3) := name(i);
end loop;

return temp;
end function;

function to_SLVV_32_Top(data : T_Version_Register_Top) return T_SLVV_32 is
function to_SLVV_32_Top(data : T_VersionRegister_Top) return T_SLVV_32 is
variable temp : T_SLVV_32(0 to 55) := (others => (others => '0'));

variable hash : T_SLVV_32(4 downto 0) := to_slvv_32(data.GitHash);
Expand All @@ -213,7 +272,7 @@ package body mem_GitVersionRegister is

variable idx : natural := 0;
begin
temp(0) := data.Version_Major & data.Version_Minor & data.Version_Release & data.Version_Flags;
temp(0) := data.Version_Major & data.Version_Minor & data.Version_Release & data.Version_CommitsToTag & data.Version_DirtyUntracked & data.Version_DirtyModified;
idx := idx +1;

for i in hash'reverse_range loop
Expand Down Expand Up @@ -241,9 +300,9 @@ package body mem_GitVersionRegister is

impure function read_Version_from_mem(FileName : string) return T_SLVV_32 is
constant Verbose : boolean := POC_VERBOSE;
constant MemoryLines : positive := C_Num_Version_Header;
variable HW_BUILD_VERSION_COMMON : T_Version_Register_Common;
variable HW_BUILD_VERSION_TOP : T_Version_Register_Top;
constant MemoryLines : positive := C_Num_VersionHeader;
variable HW_BUILD_VERSION_COMMON : T_VersionRegister_Common;
variable HW_BUILD_VERSION_TOP : T_VersionRegister_Top;

file FileHandle : TEXT open READ_MODE is FileName;
variable CurrentLine : LINE;
Expand Down Expand Up @@ -289,17 +348,17 @@ package body mem_GitVersionRegister is
Len := CurrentLine'length;
read(CurrentLine, result_s(1 to Len), Good);
assert not Verbose report "get_slv_d(): " & result_s(1 to Len) severity Note;
HW_BUILD_VERSION_COMMON.VivadoVersion_Year := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 16));
HW_BUILD_VERSION_COMMON.ToolVersion_Year := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 16));
readline(FileHandle, CurrentLine);
Len := CurrentLine'length;
read(CurrentLine, result_s(1 to Len), Good);
assert not Verbose report "get_slv_d(): " & result_s(1 to Len) severity Note;
HW_BUILD_VERSION_COMMON.VivadoVersion_Release := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 8));
HW_BUILD_VERSION_COMMON.ToolVersion_Release := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 8));
readline(FileHandle, CurrentLine);
Len := CurrentLine'length;
read(CurrentLine, result_s(1 to Len), Good);
assert not Verbose report "get_slv_d(): " & result_s(1 to Len) severity Note;
HW_BUILD_VERSION_COMMON.VivadoVersion_SubRelease := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 8));
HW_BUILD_VERSION_COMMON.ToolVersion_SubRelease := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 8));

readline(FileHandle, CurrentLine);
Len := CurrentLine'length;
Expand Down Expand Up @@ -327,17 +386,19 @@ package body mem_GitVersionRegister is
Len := CurrentLine'length;
read(CurrentLine, result_s(1 to Len), Good);
assert not Verbose report "get_slv_d(): " & result_s(1 to Len) severity Note;
HW_BUILD_VERSION_TOP.Version_Flags(7 downto 2) := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 6));
HW_BUILD_VERSION_TOP.Version_CommitsToTag := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 6));
readline(FileHandle, CurrentLine);
Len := CurrentLine'length;
read(CurrentLine, result_s(1 to Len), Good);
assert not Verbose report "get_slv_d(): " & result_s(1 to Len) severity Note;
HW_BUILD_VERSION_TOP.Version_Flags(1 downto 1) := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 1));
result_h(0 downto 0) := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 1)); -- result_h is unused until here
HW_BUILD_VERSION_TOP.Version_DirtyUntracked := result_h(0);
readline(FileHandle, CurrentLine);
Len := CurrentLine'length;
read(CurrentLine, result_s(1 to Len), Good);
assert not Verbose report "get_slv_d(): " & result_s(1 to Len) severity Note;
HW_BUILD_VERSION_TOP.Version_Flags(0 downto 0) := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 1));
result_h(0 downto 0) := std_logic_vector(to_unsigned(to_natural_dec(result_s(1 to Len)), 1)); -- result_h is unused until here
HW_BUILD_VERSION_TOP.Version_DirtyModified := result_h(0);

readline(FileHandle, CurrentLine);
Len := CurrentLine'length;
Expand Down Expand Up @@ -404,8 +465,18 @@ package body mem_GitVersionRegister is
HW_BUILD_VERSION_TOP.GitURL := to_slv(to_RawString(resize(result_s(1 to Len), 128, NUL)));

temp(0 to C_Num_Reg_Common - 1) := to_SLVV_32_Common(HW_BUILD_VERSION_COMMON);
temp(C_Num_Reg_Common to C_Num_Version_Header - 1) := to_SLVV_32_Top(HW_BUILD_VERSION_TOP);
temp(C_Num_Reg_Common to C_Num_VersionHeader - 1) := to_SLVV_32_Top(HW_BUILD_VERSION_TOP);

return temp;
end function;

impure function to_VersionRegister (FileName : string) return T_VersionRegister is
variable VersionData : T_SLVV_32(0 to C_Num_VersionRegister - 1);

begin
VersionData(0 to C_Num_VersionHeader - 1) := read_Version_from_mem(FileName);
VersionData(C_Num_VersionHeader to C_Num_VersionRegister - 1) := (others => (others => '0'));
return to_VersionRegister(VersionData);
end function;

end package body;
Loading