Release notes

Release history and changelog for the hdl_registers project.

Unreleased (YYYY-MM-DD)

Changes since previous release

Breaking changes

Break hdl_registers.constant.Constant class into BooleanConstant, FloatConstant, IntegerConstant and StringConstant.
Remove the largely unused “Value (hexadecimal)” constant information column from HTML generator.
Rename RegisterField.range to RegisterField.range_str().

Added

Add support for unsigned bit vector constants via the UnsignedVectorConstant class.

3.1.0 (25 april 2023)

Changes since previous release

Added

Add support for register constants of type string.

3.0.2 (4 march 2023)

Changes since previous release

Added

Add more comments to generated VHDL.

3.0.1 (3 march 2023)

Changes since previous release

Update project slogan on PyPI to fit within 98 characters.

3.0.0 (3 march 2023)

Changes since previous release

Added

Add field setters and getters to RegisterCppGenerator.
Add *_MASK_INVERSE defines for fields to RegisterCGenerator.
Add support for register constants of boolean and floating point type.

Breaking changes

Remove the field _mask and _shift public constants from the generated C++ interface header. These are not needed now that setters and getters are available.
Change to use unresolved VHDL types in RegisterVhdlGenerator.
- std_ulogic_vector instead of std_logic_vector.
- u_signed instead of signed.
- u_unsigned instead of unsigned.

Changes

Increase TOML parsing performance by using tomli Python package instead of tomlkit.

2.1.0 (1 april 2022)

Changes since previous release

Added

Add RegisterList.create_python_class() method to create a Python pickle file. Read more here.
Add optional field_type argument to RegisterList.append_register() and Register.
Add support for generating ieee.fixed_pkg types in RegisterVhdlGenerator based on the register field_type.

Fixed

Fix bug where setting default value for bit 31 in a register could fail.

2.0.1 (22 october 2021)

Changes since previous release

Second release to test PyPI deploy. Functionality is identical to tsfpga version 9.0.0.

2.0.0 (22 october 2021)

Initial release to test PyPI deploy. Functionality is identical to tsfpga version 9.0.0.