Prm Schema
Auto-generated
This page is generated from prm_schema.json by the schema doc generator. To update this page, edit the schema file and run bin/chore gen schema-docs.
Definitions
prm_chapter
| Property | Type | Required | Description |
|---|---|---|---|
id | identifier | ✓ | Unique identifier for the chapter |
title | string | ✓ | Human-readable title for the chapter |
description | string | Optional description of the chapter | |
level | integer | AsciiDoc heading level (1-6) | |
type | standard | appendix | Type of chapter - standard or appendix | |
auto_generate | Array<instructions | csrs> | Auto-generate reference content for instructions and/or CSRs | |
external_documentation | Array<external_documentation> | External documentation sources to include | |
non_isa_specifications | Array<non_isa_specification> | UDB non-ISA specification references |
external_documentation — External documentation source (ISA manuals, external specs, etc.)
External documentation source (ISA manuals, external specs, etc.)
| Property | Type | Required | Description |
|---|---|---|---|
source | string | ✓ | Source identifier (e.g., 'riscv-isa-manual', 'riscv-elf-psabi-doc') |
type | isa_manual | external_spec | ✓ | Type of external documentation |
path | string | ✓ | Relative path from workspace root to documentation directory |
version | Version requirement or list of requirements (e.g., >= 2.0 or ['>= 2.0', '< 3.0']) | Version requirement | |
chapters | Array<external_chapter> | Specific chapters or sections to include | |
resolve_includes | boolean | Resolve AsciiDoc include directives |
non_isa_specification — UDB non-ISA specification reference
UDB non-ISA specification reference
| Property | Type | Required | Description |
|---|---|---|---|
name | specification_name | ✓ | Name of the UDB non-ISA specification |
version | Version requirement or list of requirements (e.g., >= 2.0 or ['>= 2.0', '< 3.0']) | ✓ | Version requirement for the specification |
external_chapter — Reference to external chapter or section
Reference to external chapter or section
| Property | Type | Required | Description |
|---|---|---|---|
file | string | ✓ | Filename to include (e.g., 'riscv-cc.adoc', 'rv32.adoc') |
title | string | Custom title for this chapter | |
exclude_content | Array<string> | Content IDs to exclude (excludes entire sections/chapters and their subsections by AsciiDoc ID) | |
level_offset | integer | Heading level offset |
Properties
| Property | Type | Required | Description |
|---|---|---|---|
$schema | any | ✓ | |
kind | any | ✓ | |
name | specification_name | ✓ | Name (database key) of this PRM |
description | string | ✓ | Brief description of this PRM |
processor_config | object | ✓ | |
chapters | Array<prm_chapter> | ✓ | Ordered list of chapters in the PRM |
Tooling field
$source is an optional field set automatically by UDB tooling to record the file path this object was loaded from. You do not need to set it manually.
Schema Information
| Property | Value |
|---|---|
| Version | v0.1 |
| JSON Schema Version | Draft 07 |