schema doc

pulp-platform · Feb 23, 2022 · 0aefa4a · 0aefa4a
1 parent 56beecc
commit 0aefa4a
Show file tree

Hide file tree

Showing 196 changed files with 2,770 additions and 1,093 deletions.
diff --git a/docs/schema-doc/axi_xbar-properties-fall_through.md b/docs/schema-doc/axi_xbar-properties-fall_through.md
@@ -6,10 +6,10 @@ http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/fall_through
 
 Configure crossbar to be fall-through (zero latency).
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                           |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [axi_xbar.schema.json*](axi_xbar.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [axi\_xbar.schema.json\*](axi_xbar.schema.json "open original schema") |
 
-## fall_through Type
+## fall\_through Type
 
 `boolean`
diff --git a/docs/schema-doc/axi_xbar-properties-max_mst_trans.md b/docs/schema-doc/axi_xbar-properties-max_mst_trans.md
@@ -6,15 +6,15 @@ http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_mst_trans
 
 Maximum outstanding transaction on the master port.
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                           |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [axi_xbar.schema.json*](axi_xbar.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [axi\_xbar.schema.json\*](axi_xbar.schema.json "open original schema") |
 
-## max_mst_trans Type
+## max\_mst\_trans Type
 
 `integer`
 
-## max_mst_trans Default Value
+## max\_mst\_trans Default Value
 
 The default value is:
 

diff --git a/docs/schema-doc/axi_xbar-properties-max_slv_trans.md b/docs/schema-doc/axi_xbar-properties-max_slv_trans.md
@@ -6,15 +6,15 @@ http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_slv_trans
 
 Maximum outstanding transaction on the slave port.
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                           |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [axi_xbar.schema.json*](axi_xbar.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [axi\_xbar.schema.json\*](axi_xbar.schema.json "open original schema") |
 
-## max_slv_trans Type
+## max\_slv\_trans Type
 
 `integer`
 
-## max_slv_trans Default Value
+## max\_slv\_trans Default Value
 
 The default value is:
 

diff --git a/docs/schema-doc/axi_xbar.md b/docs/schema-doc/axi_xbar.md
@@ -6,23 +6,23 @@ http://pulp-platform.org/snitch/axi_xbar.schema.json
 
 AXI Crossbar Properties
 
-| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                          |
-| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------ |
-| Can be instantiated | No         | Unknown status | No           | Forbidden         | Allowed               | none                | [axi_xbar.schema.json](axi_xbar.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                           |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Allowed               | none                | [axi\_xbar.schema.json](axi_xbar.schema.json "open original schema") |
 
 ## AXI Crossbar Schema Type
 
 `object` ([AXI Crossbar Schema](axi_xbar.md))
 
 # AXI Crossbar Schema Properties
 
-| Property                        | Type      | Required | Nullable       | Defined by                                                                                                                                   |
-| :------------------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------- |
-| [max_slv_trans](#max_slv_trans) | `integer` | Optional | cannot be null | [AXI Crossbar Schema](axi_xbar-properties-max_slv_trans.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_slv_trans") |
-| [max_mst_trans](#max_mst_trans) | `integer` | Optional | cannot be null | [AXI Crossbar Schema](axi_xbar-properties-max_mst_trans.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_mst_trans") |
-| [fall_through](#fall_through)   | `boolean` | Optional | cannot be null | [AXI Crossbar Schema](axi_xbar-properties-fall_through.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/fall_through")   |
+| Property                          | Type      | Required | Nullable       | Defined by                                                                                                                                   |
+| :-------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------- |
+| [max\_slv\_trans](#max_slv_trans) | `integer` | Optional | cannot be null | [AXI Crossbar Schema](axi_xbar-properties-max_slv_trans.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_slv_trans") |
+| [max\_mst\_trans](#max_mst_trans) | `integer` | Optional | cannot be null | [AXI Crossbar Schema](axi_xbar-properties-max_mst_trans.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_mst_trans") |
+| [fall\_through](#fall_through)    | `boolean` | Optional | cannot be null | [AXI Crossbar Schema](axi_xbar-properties-fall_through.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/fall_through")   |
 
-## max_slv_trans
+## max\_slv\_trans
 
 Maximum outstanding transaction on the slave port.
 
@@ -36,19 +36,19 @@ Maximum outstanding transaction on the slave port.
 
 *   defined in: [AXI Crossbar Schema](axi_xbar-properties-max_slv_trans.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_slv_trans")
 
-### max_slv_trans Type
+### max\_slv\_trans Type
 
 `integer`
 
-### max_slv_trans Default Value
+### max\_slv\_trans Default Value
 
 The default value is:
 
 ```json
 4
 ```
 
-## max_mst_trans
+## max\_mst\_trans
 
 Maximum outstanding transaction on the master port.
 
@@ -62,19 +62,19 @@ Maximum outstanding transaction on the master port.
 
 *   defined in: [AXI Crossbar Schema](axi_xbar-properties-max_mst_trans.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/max_mst_trans")
 
-### max_mst_trans Type
+### max\_mst\_trans Type
 
 `integer`
 
-### max_mst_trans Default Value
+### max\_mst\_trans Default Value
 
 The default value is:
 
 ```json
 4
 ```
 
-## fall_through
+## fall\_through
 
 Configure crossbar to be fall-through (zero latency).
 
@@ -88,6 +88,6 @@ Configure crossbar to be fall-through (zero latency).
 
 *   defined in: [AXI Crossbar Schema](axi_xbar-properties-fall_through.md "http://pulp-platform.org/snitch/axi_xbar.schema.json#/properties/fall_through")
 
-### fall_through Type
+### fall\_through Type
 
 `boolean`
diff --git a/docs/schema-doc/occamy-properties-hbi-default.md b/docs/schema-doc/occamy-properties-hbi-default.md
@@ -6,9 +6,9 @@ http://pulp-platform.org/snitch/occamy.schema.json#/properties/hbi/default
 
 
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                       |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json*](occamy.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                        |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json\*](occamy.schema.json "open original schema") |
 
 ## default Type
 

diff --git a/docs/schema-doc/occamy-properties-hbi-properties-address.md b/docs/schema-doc/occamy-properties-hbi-properties-address.md
@@ -6,9 +6,9 @@ http://pulp-platform.org/snitch/occamy.schema.json#/properties/hbi/properties/ad
 
 Start address of SPM (Scratchpad Memory).
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                       |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json*](occamy.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                        |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json\*](occamy.schema.json "open original schema") |
 
 ## address Type
 

diff --git a/docs/schema-doc/occamy-properties-hbi-properties-length.md b/docs/schema-doc/occamy-properties-hbi-properties-length.md
@@ -6,9 +6,9 @@ http://pulp-platform.org/snitch/occamy.schema.json#/properties/hbi/properties/le
 
 Size of SPM based on the address range. The full address range will be mapped to SPM.
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                       |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json*](occamy.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                        |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json\*](occamy.schema.json "open original schema") |
 
 ## length Type
 

diff --git a/docs/schema-doc/occamy-properties-hbi-properties.md b/docs/schema-doc/occamy-properties-hbi-properties.md
@@ -0,0 +1,15 @@
+# Untitled undefined type in Occamy System Schema Schema
+
+```txt
+http://pulp-platform.org/snitch/occamy.schema.json#/properties/hbi/properties
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                        |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json\*](occamy.schema.json "open original schema") |
+
+## properties Type
+
+unknown
diff --git a/docs/schema-doc/occamy-properties-hbi.md b/docs/schema-doc/occamy-properties-hbi.md
@@ -6,9 +6,9 @@ http://pulp-platform.org/snitch/occamy.schema.json#/properties/hbi
 
 
 
-| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                       |
-| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | No           | Forbidden         | Allowed               | none                | [occamy.schema.json*](occamy.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                        |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Allowed               | none                | [occamy.schema.json\*](occamy.schema.json "open original schema") |
 
 ## hbi Type
 
@@ -24,7 +24,7 @@ The default value is:
 }
 ```
 
-# undefined Properties
+# hbi Properties
 
 | Property            | Type     | Required | Nullable       | Defined by                                                                                                                                                  |
 | :------------------ | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/schema-doc/occamy-properties-hbm-default.md b/docs/schema-doc/occamy-properties-hbm-default.md
@@ -6,9 +6,9 @@ http://pulp-platform.org/snitch/occamy.schema.json#/properties/hbm/default
 
 
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                       |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json*](occamy.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                        |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json\*](occamy.schema.json "open original schema") |
 
 ## default Type
 

diff --git a/docs/schema-doc/occamy-properties-hbm-properties-address.md b/docs/schema-doc/occamy-properties-hbm-properties-address.md
@@ -6,9 +6,9 @@ http://pulp-platform.org/snitch/occamy.schema.json#/properties/hbm/properties/ad
 
 Start address of SPM (Scratchpad Memory).
 
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                       |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json*](occamy.schema.json "open original schema") |
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                        |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [occamy.schema.json\*](occamy.schema.json "open original schema") |
 
 ## address Type