org.accellera.spirit.v1_0 package

Submodules

org.accellera.spirit.v1_0.access module

class org.accellera.spirit.v1_0.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_0.access_type module

org.accellera.spirit.v1_0.ad_hoc_connection module

class org.accellera.spirit.v1_0.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:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.ad_hoc_connections module

class org.accellera.spirit.v1_0.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_0.add_rem_change module

class org.accellera.spirit.v1_0.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_0.add_rem_change_value module

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

Bases: Enum

ADD = 'add'
REMOVE = 'remove'

org.accellera.spirit.v1_0.add_rem_rep_change module

class org.accellera.spirit.v1_0.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_0.add_rem_rep_change_value module

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

Bases: Enum

ADD = 'add'
REMOVE = 'remove'
REPLACE = 'replace'

org.accellera.spirit.v1_0.addr_space_ref_type module

class org.accellera.spirit.v1_0.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_0.address_bank_type module

class org.accellera.spirit.v1_0.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:
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_0.address_block module

class org.accellera.spirit.v1_0.address_block.AddressBlock(base_address=None, bit_offset=None, range=None, width=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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset_value=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Register name.

  • dim – Dimensions a register array.

  • 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_value – 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 (int | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • dependency (Iterable[Dependency])

  • reset_value (str | 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
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_value: str | None
size: int | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
access: Access | None
base_address: BaseAddress | None
bit_offset: BitOffset | 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_0.address_block_type module

class org.accellera.spirit.v1_0.address_block_type.AddressBlockType(base_address=None, bit_offset=None, range=None, width=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. If zero or absent and this is part of a slave memory map, the width is assumed to be the data width of the slave interface. It this is part of a local memory map, a missing width is assumed to be the effective width of the address space. If this is part of an address space definition, a missing width is assumed to be the widest data signal of all bus interfaces that reference this address space.

  • 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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset_value=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Register name.

  • dim – Dimensions a register array.

  • 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_value – 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 (int | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • dependency (Iterable[Dependency])

  • reset_value (str | 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
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_value: str | None
size: int | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
access: Access | None
base_address: BaseAddress | None
bit_offset: BitOffset | 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_0.address_space_endianness module

class org.accellera.spirit.v1_0.address_space_endianness.AddressSpaceEndianness(*values)

Bases: Enum

BIG = 'big'
LITTLE = 'little'

org.accellera.spirit.v1_0.address_space_ref module

class org.accellera.spirit.v1_0.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_0.address_spaces module

class org.accellera.spirit.v1_0.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. If zero or absent and this is part of a slave memory map, the width is assumed to be the data width of the slave interface. It this is part of a local memory map, a missing width is assumed to be the effective width of the address space. If this is part of an address space definition, a missing width is assumed to be the widest data signal of all bus interfaces that reference this address space.

  • bits_in_lau

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

  • 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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
bits_in_lau: BitsInLau | None
endianness: AddressSpaceEndianness | 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_0.bank module

org.accellera.spirit.v1_0.bank_alignment_type module

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

Bases: Enum

‘serial’ or ‘parallel’ bank alignment.

PARALLEL = 'parallel'
SERIAL = 'serial'

org.accellera.spirit.v1_0.banked_bank_type module

class org.accellera.spirit.v1_0.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:
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_0.banked_block_type module

class org.accellera.spirit.v1_0.banked_block_type.BankedBlockType(range=None, width=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=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. If zero or absent and this is part of a slave memory map, the width is assumed to be the data width of the slave interface. It this is part of a local memory map, a missing width is assumed to be the effective width of the address space. If this is part of an address space definition, a missing width is assumed to be the widest data signal of all bus interfaces that reference this address space.

  • 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

Parameters:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset_value=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Register name.

  • dim – Dimensions a register array.

  • 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_value – 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 (int | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • dependency (Iterable[Dependency])

  • reset_value (str | 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
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_value: str | None
size: int | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
access: Access | 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_0.banked_subspace_type module

class org.accellera.spirit.v1_0.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:
master_ref: str | None
parameter: Iterable[NameValuePairType]
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.base_address module

class org.accellera.spirit.v1_0.base_address.BaseAddress(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str

org.accellera.spirit.v1_0.bit_offset module

class org.accellera.spirit.v1_0.bit_offset.BitOffset(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None

org.accellera.spirit.v1_0.bit_steering_type module

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

Bases: Enum

DEFAULT = 'default'
OFF = 'off'
ON = 'on'

org.accellera.spirit.v1_0.bits_in_lau module

class org.accellera.spirit.v1_0.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_0.bus_definition module

class org.accellera.spirit.v1_0.bus_definition.BusDefinition(vendor=None, library=None, name=None, version=None, direct_connection=None, extends=None, max_masters=None, max_slaves=None, signals=None, choices=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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • version

  • direct_connection – When present 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. Default value of zero means unbounded.

  • max_slaves – Indicates the maximum number of slaves this bus supports. Default value of zero means unbounded.

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

  • choices

  • vendor_extensions

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • direct_connection (bool | None)

  • extends (LibraryRefType | None)

  • max_masters (int | None)

  • max_slaves (int | None)

  • signals (Signals | None)

  • choices (Choices | None)

  • vendor_extensions (VendorExtensions | None)

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, 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 clock information.

  • is_reset – Is this element is present, the signal contains 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.

  • 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)

  • vendor_extensions (VendorExtensions | None)

class DefaultValue(strength=<factory>, value=None)

Bases: object

Variables:

  • strength – The strength of the signal. “strong” (default) or “weak”

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

Parameters:
strength: Iterable[DefaultValueStrength]
value: object | 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 th enumber 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.

Parameters:
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 th enumber 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.

Parameters:
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 th enumber 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.

Parameters:

  • group (str | None)

  • bit_width (int | None)

  • direction (OnSystemValue | None)

bit_width: int | None
direction: OnSystemValue | None
group: str | 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]
choices: Choices | None
direct_connection: bool | None
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_0.bus_interface module

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

Bases: BusInterfaceType

Describes one of the bus interfaces supported by this component.

Parameters:
class BitSteering(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: BitSteeringType | None
class ExportedInterface(component_ref=None, interface_ref=None)

Bases: object

Variables:

  • component_ref – Indicates name of the sub-component containing the interface being exported.

  • interface_ref – Indicates the name of the sub-component bus interface being exported.

Parameters:

  • component_ref (str | None)

  • interface_ref (str | None)

component_ref: str | None
interface_ref: str | None
class Index(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_0.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:
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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str)

  • state (str | None)

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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description. The text content of this element identifies a signal on this component bu its signal name. The busSignal attribute names the corresponding signal in the bus definition. The optional attributes left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(value: str = '', bus_signal: str | None = None, left: int | None = None, right: int | None = None)

Bases: object

Parameters:

  • value (str)

  • bus_signal (str | None)

  • left (int | None)

  • right (int | None)

bus_signal: str | None
left: int | None
right: int | None
value: str
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

Parameters:
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

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_0.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_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
bit_steering: 'BusInterfaceType.BitSteering' | None
bus_type: LibraryRefType | None
configurators: Configurators | None
connection: BusInterfaceTypeConnection | None
exported_interface: 'BusInterfaceType.ExportedInterface' | None
index: 'BusInterfaceType.Index' | None
master: 'BusInterfaceType.Master' | None
mirrored_master: object | None
mirrored_slave: 'BusInterfaceType.MirroredSlave' | None
mirrored_system: 'BusInterfaceType.MirroredSystem' | None
name: str | None
other_attributes: Mapping[str, str]
signal_map: 'BusInterfaceType.SignalMap' | None
slave: 'BusInterfaceType.Slave' | None
system: 'BusInterfaceType.System' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.bus_interface_type module

class org.accellera.spirit.v1_0.bus_interface_type.BusInterfaceType(name=None, bus_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, exported_interface=None, connection=None, signal_map=None, index=None, bit_steering=None, configurators=None, vendor_extensions=None, other_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.

  • exported_interface – If this element is present, this interface represents an interface being exported from a sub-component. The type of interface (master, slave, …) should be obtained from the sub-component 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 – Maps component signals to 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” or “default”.

  • configurators – Configuration generators for bus interfaces.

  • vendor_extensions

  • other_attributes

Parameters:
class BitSteering(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: BitSteeringType | None
class ExportedInterface(component_ref=None, interface_ref=None)

Bases: object

Variables:

  • component_ref – Indicates name of the sub-component containing the interface being exported.

  • interface_ref – Indicates the name of the sub-component bus interface being exported.

Parameters:

  • component_ref (str | None)

  • interface_ref (str | None)

component_ref: str | None
interface_ref: str | None
class Index(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_0.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:
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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str)

  • state (str | None)

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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description. The text content of this element identifies a signal on this component bu its signal name. The busSignal attribute names the corresponding signal in the bus definition. The optional attributes left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(value: str = '', bus_signal: str | None = None, left: int | None = None, right: int | None = None)

Bases: object

Parameters:

  • value (str)

  • bus_signal (str | None)

  • left (int | None)

  • right (int | None)

bus_signal: str | None
left: int | None
right: int | None
value: str
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

Parameters:
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

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_0.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_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
bit_steering: BitSteering | None
bus_type: LibraryRefType | None
configurators: Configurators | None
connection: BusInterfaceTypeConnection | None
exported_interface: ExportedInterface | None
index: Index | None
master: Master | None
mirrored_master: object | None
mirrored_slave: MirroredSlave | None
mirrored_system: MirroredSystem | None
name: str | None
other_attributes: Mapping[str, str]
signal_map: SignalMap | None
slave: Slave | None
system: System | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.bus_interface_type_connection module

class org.accellera.spirit.v1_0.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_0.bus_interfaces module

class org.accellera.spirit.v1_0.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_0.channels module

class org.accellera.spirit.v1_0.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(max_masters=None, max_slaves=None, bus_interface_ref=<factory>)

Bases: object

Variables:

  • 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.

Parameters:

  • 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
channel: Iterable[Channel]

org.accellera.spirit.v1_0.choice_style_value module

class org.accellera.spirit.v1_0.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_0.choices module

class org.accellera.spirit.v1_0.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_0.clock_driver module

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

Bases: object

Describes a driven clock signal.

Variables:

  • clock_period – Clock period in nanoseconds

  • clock_pulse_offset – Time in nanoseconds until first pulse.

  • clock_pulse_value – Value of signal after first clock edge.

  • clock_pulse_duration – Duration in nanoseconds of first state in cycle.

Parameters:
class ClockPeriod(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class ClockPulseDuration(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class ClockPulseOffset(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class ClockPulseValue(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None

org.accellera.spirit.v1_0.component module

class org.accellera.spirit.v1_0.component.Component(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, component_instances=None, interconnections=None, remap_states=None, address_spaces=None, memory_maps=None, hw_model=None, component_generators=None, configurators=None, choices=None, file_sets=None, cpus=None, parameter=<factory>, vendor_extensions=None)

Bases: ComponentType

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

Parameters:
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:
address_space_ref: Iterable[AddressSpaceRef]
name: str | None
parameter: Iterable[Parameter]
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
component_instances: ComponentInstances | None
configurators: Configurators | None
cpus: 'ComponentType.Cpus' | None
file_sets: FileSets | None
hw_model: HwModel | None
interconnections: Interconnections | None
library: str | None
memory_maps: MemoryMaps | None
name: str | None
parameter: Iterable[Parameter]
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_0.component_generator module

class org.accellera.spirit.v1_0.component_generator.ComponentGenerator(name=None, phase=None, parameter=<factory>, access_type=None, loose_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.

Parameters:
access_type: 'GeneratorType.AccessType' | None
group: Iterable[str]
hidden: bool
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
scope: InstanceGeneratorTypeScope
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.component_generators module

class org.accellera.spirit.v1_0.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_0.component_instance module

class org.accellera.spirit.v1_0.component_instance.ComponentInstance(instance_name=None, component_ref=None, configuration=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

Parameters:
component_ref: LibraryRefType | None
configuration: Configuration | None
instance_name: InstanceName | None

org.accellera.spirit.v1_0.component_instances module

class org.accellera.spirit.v1_0.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_0.component_signal_direction_type module

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

Bases: Enum

The direction of a component signal.

IN = 'in'
INOUT = 'inout'
OUT = 'out'

org.accellera.spirit.v1_0.component_type module

class org.accellera.spirit.v1_0.component_type.ComponentType(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, component_instances=None, interconnections=None, remap_states=None, address_spaces=None, memory_maps=None, hw_model=None, component_generators=None, configurators=None, choices=None, file_sets=None, cpus=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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • version

  • bus_interfaces

  • channels

  • component_instances

  • interconnections

  • remap_states

  • address_spaces

  • memory_maps

  • hw_model

  • component_generators – Generator list is tools-specific.

  • configurators

  • choices

  • file_sets

  • cpus – cpu’s in the component

  • parameter

  • vendor_extensions

Parameters:
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:
address_space_ref: Iterable[AddressSpaceRef]
name: str | None
parameter: Iterable[Parameter]
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
component_instances: ComponentInstances | None
configurators: Configurators | None
cpus: Cpus | None
file_sets: FileSets | None
hw_model: HwModel | None
interconnections: Interconnections | None
library: str | None
memory_maps: MemoryMaps | None
name: str | None
parameter: Iterable[Parameter]
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_0.configurable_element module

class org.accellera.spirit.v1_0.configurable_element.ConfigurableElement(reference_id=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None, content=<factory>)

Bases: object

Describes the configurable content of an element in the instance.

May contain text and/or child elements. The required referenceId attribute refers to the ID attribute of the configurable element.

Variables:

  • reference_id

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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])

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
reference_id: str | None
resolve: ResolveType | None

org.accellera.spirit.v1_0.configuration module

class org.accellera.spirit.v1_0.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_0.configurator_ref module

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

Bases: object

A reference to a configurator element.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_0.configurators module

class org.accellera.spirit.v1_0.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_0.data_type_type module

class org.accellera.spirit.v1_0.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_0.default_value_strength module

class org.accellera.spirit.v1_0.default_value_strength.DefaultValueStrength(*values)

Bases: Enum

STRONG = 'strong'
WEAK = 'weak'

org.accellera.spirit.v1_0.dependency module

class org.accellera.spirit.v1_0.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_0.design module

class org.accellera.spirit.v1_0.design.Design(vendor=None, library=None, name=None, version=None, component_instances=None, interconnections=None, ad_hoc_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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • version

  • component_instances

  • interconnections

  • ad_hoc_connections

  • vendor_extensions

Parameters:
ad_hoc_connections: AdHocConnections | None
component_instances: ComponentInstances | None
interconnections: Interconnections | None
library: str | None
name: str | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_0.direction_value module

class org.accellera.spirit.v1_0.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_0.executable_image module

class org.accellera.spirit.v1_0.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:
class FileSetRefGroup(file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_0.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:
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:
class Command(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Flags(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class ReplaceDefaultFlags(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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:
class CommandLineSwitch(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Enable(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class Name(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
file_builder: Iterable[FileBuilder]
linker: Linker | None
linker_command_file: LinkerCommandFile | None
linker_flags: LinkerFlags | None
class Name(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.field_type module

class org.accellera.spirit.v1_0.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 (int | None)

  • access (Access | None)

  • description (str | None)

  • values (Iterable[Values])

  • parameter (Iterable[Parameter])

  • vendor_extensions (VendorExtensions | 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: int | None
description: str | None
name: str | None
parameter: Iterable[Parameter]
values: Iterable[Values]
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.file module

class org.accellera.spirit.v1_0.file.File(name=None, file_type=None, user_file_type=None, logical_name=None, exported_name=<factory>, build_command=None, dependency=<factory>, define=<factory>, image_type=<factory>, vendor_extensions=None, file_id=None, other_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

  • other_attributes

Parameters:
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:
class Command(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Flags(value='', append=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class ReplaceDefaultFlags(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class TargetName(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
build_command: BuildCommand | None
define: Iterable[NameValuePairType]
dependency: Iterable[Dependency]
exported_name: Iterable[str]
file_id: str | None
file_type: FileFileType | None
image_type: Iterable[str]
logical_name: LogicalName | None
name: Name | None
other_attributes: Mapping[str, str]
user_file_type: str | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.file_builder_file_type module

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

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.file_builder_type module

class org.accellera.spirit.v1_0.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:
class Command(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Flags(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class ReplaceDefaultFlags(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.file_builder_type_file_type module

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

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.file_file_type module

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

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.file_set module

class org.accellera.spirit.v1_0.file_set.FileSet(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, sw_function=None, 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:
class SwFunction(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:
class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: Optional[org.accellera.spirit.v1_0.resolve_type.ResolveType] = None, id: Optional[str] = None, dependency: Optional[str] = None, other_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: Optional[org.accellera.spirit.v1_0.range_type_type.RangeTypeType] = None, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_0.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_0.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_0.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_0.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

  • value (str)

  • name (str | None)

  • cross_ref (str | None)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Enabled(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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:
class SourceName(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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: SwFunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
file: Iterable[File]
file_set_id: str | None
group: Iterable[str]
owner: LibraryRefType | None
sw_function: 'FileSetType.SwFunction' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.file_set_ref module

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

Bases: object

A reference to a fileSet.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_0.file_set_type module

class org.accellera.spirit.v1_0.file_set_type.FileSetType(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, sw_function=None, 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

  • sw_function – Generator information if this file set describes a sw 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 single function will be called with different arguments for each instance (e.g. baseAddress).

  • vendor_extensions

  • file_set_id

Parameters:
class SwFunction(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:
class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: Optional[org.accellera.spirit.v1_0.resolve_type.ResolveType] = None, id: Optional[str] = None, dependency: Optional[str] = None, other_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: Optional[org.accellera.spirit.v1_0.range_type_type.RangeTypeType] = None, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_0.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_0.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_0.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_0.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

  • value (str)

  • name (str | None)

  • cross_ref (str | None)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Enabled(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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:
class SourceName(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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: SwFunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
file: Iterable[File]
file_set_id: str | None
group: Iterable[str]
owner: LibraryRefType | None
sw_function: SwFunction | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.file_sets module

class org.accellera.spirit.v1_0.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_0.format_type module

class org.accellera.spirit.v1_0.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_0.generator module

class org.accellera.spirit.v1_0.generator.Generator(name=None, phase=None, parameter=<factory>, access_type=None, loose_generator_exe=None, vendor_extensions=None)

Bases: GeneratorType

Specifies a set of generators.

Parameters:

  • name (str | None)

  • phase (Phase | None)

  • parameter (Iterable[Parameter])

  • access_type (AccessType | None)

  • loose_generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

access_type: 'GeneratorType.AccessType' | None
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.generator_chain module

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

Bases: object

Variables:

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

  • library – Name of the logical library this component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • 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.

  • bus_generator_selector – Selects generators declared in bus definition 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

Parameters:
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:
file_name: LibraryRefType | None
group_selector: GroupSelector | None
unique: bool
bus_generator_selector: Iterable[GeneratorSelectorType]
chain_group: Iterable[str]
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_0.generator_change_list module

class org.accellera.spirit.v1_0.generator_change_list.GeneratorChangeList(component_changes=None, interconnection_changes=None, ad_hoc_connection_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.

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

Parameters:
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:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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
add_rem_change: AddRemChange | None
export: Export | None
name: int | 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:
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 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_0.add_rem_change.AddRemChange | None = None, interconnection: org.accellera.spirit.v1_0.interconnection.Interconnection | None = None)

Bases: object

Parameters:
add_rem_change: AddRemChange | None
interconnection: Interconnection | 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_0.add_rem_change.AddRemChange | None = None, vendor_extensions: org.accellera.spirit.v1_0.vendor_extensions.VendorExtensions | None = None)

Bases: object

Parameters:
add_rem_change: AddRemChange | None
vendor_extensions: VendorExtensions | None
vendor_extension_change: Iterable[VendorExtensionChange]
ad_hoc_connection_changes: AdHocConnectionChanges | None
component_changes: ComponentChanges | None
interconnection_changes: InterconnectionChanges | None
vendor_extension_changes: VendorExtensionChanges | None

org.accellera.spirit.v1_0.generator_ref module

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

Bases: object

A reference to a generator element.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_0.generator_selector_type module

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

Bases: object

Parameters:

group_selector (GroupSelector | None)

group_selector: GroupSelector | None

org.accellera.spirit.v1_0.generator_type module

class org.accellera.spirit.v1_0.generator_type.GeneratorType(name=None, phase=None, parameter=<factory>, access_type=None, loose_generator_exe=None, vendor_extensions=None)

Bases: object

Types of generators.

Variables:

  • name – The name of this generator.

  • phase

  • parameter

  • access_type – Identifies the special requirements that this generator may place up on the DE.

  • loose_generator_exe – The pathname to the executable file that implements the loose generator

  • vendor_extensions

Parameters:

  • name (str | None)

  • phase (Phase | None)

  • parameter (Iterable[Parameter])

  • access_type (AccessType | None)

  • loose_generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

access_type: AccessType | None
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.group module

org.accellera.spirit.v1_0.group_selector module

class org.accellera.spirit.v1_0.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:
multiple_group_selection_operator: GroupSelectorMultipleGroupSelectionOperator
name: Iterable[str]

org.accellera.spirit.v1_0.group_selector_multiple_group_selection_operator module

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

Bases: Enum

AND = 'and'
OR = 'or'

org.accellera.spirit.v1_0.hw_model module

class org.accellera.spirit.v1_0.hw_model.HwModel(views=None, signals=None, hw_parameters=None, vendor_extensions=None)

Bases: HwModelType

Hardware model information.

Parameters:
class HwParameters(hw_parameter=<factory>)

Bases: object

Variables:

hw_parameter – A hardware 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. The name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

hw_parameter (Iterable[NameValueTypeType])

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

Bases: object

Parameters:

signal (Iterable[Signal])

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

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
hw_parameters: 'HwModelType.HwParameters' | None
signals: 'HwModelType.Signals' | None
vendor_extensions: VendorExtensions | None
views: 'HwModelType.Views' | None

org.accellera.spirit.v1_0.hw_model_type module

class org.accellera.spirit.v1_0.hw_model_type.HwModelType(views=None, signals=None, hw_parameters=None, vendor_extensions=None)

Bases: object

Hardware model information.

Variables:

  • views – View container

  • signals – Signal container

  • hw_parameters – Hardware parameter name value pairs container

  • vendor_extensions

Parameters:
class HwParameters(hw_parameter=<factory>)

Bases: object

Variables:

hw_parameter – A hardware 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. The name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

hw_parameter (Iterable[NameValueTypeType])

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

Bases: object

Parameters:

signal (Iterable[Signal])

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

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
hw_parameters: HwParameters | None
signals: Signals | None
vendor_extensions: VendorExtensions | None
views: Views | None

org.accellera.spirit.v1_0.instance_generator_type module

class org.accellera.spirit.v1_0.instance_generator_type.InstanceGeneratorType(name=None, phase=None, parameter=<factory>, access_type=None, loose_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:
access_type: 'GeneratorType.AccessType' | None
group: Iterable[str]
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
scope: InstanceGeneratorTypeScope
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.instance_generator_type_scope module

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

Bases: Enum

ENTITY = 'entity'
INSTANCE = 'instance'

org.accellera.spirit.v1_0.instance_name module

class org.accellera.spirit.v1_0.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_0.interconnection module

class org.accellera.spirit.v1_0.interconnection.Interconnection(component1_ref=None, bus_interface1_ref=None, component2_ref=None, bus_interface2_ref=None)

Bases: object

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

The component1Ref and busInterface1Ref attributes indicate the instance name and bus interface name of one end of the connection. The component2Ref and busInterface2Ref attributes indicate the instance name and bus interface name of the other end of he connection.

Parameters:

  • component1_ref (str | None)

  • bus_interface1_ref (str | None)

  • component2_ref (str | None)

  • bus_interface2_ref (str | None)

bus_interface1_ref: str | None
bus_interface2_ref: str | None
component1_ref: str | None
component2_ref: str | None

org.accellera.spirit.v1_0.interconnections module

class org.accellera.spirit.v1_0.interconnections.Interconnections(interconnection=<factory>)

Bases: object

Connections between internal sub components.

Parameters:

interconnection (Iterable[Interconnection])

interconnection: Iterable[Interconnection]

org.accellera.spirit.v1_0.library_ref_type module

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

Bases: object

Base SPIRIT document reference type.

Contains vendor, library, name and optional 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_0.local_memory_map_type module

class org.accellera.spirit.v1_0.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]

org.accellera.spirit.v1_0.loose_generator_invocation module

class org.accellera.spirit.v1_0.loose_generator_invocation.LooseGeneratorInvocation(design_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

  • 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:
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(instance_ref=None, content=<factory>)

Bases: object

Variables:

  • instance_ref – Reference handle for this component definition

  • content

Parameters:

  • instance_ref (str | None)

  • content (Iterable[object])

content: Iterable[object]
instance_ref: str | None
component_definition_file: Iterable[ComponentDefinitionFile]
class Parameters(parameter: collections.abc.Iterable[org.accellera.spirit.v1_0.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
design_file: object | None
group_name: str | None
parameters: Parameters | None
phase_number: float | None
selected_instances: SelectedInstances | None

org.accellera.spirit.v1_0.memory_map_ref module

class org.accellera.spirit.v1_0.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_0.memory_map_ref_type module

class org.accellera.spirit.v1_0.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_0.memory_map_type module

class org.accellera.spirit.v1_0.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:
address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
memory_remap: Iterable[MemoryRemapType]
name: str | None
subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_0.memory_maps module

class org.accellera.spirit.v1_0.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_0.address_block.AddressBlock] = <factory>, bank: collections.abc.Iterable[org.accellera.spirit.v1_0.bank.Bank] = <factory>, subspace_map: collections.abc.Iterable[org.accellera.spirit.v1_0.subspace_ref_type.SubspaceRefType] = <factory>, memory_remap: collections.abc.Iterable[org.accellera.spirit.v1_0.memory_remap_type.MemoryRemapType] = <factory>, bits_in_lau: Optional[org.accellera.spirit.v1_0.bits_in_lau.BitsInLau] = None)

Bases: MemoryMapType

Parameters:
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_0.memory_remap_type module

class org.accellera.spirit.v1_0.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]
state: str | None
subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_0.name_value_pair_type module

class org.accellera.spirit.v1_0.name_value_pair_type.NameValuePairType(value='', name=None, cross_ref=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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.

Variables:

  • value

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

  • cross_ref

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str

org.accellera.spirit.v1_0.name_value_type_type module

class org.accellera.spirit.v1_0.name_value_type_type.NameValueTypeType(value='', name=None, cross_ref=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str

org.accellera.spirit.v1_0.on_master_value module

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

Bases: Enum

IN = 'in'
INOUT = 'inout'
OUT = 'out'

org.accellera.spirit.v1_0.on_slave_value module

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

Bases: Enum

IN = 'in'
INOUT = 'inout'
OUT = 'out'

org.accellera.spirit.v1_0.on_system_value module

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

Bases: Enum

IN = 'in'
INOUT = 'inout'
OUT = 'out'

org.accellera.spirit.v1_0.parameter module

class org.accellera.spirit.v1_0.parameter.Parameter(value='', name=None, cross_ref=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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 in given 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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str

org.accellera.spirit.v1_0.persistent_data_type module

class org.accellera.spirit.v1_0.persistent_data_type.PersistentDataType(id: str | None = None)

Bases: object

Parameters:

id (str | None)

id: str | None

org.accellera.spirit.v1_0.persistent_instance_data module

class org.accellera.spirit.v1_0.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_0.phase module

class org.accellera.spirit.v1_0.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:
scope: PhaseScopeType
value: float | None

org.accellera.spirit.v1_0.phase_scope_type module

class org.accellera.spirit.v1_0.phase_scope_type.PhaseScopeType(*values)

Bases: Enum

GLOBAL = 'global'
LOCAL = 'local'

org.accellera.spirit.v1_0.pmd module

class org.accellera.spirit.v1_0.pmd.Pmd(vendor=None, library=None, name=None, version=None, applies_to=None, depends_on=None, transformer=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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • 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 unconditionaly.

  • 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.

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • applies_to (AppliesTo | None)

  • depends_on (DependsOn | None)

  • transformer (Transformer | 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 3MD 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:
parameter: Iterable[NameValuePairType]
style_sheet: str | None
xslt: Iterable[Xslt]
applies_to: AppliesTo | None
depends_on: DependsOn | None
library: str | None
name: str | None
transformer: Transformer | None
vendor: str | None
version: str | None

org.accellera.spirit.v1_0.range_type_type module

class org.accellera.spirit.v1_0.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_0.remap_states module

class org.accellera.spirit.v1_0.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_0.requires_driver module

class org.accellera.spirit.v1_0.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:
driver_type: RequiresDriverDriverType
value: bool | None

org.accellera.spirit.v1_0.requires_driver_driver_type module

class org.accellera.spirit.v1_0.requires_driver_driver_type.RequiresDriverDriverType(*values)

Bases: Enum

ANY = 'any'
CLOCK = 'clock'
SINGLE_SHOT = 'singleShot'

org.accellera.spirit.v1_0.resolve_type module

class org.accellera.spirit.v1_0.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 thorugh confiugration. Modofications 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 do not get saved with the design.

DEPENDENT = 'dependent'
GENERATED = 'generated'
IMMEDIATE = 'immediate'
USER = 'user'

org.accellera.spirit.v1_0.resolved_library_ref_type module

class org.accellera.spirit.v1_0.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 optional 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_0.signal module

class org.accellera.spirit.v1_0.signal.Signal(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=None, vendor_extensions=None)

Bases: SignalType

Describes signal charateristics.

Parameters:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class Left(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
class Right(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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
single_shot_driver: SingleShotDriver | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.signal_type module

class org.accellera.spirit.v1_0.signal_type.SignalType(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=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.

  • vendor_extensions

Parameters:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class Left(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
class Right(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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
single_shot_driver: SingleShotDriver | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.signal_value_type module

class org.accellera.spirit.v1_0.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_0.single_shot_driver module

class org.accellera.spirit.v1_0.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:
class SingleShotDuration(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class SingleShotOffset(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class SingleShotValue(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
single_shot_duration: SingleShotDuration | None
single_shot_offset: SingleShotOffset | None
single_shot_value: SingleShotValue | None

org.accellera.spirit.v1_0.source_file_file_type module

class org.accellera.spirit.v1_0.source_file_file_type.SourceFileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.strength module

class org.accellera.spirit.v1_0.strength.Strength(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: StrengthType | None

org.accellera.spirit.v1_0.strength_type module

class org.accellera.spirit.v1_0.strength_type.StrengthType(*values)

Bases: Enum

Describes a signal strength.

STRONG = 'strong'
WEAK = 'weak'

org.accellera.spirit.v1_0.subspace_ref_type module

class org.accellera.spirit.v1_0.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
master_ref: str | None
parameter: Iterable[NameValuePairType]
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.sw_function_return_type module

class org.accellera.spirit.v1_0.sw_function_return_type.SwFunctionReturnType(*values)

Bases: Enum

INT = 'int'
VOID = 'void'

org.accellera.spirit.v1_0.usage_type module

class org.accellera.spirit.v1_0.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_0.value module

org.accellera.spirit.v1_0.vendor_extensions module

class org.accellera.spirit.v1_0.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_0.view_type module

class org.accellera.spirit.v1_0.view_type.ViewType(name='default', env_identifier=<factory>, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Name of the view. Must be unique within a component

  • env_identifier – This is a string such as “ModelsimVerilog”, used to uniquely identify the hardware environment. More than one indicates that the same information applies to multiple environments.

  • 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

  • parameter

  • vendor_extensions

Parameters:
class Language(value: str = '', strict: bool | None = None)

Bases: object

Parameters:

  • value (str)

  • strict (bool | None)

strict: bool | None
value: str
default_file_builder: Iterable[FileBuilderType]
env_identifier: Iterable[str]
file_set_ref: Iterable[FileSetRef]
language: Language | None
model_name: str | None
name: str
parameter: Iterable[Parameter]
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_0.volatile module

class org.accellera.spirit.v1_0.volatile.Volatile(value=False)

Bases: object

Indicates whether the data is volatile, default to false when not present.

Parameters:

value (bool)

value: bool

Module contents

class org.accellera.spirit.v1_0.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_0.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:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.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_0.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_0.AddRemChangeValue(*values)

Bases: Enum

ADD = 'add'
REMOVE = 'remove'
class org.accellera.spirit.v1_0.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_0.AddRemRepChangeValue(*values)

Bases: Enum

ADD = 'add'
REMOVE = 'remove'
REPLACE = 'replace'
class org.accellera.spirit.v1_0.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_0.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:
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_0.AddressBlock(base_address=None, bit_offset=None, range=None, width=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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset_value=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Register name.

  • dim – Dimensions a register array.

  • 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_value – 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 (int | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • dependency (Iterable[Dependency])

  • reset_value (str | 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
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_value: str | None
size: int | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
access: Access | None
base_address: BaseAddress | None
bit_offset: BitOffset | 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_0.AddressBlockType(base_address=None, bit_offset=None, range=None, width=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. If zero or absent and this is part of a slave memory map, the width is assumed to be the data width of the slave interface. It this is part of a local memory map, a missing width is assumed to be the effective width of the address space. If this is part of an address space definition, a missing width is assumed to be the widest data signal of all bus interfaces that reference this address space.

  • 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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset_value=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Register name.

  • dim – Dimensions a register array.

  • 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_value – 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 (int | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • dependency (Iterable[Dependency])

  • reset_value (str | 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
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_value: str | None
size: int | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
access: Access | None
base_address: BaseAddress | None
bit_offset: BitOffset | 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_0.AddressSpaceEndianness(*values)

Bases: Enum

BIG = 'big'
LITTLE = 'little'
class org.accellera.spirit.v1_0.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_0.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. If zero or absent and this is part of a slave memory map, the width is assumed to be the data width of the slave interface. It this is part of a local memory map, a missing width is assumed to be the effective width of the address space. If this is part of an address space definition, a missing width is assumed to be the widest data signal of all bus interfaces that reference this address space.

  • bits_in_lau

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

  • 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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
bits_in_lau: BitsInLau | None
endianness: AddressSpaceEndianness | 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_0.BankAlignmentType(*values)

Bases: Enum

‘serial’ or ‘parallel’ bank alignment.

PARALLEL = 'parallel'
SERIAL = 'serial'
class org.accellera.spirit.v1_0.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:
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_0.BankedBlockType(range=None, width=None, usage=None, volatile=None, access=None, parameter=<factory>, register=<factory>, vendor_extensions=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. If zero or absent and this is part of a slave memory map, the width is assumed to be the data width of the slave interface. It this is part of a local memory map, a missing width is assumed to be the effective width of the address space. If this is part of an address space definition, a missing width is assumed to be the widest data signal of all bus interfaces that reference this address space.

  • 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

Parameters:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Register(name=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, dependency=<factory>, reset_value=None, field_value=<factory>, description=None, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Register name.

  • dim – Dimensions a register array.

  • 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_value – 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 (int | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • dependency (Iterable[Dependency])

  • reset_value (str | 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
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_value: str | None
size: int | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
access: Access | 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_0.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:
master_ref: str | None
parameter: Iterable[NameValuePairType]
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.BaseAddress(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class org.accellera.spirit.v1_0.BitOffset(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
class org.accellera.spirit.v1_0.BitSteeringType(*values)

Bases: Enum

DEFAULT = 'default'
OFF = 'off'
ON = 'on'
class org.accellera.spirit.v1_0.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_0.BusDefinition(vendor=None, library=None, name=None, version=None, direct_connection=None, extends=None, max_masters=None, max_slaves=None, signals=None, choices=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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • version

  • direct_connection – When present 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. Default value of zero means unbounded.

  • max_slaves – Indicates the maximum number of slaves this bus supports. Default value of zero means unbounded.

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

  • choices

  • vendor_extensions

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • direct_connection (bool | None)

  • extends (LibraryRefType | None)

  • max_masters (int | None)

  • max_slaves (int | None)

  • signals (Signals | None)

  • choices (Choices | None)

  • vendor_extensions (VendorExtensions | None)

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, 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 clock information.

  • is_reset – Is this element is present, the signal contains 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.

  • 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)

  • vendor_extensions (VendorExtensions | None)

class DefaultValue(strength=<factory>, value=None)

Bases: object

Variables:

  • strength – The strength of the signal. “strong” (default) or “weak”

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

Parameters:
strength: Iterable[DefaultValueStrength]
value: object | 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 th enumber 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.

Parameters:
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 th enumber 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.

Parameters:
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 th enumber 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.

Parameters:

  • group (str | None)

  • bit_width (int | None)

  • direction (OnSystemValue | None)

bit_width: int | None
direction: OnSystemValue | None
group: str | 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]
choices: Choices | None
direct_connection: bool | None
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_0.BusInterface(name=None, bus_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, exported_interface=None, connection=None, signal_map=None, index=None, bit_steering=None, configurators=None, vendor_extensions=None, other_attributes=<factory>)

Bases: BusInterfaceType

Describes one of the bus interfaces supported by this component.

Parameters:
class BitSteering(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: BitSteeringType | None
class ExportedInterface(component_ref=None, interface_ref=None)

Bases: object

Variables:

  • component_ref – Indicates name of the sub-component containing the interface being exported.

  • interface_ref – Indicates the name of the sub-component bus interface being exported.

Parameters:

  • component_ref (str | None)

  • interface_ref (str | None)

component_ref: str | None
interface_ref: str | None
class Index(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_0.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:
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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str)

  • state (str | None)

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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description. The text content of this element identifies a signal on this component bu its signal name. The busSignal attribute names the corresponding signal in the bus definition. The optional attributes left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(value: str = '', bus_signal: str | None = None, left: int | None = None, right: int | None = None)

Bases: object

Parameters:

  • value (str)

  • bus_signal (str | None)

  • left (int | None)

  • right (int | None)

bus_signal: str | None
left: int | None
right: int | None
value: str
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

Parameters:
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

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_0.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_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
bit_steering: 'BusInterfaceType.BitSteering' | None
bus_type: LibraryRefType | None
configurators: Configurators | None
connection: BusInterfaceTypeConnection | None
exported_interface: 'BusInterfaceType.ExportedInterface' | None
index: 'BusInterfaceType.Index' | None
master: 'BusInterfaceType.Master' | None
mirrored_master: object | None
mirrored_slave: 'BusInterfaceType.MirroredSlave' | None
mirrored_system: 'BusInterfaceType.MirroredSystem' | None
name: str | None
other_attributes: Mapping[str, str]
signal_map: 'BusInterfaceType.SignalMap' | None
slave: 'BusInterfaceType.Slave' | None
system: 'BusInterfaceType.System' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.BusInterfaceType(name=None, bus_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, exported_interface=None, connection=None, signal_map=None, index=None, bit_steering=None, configurators=None, vendor_extensions=None, other_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.

  • exported_interface – If this element is present, this interface represents an interface being exported from a sub-component. The type of interface (master, slave, …) should be obtained from the sub-component 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 – Maps component signals to 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” or “default”.

  • configurators – Configuration generators for bus interfaces.

  • vendor_extensions

  • other_attributes

Parameters:
class BitSteering(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: BitSteeringType | None
class ExportedInterface(component_ref=None, interface_ref=None)

Bases: object

Variables:

  • component_ref – Indicates name of the sub-component containing the interface being exported.

  • interface_ref – Indicates the name of the sub-component bus interface being exported.

Parameters:

  • component_ref (str | None)

  • interface_ref (str | None)

component_ref: str | None
interface_ref: str | None
class Index(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.base_address.BaseAddress | None = None, bit_offset: org.accellera.spirit.v1_0.bit_offset.BitOffset | None = None)

Bases: AddrSpaceRefType

Parameters:
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:
class Range(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str)

  • state (str | None)

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
other_attributes: Mapping[str, str]
prompt: str
range_type: RangeTypeType | None
resolve: ResolveType | None
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class SignalMap(signal_name=<factory>)

Bases: object

Variables:

signal_name – Maps a component’s signal to a signal in a bus description. The text content of this element identifies a signal on this component bu its signal name. The busSignal attribute names the corresponding signal in the bus definition. The optional attributes left and right can be used to select a bit-slice of a signal vector to map to the bus interface.

Parameters:

signal_name (Iterable[SignalName])

class SignalName(value: str = '', bus_signal: str | None = None, left: int | None = None, right: int | None = None)

Bases: object

Parameters:

  • value (str)

  • bus_signal (str | None)

  • left (int | None)

  • right (int | None)

bus_signal: str | None
left: int | None
right: int | None
value: str
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

Parameters:
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

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_0.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_0.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
bit_steering: BitSteering | None
bus_type: LibraryRefType | None
configurators: Configurators | None
connection: BusInterfaceTypeConnection | None
exported_interface: ExportedInterface | None
index: Index | None
master: Master | None
mirrored_master: object | None
mirrored_slave: MirroredSlave | None
mirrored_system: MirroredSystem | None
name: str | None
other_attributes: Mapping[str, str]
signal_map: SignalMap | None
slave: Slave | None
system: System | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.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_0.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_0.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(max_masters=None, max_slaves=None, bus_interface_ref=<factory>)

Bases: object

Variables:

  • 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.

Parameters:

  • 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
channel: Iterable[Channel]
class org.accellera.spirit.v1_0.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_0.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_0.ClockDriver(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None)

Bases: object

Describes a driven clock signal.

Variables:

  • clock_period – Clock period in nanoseconds

  • clock_pulse_offset – Time in nanoseconds until first pulse.

  • clock_pulse_value – Value of signal after first clock edge.

  • clock_pulse_duration – Duration in nanoseconds of first state in cycle.

Parameters:
class ClockPeriod(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class ClockPulseDuration(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class ClockPulseOffset(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class ClockPulseValue(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None
class org.accellera.spirit.v1_0.Component(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, component_instances=None, interconnections=None, remap_states=None, address_spaces=None, memory_maps=None, hw_model=None, component_generators=None, configurators=None, choices=None, file_sets=None, cpus=None, parameter=<factory>, vendor_extensions=None)

Bases: ComponentType

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

Parameters:
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:
address_space_ref: Iterable[AddressSpaceRef]
name: str | None
parameter: Iterable[Parameter]
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
component_instances: ComponentInstances | None
configurators: Configurators | None
cpus: 'ComponentType.Cpus' | None
file_sets: FileSets | None
hw_model: HwModel | None
interconnections: Interconnections | None
library: str | None
memory_maps: MemoryMaps | None
name: str | None
parameter: Iterable[Parameter]
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_0.ComponentGenerator(name=None, phase=None, parameter=<factory>, access_type=None, loose_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.

Parameters:
access_type: 'GeneratorType.AccessType' | None
group: Iterable[str]
hidden: bool
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
scope: InstanceGeneratorTypeScope
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.ComponentGenerators(component_generator=<factory>)

Bases: object

List of component generators.

Parameters:

component_generator (Iterable[ComponentGenerator])

component_generator: Iterable[ComponentGenerator]
class org.accellera.spirit.v1_0.ComponentInstance(instance_name=None, component_ref=None, configuration=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

Parameters:
component_ref: LibraryRefType | None
configuration: Configuration | None
instance_name: InstanceName | None
class org.accellera.spirit.v1_0.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_0.ComponentSignalDirectionType(*values)

Bases: Enum

The direction of a component signal.

IN = 'in'
INOUT = 'inout'
OUT = 'out'
class org.accellera.spirit.v1_0.ComponentType(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, component_instances=None, interconnections=None, remap_states=None, address_spaces=None, memory_maps=None, hw_model=None, component_generators=None, configurators=None, choices=None, file_sets=None, cpus=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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • version

  • bus_interfaces

  • channels

  • component_instances

  • interconnections

  • remap_states

  • address_spaces

  • memory_maps

  • hw_model

  • component_generators – Generator list is tools-specific.

  • configurators

  • choices

  • file_sets

  • cpus – cpu’s in the component

  • parameter

  • vendor_extensions

Parameters:
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:
address_space_ref: Iterable[AddressSpaceRef]
name: str | None
parameter: Iterable[Parameter]
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
component_instances: ComponentInstances | None
configurators: Configurators | None
cpus: Cpus | None
file_sets: FileSets | None
hw_model: HwModel | None
interconnections: Interconnections | None
library: str | None
memory_maps: MemoryMaps | None
name: str | None
parameter: Iterable[Parameter]
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_0.ConfigurableElement(reference_id=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None, content=<factory>)

Bases: object

Describes the configurable content of an element in the instance.

May contain text and/or child elements. The required referenceId attribute refers to the ID attribute of the configurable element.

Variables:

  • reference_id

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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])

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
reference_id: str | None
resolve: ResolveType | None
class org.accellera.spirit.v1_0.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_0.ConfiguratorRef(value='')

Bases: object

A reference to a configurator element.

Parameters:

value (str)

value: str
class org.accellera.spirit.v1_0.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_0.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_0.DefaultValueStrength(*values)

Bases: Enum

STRONG = 'strong'
WEAK = 'weak'
class org.accellera.spirit.v1_0.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_0.Design(vendor=None, library=None, name=None, version=None, component_instances=None, interconnections=None, ad_hoc_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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • version

  • component_instances

  • interconnections

  • ad_hoc_connections

  • vendor_extensions

Parameters:
ad_hoc_connections: AdHocConnections | None
component_instances: ComponentInstances | 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_0.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_0.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:
class FileSetRefGroup(file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_0.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:
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:
class Command(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Flags(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class ReplaceDefaultFlags(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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:
class CommandLineSwitch(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Enable(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class Name(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
file_builder: Iterable[FileBuilder]
linker: Linker | None
linker_command_file: LinkerCommandFile | None
linker_flags: LinkerFlags | None
class Name(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.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 (int | None)

  • access (Access | None)

  • description (str | None)

  • values (Iterable[Values])

  • parameter (Iterable[Parameter])

  • vendor_extensions (VendorExtensions | 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: int | None
description: str | None
name: str | None
parameter: Iterable[Parameter]
values: Iterable[Values]
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.File(name=None, file_type=None, user_file_type=None, logical_name=None, exported_name=<factory>, build_command=None, dependency=<factory>, define=<factory>, image_type=<factory>, vendor_extensions=None, file_id=None, other_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

  • other_attributes

Parameters:
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:
class Command(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Flags(value='', append=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class ReplaceDefaultFlags(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class TargetName(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
build_command: BuildCommand | None
define: Iterable[NameValuePairType]
dependency: Iterable[Dependency]
exported_name: Iterable[str]
file_id: str | None
file_type: FileFileType | None
image_type: Iterable[str]
logical_name: LogicalName | None
name: Name | None
other_attributes: Mapping[str, str]
user_file_type: str | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.FileBuilderFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.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:
class Command(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Flags(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class ReplaceDefaultFlags(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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_0.FileBuilderTypeFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.FileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.FileSet(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, sw_function=None, 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:
class SwFunction(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:
class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: Optional[org.accellera.spirit.v1_0.resolve_type.ResolveType] = None, id: Optional[str] = None, dependency: Optional[str] = None, other_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: Optional[org.accellera.spirit.v1_0.range_type_type.RangeTypeType] = None, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_0.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_0.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_0.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_0.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

  • value (str)

  • name (str | None)

  • cross_ref (str | None)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Enabled(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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:
class SourceName(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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: SwFunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
file: Iterable[File]
file_set_id: str | None
group: Iterable[str]
owner: LibraryRefType | None
sw_function: 'FileSetType.SwFunction' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.FileSetRef(value='')

Bases: object

A reference to a fileSet.

Parameters:

value (str)

value: str
class org.accellera.spirit.v1_0.FileSetType(owner=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, sw_function=None, 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

  • sw_function – Generator information if this file set describes a sw 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 single function will be called with different arguments for each instance (e.g. baseAddress).

  • vendor_extensions

  • file_set_id

Parameters:
class SwFunction(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:
class Argument(value: str = '', name: Optional[str] = None, cross_ref: Optional[str] = None, resolve: Optional[org.accellera.spirit.v1_0.resolve_type.ResolveType] = None, id: Optional[str] = None, dependency: Optional[str] = None, other_attributes: collections.abc.Mapping[str, str] = <factory>, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: Optional[org.accellera.spirit.v1_0.range_type_type.RangeTypeType] = None, order: Optional[float] = None, choice_ref: Optional[str] = None, choice_style: Optional[org.accellera.spirit.v1_0.choice_style_value.ChoiceStyleValue] = None, direction: Optional[org.accellera.spirit.v1_0.direction_value.DirectionValue] = None, config_groups: collections.abc.Iterable[str] = <factory>, format: Optional[org.accellera.spirit.v1_0.format_type.FormatType] = None, prompt: Optional[str] = None, data_type: Optional[org.accellera.spirit.v1_0.data_type_type.DataTypeType] = None)

Bases: NameValuePairType

Parameters:

  • value (str)

  • name (str | None)

  • cross_ref (str | None)

  • resolve (ResolveType | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class Enabled(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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:
class SourceName(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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: SwFunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
file: Iterable[File]
file_set_id: str | None
group: Iterable[str]
owner: LibraryRefType | None
sw_function: SwFunction | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.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_0.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_0.Generator(name=None, phase=None, parameter=<factory>, access_type=None, loose_generator_exe=None, vendor_extensions=None)

Bases: GeneratorType

Specifies a set of generators.

Parameters:

  • name (str | None)

  • phase (Phase | None)

  • parameter (Iterable[Parameter])

  • access_type (GeneratorType.AccessType | None)

  • loose_generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

access_type: 'GeneratorType.AccessType' | None
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.GeneratorChain(vendor=None, library=None, name=None, version=None, file_generator_selector=<factory>, component_generator_selector=<factory>, bus_generator_selector=<factory>, generator=<factory>, chain_group=<factory>, parameter=<factory>)

Bases: object

Variables:

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

  • library – Name of the logical library this component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • 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.

  • bus_generator_selector – Selects generators declared in bus definition 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

Parameters:
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:
file_name: LibraryRefType | None
group_selector: GroupSelector | None
unique: bool
bus_generator_selector: Iterable[GeneratorSelectorType]
chain_group: Iterable[str]
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_0.GeneratorChangeList(component_changes=None, interconnection_changes=None, ad_hoc_connection_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.

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

Parameters:
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:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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
add_rem_change: AddRemChange | None
export: Export | None
name: int | 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:
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 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_0.add_rem_change.AddRemChange | None = None, interconnection: org.accellera.spirit.v1_0.interconnection.Interconnection | None = None)

Bases: object

Parameters:
add_rem_change: AddRemChange | None
interconnection: Interconnection | 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_0.add_rem_change.AddRemChange | None = None, vendor_extensions: org.accellera.spirit.v1_0.vendor_extensions.VendorExtensions | None = None)

Bases: object

Parameters:
add_rem_change: AddRemChange | None
vendor_extensions: VendorExtensions | None
vendor_extension_change: Iterable[VendorExtensionChange]
ad_hoc_connection_changes: AdHocConnectionChanges | None
component_changes: ComponentChanges | None
interconnection_changes: InterconnectionChanges | None
vendor_extension_changes: VendorExtensionChanges | None
class org.accellera.spirit.v1_0.GeneratorRef(value='')

Bases: object

A reference to a generator element.

Parameters:

value (str)

value: str
class org.accellera.spirit.v1_0.GeneratorSelectorType(group_selector: org.accellera.spirit.v1_0.group_selector.GroupSelector | None = None)

Bases: object

Parameters:

group_selector (GroupSelector | None)

group_selector: GroupSelector | None
class org.accellera.spirit.v1_0.GeneratorType(name=None, phase=None, parameter=<factory>, access_type=None, loose_generator_exe=None, vendor_extensions=None)

Bases: object

Types of generators.

Variables:

  • name – The name of this generator.

  • phase

  • parameter

  • access_type – Identifies the special requirements that this generator may place up on the DE.

  • loose_generator_exe – The pathname to the executable file that implements the loose generator

  • vendor_extensions

Parameters:

  • name (str | None)

  • phase (Phase | None)

  • parameter (Iterable[Parameter])

  • access_type (AccessType | None)

  • loose_generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

access_type: AccessType | None
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.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:
multiple_group_selection_operator: GroupSelectorMultipleGroupSelectionOperator
name: Iterable[str]
class org.accellera.spirit.v1_0.GroupSelectorMultipleGroupSelectionOperator(*values)

Bases: Enum

AND = 'and'
OR = 'or'
class org.accellera.spirit.v1_0.HwModel(views=None, signals=None, hw_parameters=None, vendor_extensions=None)

Bases: HwModelType

Hardware model information.

Parameters:
class HwParameters(hw_parameter=<factory>)

Bases: object

Variables:

hw_parameter – A hardware 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. The name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

hw_parameter (Iterable[NameValueTypeType])

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

Bases: object

Parameters:

signal (Iterable[Signal])

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

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
hw_parameters: 'HwModelType.HwParameters' | None
signals: 'HwModelType.Signals' | None
vendor_extensions: VendorExtensions | None
views: 'HwModelType.Views' | None
class org.accellera.spirit.v1_0.HwModelType(views=None, signals=None, hw_parameters=None, vendor_extensions=None)

Bases: object

Hardware model information.

Variables:

  • views – View container

  • signals – Signal container

  • hw_parameters – Hardware parameter name value pairs container

  • vendor_extensions

Parameters:
class HwParameters(hw_parameter=<factory>)

Bases: object

Variables:

hw_parameter – A hardware 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. The name should be identical to the RTL (VHDL generic or Verilog parameter)

Parameters:

hw_parameter (Iterable[NameValueTypeType])

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

Bases: object

Parameters:

signal (Iterable[Signal])

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

Bases: object

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
hw_parameters: HwParameters | None
signals: Signals | None
vendor_extensions: VendorExtensions | None
views: Views | None
class org.accellera.spirit.v1_0.InstanceGeneratorType(name=None, phase=None, parameter=<factory>, access_type=None, loose_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:
access_type: 'GeneratorType.AccessType' | None
group: Iterable[str]
loose_generator_exe: str | None
name: str | None
parameter: Iterable[Parameter]
phase: Phase | None
scope: InstanceGeneratorTypeScope
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.InstanceGeneratorTypeScope(*values)

Bases: Enum

ENTITY = 'entity'
INSTANCE = 'instance'
class org.accellera.spirit.v1_0.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_0.Interconnection(component1_ref=None, bus_interface1_ref=None, component2_ref=None, bus_interface2_ref=None)

Bases: object

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

The component1Ref and busInterface1Ref attributes indicate the instance name and bus interface name of one end of the connection. The component2Ref and busInterface2Ref attributes indicate the instance name and bus interface name of the other end of he connection.

Parameters:

  • component1_ref (str | None)

  • bus_interface1_ref (str | None)

  • component2_ref (str | None)

  • bus_interface2_ref (str | None)

bus_interface1_ref: str | None
bus_interface2_ref: str | None
component1_ref: str | None
component2_ref: str | None
class org.accellera.spirit.v1_0.Interconnections(interconnection=<factory>)

Bases: object

Connections between internal sub components.

Parameters:

interconnection (Iterable[Interconnection])

interconnection: Iterable[Interconnection]
class org.accellera.spirit.v1_0.LibraryRefType(vendor=None, library=None, name=None, version=None)

Bases: object

Base SPIRIT document reference type.

Contains vendor, library, name and optional 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_0.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]
class org.accellera.spirit.v1_0.LooseGeneratorInvocation(design_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

  • 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:
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(instance_ref=None, content=<factory>)

Bases: object

Variables:

  • instance_ref – Reference handle for this component definition

  • content

Parameters:

  • instance_ref (str | None)

  • content (Iterable[object])

content: Iterable[object]
instance_ref: str | None
component_definition_file: Iterable[ComponentDefinitionFile]
class Parameters(parameter: collections.abc.Iterable[org.accellera.spirit.v1_0.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
design_file: object | None
group_name: str | None
parameters: Parameters | None
phase_number: float | None
selected_instances: SelectedInstances | None
class org.accellera.spirit.v1_0.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_0.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_0.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:
address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
memory_remap: Iterable[MemoryRemapType]
name: str | None
subspace_map: Iterable[SubspaceRefType]
class org.accellera.spirit.v1_0.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_0.address_block.AddressBlock] = <factory>, bank: collections.abc.Iterable[org.accellera.spirit.v1_0.bank.Bank] = <factory>, subspace_map: collections.abc.Iterable[org.accellera.spirit.v1_0.subspace_ref_type.SubspaceRefType] = <factory>, memory_remap: collections.abc.Iterable[org.accellera.spirit.v1_0.memory_remap_type.MemoryRemapType] = <factory>, bits_in_lau: Optional[org.accellera.spirit.v1_0.bits_in_lau.BitsInLau] = None)

Bases: MemoryMapType

Parameters:
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_0.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]
state: str | None
subspace_map: Iterable[SubspaceRefType]
class org.accellera.spirit.v1_0.NameValuePairType(value='', name=None, cross_ref=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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.

Variables:

  • value

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

  • cross_ref

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class org.accellera.spirit.v1_0.NameValueTypeType(value='', name=None, cross_ref=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • 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)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class org.accellera.spirit.v1_0.OnMasterValue(*values)

Bases: Enum

IN = 'in'
INOUT = 'inout'
OUT = 'out'
class org.accellera.spirit.v1_0.OnSlaveValue(*values)

Bases: Enum

IN = 'in'
INOUT = 'inout'
OUT = 'out'
class org.accellera.spirit.v1_0.OnSystemValue(*values)

Bases: Enum

IN = 'in'
INOUT = 'inout'
OUT = 'out'
class org.accellera.spirit.v1_0.Parameter(value='', name=None, cross_ref=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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 in given 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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
class org.accellera.spirit.v1_0.PersistentDataType(id: str | None = None)

Bases: object

Parameters:

id (str | None)

id: str | None
class org.accellera.spirit.v1_0.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_0.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:
scope: PhaseScopeType
value: float | None
class org.accellera.spirit.v1_0.PhaseScopeType(*values)

Bases: Enum

GLOBAL = 'global'
LOCAL = 'local'
class org.accellera.spirit.v1_0.Pmd(vendor=None, library=None, name=None, version=None, applies_to=None, depends_on=None, transformer=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 component belongs to. Note that a physical library may contain components from multiple logical libraries. Logical libraries are displayes in component browser.

  • name – The name of the object. Must match the root name of the XML file and the directory name it or its version directory belongs to.

  • 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 unconditionaly.

  • 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.

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • applies_to (AppliesTo | None)

  • depends_on (DependsOn | None)

  • transformer (Transformer | 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 3MD 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:
parameter: Iterable[NameValuePairType]
style_sheet: str | None
xslt: Iterable[Xslt]
applies_to: AppliesTo | 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_0.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_0.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_0.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:
driver_type: RequiresDriverDriverType
value: bool | None
class org.accellera.spirit.v1_0.RequiresDriverDriverType(*values)

Bases: Enum

ANY = 'any'
CLOCK = 'clock'
SINGLE_SHOT = 'singleShot'
class org.accellera.spirit.v1_0.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 thorugh confiugration. Modofications 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 do not get saved with the design.

DEPENDENT = 'dependent'
GENERATED = 'generated'
IMMEDIATE = 'immediate'
USER = 'user'
class org.accellera.spirit.v1_0.ResolvedLibraryRefType(value='', vendor=None, library=None, name=None, version=None)

Bases: object

Resolved SPIRIT document reference type.

Contains vendor, library, name and optional 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_0.Signal(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=None, vendor_extensions=None)

Bases: SignalType

Describes signal charateristics.

Parameters:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class Left(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
class Right(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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
single_shot_driver: SingleShotDriver | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.SignalType(name=None, direction=None, left=None, right=None, default_value=None, clock_driver=None, single_shot_driver=None, export=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.

  • vendor_extensions

Parameters:
class Export(value=None, format=FormatType.BOOL, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: bool | None
class Left(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: int | None
class Right(value=None, format=FormatType.LONG, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • prompt (str | None)

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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
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
single_shot_driver: SingleShotDriver | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.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_0.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:
class SingleShotDuration(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class SingleShotOffset(value=<factory>, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: Iterable[float]
class SingleShotValue(value='', resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, order=None, choice_ref=None, choice_style=None, direction=None, config_groups=<factory>, format=None, prompt=None)

Bases: object

Variables:

  • value

  • resolve

  • id

  • dependency

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: str
single_shot_duration: SingleShotDuration | None
single_shot_offset: SingleShotOffset | None
single_shot_value: SingleShotValue | None
class org.accellera.spirit.v1_0.SourceFileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
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_0.Strength(value=None, resolve=None, id=None, dependency=None, other_attributes=<factory>, minimum=None, maximum=None, range_type=None, 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

  • other_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 | None)

  • id (str | None)

  • dependency (str | None)

  • other_attributes (Mapping[str, str])

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType | None)

  • order (float | None)

  • choice_ref (str | None)

  • choice_style (ChoiceStyleValue | None)

  • direction (DirectionValue | None)

  • config_groups (Iterable[str])

  • format (FormatType | None)

  • prompt (str | 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
other_attributes: Mapping[str, str]
prompt: str | None
range_type: RangeTypeType | None
resolve: ResolveType | None
value: StrengthType | None
class org.accellera.spirit.v1_0.StrengthType(*values)

Bases: Enum

Describes a signal strength.

STRONG = 'strong'
WEAK = 'weak'
class org.accellera.spirit.v1_0.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
master_ref: str | None
parameter: Iterable[NameValuePairType]
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.SwFunctionReturnType(*values)

Bases: Enum

INT = 'int'
VOID = 'void'
class org.accellera.spirit.v1_0.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_0.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_0.ViewType(name='default', env_identifier=<factory>, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, parameter=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Name of the view. Must be unique within a component

  • env_identifier – This is a string such as “ModelsimVerilog”, used to uniquely identify the hardware environment. More than one indicates that the same information applies to multiple environments.

  • 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

  • parameter

  • vendor_extensions

Parameters:
class Language(value: str = '', strict: bool | None = None)

Bases: object

Parameters:

  • value (str)

  • strict (bool | None)

strict: bool | None
value: str
default_file_builder: Iterable[FileBuilderType]
env_identifier: Iterable[str]
file_set_ref: Iterable[FileSetRef]
language: Language | None
model_name: str | None
name: str
parameter: Iterable[Parameter]
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_0.Volatile(value=False)

Bases: object

Indicates whether the data is volatile, default to false when not present.

Parameters:

value (bool)

value: bool