Metadata-Version: 2.4
Name: agent-skills-systemrdl
Version: 0.1.0
Summary: Hierarchical SystemRDL 2.0 authoring reference for coding agents, packaged as an agent skill.
Author-email: Matthew Ballance <matt.ballance@gmail.com>
License: Apache License
        Version 2.0, January 2004
        http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1. Definitions.
        
        "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
        
        "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
        
        "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
        
        "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
        
        "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
        
        "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
        
        "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
        
        "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
        
        "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
        
        "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
        
        2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
        
        3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
        
        4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
        
             (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
        
             (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
        
             (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
        
             (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
        
             You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
        
        5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
        
        6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
        
        7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
        
        8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
        
        9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
        
        APPENDIX: How to apply the Apache License to your work.
        
        To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
        
        Copyright 2026 fvutils
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
        http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Project-URL: Homepage, https://dvkit.org/fvutils/agent-skills-systemrdl/
Project-URL: Documentation, https://dvkit.org/fvutils/agent-skills-systemrdl/
Project-URL: Source, https://git.dvkit.org/fvutils/agent-skills-systemrdl.git
Keywords: systemrdl,register,rdl,agent,skill,agent-skills,hardware,eda,peakrdl
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: validate
Requires-Dist: systemrdl-compiler>=1.27; extra == "validate"
Requires-Dist: pyyaml; extra == "validate"
Dynamic: license-file

# agent-skills-systemrdl

A hierarchical SystemRDL 2.0 authoring reference for coding agents, packaged as an
[Agent Plugin](https://agent-plugins.org/).

The plugin contains one [Agent Skill](https://agentskills.io/), `systemrdl-ref`, that lets an agent
write **legal** Accellera SystemRDL 2.0 — syntactically valid, semantically consistent, and free of
the property combinations the standard forbids.

## Why

The SystemRDL 2.0 standard is ~130 pages. An agent asked to write a register map otherwise has to
guess, or read the whole thing. Both produce descriptions that look right and are subtly illegal:
mutually exclusive properties set together, `woclr` on a read-only field, a writable field
straddling an access-width boundary.

## How it is organized

Content is a **disclosure ladder** — a loading order, not a filing scheme:

| L | Artifact | Loaded when | Budget |
|---|---|---|---|
| L0 | `name` + `description` | always resident | ~100 tok |
| L1 | `SKILL.md` | the skill activates | ≤ 1500 tok |
| L2 | `references/<area>/INDEX.md` — 5 hubs | the agent picks an area | ≤ 1400 tok |
| L3 | 30 leaf pages | the agent picks a construct | ≤ 2500 tok |
| L4 | `references/_deep/` — 3 pages | exhaustive lookup only | unbounded |

A trivial task stops at a hub for ~2.2k tokens; a typical one reaches two leaves for ~5.7k; only
exhaustive lookups (full BNF, full UVM/IP-XACT access-mode mapping) go further.

```
src/agent_skills_systemrdl/share/skills/systemrdl-ref/   (== skills/systemrdl-ref)
├── SKILL.md                 # entry point: authoring loop, 5 rules, hub map, express lane
├── references/
│   ├── components/          # field, reg, regfile, mem, addrmap, signal, enum, struct, constraint
│   ├── properties/          # sw/hw access, counters, interrupts, reset, addressing, HDL path, UDPs
│   ├── language/            # lexical, types, expressions, scoping, parameters, preprocessor, BNF
│   ├── patterns/            # recipes, arrays, reuse, antipatterns
│   ├── validation/          # checklist, compiler errors, tooling
│   └── _deep/               # full BNF, full access modes, full property table
├── data/properties.yaml     # all 90 properties, schema-validated
├── scripts/                 # validate_rdl.py, query_property.py, explain_error.py
└── assets/templates/        # 8 compilable starting points
```

Every normative claim cites its clause or table — `[§9.6.1 k]`, `[Table 19]` — so any sentence can
be audited against the standard. Uncited statements are marked as advice.

## Install

```bash
pip install agent-skills-systemrdl
```

That registers an `agent.skills` entry point, so tools that walk that group — including IVPM's
agents handler — find the skill without being told where it is. In an IVPM project, one line is
enough:

```yaml
# ivpm.yaml
    - name: agent-skills-systemrdl
      src: pypi
```

`ivpm update` then assembles `.agents/skills/`, `.claude/skills/`, and `.cursor/skills/`.

Without IVPM, symlink the installed skill into your client's skills directory:

```bash
python -c "from agent_skills_systemrdl.skills import get_skill_dirs; print(get_skill_dirs()[0])"
```

The package has no runtime dependencies. To let the bundled scripts do real work rather than report
that they cannot, install `agent-skills-systemrdl[validate]`; otherwise `validate_rdl.py` exits 2
with a "NOT VALIDATED" banner and the skill reports its output as unchecked rather than implying
otherwise.

The repository is also a portable [Agent Plugin](https://agent-plugins.org/) — `plugin.json` at the
root and `skills/systemrdl-ref` — so a client can be pointed at a checkout directly. See `docs/` for
other clients and the IVPM-based development setup.

## Develop

```bash
./bootstrap.sh                                    # venv under packages/python, then `ivpm update`
                                                  # (deps come from pyproject.toml via ivpm.yaml)
packages/python/bin/python -m pytest tests/       # full test suite
packages/python/bin/python tools/lint_skill.py    # ladder invariants, budgets, frontmatter
packages/python/bin/python -m build .             # sdist + wheel
make -C docs html                                 # documentation (built with -W)
```

The skill's canonical location is `src/agent_skills_systemrdl/share/skills/systemrdl-ref/`, because
setuptools only packages data found under the package directory. `skills/systemrdl-ref` is a
relative symlink to it, which is what gives the repository its Agent Plugins layout — one copy of
the content, two shapes. CI checks the symlink survives checkout and that every file under the skill
reaches the wheel.

CI enforces the claim that the shipped examples are legal:

- every `.rdl` in `assets/templates/` and `tests/golden/` compiles and elaborates;
- every ```` ```systemrdl ```` block in the prose compiles, or declares an inline reason why not
  (currently 77 compile, 26 skipped with stated reasons);
- 20 negative cases must fail with their **recorded** diagnostics, so the error catalogue cannot
  drift from what the compiler actually says;
- ladder invariants, token budgets, generated-file freshness, and property coverage;
- the wheel carries all 58 skill files, and the version agrees across `__version__.py`,
  `plugin.json`, and `SKILL.md`.

Releases are tag-driven: pushes to master build a `.<run-id>` dev-suffixed wheel that is never
published; a `v<version>` tag publishes to PyPI and the docs. See
`.forgejo/workflows/ci.yml` (primary) and `.github/workflows/ci.yml` (mirror).

## Documentation

`docs/` builds a Sphinx site whose reference pages `{include}` the skill's Markdown rather than
copying it, plus four generated analysis pages: the disclosure ladder with measured token costs, the
property index, a spec-clause map, and a coverage report.

## Project

| | |
|---|---|
| Source | <https://git.dvkit.org/fvutils/agent-skills-systemrdl.git> |
| Documentation | <https://dvkit.org/fvutils/agent-skills-systemrdl/> |
| Package | `agent-skills-systemrdl` on PyPI |

`git.dvkit.org` is authoritative. CI, releases, and documentation all publish from there
(`.forgejo/workflows/ci.yml`); any GitHub mirror runs build-and-test only.

## License

Apache-2.0. The Accellera SystemRDL 2.0 specification is copyright © 2015–2018 Accellera; this
repository restates its rules with citation and is not an official Accellera publication. Where this
reference and the standard disagree, the standard governs.
