Hsb Ip Def
NVIDIAOfficialCreated by Holoscan TeamDistributed by NVIDIA
- Skill
- Tool integration
- Software development
- Apache-2.0
- Medium risk
- Has scripts
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The hsb-ip-def skill provides a structured approach to managing SystemVerilog configuration macros for the Holoscan Sensor Bridge (HSB) IP. It enables users to generate, validate, explain, and compare HOLOLINK_def.svh files, ensuring that macro definitions align with board-level requirements and IP constraints. The skill leverages bundled Python scripts to perform these operations, providing a reliable interface for configuring HSB IP revisions 16'h2603 and 16'h2604.
What it does
- Generates HOLOLINK_def.svh files based on user-confirmed board requirements.
- Validates existing configuration files using a dedicated linting script.
- Explains macro semantics, legal values, and their impact on top-level ports.
- Compares two configuration files to identify semantic differences.
- Provides warnings for potential configuration footguns, such as HD-W3xx issues.
- Integrates with other HSB skills for top-level wrapper creation and packetizer derivation.
When to use it
- When you need to create a new HOLOLINK_def.svh file for a custom HSB board design.
- When you need to verify that an existing configuration file is valid and follows IP constraints.
- When you need to understand the effect of specific macros on the HSB IP dataplane or clocking.
- When you need to diff two configurations to understand changes between board revisions.
Advantages
- Ensures configuration consistency through automated validation.
- Prevents common configuration errors with built-in rule checking.
- Provides clear, grounded explanations for complex macro interactions.
- Maintains compatibility with specific HSB IP revisions.
Usage examples
- “Generate a new HOLOLINK_def.svh for a high-bandwidth single-sensor board.”
- The agent will initiate the generation workflow, asking for board requirements one by one, building a profile, and running the generation script upon confirmation.
- “Validate my current HOLOLINK_def.svh and check for any warnings.”
- The agent will run the validation script, report any errors or warnings, and specifically highlight any HD-W3xx footgun warnings.
- “Is it legal to set HOST_WIDTH=512 and PTP_CLK_FREQ=90_000_000?”
- The agent will use the validation script or macro references to determine if the combination is legal and explain the reasoning.
- “Compare my local def file with the baseline configuration.”
- The agent will run the comparison script and provide a summary of the semantic differences between the two files.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/nvidia/hsb-ip-def/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip hsb-ip-def.zip -d .agents/skills
Documentation by Holoscan Team
HSB IP Def Skill
Purpose
Use this skill through four workflows:
Generate a
HOLOLINK_def.svhfrom confirmed board requirements.Validate an existing def file with the bundled validator.
Explain / Reason about HSB IP macros, legality, and macro-driven ports.
Compare two def files semantically.
Scope
This skill owns the contents of HOLOLINK_def.svh: \definedirectives,localparamarrays, theHOLOLINK_pkgwrapper, and boot-timeinit_reg[]sequence. The surrounding top-level wrapper is owned byhsb-ip-create-top; packetizer-only profile derivation can be delegated to hsb-ip-packetizer`.
The file must use the standard guard plus package HOLOLINK_pkg wrapper. Load references/macro-reference.md for the full wrapper requirement and per-macro semantics.
Prerequisites
Python 3.9+ is required for the bundled scripts; PyYAML is required when reading YAML profiles.
The user must confirm file writes and shell commands unless they already asked for that exact operation.
A concrete def file path, pasted content, or confirmed generation profile is required before script-backed validation or generation.
Live HSB IP source is optional but preferred when validating against a specific checked-out IP revision.
Instructions
Run bundled script preflight from
references/script-usage.mdbefore Generate, Validate, Compare, or script-backed legality checks.Never silently default a macro during Generate. Show the proposed value or inferred requirement and get user confirmation.
Ask one requirements question per turn during chat-driven Generate.
Use sensor-agnostic language unless the user says the design is camera-specific.
Avoid unsupported "typical", "common", "most designs", or corpus-frequency claims. Anchor choices to IP behavior, documented constraints, or user requirements.
Always surface HD-W3xx footgun warnings, even when the user asks only about errors.
Do not generate
FPGA_top.sv; offer handoff tohsb-ip-create-topafter a generated def file is validated.Treat unfamiliar macros as project-specific unless they are documented in this skill's references or live HSB IP source.
Security Considerations
This skill can read and write local files and run shell commands through its bundled scripts. Before running a command or writing a file, state the command or path and get user confirmation unless the user already explicitly requested that exact operation. For pasted HOLOLINK_def.svh content, write only to a safely generated file in an isolated temporary directory and remove it after validation unless the user asks to keep it.
Version, Compatibility, And Live Source
This skill targets HSB IP rev 16'h2604 and is backward-compatible with 16'h2603. Live HSB IP source supersedes bundled references.
When source-sensitive behavior matters:
Locate
<hsb-ip-root>/top/HOLOLINK_top.sv. Known roots includehw/nvcpu_dgx_fpga/vrtl/hololink/and public-releasefpga/nv_hsb_ip/.Read
HOLOLINK_REVandHOLOLINK_BACKWARD_COMPAT_REV.Trust live source for consumed macros, port gates, and RTL behavior when it differs from bundled references.
Pass
--ip-source <root>toscripts/validate_def.pywhen validating against a known source root.
Public-doc baseline:
https://github.com/nvidia-holoscan/holoscan-sensor-bridge/blob/release-2.6.0-EA/docs/user_guide/ip_integration.mdhttps://github.com/nvidia-holoscan/holoscan-sensor-bridge/blob/release-2.6.0-EA/docs/user_guide/port_description.md
Workflow Decision
Generate when the user asks to create, scaffold, draft, design, or produce a
HOLOLINK_def.svh.Validate when the user asks to lint, check, validate, or review a
HOLOLINK_def.svh.Explain / Reason when the user asks what a macro does, whether a combination is legal, why validation fails, or how a macro affects
HOLOLINK_top.Compare when the user asks to diff two def files or understand what changed between configurations.
Generate
Load references/generate-workflow.md and references/script-usage.md.
Follow the detailed Generate workflow in the reference: run preflight, classify supplied requirements, ask one requirements question per turn, build a flat YAML profile, run scripts/generate_def.py, show provenance for generated fields, and offer handoff to hsb-ip-create-top.
When packetizer fields are needed, invoke hsb-ip-packetizer with the known RX count, RX widths, and the user's data-manipulation description. Consume only that skill's packetizer_profile_overlay YAML keys, merge them into the in-progress profile, and continue full-file generation and validation here.
Validate
Load references/script-usage.md. Load references/validation-rules.md only when explaining specific rule IDs or validation behavior.
Steps:
Run bundled script preflight once per session.
Locate the file. If the user pastes content, tell them the generated temporary path before writing, ask for confirmation, use an isolated safe temp path, and clean it up after validation unless they ask to keep it. Otherwise use the provided path.
Run
<PY> scripts/validate_def.py <path> --jsonand do not reimplement validation in context.Group findings by severity: errors, warnings, then info. For each error, cite rule ID, line number, and macro when available.
Always surface footgun warnings, especially HD-W3xx silent-fallback warnings.
If clean, confirm the inferred archetype and IP version, then suggest the likely next check or handoff.
Explain / Reason
Load only the reference needed for the question:
| Question type | Reference |
|---|---|
| Macro semantics or legal values | references/macro-reference.md |
| Validation rule behavior | references/validation-rules.md |
| Macro-driven port effects | references/top-port-map.md |
init_reg[] and N_INIT_REG | references/init-reg-cookbook.md |
| Advanced macros | references/advanced-macros.md |
| Example legal configurations | references/archetypes.md |
For grounded legality questions, run preflight and prefer validating a concrete file or minimal synthetic file with scripts/validate_def.py over hand reasoning. Cite RTL line ranges from references when explaining why a rule exists.
Compare
Load references/script-usage.md, run preflight, then use <PY> scripts/compare_defs.py <a.svh> <b.svh> [--json|--text]. Summarize semantic differences, not whitespace or comment-only changes.
Limitations
Do not generate
FPGA_top.sv; usehsb-ip-create-topafter the defs file validates.Do not derive packetizer-only field sets here when the packetizer behavior is underspecified; delegate that slice to
hsb-ip-packetizer.Do not treat bundled archetypes or corpus metadata as norms. They are examples and maintenance metadata, not defaults.
Do not silently accept unknown macros as validated HSB IP behavior unless live source or references document them.
Troubleshooting
Script preflight fails: report the missing Python or PyYAML requirement and stop before generation or validation.
Validation reports errors: group by severity, cite rule ID and line, and fix the defs file before offering top-level handoff.
Validation reports HD-W3xx warnings: surface them even when there are no errors because they describe silent RTL fallback risks.
Unknown macro appears: treat it as project-specific unless live HSB IP source or bundled references document it.
Available Scripts
Use <PY> selected during preflight from references/script-usage.md for every command.
| Script | Purpose | Arguments |
|---|---|---|
scripts/generate_def.py | Generate HOLOLINK_def.svh from an archetype and/or YAML/JSON profile; validates before writing | --profile <path>, --archetype <slug>, -o <output>, optional --allow-random-uuid compatibility flag |
scripts/validate_def.py | Validate a HOLOLINK_def.svh and emit JSON or text findings | <path/to/HOLOLINK_def.svh>, optional --json or --text, optional --ip-source <root> |
scripts/compare_defs.py | Compare two def files semantically, ignoring whitespace/comment-only changes | <a.svh> <b.svh>, optional --json or --text |
scripts/build_corpus_metadata.py | Maintenance helper to rebuild anonymized corpus metadata; do not run during normal user workflows | <path1> [<path2> ...] |
Bundled Resources
| Resource | Use |
|---|---|
references/generate-workflow.md | Detailed Generate workflow, requirement order, question style, and per-topic prompt guidance |
references/script-usage.md | Preflight, command forms, and run_script() examples for bundled scripts |
references/macro-reference.md | Wrapper requirement, macro semantics, legal constraints, and RTL citations |
references/validation-rules.md | Rule catalog for validator findings |
references/archetypes.md | Illustrative legal configurations; never treat as templates or frequency guidance |
references/init-reg-cookbook.md | Boot-time APB write sequence patterns and address conventions |
references/top-port-map.md | Macro-to-HOLOLINK_top port effects |
references/advanced-macros.md | SYNC_CLK_HIF_APB, SYNC_CLK_HIF_PTP, PERI_RAM_DEPTH, and DISABLE_COE |
assets/metadata/corpus.json, assets/metadata/corpus-stats.json | Maintenance metadata only; do not cite corpus counts as user guidance |
scripts/generate_def.py | Generate a def file from a profile |
scripts/validate_def.py | Validate a def file and emit JSON/text findings |
scripts/compare_defs.py | Compare two def files semantically |
Examples
Use hsb-ip-def to generate a HOLOLINK_def.svh for a new HSB board.Treat as Generate, run script preflight, classify supplied requirements, ask one requirement question per turn, and runscripts/generate_def.pyonly after the profile is confirmed.Use hsb-ip-def to validate my existing HOLOLINK_def.svh and tell me whether any warnings are important.Treat as Validate, ask for or locate the file, runscripts/validate_def.py <path> --json, group findings by errors, warnings, and info, and always surface HD-W3xx footgun warnings.Use hsb-ip-def to explain whether HOST_WIDTH=512 and PTP_CLK_FREQ=90_000_000 is legal.Treat as Explain / Reason, prefer a concrete validator-backed check over hand reasoning, and load only the macro or validation reference needed to explain the result.
Files
- ATTRIBUTION.mdAdded by AutoGineer895 B
- BENCHMARK.md3.4 KiB
- LICENSELicence file added by AutoGineer11.2 KiB
- README.md5.0 KiB
- SKILL.md11.3 KiB
- assets/metadata/corpus-stats.json5.3 KiB
- assets/metadata/corpus.json16.9 KiB
- evals/evals.json4.4 KiB
- references/advanced-macros.md4.7 KiB
- references/archetypes.md22.3 KiB
- references/generate-workflow.md25.1 KiB
- references/init-reg-cookbook.md5.7 KiB
- references/macro-reference.md29.8 KiB
- references/script-usage.md3.1 KiB
- references/top-port-map.md10.2 KiB
- references/validation-rules.md14.8 KiB
- scripts/build_corpus_metadata.pyScript7.5 KiB
- scripts/compare_defs.pyScript6.0 KiB
- scripts/generate_def.pyScript8.6 KiB
- scripts/lib/__init__.pyScript0 B
- scripts/lib/emitter.pyScript25.7 KiB
- scripts/lib/parser.pyScript22.3 KiB
- scripts/lib/rules.pyScript29.1 KiB
- scripts/validate_def.pyScript5.6 KiB
- skill-card.md4.5 KiB
- skill.oms.sig8.9 KiB
LICENSE
Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
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 [yyyy] [name of copyright owner]
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.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Python
The author says: Targets HSB IP rev 16'h2604; backward-compatible with 16'h2603 (the public release rev). Prefer live HSB IP source when available; warn on unknown revisions. Requires Python 3.9+ with PyYAML for the generator.
Security
What our scanner noticed· Medium risk
- Large base64-encoded blobs
- Instructions that use the network
- Scripts that your agent may run
This skill includes scripts that your agent may run. Read them before you use it.
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Holoscan Team
- Publisher
- NVIDIA (Official)
- Distributed by
- NVIDIA
- Source
- NVIDIA/skills · skills/hsb-ip-def · commit fce3cca
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE-APACHE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Holoscan Team or NVIDIA.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download hsb-ip-def.zip