org.accellera.spirit.v1_2 package

Submodules

org.accellera.spirit.v1_2.access module

class org.accellera.spirit.v1_2.access.Access(value=None)

Bases: object

Indicates the accessibility of the data in the address block.

Possible values are ‘read-write’, ‘read-only’ and ‘write-only’.

Parameters:

value (AccessType | None)

value: AccessType | None

org.accellera.spirit.v1_2.access_type module

org.accellera.spirit.v1_2.ad_hoc_connection module

class org.accellera.spirit.v1_2.ad_hoc_connection.AdHocConnection(export=None, pin_reference=<factory>, name=None)

Bases: object

Represents an ad-hoc connection between component pins.

Variables:

• export – Specifies whether this ad-hoc connection will be exported out of the design.

• pin_reference

• name

Parameters:

• export (Export | None)

• pin_reference (Iterable[PinReference])

• name (str | None)

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class PinReference(component_ref: str | None = None, signal_ref: str | None = None, left: int | None = None, right: int | None = None)

Bases: object

Parameters:

• component_ref (str | None)

• signal_ref (str | None)

• left (int | None)

• right (int | None)

component_ref: str | None

left: int | None

right: int | None

signal_ref: str | None

export: Export | None

name: str | None

pin_reference: Iterable[PinReference]

org.accellera.spirit.v1_2.ad_hoc_connections module

class org.accellera.spirit.v1_2.ad_hoc_connections.AdHocConnections(ad_hoc_connection=<factory>)

Bases: object

Defines the set of ad-hoc connections in a design.

An ad-hoc connection represents a connection between two component pins which were not connected as a result of interface connections (i.e.the pin to pin connection was made explicitly and is represented explicitly).

Parameters:

ad_hoc_connection (Iterable[AdHocConnection])

ad_hoc_connection: Iterable[AdHocConnection]

org.accellera.spirit.v1_2.add_rem_change module

class org.accellera.spirit.v1_2.add_rem_change.AddRemChange(value=None)

Bases: object

Indicates whether the alteration is an addition or a removal.

Parameters:

value (AddRemChangeValue | None)

value: AddRemChangeValue | None

org.accellera.spirit.v1_2.add_rem_change_value module

class org.accellera.spirit.v1_2.add_rem_change_value.AddRemChangeValue(*values)

Bases: Enum

ADD = 'add'

REMOVE = 'remove'

org.accellera.spirit.v1_2.add_rem_rep_change module

class org.accellera.spirit.v1_2.add_rem_rep_change.AddRemRepChange(value=None)

Bases: object

Indicates whether the alteration is an addition, removal or a replacement.

Parameters:

value (AddRemRepChangeValue | None)

value: AddRemRepChangeValue | None

org.accellera.spirit.v1_2.add_rem_rep_change_value module

class org.accellera.spirit.v1_2.add_rem_rep_change_value.AddRemRepChangeValue(*values)

Bases: Enum

ADD = 'add'

REMOVE = 'remove'

REPLACE = 'replace'

org.accellera.spirit.v1_2.addr_space_ref_type module

class org.accellera.spirit.v1_2.addr_space_ref_type.AddrSpaceRefType(address_space_ref=None)

Bases: object

Base type for an element which references an address space.

Reference is kept in an attribute rather than the text value, so that the type may be extended with child elements if necessary.

Parameters:

address_space_ref (str | None)

address_space_ref: str | None

org.accellera.spirit.v1_2.address_bank_type module

class org.accellera.spirit.v1_2.address_bank_type.AddressBankType(base_address=None, bit_offset=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameter=<factory>, vendor_extensions=None, bank_alignment=None)

Bases: object

Variables:

• base_address

• bit_offset

• address_block – An address block within the bank. No address information is supplied.

• bank – A nested bank of blocks within a bank. No address information is supplied.

• subspace_map

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• vendor_extensions

• bank_alignment

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• address_block (Iterable[BankedBlockType])

• bank (Iterable[BankedBankType])

• subspace_map (Iterable[BankedSubspaceType])

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• bank_alignment (BankAlignmentType | None)

access: Access | None

address_block: Iterable[BankedBlockType]

bank: Iterable[BankedBankType]

bank_alignment: BankAlignmentType | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

parameter: Iterable[NameValuePairType]

subspace_map: Iterable[BankedSubspaceType]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

org.accellera.spirit.v1_2.address_block module

class org.accellera.spirit.v1_2.address_block.AddressBlock(base_address=None, bit_offset=None, range=None, width=None, endianness=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=None, name=None)

Bases: AddressBlockType

This is a single contiguous block of memory inside a memory map.

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• range (Range | None)

• width (Width | None)

• endianness (EndianessType | None)

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• register (Iterable[Register])

• vendor_extensions (VendorExtensions | None)

• name (str | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Register name.

• dim – Dimensions a register array, the semantics for dim elements are the same as the C language standard for the layout of memory in multidimensional arrays.

• address_offset – Offset from baseAddress.

• size – Size in bits.

• volatile

• access

• dependency – Indicates that this register has a dependency on the setting of another register.

• reset – Register value at reset.

• field_value – Describes individual bit fields within the register.

• description – Register description

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• dim (Iterable[int])

• address_offset (str | None)

• size (Size | None)

• volatile (Volatile | None)

• access (Access | None)

• dependency (Iterable[Dependency])

• reset (Reset | None)

• field_value (Iterable[FieldType])

• description (str | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Dependency(register_ref=None, field_ref=None, value=None, mask=None)

Bases: object

Variables:

• register_ref – The name of the register that enables this register.

• field_ref – Name of the field within the register that enables this register.

• value – Value that the enabling field must be set to to enable this register.

• mask – Mask to be anded with the value of the enabling field or register before comparing to the dependency value.

Parameters:

• register_ref (str | None)

• field_ref (str | None)

• value (str | None)

• mask (str | None)

field_ref: str | None

mask: str | None

register_ref: str | None

value: str | None

class Reset(value=None, mask=None)

Bases: object

Variables:

• value – The value itself.

• mask – Mask to be anded with the value before comparing to the reset value.

Parameters:

• value (str | None)

• mask (str | None)

mask: str | None

value: str | None

class Size(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

address_offset: str | None

dependency: Iterable[Dependency]

description: str | None

dim: Iterable[int]

field_value: Iterable[FieldType]

name: str | None

parameter: Iterable[Parameter]

reset: Reset | None

size: Size | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

endianness: EndianessType | None

name: str | None

parameter: Iterable[NameValuePairType]

range: 'AddressBlockType.Range' | None

register: Iterable['AddressBlockType.Register']

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

width: 'AddressBlockType.Width' | None

org.accellera.spirit.v1_2.address_block_type module

class org.accellera.spirit.v1_2.address_block_type.AddressBlockType(base_address=None, bit_offset=None, range=None, width=None, endianness=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=None, name=None)

Bases: object

Variables:

• base_address

• bit_offset

• range – The address range of an address block. Expressed as the number of addressable units accessable to the block.

• width – Bit width of an address block.

• endianness

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• register

• vendor_extensions

• name

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• range (Range | None)

• width (Width | None)

• endianness (EndianessType | None)

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• register (Iterable[Register])

• vendor_extensions (VendorExtensions | None)

• name (str | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Register name.

• dim – Dimensions a register array, the semantics for dim elements are the same as the C language standard for the layout of memory in multidimensional arrays.

• address_offset – Offset from baseAddress.

• size – Size in bits.

• volatile

• access

• dependency – Indicates that this register has a dependency on the setting of another register.

• reset – Register value at reset.

• field_value – Describes individual bit fields within the register.

• description – Register description

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• dim (Iterable[int])

• address_offset (str | None)

• size (Size | None)

• volatile (Volatile | None)

• access (Access | None)

• dependency (Iterable[Dependency])

• reset (Reset | None)

• field_value (Iterable[FieldType])

• description (str | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Dependency(register_ref=None, field_ref=None, value=None, mask=None)

Bases: object

Variables:

• register_ref – The name of the register that enables this register.

• field_ref – Name of the field within the register that enables this register.

• value – Value that the enabling field must be set to to enable this register.

• mask – Mask to be anded with the value of the enabling field or register before comparing to the dependency value.

Parameters:

• register_ref (str | None)

• field_ref (str | None)

• value (str | None)

• mask (str | None)

field_ref: str | None

mask: str | None

register_ref: str | None

value: str | None

class Reset(value=None, mask=None)

Bases: object

Variables:

• value – The value itself.

• mask – Mask to be anded with the value before comparing to the reset value.

Parameters:

• value (str | None)

• mask (str | None)

mask: str | None

value: str | None

class Size(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

address_offset: str | None

dependency: Iterable[Dependency]

description: str | None

dim: Iterable[int]

field_value: Iterable[FieldType]

name: str | None

parameter: Iterable[Parameter]

reset: Reset | None

size: Size | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

endianness: EndianessType | None

name: str | None

parameter: Iterable[NameValuePairType]

range: Range | None

register: Iterable[Register]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

width: Width | None

org.accellera.spirit.v1_2.address_space_ref module

class org.accellera.spirit.v1_2.address_space_ref.AddressSpaceRef(address_space_ref=None)

Bases: AddrSpaceRefType

References the address space.

The name of the address space is kept in its addressSpaceRef attribute.

Parameters:

address_space_ref (str | None)

address_space_ref: str | None

org.accellera.spirit.v1_2.address_spaces module

class org.accellera.spirit.v1_2.address_spaces.AddressSpaces(address_space=<factory>)

Bases: object

If this component is a bus master, this lists all the address spaces defined by the component.

Variables:

address_space – This defines a logical space, referenced by a bus master.

Parameters:

address_space (Iterable[AddressSpace])

class AddressSpace(name=None, range=None, width=None, bits_in_lau=None, endianness=None, executable_image=<factory>, local_memory_map=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the address space. Unique within the model.

• range – The address range of an address block. Expressed as the number of addressable units accessable to the block.

• width – Bit width of an address block.

• bits_in_lau

• endianness

• executable_image

• local_memory_map – Provides the local memory map of an address space. Blocks in this memory map are accessable to master interfaces on this component that reference this address space. They are not accessable to any external master interface.

• parameter – Data specific to this address space.

• vendor_extensions

Parameters:

• name (str | None)

• range (Range | None)

• width (Width | None)

• bits_in_lau (BitsInLau | None)

• endianness (EndianessType | None)

• executable_image (Iterable[ExecutableImage])

• local_memory_map (LocalMemoryMapType | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

bits_in_lau: BitsInLau | None

endianness: EndianessType | None

executable_image: Iterable[ExecutableImage]

local_memory_map: LocalMemoryMapType | None

name: str | None

parameter: Iterable[NameValuePairType]

range: Range | None

vendor_extensions: VendorExtensions | None

width: Width | None

address_space: Iterable[AddressSpace]

org.accellera.spirit.v1_2.bank module

org.accellera.spirit.v1_2.bank_alignment_type module

class org.accellera.spirit.v1_2.bank_alignment_type.BankAlignmentType(*values)

Bases: Enum

‘serial’ or ‘parallel’ bank alignment.

PARALLEL = 'parallel'

SERIAL = 'serial'

org.accellera.spirit.v1_2.banked_bank_type module

class org.accellera.spirit.v1_2.banked_bank_type.BankedBankType(address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameter=<factory>, vendor_extensions=None, bank_alignment=None)

Bases: object

Banks nested inside a bank do not specify address.

Variables:

• address_block – An address block within the bank. No address information is supplied.

• bank – A nested bank of blocks within a bank. No address information is supplied.

• subspace_map

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• vendor_extensions

• bank_alignment

Parameters:

• address_block (Iterable[BankedBlockType])

• bank (Iterable[BankedBankType])

• subspace_map (Iterable[BankedSubspaceType])

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• bank_alignment (BankAlignmentType | None)

access: Access | None

address_block: Iterable[BankedBlockType]

bank: Iterable[BankedBankType]

bank_alignment: BankAlignmentType | None

parameter: Iterable[NameValuePairType]

subspace_map: Iterable[BankedSubspaceType]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

org.accellera.spirit.v1_2.banked_block_type module

class org.accellera.spirit.v1_2.banked_block_type.BankedBlockType(range=None, width=None, endianness=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=None, name=None)

Bases: object

Address blocks inside a bank do not specify address.

Variables:

• range – The address range of an address block. Expressed as the number of addressable units accessable to the block.

• width – Bit width of an address block.

• endianness

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• register

• vendor_extensions

• name

Parameters:

• range (Range | None)

• width (Width | None)

• endianness (EndianessType | None)

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• register (Iterable[Register])

• vendor_extensions (VendorExtensions | None)

• name (object | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Register name.

• dim – Dimensions a register array, the semantics for dim elements are the same as the C language standard for the layout of memory in multidimensional arrays.

• address_offset – Offset from baseAddress.

• size – Size in bits.

• volatile

• access

• dependency – Indicates that this register has a dependency on the setting of another register.

• reset – Register value at reset.

• field_value – Describes individual bit fields within the register.

• description – Register description

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• dim (Iterable[int])

• address_offset (str | None)

• size (Size | None)

• volatile (Volatile | None)

• access (Access | None)

• dependency (Iterable[Dependency])

• reset (Reset | None)

• field_value (Iterable[FieldType])

• description (str | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Dependency(register_ref=None, field_ref=None, value=None, mask=None)

Bases: object

Variables:

• register_ref – The name of the register that enables this register.

• field_ref – Name of the field within the register that enables this register.

• value – Value that the enabling field must be set to to enable this register.

• mask – Mask to be anded with the value of the enabling field or register before comparing to the dependency value.

Parameters:

• register_ref (str | None)

• field_ref (str | None)

• value (str | None)

• mask (str | None)

field_ref: str | None

mask: str | None

register_ref: str | None

value: str | None

class Reset(value=None, mask=None)

Bases: object

Variables:

• value – The value itself.

• mask – Mask to be anded with the value before comparing to the reset value.

Parameters:

• value (str | None)

• mask (str | None)

mask: str | None

value: str | None

class Size(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

address_offset: str | None

dependency: Iterable[Dependency]

description: str | None

dim: Iterable[int]

field_value: Iterable[FieldType]

name: str | None

parameter: Iterable[Parameter]

reset: Reset | None

size: Size | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

endianness: EndianessType | None

name: object | None

parameter: Iterable[NameValuePairType]

range: Range | None

register: Iterable[Register]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

width: Width | None

org.accellera.spirit.v1_2.banked_subspace_type module

class org.accellera.spirit.v1_2.banked_subspace_type.BankedSubspaceType(parameter=<factory>, vendor_extensions=None, master_ref=None)

Bases: object

Subspace references inside banks do not specify an address.

Variables:

• parameter – Any parameters that may apply to the subspace reference.

• vendor_extensions

• master_ref

Parameters:

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• master_ref (str | None)

master_ref: str | None

parameter: Iterable[NameValuePairType]

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.base_address module

class org.accellera.spirit.v1_2.base_address.BaseAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Base Address:')

Bases: object

Base of an address block.

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

value: str

org.accellera.spirit.v1_2.bit_offset module

class org.accellera.spirit.v1_2.bit_offset.BitOffset(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Base bit offset of an address block.

If not included, it is assumed to be 0.

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

org.accellera.spirit.v1_2.bit_steering_type module

class org.accellera.spirit.v1_2.bit_steering_type.BitSteeringType(*values)

Bases: Enum

OFF = 'off'

ON = 'on'

org.accellera.spirit.v1_2.bits_in_lau module

class org.accellera.spirit.v1_2.bits_in_lau.BitsInLau(value=None)

Bases: object

The number of bits in the least addressable unit.

The default is byte addressable (8 bits).

Parameters:

value (int | None)

value: int | None

org.accellera.spirit.v1_2.bus_def_signal_constraint_sets module

class org.accellera.spirit.v1_2.bus_def_signal_constraint_sets.BusDefSignalConstraintSets(bus_def_signal_constraints=<factory>)

Bases: object

List of busDefSignalConstraints elements for a bus definition signal.

Parameters:

bus_def_signal_constraints (Iterable[BusDefSignalConstraints])

bus_def_signal_constraints: Iterable[BusDefSignalConstraints]

org.accellera.spirit.v1_2.bus_def_signal_constraints module

class org.accellera.spirit.v1_2.bus_def_signal_constraints.BusDefSignalConstraints(timing_constraint=<factory>, design_rule_constraints=None, drive_constraint=None, load_constraint=None, constraint_set_id='default')

Bases: object

Defines constraints that apply to a signal in a bus definition.

If multiple busDefSignalConstraints are used, each must have a unique value of the constraintSet attribute. These constraints are carried over to the associated component signal as default values.

Parameters:

• timing_constraint (Iterable[TimingConstraint])

• design_rule_constraints (DesignRuleConstraints | None)

• drive_constraint (DriveConstraint | None)

• load_constraint (LoadConstraint | None)

• constraint_set_id (str)

constraint_set_id: str

design_rule_constraints: DesignRuleConstraints | None

drive_constraint: DriveConstraint | None

load_constraint: LoadConstraint | None

timing_constraint: Iterable[TimingConstraint]

org.accellera.spirit.v1_2.bus_definition module

class org.accellera.spirit.v1_2.bus_definition.BusDefinition(vendor=None, library=None, name=None, version=None, direct_connection=False, extends=None, max_masters=None, max_slaves=None, signals=None, choices=None, bus_def_parameters=None, vendor_extensions=None)

Bases: object

Defines the signals and high-level function of a bus.

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• direct_connection – This element indicates that a master interface may be directly connected to a slave interface (under certain conditions) for busses of this type.

• extends – Optional name of bus type that this bus definition is compatible with. This bus definition may change the definitions of signals in the existing bus definition and add new signals, the signals in the original bus are not deleted but may be marked illegal to disallow their use.

• max_masters – Indicates the maximum number of masters this bus supports. If this element is not present, the number of masters allowed is unbounded.

• max_slaves – Indicates the maximum number of slaves this bus supports. If the element is not present, the number of slaves allowed is unbounded.

• signals – This is a list of logical signals defined by the bus.

• choices

• bus_def_parameters – Container element for parameters defined for a bus definition.

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• direct_connection (bool)

• extends (LibraryRefType | None)

• max_masters (int | None)

• max_slaves (int | None)

• signals (Signals | None)

• choices (Choices | None)

• bus_def_parameters (BusDefParameters | None)

• vendor_extensions (VendorExtensions | None)

class BusDefParameters(bus_def_parameter=<factory>)

Bases: object

Variables:

bus_def_parameter – Defines a parameter which can be specified on a bus interface. The parameter is fully described on the bus definition and then instantiated on the bus interface. Setting ‘consistent’ to true implies that the parameter must have the same value on the corresponding bus interface parameters on both sides of connected interfaces.

Parameters:

bus_def_parameter (Iterable[BusDefParameter])

class BusDefParameter(value: str = '', consistent: bool = False, name: Optional[str] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_2.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_2.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_2.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_2.format_type.FormatType] = None, prompt: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>)

Bases: object

Parameters:

• value (str)

• consistent (bool)

• name (str | None)

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

consistent: bool

direction: DirectionValue | None

format: FormatType | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

value: str

bus_def_parameter: Iterable[BusDefParameter]

class Signals(signal: collections.abc.Iterable['BusDefinition.Signals.Signal'] = <factory>)

Bases: object

Parameters:

signal (Iterable[Signal])

class Signal(logical_name=None, is_address=None, is_data=None, is_clock=None, is_reset=None, requires_driver=None, on_system=<factory>, on_master=None, on_slave=None, default_value=None, bus_def_signal_constraint_sets=None, vendor_extensions=None)

Bases: object

Variables:

• logical_name – The assigned name of this signal in bus specifications.

• is_address – If this element is present, the signal contains address information.

• is_data – If this element is present, the signal contains data information.

• is_clock – If this element is present, the signal contains only clock information.

• is_reset – Is this element is present, the signal contains only reset information.

• requires_driver

• on_system – Defines constraints for this signal when present in a system bus interface with a matching group name.

• on_master – Defines constraints for this signal when present in a master bus interface.

• on_slave – Defines constraints for this signal when present in a slave bus interface.

• default_value – Default value for the signal when used as an input and it ends up being unconnected. Ignored for signals that require a singleShot or clock type driver. This value may be overridden by a defaultValue on a component pin.

• bus_def_signal_constraint_sets

• vendor_extensions

Parameters:

• logical_name (str | None)

• is_address (bool | None)

• is_data (bool | None)

• is_clock (bool | None)

• is_reset (bool | None)

• requires_driver (RequiresDriver | None)

• on_system (Iterable[OnSystem])

• on_master (OnMaster | None)

• on_slave (OnSlave | None)

• default_value (DefaultValue | None)

• bus_def_signal_constraint_sets (BusDefSignalConstraintSets | None)

• vendor_extensions (VendorExtensions | None)

class DefaultValue(value=None)

Bases: object

Variables:

value – The value of a signal. 1 or 0 for single bit signals, unsigned numeric otherwise.

Parameters:

value (str | None)

value: str | None

class OnMaster(bit_width=None, direction=None)

Bases: object

Variables:

• bit_width – Number of bits required to represent this signal. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this signal.

• direction – If this element is present, the direction of this signal is restricted to the specified value. The direction is relative to the non-mirrored interface. Use the value ‘illegal’ to indicate that this signal cannot appear in the interface.

Parameters:

• bit_width (int | None)

• direction (OnMasterValue | None)

bit_width: int | None

direction: OnMasterValue | None

class OnSlave(bit_width=None, direction=None)

Bases: object

Variables:

• bit_width – Number of bits required to represent this signal. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this signal.

• direction – If this element is present, the direction of this signal is restricted to the specified value. The direction is relative to the non-mirrored interface. Use the value ‘illegal’ to indicate that this signal cannot appear in the interface.

Parameters:

• bit_width (int | None)

• direction (OnSlaveValue | None)

bit_width: int | None

direction: OnSlaveValue | None

class OnSystem(group=None, bit_width=None, direction=None)

Bases: object

Variables:

• group – Used to group system signals into different groups within a common bus.

• bit_width – Number of bits required to represent this signal. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this signal.

• direction – If this element is present, the direction of this signal is restricted to the specified value. The direction is relative to the non-mirrored interface. Use the value ‘illegal’ to indicate that this signal cannot appear in the interface.

Parameters:

• group (str | None)

• bit_width (int | None)

• direction (OnSystemValue | None)

bit_width: int | None

direction: OnSystemValue | None

group: str | None

bus_def_signal_constraint_sets: BusDefSignalConstraintSets | None

default_value: DefaultValue | None

is_address: bool | None

is_clock: bool | None

is_data: bool | None

is_reset: bool | None

logical_name: str | None

on_master: OnMaster | None

on_slave: OnSlave | None

on_system: Iterable[OnSystem]

requires_driver: RequiresDriver | None

vendor_extensions: VendorExtensions | None

signal: Iterable[Signal]

bus_def_parameters: BusDefParameters | None

choices: Choices | None

direct_connection: bool

extends: LibraryRefType | None

library: str | None

max_masters: int | None

max_slaves: int | None

name: str | None

signals: Signals | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

org.accellera.spirit.v1_2.bus_interface module

class org.accellera.spirit.v1_2.bus_interface.BusInterface(name=None, bus_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection=None, signal_map=None, index=None, bit_steering=None, configurators=None, bus_interface_parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: BusInterfaceType

Describes one of the bus interfaces supported by this component.

Parameters:

• name (str | None)

• bus_type (LibraryRefType | None)

• master (Master | None)

• slave (Slave | None)

• system (System | None)

• mirrored_slave (MirroredSlave | None)

• mirrored_master (object | None)

• mirrored_system (MirroredSystem | None)

• monitor (Monitor | None)

• connection (BusInterfaceTypeConnection | None)

• signal_map (SignalMap | None)

• index (Index | None)

• bit_steering (BitSteering | None)

• configurators (Configurators | None)

• bus_interface_parameters (BusInterfaceParameters | None)

• vendor_extensions (VendorExtensions | None)

• any_attributes (Mapping[str, str])

class BitSteering(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (BitSteeringType | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: BitSteeringType | None

class BusInterfaceParameters(bus_interface_parameter=<factory>)

Bases: object

Variables:

bus_interface_parameter – Name/value pair defining a parameter on this bus interface. The name must match the name of a busDefParameter on the associated bus definition. Also, the interface type of this bus interface must be allowed as specified in the busDefParameter.

Parameters:

bus_interface_parameter (Iterable[BusInterfaceParameter])

class BusInterfaceParameter(value: str = '', name: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None)

Bases: object

Parameters:

• value (str)

• name (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

dependency: str | None

id: str | None

name: str | None

resolve: ResolveType

value: str

bus_interface_parameter: Iterable[BusInterfaceParameter]

class Index(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Connection Index:')

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Master(address_space_ref=None)

Bases: object

Variables:

address_space_ref – If this master connects to an addressable bus, this element references the address space it maps to. It has an addressSpaceRef attribute which is an addrSpaceID key ref.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref: str | None = None, base_address: org.accellera.spirit.v1_2.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_2.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:

• address_space_ref (str | None)

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

address_space_ref: str | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

address_space_ref: AddressSpaceRef | None

class MirroredSlave(base_addresses=None)

Bases: object

Variables:

base_addresses – Represents a set of remap base addresses.

Parameters:

base_addresses (BaseAddresses | None)

class BaseAddresses(remap_address=<factory>, range=None)

Bases: object

Variables:

• remap_address – Base of an address block. The state attribute indicates the name of the remap state for which this address is valid.

• range – The address range of mirrored slave.

Parameters:

• remap_address (Iterable[RemapAddress])

• range (Range | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Base Address:', state=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

• state – Name of the state in which this remapped address range is valid

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

• state (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

state: str | None

value: str

range: Range | None

remap_address: Iterable[RemapAddress]

base_addresses: BaseAddresses | None

class MirroredSystem(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

class Monitor(group: org.accellera.spirit.v1_2.group.Group | None = None, interface_type: org.accellera.spirit.v1_2.monitor_interface_type.MonitorInterfaceType | None = None)

Bases: object

Parameters:

• group (Group | None)

• interface_type (MonitorInterfaceType | None)

group: Group | None

interface_type: MonitorInterfaceType | None

class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(component_signal_name=None, bus_signal_name=None, left=None, right=None)

Bases: object

Variables:

• component_signal_name – Component signal name as specified inside the hardware model

• bus_signal_name – Bus signal name as specified inside the bus definition

• left – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

• right – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

• component_signal_name (str | None)

• bus_signal_name (str | None)

• left (Left | None)

• right (Right | None)

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

bus_signal_name: str | None

component_signal_name: str | None

left: Left | None

right: Right | None

signal_name: Iterable[SignalName]

class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

• memory_map_ref

• bridge – If this element is present, it indicates that the bus interface provides a bridge to another master bus interface on the same component. It has a masterRef attribute which contains the name of the other bus interface. It also has an opaque attribute to indicate that the bus bridge is opaque. Any slave interface can bridge to multiple master interfaces, and multiple slave interfaces can bridge to the same master interface.

• file_set_ref_group – This reference is used to point the filesets that are associated with this slave port. Depending on the slave port function, there may be completely different software drivers associated with the different ports.

Parameters:

• memory_map_ref (MemoryMapRef | None)

• bridge (Iterable[Bridge])

• file_set_ref_group (Iterable[FileSetRefGroup])

class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

• master_ref – The name of the master bus interface to which this interface bridges.

• opaque – If true (default) then this bridge is opaque; the whole of the address range is mappeed by the bridge and there are no gaps.

Parameters:

• master_ref (str | None)

• opaque (bool | None)

master_ref: str | None

opaque: bool | None

class FileSetRefGroup(group: Optional[str] = None, file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_2.file_set_ref.FileSetRef] = <factory>)

Bases: object

Parameters:

• group (str | None)

• file_set_ref (Iterable[FileSetRef])

file_set_ref: Iterable[FileSetRef]

group: str | None

bridge: Iterable[Bridge]

file_set_ref_group: Iterable[FileSetRefGroup]

memory_map_ref: MemoryMapRef | None

class System(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

any_attributes: Mapping[str, str]

bit_steering: 'BusInterfaceType.BitSteering' | None

bus_interface_parameters: 'BusInterfaceType.BusInterfaceParameters' | None

bus_type: LibraryRefType | None

configurators: Configurators | None

connection: BusInterfaceTypeConnection | None

index: 'BusInterfaceType.Index' | None

master: 'BusInterfaceType.Master' | None

mirrored_master: object | None

mirrored_slave: 'BusInterfaceType.MirroredSlave' | None

mirrored_system: 'BusInterfaceType.MirroredSystem' | None

monitor: 'BusInterfaceType.Monitor' | None

name: str | None

signal_map: 'BusInterfaceType.SignalMap' | None

slave: 'BusInterfaceType.Slave' | None

system: 'BusInterfaceType.System' | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.bus_interface_type module

class org.accellera.spirit.v1_2.bus_interface_type.BusInterfaceType(name=None, bus_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection=None, signal_map=None, index=None, bit_steering=None, configurators=None, bus_interface_parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Variables:

• name – Uniquely names this bus interface.

• bus_type – The bus type of this interface. Refers to a bus description using vendor, library and name attributes.

• master – If this element is present, the bus interface can serve as a master. This element encapsulates additional information related to its role as master.

• slave – If this element is present, the bus interface can serve as a slave.

• system – If this element is present, the bus interface is a system interface, neither master nor slave, with a specific function on the bus.

• mirrored_slave – If this element is present, the bus interface represents a mirrored slave interface. All directional constraints on signals are reversed relative to the specification in the bus definition.

• mirrored_master – If this element is present, the bus interface represents a mirrored master interface. All directional constraints on signals are reversed relative to the specification in the bus definition.

• mirrored_system – If this element is present, the bus interface represents a mirrored system interface. All directional constraints on signals are reversed relative to the specification in the bus definition.

• monitor – Indicates that this is a (passive) monitor interface. All of the signals in the interface must be inputs. The type of interface to be monitored is specified with the required interfaceType attribute. The spirit:group element must be specified if monitoring a system interface.

• connection – Directs how a bus interface is connected when the component is added to a design already containing a bus owner. Default behavior is “explicit”.

• signal_map – Listing of maps between component signals and bus signals.

• index – Master or slave index of this bus interface’s connection on a bus. Only used on indexed buses.

• bit_steering – Indicates whether bit steering should be used to map this interface onto a bus of different data width. Values are “on”, “off” (defaults to “off”).

• configurators – Configuration generators for bus interfaces.

• bus_interface_parameters – Container element for parameters associated with a bus interface.

• vendor_extensions

• any_attributes

Parameters:

• name (str | None)

• bus_type (LibraryRefType | None)

• master (Master | None)

• slave (Slave | None)

• system (System | None)

• mirrored_slave (MirroredSlave | None)

• mirrored_master (object | None)

• mirrored_system (MirroredSystem | None)

• monitor (Monitor | None)

• connection (BusInterfaceTypeConnection | None)

• signal_map (SignalMap | None)

• index (Index | None)

• bit_steering (BitSteering | None)

• configurators (Configurators | None)

• bus_interface_parameters (BusInterfaceParameters | None)

• vendor_extensions (VendorExtensions | None)

• any_attributes (Mapping[str, str])

class BitSteering(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (BitSteeringType | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: BitSteeringType | None

class BusInterfaceParameters(bus_interface_parameter=<factory>)

Bases: object

Variables:

bus_interface_parameter – Name/value pair defining a parameter on this bus interface. The name must match the name of a busDefParameter on the associated bus definition. Also, the interface type of this bus interface must be allowed as specified in the busDefParameter.

Parameters:

bus_interface_parameter (Iterable[BusInterfaceParameter])

class BusInterfaceParameter(value: str = '', name: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None)

Bases: object

Parameters:

• value (str)

• name (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

dependency: str | None

id: str | None

name: str | None

resolve: ResolveType

value: str

bus_interface_parameter: Iterable[BusInterfaceParameter]

class Index(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Connection Index:')

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Master(address_space_ref=None)

Bases: object

Variables:

address_space_ref – If this master connects to an addressable bus, this element references the address space it maps to. It has an addressSpaceRef attribute which is an addrSpaceID key ref.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref: str | None = None, base_address: org.accellera.spirit.v1_2.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_2.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:

• address_space_ref (str | None)

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

address_space_ref: str | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

address_space_ref: AddressSpaceRef | None

class MirroredSlave(base_addresses=None)

Bases: object

Variables:

base_addresses – Represents a set of remap base addresses.

Parameters:

base_addresses (BaseAddresses | None)

class BaseAddresses(remap_address=<factory>, range=None)

Bases: object

Variables:

• remap_address – Base of an address block. The state attribute indicates the name of the remap state for which this address is valid.

• range – The address range of mirrored slave.

Parameters:

• remap_address (Iterable[RemapAddress])

• range (Range | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Base Address:', state=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

• state – Name of the state in which this remapped address range is valid

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

• state (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

state: str | None

value: str

range: Range | None

remap_address: Iterable[RemapAddress]

base_addresses: BaseAddresses | None

class MirroredSystem(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

class Monitor(group: org.accellera.spirit.v1_2.group.Group | None = None, interface_type: org.accellera.spirit.v1_2.monitor_interface_type.MonitorInterfaceType | None = None)

Bases: object

Parameters:

• group (Group | None)

• interface_type (MonitorInterfaceType | None)

group: Group | None

interface_type: MonitorInterfaceType | None

class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(component_signal_name=None, bus_signal_name=None, left=None, right=None)

Bases: object

Variables:

• component_signal_name – Component signal name as specified inside the hardware model

• bus_signal_name – Bus signal name as specified inside the bus definition

• left – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

• right – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

• component_signal_name (str | None)

• bus_signal_name (str | None)

• left (Left | None)

• right (Right | None)

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

bus_signal_name: str | None

component_signal_name: str | None

left: Left | None

right: Right | None

signal_name: Iterable[SignalName]

class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

• memory_map_ref

• bridge – If this element is present, it indicates that the bus interface provides a bridge to another master bus interface on the same component. It has a masterRef attribute which contains the name of the other bus interface. It also has an opaque attribute to indicate that the bus bridge is opaque. Any slave interface can bridge to multiple master interfaces, and multiple slave interfaces can bridge to the same master interface.

• file_set_ref_group – This reference is used to point the filesets that are associated with this slave port. Depending on the slave port function, there may be completely different software drivers associated with the different ports.

Parameters:

• memory_map_ref (MemoryMapRef | None)

• bridge (Iterable[Bridge])

• file_set_ref_group (Iterable[FileSetRefGroup])

class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

• master_ref – The name of the master bus interface to which this interface bridges.

• opaque – If true (default) then this bridge is opaque; the whole of the address range is mappeed by the bridge and there are no gaps.

Parameters:

• master_ref (str | None)

• opaque (bool | None)

master_ref: str | None

opaque: bool | None

class FileSetRefGroup(group: Optional[str] = None, file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_2.file_set_ref.FileSetRef] = <factory>)

Bases: object

Parameters:

• group (str | None)

• file_set_ref (Iterable[FileSetRef])

file_set_ref: Iterable[FileSetRef]

group: str | None

bridge: Iterable[Bridge]

file_set_ref_group: Iterable[FileSetRefGroup]

memory_map_ref: MemoryMapRef | None

class System(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

any_attributes: Mapping[str, str]

bit_steering: BitSteering | None

bus_interface_parameters: BusInterfaceParameters | None

bus_type: LibraryRefType | None

configurators: Configurators | None

connection: BusInterfaceTypeConnection | None

index: Index | None

master: Master | None

mirrored_master: object | None

mirrored_slave: MirroredSlave | None

mirrored_system: MirroredSystem | None

monitor: Monitor | None

name: str | None

signal_map: SignalMap | None

slave: Slave | None

system: System | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.bus_interface_type_connection module

class org.accellera.spirit.v1_2.bus_interface_type_connection.BusInterfaceTypeConnection(*values)

Bases: Enum

Variables:

• REQUIRED – A bus instance is automatically chosen and the connection is made. Component addition fails if a suitable bus is not available.

• EXPLICIT – Connection of this bus interface is not made until the user explicitly requests connection.

EXPLICIT = 'explicit'

REQUIRED = 'required'

org.accellera.spirit.v1_2.bus_interfaces module

class org.accellera.spirit.v1_2.bus_interfaces.BusInterfaces(bus_interface=<factory>)

Bases: object

A list of bus interfaces supported by this component.

Parameters:

bus_interface (Iterable[BusInterface])

bus_interface: Iterable[BusInterface]

org.accellera.spirit.v1_2.capacitance module

class org.accellera.spirit.v1_2.capacitance.Capacitance(value=None, units=None)

Bases: object

Represents a simple capacitance value with optional units.

Parameters:

• value (float | None)

• units (CapacitanceValueUnitType | None)

units: CapacitanceValueUnitType | None

value: float | None

org.accellera.spirit.v1_2.capacitance_value_unit_type module

class org.accellera.spirit.v1_2.capacitance_value_unit_type.CapacitanceValueUnitType(*values)

Bases: Enum

Indicates legal units for capacitance values.

FF = 'ff'

PF = 'pf'

org.accellera.spirit.v1_2.cell_class_value_type module

class org.accellera.spirit.v1_2.cell_class_value_type.CellClassValueType(*values)

Bases: Enum

Indicates legal cell class values.

COMBINATIONAL = 'combinational'

SEQUENTIAL = 'sequential'

org.accellera.spirit.v1_2.cell_function_value_type module

class org.accellera.spirit.v1_2.cell_function_value_type.CellFunctionValueType(*values)

Bases: Enum

Indicates legal cell function values.

BUF = 'buf'

DFF = 'dff'

INV = 'inv'

LATCH = 'latch'

MUX21 = 'mux21'

NAND2 = 'nand2'

XOR2 = 'xor2'

org.accellera.spirit.v1_2.cell_specification module

class org.accellera.spirit.v1_2.cell_specification.CellSpecification(cell_function=None, cell_class=None, cell_name=None)

Bases: object

Used to indicate a particular technology library cell.

Use of cellName is discouraged since it is technology dependent.

Variables:

• cell_function – Defines a technology library cell in library independent fashion, based on specification of a cell function and strength.

• cell_class – Defines a technology library cell in library independent fashion, based on specification of a cell class and strength.

• cell_name – Defines a technology library cell by name. Use of this library dependent syntax is discouraged as it is not portable.

Parameters:

• cell_function (CellFunction | None)

• cell_class (CellClass | None)

• cell_name (CellName | None)

class CellClass(value: org.accellera.spirit.v1_2.cell_class_value_type.CellClassValueType | None = None, cell_strength: org.accellera.spirit.v1_2.cell_strength_value_type.CellStrengthValueType | None = None)

Bases: object

Parameters:

• value (CellClassValueType | None)

• cell_strength (CellStrengthValueType | None)

cell_strength: CellStrengthValueType | None

value: CellClassValueType | None

class CellFunction(value: org.accellera.spirit.v1_2.cell_function_value_type.CellFunctionValueType | None = None, cell_strength: org.accellera.spirit.v1_2.cell_strength_value_type.CellStrengthValueType | None = None)

Bases: object

Parameters:

• value (CellFunctionValueType | None)

• cell_strength (CellStrengthValueType | None)

cell_strength: CellStrengthValueType | None

value: CellFunctionValueType | None

class CellName(lib_cell_name: str | None = None, lib_pin_name: str | None = None)

Bases: object

Parameters:

• lib_cell_name (str | None)

• lib_pin_name (str | None)

lib_cell_name: str | None

lib_pin_name: str | None

cell_class: CellClass | None

cell_function: CellFunction | None

cell_name: CellName | None

org.accellera.spirit.v1_2.cell_strength_value_type module

class org.accellera.spirit.v1_2.cell_strength_value_type.CellStrengthValueType(*values)

Bases: Enum

Indicates legal cell strength values.

HIGH = 'high'

LOW = 'low'

MEDIAN = 'median'

org.accellera.spirit.v1_2.channels module

class org.accellera.spirit.v1_2.channels.Channels(channel=<factory>)

Bases: object

Lists all channel connections between mirror interfaces of this component.

Variables:

channel – Defines a set of mirrored interfaces of this component that are connected to one another.

Parameters:

channel (Iterable[Channel])

class Channel(name=None, max_masters=None, max_slaves=None, bus_interface_ref=<factory>)

Bases: object

Variables:

• name – Unique name for this channel.

• max_masters – Overrides the maxMasters value in the bus definition if this number is more restrictive.

• max_slaves – Overrides the maxSlaves value in the bus definition if this number is more restrictive.

• bus_interface_ref – Contains the name of one of the bus interfaces that is part of this channel. The ordering of the references may be important to the design environment.

Parameters:

• name (object | None)

• max_masters (int | None)

• max_slaves (int | None)

• bus_interface_ref (Iterable[str])

bus_interface_ref: Iterable[str]

max_masters: int | None

max_slaves: int | None

name: object | None

channel: Iterable[Channel]

org.accellera.spirit.v1_2.check_value_type module

class org.accellera.spirit.v1_2.check_value_type.CheckValueType(*values)

Bases: Enum

Indicates legal values for type of checking the paths apply to: setup or hold.

HOLD = 'hold'

SETUP = 'setup'

org.accellera.spirit.v1_2.choice_style_value module

class org.accellera.spirit.v1_2.choice_style_value.ChoiceStyleValue(*values)

Bases: Enum

Variables:

• RADIO – Display choice as radio buttons (default).

• COMBO – Display choice as combo box.

COMBO = 'combo'

RADIO = 'radio'

org.accellera.spirit.v1_2.choices module

class org.accellera.spirit.v1_2.choices.Choices(choice=<factory>)

Bases: object

Choices used by user defined properties of spirit:formatType =”choice”.

Variables:

choice – Non-empty set of legal values for a user defined property of type spirit:formatType=”choice” .

Parameters:

choice (Iterable[Choice])

class Choice(name=None, enumeration=<factory>)

Bases: object

Variables:

• name – Choice key, available for reference by the spirit:choiceRef attribute of user defined properties of type spirit:formatType=”choice”.

• enumeration – A possible value of spirit:choice

Parameters:

• name (str | None)

• enumeration (Iterable[Enumeration])

class Enumeration(value='', text=None, help=None)

Bases: object

Variables:

• value

• text – When specified, displayed in place of the spirit:enumeration value

• help – Text that may be displayed if the user requests help about the meaning of an element

Parameters:

• value (str)

• text (str | None)

• help (str | None)

help: str | None

text: str | None

value: str

enumeration: Iterable[Enumeration]

name: str | None

choice: Iterable[Choice]

org.accellera.spirit.v1_2.clock_driver module

class org.accellera.spirit.v1_2.clock_driver.ClockDriver(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None, clock_name=None, clock_source=None)

Bases: object

Describes a driven clock signal.

For clock drivers that are not directly associated with a signal, the clockName attribute can be used to associate a name with the clock. The clockSource attribute can be used on these clocks to indicate the actual clock source (e.g. an output pin of a clock generator cell).

Variables:

• clock_period – Clock period in units defined by the units attribute. Default is nanoseconds.

• clock_pulse_offset – Time until first pulse. Units are defined by the units attribute. Default is nanoseconds.

• clock_pulse_value – Value of signal after first clock edge.

• clock_pulse_duration – Duration of first state in cycle. Units are defined by the units attribute. Default is nanoseconds.

• clock_name

• clock_source

Parameters:

• clock_period (ClockPeriod | None)

• clock_pulse_offset (ClockPulseOffset | None)

• clock_pulse_value (ClockPulseValue | None)

• clock_pulse_duration (ClockPulseDuration | None)

• clock_name (str | None)

• clock_source (str | None)

class ClockPeriod(value=<factory>, units=DelayValueUnitType.NS, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• units

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• units (DelayValueUnitType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

units: DelayValueUnitType

value: Iterable[float]

class ClockPulseDuration(value=<factory>, units=DelayValueUnitType.NS, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• units

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• units (DelayValueUnitType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

units: DelayValueUnitType

value: Iterable[float]

class ClockPulseOffset(value=<factory>, units=DelayValueUnitType.NS, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• units

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• units (DelayValueUnitType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

units: DelayValueUnitType

value: Iterable[float]

class ClockPulseValue(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

clock_name: str | None

clock_period: ClockPeriod | None

clock_pulse_duration: ClockPulseDuration | None

clock_pulse_offset: ClockPulseOffset | None

clock_pulse_value: ClockPulseValue | None

clock_source: str | None

org.accellera.spirit.v1_2.component module

class org.accellera.spirit.v1_2.component.Component(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, configurators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, component_constraint_sets=None, other_clock_drivers=None, parameter=<factory>, vendor_extensions=None)

Bases: ComponentType

This is the root element for all non platform-core components.

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• bus_interfaces (BusInterfaces | None)

• channels (Channels | None)

• remap_states (RemapStates | None)

• address_spaces (AddressSpaces | None)

• memory_maps (MemoryMaps | None)

• model (Model | None)

• component_generators (ComponentGenerators | None)

• configurators (Configurators | None)

• choices (Choices | None)

• file_sets (FileSets | None)

• whitebox_elements (WhiteboxElements | None)

• cpus (Cpus | None)

• component_constraint_sets (ComponentConstraintSets | None)

• other_clock_drivers (OtherClocks | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Cpus(cpu=<factory>)

Bases: object

Variables:

cpu – Describes a processor in this component.

Parameters:

cpu (Iterable[Cpu])

class Cpu(name=None, address_space_ref=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the cpu instance relative to the platform core.

• address_space_ref – Indicates which address space maps into this cpu.

• parameter – Data specific to the cpu.

• vendor_extensions

Parameters:

• name (str | None)

• address_space_ref (Iterable[AddressSpaceRef])

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

address_space_ref: Iterable[AddressSpaceRef]

name: str | None

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

cpu: Iterable[Cpu]

class WhiteboxElements(whitebox_element: collections.abc.Iterable[org.accellera.spirit.v1_2.whitebox_element_type.WhiteboxElementType] = <factory>)

Bases: object

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]

address_spaces: AddressSpaces | None

bus_interfaces: BusInterfaces | None

channels: Channels | None

choices: Choices | None

component_constraint_sets: ComponentConstraintSets | None

component_generators: ComponentGenerators | None

configurators: Configurators | None

cpus: 'ComponentType.Cpus' | None

file_sets: FileSets | None

library: str | None

memory_maps: MemoryMaps | None

model: Model | None

name: str | None

other_clock_drivers: OtherClocks | None

parameter: Iterable[Parameter]

remap_states: RemapStates | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

whitebox_elements: 'ComponentType.WhiteboxElements' | None

org.accellera.spirit.v1_2.component_constraint_sets module

class org.accellera.spirit.v1_2.component_constraint_sets.ComponentConstraintSets(component_constraints=<factory>)

Bases: object

List of componentConstraints elements for this component.

Parameters:

component_constraints (Iterable[ComponentConstraints])

component_constraints: Iterable[ComponentConstraints]

org.accellera.spirit.v1_2.component_constraints module

class org.accellera.spirit.v1_2.component_constraints.ComponentConstraints(design_rule_constraints=None, false_path=<factory>, multi_cycle_path=<factory>, timed_path=<factory>, constraint_set_id='default')

Bases: object

Defines the set of implementation constraints associated with a component.

If multiple componentConstraints elements are used, each must have a unique value for the constraintSet attribute.

Parameters:

• design_rule_constraints (DesignRuleConstraints | None)

• false_path (Iterable[FalsePath])

• multi_cycle_path (Iterable[MultiCyclePath])

• timed_path (Iterable[TimedPath])

• constraint_set_id (str)

constraint_set_id: str

design_rule_constraints: DesignRuleConstraints | None

false_path: Iterable[FalsePath]

multi_cycle_path: Iterable[MultiCyclePath]

timed_path: Iterable[TimedPath]

org.accellera.spirit.v1_2.component_generator module

class org.accellera.spirit.v1_2.component_generator.ComponentGenerator(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE, hidden=False)

Bases: InstanceGeneratorType

Specifies a set of component generators.

The scope attribute applies to component generators and specifies whether the generator should be run for each instance of the entity (or module) or just once for all instances of the entity.

Variables:

hidden – If this attribute is true then the generator should not be presented to the user, it may be part of a chain and has no useful meaning when invoked standalone.

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (TransportMethods | None)

• lgi_access_type (LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

• group (Iterable[str])

• scope (InstanceGeneratorTypeScope)

• hidden (bool)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

group: Iterable[str]

hidden: bool

lgi_access_type: 'GeneratorType.LgiAccessType' | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

scope: InstanceGeneratorTypeScope

transport_methods: 'GeneratorType.TransportMethods' | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.component_generators module

class org.accellera.spirit.v1_2.component_generators.ComponentGenerators(component_generator=<factory>)

Bases: object

List of component generators.

Parameters:

component_generator (Iterable[ComponentGenerator])

component_generator: Iterable[ComponentGenerator]

org.accellera.spirit.v1_2.component_instance module

class org.accellera.spirit.v1_2.component_instance.ComponentInstance(instance_name=None, component_ref=None, configuration=None, vendor_extensions=None)

Bases: object

Component instance element.

The instance name is contained in the unique-value instanceName attribute.

Variables:

• instance_name

• component_ref – References a component to be found in an external library. The name attribute gives the name of the component and the version attribute speicifies which version of the component to use.

• configuration

• vendor_extensions

Parameters:

• instance_name (InstanceName | None)

• component_ref (LibraryRefType | None)

• configuration (Configuration | None)

• vendor_extensions (VendorExtensions | None)

component_ref: LibraryRefType | None

configuration: Configuration | None

instance_name: InstanceName | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.component_instances module

class org.accellera.spirit.v1_2.component_instances.ComponentInstances(component_instance=<factory>)

Bases: object

Sub instances of internal components.

Parameters:

component_instance (Iterable[ComponentInstance])

component_instance: Iterable[ComponentInstance]

org.accellera.spirit.v1_2.component_signal_direction_type module

class org.accellera.spirit.v1_2.component_signal_direction_type.ComponentSignalDirectionType(*values)

Bases: Enum

The direction of a component signal.

IN = 'in'

INOUT = 'inout'

OUT = 'out'

org.accellera.spirit.v1_2.component_type module

class org.accellera.spirit.v1_2.component_type.ComponentType(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, configurators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, component_constraint_sets=None, other_clock_drivers=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Component-specific extension to componentType.

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• bus_interfaces

• channels

• remap_states

• address_spaces

• memory_maps

• model

• component_generators – Generator list is tools-specific.

• configurators

• choices

• file_sets

• whitebox_elements

• cpus – cpu’s in the component

• component_constraint_sets

• other_clock_drivers – Defines a set of clock drivers that are not directly associated with an input signal of the component.

• parameter

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• bus_interfaces (BusInterfaces | None)

• channels (Channels | None)

• remap_states (RemapStates | None)

• address_spaces (AddressSpaces | None)

• memory_maps (MemoryMaps | None)

• model (Model | None)

• component_generators (ComponentGenerators | None)

• configurators (Configurators | None)

• choices (Choices | None)

• file_sets (FileSets | None)

• whitebox_elements (WhiteboxElements | None)

• cpus (Cpus | None)

• component_constraint_sets (ComponentConstraintSets | None)

• other_clock_drivers (OtherClocks | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Cpus(cpu=<factory>)

Bases: object

Variables:

cpu – Describes a processor in this component.

Parameters:

cpu (Iterable[Cpu])

class Cpu(name=None, address_space_ref=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the cpu instance relative to the platform core.

• address_space_ref – Indicates which address space maps into this cpu.

• parameter – Data specific to the cpu.

• vendor_extensions

Parameters:

• name (str | None)

• address_space_ref (Iterable[AddressSpaceRef])

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

address_space_ref: Iterable[AddressSpaceRef]

name: str | None

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

cpu: Iterable[Cpu]

class WhiteboxElements(whitebox_element: collections.abc.Iterable[org.accellera.spirit.v1_2.whitebox_element_type.WhiteboxElementType] = <factory>)

Bases: object

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]

address_spaces: AddressSpaces | None

bus_interfaces: BusInterfaces | None

channels: Channels | None

choices: Choices | None

component_constraint_sets: ComponentConstraintSets | None

component_generators: ComponentGenerators | None

configurators: Configurators | None

cpus: Cpus | None

file_sets: FileSets | None

library: str | None

memory_maps: MemoryMaps | None

model: Model | None

name: str | None

other_clock_drivers: OtherClocks | None

parameter: Iterable[Parameter]

remap_states: RemapStates | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

whitebox_elements: WhiteboxElements | None

org.accellera.spirit.v1_2.configurable_element module

class org.accellera.spirit.v1_2.configurable_element.ConfigurableElement(reference_id=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None, content=<factory>)

Bases: object

Describes the content of a configurable element.

The required referenceId attribute refers to the ID attribute of the configurable element.

Variables:

• reference_id

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

• content

Parameters:

• reference_id (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• content (Iterable[object])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

content: Iterable[object]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

reference_id: str | None

resolve: ResolveType

org.accellera.spirit.v1_2.configuration module

class org.accellera.spirit.v1_2.configuration.Configuration(configurable_element=<factory>)

Bases: object

All configuration information for a contained component or channel instance.

Parameters:

configurable_element (Iterable[ConfigurableElement])

configurable_element: Iterable[ConfigurableElement]

org.accellera.spirit.v1_2.configurator_ref module

class org.accellera.spirit.v1_2.configurator_ref.ConfiguratorRef(value='')

Bases: object

A reference to a configurator element.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_2.configurators module

class org.accellera.spirit.v1_2.configurators.Configurators(any_element=<factory>, any_attributes=<factory>)

Bases: object

Set of configurators on a configurable object.

The contents of this container element are undefined for version 1.0 of the SPIRIT schema. It is expected that the contents will be defined when the tight generator interface is available. In this release only ‘default’ configurators are supported.

Variables:

• any_element – Accepts any element(s) the content provider wants to put here, including elements from the SPIRIT namespace.

• any_attributes

Parameters:

• any_element (Iterable[object])

• any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]

any_element: Iterable[object]

org.accellera.spirit.v1_2.constraint_set_ref module

class org.accellera.spirit.v1_2.constraint_set_ref.ConstraintSetRef(value='')

Bases: object

A reference to a set of constraints (signalConstraints, componentConstraints, or busDefConstraints).

Parameters:

value (str)

value: str

org.accellera.spirit.v1_2.data_type_type module

class org.accellera.spirit.v1_2.data_type_type.DataTypeType(*values)

Bases: Enum

Enumerates C argument data types.

CHAR = 'char *'

DOUBLE = 'double'

FLOAT = 'float'

INT = 'int'

LONG = 'long'

UNSIGNED_INT = 'unsigned int'

UNSIGNED_LONG = 'unsigned long'

VOID = 'void *'

org.accellera.spirit.v1_2.delay module

class org.accellera.spirit.v1_2.delay.Delay(value=None, units=None)

Bases: object

Represents a simple delay value with optional units.

Parameters:

• value (float | None)

• units (DelayValueUnitType | None)

units: DelayValueUnitType | None

value: float | None

org.accellera.spirit.v1_2.delay_value_type module

class org.accellera.spirit.v1_2.delay_value_type.DelayValueType(*values)

Bases: Enum

Indicates the type of delay value - minimum or maximum delay.

MAX = 'max'

MIN = 'min'

org.accellera.spirit.v1_2.delay_value_unit_type module

class org.accellera.spirit.v1_2.delay_value_unit_type.DelayValueUnitType(*values)

Bases: Enum

Indicates legal units for delay values.

NS = 'ns'

PS = 'ps'

org.accellera.spirit.v1_2.dependency module

class org.accellera.spirit.v1_2.dependency.Dependency(value='')

Bases: object

Specifies a location on which files or fileSets may be dependent.

Typically, this would be a directory that would contain included files.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_2.design module

class org.accellera.spirit.v1_2.design.Design(vendor=None, library=None, name=None, version=None, component_instances=None, interconnections=None, ad_hoc_connections=None, hier_connections=None, vendor_extensions=None)

Bases: object

Root element for a platform design.

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• component_instances

• interconnections

• ad_hoc_connections

• hier_connections – A list of hierarchy connections between bus interfaces on component instances and the bus interfaces on the encompassing component.

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• component_instances (ComponentInstances | None)

• interconnections (Interconnections | None)

• ad_hoc_connections (AdHocConnections | None)

• hier_connections (HierConnections | None)

• vendor_extensions (VendorExtensions | None)

class HierConnections(hier_connection=<factory>)

Bases: object

Variables:

hier_connection – Represents a hierarchy connection

Parameters:

hier_connection (Iterable[HierConnection])

class HierConnection(component_ref=None, interface_ref=None, vendor_extensions=None, interface_name=None)

Bases: object

Variables:

• component_ref – This is the instance name of the component which owns the busInterface that is to be exported

• interface_ref – This is the name of the bus interface on the instance

• vendor_extensions

• interface_name – This is the name of the bus interface on the upper level component.

Parameters:

• component_ref (str | None)

• interface_ref (str | None)

• vendor_extensions (VendorExtensions | None)

• interface_name (str | None)

component_ref: str | None

interface_name: str | None

interface_ref: str | None

vendor_extensions: VendorExtensions | None

hier_connection: Iterable[HierConnection]

ad_hoc_connections: AdHocConnections | None

component_instances: ComponentInstances | None

hier_connections: HierConnections | None

interconnections: Interconnections | None

library: str | None

name: str | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

org.accellera.spirit.v1_2.design_configuration module

class org.accellera.spirit.v1_2.design_configuration.DesignConfiguration(vendor=None, library=None, name=None, version=None, design_ref=None, pmd_configuration=<factory>, generator_chain_configuration=<factory>, view_configuration=<factory>, vendor_extensions=None)

Bases: object

Top level element for describing the current configuration of a design.

Does not describe instance parameterization

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• design_ref – The design to which this configuration applies

• pmd_configuration – Contains the configurable information associated with a particular PMD

• generator_chain_configuration – Contains the configurable information associated with a generatorChain and its generators. Note that configurable information for generators associated with components is stored in the design file.

• view_configuration – Contains the active view for each instance in the design

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• design_ref (LibraryRefType | None)

• pmd_configuration (Iterable[PmdConfiguration])

• generator_chain_configuration (Iterable[GeneratorChainConfiguration])

• view_configuration (Iterable[ViewConfiguration])

• vendor_extensions (VendorExtensions | None)

class GeneratorChainConfiguration(generator_chain_ref=None, configurable_element=<factory>, generators=<factory>)

Bases: object

Variables:

• generator_chain_ref – References a generatorChain.

• configurable_element

• generators – Stores configurable information for generators referenced in the chain

Parameters:

• generator_chain_ref (LibraryRefType | None)

• configurable_element (Iterable[ConfigurableElement])

• generators (Iterable[Generators])

class Generators(generator_name=None, configurable_element=<factory>)

Bases: object

Variables:

• generator_name – This identifies the generator in the chain.

• configurable_element

Parameters:

• generator_name (str | None)

• configurable_element (Iterable[ConfigurableElement])

configurable_element: Iterable[ConfigurableElement]

generator_name: str | None

configurable_element: Iterable[ConfigurableElement]

generator_chain_ref: LibraryRefType | None

generators: Iterable[Generators]

class PmdConfiguration(pmd_ref=None, configurable_element=<factory>)

Bases: object

Variables:

• pmd_ref – References a PMD.

• configurable_element

Parameters:

• pmd_ref (LibraryRefType | None)

• configurable_element (Iterable[ConfigurableElement])

configurable_element: Iterable[ConfigurableElement]

pmd_ref: LibraryRefType | None

class ViewConfiguration(instance_name=None, view_name=None)

Bases: object

Variables:

• instance_name

• view_name – The name of the active view for this instance

Parameters:

• instance_name (InstanceName | None)

• view_name (str | None)

instance_name: InstanceName | None

view_name: str | None

design_ref: LibraryRefType | None

generator_chain_configuration: Iterable[GeneratorChainConfiguration]

library: str | None

name: str | None

pmd_configuration: Iterable[PmdConfiguration]

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

view_configuration: Iterable[ViewConfiguration]

org.accellera.spirit.v1_2.design_rule_constraints module

class org.accellera.spirit.v1_2.design_rule_constraints.DesignRuleConstraints(min_cap=None, max_cap=None, min_transition=None, max_transition=None, max_fanout=None)

Bases: object

Defines signal and/or component constraints associated with circuit design rules.

Variables:

• min_cap – Minimum capacitance value for this component or signal. The units attribute can be used to indicate the units associated with the capacitance value. Default unit value is ‘pf’.

• max_cap – Maximum capacitance value for this component or signal.

• min_transition – Minimum transition delay for this component or signal.

• max_transition – Maximum transition delay for this component or signal.

• max_fanout – Maximum fanout value for this component or signal.

Parameters:

• min_cap (Capacitance | None)

• max_cap (Capacitance | None)

• min_transition (MinTransition | None)

• max_transition (MaxTransition | None)

• max_fanout (int | None)

class MaxTransition(rise_delay=None, fall_delay=None)

Bases: object

Variables:

• rise_delay – Maximum transition delay for a rising edge transition for this component or signal.

• fall_delay – Maximum transition delay for a falling edge transition for this component or signal.

Parameters:

• rise_delay (Delay | None)

• fall_delay (Delay | None)

fall_delay: Delay | None

rise_delay: Delay | None

class MinTransition(rise_delay=None, fall_delay=None)

Bases: object

Variables:

• rise_delay – Minimum transition delay for a rising edge transition for this component or signal.

• fall_delay – Minimum transition delay for a falling edge transition for this component or signal.

Parameters:

• rise_delay (Delay | None)

• fall_delay (Delay | None)

fall_delay: Delay | None

rise_delay: Delay | None

max_cap: Capacitance | None

max_fanout: int | None

max_transition: MaxTransition | None

min_cap: Capacitance | None

min_transition: MinTransition | None

org.accellera.spirit.v1_2.direction_value module

class org.accellera.spirit.v1_2.direction_value.DirectionValue(*values)

Bases: Enum

Variables:

• VERTICAL – Display radio buttons vertically

• HORIZONTAL – Display radio buttons horizontally (default)

HORIZONTAL = 'horizontal'

VERTICAL = 'vertical'

org.accellera.spirit.v1_2.drive_constraint module

class org.accellera.spirit.v1_2.drive_constraint.DriveConstraint(cell_specification=None, resistance=None)

Bases: object

Defines a constraint indicating how an input is to be driven.

The preferred methodology is to specify a library cell in technology independent fashion. The implemention tool should assume that the associated signal is driven by the specified cell, or that the drive strength of the input signal is indicated by the specified resistance value.

Variables:

• cell_specification

• resistance – Specifes a drive resistance for the input signal.

Parameters:

• cell_specification (CellSpecification | None)

• resistance (Resistance | None)

cell_specification: CellSpecification | None

resistance: Resistance | None

org.accellera.spirit.v1_2.edge_value_type module

class org.accellera.spirit.v1_2.edge_value_type.EdgeValueType(*values)

Bases: Enum

Indicates legal values for edge specification attributes.

FALL = 'fall'

RISE = 'rise'

org.accellera.spirit.v1_2.endianess_type module

class org.accellera.spirit.v1_2.endianess_type.EndianessType(*values)

Bases: Enum

Specifies the data storage as “big” or “little” endian.

BIG = 'big'

LITTLE = 'little'

org.accellera.spirit.v1_2.executable_image module

class org.accellera.spirit.v1_2.executable_image.ExecutableImage(name=None, parameter=<factory>, language_tools=None, file_set_ref_group=None, vendor_extensions=None, id=None, image_type=None)

Bases: object

Specifies an executable software image to be loaded into a processors address space.

The format of the image is not specified. It could, for example, be an ELF loadfile, or it could be raw binary or ascii hex data for loading directly into a memory model instance.

Variables:

• name – Name of the executable image file.

• parameter – Additional information about the load module, e.g. stack base addresses, table addresses, etc.

• language_tools – Default commands and flags for software language tools needed to build the executable image.

• file_set_ref_group – Contains a group of file set references that indicates the set of file sets complying with the tool set of the current executable image.

• vendor_extensions

• id

• image_type

Parameters:

• name (Name | None)

• parameter (Iterable[Parameter])

• language_tools (LanguageTools | None)

• file_set_ref_group (FileSetRefGroup | None)

• vendor_extensions (VendorExtensions | None)

• id (str | None)

• image_type (str | None)

class FileSetRefGroup(file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_2.file_set_ref.FileSetRef] = <factory>)

Bases: object

Parameters:

file_set_ref (Iterable[FileSetRef])

file_set_ref: Iterable[FileSetRef]

class LanguageTools(file_builder=<factory>, linker=None, linker_flags=None, linker_command_file=None)

Bases: object

Variables:

• file_builder – A generic placeholder for any file builder like compilers and assemblers. It contains the file types to which the command should be applied, and the flags to be used with that command.

• linker

• linker_flags

• linker_command_file – Specifies a linker command file.

Parameters:

• file_builder (Iterable[FileBuilder])

• linker (Linker | None)

• linker_flags (LinkerFlags | None)

• linker_command_file (LinkerCommandFile | None)

class FileBuilder(file_type=None, user_file_type=None, command=None, flags=None, replace_default_flags=None, vendor_extensions=None)

Bases: object

Variables:

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

• command – Default command used to build files of the specified fileType.

• flags – Flags given to the build command when building files of this type.

• replace_default_flags – If true, replace any default flags value with the value in the sibling flags element. Otherwise, append the contents of the sibling flags element to any default flags value. If the value is true and the “flags” element is empty or missing, this will have the result of clearing any default flags value.

• vendor_extensions

Parameters:

• file_type (FileBuilderFileType | None)

• user_file_type (str | None)

• command (Command | None)

• flags (Flags | None)

• replace_default_flags (ReplaceDefaultFlags | None)

• vendor_extensions (VendorExtensions | None)

class Command(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Flags(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class ReplaceDefaultFlags(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

command: Command | None

file_type: FileBuilderFileType | None

flags: Flags | None

replace_default_flags: ReplaceDefaultFlags | None

user_file_type: str | None

vendor_extensions: VendorExtensions | None

class Linker(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class LinkerCommandFile(name=None, command_line_switch=None, enable=None, configurator_ref=None, generator_ref=<factory>)

Bases: object

Variables:

• name – Linker command file name.

• command_line_switch – The command line switch to specify the linker command file.

• enable – Specifies whether to generate and enable the linker command file.

• configurator_ref

• generator_ref

Parameters:

• name (Name | None)

• command_line_switch (CommandLineSwitch | None)

• enable (Enable | None)

• configurator_ref (ConfiguratorRef | None)

• generator_ref (Iterable[GeneratorRef])

class CommandLineSwitch(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Enable(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class Name(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

command_line_switch: CommandLineSwitch | None

configurator_ref: ConfiguratorRef | None

enable: Enable | None

generator_ref: Iterable[GeneratorRef]

name: Name | None

class LinkerFlags(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_builder: Iterable[FileBuilder]

linker: Linker | None

linker_command_file: LinkerCommandFile | None

linker_flags: LinkerFlags | None

class Name(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_set_ref_group: FileSetRefGroup | None

id: str | None

image_type: str | None

language_tools: LanguageTools | None

name: Name | None

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.false_path module

class org.accellera.spirit.v1_2.false_path.FalsePath(path_specifier=None, path_edge=None, path_type=None)

Bases: object

Defines a false path timing exception.

Parameters:

• path_specifier (PathSpecifier | None)

• path_edge (EdgeValueType | None)

• path_type (CheckValueType | None)

path_edge: EdgeValueType | None

path_specifier: PathSpecifier | None

path_type: CheckValueType | None

org.accellera.spirit.v1_2.field_type module

class org.accellera.spirit.v1_2.field_type.FieldType(name=None, bit_offset=None, bit_width=None, access=None, description=None, values=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Field name.

• bit_offset – Offset of this field’s lsb from bit 0 of the register.

• bit_width – Width of the field in bits.

• access

• description – Bit field description.

• values – Enumerates specific values that can be assigned to the bit field.

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• bit_offset (int | None)

• bit_width (BitWidth | None)

• access (Access | None)

• description (str | None)

• values (Iterable[Values])

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class BitWidth(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Values(value=None, description=None, name=None)

Bases: object

Variables:

• value – Enumerated bit field value.

• description – Description of a bit field value.

• name – The name of this enumerated value. This may be used as a token in generating code.

Parameters:

• value (str | None)

• description (str | None)

• name (str | None)

description: str | None

name: str | None

value: str | None

access: Access | None

bit_offset: int | None

bit_width: BitWidth | None

description: str | None

name: str | None

parameter: Iterable[Parameter]

values: Iterable[Values]

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.file module

class org.accellera.spirit.v1_2.file.File(name=None, file_type=<factory>, user_file_type=<factory>, logical_name=None, exported_name=<factory>, build_command=None, dependency=<factory>, define=<factory>, image_type=<factory>, vendor_extensions=None, file_id=None, any_attributes=<factory>)

Bases: object

SPIRIT reference to a file or directory.

Variables:

• name – Path to the file or directory.

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

• logical_name – Logical name for this file or directory e.g. VHDL library name.

• exported_name – Defines exported names that can be accessed externally, e.g. exported function names from a C source file.

• build_command – Command and flags used to build derived files from the sourceName files. If this element is present, the command and/or flags used to to build the file will override or augment any default builders at a higher level.

• dependency

• define – Specifies define symbols that are used in the source file. The spirit:name attribute gives the name to be defined and the text content of the element holds the value. This element supports full configurability.

• image_type – Relates the current file to a certain executable image type in the design.

• vendor_extensions

• file_id

• any_attributes

Parameters:

• name (Name | None)

• file_type (Iterable[FileFileType])

• user_file_type (Iterable[str])

• logical_name (LogicalName | None)

• exported_name (Iterable[str])

• build_command (BuildCommand | None)

• dependency (Iterable[Dependency])

• define (Iterable[NameValuePairType])

• image_type (Iterable[str])

• vendor_extensions (VendorExtensions | None)

• file_id (str | None)

• any_attributes (Mapping[str, str])

class BuildCommand(command=None, flags=None, replace_default_flags=None, target_name=None)

Bases: object

Variables:

• command – Command used to build this file.

• flags – Flags given to the build command when building this file. If the optional attribute “append” is “true”, this string will be appended to any existing flags, otherwise these flags will replace any existing default flags.

• replace_default_flags – If true, the value of the sibling element “flags” should replace any default flags specified at a more global level. If this is true and the sibling element “flags” is empty or missing, this has the effect of clearing any default flags.

• target_name – Pathname to the file that is derived (built) from the source file.

Parameters:

• command (Command | None)

• flags (Flags | None)

• replace_default_flags (ReplaceDefaultFlags | None)

• target_name (TargetName | None)

class Command(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Flags(value='', append=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• append

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• append (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

append: bool | None

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class ReplaceDefaultFlags(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class TargetName(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

command: Command | None

flags: Flags | None

replace_default_flags: ReplaceDefaultFlags | None

target_name: TargetName | None

class LogicalName(value: str = '', default: str | None = None)

Bases: object

Parameters:

• value (str)

• default (str | None)

default: str | None

value: str

class Name(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

any_attributes: Mapping[str, str]

build_command: BuildCommand | None

define: Iterable[NameValuePairType]

dependency: Iterable[Dependency]

exported_name: Iterable[str]

file_id: str | None

file_type: Iterable[FileFileType]

image_type: Iterable[str]

logical_name: LogicalName | None

name: Name | None

user_file_type: Iterable[str]

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.file_builder_file_type module

class org.accellera.spirit.v1_2.file_builder_file_type.FileBuilderFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_2.file_builder_type module

class org.accellera.spirit.v1_2.file_builder_type.FileBuilderType(file_type=None, user_file_type=None, command=None, flags=None, replace_default_flags=None)

Bases: object

Variables:

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

• command – Default command used to build files of the specified fileType.

• flags – Flags given to the build command when building files of this type.

• replace_default_flags – If true, replace any default flags value with the value in the sibling flags element. Otherwise, append the contents of the sibling flags element to any default flags value. If the value is true and the “flags” element is empty or missing, this will have the result of clearing any default flags value.

Parameters:

• file_type (FileBuilderTypeFileType | None)

• user_file_type (str | None)

• command (Command | None)

• flags (Flags | None)

• replace_default_flags (ReplaceDefaultFlags | None)

class Command(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Flags(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class ReplaceDefaultFlags(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

command: Command | None

file_type: FileBuilderTypeFileType | None

flags: Flags | None

replace_default_flags: ReplaceDefaultFlags | None

user_file_type: str | None

org.accellera.spirit.v1_2.file_builder_type_file_type module

class org.accellera.spirit.v1_2.file_builder_type_file_type.FileBuilderTypeFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_2.file_file_type module

class org.accellera.spirit.v1_2.file_file_type.FileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_2.file_set module

class org.accellera.spirit.v1_2.file_set.FileSet(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=None, file_set_id=None)

Bases: FileSetType

This element specifies a list of unique pathnames to files and directories.

It may also include build instructions for the files. If compilation order is important, e.g. for VHDL files, the files have to be provided in compilation order.

Parameters:

• owner (LibraryRefType | None)

• group (Iterable[str])

• file (Iterable[File])

• default_file_builder (Iterable[FileBuilderType])

• dependency (Iterable[Dependency])

• function (Iterable[Function])

• vendor_extensions (VendorExtensions | None)

• file_set_id (str | None)

class Function(entry_point=None, file_ref=None, return_type=None, argument=<factory>, enabled=None, source_file=<factory>, replicate=None)

Bases: object

Variables:

• entry_point

• file_ref – A reference to the file that contains the entry point function.

• return_type – Function return type. See the enumerations.

• argument – Arguments passed in when the function is called. Arguments are passed in order. This is an extension of the name-value pair which includes the data type in the spirit:dataType attribute. The argument name is in the spirit:name attribute and its value is in the text content of the element.

• enabled – Specifies if the SW function is enabled. Default is true.

• source_file

• replicate

Parameters:

• entry_point (str | None)

• file_ref (str | None)

• return_type (FunctionReturnType | None)

• argument (Iterable[Argument])

• enabled (Enabled | None)

• source_file (Iterable[SourceFile])

• replicate (bool | None)

class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_2.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_2.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_2.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_2.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_2.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• data_type (DataTypeType | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

data_type: DataTypeType | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Enabled(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

• source_name – Source file for the boot load. Relative names are searched for in the project directory and the source of the component directory.

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

Parameters:

• source_name (SourceName | None)

• file_type (SourceFileFileType | None)

• user_file_type (str | None)

class SourceName(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_type: SourceFileFileType | None

source_name: SourceName | None

user_file_type: str | None

argument: Iterable[Argument]

enabled: Enabled | None

entry_point: str | None

file_ref: str | None

replicate: bool | None

return_type: FunctionReturnType | None

source_file: Iterable[SourceFile]

default_file_builder: Iterable[FileBuilderType]

dependency: Iterable[Dependency]

file: Iterable[File]

file_set_id: str | None

function: Iterable['FileSetType.Function']

group: Iterable[str]

owner: LibraryRefType | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.file_set_ref module

class org.accellera.spirit.v1_2.file_set_ref.FileSetRef(value='')

Bases: object

A reference to a fileSet.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_2.file_set_type module

class org.accellera.spirit.v1_2.file_set_type.FileSetType(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=None, file_set_id=None)

Bases: object

Variables:

• owner – Specifies the original owner of the fileSet, used when importing fileSets from other components, as in Hierarchical components, to allow the parent component to correctly locate files imported from subcomponents

• group – Identifies this filleSet as belonging to a particular group or having a particular purpose. Examples might be “diagnostics”, “boot”, “application”, “interrupt”, “deviceDriver”, etc.

• file

• default_file_builder

• dependency

• function – Generator information if this file set describes a function. For example, this file set may describe diagnostics for which the DE can generate a diagnostics driver. The boolean attribute “replicate”, if true (default is false), directs the generator to compile a separate object module for each instance of the component in the design. Otherwise the function will be called with different arguments for each instance (e.g. baseAddress).

• vendor_extensions

• file_set_id

Parameters:

• owner (LibraryRefType | None)

• group (Iterable[str])

• file (Iterable[File])

• default_file_builder (Iterable[FileBuilderType])

• dependency (Iterable[Dependency])

• function (Iterable[Function])

• vendor_extensions (VendorExtensions | None)

• file_set_id (str | None)

class Function(entry_point=None, file_ref=None, return_type=None, argument=<factory>, enabled=None, source_file=<factory>, replicate=None)

Bases: object

Variables:

• entry_point

• file_ref – A reference to the file that contains the entry point function.

• return_type – Function return type. See the enumerations.

• argument – Arguments passed in when the function is called. Arguments are passed in order. This is an extension of the name-value pair which includes the data type in the spirit:dataType attribute. The argument name is in the spirit:name attribute and its value is in the text content of the element.

• enabled – Specifies if the SW function is enabled. Default is true.

• source_file

• replicate

Parameters:

• entry_point (str | None)

• file_ref (str | None)

• return_type (FunctionReturnType | None)

• argument (Iterable[Argument])

• enabled (Enabled | None)

• source_file (Iterable[SourceFile])

• replicate (bool | None)

class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_2.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_2.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_2.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_2.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_2.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• data_type (DataTypeType | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

data_type: DataTypeType | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Enabled(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

• source_name – Source file for the boot load. Relative names are searched for in the project directory and the source of the component directory.

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

Parameters:

• source_name (SourceName | None)

• file_type (SourceFileFileType | None)

• user_file_type (str | None)

class SourceName(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_type: SourceFileFileType | None

source_name: SourceName | None

user_file_type: str | None

argument: Iterable[Argument]

enabled: Enabled | None

entry_point: str | None

file_ref: str | None

replicate: bool | None

return_type: FunctionReturnType | None

source_file: Iterable[SourceFile]

default_file_builder: Iterable[FileBuilderType]

dependency: Iterable[Dependency]

file: Iterable[File]

file_set_id: str | None

function: Iterable[Function]

group: Iterable[str]

owner: LibraryRefType | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.file_sets module

class org.accellera.spirit.v1_2.file_sets.FileSets(file_set=<factory>)

Bases: object

List of file sets associated with component.

Parameters:

file_set (Iterable[FileSet])

file_set: Iterable[FileSet]

org.accellera.spirit.v1_2.format_type module

class org.accellera.spirit.v1_2.format_type.FormatType(*values)

Bases: Enum

This is a hint to the user interface on how to obtain the value for user defined properties.

Float means a floating point number is expected. Long means an integer is expected. Bool means a boolean (true, false) is expected and choice means the user must pick from a list of possible values. A choiceRef attribute is required for choice formats. String means any text is acceptable.

BOOL = 'bool'

CHOICE = 'choice'

FLOAT = 'float'

LONG = 'long'

STRING = 'string'

org.accellera.spirit.v1_2.function_return_type module

class org.accellera.spirit.v1_2.function_return_type.FunctionReturnType(*values)

Bases: Enum

INT = 'int'

VOID = 'void'

org.accellera.spirit.v1_2.generator module

class org.accellera.spirit.v1_2.generator.Generator(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None)

Bases: GeneratorType

Specifies a set of generators.

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (TransportMethods | None)

• lgi_access_type (LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

lgi_access_type: 'GeneratorType.LgiAccessType' | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

transport_methods: 'GeneratorType.TransportMethods' | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.generator_chain module

class org.accellera.spirit.v1_2.generator_chain.GeneratorChain(vendor=None, library=None, name=None, version=None, file_generator_selector=<factory>, component_generator_selector=<factory>, generator=<factory>, chain_group=<factory>, parameter=<factory>, choices=None)

Bases: object

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• file_generator_selector – Select other generator chain files for inclusion into this chain. The boolean attribute “unique” (default false) specifies that only a single generator is valid in this context. If more that one generator is selcted based on the selection criteria, DE will prompt the user to resolve to a single generator.

• component_generator_selector – Selects generators declared in component description files of the current design for inclusion into this generator chain.

• generator

• chain_group – Identifies this generator chain as belonging to the named group. This is used by other generator chains to select this chain for programmatic inclusion.

• parameter

• choices

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• file_generator_selector (Iterable[FileGeneratorSelector])

• component_generator_selector (Iterable[GeneratorSelectorType])

• generator (Iterable[Generator])

• chain_group (Iterable[str])

• parameter (Iterable[Parameter])

• choices (Choices | None)

class FileGeneratorSelector(group_selector=None, file_name=None, unique=True)

Bases: object

Variables:

• group_selector

• file_name – Select another generator chain using the unique identifier of this generator chain.

• unique

Parameters:

• group_selector (GroupSelector | None)

• file_name (LibraryRefType | None)

• unique (bool)

file_name: LibraryRefType | None

group_selector: GroupSelector | None

unique: bool

chain_group: Iterable[str]

choices: Choices | None

component_generator_selector: Iterable[GeneratorSelectorType]

file_generator_selector: Iterable[FileGeneratorSelector]

generator: Iterable[Generator]

library: str | None

name: str | None

parameter: Iterable[Parameter]

vendor: str | None

version: str | None

org.accellera.spirit.v1_2.generator_change_list module

class org.accellera.spirit.v1_2.generator_change_list.GeneratorChangeList(component_changes=None, interconnection_changes=None, ad_hoc_connection_changes=None, design_configuration_changes=None, vendor_extension_changes=None)

Bases: object

Defines the changes to be made to the design as directed by an external generator.

Variables:

• component_changes – List of changes affecting components in the design.

• interconnection_changes – List of changes affecting interconnections in the design.

• ad_hoc_connection_changes – List of changes affecting ad-hoc connections in the design.

• design_configuration_changes – List of changes affecting the configuration of the design.

• vendor_extension_changes – List of changes affecting vendor defined extensions in the design.

Parameters:

• component_changes (ComponentChanges | None)

• interconnection_changes (InterconnectionChanges | None)

• ad_hoc_connection_changes (AdHocConnectionChanges | None)

• design_configuration_changes (DesignConfigurationChanges | None)

• vendor_extension_changes (VendorExtensionChanges | None)

class AdHocConnectionChanges(ad_hoc_connection_change: collections.abc.Iterable['GeneratorChangeList.AdHocConnectionChanges.AdHocConnectionChange'] = <factory>)

Bases: object

Parameters:

ad_hoc_connection_change (Iterable[AdHocConnectionChange])

class AdHocConnectionChange(add_rem_change=None, name=None, export=None, pin_reference=<factory>)

Bases: object

Variables:

• add_rem_change

• name – This is the name of the ad-hoc connection to modify

• export – Specifies whether this ad-hoc connection will be exported out of the design.

• pin_reference – Indicates the signal on the component which is being connected by this ad-hoc connection

Parameters:

• add_rem_change (AddRemChange | None)

• name (str | None)

• export (Export | None)

• pin_reference (Iterable[PinReference])

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class PinReference(component_ref=None, signal_ref=None, left=0, right=0)

Bases: object

Variables:

• component_ref – This is the instance name of the component

• signal_ref – The name of the signal on the component

• left – If present, this is the left index of the signal

• right – If present, this is the right index of the signal

Parameters:

• component_ref (str | None)

• signal_ref (str | None)

• left (int)

• right (int)

component_ref: str | None

left: int

right: int

signal_ref: str | None

add_rem_change: AddRemChange | None

export: Export | None

name: str | None

pin_reference: Iterable[PinReference]

ad_hoc_connection_change: Iterable[AdHocConnectionChange]

class ComponentChanges(component_change: collections.abc.Iterable['GeneratorChangeList.ComponentChanges.ComponentChange'] = <factory>)

Bases: object

Parameters:

component_change (Iterable[ComponentChange])

class ComponentChange(add_rem_rep_change=None, instance_name=None, component_file_name=None, sub_components=None, configuration=None)

Bases: object

Variables:

• add_rem_rep_change

• instance_name

• component_file_name – This is the file containing the component definition. Required only if the alteration is an addition or a replacement. Should be an absolute filename so that the DE may copy it.

• sub_components – Required only for hierarchical components. Holds the hierarchical component’s sub- component definition files.

• configuration

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• instance_name (InstanceName | None)

• component_file_name (str | None)

• sub_components (SubComponents | None)

• configuration (Configuration | None)

class SubComponents(sub_component_file_name=<factory>)

Bases: object

Variables:

sub_component_file_name – Path to definitions of components and channels instanced in hierarchical component definition.

Parameters:

sub_component_file_name (Iterable[str])

sub_component_file_name: Iterable[str]

add_rem_rep_change: AddRemRepChange | None

component_file_name: str | None

configuration: Configuration | None

instance_name: InstanceName | None

sub_components: SubComponents | None

component_change: Iterable[ComponentChange]

class DesignConfigurationChanges(pmd_configuration_change=<factory>, generator_chain_configuration_change=<factory>, view_configuration_change=<factory>, vendor_extension_changes=None)

Bases: object

Variables:

• pmd_configuration_change – Contains the configurable information associated with a particular PMD

• generator_chain_configuration_change – Contains the configurable information associated with a generatorChain and its generators. Note that configurable information for generators associated with components is stored in the design file.

• view_configuration_change – Contains the active view for each instance in the design

• vendor_extension_changes – List of changes affecting vendor defined extensions in the design.

Parameters:

• pmd_configuration_change (Iterable[PmdConfigurationChange])

• generator_chain_configuration_change (Iterable[GeneratorChainConfigurationChange])

• view_configuration_change (Iterable[ViewConfigurationChange])

• vendor_extension_changes (VendorExtensionChanges | None)

class GeneratorChainConfigurationChange(generator_chain_ref=None, generator_chain_change=<factory>, generator_change=<factory>)

Bases: object

Variables:

• generator_chain_ref – References a generatorChain.

• generator_chain_change

• generator_change – Stores configurable information for generators referenced in the chain

Parameters:

• generator_chain_ref (LibraryRefType | None)

• generator_chain_change (Iterable[GeneratorChainChange])

• generator_change (Iterable[GeneratorChange])

class GeneratorChainChange(add_rem_rep_change: Optional[org.accellera.spirit.v1_2.add_rem_rep_change.AddRemRepChange] = None, configurable_element: collections.abc.Iterable[org.accellera.spirit.v1_2.configurable_element.ConfigurableElement] = <factory>)

Bases: object

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• configurable_element (Iterable[ConfigurableElement])

add_rem_rep_change: AddRemRepChange | None

configurable_element: Iterable[ConfigurableElement]

class GeneratorChange(add_rem_rep_change=None, generator_name=None, configurable_element=<factory>)

Bases: object

Variables:

• add_rem_rep_change

• generator_name – This identifies the generator in the chain.

• configurable_element

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• generator_name (str | None)

• configurable_element (Iterable[ConfigurableElement])

add_rem_rep_change: AddRemRepChange | None

configurable_element: Iterable[ConfigurableElement]

generator_name: str | None

generator_chain_change: Iterable[GeneratorChainChange]

generator_chain_ref: LibraryRefType | None

generator_change: Iterable[GeneratorChange]

class PmdConfigurationChange(add_rem_rep_change=None, pmd_ref=None, configurable_element=<factory>)

Bases: object

Variables:

• add_rem_rep_change

• pmd_ref – References a PMD.

• configurable_element

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• pmd_ref (LibraryRefType | None)

• configurable_element (Iterable[ConfigurableElement])

add_rem_rep_change: AddRemRepChange | None

configurable_element: Iterable[ConfigurableElement]

pmd_ref: LibraryRefType | None

class VendorExtensionChanges(vendor_extension_change: collections.abc.Iterable['GeneratorChangeList.DesignConfigurationChanges.VendorExtensionChanges.VendorExtensionChange'] = <factory>)

Bases: object

Parameters:

vendor_extension_change (Iterable[VendorExtensionChange])

class VendorExtensionChange(add_rem_change: org.accellera.spirit.v1_2.add_rem_change.AddRemChange | None = None, vendor_extensions: org.accellera.spirit.v1_2.vendor_extensions.VendorExtensions | None = None)

Bases: object

Parameters:

• add_rem_change (AddRemChange | None)

• vendor_extensions (VendorExtensions | None)

add_rem_change: AddRemChange | None

vendor_extensions: VendorExtensions | None

vendor_extension_change: Iterable[VendorExtensionChange]

class ViewConfigurationChange(add_rem_rep_change=None, instance_name=None, view_name=None)

Bases: object

Variables:

• add_rem_rep_change

• instance_name

• view_name – The name of the active view for this instance

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• instance_name (InstanceName | None)

• view_name (str | None)

add_rem_rep_change: AddRemRepChange | None

instance_name: InstanceName | None

view_name: str | None

generator_chain_configuration_change: Iterable[GeneratorChainConfigurationChange]

pmd_configuration_change: Iterable[PmdConfigurationChange]

vendor_extension_changes: VendorExtensionChanges | None

view_configuration_change: Iterable[ViewConfigurationChange]

class InterconnectionChanges(interconnection_change: collections.abc.Iterable['GeneratorChangeList.InterconnectionChanges.InterconnectionChange'] = <factory>)

Bases: object

Parameters:

interconnection_change (Iterable[InterconnectionChange])

class InterconnectionChange(add_rem_change: org.accellera.spirit.v1_2.add_rem_change.AddRemChange | None = None, interconnection: org.accellera.spirit.v1_2.interconnection.Interconnection | None = None, monitor_interconnection: org.accellera.spirit.v1_2.monitor_interconnection.MonitorInterconnection | None = None)

Bases: object

Parameters:

• add_rem_change (AddRemChange | None)

• interconnection (Interconnection | None)

• monitor_interconnection (MonitorInterconnection | None)

add_rem_change: AddRemChange | None

interconnection: Interconnection | None

monitor_interconnection: MonitorInterconnection | None

interconnection_change: Iterable[InterconnectionChange]

class VendorExtensionChanges(vendor_extension_change: collections.abc.Iterable['GeneratorChangeList.VendorExtensionChanges.VendorExtensionChange'] = <factory>)

Bases: object

Parameters:

vendor_extension_change (Iterable[VendorExtensionChange])

class VendorExtensionChange(add_rem_change: org.accellera.spirit.v1_2.add_rem_change.AddRemChange | None = None, vendor_extensions: org.accellera.spirit.v1_2.vendor_extensions.VendorExtensions | None = None)

Bases: object

Parameters:

• add_rem_change (AddRemChange | None)

• vendor_extensions (VendorExtensions | None)

add_rem_change: AddRemChange | None

vendor_extensions: VendorExtensions | None

vendor_extension_change: Iterable[VendorExtensionChange]

ad_hoc_connection_changes: AdHocConnectionChanges | None

component_changes: ComponentChanges | None

design_configuration_changes: DesignConfigurationChanges | None

interconnection_changes: InterconnectionChanges | None

vendor_extension_changes: VendorExtensionChanges | None

org.accellera.spirit.v1_2.generator_ref module

class org.accellera.spirit.v1_2.generator_ref.GeneratorRef(value='')

Bases: object

A reference to a generator element.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_2.generator_selector_type module

class org.accellera.spirit.v1_2.generator_selector_type.GeneratorSelectorType(group_selector: org.accellera.spirit.v1_2.group_selector.GroupSelector | None = None)

Bases: object

Parameters:

group_selector (GroupSelector | None)

group_selector: GroupSelector | None

org.accellera.spirit.v1_2.generator_type module

class org.accellera.spirit.v1_2.generator_type.GeneratorType(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None)

Bases: object

Types of generators.

Variables:

• name – The name of this generator.

• phase

• parameter

• api_type – Indicates the type of API used by the generator. Valid value are TGI, LGI, and none. If this element is not present, LGI is assumed.

• transport_methods

• lgi_access_type – Identifies the special requirements that this loose generator may place up on the DE. Not valid for tight generators.

• generator_exe – The pathname to the executable file that implements the generator

• vendor_extensions

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (TransportMethods | None)

• lgi_access_type (LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

lgi_access_type: LgiAccessType | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

transport_methods: TransportMethods | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.generator_type_api_type module

class org.accellera.spirit.v1_2.generator_type_api_type.GeneratorTypeApiType(*values)

Bases: Enum

LGI = 'LGI'

NONE = 'none'

TGI = 'TGI'

org.accellera.spirit.v1_2.group module

org.accellera.spirit.v1_2.group_selector module

class org.accellera.spirit.v1_2.group_selector.GroupSelector(name=<factory>, multiple_group_selection_operator=GroupSelectorMultipleGroupSelectionOperator.OR)

Bases: object

Specifies a set of group names used to select subsequent generators.

The attribute “multipleGroupOperator” specifies the OR or AND selection operator if there is more than one group name (default=OR).

Variables:

• name – Name used to select a generator or generator chain.

• multiple_group_selection_operator

Parameters:

• name (Iterable[str])

• multiple_group_selection_operator (GroupSelectorMultipleGroupSelectionOperator)

multiple_group_selection_operator: GroupSelectorMultipleGroupSelectionOperator

name: Iterable[str]

org.accellera.spirit.v1_2.group_selector_multiple_group_selection_operator module

class org.accellera.spirit.v1_2.group_selector_multiple_group_selection_operator.GroupSelectorMultipleGroupSelectionOperator(*values)

Bases: Enum

AND = 'and'

OR = 'or'

org.accellera.spirit.v1_2.instance_generator_type module

class org.accellera.spirit.v1_2.instance_generator_type.InstanceGeneratorType(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE)

Bases: GeneratorType

Variables:

• group – An identifier to specify the generator group. This is used by generator chains for selecting which generators to run.

• scope – The scope attribute applies to component generators and specifies whether the generator should be run for each instance of the entity (or module) or just once for all instances of the entity.

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (TransportMethods | None)

• lgi_access_type (LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

• group (Iterable[str])

• scope (InstanceGeneratorTypeScope)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

group: Iterable[str]

lgi_access_type: 'GeneratorType.LgiAccessType' | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

scope: InstanceGeneratorTypeScope

transport_methods: 'GeneratorType.TransportMethods' | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.instance_generator_type_scope module

class org.accellera.spirit.v1_2.instance_generator_type_scope.InstanceGeneratorTypeScope(*values)

Bases: Enum

ENTITY = 'entity'

INSTANCE = 'instance'

org.accellera.spirit.v1_2.instance_name module

class org.accellera.spirit.v1_2.instance_name.InstanceName(value='')

Bases: object

An instance name assigned to subcomponent instances and contained channels, that is unique within the parent component.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_2.interconnection module

class org.accellera.spirit.v1_2.interconnection.Interconnection(name=None, active_interface=<factory>)

Bases: object

Describes a connection from the interface of one component to the interface of another component through its attributes.

The componentRef and busInterfaceRef attributes indicate the instance name and bus interface name of one end of the connection. The interconnection element connects two active interfaces and doesn’t connect monitor interfaces.

Variables:

• name – name of the connection

• active_interface

Parameters:

• name (object | None)

• active_interface (Iterable[Interface])

active_interface: Iterable[Interface]

name: object | None

org.accellera.spirit.v1_2.interconnections module

class org.accellera.spirit.v1_2.interconnections.Interconnections(interconnection=<factory>, monitor_interconnection=<factory>)

Bases: object

Connections between internal sub components.

Parameters:

• interconnection (Iterable[Interconnection])

• monitor_interconnection (Iterable[MonitorInterconnection])

interconnection: Iterable[Interconnection]

monitor_interconnection: Iterable[MonitorInterconnection]

org.accellera.spirit.v1_2.interface module

class org.accellera.spirit.v1_2.interface.Interface(component_ref=None, bus_ref=None)

Bases: object

A representation of a component/bus interface relation; i.e. a bus interface belonging to a certain component.

Parameters:

• component_ref (object | None)

• bus_ref (object | None)

bus_ref: object | None

component_ref: object | None

org.accellera.spirit.v1_2.library_ref_type module

class org.accellera.spirit.v1_2.library_ref_type.LibraryRefType(vendor=None, library=None, name=None, version=None)

Bases: object

Base SPIRIT document reference type.

Contains vendor, library, name and version attributes.

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

library: str | None

name: str | None

vendor: str | None

version: str | None

org.accellera.spirit.v1_2.load_constraint module

class org.accellera.spirit.v1_2.load_constraint.LoadConstraint(cell_specification=None, count=None, capacitance=None)

Bases: object

Defines a constraint indicating the type of load on an output signal.

Variables:

• cell_specification

• count – Indicates how many loads of the specified cell are connected. If not present, 3 is assumed.

• capacitance – Indicates an explicit load capacitance on an output signal.

Parameters:

• cell_specification (CellSpecification | None)

• count (int | None)

• capacitance (Capacitance | None)

capacitance: Capacitance | None

cell_specification: CellSpecification | None

count: int | None

org.accellera.spirit.v1_2.local_memory_map_type module

class org.accellera.spirit.v1_2.local_memory_map_type.LocalMemoryMapType(address_block=<factory>, bank=<factory>, subspace_map=<factory>)

Bases: object

Map of address space blocks on the local memory map of a master bus interface.

Variables:

• address_block

• bank

• subspace_map – Maps in an address subspace from accross a bus bridge. Its masterRef attribute refers by name to the master bus interface on the other side of the bridge. It must match the masterRef attribute of a bridge element on the slave interface, and that bridge element must be designated as opaque.

Parameters:

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_2.loose_generator_invocation module

class org.accellera.spirit.v1_2.loose_generator_invocation.LooseGeneratorInvocation(design_file=None, configuration_file=None, bus_definition_files=None, component_definition_files=None, parameters=None, selected_instances=None, phase_number=None, group_name=None)

Bases: object

Specifies the information required to invoke a loosely coupled generator.

Variables:

• design_file – Path to description of top level design

• configuration_file – Path to configuration file for this design

• bus_definition_files – The list of bus definition files currently in use within the design

• component_definition_files – The list of component definition files currently needed to define all the components within the design.

• parameters – List of values of configurable settings for this generator invocation

• selected_instances – The list of instances to be worked upon by the generator, no instances selected indicates whole design

• phase_number – The non-negative floating point phase number associated with this generator invocation

• group_name – The generator group name associated with this generator invocation

Parameters:

• design_file (str | None)

• configuration_file (str | None)

• bus_definition_files (BusDefinitionFiles | None)

• component_definition_files (ComponentDefinitionFiles | None)

• parameters (Parameters | None)

• selected_instances (SelectedInstances | None)

• phase_number (float | None)

• group_name (str | None)

class BusDefinitionFiles(bus_definition_file=<factory>)

Bases: object

Variables:

bus_definition_file – Path to a bus definition file used within design. Attributes VLNV used to indicate which bus definition this file represents.

Parameters:

bus_definition_file (Iterable[ResolvedLibraryRefType])

bus_definition_file: Iterable[ResolvedLibraryRefType]

class ComponentDefinitionFiles(component_definition_file=<factory>)

Bases: object

Variables:

component_definition_file – Path to component definition file. This component definition is the component definition as it appears in the DE; i.e. after having been transformed by any PMD info, and including any instance specific settings such as parameter values. The instanceRef attribute is the name of the instance that this file describes.

Parameters:

component_definition_file (Iterable[ComponentDefinitionFile])

class ComponentDefinitionFile(value='', instance_ref=None)

Bases: object

Variables:

• value

• instance_ref – Reference handle for this component definition

Parameters:

• value (str)

• instance_ref (str | None)

instance_ref: str | None

value: str

component_definition_file: Iterable[ComponentDefinitionFile]

class Parameters(parameter: collections.abc.Iterable[org.accellera.spirit.v1_2.parameter.Parameter] = <factory>)

Bases: object

Parameters:

parameter (Iterable[Parameter])

parameter: Iterable[Parameter]

class SelectedInstances(selected_instance=<factory>)

Bases: object

Variables:

selected_instance – Instance name of selected instance that the generator is expected to work upon. This may be a hierarchical instance name.

Parameters:

selected_instance (Iterable[str])

selected_instance: Iterable[str]

bus_definition_files: BusDefinitionFiles | None

component_definition_files: ComponentDefinitionFiles | None

configuration_file: str | None

design_file: str | None

group_name: str | None

parameters: Parameters | None

phase_number: float | None

selected_instances: SelectedInstances | None

org.accellera.spirit.v1_2.memory_map_ref module

class org.accellera.spirit.v1_2.memory_map_ref.MemoryMapRef(memory_map_ref=None)

Bases: MemoryMapRefType

References the memory map.

The name of the memory map is kept in its memoryMapRef attribute.

Parameters:

memory_map_ref (str | None)

memory_map_ref: str | None

org.accellera.spirit.v1_2.memory_map_ref_type module

class org.accellera.spirit.v1_2.memory_map_ref_type.MemoryMapRefType(memory_map_ref=None)

Bases: object

Base type for an element which references an memory map.

Reference is kept in an attribute rather than the text value, so that the type may be extended with child elements if necessary.

Parameters:

memory_map_ref (str | None)

memory_map_ref: str | None

org.accellera.spirit.v1_2.memory_map_type module

class org.accellera.spirit.v1_2.memory_map_type.MemoryMapType(name=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, memory_remap=<factory>)

Bases: object

Map of address space blocks on slave slave bus interface.

Variables:

• name – Memory map name, unique within the component. Put into a group to avoid making it a top level element

• address_block

• bank

• subspace_map – Maps in an address subspace from accross a bus bridge. Its masterRef attribute refers by name to the master bus interface on the other side of the bridge. It must match the masterRef attribute of a bridge element on the slave interface, and that bridge element must be designated as opaque.

• memory_remap

Parameters:

• name (str | None)

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

• memory_remap (Iterable[MemoryRemapType])

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

memory_remap: Iterable[MemoryRemapType]

name: str | None

subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_2.memory_maps module

class org.accellera.spirit.v1_2.memory_maps.MemoryMaps(memory_map=<factory>)

Bases: object

Lists all the slave memory maps defined by the component.

Variables:

memory_map – The set of address blocks a bus slave contributes to the bus’ address space.

Parameters:

memory_map (Iterable[MemoryMap])

class MemoryMap(name: Optional[str] = None, address_block: collections.abc.Iterable[org.accellera.spirit.v1_2.address_block.AddressBlock] = <factory>, bank: collections.abc.Iterable[org.accellera.spirit.v1_2.bank.Bank] = <factory>, subspace_map: collections.abc.Iterable[org.accellera.spirit.v1_2.subspace_ref_type.SubspaceRefType] = <factory>, memory_remap: collections.abc.Iterable[org.accellera.spirit.v1_2.memory_remap_type.MemoryRemapType] = <factory>, bits_in_lau: Optional[org.accellera.spirit.v1_2.bits_in_lau.BitsInLau] = None)

Bases: MemoryMapType

Parameters:

• name (str | None)

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

• memory_remap (Iterable[MemoryRemapType])

• bits_in_lau (BitsInLau | None)

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

bits_in_lau: BitsInLau | None

memory_remap: Iterable[MemoryRemapType]

name: str | None

subspace_map: Iterable[SubspaceRefType]

memory_map: Iterable[MemoryMap]

org.accellera.spirit.v1_2.memory_remap_type module

class org.accellera.spirit.v1_2.memory_remap_type.MemoryRemapType(address_block=<factory>, bank=<factory>, subspace_map=<factory>, state=None)

Bases: object

Map of address space blocks on a slave bus interface in a specific remap state.

Variables:

• address_block

• bank

• subspace_map – Maps in an address subspace from accross a bus bridge. Its masterRef attribute refers by name to the master bus interface on the other side of the bridge. It must match the masterRef attribute of a bridge element on the slave interface, and that bridge element must be designated as opaque.

• state – State of the component in which the memory map is active.

Parameters:

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

• state (str | None)

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

state: str | None

subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_2.model module

class org.accellera.spirit.v1_2.model.Model(views=None, signals=None, model_parameters=None, vendor_extensions=None)

Bases: ModelType

Model information.

Parameters:

• views (Views | None)

• signals (Signals | None)

• model_parameters (ModelParameters | None)

• vendor_extensions (VendorExtensions | None)

class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

model_parameter – A model parameter name value pair. The name is given in an attribute. The value is the element value. The dataType (applicable to high level modeling) is given in the dataType attribute. For hardware based models, the name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]

class Signals(signal: collections.abc.Iterable[org.accellera.spirit.v1_2.signal.Signal] = <factory>)

Bases: object

Parameters:

signal (Iterable[Signal])

signal: Iterable[Signal]

class Views(view: collections.abc.Iterable[org.accellera.spirit.v1_2.view_type.ViewType] = <factory>)

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]

model_parameters: 'ModelType.ModelParameters' | None

signals: 'ModelType.Signals' | None

vendor_extensions: VendorExtensions | None

views: 'ModelType.Views' | None

org.accellera.spirit.v1_2.model_type module

class org.accellera.spirit.v1_2.model_type.ModelType(views=None, signals=None, model_parameters=None, vendor_extensions=None)

Bases: object

Hardware model information.

Variables:

• views – View container

• signals – Signal container

• model_parameters – Model parameter name value pairs container

• vendor_extensions

Parameters:

• views (Views | None)

• signals (Signals | None)

• model_parameters (ModelParameters | None)

• vendor_extensions (VendorExtensions | None)

class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

model_parameter – A model parameter name value pair. The name is given in an attribute. The value is the element value. The dataType (applicable to high level modeling) is given in the dataType attribute. For hardware based models, the name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]

class Signals(signal: collections.abc.Iterable[org.accellera.spirit.v1_2.signal.Signal] = <factory>)

Bases: object

Parameters:

signal (Iterable[Signal])

signal: Iterable[Signal]

class Views(view: collections.abc.Iterable[org.accellera.spirit.v1_2.view_type.ViewType] = <factory>)

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]

model_parameters: ModelParameters | None

signals: Signals | None

vendor_extensions: VendorExtensions | None

views: Views | None

org.accellera.spirit.v1_2.monitor_interconnection module

class org.accellera.spirit.v1_2.monitor_interconnection.MonitorInterconnection(name=None, active_interface=None, monitor_interface=<factory>)

Bases: object

Describes a connection from the interface of one component to any number of monitor interfaces in the design through its child elements’ attributes.

The componentRef and busInterfaceRef attributes of each child interface element indicate the instance name and bus interface name of one end of the connection. An active interface can be connected to unlimited number of monitor interfaces.

Variables:

• name – name of the connection

• active_interface

• monitor_interface

Parameters:

• name (object | None)

• active_interface (Interface | None)

• monitor_interface (Iterable[Interface])

active_interface: Interface | None

monitor_interface: Iterable[Interface]

name: object | None

org.accellera.spirit.v1_2.monitor_interface_type module

class org.accellera.spirit.v1_2.monitor_interface_type.MonitorInterfaceType(*values)

Bases: Enum

MASTER = 'master'

MIRRORED_MASTER = 'mirroredMaster'

MIRRORED_SLAVE = 'mirroredSlave'

MIRRORED_SYSTEM = 'mirroredSystem'

SLAVE = 'slave'

SYSTEM = 'system'

org.accellera.spirit.v1_2.multi_cycle_path module

class org.accellera.spirit.v1_2.multi_cycle_path.MultiCyclePath(path_specifier=None, cycles=None, path_edge=None, path_type=None, relative_clock=None)

Bases: object

Defines a multi-cycle path timing exception.

Parameters:

• path_specifier (PathSpecifier | None)

• cycles (int | None)

• path_edge (EdgeValueType | None)

• path_type (CheckValueType | None)

• relative_clock (RelativeClockType | None)

cycles: int | None

path_edge: EdgeValueType | None

path_specifier: PathSpecifier | None

path_type: CheckValueType | None

relative_clock: RelativeClockType | None

org.accellera.spirit.v1_2.name_value_pair_type module

class org.accellera.spirit.v1_2.name_value_pair_type.NameValuePairType(value='', name=None, cross_ref=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Used wherever a name value pair is appropriate.

The name is given by the attribute while the value is the element content. Supports configurability attributes and a cross reference XPath expression stored in the crossRef attribute.

Variables:

• value

• name – The name in a name-value pair.

• cross_ref

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

org.accellera.spirit.v1_2.name_value_type_type module

class org.accellera.spirit.v1_2.name_value_type_type.NameValueTypeType(value='', name=None, cross_ref=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None, data_type=None)

Bases: NameValuePairType

Name value pair with data type information.

Variables:

data_type – The data type of the argumen as pertains to the language. Example: “int”, “double”, “char *”.

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• data_type (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

data_type: str | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

org.accellera.spirit.v1_2.on_master_value module

class org.accellera.spirit.v1_2.on_master_value.OnMasterValue(*values)

Bases: Enum

IN = 'in'

INOUT = 'inout'

OUT = 'out'

org.accellera.spirit.v1_2.on_slave_value module

class org.accellera.spirit.v1_2.on_slave_value.OnSlaveValue(*values)

Bases: Enum

IN = 'in'

INOUT = 'inout'

OUT = 'out'

org.accellera.spirit.v1_2.on_system_value module

class org.accellera.spirit.v1_2.on_system_value.OnSystemValue(*values)

Bases: Enum

IN = 'in'

INOUT = 'inout'

OUT = 'out'

org.accellera.spirit.v1_2.other_clocks module

class org.accellera.spirit.v1_2.other_clocks.OtherClocks(clock_driver=<factory>)

Bases: object

List of clocks associated with the component that are not associated with signals.

Set the clockSource attribute on the clockDriver to indicate the source of a clock not associated with a particular component signal.

Parameters:

clock_driver (Iterable[ClockDriver])

clock_driver: Iterable[ClockDriver]

org.accellera.spirit.v1_2.parameter module

class org.accellera.spirit.v1_2.parameter.Parameter(value='', name=None, cross_ref=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: NameValuePairType

A name value pair.

The name is specified by the name attribute. The value is in the text content of the element. This element supports all configurability attributes. It also supports a cross reference attribute which allows it to be associated with other elements in the document through an XPath expression.

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

org.accellera.spirit.v1_2.path_element_type module

class org.accellera.spirit.v1_2.path_element_type.PathElementType(*values)

Bases: Enum

Indicates legal values for pathElement attribute.

CELL = 'cell'

CLOCK = 'clock'

PIN = 'pin'

SIGNAL = 'signal'

org.accellera.spirit.v1_2.path_specifier module

class org.accellera.spirit.v1_2.path_specifier.PathSpecifier(from_value=<factory>, to=<factory>, through=<factory>)

Bases: object

Defines one or more logical paths within a component.

Variables:

• from_value – Defines a valid path starting point. This can be a clock, an input port, a sequential cell, or a clock or data out pin of a sequential cell. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to it if might be ambiguous.

• to – Defines a valid path ending point. This can be a clock, an output port, a sequential cell, or a clock or data in pin of a sequential cell. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous. Defines a valid path ending point. This can be a clock, an output port, a sequential cell, or a clock or data in pin of a sequential cell. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous.

• through – Defines a set of pins, ports, cells, or nets through which the desired path(s) must pass. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous. Defines a set of pins, ports, cells, or nets through which the desired path(s) must pass. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous.

Parameters:

• from_value (Iterable[From])

• to (Iterable[To])

• through (Iterable[Through])

class From(value: str = '', path_element: org.accellera.spirit.v1_2.path_element_type.PathElementType | None = None)

Bases: object

Parameters:

• value (str)

• path_element (PathElementType | None)

path_element: PathElementType | None

value: str

class Through(value: str = '', path_element: org.accellera.spirit.v1_2.path_element_type.PathElementType | None = None)

Bases: object

Parameters:

• value (str)

• path_element (PathElementType | None)

path_element: PathElementType | None

value: str

class To(value: str = '', path_element: org.accellera.spirit.v1_2.path_element_type.PathElementType | None = None)

Bases: object

Parameters:

• value (str)

• path_element (PathElementType | None)

path_element: PathElementType | None

value: str

from_value: Iterable[From]

through: Iterable[Through]

to: Iterable[To]

org.accellera.spirit.v1_2.persistent_data_type module

class org.accellera.spirit.v1_2.persistent_data_type.PersistentDataType(id: str | None = None)

Bases: object

Parameters:

id (str | None)

id: str | None

org.accellera.spirit.v1_2.persistent_instance_data module

class org.accellera.spirit.v1_2.persistent_instance_data.PersistentInstanceData(id=None)

Bases: PersistentDataType

A container for any data that is specific to this instance of the design object.

The contents are not interpreted or validated by the Design Environment. This element will be saved with the design and restored when the design is loaded. It is indended to be used by generators to store and retrieve instance specific data.

Parameters:

id (str | None)

id: str | None

org.accellera.spirit.v1_2.phase module

class org.accellera.spirit.v1_2.phase.Phase(value=None, scope=PhaseScopeType.GLOBAL)

Bases: object

This is an non-negative floating point number that is used to sequence when a generator is run.

The generators are run in order starting with zero. There may be multiple generators with the same phase number. In this case, the order should not matter with respect to other generators at the same phase. If no phase number is given the generator will be considered in the “last” phase and these generators will be run in the order in which they are encountered while processing generator elements.

Parameters:

• value (float | None)

• scope (PhaseScopeType)

scope: PhaseScopeType

value: float | None

org.accellera.spirit.v1_2.phase_scope_type module

class org.accellera.spirit.v1_2.phase_scope_type.PhaseScopeType(*values)

Bases: Enum

GLOBAL = 'global'

LOCAL = 'local'

org.accellera.spirit.v1_2.pmd module

class org.accellera.spirit.v1_2.pmd.Pmd(vendor=None, library=None, name=None, version=None, applies_to=None, depends_on=None, transformer=None, choices=None)

Bases: object

The root element of the platform meta-data definition file.

This file defines the Platform meta-data to be applied to specific IP

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• applies_to – Defines the components that this pmd applies to. When the user tries to add any of those components, this pmd will be applied.

• depends_on – Defines the components that must exist in the current design for this pmd to apply. The pmd will only apply if an instance of each components declared in this list exists in the design. If the list is empty then this pmd file will apply unconditionally.

• transformer – The transformer element contains references to the actual code that will make the transformation. If there are multiple elements, they will be applied in sequence. i.e., the affected component document will pass through a pipeline of transformers with each child element representing a step in a pipeline.

• choices

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• applies_to (AppliesTo | None)

• depends_on (DependsOn | None)

• transformer (Transformer | None)

• choices (Choices | None)

class AppliesTo(component_ref=<factory>)

Bases: object

Variables:

component_ref – A vendor-library-name-version identifier used to refer to components.

Parameters:

component_ref (Iterable[ComponentRef])

class ComponentRef(vendor=None, library=None, name=None, version=None, display_label=None)

Bases: LibraryRefType

Variables:

display_label – A display label to override the original component’s display label if this PMD will apply.

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• display_label (str | None)

display_label: str | None

library: str | None

name: str | None

vendor: str | None

version: str | None

component_ref: Iterable[ComponentRef]

class DependsOn(component_ref=<factory>)

Bases: object

Variables:

component_ref – A vendor-library-name-version identifier used to refer to components.

Parameters:

component_ref (Iterable[LibraryRefType])

component_ref: Iterable[LibraryRefType]

class Transformer(xslt=<factory>)

Bases: object

Variables:

xslt – An XSLT transformer that will transform the document based on rules defined in the xsl file mentioned here.

Parameters:

xslt (Iterable[Xslt])

class Xslt(style_sheet=None, parameter=<factory>)

Bases: object

Variables:

• style_sheet – The relative path to the xsl stylesheet to be used for transformation.

• parameter – Parameters to be passed to the xslt stylesheet at run time.

Parameters:

• style_sheet (str | None)

• parameter (Iterable[NameValuePairType])

parameter: Iterable[NameValuePairType]

style_sheet: str | None

xslt: Iterable[Xslt]

applies_to: AppliesTo | None

choices: Choices | None

depends_on: DependsOn | None

library: str | None

name: str | None

transformer: Transformer | None

vendor: str | None

version: str | None

org.accellera.spirit.v1_2.range_type_type module

class org.accellera.spirit.v1_2.range_type_type.RangeTypeType(*values)

Bases: Enum

This type is used to indicate how the minimum and maximum attributes values should be interpreted.

For purposes of this attribute, an int is 4 bytes and a long is 8 bytes.

FLOAT = 'float'

INT = 'int'

LONG = 'long'

UNSIGNED_INT = 'unsigned int'

UNSIGNED_LONG = 'unsigned long'

org.accellera.spirit.v1_2.relative_clock_type module

class org.accellera.spirit.v1_2.relative_clock_type.RelativeClockType(*values)

Bases: Enum

Indicates legal values for associating a clock with timing exception.

END = 'end'

START = 'start'

org.accellera.spirit.v1_2.remap_states module

class org.accellera.spirit.v1_2.remap_states.RemapStates(remap_state=<factory>)

Bases: object

Contains a list of remap state names and associated signal values.

Variables:

remap_state – Contains a list of signals and values which tell the decoder to enter this remap state. The name attribute identifies the name of the state

Parameters:

remap_state (Iterable[RemapState])

class RemapState(remap_signal=<factory>, name=None)

Bases: object

Variables:

• remap_signal – Contains the name and value of a signal on the component, the value indicates the logic value which this signal must take to effect the remapping. The id attribute stores the name of the signal which takes that value.

• name – Stores the name of the state

Parameters:

• remap_signal (Iterable[RemapSignal])

• name (str | None)

class RemapSignal(value=None, id=None)

Bases: object

Variables:

• value

• id – This attribute identifies a signal on the component which affects the component’s memory layout

Parameters:

• value (bool | None)

• id (str | None)

id: str | None

value: bool | None

name: str | None

remap_signal: Iterable[RemapSignal]

remap_state: Iterable[RemapState]

org.accellera.spirit.v1_2.requires_driver module

class org.accellera.spirit.v1_2.requires_driver.RequiresDriver(value=None, driver_type=RequiresDriverDriverType.ANY)

Bases: object

Specifies if a signal requires a driver.

Default is false. The attribute driverType can further qualify what type of driver is required. Undefined behaviour if direction is not input or inout. Driver type any indicates that any unspecified type of driver must be connected

Parameters:

• value (bool | None)

• driver_type (RequiresDriverDriverType)

driver_type: RequiresDriverDriverType

value: bool | None

org.accellera.spirit.v1_2.requires_driver_driver_type module

class org.accellera.spirit.v1_2.requires_driver_driver_type.RequiresDriverDriverType(*values)

Bases: Enum

ANY = 'any'

CLOCK = 'clock'

SINGLE_SHOT = 'singleShot'

org.accellera.spirit.v1_2.resistance module

class org.accellera.spirit.v1_2.resistance.Resistance(value=None, units=None)

Bases: object

Represents a simple resistance value with optional units.

Parameters:

• value (float | None)

• units (ResistanceValueUnitType | None)

units: ResistanceValueUnitType | None

value: float | None

org.accellera.spirit.v1_2.resistance_value_unit_type module

class org.accellera.spirit.v1_2.resistance_value_unit_type.ResistanceValueUnitType(*values)

Bases: Enum

Indicates legal units for resistance values.

KOHM = 'kohm'

OHM = 'ohm'

org.accellera.spirit.v1_2.resolve_type module

class org.accellera.spirit.v1_2.resolve_type.ResolveType(*values)

Bases: Enum

Determines how a property is resolved.

Immediate means the value is included in the XML document and cannot be changed by the user. User means the value must be obtained from the user. Optional means the user is given the opportunity to supply a value, but can leave the entry blank. Dependent means the value depends on the value of other properties. A dependency expression must be supplied in the dependency attribute. Generated means the value will be provided by a generator.

Variables:

• IMMEDIATE – Property value is included in the XML file. It cannot be configured.

• USER – Property content can be modified through confiugration. Modifications will be saved with the design.

• DEPENDENT – Property value is expressed as an XPath expression which may refer to other properties. The expression must appear in the dendency attribute.

• GENERATED – Generators may modify this property. Modifications get saved with the design.

DEPENDENT = 'dependent'

GENERATED = 'generated'

IMMEDIATE = 'immediate'

USER = 'user'

org.accellera.spirit.v1_2.resolved_library_ref_type module

class org.accellera.spirit.v1_2.resolved_library_ref_type.ResolvedLibraryRefType(value='', vendor=None, library=None, name=None, version=None)

Bases: object

Resolved SPIRIT document reference type.

Contains vendor, library, name and version attributes and the URI of the referenced SPIRIT document

Parameters:

• value (str)

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

library: str | None

name: str | None

value: str

vendor: str | None

version: str | None

org.accellera.spirit.v1_2.signal module

class org.accellera.spirit.v1_2.signal.Signal(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=None, signal_constraint_sets=None, vendor_extensions=None)

Bases: SignalType

Describes signal charateristics.

Parameters:

• name (str | None)

• direction (ComponentSignalDirectionType | None)

• left (Left | None)

• right (Right | None)

• default_value (SignalValueType | None)

• clock_driver (ClockDriver | None)

• single_shot_driver (SingleShotDriver | None)

• export (Export | None)

• signal_constraint_sets (SignalConstraintSets | None)

• vendor_extensions (VendorExtensions | None)

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

clock_driver: ClockDriver | None

default_value: SignalValueType | None

direction: ComponentSignalDirectionType | None

export: 'SignalType.Export' | None

left: 'SignalType.Left' | None

name: str | None

right: 'SignalType.Right' | None

signal_constraint_sets: SignalConstraintSets | None

single_shot_driver: SingleShotDriver | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.signal_constraint_sets module

class org.accellera.spirit.v1_2.signal_constraint_sets.SignalConstraintSets(signal_constraints=<factory>)

Bases: object

List of signalConstraints elements for a component signal.

Parameters:

signal_constraints (Iterable[SignalConstraints])

signal_constraints: Iterable[SignalConstraints]

org.accellera.spirit.v1_2.signal_constraints module

class org.accellera.spirit.v1_2.signal_constraints.SignalConstraints(drive_constraint=None, load_constraint=None, timing_constraint=<factory>, design_rule_constraints=None, constraint_set_id='default')

Bases: object

Defines constraints that apply to a component signal.

If multiple signalConstraints elements are used, each must have a unique value for the constraintSet attribute.

Parameters:

• drive_constraint (DriveConstraint | None)

• load_constraint (LoadConstraint | None)

• timing_constraint (Iterable[TimingConstraint])

• design_rule_constraints (DesignRuleConstraints | None)

• constraint_set_id (str)

constraint_set_id: str

design_rule_constraints: DesignRuleConstraints | None

drive_constraint: DriveConstraint | None

load_constraint: LoadConstraint | None

timing_constraint: Iterable[TimingConstraint]

org.accellera.spirit.v1_2.signal_type module

class org.accellera.spirit.v1_2.signal_type.SignalType(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=None, signal_constraint_sets=None, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the signal.

• direction

• left – Left vector bound.

• right – Right vector bound.

• default_value – The initial or default value on the signal.

• clock_driver

• single_shot_driver

• export – Specifies whether a signal is to be exported out of the module.

• signal_constraint_sets

• vendor_extensions

Parameters:

• name (str | None)

• direction (ComponentSignalDirectionType | None)

• left (Left | None)

• right (Right | None)

• default_value (SignalValueType | None)

• clock_driver (ClockDriver | None)

• single_shot_driver (SingleShotDriver | None)

• export (Export | None)

• signal_constraint_sets (SignalConstraintSets | None)

• vendor_extensions (VendorExtensions | None)

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

clock_driver: ClockDriver | None

default_value: SignalValueType | None

direction: ComponentSignalDirectionType | None

export: Export | None

left: Left | None

name: str | None

right: Right | None

signal_constraint_sets: SignalConstraintSets | None

single_shot_driver: SingleShotDriver | None

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.signal_value_type module

class org.accellera.spirit.v1_2.signal_value_type.SignalValueType(strength=<factory>, value=None)

Bases: object

Describes a signal value.

The signal value can be just a value (number), a strength, or both. If the “value” is not given, it should be considered an X (unknown). A weak strength with no value given is considered Z (tristate).

Parameters:

• strength (Iterable[Strength])

• value (Value | None)

strength: Iterable[Strength]

value: Value | None

org.accellera.spirit.v1_2.single_shot_driver module

class org.accellera.spirit.v1_2.single_shot_driver.SingleShotDriver(single_shot_offset=None, single_shot_value=None, single_shot_duration=None)

Bases: object

Describes a driven one-shot signal.

Variables:

• single_shot_offset – Time in nanoseconds until start of one- shot.

• single_shot_value – Value of signal after first edge of one- shot.

• single_shot_duration – Duration in nanoseconds of the one shot.

Parameters:

• single_shot_offset (SingleShotOffset | None)

• single_shot_value (SingleShotValue | None)

• single_shot_duration (SingleShotDuration | None)

class SingleShotDuration(value=<factory>, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: Iterable[float]

class SingleShotOffset(value=<factory>, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: Iterable[float]

class SingleShotValue(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

single_shot_duration: SingleShotDuration | None

single_shot_offset: SingleShotOffset | None

single_shot_value: SingleShotValue | None

org.accellera.spirit.v1_2.source_file_file_type module

class org.accellera.spirit.v1_2.source_file_file_type.SourceFileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_2.strength module

class org.accellera.spirit.v1_2.strength.Strength(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

The strength of the signal.

“strong” (default) or “weak”.

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (StrengthType | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: StrengthType | None

org.accellera.spirit.v1_2.strength_type module

class org.accellera.spirit.v1_2.strength_type.StrengthType(*values)

Bases: Enum

Describes a signal strength.

STRONG = 'strong'

WEAK = 'weak'

org.accellera.spirit.v1_2.subspace_ref_type module

class org.accellera.spirit.v1_2.subspace_ref_type.SubspaceRefType(base_address=None, bit_offset=None, parameter=<factory>, vendor_extensions=None, master_ref=None)

Bases: object

Address subspace type.

Its subspaceReference attribute references the subspace from which the dimensions are taken.

Variables:

• base_address

• bit_offset

• parameter – Any parameters that may apply to the subspace reference.

• vendor_extensions

• master_ref

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• master_ref (str | None)

base_address: BaseAddress | None

bit_offset: BitOffset | None

master_ref: str | None

parameter: Iterable[NameValuePairType]

vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_2.timed_path module

class org.accellera.spirit.v1_2.timed_path.TimedPath(path_specifier=None, delay=None, path_edge=None, delay_type=None)

Bases: object

Defines a point-to-point timing exception.

The pathEdge attribute can be used to restrict the constraint to rising or falling edges, and the delayType attribute can be used to restrict the constraint to imply a minimum path constraint or a maximum path constraint.

Parameters:

• path_specifier (PathSpecifier | None)

• delay (Delay | None)

• path_edge (EdgeValueType | None)

• delay_type (DelayValueType | None)

delay: Delay | None

delay_type: DelayValueType | None

path_edge: EdgeValueType | None

path_specifier: PathSpecifier | None

org.accellera.spirit.v1_2.timing_constraint module

class org.accellera.spirit.v1_2.timing_constraint.TimingConstraint(percent_of_period=None, delay=None, clock_edge=None, delay_type=None, clock_name=None)

Bases: object

Defines a timing constraint for the associated signal.

The constraint is relative to the clock specified by the clockName attribute. The clockEdge indicates which clock edge the constraint is associated with (default is rising edge). The delayType attribute can be specified to further refine the constraint.

Variables:

• percent_of_period – Defines a delay constraint value which is defined as a percentage of the corresponding clock cycle time.

• delay – Defines an absolute delay constraint value. The units attribute can be used to specify units if needed. The default units are ns.

• clock_edge

• delay_type

• clock_name

Parameters:

• percent_of_period (float | None)

• delay (Delay | None)

• clock_edge (EdgeValueType | None)

• delay_type (DelayValueType | None)

• clock_name (str | None)

clock_edge: EdgeValueType | None

clock_name: str | None

delay: Delay | None

delay_type: DelayValueType | None

percent_of_period: float | None

org.accellera.spirit.v1_2.transport_methods_transport_method module

class org.accellera.spirit.v1_2.transport_methods_transport_method.TransportMethodsTransportMethod(*values)

Bases: Enum

FILE = 'file'

org.accellera.spirit.v1_2.usage_type module

class org.accellera.spirit.v1_2.usage_type.UsageType(*values)

Bases: Enum

Describes the usage of an address block.

Variables:

• MEMORY – Denotes an address range that can be used for read- write or read-only data storage.

• REGISTER – Denotes an address block that is used to communicate with hardware.

• RESERVED – Denotes an address range that must remain unoccupied.

MEMORY = 'memory'

REGISTER = 'register'

RESERVED = 'reserved'

org.accellera.spirit.v1_2.value module

org.accellera.spirit.v1_2.vendor_extensions module

class org.accellera.spirit.v1_2.vendor_extensions.VendorExtensions(any_element=<factory>)

Bases: object

Container for vendor specific extensions.

Variables:

any_element – Accepts any element(s) the content provider wants to put here, including elements from the SPIRIT namespace.

Parameters:

any_element (Iterable[object])

any_element: Iterable[object]

org.accellera.spirit.v1_2.view_type module

class org.accellera.spirit.v1_2.view_type.ViewType(name='default', env_identifier=<factory>, hierarchy_ref=None, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, constraint_set_ref=<factory>, whitebox_element_refs=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Name of the view. Must be unique within a component.

• env_identifier – Defines the hardware environment in which this view applies. The format of the string is language:tool:vendor_extension, with each piece being optional. The language must be one of the types from spirit:fileType. The tool values are defined by the SPIRIT Consortium, and include generic values “*Simulation” and “*Synthesis” to imply any tool of the indicated type. Having more than one envIdentifier indicates that the view applies to multiple environments.

• hierarchy_ref – References a SPIRIT design or configuration document (by VLNV) that provides a design for the component

• language – The hardware description language used such as “verilog” or “vhdl”. If the attribute “strict” is “true”, this value must match the language being generated for the design.

• model_name – HDL-specific name to identify the model.

• default_file_builder

• file_set_ref

• constraint_set_ref

• whitebox_element_refs – Container for white box element references.

• parameter

• vendor_extensions

Parameters:

• name (str)

• env_identifier (Iterable[str])

• hierarchy_ref (LibraryRefType | None)

• language (Language | None)

• model_name (str | None)

• default_file_builder (Iterable[FileBuilderType])

• file_set_ref (Iterable[FileSetRef])

• constraint_set_ref (Iterable[ConstraintSetRef])

• whitebox_element_refs (WhiteboxElementRefs | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Language(value: str = '', strict: bool | None = None)

Bases: object

Parameters:

• value (str)

• strict (bool | None)

strict: bool | None

value: str

class WhiteboxElementRefs(whitebox_element_ref=<factory>)

Bases: object

Variables:

whitebox_element_ref – Reference to a white box element which is visible within this view.

Parameters:

whitebox_element_ref (Iterable[WhiteboxElementRefType])

whitebox_element_ref: Iterable[WhiteboxElementRefType]

constraint_set_ref: Iterable[ConstraintSetRef]

default_file_builder: Iterable[FileBuilderType]

env_identifier: Iterable[str]

file_set_ref: Iterable[FileSetRef]

hierarchy_ref: LibraryRefType | None

language: Language | None

model_name: str | None

name: str

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

whitebox_element_refs: WhiteboxElementRefs | None

org.accellera.spirit.v1_2.volatile module

class org.accellera.spirit.v1_2.volatile.Volatile(value=False)

Bases: object

Indicates whether the data is volatile, default to false when not present.

Parameters:

value (bool)

value: bool

org.accellera.spirit.v1_2.whitebox_element_ref_type module

class org.accellera.spirit.v1_2.whitebox_element_ref_type.WhiteboxElementRefType(whitebox_path=<factory>, name=None)

Bases: object

Reference to a whiteboxElement within a view.

The ‘name’ attribute must refer to a whiteboxElement defined within this component.

Variables:

• whitebox_path – The whiteboxPath elements (as a set) define the name(s) needed to define the entire white box element in this view.

• name

Parameters:

• whitebox_path (Iterable[WhiteboxPath])

• name (str | None)

class WhiteboxPath(path_name=None, left=None, right=None)

Bases: object

Variables:

• path_name – The view specific name for a portion of the white box element.

• left – Indicates the left bound value for the associated path name.

• right – Indicates the right bound values for the associated path name.

Parameters:

• path_name (str | None)

• left (int | None)

• right (int | None)

left: int | None

path_name: str | None

right: int | None

name: str | None

whitebox_path: Iterable[WhiteboxPath]

org.accellera.spirit.v1_2.whitebox_element_type module

class org.accellera.spirit.v1_2.whitebox_element_type.WhiteboxElementType(name=None, whitebox_type=None, driveable=None, description=None, register_ref=None)

Bases: object

Defines a white box reference point within the component.

Variables:

• name – Indicates the name of the white box element. This name is referenced from the whiteboxElementRef inside of a view.

• whitebox_type – Indicates the type of the element. The pin and signal types refer to elements within the HDL description. The register type refers to a register in the memory map. The interface type refers to a bus interface in a lower level component definition.

• driveable – If true, indicates that the white box element can be driven (e.g. have a new value forced into it).

• description – Description of the white box element.

• register_ref – Indicates the name of the register associated with this white box element. The name must refer to a spirit:register defined within this component. When specified, the whiteboxType must be ‘register’.

Parameters:

• name (str | None)

• whitebox_type (WhiteboxElementTypeWhiteboxType | None)

• driveable (bool | None)

• description (str | None)

• register_ref (str | None)

description: str | None

driveable: bool | None

name: str | None

register_ref: str | None

whitebox_type: WhiteboxElementTypeWhiteboxType | None

org.accellera.spirit.v1_2.whitebox_element_type_whitebox_type module

class org.accellera.spirit.v1_2.whitebox_element_type_whitebox_type.WhiteboxElementTypeWhiteboxType(*values)

Bases: Enum

INTERFACE = 'interface'

PIN = 'pin'

REGISTER = 'register'

SIGNAL = 'signal'

Module contents

class org.accellera.spirit.v1_2.Access(value=None)

Bases: object

Indicates the accessibility of the data in the address block.

Possible values are ‘read-write’, ‘read-only’ and ‘write-only’.

Parameters:

value (AccessType | None)

value: AccessType | None

class org.accellera.spirit.v1_2.AdHocConnection(export=None, pin_reference=<factory>, name=None)

Bases: object

Represents an ad-hoc connection between component pins.

Variables:

• export – Specifies whether this ad-hoc connection will be exported out of the design.

• pin_reference

• name

Parameters:

• export (Export | None)

• pin_reference (Iterable[PinReference])

• name (str | None)

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class PinReference(component_ref: str | None = None, signal_ref: str | None = None, left: int | None = None, right: int | None = None)

Bases: object

Parameters:

• component_ref (str | None)

• signal_ref (str | None)

• left (int | None)

• right (int | None)

component_ref: str | None

left: int | None

right: int | None

signal_ref: str | None

export: Export | None

name: str | None

pin_reference: Iterable[PinReference]

class org.accellera.spirit.v1_2.AdHocConnections(ad_hoc_connection=<factory>)

Bases: object

Defines the set of ad-hoc connections in a design.

An ad-hoc connection represents a connection between two component pins which were not connected as a result of interface connections (i.e.the pin to pin connection was made explicitly and is represented explicitly).

Parameters:

ad_hoc_connection (Iterable[AdHocConnection])

ad_hoc_connection: Iterable[AdHocConnection]

class org.accellera.spirit.v1_2.AddRemChange(value=None)

Bases: object

Indicates whether the alteration is an addition or a removal.

Parameters:

value (AddRemChangeValue | None)

value: AddRemChangeValue | None

class org.accellera.spirit.v1_2.AddRemChangeValue(*values)

Bases: Enum

ADD = 'add'

REMOVE = 'remove'

class org.accellera.spirit.v1_2.AddRemRepChange(value=None)

Bases: object

Indicates whether the alteration is an addition, removal or a replacement.

Parameters:

value (AddRemRepChangeValue | None)

value: AddRemRepChangeValue | None

class org.accellera.spirit.v1_2.AddRemRepChangeValue(*values)

Bases: Enum

ADD = 'add'

REMOVE = 'remove'

REPLACE = 'replace'

class org.accellera.spirit.v1_2.AddrSpaceRefType(address_space_ref=None)

Bases: object

Base type for an element which references an address space.

Reference is kept in an attribute rather than the text value, so that the type may be extended with child elements if necessary.

Parameters:

address_space_ref (str | None)

address_space_ref: str | None

class org.accellera.spirit.v1_2.AddressBankType(base_address=None, bit_offset=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameter=<factory>, vendor_extensions=None, bank_alignment=None)

Bases: object

Variables:

• base_address

• bit_offset

• address_block – An address block within the bank. No address information is supplied.

• bank – A nested bank of blocks within a bank. No address information is supplied.

• subspace_map

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• vendor_extensions

• bank_alignment

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• address_block (Iterable[BankedBlockType])

• bank (Iterable[BankedBankType])

• subspace_map (Iterable[BankedSubspaceType])

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• bank_alignment (BankAlignmentType | None)

access: Access | None

address_block: Iterable[BankedBlockType]

bank: Iterable[BankedBankType]

bank_alignment: BankAlignmentType | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

parameter: Iterable[NameValuePairType]

subspace_map: Iterable[BankedSubspaceType]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class org.accellera.spirit.v1_2.AddressBlock(base_address=None, bit_offset=None, range=None, width=None, endianness=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=None, name=None)

Bases: AddressBlockType

This is a single contiguous block of memory inside a memory map.

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• range (AddressBlockType.Range | None)

• width (AddressBlockType.Width | None)

• endianness (EndianessType | None)

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• register (Iterable[AddressBlockType.Register])

• vendor_extensions (VendorExtensions | None)

• name (str | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Register name.

• dim – Dimensions a register array, the semantics for dim elements are the same as the C language standard for the layout of memory in multidimensional arrays.

• address_offset – Offset from baseAddress.

• size – Size in bits.

• volatile

• access

• dependency – Indicates that this register has a dependency on the setting of another register.

• reset – Register value at reset.

• field_value – Describes individual bit fields within the register.

• description – Register description

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• dim (Iterable[int])

• address_offset (str | None)

• size (Size | None)

• volatile (Volatile | None)

• access (Access | None)

• dependency (Iterable[Dependency])

• reset (Reset | None)

• field_value (Iterable[FieldType])

• description (str | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Dependency(register_ref=None, field_ref=None, value=None, mask=None)

Bases: object

Variables:

• register_ref – The name of the register that enables this register.

• field_ref – Name of the field within the register that enables this register.

• value – Value that the enabling field must be set to to enable this register.

• mask – Mask to be anded with the value of the enabling field or register before comparing to the dependency value.

Parameters:

• register_ref (str | None)

• field_ref (str | None)

• value (str | None)

• mask (str | None)

field_ref: str | None

mask: str | None

register_ref: str | None

value: str | None

class Reset(value=None, mask=None)

Bases: object

Variables:

• value – The value itself.

• mask – Mask to be anded with the value before comparing to the reset value.

Parameters:

• value (str | None)

• mask (str | None)

mask: str | None

value: str | None

class Size(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

address_offset: str | None

dependency: Iterable[Dependency]

description: str | None

dim: Iterable[int]

field_value: Iterable[FieldType]

name: str | None

parameter: Iterable[Parameter]

reset: Reset | None

size: Size | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

endianness: EndianessType | None

name: str | None

parameter: Iterable[NameValuePairType]

range: 'AddressBlockType.Range' | None

register: Iterable['AddressBlockType.Register']

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

width: 'AddressBlockType.Width' | None

class org.accellera.spirit.v1_2.AddressBlockType(base_address=None, bit_offset=None, range=None, width=None, endianness=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=None, name=None)

Bases: object

Variables:

• base_address

• bit_offset

• range – The address range of an address block. Expressed as the number of addressable units accessable to the block.

• width – Bit width of an address block.

• endianness

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• register

• vendor_extensions

• name

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• range (Range | None)

• width (Width | None)

• endianness (EndianessType | None)

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• register (Iterable[Register])

• vendor_extensions (VendorExtensions | None)

• name (str | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Register name.

• dim – Dimensions a register array, the semantics for dim elements are the same as the C language standard for the layout of memory in multidimensional arrays.

• address_offset – Offset from baseAddress.

• size – Size in bits.

• volatile

• access

• dependency – Indicates that this register has a dependency on the setting of another register.

• reset – Register value at reset.

• field_value – Describes individual bit fields within the register.

• description – Register description

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• dim (Iterable[int])

• address_offset (str | None)

• size (Size | None)

• volatile (Volatile | None)

• access (Access | None)

• dependency (Iterable[Dependency])

• reset (Reset | None)

• field_value (Iterable[FieldType])

• description (str | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Dependency(register_ref=None, field_ref=None, value=None, mask=None)

Bases: object

Variables:

• register_ref – The name of the register that enables this register.

• field_ref – Name of the field within the register that enables this register.

• value – Value that the enabling field must be set to to enable this register.

• mask – Mask to be anded with the value of the enabling field or register before comparing to the dependency value.

Parameters:

• register_ref (str | None)

• field_ref (str | None)

• value (str | None)

• mask (str | None)

field_ref: str | None

mask: str | None

register_ref: str | None

value: str | None

class Reset(value=None, mask=None)

Bases: object

Variables:

• value – The value itself.

• mask – Mask to be anded with the value before comparing to the reset value.

Parameters:

• value (str | None)

• mask (str | None)

mask: str | None

value: str | None

class Size(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

address_offset: str | None

dependency: Iterable[Dependency]

description: str | None

dim: Iterable[int]

field_value: Iterable[FieldType]

name: str | None

parameter: Iterable[Parameter]

reset: Reset | None

size: Size | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

endianness: EndianessType | None

name: str | None

parameter: Iterable[NameValuePairType]

range: Range | None

register: Iterable[Register]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

width: Width | None

class org.accellera.spirit.v1_2.AddressSpaceRef(address_space_ref=None)

Bases: AddrSpaceRefType

References the address space.

The name of the address space is kept in its addressSpaceRef attribute.

Parameters:

address_space_ref (str | None)

address_space_ref: str | None

class org.accellera.spirit.v1_2.AddressSpaces(address_space=<factory>)

Bases: object

If this component is a bus master, this lists all the address spaces defined by the component.

Variables:

address_space – This defines a logical space, referenced by a bus master.

Parameters:

address_space (Iterable[AddressSpace])

class AddressSpace(name=None, range=None, width=None, bits_in_lau=None, endianness=None, executable_image=<factory>, local_memory_map=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the address space. Unique within the model.

• range – The address range of an address block. Expressed as the number of addressable units accessable to the block.

• width – Bit width of an address block.

• bits_in_lau

• endianness

• executable_image

• local_memory_map – Provides the local memory map of an address space. Blocks in this memory map are accessable to master interfaces on this component that reference this address space. They are not accessable to any external master interface.

• parameter – Data specific to this address space.

• vendor_extensions

Parameters:

• name (str | None)

• range (Range | None)

• width (Width | None)

• bits_in_lau (BitsInLau | None)

• endianness (EndianessType | None)

• executable_image (Iterable[ExecutableImage])

• local_memory_map (LocalMemoryMapType | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

bits_in_lau: BitsInLau | None

endianness: EndianessType | None

executable_image: Iterable[ExecutableImage]

local_memory_map: LocalMemoryMapType | None

name: str | None

parameter: Iterable[NameValuePairType]

range: Range | None

vendor_extensions: VendorExtensions | None

width: Width | None

address_space: Iterable[AddressSpace]

class org.accellera.spirit.v1_2.BankAlignmentType(*values)

Bases: Enum

‘serial’ or ‘parallel’ bank alignment.

PARALLEL = 'parallel'

SERIAL = 'serial'

class org.accellera.spirit.v1_2.BankedBankType(address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameter=<factory>, vendor_extensions=None, bank_alignment=None)

Bases: object

Banks nested inside a bank do not specify address.

Variables:

• address_block – An address block within the bank. No address information is supplied.

• bank – A nested bank of blocks within a bank. No address information is supplied.

• subspace_map

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• vendor_extensions

• bank_alignment

Parameters:

• address_block (Iterable[BankedBlockType])

• bank (Iterable[BankedBankType])

• subspace_map (Iterable[BankedSubspaceType])

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• bank_alignment (BankAlignmentType | None)

access: Access | None

address_block: Iterable[BankedBlockType]

bank: Iterable[BankedBankType]

bank_alignment: BankAlignmentType | None

parameter: Iterable[NameValuePairType]

subspace_map: Iterable[BankedSubspaceType]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class org.accellera.spirit.v1_2.BankedBlockType(range=None, width=None, endianness=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=None, name=None)

Bases: object

Address blocks inside a bank do not specify address.

Variables:

• range – The address range of an address block. Expressed as the number of addressable units accessable to the block.

• width – Bit width of an address block.

• endianness

• usage – Indicates the usage of this block. Possible values are ‘memory’, ‘register’ and ‘reserved’.

• volatile

• access

• parameter – Any additional parameters needed to describe this address block to the generators.

• register

• vendor_extensions

• name

Parameters:

• range (Range | None)

• width (Width | None)

• endianness (EndianessType | None)

• usage (UsageType | None)

• volatile (Volatile | None)

• access (Access | None)

• parameter (Iterable[NameValuePairType])

• register (Iterable[Register])

• vendor_extensions (VendorExtensions | None)

• name (object | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Register name.

• dim – Dimensions a register array, the semantics for dim elements are the same as the C language standard for the layout of memory in multidimensional arrays.

• address_offset – Offset from baseAddress.

• size – Size in bits.

• volatile

• access

• dependency – Indicates that this register has a dependency on the setting of another register.

• reset – Register value at reset.

• field_value – Describes individual bit fields within the register.

• description – Register description

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• dim (Iterable[int])

• address_offset (str | None)

• size (Size | None)

• volatile (Volatile | None)

• access (Access | None)

• dependency (Iterable[Dependency])

• reset (Reset | None)

• field_value (Iterable[FieldType])

• description (str | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Dependency(register_ref=None, field_ref=None, value=None, mask=None)

Bases: object

Variables:

• register_ref – The name of the register that enables this register.

• field_ref – Name of the field within the register that enables this register.

• value – Value that the enabling field must be set to to enable this register.

• mask – Mask to be anded with the value of the enabling field or register before comparing to the dependency value.

Parameters:

• register_ref (str | None)

• field_ref (str | None)

• value (str | None)

• mask (str | None)

field_ref: str | None

mask: str | None

register_ref: str | None

value: str | None

class Reset(value=None, mask=None)

Bases: object

Variables:

• value – The value itself.

• mask – Mask to be anded with the value before comparing to the reset value.

Parameters:

• value (str | None)

• mask (str | None)

mask: str | None

value: str | None

class Size(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

address_offset: str | None

dependency: Iterable[Dependency]

description: str | None

dim: Iterable[int]

field_value: Iterable[FieldType]

name: str | None

parameter: Iterable[Parameter]

reset: Reset | None

size: Size | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

class Width(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

access: Access | None

endianness: EndianessType | None

name: object | None

parameter: Iterable[NameValuePairType]

range: Range | None

register: Iterable[Register]

usage: UsageType | None

vendor_extensions: VendorExtensions | None

volatile: Volatile | None

width: Width | None

class org.accellera.spirit.v1_2.BankedSubspaceType(parameter=<factory>, vendor_extensions=None, master_ref=None)

Bases: object

Subspace references inside banks do not specify an address.

Variables:

• parameter – Any parameters that may apply to the subspace reference.

• vendor_extensions

• master_ref

Parameters:

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• master_ref (str | None)

master_ref: str | None

parameter: Iterable[NameValuePairType]

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.BaseAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Base Address:')

Bases: object

Base of an address block.

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

value: str

class org.accellera.spirit.v1_2.BitOffset(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Base bit offset of an address block.

If not included, it is assumed to be 0.

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class org.accellera.spirit.v1_2.BitSteeringType(*values)

Bases: Enum

OFF = 'off'

ON = 'on'

class org.accellera.spirit.v1_2.BitsInLau(value=None)

Bases: object

The number of bits in the least addressable unit.

The default is byte addressable (8 bits).

Parameters:

value (int | None)

value: int | None

class org.accellera.spirit.v1_2.BusDefSignalConstraintSets(bus_def_signal_constraints=<factory>)

Bases: object

List of busDefSignalConstraints elements for a bus definition signal.

Parameters:

bus_def_signal_constraints (Iterable[BusDefSignalConstraints])

bus_def_signal_constraints: Iterable[BusDefSignalConstraints]

class org.accellera.spirit.v1_2.BusDefSignalConstraints(timing_constraint=<factory>, design_rule_constraints=None, drive_constraint=None, load_constraint=None, constraint_set_id='default')

Bases: object

Defines constraints that apply to a signal in a bus definition.

If multiple busDefSignalConstraints are used, each must have a unique value of the constraintSet attribute. These constraints are carried over to the associated component signal as default values.

Parameters:

• timing_constraint (Iterable[TimingConstraint])

• design_rule_constraints (DesignRuleConstraints | None)

• drive_constraint (DriveConstraint | None)

• load_constraint (LoadConstraint | None)

• constraint_set_id (str)

constraint_set_id: str

design_rule_constraints: DesignRuleConstraints | None

drive_constraint: DriveConstraint | None

load_constraint: LoadConstraint | None

timing_constraint: Iterable[TimingConstraint]

class org.accellera.spirit.v1_2.BusDefinition(vendor=None, library=None, name=None, version=None, direct_connection=False, extends=None, max_masters=None, max_slaves=None, signals=None, choices=None, bus_def_parameters=None, vendor_extensions=None)

Bases: object

Defines the signals and high-level function of a bus.

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• direct_connection – This element indicates that a master interface may be directly connected to a slave interface (under certain conditions) for busses of this type.

• extends – Optional name of bus type that this bus definition is compatible with. This bus definition may change the definitions of signals in the existing bus definition and add new signals, the signals in the original bus are not deleted but may be marked illegal to disallow their use.

• max_masters – Indicates the maximum number of masters this bus supports. If this element is not present, the number of masters allowed is unbounded.

• max_slaves – Indicates the maximum number of slaves this bus supports. If the element is not present, the number of slaves allowed is unbounded.

• signals – This is a list of logical signals defined by the bus.

• choices

• bus_def_parameters – Container element for parameters defined for a bus definition.

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• direct_connection (bool)

• extends (LibraryRefType | None)

• max_masters (int | None)

• max_slaves (int | None)

• signals (Signals | None)

• choices (Choices | None)

• bus_def_parameters (BusDefParameters | None)

• vendor_extensions (VendorExtensions | None)

class BusDefParameters(bus_def_parameter=<factory>)

Bases: object

Variables:

bus_def_parameter – Defines a parameter which can be specified on a bus interface. The parameter is fully described on the bus definition and then instantiated on the bus interface. Setting ‘consistent’ to true implies that the parameter must have the same value on the corresponding bus interface parameters on both sides of connected interfaces.

Parameters:

bus_def_parameter (Iterable[BusDefParameter])

class BusDefParameter(value: str = '', consistent: bool = False, name: Optional[str] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_2.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_2.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_2.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_2.format_type.FormatType] = None, prompt: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>)

Bases: object

Parameters:

• value (str)

• consistent (bool)

• name (str | None)

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

consistent: bool

direction: DirectionValue | None

format: FormatType | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

value: str

bus_def_parameter: Iterable[BusDefParameter]

class Signals(signal: collections.abc.Iterable['BusDefinition.Signals.Signal'] = <factory>)

Bases: object

Parameters:

signal (Iterable[Signal])

class Signal(logical_name=None, is_address=None, is_data=None, is_clock=None, is_reset=None, requires_driver=None, on_system=<factory>, on_master=None, on_slave=None, default_value=None, bus_def_signal_constraint_sets=None, vendor_extensions=None)

Bases: object

Variables:

• logical_name – The assigned name of this signal in bus specifications.

• is_address – If this element is present, the signal contains address information.

• is_data – If this element is present, the signal contains data information.

• is_clock – If this element is present, the signal contains only clock information.

• is_reset – Is this element is present, the signal contains only reset information.

• requires_driver

• on_system – Defines constraints for this signal when present in a system bus interface with a matching group name.

• on_master – Defines constraints for this signal when present in a master bus interface.

• on_slave – Defines constraints for this signal when present in a slave bus interface.

• default_value – Default value for the signal when used as an input and it ends up being unconnected. Ignored for signals that require a singleShot or clock type driver. This value may be overridden by a defaultValue on a component pin.

• bus_def_signal_constraint_sets

• vendor_extensions

Parameters:

• logical_name (str | None)

• is_address (bool | None)

• is_data (bool | None)

• is_clock (bool | None)

• is_reset (bool | None)

• requires_driver (RequiresDriver | None)

• on_system (Iterable[OnSystem])

• on_master (OnMaster | None)

• on_slave (OnSlave | None)

• default_value (DefaultValue | None)

• bus_def_signal_constraint_sets (BusDefSignalConstraintSets | None)

• vendor_extensions (VendorExtensions | None)

class DefaultValue(value=None)

Bases: object

Variables:

value – The value of a signal. 1 or 0 for single bit signals, unsigned numeric otherwise.

Parameters:

value (str | None)

value: str | None

class OnMaster(bit_width=None, direction=None)

Bases: object

Variables:

• bit_width – Number of bits required to represent this signal. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this signal.

• direction – If this element is present, the direction of this signal is restricted to the specified value. The direction is relative to the non-mirrored interface. Use the value ‘illegal’ to indicate that this signal cannot appear in the interface.

Parameters:

• bit_width (int | None)

• direction (OnMasterValue | None)

bit_width: int | None

direction: OnMasterValue | None

class OnSlave(bit_width=None, direction=None)

Bases: object

Variables:

• bit_width – Number of bits required to represent this signal. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this signal.

• direction – If this element is present, the direction of this signal is restricted to the specified value. The direction is relative to the non-mirrored interface. Use the value ‘illegal’ to indicate that this signal cannot appear in the interface.

Parameters:

• bit_width (int | None)

• direction (OnSlaveValue | None)

bit_width: int | None

direction: OnSlaveValue | None

class OnSystem(group=None, bit_width=None, direction=None)

Bases: object

Variables:

• group – Used to group system signals into different groups within a common bus.

• bit_width – Number of bits required to represent this signal. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this signal.

• direction – If this element is present, the direction of this signal is restricted to the specified value. The direction is relative to the non-mirrored interface. Use the value ‘illegal’ to indicate that this signal cannot appear in the interface.

Parameters:

• group (str | None)

• bit_width (int | None)

• direction (OnSystemValue | None)

bit_width: int | None

direction: OnSystemValue | None

group: str | None

bus_def_signal_constraint_sets: BusDefSignalConstraintSets | None

default_value: DefaultValue | None

is_address: bool | None

is_clock: bool | None

is_data: bool | None

is_reset: bool | None

logical_name: str | None

on_master: OnMaster | None

on_slave: OnSlave | None

on_system: Iterable[OnSystem]

requires_driver: RequiresDriver | None

vendor_extensions: VendorExtensions | None

signal: Iterable[Signal]

bus_def_parameters: BusDefParameters | None

choices: Choices | None

direct_connection: bool

extends: LibraryRefType | None

library: str | None

max_masters: int | None

max_slaves: int | None

name: str | None

signals: Signals | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

class org.accellera.spirit.v1_2.BusInterface(name=None, bus_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection=None, signal_map=None, index=None, bit_steering=None, configurators=None, bus_interface_parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: BusInterfaceType

Describes one of the bus interfaces supported by this component.

Parameters:

• name (str | None)

• bus_type (LibraryRefType | None)

• master (BusInterfaceType.Master | None)

• slave (BusInterfaceType.Slave | None)

• system (BusInterfaceType.System | None)

• mirrored_slave (BusInterfaceType.MirroredSlave | None)

• mirrored_master (object | None)

• mirrored_system (BusInterfaceType.MirroredSystem | None)

• monitor (BusInterfaceType.Monitor | None)

• connection (BusInterfaceTypeConnection | None)

• signal_map (BusInterfaceType.SignalMap | None)

• index (BusInterfaceType.Index | None)

• bit_steering (BusInterfaceType.BitSteering | None)

• configurators (Configurators | None)

• bus_interface_parameters (BusInterfaceType.BusInterfaceParameters | None)

• vendor_extensions (VendorExtensions | None)

• any_attributes (Mapping[str, str])

class BitSteering(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (BitSteeringType | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: BitSteeringType | None

class BusInterfaceParameters(bus_interface_parameter=<factory>)

Bases: object

Variables:

bus_interface_parameter – Name/value pair defining a parameter on this bus interface. The name must match the name of a busDefParameter on the associated bus definition. Also, the interface type of this bus interface must be allowed as specified in the busDefParameter.

Parameters:

bus_interface_parameter (Iterable[BusInterfaceParameter])

class BusInterfaceParameter(value: str = '', name: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None)

Bases: object

Parameters:

• value (str)

• name (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

dependency: str | None

id: str | None

name: str | None

resolve: ResolveType

value: str

bus_interface_parameter: Iterable[BusInterfaceParameter]

class Index(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Connection Index:')

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Master(address_space_ref=None)

Bases: object

Variables:

address_space_ref – If this master connects to an addressable bus, this element references the address space it maps to. It has an addressSpaceRef attribute which is an addrSpaceID key ref.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref: str | None = None, base_address: org.accellera.spirit.v1_2.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_2.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:

• address_space_ref (str | None)

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

address_space_ref: str | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

address_space_ref: AddressSpaceRef | None

class MirroredSlave(base_addresses=None)

Bases: object

Variables:

base_addresses – Represents a set of remap base addresses.

Parameters:

base_addresses (BaseAddresses | None)

class BaseAddresses(remap_address=<factory>, range=None)

Bases: object

Variables:

• remap_address – Base of an address block. The state attribute indicates the name of the remap state for which this address is valid.

• range – The address range of mirrored slave.

Parameters:

• remap_address (Iterable[RemapAddress])

• range (Range | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Base Address:', state=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

• state – Name of the state in which this remapped address range is valid

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

• state (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

state: str | None

value: str

range: Range | None

remap_address: Iterable[RemapAddress]

base_addresses: BaseAddresses | None

class MirroredSystem(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

class Monitor(group: org.accellera.spirit.v1_2.group.Group | None = None, interface_type: org.accellera.spirit.v1_2.monitor_interface_type.MonitorInterfaceType | None = None)

Bases: object

Parameters:

• group (Group | None)

• interface_type (MonitorInterfaceType | None)

group: Group | None

interface_type: MonitorInterfaceType | None

class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(component_signal_name=None, bus_signal_name=None, left=None, right=None)

Bases: object

Variables:

• component_signal_name – Component signal name as specified inside the hardware model

• bus_signal_name – Bus signal name as specified inside the bus definition

• left – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

• right – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

• component_signal_name (str | None)

• bus_signal_name (str | None)

• left (Left | None)

• right (Right | None)

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

bus_signal_name: str | None

component_signal_name: str | None

left: Left | None

right: Right | None

signal_name: Iterable[SignalName]

class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

• memory_map_ref

• bridge – If this element is present, it indicates that the bus interface provides a bridge to another master bus interface on the same component. It has a masterRef attribute which contains the name of the other bus interface. It also has an opaque attribute to indicate that the bus bridge is opaque. Any slave interface can bridge to multiple master interfaces, and multiple slave interfaces can bridge to the same master interface.

• file_set_ref_group – This reference is used to point the filesets that are associated with this slave port. Depending on the slave port function, there may be completely different software drivers associated with the different ports.

Parameters:

• memory_map_ref (MemoryMapRef | None)

• bridge (Iterable[Bridge])

• file_set_ref_group (Iterable[FileSetRefGroup])

class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

• master_ref – The name of the master bus interface to which this interface bridges.

• opaque – If true (default) then this bridge is opaque; the whole of the address range is mappeed by the bridge and there are no gaps.

Parameters:

• master_ref (str | None)

• opaque (bool | None)

master_ref: str | None

opaque: bool | None

class FileSetRefGroup(group: Optional[str] = None, file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_2.file_set_ref.FileSetRef] = <factory>)

Bases: object

Parameters:

• group (str | None)

• file_set_ref (Iterable[FileSetRef])

file_set_ref: Iterable[FileSetRef]

group: str | None

bridge: Iterable[Bridge]

file_set_ref_group: Iterable[FileSetRefGroup]

memory_map_ref: MemoryMapRef | None

class System(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

any_attributes: Mapping[str, str]

bit_steering: 'BusInterfaceType.BitSteering' | None

bus_interface_parameters: 'BusInterfaceType.BusInterfaceParameters' | None

bus_type: LibraryRefType | None

configurators: Configurators | None

connection: BusInterfaceTypeConnection | None

index: 'BusInterfaceType.Index' | None

master: 'BusInterfaceType.Master' | None

mirrored_master: object | None

mirrored_slave: 'BusInterfaceType.MirroredSlave' | None

mirrored_system: 'BusInterfaceType.MirroredSystem' | None

monitor: 'BusInterfaceType.Monitor' | None

name: str | None

signal_map: 'BusInterfaceType.SignalMap' | None

slave: 'BusInterfaceType.Slave' | None

system: 'BusInterfaceType.System' | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.BusInterfaceType(name=None, bus_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection=None, signal_map=None, index=None, bit_steering=None, configurators=None, bus_interface_parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Variables:

• name – Uniquely names this bus interface.

• bus_type – The bus type of this interface. Refers to a bus description using vendor, library and name attributes.

• master – If this element is present, the bus interface can serve as a master. This element encapsulates additional information related to its role as master.

• slave – If this element is present, the bus interface can serve as a slave.

• system – If this element is present, the bus interface is a system interface, neither master nor slave, with a specific function on the bus.

• mirrored_slave – If this element is present, the bus interface represents a mirrored slave interface. All directional constraints on signals are reversed relative to the specification in the bus definition.

• mirrored_master – If this element is present, the bus interface represents a mirrored master interface. All directional constraints on signals are reversed relative to the specification in the bus definition.

• mirrored_system – If this element is present, the bus interface represents a mirrored system interface. All directional constraints on signals are reversed relative to the specification in the bus definition.

• monitor – Indicates that this is a (passive) monitor interface. All of the signals in the interface must be inputs. The type of interface to be monitored is specified with the required interfaceType attribute. The spirit:group element must be specified if monitoring a system interface.

• connection – Directs how a bus interface is connected when the component is added to a design already containing a bus owner. Default behavior is “explicit”.

• signal_map – Listing of maps between component signals and bus signals.

• index – Master or slave index of this bus interface’s connection on a bus. Only used on indexed buses.

• bit_steering – Indicates whether bit steering should be used to map this interface onto a bus of different data width. Values are “on”, “off” (defaults to “off”).

• configurators – Configuration generators for bus interfaces.

• bus_interface_parameters – Container element for parameters associated with a bus interface.

• vendor_extensions

• any_attributes

Parameters:

• name (str | None)

• bus_type (LibraryRefType | None)

• master (Master | None)

• slave (Slave | None)

• system (System | None)

• mirrored_slave (MirroredSlave | None)

• mirrored_master (object | None)

• mirrored_system (MirroredSystem | None)

• monitor (Monitor | None)

• connection (BusInterfaceTypeConnection | None)

• signal_map (SignalMap | None)

• index (Index | None)

• bit_steering (BitSteering | None)

• configurators (Configurators | None)

• bus_interface_parameters (BusInterfaceParameters | None)

• vendor_extensions (VendorExtensions | None)

• any_attributes (Mapping[str, str])

class BitSteering(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (BitSteeringType | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: BitSteeringType | None

class BusInterfaceParameters(bus_interface_parameter=<factory>)

Bases: object

Variables:

bus_interface_parameter – Name/value pair defining a parameter on this bus interface. The name must match the name of a busDefParameter on the associated bus definition. Also, the interface type of this bus interface must be allowed as specified in the busDefParameter.

Parameters:

bus_interface_parameter (Iterable[BusInterfaceParameter])

class BusInterfaceParameter(value: str = '', name: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None)

Bases: object

Parameters:

• value (str)

• name (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

dependency: str | None

id: str | None

name: str | None

resolve: ResolveType

value: str

bus_interface_parameter: Iterable[BusInterfaceParameter]

class Index(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Connection Index:')

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Master(address_space_ref=None)

Bases: object

Variables:

address_space_ref – If this master connects to an addressable bus, this element references the address space it maps to. It has an addressSpaceRef attribute which is an addrSpaceID key ref.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref: str | None = None, base_address: org.accellera.spirit.v1_2.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_2.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:

• address_space_ref (str | None)

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

address_space_ref: str | None

base_address: BaseAddress | None

bit_offset: BitOffset | None

address_space_ref: AddressSpaceRef | None

class MirroredSlave(base_addresses=None)

Bases: object

Variables:

base_addresses – Represents a set of remap base addresses.

Parameters:

base_addresses (BaseAddresses | None)

class BaseAddresses(remap_address=<factory>, range=None)

Bases: object

Variables:

• remap_address – Base of an address block. The state attribute indicates the name of the remap state for which this address is valid.

• range – The address range of mirrored slave.

Parameters:

• remap_address (Iterable[RemapAddress])

• range (Range | None)

class Range(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt='Base Address:', state=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

• state – Name of the state in which this remapped address range is valid

Parameters:

• value (str)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str)

• state (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str

range_type: RangeTypeType

resolve: ResolveType

state: str | None

value: str

range: Range | None

remap_address: Iterable[RemapAddress]

base_addresses: BaseAddresses | None

class MirroredSystem(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

class Monitor(group: org.accellera.spirit.v1_2.group.Group | None = None, interface_type: org.accellera.spirit.v1_2.monitor_interface_type.MonitorInterfaceType | None = None)

Bases: object

Parameters:

• group (Group | None)

• interface_type (MonitorInterfaceType | None)

group: Group | None

interface_type: MonitorInterfaceType | None

class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(component_signal_name=None, bus_signal_name=None, left=None, right=None)

Bases: object

Variables:

• component_signal_name – Component signal name as specified inside the hardware model

• bus_signal_name – Bus signal name as specified inside the bus definition

• left – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

• right – The optional elements left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

• component_signal_name (str | None)

• bus_signal_name (str | None)

• left (Left | None)

• right (Right | None)

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

bus_signal_name: str | None

component_signal_name: str | None

left: Left | None

right: Right | None

signal_name: Iterable[SignalName]

class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

• memory_map_ref

• bridge – If this element is present, it indicates that the bus interface provides a bridge to another master bus interface on the same component. It has a masterRef attribute which contains the name of the other bus interface. It also has an opaque attribute to indicate that the bus bridge is opaque. Any slave interface can bridge to multiple master interfaces, and multiple slave interfaces can bridge to the same master interface.

• file_set_ref_group – This reference is used to point the filesets that are associated with this slave port. Depending on the slave port function, there may be completely different software drivers associated with the different ports.

Parameters:

• memory_map_ref (MemoryMapRef | None)

• bridge (Iterable[Bridge])

• file_set_ref_group (Iterable[FileSetRefGroup])

class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

• master_ref – The name of the master bus interface to which this interface bridges.

• opaque – If true (default) then this bridge is opaque; the whole of the address range is mappeed by the bridge and there are no gaps.

Parameters:

• master_ref (str | None)

• opaque (bool | None)

master_ref: str | None

opaque: bool | None

class FileSetRefGroup(group: Optional[str] = None, file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_2.file_set_ref.FileSetRef] = <factory>)

Bases: object

Parameters:

• group (str | None)

• file_set_ref (Iterable[FileSetRef])

file_set_ref: Iterable[FileSetRef]

group: str | None

bridge: Iterable[Bridge]

file_set_ref_group: Iterable[FileSetRefGroup]

memory_map_ref: MemoryMapRef | None

class System(group: org.accellera.spirit.v1_2.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None

any_attributes: Mapping[str, str]

bit_steering: BitSteering | None

bus_interface_parameters: BusInterfaceParameters | None

bus_type: LibraryRefType | None

configurators: Configurators | None

connection: BusInterfaceTypeConnection | None

index: Index | None

master: Master | None

mirrored_master: object | None

mirrored_slave: MirroredSlave | None

mirrored_system: MirroredSystem | None

monitor: Monitor | None

name: str | None

signal_map: SignalMap | None

slave: Slave | None

system: System | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.BusInterfaceTypeConnection(*values)

Bases: Enum

Variables:

• REQUIRED – A bus instance is automatically chosen and the connection is made. Component addition fails if a suitable bus is not available.

• EXPLICIT – Connection of this bus interface is not made until the user explicitly requests connection.

EXPLICIT = 'explicit'

REQUIRED = 'required'

class org.accellera.spirit.v1_2.BusInterfaces(bus_interface=<factory>)

Bases: object

A list of bus interfaces supported by this component.

Parameters:

bus_interface (Iterable[BusInterface])

bus_interface: Iterable[BusInterface]

class org.accellera.spirit.v1_2.Capacitance(value=None, units=None)

Bases: object

Represents a simple capacitance value with optional units.

Parameters:

• value (float | None)

• units (CapacitanceValueUnitType | None)

units: CapacitanceValueUnitType | None

value: float | None

class org.accellera.spirit.v1_2.CapacitanceValueUnitType(*values)

Bases: Enum

Indicates legal units for capacitance values.

FF = 'ff'

PF = 'pf'

class org.accellera.spirit.v1_2.CellClassValueType(*values)

Bases: Enum

Indicates legal cell class values.

COMBINATIONAL = 'combinational'

SEQUENTIAL = 'sequential'

class org.accellera.spirit.v1_2.CellFunctionValueType(*values)

Bases: Enum

Indicates legal cell function values.

BUF = 'buf'

DFF = 'dff'

INV = 'inv'

LATCH = 'latch'

MUX21 = 'mux21'

NAND2 = 'nand2'

XOR2 = 'xor2'

class org.accellera.spirit.v1_2.CellSpecification(cell_function=None, cell_class=None, cell_name=None)

Bases: object

Used to indicate a particular technology library cell.

Use of cellName is discouraged since it is technology dependent.

Variables:

• cell_function – Defines a technology library cell in library independent fashion, based on specification of a cell function and strength.

• cell_class – Defines a technology library cell in library independent fashion, based on specification of a cell class and strength.

• cell_name – Defines a technology library cell by name. Use of this library dependent syntax is discouraged as it is not portable.

Parameters:

• cell_function (CellFunction | None)

• cell_class (CellClass | None)

• cell_name (CellName | None)

class CellClass(value: org.accellera.spirit.v1_2.cell_class_value_type.CellClassValueType | None = None, cell_strength: org.accellera.spirit.v1_2.cell_strength_value_type.CellStrengthValueType | None = None)

Bases: object

Parameters:

• value (CellClassValueType | None)

• cell_strength (CellStrengthValueType | None)

cell_strength: CellStrengthValueType | None

value: CellClassValueType | None

class CellFunction(value: org.accellera.spirit.v1_2.cell_function_value_type.CellFunctionValueType | None = None, cell_strength: org.accellera.spirit.v1_2.cell_strength_value_type.CellStrengthValueType | None = None)

Bases: object

Parameters:

• value (CellFunctionValueType | None)

• cell_strength (CellStrengthValueType | None)

cell_strength: CellStrengthValueType | None

value: CellFunctionValueType | None

class CellName(lib_cell_name: str | None = None, lib_pin_name: str | None = None)

Bases: object

Parameters:

• lib_cell_name (str | None)

• lib_pin_name (str | None)

lib_cell_name: str | None

lib_pin_name: str | None

cell_class: CellClass | None

cell_function: CellFunction | None

cell_name: CellName | None

class org.accellera.spirit.v1_2.CellStrengthValueType(*values)

Bases: Enum

Indicates legal cell strength values.

HIGH = 'high'

LOW = 'low'

MEDIAN = 'median'

class org.accellera.spirit.v1_2.Channels(channel=<factory>)

Bases: object

Lists all channel connections between mirror interfaces of this component.

Variables:

channel – Defines a set of mirrored interfaces of this component that are connected to one another.

Parameters:

channel (Iterable[Channel])

class Channel(name=None, max_masters=None, max_slaves=None, bus_interface_ref=<factory>)

Bases: object

Variables:

• name – Unique name for this channel.

• max_masters – Overrides the maxMasters value in the bus definition if this number is more restrictive.

• max_slaves – Overrides the maxSlaves value in the bus definition if this number is more restrictive.

• bus_interface_ref – Contains the name of one of the bus interfaces that is part of this channel. The ordering of the references may be important to the design environment.

Parameters:

• name (object | None)

• max_masters (int | None)

• max_slaves (int | None)

• bus_interface_ref (Iterable[str])

bus_interface_ref: Iterable[str]

max_masters: int | None

max_slaves: int | None

name: object | None

channel: Iterable[Channel]

class org.accellera.spirit.v1_2.CheckValueType(*values)

Bases: Enum

Indicates legal values for type of checking the paths apply to: setup or hold.

HOLD = 'hold'

SETUP = 'setup'

class org.accellera.spirit.v1_2.ChoiceStyleValue(*values)

Bases: Enum

Variables:

• RADIO – Display choice as radio buttons (default).

• COMBO – Display choice as combo box.

COMBO = 'combo'

RADIO = 'radio'

class org.accellera.spirit.v1_2.Choices(choice=<factory>)

Bases: object

Choices used by user defined properties of spirit:formatType =”choice”.

Variables:

choice – Non-empty set of legal values for a user defined property of type spirit:formatType=”choice” .

Parameters:

choice (Iterable[Choice])

class Choice(name=None, enumeration=<factory>)

Bases: object

Variables:

• name – Choice key, available for reference by the spirit:choiceRef attribute of user defined properties of type spirit:formatType=”choice”.

• enumeration – A possible value of spirit:choice

Parameters:

• name (str | None)

• enumeration (Iterable[Enumeration])

class Enumeration(value='', text=None, help=None)

Bases: object

Variables:

• value

• text – When specified, displayed in place of the spirit:enumeration value

• help – Text that may be displayed if the user requests help about the meaning of an element

Parameters:

• value (str)

• text (str | None)

• help (str | None)

help: str | None

text: str | None

value: str

enumeration: Iterable[Enumeration]

name: str | None

choice: Iterable[Choice]

class org.accellera.spirit.v1_2.ClockDriver(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None, clock_name=None, clock_source=None)

Bases: object

Describes a driven clock signal.

For clock drivers that are not directly associated with a signal, the clockName attribute can be used to associate a name with the clock. The clockSource attribute can be used on these clocks to indicate the actual clock source (e.g. an output pin of a clock generator cell).

Variables:

• clock_period – Clock period in units defined by the units attribute. Default is nanoseconds.

• clock_pulse_offset – Time until first pulse. Units are defined by the units attribute. Default is nanoseconds.

• clock_pulse_value – Value of signal after first clock edge.

• clock_pulse_duration – Duration of first state in cycle. Units are defined by the units attribute. Default is nanoseconds.

• clock_name

• clock_source

Parameters:

• clock_period (ClockPeriod | None)

• clock_pulse_offset (ClockPulseOffset | None)

• clock_pulse_value (ClockPulseValue | None)

• clock_pulse_duration (ClockPulseDuration | None)

• clock_name (str | None)

• clock_source (str | None)

class ClockPeriod(value=<factory>, units=DelayValueUnitType.NS, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• units

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• units (DelayValueUnitType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

units: DelayValueUnitType

value: Iterable[float]

class ClockPulseDuration(value=<factory>, units=DelayValueUnitType.NS, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• units

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• units (DelayValueUnitType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

units: DelayValueUnitType

value: Iterable[float]

class ClockPulseOffset(value=<factory>, units=DelayValueUnitType.NS, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• units

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• units (DelayValueUnitType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

units: DelayValueUnitType

value: Iterable[float]

class ClockPulseValue(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

clock_name: str | None

clock_period: ClockPeriod | None

clock_pulse_duration: ClockPulseDuration | None

clock_pulse_offset: ClockPulseOffset | None

clock_pulse_value: ClockPulseValue | None

clock_source: str | None

class org.accellera.spirit.v1_2.Component(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, configurators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, component_constraint_sets=None, other_clock_drivers=None, parameter=<factory>, vendor_extensions=None)

Bases: ComponentType

This is the root element for all non platform-core components.

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• bus_interfaces (BusInterfaces | None)

• channels (Channels | None)

• remap_states (RemapStates | None)

• address_spaces (AddressSpaces | None)

• memory_maps (MemoryMaps | None)

• model (Model | None)

• component_generators (ComponentGenerators | None)

• configurators (Configurators | None)

• choices (Choices | None)

• file_sets (FileSets | None)

• whitebox_elements (ComponentType.WhiteboxElements | None)

• cpus (ComponentType.Cpus | None)

• component_constraint_sets (ComponentConstraintSets | None)

• other_clock_drivers (OtherClocks | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Cpus(cpu=<factory>)

Bases: object

Variables:

cpu – Describes a processor in this component.

Parameters:

cpu (Iterable[Cpu])

class Cpu(name=None, address_space_ref=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the cpu instance relative to the platform core.

• address_space_ref – Indicates which address space maps into this cpu.

• parameter – Data specific to the cpu.

• vendor_extensions

Parameters:

• name (str | None)

• address_space_ref (Iterable[AddressSpaceRef])

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

address_space_ref: Iterable[AddressSpaceRef]

name: str | None

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

cpu: Iterable[Cpu]

class WhiteboxElements(whitebox_element: collections.abc.Iterable[org.accellera.spirit.v1_2.whitebox_element_type.WhiteboxElementType] = <factory>)

Bases: object

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]

address_spaces: AddressSpaces | None

bus_interfaces: BusInterfaces | None

channels: Channels | None

choices: Choices | None

component_constraint_sets: ComponentConstraintSets | None

component_generators: ComponentGenerators | None

configurators: Configurators | None

cpus: 'ComponentType.Cpus' | None

file_sets: FileSets | None

library: str | None

memory_maps: MemoryMaps | None

model: Model | None

name: str | None

other_clock_drivers: OtherClocks | None

parameter: Iterable[Parameter]

remap_states: RemapStates | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

whitebox_elements: 'ComponentType.WhiteboxElements' | None

class org.accellera.spirit.v1_2.ComponentConstraintSets(component_constraints=<factory>)

Bases: object

List of componentConstraints elements for this component.

Parameters:

component_constraints (Iterable[ComponentConstraints])

component_constraints: Iterable[ComponentConstraints]

class org.accellera.spirit.v1_2.ComponentConstraints(design_rule_constraints=None, false_path=<factory>, multi_cycle_path=<factory>, timed_path=<factory>, constraint_set_id='default')

Bases: object

Defines the set of implementation constraints associated with a component.

If multiple componentConstraints elements are used, each must have a unique value for the constraintSet attribute.

Parameters:

• design_rule_constraints (DesignRuleConstraints | None)

• false_path (Iterable[FalsePath])

• multi_cycle_path (Iterable[MultiCyclePath])

• timed_path (Iterable[TimedPath])

• constraint_set_id (str)

constraint_set_id: str

design_rule_constraints: DesignRuleConstraints | None

false_path: Iterable[FalsePath]

multi_cycle_path: Iterable[MultiCyclePath]

timed_path: Iterable[TimedPath]

class org.accellera.spirit.v1_2.ComponentGenerator(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE, hidden=False)

Bases: InstanceGeneratorType

Specifies a set of component generators.

The scope attribute applies to component generators and specifies whether the generator should be run for each instance of the entity (or module) or just once for all instances of the entity.

Variables:

hidden – If this attribute is true then the generator should not be presented to the user, it may be part of a chain and has no useful meaning when invoked standalone.

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (GeneratorType.TransportMethods | None)

• lgi_access_type (GeneratorType.LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

• group (Iterable[str])

• scope (InstanceGeneratorTypeScope)

• hidden (bool)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

group: Iterable[str]

hidden: bool

lgi_access_type: 'GeneratorType.LgiAccessType' | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

scope: InstanceGeneratorTypeScope

transport_methods: 'GeneratorType.TransportMethods' | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.ComponentGenerators(component_generator=<factory>)

Bases: object

List of component generators.

Parameters:

component_generator (Iterable[ComponentGenerator])

component_generator: Iterable[ComponentGenerator]

class org.accellera.spirit.v1_2.ComponentInstance(instance_name=None, component_ref=None, configuration=None, vendor_extensions=None)

Bases: object

Component instance element.

The instance name is contained in the unique-value instanceName attribute.

Variables:

• instance_name

• component_ref – References a component to be found in an external library. The name attribute gives the name of the component and the version attribute speicifies which version of the component to use.

• configuration

• vendor_extensions

Parameters:

• instance_name (InstanceName | None)

• component_ref (LibraryRefType | None)

• configuration (Configuration | None)

• vendor_extensions (VendorExtensions | None)

component_ref: LibraryRefType | None

configuration: Configuration | None

instance_name: InstanceName | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.ComponentInstances(component_instance=<factory>)

Bases: object

Sub instances of internal components.

Parameters:

component_instance (Iterable[ComponentInstance])

component_instance: Iterable[ComponentInstance]

class org.accellera.spirit.v1_2.ComponentSignalDirectionType(*values)

Bases: Enum

The direction of a component signal.

IN = 'in'

INOUT = 'inout'

OUT = 'out'

class org.accellera.spirit.v1_2.ComponentType(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, configurators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, component_constraint_sets=None, other_clock_drivers=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Component-specific extension to componentType.

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• bus_interfaces

• channels

• remap_states

• address_spaces

• memory_maps

• model

• component_generators – Generator list is tools-specific.

• configurators

• choices

• file_sets

• whitebox_elements

• cpus – cpu’s in the component

• component_constraint_sets

• other_clock_drivers – Defines a set of clock drivers that are not directly associated with an input signal of the component.

• parameter

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• bus_interfaces (BusInterfaces | None)

• channels (Channels | None)

• remap_states (RemapStates | None)

• address_spaces (AddressSpaces | None)

• memory_maps (MemoryMaps | None)

• model (Model | None)

• component_generators (ComponentGenerators | None)

• configurators (Configurators | None)

• choices (Choices | None)

• file_sets (FileSets | None)

• whitebox_elements (WhiteboxElements | None)

• cpus (Cpus | None)

• component_constraint_sets (ComponentConstraintSets | None)

• other_clock_drivers (OtherClocks | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Cpus(cpu=<factory>)

Bases: object

Variables:

cpu – Describes a processor in this component.

Parameters:

cpu (Iterable[Cpu])

class Cpu(name=None, address_space_ref=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the cpu instance relative to the platform core.

• address_space_ref – Indicates which address space maps into this cpu.

• parameter – Data specific to the cpu.

• vendor_extensions

Parameters:

• name (str | None)

• address_space_ref (Iterable[AddressSpaceRef])

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

address_space_ref: Iterable[AddressSpaceRef]

name: str | None

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

cpu: Iterable[Cpu]

class WhiteboxElements(whitebox_element: collections.abc.Iterable[org.accellera.spirit.v1_2.whitebox_element_type.WhiteboxElementType] = <factory>)

Bases: object

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]

address_spaces: AddressSpaces | None

bus_interfaces: BusInterfaces | None

channels: Channels | None

choices: Choices | None

component_constraint_sets: ComponentConstraintSets | None

component_generators: ComponentGenerators | None

configurators: Configurators | None

cpus: Cpus | None

file_sets: FileSets | None

library: str | None

memory_maps: MemoryMaps | None

model: Model | None

name: str | None

other_clock_drivers: OtherClocks | None

parameter: Iterable[Parameter]

remap_states: RemapStates | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

whitebox_elements: WhiteboxElements | None

class org.accellera.spirit.v1_2.ConfigurableElement(reference_id=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None, content=<factory>)

Bases: object

Describes the content of a configurable element.

The required referenceId attribute refers to the ID attribute of the configurable element.

Variables:

• reference_id

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

• content

Parameters:

• reference_id (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• content (Iterable[object])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

content: Iterable[object]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

reference_id: str | None

resolve: ResolveType

class org.accellera.spirit.v1_2.Configuration(configurable_element=<factory>)

Bases: object

All configuration information for a contained component or channel instance.

Parameters:

configurable_element (Iterable[ConfigurableElement])

configurable_element: Iterable[ConfigurableElement]

class org.accellera.spirit.v1_2.ConfiguratorRef(value='')

Bases: object

A reference to a configurator element.

Parameters:

value (str)

value: str

class org.accellera.spirit.v1_2.Configurators(any_element=<factory>, any_attributes=<factory>)

Bases: object

Set of configurators on a configurable object.

The contents of this container element are undefined for version 1.0 of the SPIRIT schema. It is expected that the contents will be defined when the tight generator interface is available. In this release only ‘default’ configurators are supported.

Variables:

• any_element – Accepts any element(s) the content provider wants to put here, including elements from the SPIRIT namespace.

• any_attributes

Parameters:

• any_element (Iterable[object])

• any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]

any_element: Iterable[object]

class org.accellera.spirit.v1_2.ConstraintSetRef(value='')

Bases: object

A reference to a set of constraints (signalConstraints, componentConstraints, or busDefConstraints).

Parameters:

value (str)

value: str

class org.accellera.spirit.v1_2.DataTypeType(*values)

Bases: Enum

Enumerates C argument data types.

CHAR = 'char *'

DOUBLE = 'double'

FLOAT = 'float'

INT = 'int'

LONG = 'long'

UNSIGNED_INT = 'unsigned int'

UNSIGNED_LONG = 'unsigned long'

VOID = 'void *'

class org.accellera.spirit.v1_2.Delay(value=None, units=None)

Bases: object

Represents a simple delay value with optional units.

Parameters:

• value (float | None)

• units (DelayValueUnitType | None)

units: DelayValueUnitType | None

value: float | None

class org.accellera.spirit.v1_2.DelayValueType(*values)

Bases: Enum

Indicates the type of delay value - minimum or maximum delay.

MAX = 'max'

MIN = 'min'

class org.accellera.spirit.v1_2.DelayValueUnitType(*values)

Bases: Enum

Indicates legal units for delay values.

NS = 'ns'

PS = 'ps'

class org.accellera.spirit.v1_2.Dependency(value='')

Bases: object

Specifies a location on which files or fileSets may be dependent.

Typically, this would be a directory that would contain included files.

Parameters:

value (str)

value: str

class org.accellera.spirit.v1_2.Design(vendor=None, library=None, name=None, version=None, component_instances=None, interconnections=None, ad_hoc_connections=None, hier_connections=None, vendor_extensions=None)

Bases: object

Root element for a platform design.

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• component_instances

• interconnections

• ad_hoc_connections

• hier_connections – A list of hierarchy connections between bus interfaces on component instances and the bus interfaces on the encompassing component.

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• component_instances (ComponentInstances | None)

• interconnections (Interconnections | None)

• ad_hoc_connections (AdHocConnections | None)

• hier_connections (HierConnections | None)

• vendor_extensions (VendorExtensions | None)

class HierConnections(hier_connection=<factory>)

Bases: object

Variables:

hier_connection – Represents a hierarchy connection

Parameters:

hier_connection (Iterable[HierConnection])

class HierConnection(component_ref=None, interface_ref=None, vendor_extensions=None, interface_name=None)

Bases: object

Variables:

• component_ref – This is the instance name of the component which owns the busInterface that is to be exported

• interface_ref – This is the name of the bus interface on the instance

• vendor_extensions

• interface_name – This is the name of the bus interface on the upper level component.

Parameters:

• component_ref (str | None)

• interface_ref (str | None)

• vendor_extensions (VendorExtensions | None)

• interface_name (str | None)

component_ref: str | None

interface_name: str | None

interface_ref: str | None

vendor_extensions: VendorExtensions | None

hier_connection: Iterable[HierConnection]

ad_hoc_connections: AdHocConnections | None

component_instances: ComponentInstances | None

hier_connections: HierConnections | None

interconnections: Interconnections | None

library: str | None

name: str | None

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

class org.accellera.spirit.v1_2.DesignConfiguration(vendor=None, library=None, name=None, version=None, design_ref=None, pmd_configuration=<factory>, generator_chain_configuration=<factory>, view_configuration=<factory>, vendor_extensions=None)

Bases: object

Top level element for describing the current configuration of a design.

Does not describe instance parameterization

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• design_ref – The design to which this configuration applies

• pmd_configuration – Contains the configurable information associated with a particular PMD

• generator_chain_configuration – Contains the configurable information associated with a generatorChain and its generators. Note that configurable information for generators associated with components is stored in the design file.

• view_configuration – Contains the active view for each instance in the design

• vendor_extensions

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• design_ref (LibraryRefType | None)

• pmd_configuration (Iterable[PmdConfiguration])

• generator_chain_configuration (Iterable[GeneratorChainConfiguration])

• view_configuration (Iterable[ViewConfiguration])

• vendor_extensions (VendorExtensions | None)

class GeneratorChainConfiguration(generator_chain_ref=None, configurable_element=<factory>, generators=<factory>)

Bases: object

Variables:

• generator_chain_ref – References a generatorChain.

• configurable_element

• generators – Stores configurable information for generators referenced in the chain

Parameters:

• generator_chain_ref (LibraryRefType | None)

• configurable_element (Iterable[ConfigurableElement])

• generators (Iterable[Generators])

class Generators(generator_name=None, configurable_element=<factory>)

Bases: object

Variables:

• generator_name – This identifies the generator in the chain.

• configurable_element

Parameters:

• generator_name (str | None)

• configurable_element (Iterable[ConfigurableElement])

configurable_element: Iterable[ConfigurableElement]

generator_name: str | None

configurable_element: Iterable[ConfigurableElement]

generator_chain_ref: LibraryRefType | None

generators: Iterable[Generators]

class PmdConfiguration(pmd_ref=None, configurable_element=<factory>)

Bases: object

Variables:

• pmd_ref – References a PMD.

• configurable_element

Parameters:

• pmd_ref (LibraryRefType | None)

• configurable_element (Iterable[ConfigurableElement])

configurable_element: Iterable[ConfigurableElement]

pmd_ref: LibraryRefType | None

class ViewConfiguration(instance_name=None, view_name=None)

Bases: object

Variables:

• instance_name

• view_name – The name of the active view for this instance

Parameters:

• instance_name (InstanceName | None)

• view_name (str | None)

instance_name: InstanceName | None

view_name: str | None

design_ref: LibraryRefType | None

generator_chain_configuration: Iterable[GeneratorChainConfiguration]

library: str | None

name: str | None

pmd_configuration: Iterable[PmdConfiguration]

vendor: str | None

vendor_extensions: VendorExtensions | None

version: str | None

view_configuration: Iterable[ViewConfiguration]

class org.accellera.spirit.v1_2.DesignRuleConstraints(min_cap=None, max_cap=None, min_transition=None, max_transition=None, max_fanout=None)

Bases: object

Defines signal and/or component constraints associated with circuit design rules.

Variables:

• min_cap – Minimum capacitance value for this component or signal. The units attribute can be used to indicate the units associated with the capacitance value. Default unit value is ‘pf’.

• max_cap – Maximum capacitance value for this component or signal.

• min_transition – Minimum transition delay for this component or signal.

• max_transition – Maximum transition delay for this component or signal.

• max_fanout – Maximum fanout value for this component or signal.

Parameters:

• min_cap (Capacitance | None)

• max_cap (Capacitance | None)

• min_transition (MinTransition | None)

• max_transition (MaxTransition | None)

• max_fanout (int | None)

class MaxTransition(rise_delay=None, fall_delay=None)

Bases: object

Variables:

• rise_delay – Maximum transition delay for a rising edge transition for this component or signal.

• fall_delay – Maximum transition delay for a falling edge transition for this component or signal.

Parameters:

• rise_delay (Delay | None)

• fall_delay (Delay | None)

fall_delay: Delay | None

rise_delay: Delay | None

class MinTransition(rise_delay=None, fall_delay=None)

Bases: object

Variables:

• rise_delay – Minimum transition delay for a rising edge transition for this component or signal.

• fall_delay – Minimum transition delay for a falling edge transition for this component or signal.

Parameters:

• rise_delay (Delay | None)

• fall_delay (Delay | None)

fall_delay: Delay | None

rise_delay: Delay | None

max_cap: Capacitance | None

max_fanout: int | None

max_transition: MaxTransition | None

min_cap: Capacitance | None

min_transition: MinTransition | None

class org.accellera.spirit.v1_2.DirectionValue(*values)

Bases: Enum

Variables:

• VERTICAL – Display radio buttons vertically

• HORIZONTAL – Display radio buttons horizontally (default)

HORIZONTAL = 'horizontal'

VERTICAL = 'vertical'

class org.accellera.spirit.v1_2.DriveConstraint(cell_specification=None, resistance=None)

Bases: object

Defines a constraint indicating how an input is to be driven.

The preferred methodology is to specify a library cell in technology independent fashion. The implemention tool should assume that the associated signal is driven by the specified cell, or that the drive strength of the input signal is indicated by the specified resistance value.

Variables:

• cell_specification

• resistance – Specifes a drive resistance for the input signal.

Parameters:

• cell_specification (CellSpecification | None)

• resistance (Resistance | None)

cell_specification: CellSpecification | None

resistance: Resistance | None

class org.accellera.spirit.v1_2.EdgeValueType(*values)

Bases: Enum

Indicates legal values for edge specification attributes.

FALL = 'fall'

RISE = 'rise'

class org.accellera.spirit.v1_2.EndianessType(*values)

Bases: Enum

Specifies the data storage as “big” or “little” endian.

BIG = 'big'

LITTLE = 'little'

class org.accellera.spirit.v1_2.ExecutableImage(name=None, parameter=<factory>, language_tools=None, file_set_ref_group=None, vendor_extensions=None, id=None, image_type=None)

Bases: object

Specifies an executable software image to be loaded into a processors address space.

The format of the image is not specified. It could, for example, be an ELF loadfile, or it could be raw binary or ascii hex data for loading directly into a memory model instance.

Variables:

• name – Name of the executable image file.

• parameter – Additional information about the load module, e.g. stack base addresses, table addresses, etc.

• language_tools – Default commands and flags for software language tools needed to build the executable image.

• file_set_ref_group – Contains a group of file set references that indicates the set of file sets complying with the tool set of the current executable image.

• vendor_extensions

• id

• image_type

Parameters:

• name (Name | None)

• parameter (Iterable[Parameter])

• language_tools (LanguageTools | None)

• file_set_ref_group (FileSetRefGroup | None)

• vendor_extensions (VendorExtensions | None)

• id (str | None)

• image_type (str | None)

class FileSetRefGroup(file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_2.file_set_ref.FileSetRef] = <factory>)

Bases: object

Parameters:

file_set_ref (Iterable[FileSetRef])

file_set_ref: Iterable[FileSetRef]

class LanguageTools(file_builder=<factory>, linker=None, linker_flags=None, linker_command_file=None)

Bases: object

Variables:

• file_builder – A generic placeholder for any file builder like compilers and assemblers. It contains the file types to which the command should be applied, and the flags to be used with that command.

• linker

• linker_flags

• linker_command_file – Specifies a linker command file.

Parameters:

• file_builder (Iterable[FileBuilder])

• linker (Linker | None)

• linker_flags (LinkerFlags | None)

• linker_command_file (LinkerCommandFile | None)

class FileBuilder(file_type=None, user_file_type=None, command=None, flags=None, replace_default_flags=None, vendor_extensions=None)

Bases: object

Variables:

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

• command – Default command used to build files of the specified fileType.

• flags – Flags given to the build command when building files of this type.

• replace_default_flags – If true, replace any default flags value with the value in the sibling flags element. Otherwise, append the contents of the sibling flags element to any default flags value. If the value is true and the “flags” element is empty or missing, this will have the result of clearing any default flags value.

• vendor_extensions

Parameters:

• file_type (FileBuilderFileType | None)

• user_file_type (str | None)

• command (Command | None)

• flags (Flags | None)

• replace_default_flags (ReplaceDefaultFlags | None)

• vendor_extensions (VendorExtensions | None)

class Command(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Flags(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class ReplaceDefaultFlags(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

command: Command | None

file_type: FileBuilderFileType | None

flags: Flags | None

replace_default_flags: ReplaceDefaultFlags | None

user_file_type: str | None

vendor_extensions: VendorExtensions | None

class Linker(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class LinkerCommandFile(name=None, command_line_switch=None, enable=None, configurator_ref=None, generator_ref=<factory>)

Bases: object

Variables:

• name – Linker command file name.

• command_line_switch – The command line switch to specify the linker command file.

• enable – Specifies whether to generate and enable the linker command file.

• configurator_ref

• generator_ref

Parameters:

• name (Name | None)

• command_line_switch (CommandLineSwitch | None)

• enable (Enable | None)

• configurator_ref (ConfiguratorRef | None)

• generator_ref (Iterable[GeneratorRef])

class CommandLineSwitch(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Enable(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class Name(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

command_line_switch: CommandLineSwitch | None

configurator_ref: ConfiguratorRef | None

enable: Enable | None

generator_ref: Iterable[GeneratorRef]

name: Name | None

class LinkerFlags(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_builder: Iterable[FileBuilder]

linker: Linker | None

linker_command_file: LinkerCommandFile | None

linker_flags: LinkerFlags | None

class Name(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_set_ref_group: FileSetRefGroup | None

id: str | None

image_type: str | None

language_tools: LanguageTools | None

name: Name | None

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.FalsePath(path_specifier=None, path_edge=None, path_type=None)

Bases: object

Defines a false path timing exception.

Parameters:

• path_specifier (PathSpecifier | None)

• path_edge (EdgeValueType | None)

• path_type (CheckValueType | None)

path_edge: EdgeValueType | None

path_specifier: PathSpecifier | None

path_type: CheckValueType | None

class org.accellera.spirit.v1_2.FieldType(name=None, bit_offset=None, bit_width=None, access=None, description=None, values=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Field name.

• bit_offset – Offset of this field’s lsb from bit 0 of the register.

• bit_width – Width of the field in bits.

• access

• description – Bit field description.

• values – Enumerates specific values that can be assigned to the bit field.

• parameter

• vendor_extensions

Parameters:

• name (str | None)

• bit_offset (int | None)

• bit_width (BitWidth | None)

• access (Access | None)

• description (str | None)

• values (Iterable[Values])

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class BitWidth(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Values(value=None, description=None, name=None)

Bases: object

Variables:

• value – Enumerated bit field value.

• description – Description of a bit field value.

• name – The name of this enumerated value. This may be used as a token in generating code.

Parameters:

• value (str | None)

• description (str | None)

• name (str | None)

description: str | None

name: str | None

value: str | None

access: Access | None

bit_offset: int | None

bit_width: BitWidth | None

description: str | None

name: str | None

parameter: Iterable[Parameter]

values: Iterable[Values]

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.File(name=None, file_type=<factory>, user_file_type=<factory>, logical_name=None, exported_name=<factory>, build_command=None, dependency=<factory>, define=<factory>, image_type=<factory>, vendor_extensions=None, file_id=None, any_attributes=<factory>)

Bases: object

SPIRIT reference to a file or directory.

Variables:

• name – Path to the file or directory.

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

• logical_name – Logical name for this file or directory e.g. VHDL library name.

• exported_name – Defines exported names that can be accessed externally, e.g. exported function names from a C source file.

• build_command – Command and flags used to build derived files from the sourceName files. If this element is present, the command and/or flags used to to build the file will override or augment any default builders at a higher level.

• dependency

• define – Specifies define symbols that are used in the source file. The spirit:name attribute gives the name to be defined and the text content of the element holds the value. This element supports full configurability.

• image_type – Relates the current file to a certain executable image type in the design.

• vendor_extensions

• file_id

• any_attributes

Parameters:

• name (Name | None)

• file_type (Iterable[FileFileType])

• user_file_type (Iterable[str])

• logical_name (LogicalName | None)

• exported_name (Iterable[str])

• build_command (BuildCommand | None)

• dependency (Iterable[Dependency])

• define (Iterable[NameValuePairType])

• image_type (Iterable[str])

• vendor_extensions (VendorExtensions | None)

• file_id (str | None)

• any_attributes (Mapping[str, str])

class BuildCommand(command=None, flags=None, replace_default_flags=None, target_name=None)

Bases: object

Variables:

• command – Command used to build this file.

• flags – Flags given to the build command when building this file. If the optional attribute “append” is “true”, this string will be appended to any existing flags, otherwise these flags will replace any existing default flags.

• replace_default_flags – If true, the value of the sibling element “flags” should replace any default flags specified at a more global level. If this is true and the sibling element “flags” is empty or missing, this has the effect of clearing any default flags.

• target_name – Pathname to the file that is derived (built) from the source file.

Parameters:

• command (Command | None)

• flags (Flags | None)

• replace_default_flags (ReplaceDefaultFlags | None)

• target_name (TargetName | None)

class Command(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Flags(value='', append=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• append

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• append (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

append: bool | None

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class ReplaceDefaultFlags(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class TargetName(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

command: Command | None

flags: Flags | None

replace_default_flags: ReplaceDefaultFlags | None

target_name: TargetName | None

class LogicalName(value: str = '', default: str | None = None)

Bases: object

Parameters:

• value (str)

• default (str | None)

default: str | None

value: str

class Name(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

any_attributes: Mapping[str, str]

build_command: BuildCommand | None

define: Iterable[NameValuePairType]

dependency: Iterable[Dependency]

exported_name: Iterable[str]

file_id: str | None

file_type: Iterable[FileFileType]

image_type: Iterable[str]

logical_name: LogicalName | None

name: Name | None

user_file_type: Iterable[str]

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.FileBuilderFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

class org.accellera.spirit.v1_2.FileBuilderType(file_type=None, user_file_type=None, command=None, flags=None, replace_default_flags=None)

Bases: object

Variables:

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

• command – Default command used to build files of the specified fileType.

• flags – Flags given to the build command when building files of this type.

• replace_default_flags – If true, replace any default flags value with the value in the sibling flags element. Otherwise, append the contents of the sibling flags element to any default flags value. If the value is true and the “flags” element is empty or missing, this will have the result of clearing any default flags value.

Parameters:

• file_type (FileBuilderTypeFileType | None)

• user_file_type (str | None)

• command (Command | None)

• flags (Flags | None)

• replace_default_flags (ReplaceDefaultFlags | None)

class Command(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Flags(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class ReplaceDefaultFlags(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (bool | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

command: Command | None

file_type: FileBuilderTypeFileType | None

flags: Flags | None

replace_default_flags: ReplaceDefaultFlags | None

user_file_type: str | None

class org.accellera.spirit.v1_2.FileBuilderTypeFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

class org.accellera.spirit.v1_2.FileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

class org.accellera.spirit.v1_2.FileSet(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=None, file_set_id=None)

Bases: FileSetType

This element specifies a list of unique pathnames to files and directories.

It may also include build instructions for the files. If compilation order is important, e.g. for VHDL files, the files have to be provided in compilation order.

Parameters:

• owner (LibraryRefType | None)

• group (Iterable[str])

• file (Iterable[File])

• default_file_builder (Iterable[FileBuilderType])

• dependency (Iterable[Dependency])

• function (Iterable[FileSetType.Function])

• vendor_extensions (VendorExtensions | None)

• file_set_id (str | None)

class Function(entry_point=None, file_ref=None, return_type=None, argument=<factory>, enabled=None, source_file=<factory>, replicate=None)

Bases: object

Variables:

• entry_point

• file_ref – A reference to the file that contains the entry point function.

• return_type – Function return type. See the enumerations.

• argument – Arguments passed in when the function is called. Arguments are passed in order. This is an extension of the name-value pair which includes the data type in the spirit:dataType attribute. The argument name is in the spirit:name attribute and its value is in the text content of the element.

• enabled – Specifies if the SW function is enabled. Default is true.

• source_file

• replicate

Parameters:

• entry_point (str | None)

• file_ref (str | None)

• return_type (FunctionReturnType | None)

• argument (Iterable[Argument])

• enabled (Enabled | None)

• source_file (Iterable[SourceFile])

• replicate (bool | None)

class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_2.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_2.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_2.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_2.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_2.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• data_type (DataTypeType | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

data_type: DataTypeType | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Enabled(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

• source_name – Source file for the boot load. Relative names are searched for in the project directory and the source of the component directory.

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

Parameters:

• source_name (SourceName | None)

• file_type (SourceFileFileType | None)

• user_file_type (str | None)

class SourceName(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_type: SourceFileFileType | None

source_name: SourceName | None

user_file_type: str | None

argument: Iterable[Argument]

enabled: Enabled | None

entry_point: str | None

file_ref: str | None

replicate: bool | None

return_type: FunctionReturnType | None

source_file: Iterable[SourceFile]

default_file_builder: Iterable[FileBuilderType]

dependency: Iterable[Dependency]

file: Iterable[File]

file_set_id: str | None

function: Iterable['FileSetType.Function']

group: Iterable[str]

owner: LibraryRefType | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.FileSetRef(value='')

Bases: object

A reference to a fileSet.

Parameters:

value (str)

value: str

class org.accellera.spirit.v1_2.FileSetType(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=None, file_set_id=None)

Bases: object

Variables:

• owner – Specifies the original owner of the fileSet, used when importing fileSets from other components, as in Hierarchical components, to allow the parent component to correctly locate files imported from subcomponents

• group – Identifies this filleSet as belonging to a particular group or having a particular purpose. Examples might be “diagnostics”, “boot”, “application”, “interrupt”, “deviceDriver”, etc.

• file

• default_file_builder

• dependency

• function – Generator information if this file set describes a function. For example, this file set may describe diagnostics for which the DE can generate a diagnostics driver. The boolean attribute “replicate”, if true (default is false), directs the generator to compile a separate object module for each instance of the component in the design. Otherwise the function will be called with different arguments for each instance (e.g. baseAddress).

• vendor_extensions

• file_set_id

Parameters:

• owner (LibraryRefType | None)

• group (Iterable[str])

• file (Iterable[File])

• default_file_builder (Iterable[FileBuilderType])

• dependency (Iterable[Dependency])

• function (Iterable[Function])

• vendor_extensions (VendorExtensions | None)

• file_set_id (str | None)

class Function(entry_point=None, file_ref=None, return_type=None, argument=<factory>, enabled=None, source_file=<factory>, replicate=None)

Bases: object

Variables:

• entry_point

• file_ref – A reference to the file that contains the entry point function.

• return_type – Function return type. See the enumerations.

• argument – Arguments passed in when the function is called. Arguments are passed in order. This is an extension of the name-value pair which includes the data type in the spirit:dataType attribute. The argument name is in the spirit:name attribute and its value is in the text content of the element.

• enabled – Specifies if the SW function is enabled. Default is true.

• source_file

• replicate

Parameters:

• entry_point (str | None)

• file_ref (str | None)

• return_type (FunctionReturnType | None)

• argument (Iterable[Argument])

• enabled (Enabled | None)

• source_file (Iterable[SourceFile])

• replicate (bool | None)

class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: org.accellera.spirit.v1_2.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_2.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_2.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_2.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_2.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_2.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• data_type (DataTypeType | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

data_type: DataTypeType | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class Enabled(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

• source_name – Source file for the boot load. Relative names are searched for in the project directory and the source of the component directory.

• file_type – Enumerated file types known by SPIRIT.

• user_file_type – Free form file type, not - yet - known by SPIRIT .

Parameters:

• source_name (SourceName | None)

• file_type (SourceFileFileType | None)

• user_file_type (str | None)

class SourceName(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

file_type: SourceFileFileType | None

source_name: SourceName | None

user_file_type: str | None

argument: Iterable[Argument]

enabled: Enabled | None

entry_point: str | None

file_ref: str | None

replicate: bool | None

return_type: FunctionReturnType | None

source_file: Iterable[SourceFile]

default_file_builder: Iterable[FileBuilderType]

dependency: Iterable[Dependency]

file: Iterable[File]

file_set_id: str | None

function: Iterable[Function]

group: Iterable[str]

owner: LibraryRefType | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.FileSets(file_set=<factory>)

Bases: object

List of file sets associated with component.

Parameters:

file_set (Iterable[FileSet])

file_set: Iterable[FileSet]

class org.accellera.spirit.v1_2.FormatType(*values)

Bases: Enum

This is a hint to the user interface on how to obtain the value for user defined properties.

Float means a floating point number is expected. Long means an integer is expected. Bool means a boolean (true, false) is expected and choice means the user must pick from a list of possible values. A choiceRef attribute is required for choice formats. String means any text is acceptable.

BOOL = 'bool'

CHOICE = 'choice'

FLOAT = 'float'

LONG = 'long'

STRING = 'string'

class org.accellera.spirit.v1_2.FunctionReturnType(*values)

Bases: Enum

INT = 'int'

VOID = 'void'

class org.accellera.spirit.v1_2.Generator(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None)

Bases: GeneratorType

Specifies a set of generators.

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (GeneratorType.TransportMethods | None)

• lgi_access_type (GeneratorType.LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

lgi_access_type: 'GeneratorType.LgiAccessType' | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

transport_methods: 'GeneratorType.TransportMethods' | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.GeneratorChain(vendor=None, library=None, name=None, version=None, file_generator_selector=<factory>, component_generator_selector=<factory>, generator=<factory>, chain_group=<factory>, parameter=<factory>, choices=None)

Bases: object

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• file_generator_selector – Select other generator chain files for inclusion into this chain. The boolean attribute “unique” (default false) specifies that only a single generator is valid in this context. If more that one generator is selcted based on the selection criteria, DE will prompt the user to resolve to a single generator.

• component_generator_selector – Selects generators declared in component description files of the current design for inclusion into this generator chain.

• generator

• chain_group – Identifies this generator chain as belonging to the named group. This is used by other generator chains to select this chain for programmatic inclusion.

• parameter

• choices

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• file_generator_selector (Iterable[FileGeneratorSelector])

• component_generator_selector (Iterable[GeneratorSelectorType])

• generator (Iterable[Generator])

• chain_group (Iterable[str])

• parameter (Iterable[Parameter])

• choices (Choices | None)

class FileGeneratorSelector(group_selector=None, file_name=None, unique=True)

Bases: object

Variables:

• group_selector

• file_name – Select another generator chain using the unique identifier of this generator chain.

• unique

Parameters:

• group_selector (GroupSelector | None)

• file_name (LibraryRefType | None)

• unique (bool)

file_name: LibraryRefType | None

group_selector: GroupSelector | None

unique: bool

chain_group: Iterable[str]

choices: Choices | None

component_generator_selector: Iterable[GeneratorSelectorType]

file_generator_selector: Iterable[FileGeneratorSelector]

generator: Iterable[Generator]

library: str | None

name: str | None

parameter: Iterable[Parameter]

vendor: str | None

version: str | None

class org.accellera.spirit.v1_2.GeneratorChangeList(component_changes=None, interconnection_changes=None, ad_hoc_connection_changes=None, design_configuration_changes=None, vendor_extension_changes=None)

Bases: object

Defines the changes to be made to the design as directed by an external generator.

Variables:

• component_changes – List of changes affecting components in the design.

• interconnection_changes – List of changes affecting interconnections in the design.

• ad_hoc_connection_changes – List of changes affecting ad-hoc connections in the design.

• design_configuration_changes – List of changes affecting the configuration of the design.

• vendor_extension_changes – List of changes affecting vendor defined extensions in the design.

Parameters:

• component_changes (ComponentChanges | None)

• interconnection_changes (InterconnectionChanges | None)

• ad_hoc_connection_changes (AdHocConnectionChanges | None)

• design_configuration_changes (DesignConfigurationChanges | None)

• vendor_extension_changes (VendorExtensionChanges | None)

class AdHocConnectionChanges(ad_hoc_connection_change: collections.abc.Iterable['GeneratorChangeList.AdHocConnectionChanges.AdHocConnectionChange'] = <factory>)

Bases: object

Parameters:

ad_hoc_connection_change (Iterable[AdHocConnectionChange])

class AdHocConnectionChange(add_rem_change=None, name=None, export=None, pin_reference=<factory>)

Bases: object

Variables:

• add_rem_change

• name – This is the name of the ad-hoc connection to modify

• export – Specifies whether this ad-hoc connection will be exported out of the design.

• pin_reference – Indicates the signal on the component which is being connected by this ad-hoc connection

Parameters:

• add_rem_change (AddRemChange | None)

• name (str | None)

• export (Export | None)

• pin_reference (Iterable[PinReference])

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class PinReference(component_ref=None, signal_ref=None, left=0, right=0)

Bases: object

Variables:

• component_ref – This is the instance name of the component

• signal_ref – The name of the signal on the component

• left – If present, this is the left index of the signal

• right – If present, this is the right index of the signal

Parameters:

• component_ref (str | None)

• signal_ref (str | None)

• left (int)

• right (int)

component_ref: str | None

left: int

right: int

signal_ref: str | None

add_rem_change: AddRemChange | None

export: Export | None

name: str | None

pin_reference: Iterable[PinReference]

ad_hoc_connection_change: Iterable[AdHocConnectionChange]

class ComponentChanges(component_change: collections.abc.Iterable['GeneratorChangeList.ComponentChanges.ComponentChange'] = <factory>)

Bases: object

Parameters:

component_change (Iterable[ComponentChange])

class ComponentChange(add_rem_rep_change=None, instance_name=None, component_file_name=None, sub_components=None, configuration=None)

Bases: object

Variables:

• add_rem_rep_change

• instance_name

• component_file_name – This is the file containing the component definition. Required only if the alteration is an addition or a replacement. Should be an absolute filename so that the DE may copy it.

• sub_components – Required only for hierarchical components. Holds the hierarchical component’s sub- component definition files.

• configuration

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• instance_name (InstanceName | None)

• component_file_name (str | None)

• sub_components (SubComponents | None)

• configuration (Configuration | None)

class SubComponents(sub_component_file_name=<factory>)

Bases: object

Variables:

sub_component_file_name – Path to definitions of components and channels instanced in hierarchical component definition.

Parameters:

sub_component_file_name (Iterable[str])

sub_component_file_name: Iterable[str]

add_rem_rep_change: AddRemRepChange | None

component_file_name: str | None

configuration: Configuration | None

instance_name: InstanceName | None

sub_components: SubComponents | None

component_change: Iterable[ComponentChange]

class DesignConfigurationChanges(pmd_configuration_change=<factory>, generator_chain_configuration_change=<factory>, view_configuration_change=<factory>, vendor_extension_changes=None)

Bases: object

Variables:

• pmd_configuration_change – Contains the configurable information associated with a particular PMD

• generator_chain_configuration_change – Contains the configurable information associated with a generatorChain and its generators. Note that configurable information for generators associated with components is stored in the design file.

• view_configuration_change – Contains the active view for each instance in the design

• vendor_extension_changes – List of changes affecting vendor defined extensions in the design.

Parameters:

• pmd_configuration_change (Iterable[PmdConfigurationChange])

• generator_chain_configuration_change (Iterable[GeneratorChainConfigurationChange])

• view_configuration_change (Iterable[ViewConfigurationChange])

• vendor_extension_changes (VendorExtensionChanges | None)

class GeneratorChainConfigurationChange(generator_chain_ref=None, generator_chain_change=<factory>, generator_change=<factory>)

Bases: object

Variables:

• generator_chain_ref – References a generatorChain.

• generator_chain_change

• generator_change – Stores configurable information for generators referenced in the chain

Parameters:

• generator_chain_ref (LibraryRefType | None)

• generator_chain_change (Iterable[GeneratorChainChange])

• generator_change (Iterable[GeneratorChange])

class GeneratorChainChange(add_rem_rep_change: Optional[org.accellera.spirit.v1_2.add_rem_rep_change.AddRemRepChange] = None, configurable_element: collections.abc.Iterable[org.accellera.spirit.v1_2.configurable_element.ConfigurableElement] = <factory>)

Bases: object

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• configurable_element (Iterable[ConfigurableElement])

add_rem_rep_change: AddRemRepChange | None

configurable_element: Iterable[ConfigurableElement]

class GeneratorChange(add_rem_rep_change=None, generator_name=None, configurable_element=<factory>)

Bases: object

Variables:

• add_rem_rep_change

• generator_name – This identifies the generator in the chain.

• configurable_element

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• generator_name (str | None)

• configurable_element (Iterable[ConfigurableElement])

add_rem_rep_change: AddRemRepChange | None

configurable_element: Iterable[ConfigurableElement]

generator_name: str | None

generator_chain_change: Iterable[GeneratorChainChange]

generator_chain_ref: LibraryRefType | None

generator_change: Iterable[GeneratorChange]

class PmdConfigurationChange(add_rem_rep_change=None, pmd_ref=None, configurable_element=<factory>)

Bases: object

Variables:

• add_rem_rep_change

• pmd_ref – References a PMD.

• configurable_element

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• pmd_ref (LibraryRefType | None)

• configurable_element (Iterable[ConfigurableElement])

add_rem_rep_change: AddRemRepChange | None

configurable_element: Iterable[ConfigurableElement]

pmd_ref: LibraryRefType | None

class VendorExtensionChanges(vendor_extension_change: collections.abc.Iterable['GeneratorChangeList.DesignConfigurationChanges.VendorExtensionChanges.VendorExtensionChange'] = <factory>)

Bases: object

Parameters:

vendor_extension_change (Iterable[VendorExtensionChange])

class VendorExtensionChange(add_rem_change: org.accellera.spirit.v1_2.add_rem_change.AddRemChange | None = None, vendor_extensions: org.accellera.spirit.v1_2.vendor_extensions.VendorExtensions | None = None)

Bases: object

Parameters:

• add_rem_change (AddRemChange | None)

• vendor_extensions (VendorExtensions | None)

add_rem_change: AddRemChange | None

vendor_extensions: VendorExtensions | None

vendor_extension_change: Iterable[VendorExtensionChange]

class ViewConfigurationChange(add_rem_rep_change=None, instance_name=None, view_name=None)

Bases: object

Variables:

• add_rem_rep_change

• instance_name

• view_name – The name of the active view for this instance

Parameters:

• add_rem_rep_change (AddRemRepChange | None)

• instance_name (InstanceName | None)

• view_name (str | None)

add_rem_rep_change: AddRemRepChange | None

instance_name: InstanceName | None

view_name: str | None

generator_chain_configuration_change: Iterable[GeneratorChainConfigurationChange]

pmd_configuration_change: Iterable[PmdConfigurationChange]

vendor_extension_changes: VendorExtensionChanges | None

view_configuration_change: Iterable[ViewConfigurationChange]

class InterconnectionChanges(interconnection_change: collections.abc.Iterable['GeneratorChangeList.InterconnectionChanges.InterconnectionChange'] = <factory>)

Bases: object

Parameters:

interconnection_change (Iterable[InterconnectionChange])

class InterconnectionChange(add_rem_change: org.accellera.spirit.v1_2.add_rem_change.AddRemChange | None = None, interconnection: org.accellera.spirit.v1_2.interconnection.Interconnection | None = None, monitor_interconnection: org.accellera.spirit.v1_2.monitor_interconnection.MonitorInterconnection | None = None)

Bases: object

Parameters:

• add_rem_change (AddRemChange | None)

• interconnection (Interconnection | None)

• monitor_interconnection (MonitorInterconnection | None)

add_rem_change: AddRemChange | None

interconnection: Interconnection | None

monitor_interconnection: MonitorInterconnection | None

interconnection_change: Iterable[InterconnectionChange]

class VendorExtensionChanges(vendor_extension_change: collections.abc.Iterable['GeneratorChangeList.VendorExtensionChanges.VendorExtensionChange'] = <factory>)

Bases: object

Parameters:

vendor_extension_change (Iterable[VendorExtensionChange])

class VendorExtensionChange(add_rem_change: org.accellera.spirit.v1_2.add_rem_change.AddRemChange | None = None, vendor_extensions: org.accellera.spirit.v1_2.vendor_extensions.VendorExtensions | None = None)

Bases: object

Parameters:

• add_rem_change (AddRemChange | None)

• vendor_extensions (VendorExtensions | None)

add_rem_change: AddRemChange | None

vendor_extensions: VendorExtensions | None

vendor_extension_change: Iterable[VendorExtensionChange]

ad_hoc_connection_changes: AdHocConnectionChanges | None

component_changes: ComponentChanges | None

design_configuration_changes: DesignConfigurationChanges | None

interconnection_changes: InterconnectionChanges | None

vendor_extension_changes: VendorExtensionChanges | None

class org.accellera.spirit.v1_2.GeneratorRef(value='')

Bases: object

A reference to a generator element.

Parameters:

value (str)

value: str

class org.accellera.spirit.v1_2.GeneratorSelectorType(group_selector: org.accellera.spirit.v1_2.group_selector.GroupSelector | None = None)

Bases: object

Parameters:

group_selector (GroupSelector | None)

group_selector: GroupSelector | None

class org.accellera.spirit.v1_2.GeneratorType(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None)

Bases: object

Types of generators.

Variables:

• name – The name of this generator.

• phase

• parameter

• api_type – Indicates the type of API used by the generator. Valid value are TGI, LGI, and none. If this element is not present, LGI is assumed.

• transport_methods

• lgi_access_type – Identifies the special requirements that this loose generator may place up on the DE. Not valid for tight generators.

• generator_exe – The pathname to the executable file that implements the generator

• vendor_extensions

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (TransportMethods | None)

• lgi_access_type (LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

lgi_access_type: LgiAccessType | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

transport_methods: TransportMethods | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.GeneratorTypeApiType(*values)

Bases: Enum

LGI = 'LGI'

NONE = 'none'

TGI = 'TGI'

class org.accellera.spirit.v1_2.GroupSelector(name=<factory>, multiple_group_selection_operator=GroupSelectorMultipleGroupSelectionOperator.OR)

Bases: object

Specifies a set of group names used to select subsequent generators.

The attribute “multipleGroupOperator” specifies the OR or AND selection operator if there is more than one group name (default=OR).

Variables:

• name – Name used to select a generator or generator chain.

• multiple_group_selection_operator

Parameters:

• name (Iterable[str])

• multiple_group_selection_operator (GroupSelectorMultipleGroupSelectionOperator)

multiple_group_selection_operator: GroupSelectorMultipleGroupSelectionOperator

name: Iterable[str]

class org.accellera.spirit.v1_2.GroupSelectorMultipleGroupSelectionOperator(*values)

Bases: Enum

AND = 'and'

OR = 'or'

class org.accellera.spirit.v1_2.InstanceGeneratorType(name=None, phase=None, parameter=<factory>, api_type=None, transport_methods=None, lgi_access_type=None, generator_exe=None, vendor_extensions=None, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE)

Bases: GeneratorType

Variables:

• group – An identifier to specify the generator group. This is used by generator chains for selecting which generators to run.

• scope – The scope attribute applies to component generators and specifies whether the generator should be run for each instance of the entity (or module) or just once for all instances of the entity.

Parameters:

• name (str | None)

• phase (Phase | None)

• parameter (Iterable[Parameter])

• api_type (GeneratorTypeApiType | None)

• transport_methods (GeneratorType.TransportMethods | None)

• lgi_access_type (GeneratorType.LgiAccessType | None)

• generator_exe (str | None)

• vendor_extensions (VendorExtensions | None)

• group (Iterable[str])

• scope (InstanceGeneratorTypeScope)

api_type: GeneratorTypeApiType | None

generator_exe: str | None

group: Iterable[str]

lgi_access_type: 'GeneratorType.LgiAccessType' | None

name: str | None

parameter: Iterable[Parameter]

phase: Phase | None

scope: InstanceGeneratorTypeScope

transport_methods: 'GeneratorType.TransportMethods' | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.InstanceGeneratorTypeScope(*values)

Bases: Enum

ENTITY = 'entity'

INSTANCE = 'instance'

class org.accellera.spirit.v1_2.InstanceName(value='')

Bases: object

An instance name assigned to subcomponent instances and contained channels, that is unique within the parent component.

Parameters:

value (str)

value: str

class org.accellera.spirit.v1_2.Interconnection(name=None, active_interface=<factory>)

Bases: object

Describes a connection from the interface of one component to the interface of another component through its attributes.

The componentRef and busInterfaceRef attributes indicate the instance name and bus interface name of one end of the connection. The interconnection element connects two active interfaces and doesn’t connect monitor interfaces.

Variables:

• name – name of the connection

• active_interface

Parameters:

• name (object | None)

• active_interface (Iterable[Interface])

active_interface: Iterable[Interface]

name: object | None

class org.accellera.spirit.v1_2.Interconnections(interconnection=<factory>, monitor_interconnection=<factory>)

Bases: object

Connections between internal sub components.

Parameters:

• interconnection (Iterable[Interconnection])

• monitor_interconnection (Iterable[MonitorInterconnection])

interconnection: Iterable[Interconnection]

monitor_interconnection: Iterable[MonitorInterconnection]

class org.accellera.spirit.v1_2.Interface(component_ref=None, bus_ref=None)

Bases: object

A representation of a component/bus interface relation; i.e. a bus interface belonging to a certain component.

Parameters:

• component_ref (object | None)

• bus_ref (object | None)

bus_ref: object | None

component_ref: object | None

class org.accellera.spirit.v1_2.LibraryRefType(vendor=None, library=None, name=None, version=None)

Bases: object

Base SPIRIT document reference type.

Contains vendor, library, name and version attributes.

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

library: str | None

name: str | None

vendor: str | None

version: str | None

class org.accellera.spirit.v1_2.LoadConstraint(cell_specification=None, count=None, capacitance=None)

Bases: object

Defines a constraint indicating the type of load on an output signal.

Variables:

• cell_specification

• count – Indicates how many loads of the specified cell are connected. If not present, 3 is assumed.

• capacitance – Indicates an explicit load capacitance on an output signal.

Parameters:

• cell_specification (CellSpecification | None)

• count (int | None)

• capacitance (Capacitance | None)

capacitance: Capacitance | None

cell_specification: CellSpecification | None

count: int | None

class org.accellera.spirit.v1_2.LocalMemoryMapType(address_block=<factory>, bank=<factory>, subspace_map=<factory>)

Bases: object

Map of address space blocks on the local memory map of a master bus interface.

Variables:

• address_block

• bank

• subspace_map – Maps in an address subspace from accross a bus bridge. Its masterRef attribute refers by name to the master bus interface on the other side of the bridge. It must match the masterRef attribute of a bridge element on the slave interface, and that bridge element must be designated as opaque.

Parameters:

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

subspace_map: Iterable[SubspaceRefType]

class org.accellera.spirit.v1_2.LooseGeneratorInvocation(design_file=None, configuration_file=None, bus_definition_files=None, component_definition_files=None, parameters=None, selected_instances=None, phase_number=None, group_name=None)

Bases: object

Specifies the information required to invoke a loosely coupled generator.

Variables:

• design_file – Path to description of top level design

• configuration_file – Path to configuration file for this design

• bus_definition_files – The list of bus definition files currently in use within the design

• component_definition_files – The list of component definition files currently needed to define all the components within the design.

• parameters – List of values of configurable settings for this generator invocation

• selected_instances – The list of instances to be worked upon by the generator, no instances selected indicates whole design

• phase_number – The non-negative floating point phase number associated with this generator invocation

• group_name – The generator group name associated with this generator invocation

Parameters:

• design_file (str | None)

• configuration_file (str | None)

• bus_definition_files (BusDefinitionFiles | None)

• component_definition_files (ComponentDefinitionFiles | None)

• parameters (Parameters | None)

• selected_instances (SelectedInstances | None)

• phase_number (float | None)

• group_name (str | None)

class BusDefinitionFiles(bus_definition_file=<factory>)

Bases: object

Variables:

bus_definition_file – Path to a bus definition file used within design. Attributes VLNV used to indicate which bus definition this file represents.

Parameters:

bus_definition_file (Iterable[ResolvedLibraryRefType])

bus_definition_file: Iterable[ResolvedLibraryRefType]

class ComponentDefinitionFiles(component_definition_file=<factory>)

Bases: object

Variables:

component_definition_file – Path to component definition file. This component definition is the component definition as it appears in the DE; i.e. after having been transformed by any PMD info, and including any instance specific settings such as parameter values. The instanceRef attribute is the name of the instance that this file describes.

Parameters:

component_definition_file (Iterable[ComponentDefinitionFile])

class ComponentDefinitionFile(value='', instance_ref=None)

Bases: object

Variables:

• value

• instance_ref – Reference handle for this component definition

Parameters:

• value (str)

• instance_ref (str | None)

instance_ref: str | None

value: str

component_definition_file: Iterable[ComponentDefinitionFile]

class Parameters(parameter: collections.abc.Iterable[org.accellera.spirit.v1_2.parameter.Parameter] = <factory>)

Bases: object

Parameters:

parameter (Iterable[Parameter])

parameter: Iterable[Parameter]

class SelectedInstances(selected_instance=<factory>)

Bases: object

Variables:

selected_instance – Instance name of selected instance that the generator is expected to work upon. This may be a hierarchical instance name.

Parameters:

selected_instance (Iterable[str])

selected_instance: Iterable[str]

bus_definition_files: BusDefinitionFiles | None

component_definition_files: ComponentDefinitionFiles | None

configuration_file: str | None

design_file: str | None

group_name: str | None

parameters: Parameters | None

phase_number: float | None

selected_instances: SelectedInstances | None

class org.accellera.spirit.v1_2.MemoryMapRef(memory_map_ref=None)

Bases: MemoryMapRefType

References the memory map.

The name of the memory map is kept in its memoryMapRef attribute.

Parameters:

memory_map_ref (str | None)

memory_map_ref: str | None

class org.accellera.spirit.v1_2.MemoryMapRefType(memory_map_ref=None)

Bases: object

Base type for an element which references an memory map.

Reference is kept in an attribute rather than the text value, so that the type may be extended with child elements if necessary.

Parameters:

memory_map_ref (str | None)

memory_map_ref: str | None

class org.accellera.spirit.v1_2.MemoryMapType(name=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, memory_remap=<factory>)

Bases: object

Map of address space blocks on slave slave bus interface.

Variables:

• name – Memory map name, unique within the component. Put into a group to avoid making it a top level element

• address_block

• bank

• subspace_map – Maps in an address subspace from accross a bus bridge. Its masterRef attribute refers by name to the master bus interface on the other side of the bridge. It must match the masterRef attribute of a bridge element on the slave interface, and that bridge element must be designated as opaque.

• memory_remap

Parameters:

• name (str | None)

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

• memory_remap (Iterable[MemoryRemapType])

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

memory_remap: Iterable[MemoryRemapType]

name: str | None

subspace_map: Iterable[SubspaceRefType]

class org.accellera.spirit.v1_2.MemoryMaps(memory_map=<factory>)

Bases: object

Lists all the slave memory maps defined by the component.

Variables:

memory_map – The set of address blocks a bus slave contributes to the bus’ address space.

Parameters:

memory_map (Iterable[MemoryMap])

class MemoryMap(name: Optional[str] = None, address_block: collections.abc.Iterable[org.accellera.spirit.v1_2.address_block.AddressBlock] = <factory>, bank: collections.abc.Iterable[org.accellera.spirit.v1_2.bank.Bank] = <factory>, subspace_map: collections.abc.Iterable[org.accellera.spirit.v1_2.subspace_ref_type.SubspaceRefType] = <factory>, memory_remap: collections.abc.Iterable[org.accellera.spirit.v1_2.memory_remap_type.MemoryRemapType] = <factory>, bits_in_lau: Optional[org.accellera.spirit.v1_2.bits_in_lau.BitsInLau] = None)

Bases: MemoryMapType

Parameters:

• name (str | None)

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

• memory_remap (Iterable[MemoryRemapType])

• bits_in_lau (BitsInLau | None)

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

bits_in_lau: BitsInLau | None

memory_remap: Iterable[MemoryRemapType]

name: str | None

subspace_map: Iterable[SubspaceRefType]

memory_map: Iterable[MemoryMap]

class org.accellera.spirit.v1_2.MemoryRemapType(address_block=<factory>, bank=<factory>, subspace_map=<factory>, state=None)

Bases: object

Map of address space blocks on a slave bus interface in a specific remap state.

Variables:

• address_block

• bank

• subspace_map – Maps in an address subspace from accross a bus bridge. Its masterRef attribute refers by name to the master bus interface on the other side of the bridge. It must match the masterRef attribute of a bridge element on the slave interface, and that bridge element must be designated as opaque.

• state – State of the component in which the memory map is active.

Parameters:

• address_block (Iterable[AddressBlock])

• bank (Iterable[Bank])

• subspace_map (Iterable[SubspaceRefType])

• state (str | None)

address_block: Iterable[AddressBlock]

bank: Iterable[Bank]

state: str | None

subspace_map: Iterable[SubspaceRefType]

class org.accellera.spirit.v1_2.Model(views=None, signals=None, model_parameters=None, vendor_extensions=None)

Bases: ModelType

Model information.

Parameters:

• views (ModelType.Views | None)

• signals (ModelType.Signals | None)

• model_parameters (ModelType.ModelParameters | None)

• vendor_extensions (VendorExtensions | None)

class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

model_parameter – A model parameter name value pair. The name is given in an attribute. The value is the element value. The dataType (applicable to high level modeling) is given in the dataType attribute. For hardware based models, the name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]

class Signals(signal: collections.abc.Iterable[org.accellera.spirit.v1_2.signal.Signal] = <factory>)

Bases: object

Parameters:

signal (Iterable[Signal])

signal: Iterable[Signal]

class Views(view: collections.abc.Iterable[org.accellera.spirit.v1_2.view_type.ViewType] = <factory>)

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]

model_parameters: 'ModelType.ModelParameters' | None

signals: 'ModelType.Signals' | None

vendor_extensions: VendorExtensions | None

views: 'ModelType.Views' | None

class org.accellera.spirit.v1_2.ModelType(views=None, signals=None, model_parameters=None, vendor_extensions=None)

Bases: object

Hardware model information.

Variables:

• views – View container

• signals – Signal container

• model_parameters – Model parameter name value pairs container

• vendor_extensions

Parameters:

• views (Views | None)

• signals (Signals | None)

• model_parameters (ModelParameters | None)

• vendor_extensions (VendorExtensions | None)

class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

model_parameter – A model parameter name value pair. The name is given in an attribute. The value is the element value. The dataType (applicable to high level modeling) is given in the dataType attribute. For hardware based models, the name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]

class Signals(signal: collections.abc.Iterable[org.accellera.spirit.v1_2.signal.Signal] = <factory>)

Bases: object

Parameters:

signal (Iterable[Signal])

signal: Iterable[Signal]

class Views(view: collections.abc.Iterable[org.accellera.spirit.v1_2.view_type.ViewType] = <factory>)

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]

model_parameters: ModelParameters | None

signals: Signals | None

vendor_extensions: VendorExtensions | None

views: Views | None

class org.accellera.spirit.v1_2.MonitorInterconnection(name=None, active_interface=None, monitor_interface=<factory>)

Bases: object

Describes a connection from the interface of one component to any number of monitor interfaces in the design through its child elements’ attributes.

The componentRef and busInterfaceRef attributes of each child interface element indicate the instance name and bus interface name of one end of the connection. An active interface can be connected to unlimited number of monitor interfaces.

Variables:

• name – name of the connection

• active_interface

• monitor_interface

Parameters:

• name (object | None)

• active_interface (Interface | None)

• monitor_interface (Iterable[Interface])

active_interface: Interface | None

monitor_interface: Iterable[Interface]

name: object | None

class org.accellera.spirit.v1_2.MonitorInterfaceType(*values)

Bases: Enum

MASTER = 'master'

MIRRORED_MASTER = 'mirroredMaster'

MIRRORED_SLAVE = 'mirroredSlave'

MIRRORED_SYSTEM = 'mirroredSystem'

SLAVE = 'slave'

SYSTEM = 'system'

class org.accellera.spirit.v1_2.MultiCyclePath(path_specifier=None, cycles=None, path_edge=None, path_type=None, relative_clock=None)

Bases: object

Defines a multi-cycle path timing exception.

Parameters:

• path_specifier (PathSpecifier | None)

• cycles (int | None)

• path_edge (EdgeValueType | None)

• path_type (CheckValueType | None)

• relative_clock (RelativeClockType | None)

cycles: int | None

path_edge: EdgeValueType | None

path_specifier: PathSpecifier | None

path_type: CheckValueType | None

relative_clock: RelativeClockType | None

class org.accellera.spirit.v1_2.NameValuePairType(value='', name=None, cross_ref=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Used wherever a name value pair is appropriate.

The name is given by the attribute while the value is the element content. Supports configurability attributes and a cross reference XPath expression stored in the crossRef attribute.

Variables:

• value

• name – The name in a name-value pair.

• cross_ref

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class org.accellera.spirit.v1_2.NameValueTypeType(value='', name=None, cross_ref=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None, data_type=None)

Bases: NameValuePairType

Name value pair with data type information.

Variables:

data_type – The data type of the argumen as pertains to the language. Example: “int”, “double”, “char *”.

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

• data_type (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

data_type: str | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class org.accellera.spirit.v1_2.OnMasterValue(*values)

Bases: Enum

IN = 'in'

INOUT = 'inout'

OUT = 'out'

class org.accellera.spirit.v1_2.OnSlaveValue(*values)

Bases: Enum

IN = 'in'

INOUT = 'inout'

OUT = 'out'

class org.accellera.spirit.v1_2.OnSystemValue(*values)

Bases: Enum

IN = 'in'

INOUT = 'inout'

OUT = 'out'

class org.accellera.spirit.v1_2.OtherClocks(clock_driver=<factory>)

Bases: object

List of clocks associated with the component that are not associated with signals.

Set the clockSource attribute on the clockDriver to indicate the source of a clock not associated with a particular component signal.

Parameters:

clock_driver (Iterable[ClockDriver])

clock_driver: Iterable[ClockDriver]

class org.accellera.spirit.v1_2.Parameter(value='', name=None, cross_ref=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: NameValuePairType

A name value pair.

The name is specified by the name attribute. The value is in the text content of the element. This element supports all configurability attributes. It also supports a cross reference attribute which allows it to be associated with other elements in the document through an XPath expression.

Parameters:

• value (str)

• name (str | None)

• cross_ref (str | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

cross_ref: str | None

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

name: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

class org.accellera.spirit.v1_2.PathElementType(*values)

Bases: Enum

Indicates legal values for pathElement attribute.

CELL = 'cell'

CLOCK = 'clock'

PIN = 'pin'

SIGNAL = 'signal'

class org.accellera.spirit.v1_2.PathSpecifier(from_value=<factory>, to=<factory>, through=<factory>)

Bases: object

Defines one or more logical paths within a component.

Variables:

• from_value – Defines a valid path starting point. This can be a clock, an input port, a sequential cell, or a clock or data out pin of a sequential cell. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to it if might be ambiguous.

• to – Defines a valid path ending point. This can be a clock, an output port, a sequential cell, or a clock or data in pin of a sequential cell. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous. Defines a valid path ending point. This can be a clock, an output port, a sequential cell, or a clock or data in pin of a sequential cell. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous.

• through – Defines a set of pins, ports, cells, or nets through which the desired path(s) must pass. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous. Defines a set of pins, ports, cells, or nets through which the desired path(s) must pass. These do not have to be objects that are directly represented in the SPIRIT data model. Use the pathElement attribute to indicate the type of object referred to if it might be ambiguous.

Parameters:

• from_value (Iterable[From])

• to (Iterable[To])

• through (Iterable[Through])

class From(value: str = '', path_element: org.accellera.spirit.v1_2.path_element_type.PathElementType | None = None)

Bases: object

Parameters:

• value (str)

• path_element (PathElementType | None)

path_element: PathElementType | None

value: str

class Through(value: str = '', path_element: org.accellera.spirit.v1_2.path_element_type.PathElementType | None = None)

Bases: object

Parameters:

• value (str)

• path_element (PathElementType | None)

path_element: PathElementType | None

value: str

class To(value: str = '', path_element: org.accellera.spirit.v1_2.path_element_type.PathElementType | None = None)

Bases: object

Parameters:

• value (str)

• path_element (PathElementType | None)

path_element: PathElementType | None

value: str

from_value: Iterable[From]

through: Iterable[Through]

to: Iterable[To]

class org.accellera.spirit.v1_2.PersistentDataType(id: str | None = None)

Bases: object

Parameters:

id (str | None)

id: str | None

class org.accellera.spirit.v1_2.PersistentInstanceData(id=None)

Bases: PersistentDataType

A container for any data that is specific to this instance of the design object.

The contents are not interpreted or validated by the Design Environment. This element will be saved with the design and restored when the design is loaded. It is indended to be used by generators to store and retrieve instance specific data.

Parameters:

id (str | None)

id: str | None

class org.accellera.spirit.v1_2.Phase(value=None, scope=PhaseScopeType.GLOBAL)

Bases: object

This is an non-negative floating point number that is used to sequence when a generator is run.

The generators are run in order starting with zero. There may be multiple generators with the same phase number. In this case, the order should not matter with respect to other generators at the same phase. If no phase number is given the generator will be considered in the “last” phase and these generators will be run in the order in which they are encountered while processing generator elements.

Parameters:

• value (float | None)

• scope (PhaseScopeType)

scope: PhaseScopeType

value: float | None

class org.accellera.spirit.v1_2.PhaseScopeType(*values)

Bases: Enum

GLOBAL = 'global'

LOCAL = 'local'

class org.accellera.spirit.v1_2.Pmd(vendor=None, library=None, name=None, version=None, applies_to=None, depends_on=None, transformer=None, choices=None)

Bases: object

The root element of the platform meta-data definition file.

This file defines the Platform meta-data to be applied to specific IP

Variables:

• vendor – Name of the vendor who supplies this file.

• library – Name of the logical library this element belongs to.

• name – The name of the object.

• version

• applies_to – Defines the components that this pmd applies to. When the user tries to add any of those components, this pmd will be applied.

• depends_on – Defines the components that must exist in the current design for this pmd to apply. The pmd will only apply if an instance of each components declared in this list exists in the design. If the list is empty then this pmd file will apply unconditionally.

• transformer – The transformer element contains references to the actual code that will make the transformation. If there are multiple elements, they will be applied in sequence. i.e., the affected component document will pass through a pipeline of transformers with each child element representing a step in a pipeline.

• choices

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• applies_to (AppliesTo | None)

• depends_on (DependsOn | None)

• transformer (Transformer | None)

• choices (Choices | None)

class AppliesTo(component_ref=<factory>)

Bases: object

Variables:

component_ref – A vendor-library-name-version identifier used to refer to components.

Parameters:

component_ref (Iterable[ComponentRef])

class ComponentRef(vendor=None, library=None, name=None, version=None, display_label=None)

Bases: LibraryRefType

Variables:

display_label – A display label to override the original component’s display label if this PMD will apply.

Parameters:

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

• display_label (str | None)

display_label: str | None

library: str | None

name: str | None

vendor: str | None

version: str | None

component_ref: Iterable[ComponentRef]

class DependsOn(component_ref=<factory>)

Bases: object

Variables:

component_ref – A vendor-library-name-version identifier used to refer to components.

Parameters:

component_ref (Iterable[LibraryRefType])

component_ref: Iterable[LibraryRefType]

class Transformer(xslt=<factory>)

Bases: object

Variables:

xslt – An XSLT transformer that will transform the document based on rules defined in the xsl file mentioned here.

Parameters:

xslt (Iterable[Xslt])

class Xslt(style_sheet=None, parameter=<factory>)

Bases: object

Variables:

• style_sheet – The relative path to the xsl stylesheet to be used for transformation.

• parameter – Parameters to be passed to the xslt stylesheet at run time.

Parameters:

• style_sheet (str | None)

• parameter (Iterable[NameValuePairType])

parameter: Iterable[NameValuePairType]

style_sheet: str | None

xslt: Iterable[Xslt]

applies_to: AppliesTo | None

choices: Choices | None

depends_on: DependsOn | None

library: str | None

name: str | None

transformer: Transformer | None

vendor: str | None

version: str | None

class org.accellera.spirit.v1_2.RangeTypeType(*values)

Bases: Enum

This type is used to indicate how the minimum and maximum attributes values should be interpreted.

For purposes of this attribute, an int is 4 bytes and a long is 8 bytes.

FLOAT = 'float'

INT = 'int'

LONG = 'long'

UNSIGNED_INT = 'unsigned int'

UNSIGNED_LONG = 'unsigned long'

class org.accellera.spirit.v1_2.RelativeClockType(*values)

Bases: Enum

Indicates legal values for associating a clock with timing exception.

END = 'end'

START = 'start'

class org.accellera.spirit.v1_2.RemapStates(remap_state=<factory>)

Bases: object

Contains a list of remap state names and associated signal values.

Variables:

remap_state – Contains a list of signals and values which tell the decoder to enter this remap state. The name attribute identifies the name of the state

Parameters:

remap_state (Iterable[RemapState])

class RemapState(remap_signal=<factory>, name=None)

Bases: object

Variables:

• remap_signal – Contains the name and value of a signal on the component, the value indicates the logic value which this signal must take to effect the remapping. The id attribute stores the name of the signal which takes that value.

• name – Stores the name of the state

Parameters:

• remap_signal (Iterable[RemapSignal])

• name (str | None)

class RemapSignal(value=None, id=None)

Bases: object

Variables:

• value

• id – This attribute identifies a signal on the component which affects the component’s memory layout

Parameters:

• value (bool | None)

• id (str | None)

id: str | None

value: bool | None

name: str | None

remap_signal: Iterable[RemapSignal]

remap_state: Iterable[RemapState]

class org.accellera.spirit.v1_2.RequiresDriver(value=None, driver_type=RequiresDriverDriverType.ANY)

Bases: object

Specifies if a signal requires a driver.

Default is false. The attribute driverType can further qualify what type of driver is required. Undefined behaviour if direction is not input or inout. Driver type any indicates that any unspecified type of driver must be connected

Parameters:

• value (bool | None)

• driver_type (RequiresDriverDriverType)

driver_type: RequiresDriverDriverType

value: bool | None

class org.accellera.spirit.v1_2.RequiresDriverDriverType(*values)

Bases: Enum

ANY = 'any'

CLOCK = 'clock'

SINGLE_SHOT = 'singleShot'

class org.accellera.spirit.v1_2.Resistance(value=None, units=None)

Bases: object

Represents a simple resistance value with optional units.

Parameters:

• value (float | None)

• units (ResistanceValueUnitType | None)

units: ResistanceValueUnitType | None

value: float | None

class org.accellera.spirit.v1_2.ResistanceValueUnitType(*values)

Bases: Enum

Indicates legal units for resistance values.

KOHM = 'kohm'

OHM = 'ohm'

class org.accellera.spirit.v1_2.ResolveType(*values)

Bases: Enum

Determines how a property is resolved.

Immediate means the value is included in the XML document and cannot be changed by the user. User means the value must be obtained from the user. Optional means the user is given the opportunity to supply a value, but can leave the entry blank. Dependent means the value depends on the value of other properties. A dependency expression must be supplied in the dependency attribute. Generated means the value will be provided by a generator.

Variables:

• IMMEDIATE – Property value is included in the XML file. It cannot be configured.

• USER – Property content can be modified through confiugration. Modifications will be saved with the design.

• DEPENDENT – Property value is expressed as an XPath expression which may refer to other properties. The expression must appear in the dendency attribute.

• GENERATED – Generators may modify this property. Modifications get saved with the design.

DEPENDENT = 'dependent'

GENERATED = 'generated'

IMMEDIATE = 'immediate'

USER = 'user'

class org.accellera.spirit.v1_2.ResolvedLibraryRefType(value='', vendor=None, library=None, name=None, version=None)

Bases: object

Resolved SPIRIT document reference type.

Contains vendor, library, name and version attributes and the URI of the referenced SPIRIT document

Parameters:

• value (str)

• vendor (str | None)

• library (str | None)

• name (str | None)

• version (str | None)

library: str | None

name: str | None

value: str

vendor: str | None

version: str | None

class org.accellera.spirit.v1_2.Signal(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=None, signal_constraint_sets=None, vendor_extensions=None)

Bases: SignalType

Describes signal charateristics.

Parameters:

• name (str | None)

• direction (ComponentSignalDirectionType | None)

• left (SignalType.Left | None)

• right (SignalType.Right | None)

• default_value (SignalValueType | None)

• clock_driver (ClockDriver | None)

• single_shot_driver (SingleShotDriver | None)

• export (SignalType.Export | None)

• signal_constraint_sets (SignalConstraintSets | None)

• vendor_extensions (VendorExtensions | None)

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

clock_driver: ClockDriver | None

default_value: SignalValueType | None

direction: ComponentSignalDirectionType | None

export: 'SignalType.Export' | None

left: 'SignalType.Left' | None

name: str | None

right: 'SignalType.Right' | None

signal_constraint_sets: SignalConstraintSets | None

single_shot_driver: SingleShotDriver | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.SignalConstraintSets(signal_constraints=<factory>)

Bases: object

List of signalConstraints elements for a component signal.

Parameters:

signal_constraints (Iterable[SignalConstraints])

signal_constraints: Iterable[SignalConstraints]

class org.accellera.spirit.v1_2.SignalConstraints(drive_constraint=None, load_constraint=None, timing_constraint=<factory>, design_rule_constraints=None, constraint_set_id='default')

Bases: object

Defines constraints that apply to a component signal.

If multiple signalConstraints elements are used, each must have a unique value for the constraintSet attribute.

Parameters:

• drive_constraint (DriveConstraint | None)

• load_constraint (LoadConstraint | None)

• timing_constraint (Iterable[TimingConstraint])

• design_rule_constraints (DesignRuleConstraints | None)

• constraint_set_id (str)

constraint_set_id: str

design_rule_constraints: DesignRuleConstraints | None

drive_constraint: DriveConstraint | None

load_constraint: LoadConstraint | None

timing_constraint: Iterable[TimingConstraint]

class org.accellera.spirit.v1_2.SignalType(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=None, signal_constraint_sets=None, vendor_extensions=None)

Bases: object

Variables:

• name – The name of the signal.

• direction

• left – Left vector bound.

• right – Right vector bound.

• default_value – The initial or default value on the signal.

• clock_driver

• single_shot_driver

• export – Specifies whether a signal is to be exported out of the module.

• signal_constraint_sets

• vendor_extensions

Parameters:

• name (str | None)

• direction (ComponentSignalDirectionType | None)

• left (Left | None)

• right (Right | None)

• default_value (SignalValueType | None)

• clock_driver (ClockDriver | None)

• single_shot_driver (SingleShotDriver | None)

• export (Export | None)

• signal_constraint_sets (SignalConstraintSets | None)

• vendor_extensions (VendorExtensions | None)

class Export(value=None, format=FormatType.BOOL, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The bool.att attribute group sets the default format to “bool”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (bool | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: bool | None

class Left(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

class Right(value=None, format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, prompt=None)

Bases: object

Variables:

• value

• format – This is a hint to the user interface about the data format to require for user resolved properties. The long.att attribute group sets the default format to “long”.

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• prompt

Parameters:

• value (int | None)

• format (FormatType)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: int | None

clock_driver: ClockDriver | None

default_value: SignalValueType | None

direction: ComponentSignalDirectionType | None

export: Export | None

left: Left | None

name: str | None

right: Right | None

signal_constraint_sets: SignalConstraintSets | None

single_shot_driver: SingleShotDriver | None

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.SignalValueType(strength=<factory>, value=None)

Bases: object

Describes a signal value.

The signal value can be just a value (number), a strength, or both. If the “value” is not given, it should be considered an X (unknown). A weak strength with no value given is considered Z (tristate).

Parameters:

• strength (Iterable[Strength])

• value (Value | None)

strength: Iterable[Strength]

value: Value | None

class org.accellera.spirit.v1_2.SingleShotDriver(single_shot_offset=None, single_shot_value=None, single_shot_duration=None)

Bases: object

Describes a driven one-shot signal.

Variables:

• single_shot_offset – Time in nanoseconds until start of one- shot.

• single_shot_value – Value of signal after first edge of one- shot.

• single_shot_duration – Duration in nanoseconds of the one shot.

Parameters:

• single_shot_offset (SingleShotOffset | None)

• single_shot_value (SingleShotValue | None)

• single_shot_duration (SingleShotDuration | None)

class SingleShotDuration(value=<factory>, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: Iterable[float]

class SingleShotOffset(value=<factory>, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (Iterable[float])

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: Iterable[float]

class SingleShotValue(value='', resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (str)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: str

single_shot_duration: SingleShotDuration | None

single_shot_offset: SingleShotOffset | None

single_shot_value: SingleShotValue | None

class org.accellera.spirit.v1_2.SourceFileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'

CPP_SOURCE = 'cppSource'

C_SOURCE = 'cSource'

EXECUTABLE_HDL = 'executableHdl'

E_SOURCE = 'eSource'

OVASOURCE = 'OVASource'

PERL_SOURCE = 'perlSource'

PSL_SOURCE = 'pslSource'

SVASOURCE = 'SVASource'

SW_OBJECT = 'swObject'

SW_OBJECT_LIBRARY = 'swObjectLibrary'

SYSTEM_CSOURCE = 'systemCSource'

SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'

SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'

SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'

SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'

SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'

SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'

SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'

TCL_SOURCE = 'tclSource'

UNELABORATED_HDL = 'unelaboratedHdl'

UNKNOWN = 'unknown'

VERA_SOURCE = 'veraSource'

VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'

VERILOG_SOURCE = 'verilogSource'

VERILOG_SOURCE_2001 = 'verilogSource-2001'

VERILOG_SOURCE_95 = 'verilogSource-95'

VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'

VHDL_SOURCE = 'vhdlSource'

VHDL_SOURCE_87 = 'vhdlSource-87'

VHDL_SOURCE_93 = 'vhdlSource-93'

class org.accellera.spirit.v1_2.Strength(value=None, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

The strength of the signal.

“strong” (default) or “weak”.

Variables:

• value

• resolve

• id

• dependency

• any_attributes

• minimum – For user-resolved properties with numeric values, this indicates the minimum value allowed.

• maximum – For user-resolved properties with numeric values, this indicates the maximum value allowed.

• range_type

• order – For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order.

• choice_ref – For user resolved properties with a “choice” format, this refers to a uiChoice element in the ui section of the component file.

• choice_style

• direction

• config_groups

• format

• prompt

Parameters:

• value (StrengthType | None)

• resolve (ResolveType)

• id (str | None)

• dependency (str | None)

• any_attributes (Mapping[str, str])

• minimum (str | None)

• maximum (str | None)

• range_type (RangeTypeType)

• order (float | None)

• choice_ref (str | None)

• choice_style (ChoiceStyleValue | None)

• direction (DirectionValue | None)

• config_groups (Iterable[str])

• format (FormatType | None)

• prompt (str | None)

any_attributes: Mapping[str, str]

choice_ref: str | None

choice_style: ChoiceStyleValue | None

config_groups: Iterable[str]

dependency: str | None

direction: DirectionValue | None

format: FormatType | None

id: str | None

maximum: str | None

minimum: str | None

order: float | None

prompt: str | None

range_type: RangeTypeType

resolve: ResolveType

value: StrengthType | None

class org.accellera.spirit.v1_2.StrengthType(*values)

Bases: Enum

Describes a signal strength.

STRONG = 'strong'

WEAK = 'weak'

class org.accellera.spirit.v1_2.SubspaceRefType(base_address=None, bit_offset=None, parameter=<factory>, vendor_extensions=None, master_ref=None)

Bases: object

Address subspace type.

Its subspaceReference attribute references the subspace from which the dimensions are taken.

Variables:

• base_address

• bit_offset

• parameter – Any parameters that may apply to the subspace reference.

• vendor_extensions

• master_ref

Parameters:

• base_address (BaseAddress | None)

• bit_offset (BitOffset | None)

• parameter (Iterable[NameValuePairType])

• vendor_extensions (VendorExtensions | None)

• master_ref (str | None)

base_address: BaseAddress | None

bit_offset: BitOffset | None

master_ref: str | None

parameter: Iterable[NameValuePairType]

vendor_extensions: VendorExtensions | None

class org.accellera.spirit.v1_2.TimedPath(path_specifier=None, delay=None, path_edge=None, delay_type=None)

Bases: object

Defines a point-to-point timing exception.

The pathEdge attribute can be used to restrict the constraint to rising or falling edges, and the delayType attribute can be used to restrict the constraint to imply a minimum path constraint or a maximum path constraint.

Parameters:

• path_specifier (PathSpecifier | None)

• delay (Delay | None)

• path_edge (EdgeValueType | None)

• delay_type (DelayValueType | None)

delay: Delay | None

delay_type: DelayValueType | None

path_edge: EdgeValueType | None

path_specifier: PathSpecifier | None

class org.accellera.spirit.v1_2.TimingConstraint(percent_of_period=None, delay=None, clock_edge=None, delay_type=None, clock_name=None)

Bases: object

Defines a timing constraint for the associated signal.

The constraint is relative to the clock specified by the clockName attribute. The clockEdge indicates which clock edge the constraint is associated with (default is rising edge). The delayType attribute can be specified to further refine the constraint.

Variables:

• percent_of_period – Defines a delay constraint value which is defined as a percentage of the corresponding clock cycle time.

• delay – Defines an absolute delay constraint value. The units attribute can be used to specify units if needed. The default units are ns.

• clock_edge

• delay_type

• clock_name

Parameters:

• percent_of_period (float | None)

• delay (Delay | None)

• clock_edge (EdgeValueType | None)

• delay_type (DelayValueType | None)

• clock_name (str | None)

clock_edge: EdgeValueType | None

clock_name: str | None

delay: Delay | None

delay_type: DelayValueType | None

percent_of_period: float | None

class org.accellera.spirit.v1_2.TransportMethodsTransportMethod(*values)

Bases: Enum

FILE = 'file'

class org.accellera.spirit.v1_2.UsageType(*values)

Bases: Enum

Describes the usage of an address block.

Variables:

• MEMORY – Denotes an address range that can be used for read- write or read-only data storage.

• REGISTER – Denotes an address block that is used to communicate with hardware.

• RESERVED – Denotes an address range that must remain unoccupied.

MEMORY = 'memory'

REGISTER = 'register'

RESERVED = 'reserved'

class org.accellera.spirit.v1_2.VendorExtensions(any_element=<factory>)

Bases: object

Container for vendor specific extensions.

Variables:

any_element – Accepts any element(s) the content provider wants to put here, including elements from the SPIRIT namespace.

Parameters:

any_element (Iterable[object])

any_element: Iterable[object]

class org.accellera.spirit.v1_2.ViewType(name='default', env_identifier=<factory>, hierarchy_ref=None, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, constraint_set_ref=<factory>, whitebox_element_refs=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

• name – Name of the view. Must be unique within a component.

• env_identifier – Defines the hardware environment in which this view applies. The format of the string is language:tool:vendor_extension, with each piece being optional. The language must be one of the types from spirit:fileType. The tool values are defined by the SPIRIT Consortium, and include generic values “*Simulation” and “*Synthesis” to imply any tool of the indicated type. Having more than one envIdentifier indicates that the view applies to multiple environments.

• hierarchy_ref – References a SPIRIT design or configuration document (by VLNV) that provides a design for the component

• language – The hardware description language used such as “verilog” or “vhdl”. If the attribute “strict” is “true”, this value must match the language being generated for the design.

• model_name – HDL-specific name to identify the model.

• default_file_builder

• file_set_ref

• constraint_set_ref

• whitebox_element_refs – Container for white box element references.

• parameter

• vendor_extensions

Parameters:

• name (str)

• env_identifier (Iterable[str])

• hierarchy_ref (LibraryRefType | None)

• language (Language | None)

• model_name (str | None)

• default_file_builder (Iterable[FileBuilderType])

• file_set_ref (Iterable[FileSetRef])

• constraint_set_ref (Iterable[ConstraintSetRef])

• whitebox_element_refs (WhiteboxElementRefs | None)

• parameter (Iterable[Parameter])

• vendor_extensions (VendorExtensions | None)

class Language(value: str = '', strict: bool | None = None)

Bases: object

Parameters:

• value (str)

• strict (bool | None)

strict: bool | None

value: str

class WhiteboxElementRefs(whitebox_element_ref=<factory>)

Bases: object

Variables:

whitebox_element_ref – Reference to a white box element which is visible within this view.

Parameters:

whitebox_element_ref (Iterable[WhiteboxElementRefType])

whitebox_element_ref: Iterable[WhiteboxElementRefType]

constraint_set_ref: Iterable[ConstraintSetRef]

default_file_builder: Iterable[FileBuilderType]

env_identifier: Iterable[str]

file_set_ref: Iterable[FileSetRef]

hierarchy_ref: LibraryRefType | None

language: Language | None

model_name: str | None

name: str

parameter: Iterable[Parameter]

vendor_extensions: VendorExtensions | None

whitebox_element_refs: WhiteboxElementRefs | None

class org.accellera.spirit.v1_2.Volatile(value=False)

Bases: object

Indicates whether the data is volatile, default to false when not present.

Parameters:

value (bool)

value: bool

class org.accellera.spirit.v1_2.WhiteboxElementRefType(whitebox_path=<factory>, name=None)

Bases: object

Reference to a whiteboxElement within a view.

The ‘name’ attribute must refer to a whiteboxElement defined within this component.

Variables:

• whitebox_path – The whiteboxPath elements (as a set) define the name(s) needed to define the entire white box element in this view.

• name

Parameters:

• whitebox_path (Iterable[WhiteboxPath])

• name (str | None)

class WhiteboxPath(path_name=None, left=None, right=None)

Bases: object

Variables:

• path_name – The view specific name for a portion of the white box element.

• left – Indicates the left bound value for the associated path name.

• right – Indicates the right bound values for the associated path name.

Parameters:

• path_name (str | None)

• left (int | None)

• right (int | None)

left: int | None

path_name: str | None

right: int | None

name: str | None

whitebox_path: Iterable[WhiteboxPath]

class org.accellera.spirit.v1_2.WhiteboxElementType(name=None, whitebox_type=None, driveable=None, description=None, register_ref=None)

Bases: object

Defines a white box reference point within the component.

Variables:

• name – Indicates the name of the white box element. This name is referenced from the whiteboxElementRef inside of a view.

• whitebox_type – Indicates the type of the element. The pin and signal types refer to elements within the HDL description. The register type refers to a register in the memory map. The interface type refers to a bus interface in a lower level component definition.

• driveable – If true, indicates that the white box element can be driven (e.g. have a new value forced into it).

• description – Description of the white box element.

• register_ref – Indicates the name of the register associated with this white box element. The name must refer to a spirit:register defined within this component. When specified, the whiteboxType must be ‘register’.

Parameters:

• name (str | None)

• whitebox_type (WhiteboxElementTypeWhiteboxType | None)

• driveable (bool | None)

• description (str | None)

• register_ref (str | None)

description: str | None

driveable: bool | None

name: str | None

register_ref: str | None

whitebox_type: WhiteboxElementTypeWhiteboxType | None

class org.accellera.spirit.v1_2.WhiteboxElementTypeWhiteboxType(*values)

Bases: Enum

INTERFACE = 'interface'

PIN = 'pin'

REGISTER = 'register'

SIGNAL = 'signal'