Interconnect Specification¶
The input depends on frontend used. Below are the specifications for available frontends.
YAML Syntax Specification¶
Full examples are provided at the bottom of this file and in examples.
The current version of the specification is 1.0.
Top Level Fields¶
Field Name |
Required |
Description |
Default |
|
yes |
version of specification used |
- |
|
no |
interconnect name |
|
|
no |
interconnect version |
|
Top Level Sections¶
These sections are explained in detail in their own subsections of this document.
Field Name |
Required |
Description |
|
no |
interconnect configuration options |
|
no |
default options for parameters |
|
no |
clocks used in the interconnect |
|
yes |
interconnect ports |
|
no* |
crossbars used |
|
no* |
connections between ports and crossbars |
|
yes |
determines which addresses lead to what port |
*crossbars and connections must either both be defined or both be left for inference
Global¶
Global parameters for configuring global interconnect behavior.
None of the fields are required.
If they are unspecified, they are set to default value.
If the global field is empty, it is valid to omit it completely.
Field Name |
Description |
Allowed Values |
Default |
|
address width, used in address map and by the components |
any positive integer |
|
Default¶
Default parameters specify the default value for various fields used throughout the specification.
None of the fields are required; if they are unspecified, they are unset.
If the default field is empty, it is valid to omit it completely.
For the allowed set of values, see the corresponding fields in other sections.
Field Name |
Description |
|
data width of interconnect ports |
|
clock name to be used by components and ports |
|
frequency to be used by clocks |
|
bus protocol of interconnect ports |
Backend Specific¶
Pulp Platform Axi¶
Accepted only with the topwrap_pulpplatform backend (the default), which defines them in omnibus/backend/topwrap_pulpplatform.schema.yml.
Other backends report them as unknown with a warning.
Field Name |
Description |
|
max number of outstanding reads of data width and ID width converters |
Clocks¶
Specifies clocks and their frequencies. Each clock implies a reset domain.
Each clock is defined as:
name:
frequency: ...
where name has to be a unique clock identifier.
frequency can be omitted, in which case it is taken from Defaults, or set to n/a if not available.
Valid values for frequency are positive numbers in Hz (e.g. 100e6), or strings made of an optional positive integer and an optional suffix Hz, k, kHz, M, MHz, G or GHz, which scales the value accordingly (e.g. "100MHz", "25k"), or n/a. Strings can’t hold fractions or exponents: write "2500kHz" or 2.5e6 rather than "2.5MHz".
When omitted, one clock with the name clk and a default frequency is created.
Ports¶
Interconnect ports.
Each port has to have a unique name.
Field Name |
Optional |
Allowed Values |
Description |
|
no |
‘subordinate’ or ‘manager’ |
determines port role from the perspective of interconnect |
|
yes* |
any positive integer |
- |
|
yes* |
any valid clock name, see Clocks |
clock domain of the port |
|
yes* |
one of |
bus protocol to be used |
|
yes |
any valid name |
group for muxed buses, NOT SUPPORTED YET |
* optional only if default exists, see Defaults
Crossbars¶
Interconnect crossbars.
Each crossbar has to have a unique name. If a crossbar’s clock is not specified and no default exists, then the clock will be inferred from the design.
Field Name |
Optional |
Allowed Values |
Description |
|
yes |
any valid clock name, see Clocks |
clock domain of the crossbar |
|
no |
see below |
ports of the crossbar |
Each port is defined as:
name:
role: ...
where name has to be unique to the crossbar, while role takes either subordinate or manager as arguments.
They specify whether the port is a subordinate or a manager with respect to the crossbar.
The crossbars field can be omitted. In such case:
connectionsfield must also be omittedone all-to-all crossbar is generated
Connections¶
Interconnect connections between ports and crossbars.
If the crossbars field is omitted, this field must be omitted too; otherwise, it must be specified.
Each connection is specified as porta -> portb in the direction of interconnect subordinate ports to interconnect manager ports (device manager to device subordinate).
If a port is a top level port (from ports field), its name is taken as is, e.g. cpu.
If a port is a crossbar port, its name is “crossbar.port”, e.g. main.cpu.
Field Name |
Optional |
Allowed Values |
Default |
Description |
|
yes |
any nonnegative integer |
|
number of skid buffers NOT SUPPORTED YET |
|
yes |
|
|
whether to treat this connection as clock barier |
|
yes |
any positive integer |
|
sets data width of this connection |
|
yes |
|
|
whether to treat this connection as protocol propagation barrier |
Backend specific parameters¶
Pulp Platform Axi¶
Accepted only with the topwrap_pulpplatform backend (the default), which defines them in omnibus/backend/topwrap_pulpplatform.schema.yml.
Other backends report them as unknown, with a warning.
Field Name |
Optional |
Allowed Values |
Default |
Description |
|
yes |
any positive integer |
value from Defaults if exists, otherwise |
max number of outstanding reads of data width and ID width converters on this connection |
Address Map¶
Address map inside an interconnect. It is specified as a set of entries. Each entry is identified by a unique name.
Field Name |
Optional |
Allowed Values |
Default |
Description |
|
yes |
single port or list of ports |
all ports |
source ports for which address map applies NOT SUPPORTED YET |
|
no |
single port |
- |
destination port for which address map applies |
|
no |
any valid nonnegative integer |
- |
base address of address map |
|
no |
any valid nonnegative integer |
- |
size of address map entry |
Full File¶
desc_version: 1.0
name: Interconnect
version: 0.1
#addr width defaults to 32
default:
data_width: 64
clock: clka
frequency: 10MHz
protocol: AXI4
axi_max_reads: 1
clocks:
clka:
frequency: 10GHz
clkb:
frequency: 10e6
clkc:
#frequency taken from default
ports:
porta:
role: "subordinate"
#other parameters are taken from their default value
portb:
protocol: AXI4Lite
role: "manager"
clock: clkb
data_width: 32
crossbars:
main:
#clock taken from default
porta:
role: "subordinate"
portb:
role: "manager"
connections:
"porta -> main.porta":
registers: 1
axi_max_reads: 2 #overwrites default
#does NOT have "protocol: True"
"main.portb -> portb":
cdc: True
#also has "protocol: True", can be overwritten with "protocol: False"
address_map:
"portb":
to: portb
base: 0x0000
size: 0xFFFF