Common patterns used by all schemas

v0.1

Auto-generated

This page is generated from schema_defs.json by the schema doc generator. To update this page, edit the schema file and run bin/chore gen schema-docs.

Definitions

$source — Path to the source file containing this object

Path to the source file containing this object

Type: string

semantic_version

Type: string

rvi_version

Type: string

csr_name — CSR name

CSR name

Type: string

csr_field — CSR field

CSR field

Type: string

csr_field_bits — CSR field

CSR field

Type: string

field_location — Location of a field in a register

Location of a field in a register

bit_length_value — Bit width value for a register or field

Bit width value for a register or field

register_name — Register name

Type: string

register_file_name — Register file name

Type: string

register_alias — Register alias or ABI mnemonic

Type: string

possibly_split_field_location — Location specifier for a field

Location specifier for a field

revision_history_entry

Property	Type	Required	Description
`revision`	`semantic_version`	✓	Revision number
`date`	`string`	✓	The date of the change
`changes`	Array<`string`>	✓	List of changes

spec_state — Ratification state of a specification or extension version: development (actively being worked on), frozen (feature-complete, under review), public-review (open for public comment), ratification-ready (approved by the task group, awaiting board vote), ratified (officially approved by RISC-V International), or nonstandard-released (released but not part of the RISC-V standard).

Ratification state of a specification or extension version: development (actively being worked on), frozen (feature-complete, under review), public-review (open for public comment), ratification-ready (approved by the task group, awaiting board vote), ratified (officially approved by RISC-V International), or nonstandard-released (released but not part of the RISC-V standard).

Allowed values:

development
frozen
public-review
ratification-ready
ratified
nonstandard-released

spec_text

conditional_text

Property	Type	Required	Description
`text`	`string`	✓	Asciidoctor source
`when()`	`string`		IDL boolean expression. When true, the text applies
`when_ast`	`object`

license — License that applies to the textual documentation for this extension

License that applies to the textual documentation for this extension

Property	Type	Description
`name`	`string`	License name
`id`	`string`	License identifier
`url`	`string`	Link to license text
`text_url`	`string`	Link to license text

company — A company

A company

Property	Type	Required	Description
`name`	`string`		Name of the company. Should be "RISC-V International" for standard extensions
`url`	`string`		Website of the company. Should be "https://riscv.org" for standard extensions

extension_presence

date — A specific day in YYYY-MM-DD format

A specific day in YYYY-MM-DD format

Type: string

extension_name — Extension name (e.g., I, M, Zicsr, Smstateen)

Extension name (e.g., I, M, Zicsr, Smstateen)

Type: string

extension_version — Exact version in MAJOR[.MINOR[.PATCH]] format (e.g., 2.1.0, 2.1, 2)

Exact version in MAJOR[.MINOR[.PATCH]] format (e.g., 2.1.0, 2.1, 2)

requirement_string — Version requirement string (e.g., >= 2.0, ~> 1.5, = 2.1)

Version requirement string (e.g., >= 2.0, ~> 1.5, = 2.1)

Type: string

version_requirements — Version requirement or list of requirements (e.g., >= 2.0 or ['>= 2.0', '< 3.0'])

Version requirement or list of requirements (e.g., >= 2.0 or ['>= 2.0', '< 3.0'])

extension_requirement — A requirement on an extension. Can either specify just an extension name, in which case version '>= 0' is implied, or both a name and a requirement

A requirement on an extension. Can either specify just an extension name, in which case version '>= 0' is implied, or both a name and a requirement

Property	Type	Required	Description
`name`	`extension_name`	✓
`version`	`version_requirements`

param_name

Type: string

param_requirement

Property	Type	Required	Description
`name`	`param_name`	✓
`schema`	`json-schema-draft-07`	✓

requires_entry

extension_with_version

Property	Type	Required	Description
`name`	`extension_name`	✓
`version`	`extension_version`	✓

author

Property	Type	Required	Description
`name`	`string`	✓	Author's full name
`email`	`string`		Author's email address
`organization`	`organization`		Author's organization, which should be an RVI member (or individual)

organization

Property	Type	Required	Description
`name`	`string`	✓	Organization name
`url`	`string`		Organization URL

when_condition

Property	Type	Required	Description
`version`	`version_requirements`

parameter_constraint

Property	Type	Required	Description
`schema`	`json-schema-draft-07`
`when`	`when_condition`

cert_normative_rules — Architecturally visible behaviors requiring validation by certification tests

Architecturally visible behaviors requiring validation by certification tests

Type: array

encoding_match

inst_type_name

Type: string

inst_subtype_name

Type: string

reference — reference to another database object, as a JSON Reference

reference to another database object, as a JSON Reference

Type: string

integer — An integer, either native to JSON or a number-like string

An integer, either native to JSON or a number-like string

ref_url

Type: string

ref_url_list

extension_condition — A logic condition specifying certain extension version requirements

A logic condition specifying certain extension version requirements

Property	Type	Required	Description
`extension`	One of: `extension_requirement` \| `object` \| `object`	✓

param_condition

Property	Type	Required	Description
`param`	One of: `object` \| `object`	✓

idl — IDL code

IDL code

Type: string

idl_condition — A condition expressed with IDL

A condition expressed with IDL

Property	Type	Required	Description
`idl()`	`idl`	✓	IDL function containing one or more implications (e.g., A -> B).
`idl_ast`	`object`
`reason`	`string`		Why the constraint exists

yaml_condition

xlen_condition

Property	Type	Required	Description
`xlen`	`32` \| `64`	✓

condition — A condition (YAML structure or IDL function). See the conditions reference for details.

A condition (YAML structure or IDL function). See the conditions reference for details.

extension_requirement_list_item — A list of extension requirements, possibly with a condition

A list of extension requirements, possibly with a condition

extension_requirement_list

uint32

Type: integer

uint64

Type: integer

32bit_unsigned_pow2 — An unsigned power of 2 that fits in 32 bits

An unsigned power of 2 that fits in 32 bits

Allowed values:

1
2
4
8
16
32
64
128
256
512
1024
2048
4095
8192
16384
32768
65536
131072
262144
524288
1048576
2097152
4194304
8388608
16777216
33554432
67108864
134217728
268435456
536870912
1073741824
2147483648

64bit_unsigned_pow2 — An unsigned power of 2 that fits in 64 bits

An unsigned power of 2 that fits in 64 bits

Allowed values:

1
2
4
8
16
32
64
128
256
512
1024
2048
4095
8192
16384
32768
65536
131072
262144
524288
1048576
2097152
4194304
8388608
16777216
33554432
67108864
134217728
268435456
536870912
1073741824
2147483648
4294967296
8589934592
17179869184
34359738368
68719476736
137438953472
274877906944
549755813888
1099511627776
2199023255552
4398046511104
8796093022208
17592186044416
35184372088832
70368744177664
140737488355328
281474976710656
562949953421312
1125899906842624
2251799813685248
4503599627370496
9007199254740992
18014398509481984
36028797018963968
72057594037927936
144115188075855872
288230376151711744
576460752303423488
1152921504606846976
2305843009213693952
4611686018427387904
9223372036854775808

Schema Information

Property	Value
Version	`v0.1`
JSON Schema Version	Draft 07

Definitions​

Schema Information​

Definitions

Schema Information