Skip to content

Eriemon/verilog-generator

readable-verilog-generator

Verified

Use when creating, writing, reviewing, annotating, repairing, refactoring, or validating readable Verilog RTL, including synthesizable Verilog-2001 .v files, existing-RTL analysis, semantic comment annotation, testbench scaffold planning, ASIC-quality review, local or remote Vivado/xsim validation, evidence-backed repair, and workflow trace diagnosis.

FileKindSize
SKILL.mdskill md21.3 KB
agents/openai.yamlconfig363 B
assets/examples/existing_rtl/fsm_without_default.vother761 B
assets/examples/existing_rtl/fsm_without_default_spec.mdmarkdown311 B
assets/examples/existing_rtl/leaf_counter.vother314 B
assets/examples/existing_rtl/missing_output_register.vother423 B
assets/examples/existing_rtl/missing_output_register_spec.mdmarkdown331 B
assets/examples/existing_rtl/ready_valid_slice.vother967 B
assets/examples/existing_rtl/ready_valid_slice_spec.mdmarkdown420 B
assets/examples/existing_rtl/reset_gap_counter.vother319 B
assets/examples/existing_rtl/reset_gap_counter_spec.mdmarkdown212 B
assets/examples/existing_rtl/tb_ready_valid_slice.vother846 B
assets/examples/existing_rtl/top_counter.vother271 B
assets/examples/existing_rtl/traffic_light.vother2.5 KB
assets/examples/existing_rtl/traffic_light_spec.mdmarkdown585 B
assets/examples/readme/axis_packet_meter.vother10.2 KB
assets/examples/remote_fixtures/comb_hierarchy_budget/generated/rtl/comb_hierarchy_budget.vother1.9 KB
assets/examples/remote_fixtures/comb_hierarchy_budget/generated/tb/tb_comb_hierarchy_budget.vother2.5 KB
assets/examples/remote_fixtures/comb_hierarchy_budget/hierarchy_child_loop.vother447 B
assets/examples/remote_fixtures/comb_hierarchy_budget/hierarchy_over_budget.vother527 B
assets/examples/remote_fixtures/comb_hierarchy_budget/hierarchy_q_cut.vother467 B
assets/examples/remote_fixtures/comb_hierarchy_budget/hierarchy_within_budget.vother450 B
assets/examples/remote_fixtures/comb_hierarchy_budget/spec.jsonconfig1.7 KB
assets/examples/remote_fixtures/comb_operation_budget/comb_operation_budget_bad.vother187 B
assets/examples/remote_fixtures/comb_operation_budget/generated/rtl/comb_operation_budget.vother6.1 KB
assets/examples/remote_fixtures/comb_operation_budget/generated/tb/tb_comb_operation_budget.vother5.7 KB
assets/examples/remote_fixtures/comb_operation_budget/spec.jsonconfig2.9 KB
assets/examples/remote_fixtures/comb_parity_mux/generated/rtl/comb_parity_mux.vother2.1 KB
assets/examples/remote_fixtures/comb_parity_mux/generated/tb/tb_comb_parity_mux.vother2.8 KB
assets/examples/remote_fixtures/comb_parity_mux/spec.jsonconfig1.9 KB
assets/examples/remote_fixtures/pipeline_delay/generated/rtl/pipeline_delay.vother4.5 KB
assets/examples/remote_fixtures/pipeline_delay/generated/tb/tb_pipeline_delay.vother2.6 KB
assets/examples/remote_fixtures/pipeline_delay/spec.jsonconfig2.2 KB
assets/examples/remote_fixtures/ready_valid_slice/generated/rtl/ready_valid_slice.vother5.2 KB
assets/examples/remote_fixtures/ready_valid_slice/generated/tb/tb_ready_valid_slice.vother2.9 KB
assets/examples/remote_fixtures/ready_valid_slice/spec.jsonconfig2.6 KB
assets/examples/rtl_erie_verilog_spec.jsonconfig2.1 KB
assets/examples/use_case_templates/jesd_adc.jsonconfig2.4 KB
assets/examples/use_case_templates/jesd_dac.jsonconfig2.5 KB
assets/examples/use_case_templates/mxfe_mixed.jsonconfig2.7 KB
assets/examples/use_case_templates/spi_adc.jsonconfig2.8 KB
assets/examples/use_case_templates/spi_dac.jsonconfig2.7 KB
assets/examples/verilog_pattern_templates/axi4_lite_csr.jsonconfig2.1 KB
assets/examples/verilog_pattern_templates/axi_interconnect_dma.jsonconfig2.3 KB
assets/examples/verilog_pattern_templates/axis_ready_valid.jsonconfig2.3 KB
assets/examples/verilog_pattern_templates/conv_load_store.jsonconfig1.8 KB
assets/external_interface_catalog.jsonconfig2.9 KB
assets/ideal_bad_style_metrics.jsonconfig17.5 KB
assets/installer/manifest.projection.jsonconfig2.8 KB
assets/installer/platforms.jsonconfig1.3 KB
assets/interface_templates/ahb_lite_config.vincother2.3 KB
assets/interface_templates/apb_config.vincother861 B
assets/interface_templates/axi4_full_master.vincother1.8 KB
assets/interface_templates/axi4_full_slave.vincother1.8 KB
assets/interface_templates/axi4_lite_config.vincother1.6 KB
assets/interface_templates/axi_stream_duplex.vincother1.1 KB
assets/interface_templates/catalog.jsonconfig2.6 KB
assets/project_ip_interface_manifest.template.jsonconfig9.4 KB
assets/readme-workflow.pngbinary1.4 MB
assets/readme/design-profile-cn.pngbinary1.4 MB
assets/readme/design-profile.pngbinary1.4 MB
assets/readme/evidence-guard-cn.pngbinary1.4 MB
assets/readme/evidence-guard.pngbinary1.4 MB
assets/readme/hero-overview-cn.pngbinary1.5 MB
assets/readme/hero-overview.pngbinary1.5 MB
assets/readme/project-facts-cn.pngbinary1.2 MB
assets/readme/project-facts.pngbinary1.3 MB
assets/readme/rule-rendering-cn.pngbinary1.4 MB
assets/readme/rule-rendering.pngbinary1.2 MB
assets/style_templates/header_prompt_none_mode.txtmarkdown2.1 KB
assets/style_templates/header_prompt_table_mode.txtmarkdown2.5 KB
assets/style_templates/rtl_bus_grouping.tplother1.0 KB
assets/style_templates/rtl_fsm.tplother832 B
assets/style_templates/rtl_header_bilingual.tplother1.6 KB
assets/style_templates/rtl_instantiation.tplother496 B
assets/style_templates/rtl_region_order.tplother987 B
assets/use_case_templates/catalog.jsonconfig2.8 KB
assets/use_case_templates/jesd_adc/README.mdmarkdown699 B
assets/use_case_templates/jesd_adc/constraints/system_constr.xdcother454 B
assets/use_case_templates/jesd_adc/manifest.jsonconfig1.7 KB
assets/use_case_templates/jesd_adc/tcl/common_bd.tclother4.0 KB
assets/use_case_templates/jesd_adc/tcl/system_bd.tclother920 B
assets/use_case_templates/jesd_adc/tcl/system_project.tclother1.0 KB
assets/use_case_templates/jesd_adc/verilog/system_top.vother2.9 KB
assets/use_case_templates/jesd_dac/README.mdmarkdown745 B
assets/use_case_templates/jesd_dac/constraints/system_constr.xdcother299 B
assets/use_case_templates/jesd_dac/manifest.jsonconfig1.7 KB
assets/use_case_templates/jesd_dac/tcl/common_bd.tclother4.8 KB
assets/use_case_templates/jesd_dac/tcl/system_bd.tclother923 B
assets/use_case_templates/jesd_dac/tcl/system_project.tclother1.1 KB
assets/use_case_templates/jesd_dac/verilog/system_top.vother2.9 KB
assets/use_case_templates/mxfe_mixed/README.mdmarkdown739 B
assets/use_case_templates/mxfe_mixed/constraints/system_constr.xdcother380 B
assets/use_case_templates/mxfe_mixed/manifest.jsonconfig1.8 KB
assets/use_case_templates/mxfe_mixed/tcl/common_bd.tclother5.4 KB
assets/use_case_templates/mxfe_mixed/tcl/system_bd.tclother1.2 KB
assets/use_case_templates/mxfe_mixed/tcl/system_project.tclother1.2 KB
assets/use_case_templates/mxfe_mixed/verilog/system_top.vother3.4 KB
assets/use_case_templates/spi_adc/README.mdmarkdown925 B
assets/use_case_templates/spi_adc/constraints/system_constr.xdcother635 B
assets/use_case_templates/spi_adc/manifest.jsonconfig1.7 KB
assets/use_case_templates/spi_adc/tcl/common_bd.tclother6.3 KB
assets/use_case_templates/spi_adc/tcl/system_bd.tclother1.6 KB
assets/use_case_templates/spi_adc/tcl/system_project.tclother982 B
assets/use_case_templates/spi_adc/verilog/system_top.vother4.2 KB
assets/use_case_templates/spi_dac/README.mdmarkdown757 B
assets/use_case_templates/spi_dac/constraints/system_constr.xdcother546 B
assets/use_case_templates/spi_dac/manifest.jsonconfig1.6 KB
assets/use_case_templates/spi_dac/tcl/common_bd.tclother5.7 KB
assets/use_case_templates/spi_dac/tcl/system_bd.tclother1.0 KB
assets/use_case_templates/spi_dac/tcl/system_project.tclother981 B
assets/use_case_templates/spi_dac/verilog/system_top.vother3.5 KB
assets/verilog_formatter_config/defaults.jsonconfig6.2 KB
assets/verilog_formatter_config/profiles/conservative.jsonconfig283 B
assets/verilog_formatter_config/profiles/example_compat.jsonconfig484 B
assets/verilog_formatter_config/profiles/formatter-lint.jsonconfig121 B
assets/verilog_formatter_config/profiles/formatter-normalize.jsonconfig182 B
assets/verilog_formatter_config/profiles/formatter-preserve.jsonconfig385 B
assets/verilog_formatter_config/profiles/formatting.jsonconfig270 B
assets/verilog_formatter_config/profiles/lint.jsonconfig269 B
assets/verilog_formatter_config/profiles/migration.jsonconfig239 B
assets/verilog_formatter_config/profiles/stress_cases_compat.jsonconfig484 B
assets/verilog_formatter_config/profiles/vitis-wrapper.jsonconfig486 B
assets/verilog_formatter_config/schema.jsonconfig13.7 KB
assets/verilog_formatter_config/templates/task-batch.jsonconfig212 B
assets/verilog_formatter_config/templates/task-inplace.jsonconfig221 B
assets/verilog_formatter_config/templates/task-single-file.jsonconfig220 B
assets/verilog_pattern_templates/axi4_lite_csr_shell.vincother562 B
assets/verilog_pattern_templates/axi_interconnect_port_groups.vincother592 B
assets/verilog_pattern_templates/axis_ready_valid_slice.vincother494 B
assets/verilog_pattern_templates/catalog.jsonconfig2.2 KB
assets/verilog_pattern_templates/conv_load_store_pipeline.vincother457 B
assets/verilog_pattern_templates/counter_state_bridge.vincother443 B
assets/verilog_pattern_templates/equivalence_wrapper_probe.vincother306 B
assets/verilog_pattern_templates/fsm_state_transition.vincother1.0 KB
assets/verilog_pattern_templates/phase_output_registering.vincother404 B
assets/verilog_pattern_templates/wrapper_top_stitching.vincother608 B
assets/verilog_quality_gates.jsonconfig38.2 KB
assets/verilog_style_rules.jsonconfig11.8 KB
assets/xilinx_primitive_semantics.jsonconfig21.4 KB
references/checklists/capability-distillation-checklist.mdmarkdown3.0 KB
references/checklists/lint-checklist.mdmarkdown3.6 KB
references/checklists/verilog-readability-gate.mdmarkdown3.5 KB
references/corpus/verilog-style-observations.mdmarkdown4.6 KB
references/integration/configuration.mdmarkdown19.9 KB
references/integration/host-integration.mdmarkdown10.6 KB
references/rules/asic-verilog-quality.mdmarkdown3.9 KB
references/rules/erie-style.mdmarkdown6.3 KB
references/rules/testbench-patterns.mdmarkdown3.2 KB
references/rules/verilog-code-comment-naming-standard.mdmarkdown55.6 KB
references/rules/verilog-comment-placement.mdmarkdown8.4 KB
references/rules/verilog-pattern-templates.mdmarkdown1.1 KB
references/rules/verilog-quality-gates.mdmarkdown21.4 KB
references/rules/xilinx-primitive-exemptions.mdmarkdown10.6 KB
references/skill/installation.mdmarkdown6.1 KB
references/skill/script-guide.mdmarkdown7.5 KB
references/skill/skill-standards.mdmarkdown2.1 KB
references/workflows/verilog_dispatcher.mdmarkdown6.4 KB
references/workflows/workflow-contracts.mdmarkdown15.1 KB
scripts/__init__.pyscript53 B
scripts/python/__init__.pyscript55 B
scripts/python/corpus/analyze_verilog_style_corpus.pyscript25.3 KB
scripts/python/existing_rtl/existing_rtl.pyscript81.1 KB
scripts/python/existing_rtl/existing_rtl_improvement.pyscript109.9 KB
scripts/python/existing_rtl/intervention.pyscript8.3 KB
scripts/python/existing_rtl/optimizer.pyscript25.8 KB
scripts/python/existing_rtl/reflection.pyscript86.7 KB
scripts/python/existing_rtl/semantic_contract.pyscript45.6 KB
scripts/python/existing_rtl/verifier.pyscript15.3 KB
scripts/python/existing_rtl/verify_repair.pyscript4.6 KB
scripts/python/existing_rtl/verify_repair_core.pyscript45.7 KB
scripts/python/existing_rtl/verify_repair_patch_apply.pyscript23.5 KB
scripts/python/existing_rtl/verify_repair_patch_categories.pyscript35.5 KB
scripts/python/existing_rtl/verify_repair_patch_plan.pyscript25.1 KB
scripts/python/existing_rtl/verify_repair_patching.pyscript2.4 KB
scripts/python/existing_rtl/verify_repair_support.pyscript25.6 KB
scripts/python/existing_rtl/verify_repair_testbench.pyscript45.9 KB
scripts/python/existing_rtl/verify_reporting.pyscript16.1 KB
scripts/python/facade/__init__.pyscript45 B
scripts/python/facade/existing_rtl_api.pyscript14.0 KB
scripts/python/facade/quality_api.pyscript19.9 KB
scripts/python/facade/representative_cases.pyscript38.3 KB
scripts/python/facade/verilog_api.pyscript6.5 KB
scripts/python/facade/workflow_api.pyscript63.2 KB
scripts/python/generation/tb_generator.pyscript54.9 KB
scripts/python/header_contract.pyscript21.1 KB
scripts/python/installation/__init__.pyscript52 B
scripts/python/installation/bundle.pyscript16.3 KB
scripts/python/installation/catalog.pyscript16.6 KB
scripts/python/installation/cli.pyscript26.4 KB
scripts/python/installation/projection.pyscript14.2 KB
scripts/python/installation/receipt.pyscript13.4 KB
scripts/python/installation/transaction.pyscript29.0 KB
scripts/python/quality/clock_name_roles.pyscript1.0 KB
scripts/python/quality/comment_placement.pyscript49.5 KB
scripts/python/quality/declaration_region_policy.pyscript8.0 KB
scripts/python/quality/deliverable_gate.pyscript51.9 KB
scripts/python/quality/external_interface_stubs.pyscript41.5 KB
scripts/python/quality/formatter_ast.pyscript85.0 KB
scripts/python/quality/formatter_ast_instances.pyscript5.4 KB

scripts/python/existing_rtl/intervention.py

View on GitHub
"""人工介入决策的归一化、适用范围判断和记忆条目生成。"""

# 未来注解避免运行时解析复杂类型,保持轻量导入。
from __future__ import annotations

# 标准库类型:仅用于描述 JSON-like 字典中的任意值。
from typing import Any

# 公开入口把用户回答转换成 workflow 可持久化的决策和记忆。
def resolve_intervention(intervention: dict[str, Any], answer: dict[str, Any]) -> tuple[dict[str, Any], dict[str, Any]]:
    """
    将一次人工介入回答整理为决策对象和决策记忆。

    :param intervention: workflow 生成的待确认问题,包含来源和问题文本。
    :param answer: 用户提交的回答对象,必须包含 decision、evidence、constraints 和 affected_subfunctions。
    :return: 二元组,第一项是 resolved decision,第二项是可写入 workflow state 的 memory。
    :raises ValueError: 当回答不是对象、缺少必要字段或 decision 为空时抛出。
    """

    # 先校验回答字段,避免写出不完整的人类决策记录。
    _validate_answer(answer)

    # affected_subfunctions 为空时默认影响全部子功能,保持旧流程的全局决策语义。
    list_affected = [str(item) for item in _as_list(answer.get("affected_subfunctions"))] or ["*"]  # 影响范围

    # 原始介入摘要单独命名,避免主决策对象变成难读的大字典。
    dict_source_intervention = {
        "primary_source": intervention.get("primary_source"),  # 原始介入来源
        "question": intervention.get("question"),  # 原始人工确认问题
    }  # 原始介入摘要对象

    # 决策对象保留原有 wire shape,供 workflow state 和报告继续读取。
    dict_decision: dict[str, Any] = {}  # 人工决策记录

    # 决策记录版本用于未来迁移兼容。
    dict_decision["version"] = 1  # 决策记录版本

    # 人工介入完成后固定进入 resolved 状态。
    dict_decision["status"] = "resolved"  # 人工介入已解决状态

    # 决策文本保持用户原文的字符串形式。
    dict_decision["decision"] = str(answer["decision"])  # 用户确认的决策文本

    # 证据字段归一化为列表,保留旧 wire shape。
    dict_decision["evidence"] = _as_list(answer.get("evidence", []))  # 用户提供的证据列表

    # 约束字段归一化为列表,供记忆摘要拼接。
    dict_decision["constraints"] = _as_list(answer.get("constraints", []))  # 用户确认的约束列表

    # 影响范围使用前面计算好的默认星号语义。
    dict_decision["affected_subfunctions"] = list_affected  # 决策影响的子功能范围

    # 原始介入摘要保留问题来源,便于审计人类决策链。
    dict_decision["source_intervention"] = dict_source_intervention  # 原始介入摘要

    # 记忆条目按影响范围展开,让后续阶段能按子功能匹配人类决策。
    dict_memory = {
        "version": 1,  # 记忆结构版本
        "entries": [  # workflow 可持久化的记忆条目列表
            {
                "subfunction": subfunction_name,  # 记忆适用的子功能
                "stage": "*",  # 决策适用于所有阶段
                "error_signature": "human_decision",  # 人工决策的固定错误签名
                "constraint": _constraint_text(dict_decision),  # 可读约束摘要
                "decision": dict_decision["decision"],  # 原始决策文本
            }
            for subfunction_name in list_affected  # 决策影响范围逐项展开
        ],  # 按影响范围展开后的记忆条目集合
    }

    # 返回决策和记忆,调用方负责写入状态文件或报告。
    return dict_decision, dict_memory

# workflow 在进入子功能阶段前用该函数判断已有人工决策是否命中。
def decision_applies(decision: dict[str, Any] | None, subfunction: str | None) -> bool:
    """
    判断人工决策是否适用于指定子功能。

    :param decision: 已解析的人工决策对象;为空表示没有可用决策。
    :param subfunction: 当前子功能名称;为空时表示调用方处于全局上下文。
    :return: 当决策为空返回 False;当影响范围为空、包含 ``*``、处于全局上下文或命中子功能名时返回 True。
    """

    # 没有决策时不能套用任何人工约束。
    if not decision:

        # 返回不适用,保持调用方继续等待或触发人工介入。
        return False

    # 决策影响范围统一转字符串列表,兼容 JSON 中的数字或其他标量。
    list_affected = [str(item) for item in decision.get("affected_subfunctions", []) or []]  # 当前决策影响范围

    # 空范围、全局星号、全局上下文或显式子功能命中都视为适用。
    return not list_affected or "*" in list_affected or subfunction is None or str(subfunction) in list_affected

# 回答校验集中在这里,保持 resolve_intervention 主流程直观。
def _validate_answer(answer: dict[str, Any]) -> None:
    """校验人工介入回答是否包含生成决策所需的字段。

    参数:
        answer: 用户提交的人工介入回答对象。

    返回:
        无。

    异常:
        ValueError: 当回答不是对象、缺少字段或 decision 为空时抛出。
    """

    # 人工回答必须是 JSON object,列表或字符串都无法承载必要字段。
    if not isinstance(answer, dict):

        # 错误前缀遵循脚本输出规范,主体保留原英文诊断。
        raise ValueError("> ERR: [Python] Human intervention answer must be a JSON object.")

    # 必需字段缺失时一次性报告全部字段,方便用户补齐回答。
    list_missing = [
        field_name  # 缺失的必需字段名
        for field_name in ("decision", "evidence", "constraints", "affected_subfunctions")  # 必需字段枚举
        if field_name not in answer  # 当前回答缺失该字段
    ]  # 缺失字段列表

    # 缺字段的回答不能进入决策记忆,否则后续阶段会误用不完整约束。
    if list_missing:

        # 缺失字段列表保留原拼接格式,便于用户直接补齐。
        raise ValueError(
            "> ERR: [Python] Human intervention answer is missing required fields: " + ", ".join(list_missing)
        )

    # decision 文本为空时无法形成可审计的人类决策。
    if not str(answer.get("decision", "")).strip():

        # 空决策的诊断也保留英文主体,便于既有调用方识别原因。
        raise ValueError("> ERR: [Python] Human intervention answer decision must not be empty.")

# 记忆约束摘要只拼接非空约束,避免空字符串污染报告。
def _constraint_text(decision: dict[str, Any]) -> str:
    """把人工决策和非空约束合成为可写入记忆的摘要。

    参数:
        decision: 已解析的人工决策对象。

    返回:
        面向 prompt 记忆的人工决策摘要文本。
    """

    # 约束文本使用分号拼接,保留用户提供约束的顺序。
    str_constraints = "; ".join(str(item) for item in decision.get("constraints", []) if str(item).strip())  # 约束摘要

    # 有约束时把决策和约束同时写入记忆,便于后续 prompt 引用。
    if str_constraints:

        # 返回带约束的人工决策摘要。
        return f"Human decision: {decision['decision']}. Constraints: {str_constraints}."

    # 没有约束时只记录决策本身。
    return f"Human decision: {decision['decision']}."

# JSON 字段兼容空值、列表和单项标量三种输入。
def _as_list(value: Any) -> list[Any]:
    """把 JSON 字段值归一化为列表形态。

    参数:
        value: 可能为空、列表或单项标量的 JSON 字段值。

    返回:
        归一化后的列表对象;原列表输入保持原对象返回。
    """

    # 空值代表没有条目。
    if value is None:

        # 返回空列表,调用方不需要再判断 None。
        return []

    # 列表输入保留原有顺序和元素对象。
    if isinstance(value, list):

        # 返回原列表,保持旧行为不做深拷贝。
        return value

    # 标量输入提升为单元素列表,兼容简单回答格式。
    return [value]
planning-and-task-breakdownaddyosmani/agent-skillsBreaks work into ordered tasks. Use when you have a spec or clear requirements and need to break work into implementable tasks. Use when a task feels too large to start, when you need to estimate scope, or when parallel work is possible.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
screenpipethedotmack/claude-memSearch screen and audio history recorded by Screenpipe and optionally save selected context into claude-mem. Use when the user asks to recall desktop activity, a meeting, or something seen in another app through Screenpipe.Stars: 118kUpdated Claude CodeCodexVerifiedInstall
contact-widgetnexu-io/open-designSelf-contained floating chat widget with welcome screen, social links, meeting button, and message input. Single HTML file, zero dependencies.Stars: 108kUpdated Claude CodeCodexVerifiedInstall
meeting-notesnexu-io/open-designMeeting notes page — title bar with attendees, agenda checklist, decisions block, action items table with owners + dates, and a "next meeting" footer. Use when the brief mentions "meeting notes", "minutes", "1:1 notes", "all-hands recap", or "会议纪要".Stars: 108kUpdated Claude CodeCodexVerifiedInstall