Skip to content

docs: creating new ip: set guidelines for core version #1831

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

gastmaier
Copy link
Contributor

@gastmaier gastmaier commented Jul 9, 2025

PR Description

For historical reasons, we have been creating linux dt-bindings suffixed
with 1.00.a, because that was the default vivado set value, and what
would be outputted by
SDTGen.

Nowadays, vivado default is 1.0 and the auto-generated devicetrees never
really matched with the actual devicetree bindings.
To improve overall coherence between hdl and linux, I propose the
following:

  • semantic versioning across the board,
  • dt-bindings are suffixed by -<major>, and should match the filename
    and compatible
  • Bus connected Ips should have the IP-XACT version set to
    . (I developed a method to autoset based on
    CORE_VERSION)
  • Drivers should print the version reg as %u.%u.%u

New software:

  • dt-bindings suffixed by -<major>

Existing software:

  • Format patch version as decimal, without bumping, e.g. ‘a’ -> 61
  • update drivers to print %u.%u.%u instead of %u.%u.%c

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)
  • Documentation

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have compiled all hdl projects and libraries affected by this PR
  • I have tested in hardware affected projects, at least on relevant boards
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Critical Warnings on compilation
  • I have added new hdl testbenches or updated existing ones

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
@gastmaier gastmaier force-pushed the doc-core-version branch 2 times, most recently from 0a65188 to ac85a84 Compare July 10, 2025 13:06
To ensure consistency with software, semantic versioning must be used.
The first release should have major version at least 1.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Explain how it came to be and how to handle

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant