You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Following discussions in #22, this PR introduces a core register schema with a protocolVersion field specifying the minimum semantic version mandating a given set of common registers.
The new JSON schema is named core.json and is to be used by both the common register metadata file and each of the device.yml files.
The common register metadata file is also renamed to core.yml to avoid the unusual terminology of "common". In Harp parlance, the "core" is always what we talk about when discussing requirements for hardware devices. There is no direct reference to this metadata file other than from the generator and analysis packages, which will be themselves updated in the near future to embed the new core.yml. Since these packages distribute their own snapshots, changing and renaming this file is not expected to be breaking.
Also added regex validation patterns for all version strings, adapted from semantic versioning with only a major and minor version component: ^(0|[1-9]\\d*)\.(0|[1-9]\d*)$
Consider device.yml as an interface specification with that in mind all fields should be tracked of as Major.Minor.
Instead of keeping track of the architecture, use the hardware targets (e.g. hw_target {hw_version, architecture_enum, archicture}. Where architecture_enum comes from #44 (comment).
What to do with the version of the protocol implementation version? @glopesdev argues that, until we decide what we really want people to use the device.yml for (e.g. interface definition vs manifest file for the whole device) this version should not be tracked for now at the level of the device.yml. It should be noted that this does not kill the affordances already provided by reading the version register directly as of (#44).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following discussions in #22, this PR introduces a core register schema with a
protocolVersionfield specifying the minimum semantic version mandating a given set of common registers.The new JSON schema is named
core.jsonand is to be used by both the common register metadata file and each of thedevice.ymlfiles.The common register metadata file is also renamed to
core.ymlto avoid the unusual terminology of "common". In Harp parlance, the "core" is always what we talk about when discussing requirements for hardware devices. There is no direct reference to this metadata file other than from the generator and analysis packages, which will be themselves updated in the near future to embed the newcore.yml. Since these packages distribute their own snapshots, changing and renaming this file is not expected to be breaking.Also added regex validation patterns for all version strings, adapted from semantic versioning with only a major and minor version component:
^(0|[1-9]\\d*)\.(0|[1-9]\d*)$Fixes #22
Fixes #65