* Zfh norm rules
* Zfa norm rules
* Remove non cmo norm rule/tag changes
* Fix typo
* fixed duplicates in normative rules
* Updated rules with feedback
* Rule updates
* Norm rules for rv32e
* Use latest docs-resources submodule
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Minor typo fixes
* Move yaml file to normative rules dir
* Move to norm rules dir
* Minor typo fixes
* Update normative_curations to normative_rule_definitions
* Move rules to norm rules dir
* typo fixes
* typo fix
* bfloat16 norm tags and rules
* fix header currations to definitions
* Zfinx norm tags and rules
* addressed feedback
* all changes committed
* updated format
* vector crypto norm rules and tags
* second half vector crypto
* Fix naming underscores and dashes, remove untestable rules, tag CSRs better
* requested changes fixed
* old removed
* updated style, added remaining zicsr tags and rules
* merge
* fixed yaml file names to match
* cleanup
* Merge conflict with spaces
* Switch to latest docs-resources
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Manually merged in changes from PR 11
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Fixed wrong link is norm rule tagging doc
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Cleanup
* Removed bad tags
* chapter names and yaml language servers
* Fixing yaml
* yaml fixes
* cleanup
* tagging schema
* Trailing spaces
* Reduce from 151 to 77 number of norm rule defs referencing non-existant adoc tags. And switching to latest doc-resources (no tool changes though).
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Added AI summary of normative rule tagging errors (used Claude).
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Merging changes from upstream CSC fork to this fork.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Update to latest docs-resources
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Added norm rules for c-st-ext and zilsd (manually copied from HMC fork)
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Bump pre-commit/action from 3.0.0 to 3.0.1
Bumps [pre-commit/action](https://github.com/pre-commit/action) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/pre-commit/action/releases)
- [Commits](https://github.com/pre-commit/action/compare/v3.0.0...v3.0.1)
---
updated-dependencies:
- dependency-name: pre-commit/action
dependency-version: 3.0.1
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump actions/setup-python from 5 to 6
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5 to 6.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v5...v6)
---
updated-dependencies:
- dependency-name: actions/setup-python
dependency-version: '6'
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump actions/upload-artifact from 4 to 5
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4 to 5.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v4...v5)
---
updated-dependencies:
- dependency-name: actions/upload-artifact
dependency-version: '5'
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump actions/upload-pages-artifact from 3 to 4
Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 3 to 4.
- [Release notes](https://github.com/actions/upload-pages-artifact/releases)
- [Commits](https://github.com/actions/upload-pages-artifact/compare/v3...v4)
---
updated-dependencies:
- dependency-name: actions/upload-pages-artifact
dependency-version: '4'
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
* Adding normative rules for priv-csrs
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Added norm rules for Zc extension
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Reduced zilsd chapter name
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Added fix for partial tagging of unordered list in Zc
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Fixed all HMC norm rules that referenced non-existant tags
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Shortened chapter names to fit better in cells and fixed $schema paths that were corrupted.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Updated docs-resources to latest with fixes/improvements and changed Makefile to have uncommented warning flag.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Fixed unreferenced rules
* formatted yaml per pre-commit hook
* Fix renaming of anchor from "rm" to "norm:dyn_round_enc".
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Update Makefile to add HTML format of normative rules
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Build just HTML version of norm rules for all/build targets
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Using norm rule direct to html and Tim's toggle to display norm tags
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Update to latest docs-resources submodule
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Removed tags_without_text (obscure feature not required by norm rules)
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Bump softprops/action-gh-release from 2.4.1 to 2.4.2
Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 2.4.1 to 2.4.2.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Commits](https://github.com/softprops/action-gh-release/compare/v2.4.1...v2.4.2)
---
updated-dependencies:
- dependency-name: softprops/action-gh-release
dependency-version: 2.4.2
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump docs-resources from `7f7f63a` to `40844de`
Bumps [docs-resources](https://github.com/riscv/docs-resources) from `7f7f63a` to `40844de`.
- [Commits](7f7f63ad85...40844defba)
---
updated-dependencies:
- dependency-name: docs-resources
dependency-version: 40844defba0d1bcad46ce690ebca51912fbb3f67
dependency-type: direct:production
...
Signed-off-by: dependabot[bot] <support@github.com>
* Update to docs-resources with better norm rule HTML table column names
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Fix formatting in m-st-ext.adoc
Correct spacing in REMW and REMUW documentation.
Signed-off-by: David Harris <74973295+davidharrishmc@users.noreply.github.com>
* Build and deploy norm-rules.json and norm-rules.html so they can have a static URL
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Copy priv/unpriv ISA manual HTML to same directory as norm-rules.html (mimicking how they are all in the build directory)
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Forgot to put riscv- prefix into ISA manual HTML copied to norm-rules deployment directory for GitHub Pages
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Use latest docs-resources
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Added normative rules
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Updated to match agreed parameter tagging scheme. Made a few other small improvements while at it.
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Replace _param with kind: parameter
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Update to latest docs-resources commit
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Use tag instead of tags if only one tag in Zilsd norm rules
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Incorporating some feedback from Christian on Zilsd norm rules
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Update f-st-ext.yaml
Signed-off-by: james-ball-qualcomm <quic_jameball@quicinc.com>
* Update f-st-ext.adoc
Signed-off-by: james-ball-qualcomm <quic_jameball@quicinc.com>
* update doc-resources submodule
* Added blank lines in zimop.yaml and zimop.adoc for norm_rule review
* Bump actions/checkout from 5 to 6
Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)
---
updated-dependencies:
- dependency-name: actions/checkout
dependency-version: '6'
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
* Made changes to Zilsd norm rules based on PR feedback from Christian and Derek
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* A couple of additional latexmath calls in mm-formal.adoc (should be all gone).
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Added more norm rules into M-mode chapter. Commiting so I can merge in changes from upstream ISA manual chapters.
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Extract norm rules in m-mode up to endianness control in mstatus
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Bump docs-resources from `49eff17` to `824bd66`
Bumps [docs-resources](https://github.com/riscv/docs-resources) from `49eff17` to `824bd66`.
- [Commits](49eff17dfd...824bd661c4)
---
updated-dependencies:
- dependency-name: docs-resources
dependency-version: 824bd661c4464e1314309ed07c9069753940929b
dependency-type: direct:production
...
Signed-off-by: dependabot[bot] <support@github.com>
* Latest docs-resources
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Bump softprops/action-gh-release from 2.4.2 to 2.5.0
Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 2.4.2 to 2.5.0.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Commits](https://github.com/softprops/action-gh-release/compare/v2.4.2...v2.5.0)
---
updated-dependencies:
- dependency-name: softprops/action-gh-release
dependency-version: 2.5.0
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
* Fix formatting for C.FLDSP instruction description
Signed-off-by: David Harris <74973295+davidharrishmc@users.noreply.github.com>
* Rename c-fdwsp_op to c-fldsp_op in YAML file
Signed-off-by: David Harris <74973295+davidharrishmc@users.noreply.github.com>
* Remove c-jalr entry from c-st-ext.yaml
Removed the 'c-jalr' entry from the YAML file. Redundant with the c-ebreak entry with the same tag and the c_jalr_op entry with the main operation.
Signed-off-by: David Harris <74973295+davidharrishmc@users.noreply.github.com>
* Working my way through the machine chapter. Got up to mstatus.tw.
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Remove spaces yamlchk didn't like
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Get latest docs-resources to get fix for table column widths
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* added norm rule tags for wavedrom generated images
* Latest docs-resources
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Replace note with clarification text for rule mstatus_tw_op
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* removed some non-normative text from zimop. changed to inline tag
* Replace note with clarification text for rule mstatus_tw_op
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Bump softprops/action-gh-release from 2.4.2 to 2.5.0
Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 2.4.2 to 2.5.0.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Commits](https://github.com/softprops/action-gh-release/compare/v2.4.2...v2.5.0)
---
updated-dependencies:
- dependency-name: softprops/action-gh-release
dependency-version: 2.5.0
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
* Latest docs-resources
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* changed name of c-mop tag from tab:c-mop to norm:c-mop_enc
* added zcmop enc table tags to yaml file
* Added norm rule to image to test HTML
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* added additional context for existing rules by adding another tag for ztso_ld,sd,amo
* removed trailing blank spaces
* Merging in origin/main
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Finished tagging mstatus
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Bump actions/github-script from 6 to 8
Bumps [actions/github-script](https://github.com/actions/github-script) from 6 to 8.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/v6...v8)
---
updated-dependencies:
- dependency-name: actions/github-script
dependency-version: '8'
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
* Added norm rules for mtvec CSR
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Added medeleg and mideleg CSRs
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* updated doc resources
* Adding mip/mie
Signed-off-by: James Ball <quic_jameball@quicinc.com>
* Added norm rules for mip/mie.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Added fcvtmod-w-s_rsv rule
* Fixed typo
* Added c-srai_hint normative rule
* Zihintntl: Created PR to enable review (won't show all changes like normal) (#119)
* Fixes issue #80. Removed norm rule fence_null_pred_succ_inter and its tags with the same name. Added norm rules and tags for HINT and NOP instructions.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Remove copilot_instructions.md
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Remove changes accidentally introduced by tagging into priv ISA volume.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Remove changes accidentally introduced by tagging into unpriv ISA volume.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Found a couple more unintentional visible changes introduced by norm tagging by using Copilot to compare HTML versions of priv and unpriv ISA volumes.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Machine mode chapter now has norm rules tagged up to mcause (mtval is next).
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
* Bump actions/upload-artifact from 5 to 6
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 5 to 6.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v5...v6)
---
updated-dependencies:
- dependency-name: actions/upload-artifact
dependency-version: '6'
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump docs-resources from `d644eb9` to `b5eaf50`
Bumps [docs-resources](https://github.com/riscv/docs-resources) from `d644eb9` to `b5eaf50`.
- [Commits](d644eb9c54...b5eaf50001)
---
updated-dependencies:
- dependency-name: docs-resources
dependency-version: b5eaf5000174386aa3d790eb6e0904ced0f2a93b
dependency-type: direct:production
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump pre-commit/action from 3.0.0 to 3.0.1
Bumps [pre-commit/action](https://github.com/pre-commit/action) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/pre-commit/action/releases)
- [Commits](https://github.com/pre-commit/action/compare/v3.0.0...v3.0.1)
---
updated-dependencies:
- dependency-name: pre-commit/action
dependency-version: 3.0.1
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump actions/setup-python from 5 to 6
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5 to 6.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v5...v6)
---
updated-dependencies:
- dependency-name: actions/setup-python
dependency-version: '6'
dependency-type: direct:production
update-type: version-update:semver-major
...
Signed-off-by: dependabot[bot] <support@github.com>
* Bump pre-commit/action from 3.0.0 to 3.0.1
Bumps [pre-commit/action](https://github.com/pre-commit/action) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/pre-commit/action/releases)
- [Commits](https://github.com/pre-commit/action/compare/v3.0.0...v3.0.1)
---
updated-dependencies:
- dependency-name: pre-commit/action
dependency-version: 3.0.1
dependency-type: direct:production
update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>
---------
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: james-ball-qualcomm <quic_jameball@quicinc.com>
Signed-off-by: James Ball <quic_jameball@quicinc.com>
Signed-off-by: David Harris <74973295+davidharrishmc@users.noreply.github.com>
Signed-off-by: james-ball-qualcomm <jameball@qti.qualcomm.com>
Co-authored-by: Corey Hickson <chickson@hmc.edu>
Co-authored-by: Neil Chulani <neil22@me.com>
Co-authored-by: SadhviNarayanan <sadhvin@gmail.com>
Co-authored-by: David Harris <74973295+davidharrishmc@users.noreply.github.com>
Co-authored-by: David Harris <David_Harris@hmc.edu>
Co-authored-by: Noah Fotenos <nfotenos@g.hmc.edu>
Co-authored-by: Vikram Krishna <vkrishna@hmc.edu>
Co-authored-by: Georgia Tai <ytai@g.hmc.edu>
Co-authored-by: jacassidy <jkc.cassidy@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jamie Grimm <jgrimm@vtmgroup.com>
Make these references display as Zbkb, Zbkc, Zbkx without the -sc suffix.
Signed-off-by: David Harris <74973295+davidharrishmc@users.noreply.github.com>
* First draft adding Zalasr to the main spec
* Zalasr upgrade to 0.9
* Upgrading Zalasr documentation based on feedback to differentiate from existing Za extensions
* Updating Zalasr to version 1.0
---------
Co-authored-by: Brendan Sweeney <turtwig@utexas.edu>
Vector crypto chapter was using a different spelling, carryless, compared to the usually accepted form, carry-less, which is also the spelling used in the scalar crypto chapter.
This patch unifies the spelling to carry-less.
Signed-off-by: Nicolas Brunie <82109999+nibrunieAtSi5@users.noreply.github.com>
* Add RLB, MML, MMWP fields spec to mseccfg section
* Move mseccfg fields spec and rationale to right sections
* Add a privileged rationale chapter
* move reset state of smepmp fields to reset section
* Include new chapter into priv book; fix references
* remove misnamed file
* Move Smnpm to machine chapter
* Move Smmpm to Machine chapter
* Move Ssnpm to supervisor chapter
* Move Ssnpm additions to H to hypervisor chapter
* Clean up the movement of extension details
"At least one hart must have an ID of 0" and "IDs must be unique" together
imply that exactly one hart has an ID of 0. But the latter wording is less
confusing.
`pmpaddr` uniquely contains writable bits that "read as" some value, but have an underlying value that can be different. The behaviour when you modify *different* bits in the CSR using `csrr{sc}[i]` was not clear.
This is the behaviour that the Sail model, SPIKE and the open-source Rocket core all implement.
Co-authored-by: Tim Hutt <timothy.hutt@codasip.com>
Add cache-block instructions to the list of instructions that are affected by permission checks. This is meant to be implied by the text elsewhere saying that CMOs require load/store permission, but it is nice to be explicit.
Current riscv AQ & RL (Zalasr) instructions are RCsc. This typo affects PPO6 and PPO7.
Signed-off-by: Guo Ren <guoren@kernel.org>
Co-authored-by: Andrew Waterman <andrew@sifive.com>
As mentioned a few lines below the one changed, scountovf only contains the OF bits of 29 mhpmevent registers, as only 29 exist.
Signed-off-by: Tiago Rocha <33607449+Tiago-R@users.noreply.github.com>
Co-authored-by: Bill Traynor <wmat@riscv.org>
Co-authored-by: Andrew Waterman <andrew@sifive.com>
