org.accellera.spirit.v1_4 package

Subpackages

Submodules

org.accellera.spirit.v1_4.abstraction_def_port_constraints_type module

class org.accellera.spirit.v1_4.abstraction_def_port_constraints_type.AbstractionDefPortConstraintsType(timing_constraint=<factory>, drive_constraint=None, load_constraint=None)

Bases: object

Defines constraints that apply to a wire type port in an abstraction definition.

Parameters:
drive_constraint: DriveConstraint | None
load_constraint: LoadConstraint | None
timing_constraint: Iterable[TimingConstraint]

org.accellera.spirit.v1_4.abstraction_definition module

class org.accellera.spirit.v1_4.abstraction_definition.AbstractionDefinition(vendor=None, library=None, name=None, version=None, bus_type=None, extends=None, ports=None, description=None, vendor_extensions=None)

Bases: object

Define the ports and other information of a particular abstraction of the bus.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • bus_type – Reference to the busDefinition that this abstractionDefinition implements.

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

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

  • description – String for describing the abstraction definition to users; no semantic impact

  • vendor_extensions

Parameters:
class Ports(port: collections.abc.Iterable['AbstractionDefinition.Ports.Port'] = <factory>)

Bases: object

Parameters:

port (Iterable[Port])

class Port(logical_name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: object

Variables:

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

  • display_name – Short description string, typically for user interface

  • description – Full description string, typically for documentation

  • wire – A port that carries logic or an array of logic values

  • transactional – A port that carries complex information modeled at a high level of abstraction.

  • vendor_extensions

Parameters:

  • logical_name (str | None)

  • display_name (str | None)

  • description (str | None)

  • wire (Wire | None)

  • transactional (Transactional | None)

  • vendor_extensions (VendorExtensions | None)

class Transactional(qualifier=None, on_system=<factory>, on_master=None, on_slave=None)

Bases: object

Variables:

  • qualifier – The type of information this port carries A transactional port can carry both address and data information.

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

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

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

Parameters:
class OnMaster(presence=None, service=None)

Bases: object

Variables:

  • presence

  • service – The service that this transactional port can provide or requires.

Parameters:
presence: Presence | None
service: ServiceType | None
class OnSlave(presence=None, service=None)

Bases: object

Variables:

  • presence

  • service – The service that this transactional port can provide or requires.

Parameters:
presence: Presence | None
service: ServiceType | None
class OnSystem(group=None, presence=None, service=None)

Bases: object

Variables:

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

  • presence

  • service – The service that this transactional port can provide or requires.

Parameters:
group: str | None
presence: Presence | None
service: ServiceType | None
class Qualifier(is_address=None, is_data=None)

Bases: object

Variables:

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

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

Parameters:

  • is_address (bool | None)

  • is_data (bool | None)

is_address: bool | None
is_data: bool | None
on_master: OnMaster | None
on_slave: OnSlave | None
on_system: Iterable[OnSystem]
qualifier: Qualifier | None
class Wire(qualifier=None, on_system=<factory>, on_master=None, on_slave=None, default_value=None, requires_driver=None)

Bases: object

Variables:

  • qualifier – The type of information this port carries A wire port can carry both address and data, but may not mix this with a clock or reset

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

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

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

  • default_value – Indicates the default value for this wire port.

  • requires_driver

Parameters:
class OnMaster(presence=None, width=None, direction=None, mode_constraints=None, mirrored_mode_constraints=None)

Bases: object

Variables:

  • presence

  • width – Number of bits required to represent this port. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this port. The logical numbering of the port starts at 0 to width-1.

  • direction – If this element is present, the direction of this port is restricted to the specified value. The direction is relative to the non-mirrored interface.

  • mode_constraints – Specifies default constraints for the enclosing wire type port. If the mirroredModeConstraints element is not defined, then these constraints applied to this port when it appears in a ‘mode’ bus interface or a mirrored-‘mode’ bus interface. Otherwise they only apply when the port appears in a ‘mode’ bus interface.

  • mirrored_mode_constraints – Specifies default constraints for the enclosing wire type port when it appears in a mirrored-‘mode’ bus interface.

Parameters:
direction: OnMasterDirection | None
mirrored_mode_constraints: AbstractionDefPortConstraintsType | None
mode_constraints: AbstractionDefPortConstraintsType | None
presence: Presence | None
width: int | None
class OnSlave(presence=None, width=None, direction=None, mode_constraints=None, mirrored_mode_constraints=None)

Bases: object

Variables:

  • presence

  • width – Number of bits required to represent this port. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this port. The logical numbering of the port starts at 0 to width-1.

  • direction – If this element is present, the direction of this port is restricted to the specified value. The direction is relative to the non-mirrored interface.

  • mode_constraints – Specifies default constraints for the enclosing wire type port. If the mirroredModeConstraints element is not defined, then these constraints applied to this port when it appears in a ‘mode’ bus interface or a mirrored-‘mode’ bus interface. Otherwise they only apply when the port appears in a ‘mode’ bus interface.

  • mirrored_mode_constraints – Specifies default constraints for the enclosing wire type port when it appears in a mirrored-‘mode’ bus interface.

Parameters:
direction: OnSlaveDirection | None
mirrored_mode_constraints: AbstractionDefPortConstraintsType | None
mode_constraints: AbstractionDefPortConstraintsType | None
presence: Presence | None
width: int | None
class OnSystem(group=None, presence=None, width=None, direction=None, mode_constraints=None, mirrored_mode_constraints=None)

Bases: object

Variables:

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

  • presence

  • width – Number of bits required to represent this port. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this port. The logical numbering of the port starts at 0 to width-1.

  • direction – If this element is present, the direction of this port is restricted to the specified value. The direction is relative to the non-mirrored interface.

  • mode_constraints – Specifies default constraints for the enclosing wire type port. If the mirroredModeConstraints element is not defined, then these constraints applied to this port when it appears in a ‘mode’ bus interface or a mirrored-‘mode’ bus interface. Otherwise they only apply when the port appears in a ‘mode’ bus interface.

  • mirrored_mode_constraints – Specifies default constraints for the enclosing wire type port when it appears in a mirrored-‘mode’ bus interface.

Parameters:
direction: OnSystemDirection | None
group: str | None
mirrored_mode_constraints: AbstractionDefPortConstraintsType | None
mode_constraints: AbstractionDefPortConstraintsType | None
presence: Presence | None
width: int | None
class Qualifier(is_address=None, is_data=None, is_clock=None, is_reset=None)

Bases: object

Variables:

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

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

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

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

Parameters:

  • is_address (bool | None)

  • is_data (bool | None)

  • is_clock (bool | None)

  • is_reset (bool | None)

is_address: bool | None
is_clock: bool | None
is_data: bool | None
is_reset: bool | None
default_value: str | None
on_master: OnMaster | None
on_slave: OnSlave | None
on_system: Iterable[OnSystem]
qualifier: Qualifier | None
requires_driver: RequiresDriver | None
description: str | None
display_name: str | None
logical_name: str | None
transactional: Transactional | None
vendor_extensions: VendorExtensions | None
wire: Wire | None
port: Iterable[Port]
bus_type: LibraryRefType | None
description: str | None
extends: LibraryRefType | None
library: str | None
name: str | None
ports: Ports | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_4.abstractor module

class org.accellera.spirit.v1_4.abstractor.Abstractor(vendor=None, library=None, name=None, version=None, abstractor_mode=None, bus_type=None, abstractor_interfaces=None, model=None, abstractor_generators=None, choices=None, file_sets=None, description=None, parameters=None, vendor_extensions=None)

Bases: AbstractorType

This is the root element for abstractors.

Parameters:
class AbstractorInterfaces(abstractor_interface=<factory>)

Bases: object

Variables:

abstractor_interface – An abstractor must have exactly 2 Interfaces.

Parameters:

abstractor_interface (Iterable[AbstractorBusInterfaceType])

abstractor_interface: Iterable[AbstractorBusInterfaceType]
class AbstractorMode(value=None, group=None)

Bases: object

Variables:

  • value

  • group – Define the system group if the mode is set to system

Parameters:
group: str | None
value: AbstractorModeType | None
abstractor_generators: AbstractorGenerators | None
abstractor_interfaces: 'AbstractorType.AbstractorInterfaces' | None
abstractor_mode: 'AbstractorType.AbstractorMode' | None
bus_type: LibraryRefType | None
choices: Choices | None
description: str | None
file_sets: FileSets | None
library: str | None
model: AbstractorModelType | None
name: str | None
parameters: Parameters | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_4.abstractor_bus_interface_type module

class org.accellera.spirit.v1_4.abstractor_bus_interface_type.AbstractorBusInterfaceType(name=None, display_name=None, description=None, abstraction_type=None, port_maps=None, parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Type definition for a busInterface in a component.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • abstraction_type – The abstraction type/level of this interface. Refers to abstraction definition using vendor, library, name, version attributes. Bus definition can be found through a reference in this file.

  • port_maps – Listing of maps between component ports and bus ports.

  • parameters

  • vendor_extensions

  • any_attributes

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • abstraction_type (LibraryRefType | None)

  • port_maps (PortMaps | None)

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

class PortMaps(port_map=<factory>)

Bases: object

Variables:

port_map – Maps a component’s port to a port in a bus description. This is the logical to physical mapping. The logical pin comes from the bus interface and the physical pin from the component.

Parameters:

port_map (Iterable[PortMap])

class PortMap(logical_port=None, physical_port=None)

Bases: object

Variables:

  • logical_port – Logical port from abstraction definition

  • physical_port – Physical port from this component

Parameters:
class LogicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Bus port name as specified inside the abstraction definition

  • vector – Definition of the logical indecies for a vectored port.

Parameters:

  • name (str | None)

  • vector (Vector | None)

class Vector(left=None, right=None)

Bases: object

Variables:

  • left – Defines which logical bit maps to the physical left bit below

  • right – Defines which logical bit maps to the physical right bit below

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None
name: str | None
vector: Vector | None
class PhysicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Component port name as specified inside the model port section

  • vector

Parameters:

  • name (str | None)

  • vector (Vector | None)

name: str | None
vector: Vector | None
logical_port: LogicalPort | None
physical_port: PhysicalPort | None
port_map: Iterable[PortMap]
abstraction_type: LibraryRefType | None
any_attributes: Mapping[str, str]
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
port_maps: PortMaps | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.abstractor_generator module

class org.accellera.spirit.v1_4.abstractor_generator.AbstractorGenerator(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE)

Bases: InstanceGeneratorType

Specifies a set of abstractor generators.

The scope attribute applies to abstractor 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:
api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
group: Iterable[str]
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
scope: InstanceGeneratorTypeScope
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.abstractor_generators module

class org.accellera.spirit.v1_4.abstractor_generators.AbstractorGenerators(abstractor_generator=<factory>)

Bases: object

List of abstractor generators.

Parameters:

abstractor_generator (Iterable[AbstractorGenerator])

abstractor_generator: Iterable[AbstractorGenerator]

org.accellera.spirit.v1_4.abstractor_mode_type module

class org.accellera.spirit.v1_4.abstractor_mode_type.AbstractorModeType(*values)

Bases: Enum

Mode for this abstractor.

DIRECT = 'direct'
MASTER = 'master'
SLAVE = 'slave'
SYSTEM = 'system'

org.accellera.spirit.v1_4.abstractor_model_type module

class org.accellera.spirit.v1_4.abstractor_model_type.AbstractorModelType(views=None, ports=None, model_parameters=None)

Bases: object

Model information for an abstractor.

Variables:

  • views – View container

  • ports – Port container

  • model_parameters – Model parameter name value pairs container

Parameters:
class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

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

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]
class Ports(port: collections.abc.Iterable[org.accellera.spirit.v1_4.abstractor_port_type.AbstractorPortType] = <factory>)

Bases: object

Parameters:

port (Iterable[AbstractorPortType])

port: Iterable[AbstractorPortType]
class Views(view=<factory>)

Bases: object

Variables:

view – Single view of an abstractor

Parameters:

view (Iterable[AbstractorViewType])

view: Iterable[AbstractorViewType]
model_parameters: ModelParameters | None
ports: Ports | None
views: Views | None

org.accellera.spirit.v1_4.abstractor_port_type module

class org.accellera.spirit.v1_4.abstractor_port_type.AbstractorPortType(name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: PortType

A port description, giving a name and an access type for high level ports.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
vendor_extensions: VendorExtensions | None
wire: PortWireType | None

org.accellera.spirit.v1_4.abstractor_port_wire_type module

class org.accellera.spirit.v1_4.abstractor_port_wire_type.AbstractorPortWireType(direction=None, vector=None, wire_type_defs=None, driver=None, all_logical_directions_allowed=False)

Bases: PortWireType

Wire port type for an abstractor.

Parameters:
all_logical_directions_allowed: bool
constraint_sets: Any
direction: ComponentPortDirectionType | None
driver: Driver | None
vector: Vector | None
wire_type_defs: WireTypeDefs | None

org.accellera.spirit.v1_4.abstractor_type module

class org.accellera.spirit.v1_4.abstractor_type.AbstractorType(vendor=None, library=None, name=None, version=None, abstractor_mode=None, bus_type=None, abstractor_interfaces=None, model=None, abstractor_generators=None, choices=None, file_sets=None, description=None, parameters=None, vendor_extensions=None)

Bases: object

Abstractor-specific extension to abstractorType.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • abstractor_mode – Define the mode for the interfaces on this abstractor. For master the first interface connects to the master, the second connects to the mirroredMaster For slave the first interface connects to the mirroredSlave the second connects to the slave For direct the first interface connects to the master, the second connects to the slave For system the first interface connects to the system, the second connects to the mirroredSystem. For system the group attribute is required

  • bus_type – The bus type of both interfaces. Refers to bus definition using vendor, library, name, version attributes.

  • abstractor_interfaces – The interfaces supported by this abstractor

  • model – Model inofrmation.

  • abstractor_generators – Generator list is tools-specific.

  • choices

  • file_sets

  • description – String for describing the component to users

  • parameters

  • vendor_extensions

Parameters:
class AbstractorInterfaces(abstractor_interface=<factory>)

Bases: object

Variables:

abstractor_interface – An abstractor must have exactly 2 Interfaces.

Parameters:

abstractor_interface (Iterable[AbstractorBusInterfaceType])

abstractor_interface: Iterable[AbstractorBusInterfaceType]
class AbstractorMode(value=None, group=None)

Bases: object

Variables:

  • value

  • group – Define the system group if the mode is set to system

Parameters:
group: str | None
value: AbstractorModeType | None
abstractor_generators: AbstractorGenerators | None
abstractor_interfaces: AbstractorInterfaces | None
abstractor_mode: AbstractorMode | None
bus_type: LibraryRefType | None
choices: Choices | None
description: str | None
file_sets: FileSets | None
library: str | None
model: AbstractorModelType | None
name: str | None
parameters: Parameters | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_4.abstractor_view_type module

class org.accellera.spirit.v1_4.abstractor_view_type.AbstractorViewType(name=None, display_name=None, description=None, env_identifier=<factory>, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Abstraction view type.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • env_identifier – Defines the hardware environment in which this view applies. The format of the string is language:tool:vendor_extension, with each piece being optional. The language must be one of the types from spirit:fileType. The tool values are defined by the SPIRIT Consortium, and include generic values “*Simulation” and “*Synthesis” to imply any tool of the indicated type. Having more than one envIdentifier indicates that the view applies to multiple environments.

  • 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 – Language specific name to identity the model. Verilog or SystemVerilog this is the module name. For VHDL this is, with ()’s, the entity(architecture) name pair or without a single configuration name. For SystemC this is the class name.

  • default_file_builder – Default command and flags used to build derived files from the sourceName files in the referenced file sets.

  • file_set_ref

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • env_identifier (Iterable[str])

  • language (Language | None)

  • model_name (str | None)

  • default_file_builder (Iterable[FileBuilderType])

  • file_set_ref (Iterable[FileSetRef])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Language(value='', strict=None)

Bases: object

Variables:

  • value

  • strict – A value of ‘true’ indicates that this value must match the language being generated for the design.

Parameters:

  • value (str)

  • strict (bool | None)

strict: bool | None
value: str
default_file_builder: Iterable[FileBuilderType]
description: str | None
display_name: str | None
env_identifier: Iterable[str]
file_set_ref: Iterable[FileSetRef]
language: Language | None
model_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.access module

class org.accellera.spirit.v1_4.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_4.access_type module

org.accellera.spirit.v1_4.ad_hoc_connection module

class org.accellera.spirit.v1_4.ad_hoc_connection.AdHocConnection(name=None, display_name=None, description=None, internal_port_reference=<factory>, external_port_reference=<factory>, tied_value=None)

Bases: object

Represents an ad-hoc connection between component ports.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • internal_port_reference – Defines a reference to a port on a component contained within the design.

  • external_port_reference – Defines a reference to a port on the component containing this design. The portRef attribute indicates the name of the port in the containing component.

  • tied_value – The logic value of this connection. Only valid for ports of style wire.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • internal_port_reference (Iterable[InternalPortReference])

  • external_port_reference (Iterable[ExternalPortReference])

  • tied_value (str | None)

class ExternalPortReference(port_ref=None, left=None, right=None)

Bases: object

Variables:

  • port_ref – A port on the top level component.

  • left – Left index of a vector.

  • right – Right index of a vector.

Parameters:

  • port_ref (str | None)

  • left (int | None)

  • right (int | None)

left: int | None
port_ref: str | None
right: int | None
class InternalPortReference(component_ref=None, port_ref=None, left=None, right=None)

Bases: object

Variables:

  • component_ref – A reference to the instanceName element of a component in this design.

  • port_ref – A port on the on the referenced component from componentRef.

  • left – Left index of a vector.

  • right – Right index of a vector.

Parameters:

  • component_ref (str | None)

  • port_ref (str | None)

  • left (int | None)

  • right (int | None)

component_ref: str | None
left: int | None
port_ref: str | None
right: int | None
description: str | None
display_name: str | None
external_port_reference: Iterable[ExternalPortReference]
internal_port_reference: Iterable[InternalPortReference]
name: str | None
tied_value: str | None

org.accellera.spirit.v1_4.ad_hoc_connections module

class org.accellera.spirit.v1_4.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_4.addr_space_ref_type module

class org.accellera.spirit.v1_4.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_4.address_bank_type module

class org.accellera.spirit.v1_4.address_bank_type.AddressBankType(name=None, display_name=None, description=None, base_address=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameters=None, vendor_extensions=None, bank_alignment=None)

Bases: object

Top level bank the specify an address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • base_address

  • 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

  • parameters – 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
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
subspace_map: Iterable[BankedSubspaceType]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None

org.accellera.spirit.v1_4.address_block module

class org.accellera.spirit.v1_4.address_block.AddressBlock(name=None, display_name=None, description=None, base_address=None, range=None, width=None, usage=None, volatile=None, access=None, parameters=None, register=<factory>, vendor_extensions=None)

Bases: AddressBlockType

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

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Register(name=None, display_name=None, description=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, reset=None, field_value=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • address_offset – Offset from the address block’s baseAddress.

  • size – Size in bits.

  • volatile

  • access

  • reset – Register value at reset.

  • field_value – Describes individual bit fields within the register.

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • dim (Iterable[int])

  • address_offset (str | None)

  • size (Size | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • reset (Reset | None)

  • field_value (Iterable[FieldType])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Reset(value=None, mask=None)

Bases: object

Variables:

  • value – The value itself.

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

Parameters:

  • value (Value | None)

  • mask (Mask | None)

class Mask(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
mask: Mask | None
value: Value | None
class Size(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
address_offset: str | None
description: str | None
dim: Iterable[int]
display_name: str | None
field_value: Iterable[FieldType]
name: str | None
parameters: Parameters | None
reset: Reset | None
size: Size | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
base_address: BaseAddress | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
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_4.address_block_type module

class org.accellera.spirit.v1_4.address_block_type.AddressBlockType(name=None, display_name=None, description=None, base_address=None, range=None, width=None, usage=None, volatile=None, access=None, parameters=None, register=<factory>, vendor_extensions=None)

Bases: object

Top level address block that specify an address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • base_address

  • range – The address range of an address block. Expressed as the number of addressable units accessible to the block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:bitsInLAU * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • width – The bit width of a row in the address block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:addressUnitBits * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

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

  • volatile

  • access

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

  • register

  • vendor_extensions

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Register(name=None, display_name=None, description=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, reset=None, field_value=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • address_offset – Offset from the address block’s baseAddress.

  • size – Size in bits.

  • volatile

  • access

  • reset – Register value at reset.

  • field_value – Describes individual bit fields within the register.

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • dim (Iterable[int])

  • address_offset (str | None)

  • size (Size | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • reset (Reset | None)

  • field_value (Iterable[FieldType])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Reset(value=None, mask=None)

Bases: object

Variables:

  • value – The value itself.

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

Parameters:

  • value (Value | None)

  • mask (Mask | None)

class Mask(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
mask: Mask | None
value: Value | None
class Size(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
address_offset: str | None
description: str | None
dim: Iterable[int]
display_name: str | None
field_value: Iterable[FieldType]
name: str | None
parameters: Parameters | None
reset: Reset | None
size: Size | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
base_address: BaseAddress | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
range: Range | None
register: Iterable[Register]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
width: Width | None

org.accellera.spirit.v1_4.address_space_ref module

class org.accellera.spirit.v1_4.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_4.address_spaces module

class org.accellera.spirit.v1_4.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, display_name=None, description=None, range=None, width=None, address_unit_bits=None, executable_image=<factory>, local_memory_map=None, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • range – The address range of an address block. Expressed as the number of addressable units accessible to the block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:bitsInLAU * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • width – The bit width of a row in the address block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:addressUnitBits * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • address_unit_bits

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

  • parameters – Data specific to this address space.

  • vendor_extensions

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
address_unit_bits: AddressUnitBits | None
description: str | None
display_name: str | None
executable_image: Iterable[ExecutableImage]
local_memory_map: LocalMemoryMapType | None
name: str | None
parameters: Parameters | None
range: Range | None
vendor_extensions: VendorExtensions | None
width: Width | None
address_space: Iterable[AddressSpace]

org.accellera.spirit.v1_4.address_unit_bits module

class org.accellera.spirit.v1_4.address_unit_bits.AddressUnitBits(value=None)

Bases: object

The number of data bits in an addressable unit.

The default is byte addressable (8 bits).

Parameters:

value (int | None)

value: int | None

org.accellera.spirit.v1_4.bank module

org.accellera.spirit.v1_4.bank_alignment_type module

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

Bases: Enum

‘serial’ or ‘parallel’ bank alignment.

PARALLEL = 'parallel'
SERIAL = 'serial'

org.accellera.spirit.v1_4.banked_bank_type module

class org.accellera.spirit.v1_4.banked_bank_type.BankedBankType(name=None, display_name=None, description=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameters=None, vendor_extensions=None, bank_alignment=None)

Bases: object

Banks nested inside a bank do not specify address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • 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

  • parameters – 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
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
subspace_map: Iterable[BankedSubspaceType]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None

org.accellera.spirit.v1_4.banked_block_type module

class org.accellera.spirit.v1_4.banked_block_type.BankedBlockType(name=None, display_name=None, description=None, range=None, width=None, usage=None, volatile=None, access=None, parameters=None, register=<factory>, vendor_extensions=None)

Bases: object

Address blocks inside a bank do not specify address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • range – The address range of an address block. Expressed as the number of addressable units accessible to the block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:bitsInLAU * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • width – The bit width of a row in the address block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:addressUnitBits * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

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

  • volatile

  • access

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

  • register

  • vendor_extensions

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Register(name=None, display_name=None, description=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, reset=None, field_value=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • address_offset – Offset from the address block’s baseAddress.

  • size – Size in bits.

  • volatile

  • access

  • reset – Register value at reset.

  • field_value – Describes individual bit fields within the register.

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • dim (Iterable[int])

  • address_offset (str | None)

  • size (Size | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • reset (Reset | None)

  • field_value (Iterable[FieldType])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Reset(value=None, mask=None)

Bases: object

Variables:

  • value – The value itself.

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

Parameters:

  • value (Value | None)

  • mask (Mask | None)

class Mask(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
mask: Mask | None
value: Value | None
class Size(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
address_offset: str | None
description: str | None
dim: Iterable[int]
display_name: str | None
field_value: Iterable[FieldType]
name: str | None
parameters: Parameters | None
reset: Reset | None
size: Size | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
range: Range | None
register: Iterable[Register]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
width: Width | None

org.accellera.spirit.v1_4.banked_subspace_type module

class org.accellera.spirit.v1_4.banked_subspace_type.BankedSubspaceType(name=None, display_name=None, description=None, parameters=None, vendor_extensions=None, master_ref=None)

Bases: object

Subspace references inside banks do not specify an address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • vendor_extensions

  • master_ref

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

  • master_ref (str | None)

description: str | None
display_name: str | None
master_ref: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.base_address module

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

Bases: object

Base of an address block, bank, subspace map or address space.

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
value: str

org.accellera.spirit.v1_4.bit_steering_type module

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

Bases: Enum

Indicates whether bit steering should be used to map this interface onto a bus of different data width.

Values are “on”, “off” (defaults to “off”).

OFF = 'off'
ON = 'on'

org.accellera.spirit.v1_4.bits_in_lau module

class org.accellera.spirit.v1_4.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_4.bus_definition module

class org.accellera.spirit.v1_4.bus_definition.BusDefinition(vendor=None, library=None, name=None, version=None, direct_connection=None, is_addressable=None, extends=None, max_masters=None, max_slaves=None, system_group_names=None, description=None, vendor_extensions=None)

Bases: object

Defines the structural information associated with a bus type, independent of the abstraction level.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

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

  • is_addressable – If true, indicates that this is an addressable bus.

  • extends – Optional name of bus type that this bus definition is compatible with. This bus definition may change the definitions in the existing bus definition

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

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

  • system_group_names – Indicates the list of system group names that are defined for this bus definition.

  • description – String for describing the bus definition to users; no semantic impact

  • vendor_extensions

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • direct_connection (bool | None)

  • is_addressable (bool | None)

  • extends (LibraryRefType | None)

  • max_masters (int | None)

  • max_slaves (int | None)

  • system_group_names (SystemGroupNames | None)

  • description (str | None)

  • vendor_extensions (VendorExtensions | None)

class SystemGroupNames(system_group_name=<factory>)

Bases: object

Variables:

system_group_name – Indicates the name of a system group defined for this bus definition.

Parameters:

system_group_name (Iterable[str])

system_group_name: Iterable[str]
description: str | None
direct_connection: bool | None
extends: LibraryRefType | None
is_addressable: bool | None
library: str | None
max_masters: int | None
max_slaves: int | None
name: str | None
system_group_names: SystemGroupNames | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_4.bus_interface module

class org.accellera.spirit.v1_4.bus_interface.BusInterface(name=None, display_name=None, description=None, bus_type=None, abstraction_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection_required=None, port_maps=None, bits_in_lau=None, bit_steering=None, endianness=None, parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: BusInterfaceType

Describes one of the bus interfaces supported by this component.

Parameters:
class BitSteering(value: Optional[org.accellera.spirit.v1_4.bit_steering_type.BitSteeringType] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (BitSteeringType | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: BitSteeringType | 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.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref=None, base_address=None)

Bases: AddrSpaceRefType

Variables:

base_address – Base of an address space.

Parameters:

  • address_space_ref (str | None)

  • base_address (BaseAddress | None)

class BaseAddress(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: str = 'Base Address:')

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
value: str
address_space_ref: str | None
base_address: BaseAddress | 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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt='Base Address:', state=None)

Bases: object

Variables:

  • value

  • format

  • resolve

  • id

  • dependency

  • any_attributes

  • choice_ref

  • order

  • config_groups

  • bit_string_length

  • minimum

  • maximum

  • range_type

  • prompt

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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

  • state (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_4.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class Monitor(group: org.accellera.spirit.v1_4.group.Group | None = None, interface_mode: org.accellera.spirit.v1_4.monitor_interface_mode.MonitorInterfaceMode | None = None)

Bases: object

Parameters:
group: Group | None
interface_mode: MonitorInterfaceMode | None
class PortMaps(port_map=<factory>)

Bases: object

Variables:

port_map – Maps a component’s port to a port in a bus description. This is the logical to physical mapping. The logical pin comes from the bus interface and the physical pin from the component.

Parameters:

port_map (Iterable[PortMap])

class PortMap(logical_port=None, physical_port=None)

Bases: object

Variables:

  • logical_port – Logical port from abstraction definition

  • physical_port – Physical port from this component

Parameters:
class LogicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Bus port name as specified inside the abstraction definition

  • vector – Definition of the logical indecies for a vectored port.

Parameters:

  • name (str | None)

  • vector (Vector | None)

class Vector(left=None, right=None)

Bases: object

Variables:

  • left – Defines which logical bit maps to the physical left bit below

  • right – Defines which logical bit maps to the physical right bit below

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None
name: str | None
vector: Vector | None
class PhysicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Component port name as specified inside the model port section

  • vector

Parameters:

  • name (str | None)

  • vector (Vector | None)

name: str | None
vector: Vector | None
logical_port: LogicalPort | None
physical_port: PhysicalPort | None
port_map: Iterable[PortMap]
class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

  • memory_map_ref

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

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

Parameters:
class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

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

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

Parameters:

  • master_ref (str | None)

  • opaque (bool | None)

master_ref: str | None
opaque: bool | None
class FileSetRefGroup(group=None, file_set_ref=<factory>)

Bases: object

Variables:

  • group – Abritray name assigned to the collections of fileSets.

  • file_set_ref

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

Bases: object

Parameters:

group (Group | None)

group: Group | None
abstraction_type: LibraryRefType | None
any_attributes: Mapping[str, str]
bit_steering: 'BusInterfaceType.BitSteering' | None
bits_in_lau: BitsInLau | None
bus_type: LibraryRefType | None
connection_required: bool | None
description: str | None
display_name: str | None
endianness: EndianessType | None
master: 'BusInterfaceType.Master' | None
mirrored_master: object | None
mirrored_slave: 'BusInterfaceType.MirroredSlave' | None
mirrored_system: 'BusInterfaceType.MirroredSystem' | None
monitor: 'BusInterfaceType.Monitor' | None
name: str | None
parameters: Parameters | None
port_maps: 'BusInterfaceType.PortMaps' | None
slave: 'BusInterfaceType.Slave' | None
system: 'BusInterfaceType.System' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.bus_interface_type module

class org.accellera.spirit.v1_4.bus_interface_type.BusInterfaceType(name=None, display_name=None, description=None, bus_type=None, abstraction_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection_required=None, port_maps=None, bits_in_lau=None, bit_steering=None, endianness=None, parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Type definition for a busInterface in a component.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • bus_type – The bus type of this interface. Refers to bus definition using vendor, library, name, version attributes.

  • abstraction_type – The abstraction type/level of this interface. Refers to abstraction definition using vendor, library, name, version attributes. Bus definition can be found through a reference in this file.

  • 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 ports 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 ports 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 ports are reversed relative to the specification in the bus definition.

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

  • connection_required – Indicates whether a connection to this interface is required for proper component functionality.

  • port_maps – Listing of maps between component ports and bus ports.

  • bits_in_lau

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

  • endianness – ‘big’: means the most significant element of any multi-element data field is stored at the lowest memory address. ‘little’ means the least significant element of any multi-element data field is stored at the lowest memory address. If this element is not present the default is ‘little’ endian.

  • parameters

  • vendor_extensions

  • any_attributes

Parameters:
class BitSteering(value: Optional[org.accellera.spirit.v1_4.bit_steering_type.BitSteeringType] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (BitSteeringType | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: BitSteeringType | 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.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref=None, base_address=None)

Bases: AddrSpaceRefType

Variables:

base_address – Base of an address space.

Parameters:

  • address_space_ref (str | None)

  • base_address (BaseAddress | None)

class BaseAddress(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: str = 'Base Address:')

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
value: str
address_space_ref: str | None
base_address: BaseAddress | 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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt='Base Address:', state=None)

Bases: object

Variables:

  • value

  • format

  • resolve

  • id

  • dependency

  • any_attributes

  • choice_ref

  • order

  • config_groups

  • bit_string_length

  • minimum

  • maximum

  • range_type

  • prompt

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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

  • state (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_4.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class Monitor(group: org.accellera.spirit.v1_4.group.Group | None = None, interface_mode: org.accellera.spirit.v1_4.monitor_interface_mode.MonitorInterfaceMode | None = None)

Bases: object

Parameters:
group: Group | None
interface_mode: MonitorInterfaceMode | None
class PortMaps(port_map=<factory>)

Bases: object

Variables:

port_map – Maps a component’s port to a port in a bus description. This is the logical to physical mapping. The logical pin comes from the bus interface and the physical pin from the component.

Parameters:

port_map (Iterable[PortMap])

class PortMap(logical_port=None, physical_port=None)

Bases: object

Variables:

  • logical_port – Logical port from abstraction definition

  • physical_port – Physical port from this component

Parameters:
class LogicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Bus port name as specified inside the abstraction definition

  • vector – Definition of the logical indecies for a vectored port.

Parameters:

  • name (str | None)

  • vector (Vector | None)

class Vector(left=None, right=None)

Bases: object

Variables:

  • left – Defines which logical bit maps to the physical left bit below

  • right – Defines which logical bit maps to the physical right bit below

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None
name: str | None
vector: Vector | None
class PhysicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Component port name as specified inside the model port section

  • vector

Parameters:

  • name (str | None)

  • vector (Vector | None)

name: str | None
vector: Vector | None
logical_port: LogicalPort | None
physical_port: PhysicalPort | None
port_map: Iterable[PortMap]
class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

  • memory_map_ref

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

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

Parameters:
class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

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

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

Parameters:

  • master_ref (str | None)

  • opaque (bool | None)

master_ref: str | None
opaque: bool | None
class FileSetRefGroup(group=None, file_set_ref=<factory>)

Bases: object

Variables:

  • group – Abritray name assigned to the collections of fileSets.

  • file_set_ref

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

Bases: object

Parameters:

group (Group | None)

group: Group | None
abstraction_type: LibraryRefType | None
any_attributes: Mapping[str, str]
bit_steering: BitSteering | None
bits_in_lau: BitsInLau | None
bus_type: LibraryRefType | None
connection_required: bool | None
description: str | None
display_name: str | None
endianness: EndianessType | None
master: Master | None
mirrored_master: object | None
mirrored_slave: MirroredSlave | None
mirrored_system: MirroredSystem | None
monitor: Monitor | None
name: str | None
parameters: Parameters | None
port_maps: PortMaps | None
slave: Slave | None
system: System | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.bus_interfaces module

class org.accellera.spirit.v1_4.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_4.cell_class_value_type module

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

Bases: Enum

Indicates legal cell class values.

COMBINATIONAL = 'combinational'
SEQUENTIAL = 'sequential'

org.accellera.spirit.v1_4.cell_function_value_type module

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

Bases: Enum

Indicates legal cell function values.

BUF = 'buf'
DFF = 'dff'
INV = 'inv'
LATCH = 'latch'
MUX21 = 'mux21'
NAND2 = 'nand2'
XOR2 = 'xor2'

org.accellera.spirit.v1_4.cell_specification module

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

Bases: object

Used to provide a generic description of a technology library cell.

Variables:

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

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

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

Bases: object

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

Bases: object

Parameters:
cell_strength: CellStrengthValueType | None
value: CellFunctionValueType | None
cell_class: CellClass | None
cell_function: CellFunction | None

org.accellera.spirit.v1_4.cell_strength_value_type module

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

Bases: Enum

Indicates legal cell strength values.

HIGH = 'high'
LOW = 'low'
MEDIAN = 'median'

org.accellera.spirit.v1_4.channels module

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

Bases: object

Lists all channel connections between mirror interfaces of this component.

Variables:

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

Parameters:

channel (Iterable[Channel])

class Channel(name=None, display_name=None, description=None, bus_interface_ref=<factory>)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • bus_interface_ref (Iterable[str])

bus_interface_ref: Iterable[str]
description: str | None
display_name: str | None
name: str | None
channel: Iterable[Channel]

org.accellera.spirit.v1_4.choices module

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

Bases: object

Choices used by elements with an attribute spirit:choiceRef.

Variables:

choice – Non-empty set of legal values for a elements with an attribute spirit:choiceRef.

Parameters:

choice (Iterable[Choice])

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

Bases: object

Variables:

  • name – Choice key, available for reference by the spirit:choiceRef attribute.

  • enumeration – One 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_4.clock_driver module

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

Bases: ClockDriverType

Describes a driven clock port.

Variables:

clock_name – Indicates the name of the cllock. If not specified the name is assumed to be the name of the containing port.

Parameters:
class ClockPeriod(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseDuration(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseOffset(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
clock_name: str | None
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None

org.accellera.spirit.v1_4.clock_driver_type module

class org.accellera.spirit.v1_4.clock_driver_type.ClockDriverType(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None)

Bases: object

Variables:

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

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

  • clock_pulse_value – Value of port after first clock edge.

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

Parameters:
class ClockPeriod(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseDuration(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseOffset(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None

org.accellera.spirit.v1_4.component module

class org.accellera.spirit.v1_4.component.Component(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, other_clock_drivers=None, description=None, parameters=None, 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, display_name=None, description=None, address_space_ref=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • parameters – Data specific to the cpu.

  • vendor_extensions

Parameters:
address_space_ref: Iterable[AddressSpaceRef]
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
class WhiteboxElements(whitebox_element=<factory>)

Bases: object

Variables:

whitebox_element – A whiteboxElement is a useful way to identify elements of a component that can not be identified through other means such as internal signals and non- software accessible registers.

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
cpus: 'ComponentType.Cpus' | None
description: str | None
file_sets: FileSets | None
library: str | None
memory_maps: MemoryMaps | None
model: Model | None
name: str | None
other_clock_drivers: OtherClocks | None
parameters: Parameters | None
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
whitebox_elements: 'ComponentType.WhiteboxElements' | None

org.accellera.spirit.v1_4.component_generator module

class org.accellera.spirit.v1_4.component_generator.ComponentGenerator(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE)

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:
api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
group: Iterable[str]
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
scope: InstanceGeneratorTypeScope
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.component_generators module

class org.accellera.spirit.v1_4.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_4.component_instance module

class org.accellera.spirit.v1_4.component_instance.ComponentInstance(instance_name=None, display_name=None, description=None, component_ref=None, configurable_element_values=None, vendor_extensions=None)

Bases: object

Component instance element.

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

Variables:

  • instance_name

  • display_name – Display name for the subcomponent instance.

  • description – String for describing this component instance to users

  • component_ref – References a component to be found in an external library. The four attributes define the VLNV of the referenced element.

  • configurable_element_values

  • vendor_extensions

Parameters:
component_ref: LibraryRefType | None
configurable_element_values: ConfigurableElementValues | None
description: str | None
display_name: str | None
instance_name: InstanceName | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.component_instances module

class org.accellera.spirit.v1_4.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_4.component_port_direction_type module

class org.accellera.spirit.v1_4.component_port_direction_type.ComponentPortDirectionType(*values)

Bases: Enum

The direction of a component port.

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

org.accellera.spirit.v1_4.component_type module

class org.accellera.spirit.v1_4.component_type.ComponentType(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, other_clock_drivers=None, description=None, parameters=None, vendor_extensions=None)

Bases: object

Component-specific extension to componentType.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • bus_interfaces

  • channels

  • remap_states

  • address_spaces

  • memory_maps

  • model

  • component_generators – Generator list is tools-specific.

  • choices

  • file_sets

  • whitebox_elements – A list of whiteboxElements

  • cpus – cpu’s in the component

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

  • description – String for describing the component to users

  • parameters

  • 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, display_name=None, description=None, address_space_ref=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • parameters – Data specific to the cpu.

  • vendor_extensions

Parameters:
address_space_ref: Iterable[AddressSpaceRef]
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
class WhiteboxElements(whitebox_element=<factory>)

Bases: object

Variables:

whitebox_element – A whiteboxElement is a useful way to identify elements of a component that can not be identified through other means such as internal signals and non- software accessible registers.

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
cpus: Cpus | None
description: str | None
file_sets: FileSets | None
library: str | None
memory_maps: MemoryMaps | None
model: Model | None
name: str | None
other_clock_drivers: OtherClocks | None
parameters: Parameters | None
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
whitebox_elements: WhiteboxElements | None

org.accellera.spirit.v1_4.configurable_element_value module

class org.accellera.spirit.v1_4.configurable_element_value.ConfigurableElementValue(value='', reference_id=None)

Bases: object

Describes the content of a configurable element.

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

Variables:

  • value

  • reference_id – Refers to the ID attribute of the configurable element.

Parameters:

  • value (str)

  • reference_id (str | None)

reference_id: str | None
value: str

org.accellera.spirit.v1_4.configurable_element_values module

class org.accellera.spirit.v1_4.configurable_element_values.ConfigurableElementValues(configurable_element_value=<factory>)

Bases: object

All configuration information for a contained component, generator, generator chain or abstractor instance.

Variables:

configurable_element_value – Describes the content of a configurable element. The required referenceId attribute refers to the ID attribute of the configurable element.

Parameters:

configurable_element_value (Iterable[ConfigurableElementValue])

configurable_element_value: Iterable[ConfigurableElementValue]

org.accellera.spirit.v1_4.constraint_set module

class org.accellera.spirit.v1_4.constraint_set.ConstraintSet(name=None, display_name=None, description=None, vector=None, drive_constraint=None, load_constraint=None, timing_constraint=<factory>, constraint_set_id='default')

Bases: object

Defines constraints that apply to a component port.

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

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • vector – The optional element vector specify the bits of a vector for which the constraints apply. The vaules of left and right must be within the range of the port. If the vector is not specified then the constraints apply to all the bits of the port.

  • drive_constraint

  • load_constraint

  • timing_constraint

  • constraint_set_id

Parameters:
class Vector(left=None, right=None)

Bases: object

Variables:

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

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

Parameters:

  • left (int | None)

  • right (int | None)

left: int | None
right: int | None
constraint_set_id: str
description: str | None
display_name: str | None
drive_constraint: DriveConstraint | None
load_constraint: LoadConstraint | None
name: str | None
timing_constraint: Iterable[TimingConstraint]
vector: Vector | None

org.accellera.spirit.v1_4.constraint_set_ref module

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

Bases: object

A reference to a set of port constraints.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_4.constraint_sets module

class org.accellera.spirit.v1_4.constraint_sets.ConstraintSets(constraint_set=<factory>)

Bases: object

List of constraintSet elements for a component port.

Parameters:

constraint_set (Iterable[ConstraintSet])

constraint_set: Iterable[ConstraintSet]

org.accellera.spirit.v1_4.data_type_type module

class org.accellera.spirit.v1_4.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_4.default_value module

class org.accellera.spirit.v1_4.default_value.DefaultValue(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt=None)

Bases: object

Default value for a wire port.

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str

org.accellera.spirit.v1_4.delay_value_type module

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

Bases: Enum

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

MAX = 'max'
MIN = 'min'

org.accellera.spirit.v1_4.delay_value_unit_type module

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

Bases: Enum

Indicates legal units for delay values.

NS = 'ns'
PS = 'ps'

org.accellera.spirit.v1_4.dependency module

class org.accellera.spirit.v1_4.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_4.design module

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

Bases: object

Root element for a platform design.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • component_instances

  • interconnections

  • ad_hoc_connections

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

  • description – String for describing the design to users

  • vendor_extensions

Parameters:
class HierConnections(hier_connection=<factory>)

Bases: object

Variables:

hier_connection – Represents a hierarchy connection

Parameters:

hier_connection (Iterable[HierConnection])

class HierConnection(active_interface=None, vendor_extensions=None, interface_ref=None)

Bases: object

Variables:

  • active_interface – Component and bus reference to export to the upper level component. The componentRef and busRef attributes indicate the instance name and bus interface name of the hierachical connection.

  • vendor_extensions

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

Parameters:
active_interface: Interface | None
interface_ref: str | None
vendor_extensions: VendorExtensions | None
hier_connection: Iterable[HierConnection]
ad_hoc_connections: AdHocConnections | None
component_instances: ComponentInstances | None
description: str | None
hier_connections: HierConnections | None
interconnections: Interconnections | None
library: str | None
name: str | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_4.design_configuration module

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

Bases: object

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

Does not describe instance parameterization

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • design_ref – The design to which this configuration applies

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

  • interconnection_configuration – Contains the information about the abstractors required to cross between two interfaces at with different abstractionDefs.

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

  • description – String for describing this design configuration to users

  • vendor_extensions

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

Bases: object

Variables:

  • generator_chain_ref – References a generatorChain.

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

Parameters:
class Generators(generator_name=None, configurable_element_values=None)

Bases: object

Variables:

  • generator_name – This identifies the generator in the chain.

  • configurable_element_values

Parameters:
configurable_element_values: ConfigurableElementValues | None
generator_name: str | None
generator_chain_ref: LibraryRefType | None
generators: Iterable[Generators]
class InterconnectionConfiguration(interconnection_ref=None, abstractors=None)

Bases: object

Variables:

  • interconnection_ref – Reference to the interconnection name or possibly an hierConnection interfaceName in a design file.

  • abstractors – List of abstractors for this interconnection

Parameters:

  • interconnection_ref (str | None)

  • abstractors (Abstractors | None)

class Abstractors(abstractor=<factory>)

Bases: object

Variables:

abstractor – Element to hold a the abstractor reference, the configuration and viewName. If multiple elements are present then the order is the order in which the abstractors should be chained together.

Parameters:

abstractor (Iterable[Abstractor])

class Abstractor(instance_name=None, display_name=None, description=None, abstractor_ref=None, configurable_element_values=None, view_name=None)

Bases: object

Variables:

  • instance_name – Instance name for the abstractor

  • display_name – Display name for the abstractor instance.

  • description – String for describing this abstractor instance to users

  • abstractor_ref – Abstractor reference

  • configurable_element_values

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

Parameters:

  • instance_name (str | None)

  • display_name (str | None)

  • description (str | None)

  • abstractor_ref (LibraryRefType | None)

  • configurable_element_values (ConfigurableElementValues | None)

  • view_name (str | None)

abstractor_ref: LibraryRefType | None
configurable_element_values: ConfigurableElementValues | None
description: str | None
display_name: str | None
instance_name: str | None
view_name: str | None
abstractor: Iterable[Abstractor]
abstractors: Abstractors | None
interconnection_ref: str | None
class ViewConfiguration(instance_name=None, view_name=None)

Bases: object

Variables:

  • instance_name

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

Parameters:

  • instance_name (InstanceName | None)

  • view_name (str | None)

instance_name: InstanceName | None
view_name: str | None
description: str | None
design_ref: LibraryRefType | None
generator_chain_configuration: Iterable[GeneratorChainConfiguration]
interconnection_configuration: Iterable[InterconnectionConfiguration]
library: str | None
name: str | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
view_configuration: Iterable[ViewConfiguration]

org.accellera.spirit.v1_4.drive_constraint module

class org.accellera.spirit.v1_4.drive_constraint.DriveConstraint(cell_specification=None)

Bases: object

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

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

Parameters:

cell_specification (CellSpecification | None)

cell_specification: CellSpecification | None

org.accellera.spirit.v1_4.driver module

class org.accellera.spirit.v1_4.driver.Driver(default_value=None, clock_driver=None, single_shot_driver=None)

Bases: DriverType

Wire port driver element.

Parameters:
clock_driver: ClockDriver | None
default_value: DefaultValue | None
single_shot_driver: SingleShotDriver | None

org.accellera.spirit.v1_4.driver_type module

class org.accellera.spirit.v1_4.driver_type.DriverType(default_value=None, clock_driver=None, single_shot_driver=None)

Bases: object

Wire port driver type.

Parameters:
clock_driver: ClockDriver | None
default_value: DefaultValue | None
single_shot_driver: SingleShotDriver | None

org.accellera.spirit.v1_4.edge_value_type module

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

Bases: Enum

Indicates legal values for edge specification attributes.

FALL = 'fall'
RISE = 'rise'

org.accellera.spirit.v1_4.endianess_type module

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

Bases: Enum

‘big’: means the most significant element of any multi-element data field is stored at the lowest memory address.

‘little’ means the least significant element of any multi-element data field is stored at the lowest memory address. If this element is not present the default is ‘little’ endian.

BIG = 'big'
LITTLE = 'little'

org.accellera.spirit.v1_4.executable_image module

class org.accellera.spirit.v1_4.executable_image.ExecutableImage(name=None, description=None, parameters=None, 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.

  • description – String for describing this executable image to users

  • parameters – 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 – Unique ID for the executableImage, referenced in fileSet/function/fileRef

  • image_type – Open element to describe the type of image. The contents is model and/or generator specific.

Parameters:
class FileSetRefGroup(file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_4.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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Flags(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class ReplaceDefaultFlags(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class LinkerCommandFile(name=None, command_line_switch=None, enable=None, generator_ref=<factory>, vendor_extensions=None)

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.

  • generator_ref

  • vendor_extensions

Parameters:
class CommandLineSwitch(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Enable(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class Name(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
command_line_switch: CommandLineSwitch | None
enable: Enable | None
generator_ref: Iterable[GeneratorRef]
name: Name | None
vendor_extensions: VendorExtensions | None
class LinkerFlags(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
file_builder: Iterable[FileBuilder]
linker: Linker | None
linker_command_file: LinkerCommandFile | None
linker_flags: LinkerFlags | None
description: str | None
file_set_ref_group: FileSetRefGroup | None
id: str | None
image_type: str | None
language_tools: LanguageTools | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.field_type module

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

Bases: object

A field within a register.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • bit_width – Width of the field in bits.

  • access

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

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • bit_offset (int | None)

  • bit_width (BitWidth | None)

  • access (Access | None)

  • values (Iterable[Values])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class BitWidth(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Values(value=None, name=None, description=None)

Bases: object

Variables:

  • value – Enumerated bit field value.

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

  • description – Description of a bit field value.

Parameters:

  • value (str | None)

  • name (str | None)

  • description (str | None)

description: str | None
name: str | None
value: str | None
access: Access | None
bit_offset: int | None
bit_width: BitWidth | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
values: Iterable[Values]
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.file module

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

Bases: object

SPIRIT reference to a file or directory.

Variables:

  • name – Path to the file or directory. If this path is a relative path, then it is relative to the containing XML file.

  • file_type – Enumerated file types known by SPIRIT.

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

  • is_include_file – Indicate that the file is include file.

  • 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 element gives the name to be defined and the text content of the spirit:value element holds the value. This element supports full configurability.

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

  • description – String for describing this file to users

  • vendor_extensions

  • file_id – Unique ID for this file, referenced in fileSet/function/fileRef

  • any_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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Flags(value='', append=None, format=FormatType.STRING, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt=None)

Bases: object

Variables:

  • value

  • append – “true” indicates that the flags shall be appended to any existing flags, “false”indicates these flags will replace any existing default flags.

  • format

  • resolve

  • id

  • dependency

  • any_attributes

  • choice_ref

  • order

  • config_groups

  • bit_string_length

  • minimum

  • maximum

  • range_type

  • prompt

Parameters:

  • value (str)

  • append (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
append: bool | None
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class ReplaceDefaultFlags(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class TargetName(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
command: Command | None
flags: Flags | None
replace_default_flags: ReplaceDefaultFlags | None
target_name: TargetName | None
class IsIncludeFile(value=None, external_declarations=False)

Bases: object

Variables:

  • value

  • external_declarations – the File contains some declarations that is needed in top file

Parameters:

  • value (bool | None)

  • external_declarations (bool)

external_declarations: bool
value: bool | None
class LogicalName(value='', default=False)

Bases: object

Variables:

  • value

  • default – The logical name shall only be used as a default and another process may override this name.

Parameters:

  • value (str)

  • default (bool)

default: bool
value: str
class Name(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
any_attributes: Mapping[str, str]
build_command: BuildCommand | None
define: Iterable[NameValuePairType]
dependency: Iterable[Dependency]
description: str | None
exported_name: Iterable[str]
file_id: str | None
file_type: Iterable[FileFileType]
image_type: Iterable[str]
is_include_file: IsIncludeFile | None
logical_name: LogicalName | None
name: Name | None
user_file_type: Iterable[str]
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.file_builder_file_type module

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

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_4.file_builder_type module

class org.accellera.spirit.v1_4.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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Flags(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class ReplaceDefaultFlags(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
command: Command | None
file_type: FileBuilderTypeFileType | None
flags: Flags | None
replace_default_flags: ReplaceDefaultFlags | None
user_file_type: str | None

org.accellera.spirit.v1_4.file_builder_type_file_type module

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

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_4.file_file_type module

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

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_4.file_set module

class org.accellera.spirit.v1_4.file_set.FileSet(name=None, display_name=None, description=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=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:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • group (Iterable[str])

  • file (Iterable[File])

  • default_file_builder (Iterable[FileBuilderType])

  • dependency (Iterable[Dependency])

  • function (Iterable[Function])

  • vendor_extensions (VendorExtensions | None)

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

Bases: object

Variables:

  • entry_point – Optional name for the function.

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

  • return_type – Function return type. Possible values are void and int.

  • 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 element and its value is in the spirit:value element.

  • disabled – Specifies if the SW function is enabled. If not present the function is always enabled.

  • source_file – Location information for the source file of this function.

  • replicate – If true directs the generator to compile a separate object module for each instance of the component in the design. If false (default) the function will be called with different arguments for each instance.

Parameters:
class Argument(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>, data_type=None)

Bases: NameValuePairType

Variables:

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

  • data_type (DataTypeType | None)

any_attributes: Mapping[str, str]
data_type: DataTypeType | None
description: str | None
display_name: str | None
name: str | None
value: Value | None
vendor_extensions: VendorExtensions | None
class Disabled(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

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

  • file_type – Enumerated file types known by SPIRIT.

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

Parameters:

  • source_name (str | None)

  • file_type (SourceFileFileType | None)

  • user_file_type (str | None)

file_type: SourceFileFileType | None
source_name: str | None
user_file_type: str | None
argument: Iterable[Argument]
disabled: Disabled | None
entry_point: str | None
file_ref: str | None
replicate: bool
return_type: FunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
description: str | None
display_name: str | None
file: Iterable[File]
function: Iterable['FileSetType.Function']
group: Iterable[str]
name: str | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.file_set_ref module

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

Bases: object

A reference to a fileSet.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_4.file_set_type module

class org.accellera.spirit.v1_4.file_set_type.FileSetType(name=None, display_name=None, description=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • 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 – Default command and flags used to build derived files from the sourceName files in this file set.

  • dependency

  • function – Generator information if this file set describes a function. For example, this file set may describe diagnostics for which the DE can generate a diagnostics driver.

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • group (Iterable[str])

  • file (Iterable[File])

  • default_file_builder (Iterable[FileBuilderType])

  • dependency (Iterable[Dependency])

  • function (Iterable[Function])

  • vendor_extensions (VendorExtensions | None)

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

Bases: object

Variables:

  • entry_point – Optional name for the function.

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

  • return_type – Function return type. Possible values are void and int.

  • 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 element and its value is in the spirit:value element.

  • disabled – Specifies if the SW function is enabled. If not present the function is always enabled.

  • source_file – Location information for the source file of this function.

  • replicate – If true directs the generator to compile a separate object module for each instance of the component in the design. If false (default) the function will be called with different arguments for each instance.

Parameters:
class Argument(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>, data_type=None)

Bases: NameValuePairType

Variables:

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

  • data_type (DataTypeType | None)

any_attributes: Mapping[str, str]
data_type: DataTypeType | None
description: str | None
display_name: str | None
name: str | None
value: Value | None
vendor_extensions: VendorExtensions | None
class Disabled(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

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

  • file_type – Enumerated file types known by SPIRIT.

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

Parameters:

  • source_name (str | None)

  • file_type (SourceFileFileType | None)

  • user_file_type (str | None)

file_type: SourceFileFileType | None
source_name: str | None
user_file_type: str | None
argument: Iterable[Argument]
disabled: Disabled | None
entry_point: str | None
file_ref: str | None
replicate: bool
return_type: FunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
description: str | None
display_name: str | None
file: Iterable[File]
function: Iterable[Function]
group: Iterable[str]
name: str | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.file_sets module

class org.accellera.spirit.v1_4.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_4.format_type module

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

Bases: Enum

This is an indication on the formatof the value for user defined properties.

bitString means either a double quoted string of 1’s an 0’s or a spiritNumberFormat number. bool means a boolean (true, false) is expected. float means a decimal floating point number is expected. long means an value of spiritNumberFormat is expected. String means any text is acceptable.

BIT_STRING = 'bitString'
BOOL = 'bool'
FLOAT = 'float'
LONG = 'long'
STRING = 'string'

org.accellera.spirit.v1_4.function_return_type module

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

Bases: Enum

INT = 'int'
VOID = 'void'

org.accellera.spirit.v1_4.generator module

class org.accellera.spirit.v1_4.generator.Generator(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False)

Bases: GeneratorType

Specifies a set of generators.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • phase (Phase | None)

  • parameters (Parameters | None)

  • api_type (GeneratorTypeApiType | None)

  • transport_methods (TransportMethods | None)

  • generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

  • hidden (bool)

api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.generator_chain module

class org.accellera.spirit.v1_4.generator_chain.GeneratorChain(vendor=None, library=None, name=None, version=None, generator_chain_selector=<factory>, component_generator_selector=<factory>, generator=<factory>, chain_group=<factory>, display_name=None, description=None, choices=None, vendor_extensions=None, hidden=False)

Bases: object

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • generator_chain_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 selected based on the selection criteria, DE will prompt the user to resolve to a single generator.

  • component_generator_selector – Selects generators declared in components 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.

  • display_name – Short description string, typically for user interface

  • description – Full description string, typically for documentation

  • choices

  • vendor_extensions

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

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • generator_chain_selector (Iterable[GeneratorChainSelector])

  • component_generator_selector (Iterable[GeneratorSelectorType])

  • generator (Iterable[Generator])

  • chain_group (Iterable[str])

  • display_name (str | None)

  • description (str | None)

  • choices (Choices | None)

  • vendor_extensions (VendorExtensions | None)

  • hidden (bool)

class GeneratorChainSelector(group_selector=None, generator_chain_ref=None, unique=False)

Bases: object

Variables:

  • group_selector

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

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

Parameters:
generator_chain_ref: LibraryRefType | None
group_selector: GroupSelector | None
unique: bool
chain_group: Iterable[str]
choices: Choices | None
component_generator_selector: Iterable[GeneratorSelectorType]
description: str | None
display_name: str | None
generator: Iterable[Generator]
generator_chain_selector: Iterable[GeneratorChainSelector]
hidden: bool
library: str | None
name: str | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None

org.accellera.spirit.v1_4.generator_ref module

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

Bases: object

A reference to a generator element.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_4.generator_selector_type module

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

Bases: object

Parameters:

group_selector (GroupSelector | None)

group_selector: GroupSelector | None

org.accellera.spirit.v1_4.generator_type module

class org.accellera.spirit.v1_4.generator_type.GeneratorType(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False)

Bases: object

Types of generators.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • phase

  • parameters

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

  • transport_methods

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

  • vendor_extensions

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • phase (Phase | None)

  • parameters (Parameters | None)

  • api_type (GeneratorTypeApiType | None)

  • transport_methods (TransportMethods | None)

  • generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

  • hidden (bool)

api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
transport_methods: TransportMethods | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.generator_type_api_type module

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

Bases: Enum

NONE = 'none'
TGI = 'TGI'

org.accellera.spirit.v1_4.group module

org.accellera.spirit.v1_4.group_selector module

class org.accellera.spirit.v1_4.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 – Specifies a generator group name or a generator chain group name to be selected for inclusion in the generator chain.

  • multiple_group_selection_operator – Specifies the OR or AND selection operator if there is more than one group name.

Parameters:
multiple_group_selection_operator: GroupSelectorMultipleGroupSelectionOperator
name: Iterable[str]

org.accellera.spirit.v1_4.group_selector_multiple_group_selection_operator module

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

Bases: Enum

AND = 'and'
OR = 'or'

org.accellera.spirit.v1_4.initiative module

class org.accellera.spirit.v1_4.initiative.Initiative(value=None)

Bases: object

If this element is present, the type of access is restricted to the specified value.

Parameters:

value (InitiativeValue | None)

value: InitiativeValue | None

org.accellera.spirit.v1_4.initiative_value module

class org.accellera.spirit.v1_4.initiative_value.InitiativeValue(*values)

Bases: Enum

BOTH = 'both'
PHANTOM = 'phantom'
PROVIDES = 'provides'
REQUIRES = 'requires'

org.accellera.spirit.v1_4.instance_generator_type module

class org.accellera.spirit.v1_4.instance_generator_type.InstanceGeneratorType(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False, 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:
api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
group: Iterable[str]
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
scope: InstanceGeneratorTypeScope
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.instance_generator_type_scope module

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

Bases: Enum

ENTITY = 'entity'
INSTANCE = 'instance'

org.accellera.spirit.v1_4.instance_name module

class org.accellera.spirit.v1_4.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_4.interconnection module

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

Bases: object

Describes a connection between two active (not monitor) busInterfaces.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • active_interface – Describes one interface of the interconnection. The componentRef and busRef attributes indicate the instance name and bus interface name of one end of the connection.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • active_interface (Iterable[Interface])

active_interface: Iterable[Interface]
description: str | None
display_name: str | None
name: str | None

org.accellera.spirit.v1_4.interconnections module

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

Bases: object

Connections between internal sub components.

Parameters:
interconnection: Iterable[Interconnection]
monitor_interconnection: Iterable[MonitorInterconnection]

org.accellera.spirit.v1_4.interface module

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

Bases: object

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

Variables:

  • component_ref – Reference to a component instance name.

  • bus_ref – Reference to the components bus interface

Parameters:

  • component_ref (str | None)

  • bus_ref (str | None)

bus_ref: str | None
component_ref: str | None

org.accellera.spirit.v1_4.library_ref_type module

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

Bases: object

Base IP-XACT document reference type.

Contains vendor, library, name and version attributes.

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

library: str | None
name: str | None
vendor: str | None
version: str | None

org.accellera.spirit.v1_4.load_constraint module

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

Bases: object

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

Variables:

  • cell_specification

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

Parameters:
cell_specification: CellSpecification | None
count: int | None

org.accellera.spirit.v1_4.local_memory_map_type module

class org.accellera.spirit.v1_4.local_memory_map_type.LocalMemoryMapType(name=None, display_name=None, description=None, 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:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • address_block

  • bank

  • subspace_map – Maps in an address subspace from across 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:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • address_block (Iterable[AddressBlock])

  • bank (Iterable[Bank])

  • subspace_map (Iterable[SubspaceRefType])

address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
description: str | None
display_name: str | None
name: str | None
subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_4.memory_map_ref module

class org.accellera.spirit.v1_4.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_4.memory_map_ref_type module

class org.accellera.spirit.v1_4.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_4.memory_map_type module

class org.accellera.spirit.v1_4.memory_map_type.MemoryMapType(name=None, display_name=None, description=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 – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • address_block

  • bank

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

  • memory_remap

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • address_block (Iterable[AddressBlock])

  • bank (Iterable[Bank])

  • subspace_map (Iterable[SubspaceRefType])

  • memory_remap (Iterable[MemoryRemapType])

address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
description: str | None
display_name: str | None
memory_remap: Iterable[MemoryRemapType]
name: str | None
subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_4.memory_maps module

class org.accellera.spirit.v1_4.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, display_name: Optional[str] = None, description: Optional[str] = None, address_block: collections.abc.Iterable[org.accellera.spirit.v1_4.address_block.AddressBlock] = <factory>, bank: collections.abc.Iterable[org.accellera.spirit.v1_4.bank.Bank] = <factory>, subspace_map: collections.abc.Iterable[org.accellera.spirit.v1_4.subspace_ref_type.SubspaceRefType] = <factory>, memory_remap: collections.abc.Iterable[org.accellera.spirit.v1_4.memory_remap_type.MemoryRemapType] = <factory>, address_unit_bits: Optional[org.accellera.spirit.v1_4.address_unit_bits.AddressUnitBits] = None)

Bases: MemoryMapType

Parameters:
address_block: Iterable[AddressBlock]
address_unit_bits: AddressUnitBits | None
bank: Iterable[Bank]
description: str | None
display_name: str | None
memory_remap: Iterable[MemoryRemapType]
name: str | None
subspace_map: Iterable[SubspaceRefType]
memory_map: Iterable[MemoryMap]

org.accellera.spirit.v1_4.memory_remap_type module

class org.accellera.spirit.v1_4.memory_remap_type.MemoryRemapType(name=None, display_name=None, description=None, 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:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • address_block

  • bank

  • subspace_map – Maps in an address subspace from across 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:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • address_block (Iterable[AddressBlock])

  • bank (Iterable[Bank])

  • subspace_map (Iterable[SubspaceRefType])

  • state (str | None)

address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
description: str | None
display_name: str | None
name: str | None
state: str | None
subspace_map: Iterable[SubspaceRefType]

org.accellera.spirit.v1_4.model module

class org.accellera.spirit.v1_4.model.Model(views=None, ports=None, model_parameters=None)

Bases: ModelType

Model information.

Parameters:
class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

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

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]
class Ports(port: collections.abc.Iterable[org.accellera.spirit.v1_4.port.Port] = <factory>)

Bases: object

Parameters:

port (Iterable[Port])

port: Iterable[Port]
class Views(view=<factory>)

Bases: object

Variables:

view – Single view of a component

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
model_parameters: 'ModelType.ModelParameters' | None
ports: 'ModelType.Ports' | None
views: 'ModelType.Views' | None

org.accellera.spirit.v1_4.model_type module

class org.accellera.spirit.v1_4.model_type.ModelType(views=None, ports=None, model_parameters=None)

Bases: object

Model information.

Variables:

  • views – View container

  • ports – Port container

  • model_parameters – Model parameter name value pairs container

Parameters:
class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

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

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]
class Ports(port: collections.abc.Iterable[org.accellera.spirit.v1_4.port.Port] = <factory>)

Bases: object

Parameters:

port (Iterable[Port])

port: Iterable[Port]
class Views(view=<factory>)

Bases: object

Variables:

view – Single view of a component

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
model_parameters: ModelParameters | None
ports: Ports | None
views: Views | None

org.accellera.spirit.v1_4.monitor_interconnection module

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

Bases: object

Describes a connection from the interface of one component to any number of monitor interfaces in the design.

An active interface can be connected to unlimited number of monitor interfaces.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • active_interface – Describes an active interface of the design that all the monitors will be connected to. The componentRef and busRef attributes indicate the instance name and bus interface name.

  • monitor_interface – Describes a list of monitor interfaces that are connected to the single active interface. The componentRef and busRef attributes indicate the instance name and bus interface name.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • active_interface (Interface | None)

  • monitor_interface (Iterable[Interface])

active_interface: Interface | None
description: str | None
display_name: str | None
monitor_interface: Iterable[Interface]
name: str | None

org.accellera.spirit.v1_4.monitor_interface_mode module

class org.accellera.spirit.v1_4.monitor_interface_mode.MonitorInterfaceMode(*values)

Bases: Enum

MASTER = 'master'
MIRRORED_MASTER = 'mirroredMaster'
MIRRORED_SLAVE = 'mirroredSlave'
MIRRORED_SYSTEM = 'mirroredSystem'
SLAVE = 'slave'
SYSTEM = 'system'

org.accellera.spirit.v1_4.name_value_pair_type module

class org.accellera.spirit.v1_4.name_value_pair_type.NameValuePairType(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Name and value type for use in resolvable elements.

Variables:

  • name – Unique name

  • display_name – Short description string, typically for user interface

  • description – Full description string, typically for documentation

  • value – The value of the parameter.

  • vendor_extensions

  • any_attributes

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]
description: str | None
display_name: str | None
name: str | None
value: Value | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.name_value_type_type module

class org.accellera.spirit.v1_4.name_value_type_type.NameValueTypeType(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>, data_type=None, usage_type=NameValueTypeTypeUsageType.NONTYPED)

Bases: NameValuePairType

Name value pair with data type information.

Variables:

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

  • usage_type – Indicates the type of the model parameter. Legal values are defined in the attribute enumeration list. Default value is ‘nontyped’.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

  • data_type (str | None)

  • usage_type (NameValueTypeTypeUsageType)

any_attributes: Mapping[str, str]
data_type: str | None
description: str | None
display_name: str | None
name: str | None
usage_type: NameValueTypeTypeUsageType
value: 'NameValuePairType.Value' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.name_value_type_type_usage_type module

class org.accellera.spirit.v1_4.name_value_type_type_usage_type.NameValueTypeTypeUsageType(*values)

Bases: Enum

NONTYPED = 'nontyped'
TYPED = 'typed'

org.accellera.spirit.v1_4.on_master_direction module

class org.accellera.spirit.v1_4.on_master_direction.OnMasterDirection(*values)

Bases: Enum

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

org.accellera.spirit.v1_4.on_slave_direction module

class org.accellera.spirit.v1_4.on_slave_direction.OnSlaveDirection(*values)

Bases: Enum

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

org.accellera.spirit.v1_4.on_system_direction module

class org.accellera.spirit.v1_4.on_system_direction.OnSystemDirection(*values)

Bases: Enum

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

org.accellera.spirit.v1_4.other_clock_driver module

class org.accellera.spirit.v1_4.other_clock_driver.OtherClockDriver(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None, clock_name=None, clock_source=None)

Bases: ClockDriverType

Describes a clock not directly associated with an input port.

The clockSource attribute can be used on these clocks to indicate the actual clock source (e.g. an output port of a clock generator cell).

Variables:

  • clock_name – Indicates the name of the clock.

  • clock_source – Indicates the name of the actual clock source (e.g. an output pin of a clock generator cell).

Parameters:
class ClockPeriod(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseDuration(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseOffset(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
clock_name: str | None
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None
clock_source: str | None

org.accellera.spirit.v1_4.other_clocks module

class org.accellera.spirit.v1_4.other_clocks.OtherClocks(other_clock_driver=<factory>)

Bases: object

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

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

Parameters:

other_clock_driver (Iterable[OtherClockDriver])

other_clock_driver: Iterable[OtherClockDriver]

org.accellera.spirit.v1_4.parameter module

class org.accellera.spirit.v1_4.parameter.Parameter(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>)

Bases: NameValuePairType

A name value pair.

The name is specified by the name element. The value is in the text content of the value element. This value element supports all configurability attributes.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]
description: str | None
display_name: str | None
name: str | None
value: 'NameValuePairType.Value' | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.parameters module

class org.accellera.spirit.v1_4.parameters.Parameters(parameter=<factory>)

Bases: object

A collection of parameters.

Parameters:

parameter (Iterable[Parameter])

parameter: Iterable[Parameter]

org.accellera.spirit.v1_4.phase module

class org.accellera.spirit.v1_4.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_4.phase_scope_type module

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

Bases: Enum

GLOBAL = 'global'
LOCAL = 'local'

org.accellera.spirit.v1_4.port module

class org.accellera.spirit.v1_4.port.Port(name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: PortType

Describes port characteristics.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
vendor_extensions: VendorExtensions | None
wire: PortWireType | None

org.accellera.spirit.v1_4.port_access_handle module

class org.accellera.spirit.v1_4.port_access_handle.PortAccessHandle(value='')

Bases: object

If present, a netlister should use this string instead of the port name to access the port.

Parameters:

value (str)

value: str

org.accellera.spirit.v1_4.port_access_type module

class org.accellera.spirit.v1_4.port_access_type.PortAccessType(value=None)

Bases: object

If present, indicates how a netlister accesses a port or all the ports of a busInterface.

Parameters:

value (PortAccessTypeValue | None)

value: PortAccessTypeValue | None

org.accellera.spirit.v1_4.port_access_type_value module

class org.accellera.spirit.v1_4.port_access_type_value.PortAccessTypeValue(*values)

Bases: Enum

PTR = 'ptr'
REF = 'ref'

org.accellera.spirit.v1_4.port_declaration_type module

class org.accellera.spirit.v1_4.port_declaration_type.PortDeclarationType(name=None, display_name=None, description=None, wire=None, transactional=None)

Bases: object

Basic port declarations.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • wire – Defines a port whose type resolves to simple bits.

  • transactional – Defines a port that implements or uses a service that can be implemented with functions or methods.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
wire: PortWireType | None

org.accellera.spirit.v1_4.port_transactional_type module

class org.accellera.spirit.v1_4.port_transactional_type.PortTransactionalType(trans_type_def=None, service=None, access=None, connection=None, all_logical_initiatives_allowed=False)

Bases: object

Transactional port type.

Variables:

  • trans_type_def – Definition of the port type expressed in the default language for this port (i.e. SystemC or SystemV).

  • service – Describes the interface protocol.

  • access – port access mode

  • connection – Bounds number of legal connections.

  • all_logical_initiatives_allowed – True if logical ports with different initiatives from the physical port initiative may be mapped onto this port. Forbidden for phantom ports, which always allow logical ports with all initiatives value to be mapped onto the physical port. Also ignored for “both” ports, since any logical port may be mapped to a physical “both” port.

Parameters:
class Access(port_access_type: org.accellera.spirit.v1_4.port_access_type.PortAccessType | None = None, port_access_handle: org.accellera.spirit.v1_4.port_access_handle.PortAccessHandle | None = None)

Bases: object

Parameters:
port_access_handle: PortAccessHandle | None
port_access_type: PortAccessType | None
class Connection(max_connections=None, min_connections=None)

Bases: object

Variables:

  • max_connections – Indicates the maximum number of connections this port supports. If this element is not present or set to 0 it implies an unbounded number of allowed connections.

  • min_connections – Indicates the minimum number of connections this port supports. If this element is not present, the minimum number of allowed connections is 1.

Parameters:

  • max_connections (int | None)

  • min_connections (int | None)

max_connections: int | None
min_connections: int | None
class Service(initiative=None, service_type_defs=None, vendor_extensions=None)

Bases: object

Variables:

  • initiative – Defines how the port accesses this service.

  • service_type_defs – The group of service type definitions.

  • vendor_extensions

Parameters:
initiative: Initiative | None
service_type_defs: ServiceTypeDefs | None
vendor_extensions: VendorExtensions | None
access: Access | None
all_logical_initiatives_allowed: bool
connection: Connection | None
service: Service | None
trans_type_def: TransTypeDef | None

org.accellera.spirit.v1_4.port_type module

class org.accellera.spirit.v1_4.port_type.PortType(name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: PortDeclarationType

A port description, giving a name and an access type for high level ports.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
vendor_extensions: VendorExtensions | None
wire: PortWireType | None

org.accellera.spirit.v1_4.port_wire_type module

class org.accellera.spirit.v1_4.port_wire_type.PortWireType(direction=None, vector=None, wire_type_defs=None, driver=None, constraint_sets=None, all_logical_directions_allowed=False)

Bases: object

Wire port type for a component.

Variables:

  • direction – The direction of a wire style port. The basic directions for a port are ‘in’ for input ports, ‘out’ for output port and ‘inout’ for bidirectional and tristate ports. A value of ‘phantom’ is also allowed and define a port that exist on the IP-XACT component but not on the HDL model.

  • vector – Specific left and right vector bounds. Signal width is max(left,right)-min(left,right)+1 When the bounds are not present, a scalar port is assumed.

  • wire_type_defs

  • driver

  • constraint_sets

  • all_logical_directions_allowed – True if logical ports with different directions from the physical port direction may be mapped onto this port. Forbidden for phantom ports, which always allow logical ports with all direction value to be mapped onto the physical port. Also ignored for inout ports, since any logical port maybe mapped to a physical inout port.

Parameters:
all_logical_directions_allowed: bool
constraint_sets: ConstraintSets | None
direction: ComponentPortDirectionType | None
driver: Driver | None
vector: Vector | None
wire_type_defs: WireTypeDefs | None

org.accellera.spirit.v1_4.presence module

class org.accellera.spirit.v1_4.presence.Presence(value=PresenceValue.OPTIONAL)

Bases: object

If this element is present, the existance of the port is controlled by the specified value.

valid values are ‘illegal’, ‘required’ and ‘optional’.

Parameters:

value (PresenceValue)

value: PresenceValue

org.accellera.spirit.v1_4.presence_value module

class org.accellera.spirit.v1_4.presence_value.PresenceValue(*values)

Bases: Enum

ILLEGAL = 'illegal'
OPTIONAL = 'optional'
REQUIRED = 'required'

org.accellera.spirit.v1_4.range_type_type module

class org.accellera.spirit.v1_4.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_4.remap_states module

class org.accellera.spirit.v1_4.remap_states.RemapStates(remap_state=<factory>)

Bases: object

Contains a list of remap state names and associated port values.

Variables:

remap_state – Contains a list of ports 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(name=None, display_name=None, description=None, remap_port=<factory>)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • remap_port – Contains the name and value of a port on the component, the value indicates the logic value which this port must take to effect the remapping. The portMapRef attribute stores the name of the port which takes that value.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • remap_port (Iterable[RemapPort])

class RemapPort(value='', port_name_ref=None, port_index=None)

Bases: object

Variables:

  • value

  • port_name_ref – This attribute identifies a signal on the component which affects the component’s memory layout

  • port_index – Index for a vectored type port. Must be a number between left and right for the port.

Parameters:

  • value (str)

  • port_name_ref (str | None)

  • port_index (int | None)

port_index: int | None
port_name_ref: str | None
value: str
description: str | None
display_name: str | None
name: str | None
remap_port: Iterable[RemapPort]
remap_state: Iterable[RemapState]

org.accellera.spirit.v1_4.requires_driver module

class org.accellera.spirit.v1_4.requires_driver.RequiresDriver(value=False, driver_type=RequiresDriverDriverType.ANY)

Bases: object

Specifies if a port 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

Variables:

  • value

  • driver_type – Defines the type of driver that is required. The default is any type of driver. The 2 other options are a clock type driver or a singleshot type driver.

Parameters:
driver_type: RequiresDriverDriverType
value: bool

org.accellera.spirit.v1_4.requires_driver_driver_type module

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

Bases: Enum

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

org.accellera.spirit.v1_4.resolve_type module

class org.accellera.spirit.v1_4.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. Dependent means the value depends on the value of other properties. A dependency expression must be supplied in the dependency attribute. Generated means the value will be provided by a generator.

Variables:

  • IMMEDIATE – Property value is included in the XML file. It cannot be configured.

  • USER – Property content can be modified through confiugration. Modifications will be saved with the design.

  • DEPENDENT – Property value is expressed as an XPath expression which may refer to other properties. The expression must appear in the dendency attribute.

  • GENERATED – Generators may modify this property. Modifications get saved with the design.

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

org.accellera.spirit.v1_4.resolved_library_ref_type module

class org.accellera.spirit.v1_4.resolved_library_ref_type.ResolvedLibraryRefType(value='', vendor=None, library=None, name=None, version=None)

Bases: object

Resolved SPIRIT document reference type.

Contains vendor, library, name and version attributes and the URI of the referenced SPIRIT document

Parameters:

  • value (str)

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

library: str | None
name: str | None
value: str
vendor: str | None
version: str | None

org.accellera.spirit.v1_4.service_type module

class org.accellera.spirit.v1_4.service_type.ServiceType(initiative=ServiceTypeInitiative.REQUIRES, type_name=<factory>, vendor_extensions=None)

Bases: object

The service that this transactional port can provide or requires.

Variables:

  • initiative – If this element is present, the type of access is restricted to the specified value.

  • type_name – Defines the name of the transactional interface type.

  • vendor_extensions

Parameters:
class TypeName(value='', implicit=False)

Bases: object

Variables:

  • value

  • implicit – Defines that the typeName supplied for this service is implicit and a netlister should not declare this service in a language specific top-level netlist

Parameters:

  • value (str)

  • implicit (bool)

implicit: bool
value: str
initiative: ServiceTypeInitiative
type_name: Iterable[TypeName]
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.service_type_def module

class org.accellera.spirit.v1_4.service_type_def.ServiceTypeDef(type_name=None, type_definition=<factory>, parameters=None)

Bases: object

Definition of a single service type defintion.

Variables:

  • type_name – The name of the service type. Can be any predefined type such as booean or integer or any user-defined type such as addr_type or data_type.

  • type_definition – Where the definition of the type is contained if the type if not part of the language. For SystemC and SystemVerilog it is the include file containing the type definition.

  • parameters – list service parameters (e.g. parameters for a systemVerilog interface)

Parameters:

  • type_name (TypeName | None)

  • type_definition (Iterable[str])

  • parameters (Parameters | None)

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

Bases: object

Parameters:

parameter (Iterable[Parameter])

parameter: Iterable[Parameter]
class TypeName(value='', constrained=False, implicit=False)

Bases: object

Variables:

  • value

  • constrained – Defines that the type for the port has constrainted the number of bits in the vector

  • implicit – Defines that the typeName supplied for this service is implicit and a netlister should not declare this service in a language specific top-level netlist

Parameters:

  • value (str)

  • constrained (bool)

  • implicit (bool)

constrained: bool
implicit: bool
value: str
parameters: Parameters | None
type_definition: Iterable[str]
type_name: TypeName | None

org.accellera.spirit.v1_4.service_type_defs module

class org.accellera.spirit.v1_4.service_type_defs.ServiceTypeDefs(service_type_def=<factory>)

Bases: object

The group of type definitions.

If no match to a viewName is found then the default language types are to be used. See the User Guide for these default types.

Parameters:

service_type_def (Iterable[ServiceTypeDef])

service_type_def: Iterable[ServiceTypeDef]

org.accellera.spirit.v1_4.service_type_initiative module

class org.accellera.spirit.v1_4.service_type_initiative.ServiceTypeInitiative(*values)

Bases: Enum

BOTH = 'both'
PROVIDES = 'provides'
REQUIRES = 'requires'

org.accellera.spirit.v1_4.single_shot_driver module

class org.accellera.spirit.v1_4.single_shot_driver.SingleShotDriver(single_shot_offset=None, single_shot_value=None, single_shot_duration=None)

Bases: object

Describes a driven one-shot port.

Variables:

  • single_shot_offset – Time in nanoseconds until start of one- shot.

  • single_shot_value – Value of port after first edge of one- shot.

  • single_shot_duration – Duration in nanoseconds of the one shot.

Parameters:
class SingleShotDuration(value: collections.abc.Iterable[float] = <factory>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: Iterable[float]
class SingleShotOffset(value: collections.abc.Iterable[float] = <factory>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: Iterable[float]
class SingleShotValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
single_shot_duration: SingleShotDuration | None
single_shot_offset: SingleShotOffset | None
single_shot_value: SingleShotValue | None

org.accellera.spirit.v1_4.source_file_file_type module

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

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'

org.accellera.spirit.v1_4.subspace_ref_type module

class org.accellera.spirit.v1_4.subspace_ref_type.SubspaceRefType(name=None, display_name=None, description=None, base_address=None, parameters=None, vendor_extensions=None, master_ref=None)

Bases: object

Address subspace type.

Its subspaceReference attribute references the subspace from which the dimensions are taken.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • base_address

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

  • vendor_extensions

  • master_ref

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • base_address (BaseAddress | None)

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

  • master_ref (str | None)

base_address: BaseAddress | None
description: str | None
display_name: str | None
master_ref: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None

org.accellera.spirit.v1_4.timing_constraint module

class org.accellera.spirit.v1_4.timing_constraint.TimingConstraint(value=None, clock_edge=EdgeValueType.RISE, delay_type=None, clock_name=None)

Bases: object

Defines a timing constraint for the associated port.

The constraint is relative to the clock specified by the clockName attribute. The clockEdge indicates which clock edge the constraint is associated with (default is rising edge). The delayType attribute can be specified to further refine the constraint.

Variables:

  • value

  • clock_edge

  • delay_type

  • clock_name – Indicates the name of the clock to which this constraint applies.

Parameters:
clock_edge: EdgeValueType
clock_name: str | None
delay_type: DelayValueType | None
value: float | None

org.accellera.spirit.v1_4.trans_type_def module

class org.accellera.spirit.v1_4.trans_type_def.TransTypeDef(type_name=None, type_definition=<factory>)

Bases: object

Definition of a single transactional type defintion.

Variables:

  • type_name – The name of the port type. Can be any predefined type such sc_port or sc_export in SystemC or any user-defined type such as tlm_port.

  • type_definition – Where the definition of the type is contained. For SystemC and SystemVerilog it is the include file containing the type definition.

Parameters:

  • type_name (TypeName | None)

  • type_definition (Iterable[str])

class TypeName(value='', constrained=False)

Bases: object

Variables:

  • value

  • constrained – Defines that the type for the port has constrainted the number of bits in the vector

Parameters:

  • value (str)

  • constrained (bool)

constrained: bool
value: str
type_definition: Iterable[str]
type_name: TypeName | None

org.accellera.spirit.v1_4.transport_methods_transport_method module

class org.accellera.spirit.v1_4.transport_methods_transport_method.TransportMethodsTransportMethod(*values)

Bases: Enum

FILE = 'file'

org.accellera.spirit.v1_4.usage_type module

class org.accellera.spirit.v1_4.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_4.vector module

class org.accellera.spirit.v1_4.vector.Vector(left=None, right=None)

Bases: object

Definition of the indecies for a vectored port.

Variables:

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

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

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None

org.accellera.spirit.v1_4.vendor_extensions module

class org.accellera.spirit.v1_4.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_4.view_type module

class org.accellera.spirit.v1_4.view_type.ViewType(name=None, display_name=None, description=None, env_identifier=<factory>, hierarchy_ref=None, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, constraint_set_ref=<factory>, whitebox_element_refs=None, parameters=None, vendor_extensions=None)

Bases: object

Component view type.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • env_identifier – Defines the hardware environment in which this view applies. The format of the string is language:tool:vendor_extension, with each piece being optional. The language must be one of the types from spirit:fileType. The tool values are defined by the SPIRIT Consortium, and include generic values “*Simulation” and “*Synthesis” to imply any tool of the indicated type. Having more than one envIdentifier indicates that the view applies to multiple environments.

  • hierarchy_ref – References a SPIRIT design or configuration document (by VLNV) that provides a design for the component

  • language – The hardware description language used such as “verilog” or “vhdl”. If the attribute “strict” is “true”, this value must match the language being generated for the design.

  • model_name – Language specific name to identity the model. Verilog or SystemVerilog this is the module name. For VHDL this is, with ()’s, the entity(architecture) name pair or without, a single configuration name. For SystemC this is the class name.

  • default_file_builder – Default command and flags used to build derived files from the sourceName files in the referenced file sets.

  • file_set_ref

  • constraint_set_ref

  • whitebox_element_refs – Container for white box element references.

  • parameters

  • vendor_extensions

Parameters:
class Language(value='', strict=False)

Bases: object

Variables:

  • value

  • strict – A value of ‘true’ indicates that this value must match the language being generated for the design.

Parameters:

  • value (str)

  • strict (bool)

strict: bool
value: str
class WhiteboxElementRefs(whitebox_element_ref=<factory>)

Bases: object

Variables:

whitebox_element_ref – Reference to a white box element which is visible within this view.

Parameters:

whitebox_element_ref (Iterable[WhiteboxElementRefType])

whitebox_element_ref: Iterable[WhiteboxElementRefType]
constraint_set_ref: Iterable[ConstraintSetRef]
default_file_builder: Iterable[FileBuilderType]
description: str | None
display_name: str | None
env_identifier: Iterable[str]
file_set_ref: Iterable[FileSetRef]
hierarchy_ref: LibraryRefType | None
language: Language | None
model_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
whitebox_element_refs: WhiteboxElementRefs | None

org.accellera.spirit.v1_4.volatile module

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

Bases: object

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

Parameters:

value (bool)

value: bool

org.accellera.spirit.v1_4.whitebox_element_ref_type module

class org.accellera.spirit.v1_4.whitebox_element_ref_type.WhiteboxElementRefType(whitebox_path=<factory>, name=None)

Bases: object

Reference to a whiteboxElement within a view.

The ‘name’ attribute must refer to a whiteboxElement defined within this component.

Variables:

  • whitebox_path – The whiteboxPath elements (as a set) define the name(s) needed to define the entire white box element in this view.

  • name – Reference to a whiteboxElement defined within this component.

Parameters:
class WhiteboxPath(path_name=None, left=None, right=None)

Bases: object

Variables:

  • path_name – The view specific name for a portion of the white box element.

  • left – Indicates the left bound value for the associated path name.

  • right – Indicates the right bound values for the associated path name.

Parameters:

  • path_name (str | None)

  • left (int | None)

  • right (int | None)

left: int | None
path_name: str | None
right: int | None
name: str | None
whitebox_path: Iterable[WhiteboxPath]

org.accellera.spirit.v1_4.whitebox_element_type module

class org.accellera.spirit.v1_4.whitebox_element_type.WhiteboxElementType(name=None, display_name=None, description=None, whitebox_type=None, driveable=None, register_ref=None, parameters=None, vendor_extensions=None)

Bases: object

Defines a white box reference point within the component.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • whitebox_type – Indicates the type of the element. The pin and signal types refer to elements within the HDL description. The register type refers to a register in the memory map. The interface type refers to a bus interface in a lower level component definition.

  • driveable – If true, indicates that the white box element can be driven (e.g. have a new value forced into it).

  • register_ref – Indicates the name of the register associated with this white box element. The name should be a full hierarchical path from the memory map to the register, using ‘/’ as a hierarchy separator. When specified, the whiteboxType must be ‘register’.

  • parameters

  • vendor_extensions

Parameters:
description: str | None
display_name: str | None
driveable: bool | None
name: str | None
parameters: Parameters | None
register_ref: str | None
vendor_extensions: VendorExtensions | None
whitebox_type: WhiteboxElementTypeWhiteboxType | None

org.accellera.spirit.v1_4.whitebox_element_type_whitebox_type module

class org.accellera.spirit.v1_4.whitebox_element_type_whitebox_type.WhiteboxElementTypeWhiteboxType(*values)

Bases: Enum

INTERFACE = 'interface'
PIN = 'pin'
REGISTER = 'register'
SIGNAL = 'signal'

org.accellera.spirit.v1_4.wire_type_def module

class org.accellera.spirit.v1_4.wire_type_def.WireTypeDef(type_name=None, type_definition=<factory>, view_name_ref=<factory>)

Bases: object

Definition of a single wire type defintion that can relate to multiple views.

Variables:

  • type_name – The name of the logic type. Examples could be std_logic, std_ulogic, std_logic_vector, sc_logic, …

  • type_definition – Where the definition of the type is contained. For std_logic, this is contained in IEEE.std_logic_1164.all. For sc_logic, this is contained in systemc.h. For VHDL this is the library and package as defined by the “used” statement. For SystemC and SystemVerilog it is the include file required. For verilog this is not needed.

  • view_name_ref – A reference to a view name in the file for which this type applies.

Parameters:

  • type_name (TypeName | None)

  • type_definition (Iterable[str])

  • view_name_ref (Iterable[str])

class TypeName(value='', constrained=False)

Bases: object

Variables:

  • value

  • constrained – Defines that the type for the port has constrainted the number of bits in the vector

Parameters:

  • value (str)

  • constrained (bool)

constrained: bool
value: str
type_definition: Iterable[str]
type_name: TypeName | None
view_name_ref: Iterable[str]

org.accellera.spirit.v1_4.wire_type_defs module

class org.accellera.spirit.v1_4.wire_type_defs.WireTypeDefs(wire_type_def=<factory>)

Bases: object

The group of wire type definitions.

If no match to a viewName is found then the default language types are to be used. See the User Guide for these default types.

Parameters:

wire_type_def (Iterable[WireTypeDef])

wire_type_def: Iterable[WireTypeDef]

Module contents

class org.accellera.spirit.v1_4.AbstractionDefPortConstraintsType(timing_constraint=<factory>, drive_constraint=None, load_constraint=None)

Bases: object

Defines constraints that apply to a wire type port in an abstraction definition.

Parameters:
drive_constraint: DriveConstraint | None
load_constraint: LoadConstraint | None
timing_constraint: Iterable[TimingConstraint]
class org.accellera.spirit.v1_4.AbstractionDefinition(vendor=None, library=None, name=None, version=None, bus_type=None, extends=None, ports=None, description=None, vendor_extensions=None)

Bases: object

Define the ports and other information of a particular abstraction of the bus.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • bus_type – Reference to the busDefinition that this abstractionDefinition implements.

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

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

  • description – String for describing the abstraction definition to users; no semantic impact

  • vendor_extensions

Parameters:
class Ports(port: collections.abc.Iterable['AbstractionDefinition.Ports.Port'] = <factory>)

Bases: object

Parameters:

port (Iterable[Port])

class Port(logical_name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: object

Variables:

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

  • display_name – Short description string, typically for user interface

  • description – Full description string, typically for documentation

  • wire – A port that carries logic or an array of logic values

  • transactional – A port that carries complex information modeled at a high level of abstraction.

  • vendor_extensions

Parameters:

  • logical_name (str | None)

  • display_name (str | None)

  • description (str | None)

  • wire (Wire | None)

  • transactional (Transactional | None)

  • vendor_extensions (VendorExtensions | None)

class Transactional(qualifier=None, on_system=<factory>, on_master=None, on_slave=None)

Bases: object

Variables:

  • qualifier – The type of information this port carries A transactional port can carry both address and data information.

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

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

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

Parameters:
class OnMaster(presence=None, service=None)

Bases: object

Variables:

  • presence

  • service – The service that this transactional port can provide or requires.

Parameters:
presence: Presence | None
service: ServiceType | None
class OnSlave(presence=None, service=None)

Bases: object

Variables:

  • presence

  • service – The service that this transactional port can provide or requires.

Parameters:
presence: Presence | None
service: ServiceType | None
class OnSystem(group=None, presence=None, service=None)

Bases: object

Variables:

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

  • presence

  • service – The service that this transactional port can provide or requires.

Parameters:
group: str | None
presence: Presence | None
service: ServiceType | None
class Qualifier(is_address=None, is_data=None)

Bases: object

Variables:

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

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

Parameters:

  • is_address (bool | None)

  • is_data (bool | None)

is_address: bool | None
is_data: bool | None
on_master: OnMaster | None
on_slave: OnSlave | None
on_system: Iterable[OnSystem]
qualifier: Qualifier | None
class Wire(qualifier=None, on_system=<factory>, on_master=None, on_slave=None, default_value=None, requires_driver=None)

Bases: object

Variables:

  • qualifier – The type of information this port carries A wire port can carry both address and data, but may not mix this with a clock or reset

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

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

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

  • default_value – Indicates the default value for this wire port.

  • requires_driver

Parameters:
class OnMaster(presence=None, width=None, direction=None, mode_constraints=None, mirrored_mode_constraints=None)

Bases: object

Variables:

  • presence

  • width – Number of bits required to represent this port. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this port. The logical numbering of the port starts at 0 to width-1.

  • direction – If this element is present, the direction of this port is restricted to the specified value. The direction is relative to the non-mirrored interface.

  • mode_constraints – Specifies default constraints for the enclosing wire type port. If the mirroredModeConstraints element is not defined, then these constraints applied to this port when it appears in a ‘mode’ bus interface or a mirrored-‘mode’ bus interface. Otherwise they only apply when the port appears in a ‘mode’ bus interface.

  • mirrored_mode_constraints – Specifies default constraints for the enclosing wire type port when it appears in a mirrored-‘mode’ bus interface.

Parameters:
direction: OnMasterDirection | None
mirrored_mode_constraints: AbstractionDefPortConstraintsType | None
mode_constraints: AbstractionDefPortConstraintsType | None
presence: Presence | None
width: int | None
class OnSlave(presence=None, width=None, direction=None, mode_constraints=None, mirrored_mode_constraints=None)

Bases: object

Variables:

  • presence

  • width – Number of bits required to represent this port. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this port. The logical numbering of the port starts at 0 to width-1.

  • direction – If this element is present, the direction of this port is restricted to the specified value. The direction is relative to the non-mirrored interface.

  • mode_constraints – Specifies default constraints for the enclosing wire type port. If the mirroredModeConstraints element is not defined, then these constraints applied to this port when it appears in a ‘mode’ bus interface or a mirrored-‘mode’ bus interface. Otherwise they only apply when the port appears in a ‘mode’ bus interface.

  • mirrored_mode_constraints – Specifies default constraints for the enclosing wire type port when it appears in a mirrored-‘mode’ bus interface.

Parameters:
direction: OnSlaveDirection | None
mirrored_mode_constraints: AbstractionDefPortConstraintsType | None
mode_constraints: AbstractionDefPortConstraintsType | None
presence: Presence | None
width: int | None
class OnSystem(group=None, presence=None, width=None, direction=None, mode_constraints=None, mirrored_mode_constraints=None)

Bases: object

Variables:

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

  • presence

  • width – Number of bits required to represent this port. Absence of this element indicates unconstrained number of bits, i.e. the component will define the number of bits in this port. The logical numbering of the port starts at 0 to width-1.

  • direction – If this element is present, the direction of this port is restricted to the specified value. The direction is relative to the non-mirrored interface.

  • mode_constraints – Specifies default constraints for the enclosing wire type port. If the mirroredModeConstraints element is not defined, then these constraints applied to this port when it appears in a ‘mode’ bus interface or a mirrored-‘mode’ bus interface. Otherwise they only apply when the port appears in a ‘mode’ bus interface.

  • mirrored_mode_constraints – Specifies default constraints for the enclosing wire type port when it appears in a mirrored-‘mode’ bus interface.

Parameters:
direction: OnSystemDirection | None
group: str | None
mirrored_mode_constraints: AbstractionDefPortConstraintsType | None
mode_constraints: AbstractionDefPortConstraintsType | None
presence: Presence | None
width: int | None
class Qualifier(is_address=None, is_data=None, is_clock=None, is_reset=None)

Bases: object

Variables:

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

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

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

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

Parameters:

  • is_address (bool | None)

  • is_data (bool | None)

  • is_clock (bool | None)

  • is_reset (bool | None)

is_address: bool | None
is_clock: bool | None
is_data: bool | None
is_reset: bool | None
default_value: str | None
on_master: OnMaster | None
on_slave: OnSlave | None
on_system: Iterable[OnSystem]
qualifier: Qualifier | None
requires_driver: RequiresDriver | None
description: str | None
display_name: str | None
logical_name: str | None
transactional: Transactional | None
vendor_extensions: VendorExtensions | None
wire: Wire | None
port: Iterable[Port]
bus_type: LibraryRefType | None
description: str | None
extends: LibraryRefType | None
library: str | None
name: str | None
ports: Ports | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_4.Abstractor(vendor=None, library=None, name=None, version=None, abstractor_mode=None, bus_type=None, abstractor_interfaces=None, model=None, abstractor_generators=None, choices=None, file_sets=None, description=None, parameters=None, vendor_extensions=None)

Bases: AbstractorType

This is the root element for abstractors.

Parameters:
class AbstractorInterfaces(abstractor_interface=<factory>)

Bases: object

Variables:

abstractor_interface – An abstractor must have exactly 2 Interfaces.

Parameters:

abstractor_interface (Iterable[AbstractorBusInterfaceType])

abstractor_interface: Iterable[AbstractorBusInterfaceType]
class AbstractorMode(value=None, group=None)

Bases: object

Variables:

  • value

  • group – Define the system group if the mode is set to system

Parameters:
group: str | None
value: AbstractorModeType | None
abstractor_generators: AbstractorGenerators | None
abstractor_interfaces: 'AbstractorType.AbstractorInterfaces' | None
abstractor_mode: 'AbstractorType.AbstractorMode' | None
bus_type: LibraryRefType | None
choices: Choices | None
description: str | None
file_sets: FileSets | None
library: str | None
model: AbstractorModelType | None
name: str | None
parameters: Parameters | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_4.AbstractorBusInterfaceType(name=None, display_name=None, description=None, abstraction_type=None, port_maps=None, parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Type definition for a busInterface in a component.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • abstraction_type – The abstraction type/level of this interface. Refers to abstraction definition using vendor, library, name, version attributes. Bus definition can be found through a reference in this file.

  • port_maps – Listing of maps between component ports and bus ports.

  • parameters

  • vendor_extensions

  • any_attributes

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • abstraction_type (LibraryRefType | None)

  • port_maps (PortMaps | None)

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

class PortMaps(port_map=<factory>)

Bases: object

Variables:

port_map – Maps a component’s port to a port in a bus description. This is the logical to physical mapping. The logical pin comes from the bus interface and the physical pin from the component.

Parameters:

port_map (Iterable[PortMap])

class PortMap(logical_port=None, physical_port=None)

Bases: object

Variables:

  • logical_port – Logical port from abstraction definition

  • physical_port – Physical port from this component

Parameters:
class LogicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Bus port name as specified inside the abstraction definition

  • vector – Definition of the logical indecies for a vectored port.

Parameters:

  • name (str | None)

  • vector (Vector | None)

class Vector(left=None, right=None)

Bases: object

Variables:

  • left – Defines which logical bit maps to the physical left bit below

  • right – Defines which logical bit maps to the physical right bit below

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None
name: str | None
vector: Vector | None
class PhysicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Component port name as specified inside the model port section

  • vector

Parameters:

  • name (str | None)

  • vector (Vector | None)

name: str | None
vector: Vector | None
logical_port: LogicalPort | None
physical_port: PhysicalPort | None
port_map: Iterable[PortMap]
abstraction_type: LibraryRefType | None
any_attributes: Mapping[str, str]
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
port_maps: PortMaps | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.AbstractorGenerator(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE)

Bases: InstanceGeneratorType

Specifies a set of abstractor generators.

The scope attribute applies to abstractor 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:
api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
group: Iterable[str]
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
scope: InstanceGeneratorTypeScope
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.AbstractorGenerators(abstractor_generator=<factory>)

Bases: object

List of abstractor generators.

Parameters:

abstractor_generator (Iterable[AbstractorGenerator])

abstractor_generator: Iterable[AbstractorGenerator]
class org.accellera.spirit.v1_4.AbstractorModeType(*values)

Bases: Enum

Mode for this abstractor.

DIRECT = 'direct'
MASTER = 'master'
SLAVE = 'slave'
SYSTEM = 'system'
class org.accellera.spirit.v1_4.AbstractorModelType(views=None, ports=None, model_parameters=None)

Bases: object

Model information for an abstractor.

Variables:

  • views – View container

  • ports – Port container

  • model_parameters – Model parameter name value pairs container

Parameters:
class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

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

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]
class Ports(port: collections.abc.Iterable[org.accellera.spirit.v1_4.abstractor_port_type.AbstractorPortType] = <factory>)

Bases: object

Parameters:

port (Iterable[AbstractorPortType])

port: Iterable[AbstractorPortType]
class Views(view=<factory>)

Bases: object

Variables:

view – Single view of an abstractor

Parameters:

view (Iterable[AbstractorViewType])

view: Iterable[AbstractorViewType]
model_parameters: ModelParameters | None
ports: Ports | None
views: Views | None
class org.accellera.spirit.v1_4.AbstractorPortType(name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: PortType

A port description, giving a name and an access type for high level ports.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
vendor_extensions: VendorExtensions | None
wire: PortWireType | None
class org.accellera.spirit.v1_4.AbstractorPortWireType(direction=None, vector=None, wire_type_defs=None, driver=None, all_logical_directions_allowed=False)

Bases: PortWireType

Wire port type for an abstractor.

Parameters:
all_logical_directions_allowed: bool
constraint_sets: Any
direction: ComponentPortDirectionType | None
driver: Driver | None
vector: Vector | None
wire_type_defs: WireTypeDefs | None
class org.accellera.spirit.v1_4.AbstractorType(vendor=None, library=None, name=None, version=None, abstractor_mode=None, bus_type=None, abstractor_interfaces=None, model=None, abstractor_generators=None, choices=None, file_sets=None, description=None, parameters=None, vendor_extensions=None)

Bases: object

Abstractor-specific extension to abstractorType.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • abstractor_mode – Define the mode for the interfaces on this abstractor. For master the first interface connects to the master, the second connects to the mirroredMaster For slave the first interface connects to the mirroredSlave the second connects to the slave For direct the first interface connects to the master, the second connects to the slave For system the first interface connects to the system, the second connects to the mirroredSystem. For system the group attribute is required

  • bus_type – The bus type of both interfaces. Refers to bus definition using vendor, library, name, version attributes.

  • abstractor_interfaces – The interfaces supported by this abstractor

  • model – Model inofrmation.

  • abstractor_generators – Generator list is tools-specific.

  • choices

  • file_sets

  • description – String for describing the component to users

  • parameters

  • vendor_extensions

Parameters:
class AbstractorInterfaces(abstractor_interface=<factory>)

Bases: object

Variables:

abstractor_interface – An abstractor must have exactly 2 Interfaces.

Parameters:

abstractor_interface (Iterable[AbstractorBusInterfaceType])

abstractor_interface: Iterable[AbstractorBusInterfaceType]
class AbstractorMode(value=None, group=None)

Bases: object

Variables:

  • value

  • group – Define the system group if the mode is set to system

Parameters:
group: str | None
value: AbstractorModeType | None
abstractor_generators: AbstractorGenerators | None
abstractor_interfaces: AbstractorInterfaces | None
abstractor_mode: AbstractorMode | None
bus_type: LibraryRefType | None
choices: Choices | None
description: str | None
file_sets: FileSets | None
library: str | None
model: AbstractorModelType | None
name: str | None
parameters: Parameters | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_4.AbstractorViewType(name=None, display_name=None, description=None, env_identifier=<factory>, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Abstraction view type.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • env_identifier – Defines the hardware environment in which this view applies. The format of the string is language:tool:vendor_extension, with each piece being optional. The language must be one of the types from spirit:fileType. The tool values are defined by the SPIRIT Consortium, and include generic values “*Simulation” and “*Synthesis” to imply any tool of the indicated type. Having more than one envIdentifier indicates that the view applies to multiple environments.

  • 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 – Language specific name to identity the model. Verilog or SystemVerilog this is the module name. For VHDL this is, with ()’s, the entity(architecture) name pair or without a single configuration name. For SystemC this is the class name.

  • default_file_builder – Default command and flags used to build derived files from the sourceName files in the referenced file sets.

  • file_set_ref

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • env_identifier (Iterable[str])

  • language (Language | None)

  • model_name (str | None)

  • default_file_builder (Iterable[FileBuilderType])

  • file_set_ref (Iterable[FileSetRef])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Language(value='', strict=None)

Bases: object

Variables:

  • value

  • strict – A value of ‘true’ indicates that this value must match the language being generated for the design.

Parameters:

  • value (str)

  • strict (bool | None)

strict: bool | None
value: str
default_file_builder: Iterable[FileBuilderType]
description: str | None
display_name: str | None
env_identifier: Iterable[str]
file_set_ref: Iterable[FileSetRef]
language: Language | None
model_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.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_4.AdHocConnection(name=None, display_name=None, description=None, internal_port_reference=<factory>, external_port_reference=<factory>, tied_value=None)

Bases: object

Represents an ad-hoc connection between component ports.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • internal_port_reference – Defines a reference to a port on a component contained within the design.

  • external_port_reference – Defines a reference to a port on the component containing this design. The portRef attribute indicates the name of the port in the containing component.

  • tied_value – The logic value of this connection. Only valid for ports of style wire.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • internal_port_reference (Iterable[InternalPortReference])

  • external_port_reference (Iterable[ExternalPortReference])

  • tied_value (str | None)

class ExternalPortReference(port_ref=None, left=None, right=None)

Bases: object

Variables:

  • port_ref – A port on the top level component.

  • left – Left index of a vector.

  • right – Right index of a vector.

Parameters:

  • port_ref (str | None)

  • left (int | None)

  • right (int | None)

left: int | None
port_ref: str | None
right: int | None
class InternalPortReference(component_ref=None, port_ref=None, left=None, right=None)

Bases: object

Variables:

  • component_ref – A reference to the instanceName element of a component in this design.

  • port_ref – A port on the on the referenced component from componentRef.

  • left – Left index of a vector.

  • right – Right index of a vector.

Parameters:

  • component_ref (str | None)

  • port_ref (str | None)

  • left (int | None)

  • right (int | None)

component_ref: str | None
left: int | None
port_ref: str | None
right: int | None
description: str | None
display_name: str | None
external_port_reference: Iterable[ExternalPortReference]
internal_port_reference: Iterable[InternalPortReference]
name: str | None
tied_value: str | None
class org.accellera.spirit.v1_4.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_4.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_4.AddressBankType(name=None, display_name=None, description=None, base_address=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameters=None, vendor_extensions=None, bank_alignment=None)

Bases: object

Top level bank the specify an address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • base_address

  • 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

  • parameters – 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
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
subspace_map: Iterable[BankedSubspaceType]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class org.accellera.spirit.v1_4.AddressBlock(name=None, display_name=None, description=None, base_address=None, range=None, width=None, usage=None, volatile=None, access=None, parameters=None, register=<factory>, vendor_extensions=None)

Bases: AddressBlockType

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

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Register(name=None, display_name=None, description=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, reset=None, field_value=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • address_offset – Offset from the address block’s baseAddress.

  • size – Size in bits.

  • volatile

  • access

  • reset – Register value at reset.

  • field_value – Describes individual bit fields within the register.

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • dim (Iterable[int])

  • address_offset (str | None)

  • size (Size | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • reset (Reset | None)

  • field_value (Iterable[FieldType])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Reset(value=None, mask=None)

Bases: object

Variables:

  • value – The value itself.

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

Parameters:

  • value (Value | None)

  • mask (Mask | None)

class Mask(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
mask: Mask | None
value: Value | None
class Size(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
address_offset: str | None
description: str | None
dim: Iterable[int]
display_name: str | None
field_value: Iterable[FieldType]
name: str | None
parameters: Parameters | None
reset: Reset | None
size: Size | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
base_address: BaseAddress | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
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_4.AddressBlockType(name=None, display_name=None, description=None, base_address=None, range=None, width=None, usage=None, volatile=None, access=None, parameters=None, register=<factory>, vendor_extensions=None)

Bases: object

Top level address block that specify an address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • base_address

  • range – The address range of an address block. Expressed as the number of addressable units accessible to the block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:bitsInLAU * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • width – The bit width of a row in the address block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:addressUnitBits * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

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

  • volatile

  • access

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

  • register

  • vendor_extensions

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Register(name=None, display_name=None, description=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, reset=None, field_value=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • address_offset – Offset from the address block’s baseAddress.

  • size – Size in bits.

  • volatile

  • access

  • reset – Register value at reset.

  • field_value – Describes individual bit fields within the register.

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • dim (Iterable[int])

  • address_offset (str | None)

  • size (Size | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • reset (Reset | None)

  • field_value (Iterable[FieldType])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Reset(value=None, mask=None)

Bases: object

Variables:

  • value – The value itself.

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

Parameters:

  • value (Value | None)

  • mask (Mask | None)

class Mask(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
mask: Mask | None
value: Value | None
class Size(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
address_offset: str | None
description: str | None
dim: Iterable[int]
display_name: str | None
field_value: Iterable[FieldType]
name: str | None
parameters: Parameters | None
reset: Reset | None
size: Size | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
base_address: BaseAddress | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
range: Range | None
register: Iterable[Register]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
width: Width | None
class org.accellera.spirit.v1_4.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_4.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, display_name=None, description=None, range=None, width=None, address_unit_bits=None, executable_image=<factory>, local_memory_map=None, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • range – The address range of an address block. Expressed as the number of addressable units accessible to the block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:bitsInLAU * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • width – The bit width of a row in the address block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:addressUnitBits * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • address_unit_bits

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

  • parameters – Data specific to this address space.

  • vendor_extensions

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
address_unit_bits: AddressUnitBits | None
description: str | None
display_name: str | None
executable_image: Iterable[ExecutableImage]
local_memory_map: LocalMemoryMapType | None
name: str | None
parameters: Parameters | None
range: Range | None
vendor_extensions: VendorExtensions | None
width: Width | None
address_space: Iterable[AddressSpace]
class org.accellera.spirit.v1_4.AddressUnitBits(value=None)

Bases: object

The number of data bits in an addressable unit.

The default is byte addressable (8 bits).

Parameters:

value (int | None)

value: int | None
class org.accellera.spirit.v1_4.BankAlignmentType(*values)

Bases: Enum

‘serial’ or ‘parallel’ bank alignment.

PARALLEL = 'parallel'
SERIAL = 'serial'
class org.accellera.spirit.v1_4.BankedBankType(name=None, display_name=None, description=None, address_block=<factory>, bank=<factory>, subspace_map=<factory>, usage=None, volatile=None, access=None, parameters=None, vendor_extensions=None, bank_alignment=None)

Bases: object

Banks nested inside a bank do not specify address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • 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

  • parameters – 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
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
subspace_map: Iterable[BankedSubspaceType]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class org.accellera.spirit.v1_4.BankedBlockType(name=None, display_name=None, description=None, range=None, width=None, usage=None, volatile=None, access=None, parameters=None, register=<factory>, vendor_extensions=None)

Bases: object

Address blocks inside a bank do not specify address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • range – The address range of an address block. Expressed as the number of addressable units accessible to the block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:bitsInLAU * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

  • width – The bit width of a row in the address block. The range and the width are related by the following formulas: number_of_bits_in_block = spirit:addressUnitBits * spirit:range number_of_rows_in_block = number_of_bits_in_block / spirit:width

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

  • volatile

  • access

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

  • register

  • vendor_extensions

Parameters:
class Range(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Register(name=None, display_name=None, description=None, dim=<factory>, address_offset=None, size=None, volatile=None, access=None, reset=None, field_value=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • address_offset – Offset from the address block’s baseAddress.

  • size – Size in bits.

  • volatile

  • access

  • reset – Register value at reset.

  • field_value – Describes individual bit fields within the register.

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • dim (Iterable[int])

  • address_offset (str | None)

  • size (Size | None)

  • volatile (Volatile | None)

  • access (Access | None)

  • reset (Reset | None)

  • field_value (Iterable[FieldType])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class Reset(value=None, mask=None)

Bases: object

Variables:

  • value – The value itself.

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

Parameters:

  • value (Value | None)

  • mask (Mask | None)

class Mask(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
mask: Mask | None
value: Value | None
class Size(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
address_offset: str | None
description: str | None
dim: Iterable[int]
display_name: str | None
field_value: Iterable[FieldType]
name: str | None
parameters: Parameters | None
reset: Reset | None
size: Size | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
class Width(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
access: Access | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
range: Range | None
register: Iterable[Register]
usage: UsageType | None
vendor_extensions: VendorExtensions | None
volatile: Volatile | None
width: Width | None
class org.accellera.spirit.v1_4.BankedSubspaceType(name=None, display_name=None, description=None, parameters=None, vendor_extensions=None, master_ref=None)

Bases: object

Subspace references inside banks do not specify an address.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • vendor_extensions

  • master_ref

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

  • master_ref (str | None)

description: str | None
display_name: str | None
master_ref: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.BaseAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt='Base Address:')

Bases: object

Base of an address block, bank, subspace map or address space.

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
value: str
class org.accellera.spirit.v1_4.BitSteeringType(*values)

Bases: Enum

Indicates whether bit steering should be used to map this interface onto a bus of different data width.

Values are “on”, “off” (defaults to “off”).

OFF = 'off'
ON = 'on'
class org.accellera.spirit.v1_4.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_4.BusDefinition(vendor=None, library=None, name=None, version=None, direct_connection=None, is_addressable=None, extends=None, max_masters=None, max_slaves=None, system_group_names=None, description=None, vendor_extensions=None)

Bases: object

Defines the structural information associated with a bus type, independent of the abstraction level.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

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

  • is_addressable – If true, indicates that this is an addressable bus.

  • extends – Optional name of bus type that this bus definition is compatible with. This bus definition may change the definitions in the existing bus definition

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

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

  • system_group_names – Indicates the list of system group names that are defined for this bus definition.

  • description – String for describing the bus definition to users; no semantic impact

  • vendor_extensions

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • direct_connection (bool | None)

  • is_addressable (bool | None)

  • extends (LibraryRefType | None)

  • max_masters (int | None)

  • max_slaves (int | None)

  • system_group_names (SystemGroupNames | None)

  • description (str | None)

  • vendor_extensions (VendorExtensions | None)

class SystemGroupNames(system_group_name=<factory>)

Bases: object

Variables:

system_group_name – Indicates the name of a system group defined for this bus definition.

Parameters:

system_group_name (Iterable[str])

system_group_name: Iterable[str]
description: str | None
direct_connection: bool | None
extends: LibraryRefType | None
is_addressable: bool | None
library: str | None
max_masters: int | None
max_slaves: int | None
name: str | None
system_group_names: SystemGroupNames | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_4.BusInterface(name=None, display_name=None, description=None, bus_type=None, abstraction_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection_required=None, port_maps=None, bits_in_lau=None, bit_steering=None, endianness=None, parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: BusInterfaceType

Describes one of the bus interfaces supported by this component.

Parameters:
class BitSteering(value: Optional[org.accellera.spirit.v1_4.bit_steering_type.BitSteeringType] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (BitSteeringType | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: BitSteeringType | 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.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref=None, base_address=None)

Bases: AddrSpaceRefType

Variables:

base_address – Base of an address space.

Parameters:

  • address_space_ref (str | None)

  • base_address (BaseAddress | None)

class BaseAddress(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: str = 'Base Address:')

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
value: str
address_space_ref: str | None
base_address: BaseAddress | 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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt='Base Address:', state=None)

Bases: object

Variables:

  • value

  • format

  • resolve

  • id

  • dependency

  • any_attributes

  • choice_ref

  • order

  • config_groups

  • bit_string_length

  • minimum

  • maximum

  • range_type

  • prompt

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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

  • state (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_4.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class Monitor(group: org.accellera.spirit.v1_4.group.Group | None = None, interface_mode: org.accellera.spirit.v1_4.monitor_interface_mode.MonitorInterfaceMode | None = None)

Bases: object

Parameters:
group: Group | None
interface_mode: MonitorInterfaceMode | None
class PortMaps(port_map=<factory>)

Bases: object

Variables:

port_map – Maps a component’s port to a port in a bus description. This is the logical to physical mapping. The logical pin comes from the bus interface and the physical pin from the component.

Parameters:

port_map (Iterable[PortMap])

class PortMap(logical_port=None, physical_port=None)

Bases: object

Variables:

  • logical_port – Logical port from abstraction definition

  • physical_port – Physical port from this component

Parameters:
class LogicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Bus port name as specified inside the abstraction definition

  • vector – Definition of the logical indecies for a vectored port.

Parameters:

  • name (str | None)

  • vector (Vector | None)

class Vector(left=None, right=None)

Bases: object

Variables:

  • left – Defines which logical bit maps to the physical left bit below

  • right – Defines which logical bit maps to the physical right bit below

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None
name: str | None
vector: Vector | None
class PhysicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Component port name as specified inside the model port section

  • vector

Parameters:

  • name (str | None)

  • vector (Vector | None)

name: str | None
vector: Vector | None
logical_port: LogicalPort | None
physical_port: PhysicalPort | None
port_map: Iterable[PortMap]
class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

  • memory_map_ref

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

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

Parameters:
class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

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

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

Parameters:

  • master_ref (str | None)

  • opaque (bool | None)

master_ref: str | None
opaque: bool | None
class FileSetRefGroup(group=None, file_set_ref=<factory>)

Bases: object

Variables:

  • group – Abritray name assigned to the collections of fileSets.

  • file_set_ref

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

Bases: object

Parameters:

group (Group | None)

group: Group | None
abstraction_type: LibraryRefType | None
any_attributes: Mapping[str, str]
bit_steering: 'BusInterfaceType.BitSteering' | None
bits_in_lau: BitsInLau | None
bus_type: LibraryRefType | None
connection_required: bool | None
description: str | None
display_name: str | None
endianness: EndianessType | None
master: 'BusInterfaceType.Master' | None
mirrored_master: object | None
mirrored_slave: 'BusInterfaceType.MirroredSlave' | None
mirrored_system: 'BusInterfaceType.MirroredSystem' | None
monitor: 'BusInterfaceType.Monitor' | None
name: str | None
parameters: Parameters | None
port_maps: 'BusInterfaceType.PortMaps' | None
slave: 'BusInterfaceType.Slave' | None
system: 'BusInterfaceType.System' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.BusInterfaceType(name=None, display_name=None, description=None, bus_type=None, abstraction_type=None, master=None, slave=None, system=None, mirrored_slave=None, mirrored_master=None, mirrored_system=None, monitor=None, connection_required=None, port_maps=None, bits_in_lau=None, bit_steering=None, endianness=None, parameters=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Type definition for a busInterface in a component.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • bus_type – The bus type of this interface. Refers to bus definition using vendor, library, name, version attributes.

  • abstraction_type – The abstraction type/level of this interface. Refers to abstraction definition using vendor, library, name, version attributes. Bus definition can be found through a reference in this file.

  • 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 ports 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 ports 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 ports are reversed relative to the specification in the bus definition.

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

  • connection_required – Indicates whether a connection to this interface is required for proper component functionality.

  • port_maps – Listing of maps between component ports and bus ports.

  • bits_in_lau

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

  • endianness – ‘big’: means the most significant element of any multi-element data field is stored at the lowest memory address. ‘little’ means the least significant element of any multi-element data field is stored at the lowest memory address. If this element is not present the default is ‘little’ endian.

  • parameters

  • vendor_extensions

  • any_attributes

Parameters:
class BitSteering(value: Optional[org.accellera.spirit.v1_4.bit_steering_type.BitSteeringType] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (BitSteeringType | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: BitSteeringType | 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.

Parameters:

address_space_ref (AddressSpaceRef | None)

class AddressSpaceRef(address_space_ref=None, base_address=None)

Bases: AddrSpaceRefType

Variables:

base_address – Base of an address space.

Parameters:

  • address_space_ref (str | None)

  • base_address (BaseAddress | None)

class BaseAddress(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: str = 'Base Address:')

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
value: str
address_space_ref: str | None
base_address: BaseAddress | 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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class RemapAddress(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt='Base Address:', state=None)

Bases: object

Variables:

  • value

  • format

  • resolve

  • id

  • dependency

  • any_attributes

  • choice_ref

  • order

  • config_groups

  • bit_string_length

  • minimum

  • maximum

  • range_type

  • prompt

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

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str)

  • state (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str
range_type: RangeTypeType
resolve: ResolveType
state: str | None
value: str
range: Range | None
remap_address: Iterable[RemapAddress]
base_addresses: BaseAddresses | None
class MirroredSystem(group: org.accellera.spirit.v1_4.group.Group | None = None)

Bases: object

Parameters:

group (Group | None)

group: Group | None
class Monitor(group: org.accellera.spirit.v1_4.group.Group | None = None, interface_mode: org.accellera.spirit.v1_4.monitor_interface_mode.MonitorInterfaceMode | None = None)

Bases: object

Parameters:
group: Group | None
interface_mode: MonitorInterfaceMode | None
class PortMaps(port_map=<factory>)

Bases: object

Variables:

port_map – Maps a component’s port to a port in a bus description. This is the logical to physical mapping. The logical pin comes from the bus interface and the physical pin from the component.

Parameters:

port_map (Iterable[PortMap])

class PortMap(logical_port=None, physical_port=None)

Bases: object

Variables:

  • logical_port – Logical port from abstraction definition

  • physical_port – Physical port from this component

Parameters:
class LogicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Bus port name as specified inside the abstraction definition

  • vector – Definition of the logical indecies for a vectored port.

Parameters:

  • name (str | None)

  • vector (Vector | None)

class Vector(left=None, right=None)

Bases: object

Variables:

  • left – Defines which logical bit maps to the physical left bit below

  • right – Defines which logical bit maps to the physical right bit below

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None
name: str | None
vector: Vector | None
class PhysicalPort(name=None, vector=None)

Bases: object

Variables:

  • name – Component port name as specified inside the model port section

  • vector

Parameters:

  • name (str | None)

  • vector (Vector | None)

name: str | None
vector: Vector | None
logical_port: LogicalPort | None
physical_port: PhysicalPort | None
port_map: Iterable[PortMap]
class Slave(memory_map_ref=None, bridge=<factory>, file_set_ref_group=<factory>)

Bases: object

Variables:

  • memory_map_ref

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

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

Parameters:
class Bridge(master_ref=None, opaque=None)

Bases: object

Variables:

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

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

Parameters:

  • master_ref (str | None)

  • opaque (bool | None)

master_ref: str | None
opaque: bool | None
class FileSetRefGroup(group=None, file_set_ref=<factory>)

Bases: object

Variables:

  • group – Abritray name assigned to the collections of fileSets.

  • file_set_ref

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

Bases: object

Parameters:

group (Group | None)

group: Group | None
abstraction_type: LibraryRefType | None
any_attributes: Mapping[str, str]
bit_steering: BitSteering | None
bits_in_lau: BitsInLau | None
bus_type: LibraryRefType | None
connection_required: bool | None
description: str | None
display_name: str | None
endianness: EndianessType | None
master: Master | None
mirrored_master: object | None
mirrored_slave: MirroredSlave | None
mirrored_system: MirroredSystem | None
monitor: Monitor | None
name: str | None
parameters: Parameters | None
port_maps: PortMaps | None
slave: Slave | None
system: System | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.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_4.CellClassValueType(*values)

Bases: Enum

Indicates legal cell class values.

COMBINATIONAL = 'combinational'
SEQUENTIAL = 'sequential'
class org.accellera.spirit.v1_4.CellFunctionValueType(*values)

Bases: Enum

Indicates legal cell function values.

BUF = 'buf'
DFF = 'dff'
INV = 'inv'
LATCH = 'latch'
MUX21 = 'mux21'
NAND2 = 'nand2'
XOR2 = 'xor2'
class org.accellera.spirit.v1_4.CellSpecification(cell_function=None, cell_class=None)

Bases: object

Used to provide a generic description of a technology library cell.

Variables:

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

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

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

Bases: object

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

Bases: object

Parameters:
cell_strength: CellStrengthValueType | None
value: CellFunctionValueType | None
cell_class: CellClass | None
cell_function: CellFunction | None
class org.accellera.spirit.v1_4.CellStrengthValueType(*values)

Bases: Enum

Indicates legal cell strength values.

HIGH = 'high'
LOW = 'low'
MEDIAN = 'median'
class org.accellera.spirit.v1_4.Channels(channel=<factory>)

Bases: object

Lists all channel connections between mirror interfaces of this component.

Variables:

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

Parameters:

channel (Iterable[Channel])

class Channel(name=None, display_name=None, description=None, bus_interface_ref=<factory>)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • bus_interface_ref (Iterable[str])

bus_interface_ref: Iterable[str]
description: str | None
display_name: str | None
name: str | None
channel: Iterable[Channel]
class org.accellera.spirit.v1_4.Choices(choice=<factory>)

Bases: object

Choices used by elements with an attribute spirit:choiceRef.

Variables:

choice – Non-empty set of legal values for a elements with an attribute spirit:choiceRef.

Parameters:

choice (Iterable[Choice])

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

Bases: object

Variables:

  • name – Choice key, available for reference by the spirit:choiceRef attribute.

  • enumeration – One 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_4.ClockDriver(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None, clock_name=None)

Bases: ClockDriverType

Describes a driven clock port.

Variables:

clock_name – Indicates the name of the cllock. If not specified the name is assumed to be the name of the containing port.

Parameters:
class ClockPeriod(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseDuration(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseOffset(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
clock_name: str | None
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None
class org.accellera.spirit.v1_4.ClockDriverType(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None)

Bases: object

Variables:

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

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

  • clock_pulse_value – Value of port after first clock edge.

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

Parameters:
class ClockPeriod(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseDuration(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseOffset(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None
class org.accellera.spirit.v1_4.Component(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, other_clock_drivers=None, description=None, parameters=None, 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, display_name=None, description=None, address_space_ref=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • parameters – Data specific to the cpu.

  • vendor_extensions

Parameters:
address_space_ref: Iterable[AddressSpaceRef]
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
class WhiteboxElements(whitebox_element=<factory>)

Bases: object

Variables:

whitebox_element – A whiteboxElement is a useful way to identify elements of a component that can not be identified through other means such as internal signals and non- software accessible registers.

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
cpus: 'ComponentType.Cpus' | None
description: str | None
file_sets: FileSets | None
library: str | None
memory_maps: MemoryMaps | None
model: Model | None
name: str | None
other_clock_drivers: OtherClocks | None
parameters: Parameters | None
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
whitebox_elements: 'ComponentType.WhiteboxElements' | None
class org.accellera.spirit.v1_4.ComponentGenerator(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False, group=<factory>, scope=InstanceGeneratorTypeScope.INSTANCE)

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:
api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
group: Iterable[str]
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
scope: InstanceGeneratorTypeScope
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.ComponentGenerators(component_generator=<factory>)

Bases: object

List of component generators.

Parameters:

component_generator (Iterable[ComponentGenerator])

component_generator: Iterable[ComponentGenerator]
class org.accellera.spirit.v1_4.ComponentInstance(instance_name=None, display_name=None, description=None, component_ref=None, configurable_element_values=None, vendor_extensions=None)

Bases: object

Component instance element.

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

Variables:

  • instance_name

  • display_name – Display name for the subcomponent instance.

  • description – String for describing this component instance to users

  • component_ref – References a component to be found in an external library. The four attributes define the VLNV of the referenced element.

  • configurable_element_values

  • vendor_extensions

Parameters:
component_ref: LibraryRefType | None
configurable_element_values: ConfigurableElementValues | None
description: str | None
display_name: str | None
instance_name: InstanceName | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.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_4.ComponentPortDirectionType(*values)

Bases: Enum

The direction of a component port.

IN = 'in'
INOUT = 'inout'
OUT = 'out'
PHANTOM = 'phantom'
class org.accellera.spirit.v1_4.ComponentType(vendor=None, library=None, name=None, version=None, bus_interfaces=None, channels=None, remap_states=None, address_spaces=None, memory_maps=None, model=None, component_generators=None, choices=None, file_sets=None, whitebox_elements=None, cpus=None, other_clock_drivers=None, description=None, parameters=None, vendor_extensions=None)

Bases: object

Component-specific extension to componentType.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • bus_interfaces

  • channels

  • remap_states

  • address_spaces

  • memory_maps

  • model

  • component_generators – Generator list is tools-specific.

  • choices

  • file_sets

  • whitebox_elements – A list of whiteboxElements

  • cpus – cpu’s in the component

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

  • description – String for describing the component to users

  • parameters

  • 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, display_name=None, description=None, address_space_ref=<factory>, parameters=None, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • parameters – Data specific to the cpu.

  • vendor_extensions

Parameters:
address_space_ref: Iterable[AddressSpaceRef]
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
cpu: Iterable[Cpu]
class WhiteboxElements(whitebox_element=<factory>)

Bases: object

Variables:

whitebox_element – A whiteboxElement is a useful way to identify elements of a component that can not be identified through other means such as internal signals and non- software accessible registers.

Parameters:

whitebox_element (Iterable[WhiteboxElementType])

whitebox_element: Iterable[WhiteboxElementType]
address_spaces: AddressSpaces | None
bus_interfaces: BusInterfaces | None
channels: Channels | None
choices: Choices | None
component_generators: ComponentGenerators | None
cpus: Cpus | None
description: str | None
file_sets: FileSets | None
library: str | None
memory_maps: MemoryMaps | None
model: Model | None
name: str | None
other_clock_drivers: OtherClocks | None
parameters: Parameters | None
remap_states: RemapStates | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
whitebox_elements: WhiteboxElements | None
class org.accellera.spirit.v1_4.ConfigurableElementValue(value='', reference_id=None)

Bases: object

Describes the content of a configurable element.

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

Variables:

  • value

  • reference_id – Refers to the ID attribute of the configurable element.

Parameters:

  • value (str)

  • reference_id (str | None)

reference_id: str | None
value: str
class org.accellera.spirit.v1_4.ConfigurableElementValues(configurable_element_value=<factory>)

Bases: object

All configuration information for a contained component, generator, generator chain or abstractor instance.

Variables:

configurable_element_value – Describes the content of a configurable element. The required referenceId attribute refers to the ID attribute of the configurable element.

Parameters:

configurable_element_value (Iterable[ConfigurableElementValue])

configurable_element_value: Iterable[ConfigurableElementValue]
class org.accellera.spirit.v1_4.ConstraintSet(name=None, display_name=None, description=None, vector=None, drive_constraint=None, load_constraint=None, timing_constraint=<factory>, constraint_set_id='default')

Bases: object

Defines constraints that apply to a component port.

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

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • vector – The optional element vector specify the bits of a vector for which the constraints apply. The vaules of left and right must be within the range of the port. If the vector is not specified then the constraints apply to all the bits of the port.

  • drive_constraint

  • load_constraint

  • timing_constraint

  • constraint_set_id

Parameters:
class Vector(left=None, right=None)

Bases: object

Variables:

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

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

Parameters:

  • left (int | None)

  • right (int | None)

left: int | None
right: int | None
constraint_set_id: str
description: str | None
display_name: str | None
drive_constraint: DriveConstraint | None
load_constraint: LoadConstraint | None
name: str | None
timing_constraint: Iterable[TimingConstraint]
vector: Vector | None
class org.accellera.spirit.v1_4.ConstraintSetRef(value='')

Bases: object

A reference to a set of port constraints.

Parameters:

value (str)

value: str
class org.accellera.spirit.v1_4.ConstraintSets(constraint_set=<factory>)

Bases: object

List of constraintSet elements for a component port.

Parameters:

constraint_set (Iterable[ConstraintSet])

constraint_set: Iterable[ConstraintSet]
class org.accellera.spirit.v1_4.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_4.DefaultValue(value='', format=FormatType.LONG, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt=None)

Bases: object

Default value for a wire port.

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class org.accellera.spirit.v1_4.DelayValueType(*values)

Bases: Enum

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

MAX = 'max'
MIN = 'min'
class org.accellera.spirit.v1_4.DelayValueUnitType(*values)

Bases: Enum

Indicates legal units for delay values.

NS = 'ns'
PS = 'ps'
class org.accellera.spirit.v1_4.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_4.Design(vendor=None, library=None, name=None, version=None, component_instances=None, interconnections=None, ad_hoc_connections=None, hier_connections=None, description=None, vendor_extensions=None)

Bases: object

Root element for a platform design.

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • component_instances

  • interconnections

  • ad_hoc_connections

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

  • description – String for describing the design to users

  • vendor_extensions

Parameters:
class HierConnections(hier_connection=<factory>)

Bases: object

Variables:

hier_connection – Represents a hierarchy connection

Parameters:

hier_connection (Iterable[HierConnection])

class HierConnection(active_interface=None, vendor_extensions=None, interface_ref=None)

Bases: object

Variables:

  • active_interface – Component and bus reference to export to the upper level component. The componentRef and busRef attributes indicate the instance name and bus interface name of the hierachical connection.

  • vendor_extensions

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

Parameters:
active_interface: Interface | None
interface_ref: str | None
vendor_extensions: VendorExtensions | None
hier_connection: Iterable[HierConnection]
ad_hoc_connections: AdHocConnections | None
component_instances: ComponentInstances | None
description: str | None
hier_connections: HierConnections | None
interconnections: Interconnections | None
library: str | None
name: str | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_4.DesignConfiguration(vendor=None, library=None, name=None, version=None, design_ref=None, generator_chain_configuration=<factory>, interconnection_configuration=<factory>, view_configuration=<factory>, description=None, vendor_extensions=None)

Bases: object

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

Does not describe instance parameterization

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • design_ref – The design to which this configuration applies

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

  • interconnection_configuration – Contains the information about the abstractors required to cross between two interfaces at with different abstractionDefs.

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

  • description – String for describing this design configuration to users

  • vendor_extensions

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

Bases: object

Variables:

  • generator_chain_ref – References a generatorChain.

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

Parameters:
class Generators(generator_name=None, configurable_element_values=None)

Bases: object

Variables:

  • generator_name – This identifies the generator in the chain.

  • configurable_element_values

Parameters:
configurable_element_values: ConfigurableElementValues | None
generator_name: str | None
generator_chain_ref: LibraryRefType | None
generators: Iterable[Generators]
class InterconnectionConfiguration(interconnection_ref=None, abstractors=None)

Bases: object

Variables:

  • interconnection_ref – Reference to the interconnection name or possibly an hierConnection interfaceName in a design file.

  • abstractors – List of abstractors for this interconnection

Parameters:

  • interconnection_ref (str | None)

  • abstractors (Abstractors | None)

class Abstractors(abstractor=<factory>)

Bases: object

Variables:

abstractor – Element to hold a the abstractor reference, the configuration and viewName. If multiple elements are present then the order is the order in which the abstractors should be chained together.

Parameters:

abstractor (Iterable[Abstractor])

class Abstractor(instance_name=None, display_name=None, description=None, abstractor_ref=None, configurable_element_values=None, view_name=None)

Bases: object

Variables:

  • instance_name – Instance name for the abstractor

  • display_name – Display name for the abstractor instance.

  • description – String for describing this abstractor instance to users

  • abstractor_ref – Abstractor reference

  • configurable_element_values

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

Parameters:

  • instance_name (str | None)

  • display_name (str | None)

  • description (str | None)

  • abstractor_ref (LibraryRefType | None)

  • configurable_element_values (ConfigurableElementValues | None)

  • view_name (str | None)

abstractor_ref: LibraryRefType | None
configurable_element_values: ConfigurableElementValues | None
description: str | None
display_name: str | None
instance_name: str | None
view_name: str | None
abstractor: Iterable[Abstractor]
abstractors: Abstractors | None
interconnection_ref: str | None
class ViewConfiguration(instance_name=None, view_name=None)

Bases: object

Variables:

  • instance_name

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

Parameters:

  • instance_name (InstanceName | None)

  • view_name (str | None)

instance_name: InstanceName | None
view_name: str | None
description: str | None
design_ref: LibraryRefType | None
generator_chain_configuration: Iterable[GeneratorChainConfiguration]
interconnection_configuration: Iterable[InterconnectionConfiguration]
library: str | None
name: str | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
view_configuration: Iterable[ViewConfiguration]
class org.accellera.spirit.v1_4.DriveConstraint(cell_specification=None)

Bases: object

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

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

Parameters:

cell_specification (CellSpecification | None)

cell_specification: CellSpecification | None
class org.accellera.spirit.v1_4.Driver(default_value=None, clock_driver=None, single_shot_driver=None)

Bases: DriverType

Wire port driver element.

Parameters:
clock_driver: ClockDriver | None
default_value: DefaultValue | None
single_shot_driver: SingleShotDriver | None
class org.accellera.spirit.v1_4.DriverType(default_value=None, clock_driver=None, single_shot_driver=None)

Bases: object

Wire port driver type.

Parameters:
clock_driver: ClockDriver | None
default_value: DefaultValue | None
single_shot_driver: SingleShotDriver | None
class org.accellera.spirit.v1_4.EdgeValueType(*values)

Bases: Enum

Indicates legal values for edge specification attributes.

FALL = 'fall'
RISE = 'rise'
class org.accellera.spirit.v1_4.EndianessType(*values)

Bases: Enum

‘big’: means the most significant element of any multi-element data field is stored at the lowest memory address.

‘little’ means the least significant element of any multi-element data field is stored at the lowest memory address. If this element is not present the default is ‘little’ endian.

BIG = 'big'
LITTLE = 'little'
class org.accellera.spirit.v1_4.ExecutableImage(name=None, description=None, parameters=None, 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.

  • description – String for describing this executable image to users

  • parameters – 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 – Unique ID for the executableImage, referenced in fileSet/function/fileRef

  • image_type – Open element to describe the type of image. The contents is model and/or generator specific.

Parameters:
class FileSetRefGroup(file_set_ref: collections.abc.Iterable[org.accellera.spirit.v1_4.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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Flags(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class ReplaceDefaultFlags(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class LinkerCommandFile(name=None, command_line_switch=None, enable=None, generator_ref=<factory>, vendor_extensions=None)

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.

  • generator_ref

  • vendor_extensions

Parameters:
class CommandLineSwitch(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Enable(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class Name(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
command_line_switch: CommandLineSwitch | None
enable: Enable | None
generator_ref: Iterable[GeneratorRef]
name: Name | None
vendor_extensions: VendorExtensions | None
class LinkerFlags(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
file_builder: Iterable[FileBuilder]
linker: Linker | None
linker_command_file: LinkerCommandFile | None
linker_flags: LinkerFlags | None
description: str | None
file_set_ref_group: FileSetRefGroup | None
id: str | None
image_type: str | None
language_tools: LanguageTools | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.FieldType(name=None, display_name=None, description=None, bit_offset=None, bit_width=None, access=None, values=<factory>, parameters=None, vendor_extensions=None)

Bases: object

A field within a register.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

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

  • bit_width – Width of the field in bits.

  • access

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

  • parameters

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • bit_offset (int | None)

  • bit_width (BitWidth | None)

  • access (Access | None)

  • values (Iterable[Values])

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

class BitWidth(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Values(value=None, name=None, description=None)

Bases: object

Variables:

  • value – Enumerated bit field value.

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

  • description – Description of a bit field value.

Parameters:

  • value (str | None)

  • name (str | None)

  • description (str | None)

description: str | None
name: str | None
value: str | None
access: Access | None
bit_offset: int | None
bit_width: BitWidth | None
description: str | None
display_name: str | None
name: str | None
parameters: Parameters | None
values: Iterable[Values]
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.File(name=None, file_type=<factory>, user_file_type=<factory>, is_include_file=None, logical_name=None, exported_name=<factory>, build_command=None, dependency=<factory>, define=<factory>, image_type=<factory>, description=None, vendor_extensions=None, file_id=None, any_attributes=<factory>)

Bases: object

SPIRIT reference to a file or directory.

Variables:

  • name – Path to the file or directory. If this path is a relative path, then it is relative to the containing XML file.

  • file_type – Enumerated file types known by SPIRIT.

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

  • is_include_file – Indicate that the file is include file.

  • 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 element gives the name to be defined and the text content of the spirit:value element holds the value. This element supports full configurability.

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

  • description – String for describing this file to users

  • vendor_extensions

  • file_id – Unique ID for this file, referenced in fileSet/function/fileRef

  • any_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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Flags(value='', append=None, format=FormatType.STRING, resolve=ResolveType.IMMEDIATE, id=None, dependency=None, any_attributes=<factory>, choice_ref=None, order=None, config_groups=<factory>, bit_string_length=None, minimum=None, maximum=None, range_type=RangeTypeType.FLOAT, prompt=None)

Bases: object

Variables:

  • value

  • append – “true” indicates that the flags shall be appended to any existing flags, “false”indicates these flags will replace any existing default flags.

  • format

  • resolve

  • id

  • dependency

  • any_attributes

  • choice_ref

  • order

  • config_groups

  • bit_string_length

  • minimum

  • maximum

  • range_type

  • prompt

Parameters:

  • value (str)

  • append (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
append: bool | None
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class ReplaceDefaultFlags(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class TargetName(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
command: Command | None
flags: Flags | None
replace_default_flags: ReplaceDefaultFlags | None
target_name: TargetName | None
class IsIncludeFile(value=None, external_declarations=False)

Bases: object

Variables:

  • value

  • external_declarations – the File contains some declarations that is needed in top file

Parameters:

  • value (bool | None)

  • external_declarations (bool)

external_declarations: bool
value: bool | None
class LogicalName(value='', default=False)

Bases: object

Variables:

  • value

  • default – The logical name shall only be used as a default and another process may override this name.

Parameters:

  • value (str)

  • default (bool)

default: bool
value: str
class Name(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
any_attributes: Mapping[str, str]
build_command: BuildCommand | None
define: Iterable[NameValuePairType]
dependency: Iterable[Dependency]
description: str | None
exported_name: Iterable[str]
file_id: str | None
file_type: Iterable[FileFileType]
image_type: Iterable[str]
is_include_file: IsIncludeFile | None
logical_name: LogicalName | None
name: Name | None
user_file_type: Iterable[str]
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.FileBuilderFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'
class org.accellera.spirit.v1_4.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: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class Flags(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.STRING: 'string'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
class ReplaceDefaultFlags(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
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_4.FileBuilderTypeFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'
class org.accellera.spirit.v1_4.FileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'
class org.accellera.spirit.v1_4.FileSet(name=None, display_name=None, description=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=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 Function(entry_point=None, file_ref=None, return_type=None, argument=<factory>, disabled=None, source_file=<factory>, replicate=False)

Bases: object

Variables:

  • entry_point – Optional name for the function.

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

  • return_type – Function return type. Possible values are void and int.

  • 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 element and its value is in the spirit:value element.

  • disabled – Specifies if the SW function is enabled. If not present the function is always enabled.

  • source_file – Location information for the source file of this function.

  • replicate – If true directs the generator to compile a separate object module for each instance of the component in the design. If false (default) the function will be called with different arguments for each instance.

Parameters:
class Argument(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>, data_type=None)

Bases: NameValuePairType

Variables:

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

  • data_type (DataTypeType | None)

any_attributes: Mapping[str, str]
data_type: DataTypeType | None
description: str | None
display_name: str | None
name: str | None
value: Value | None
vendor_extensions: VendorExtensions | None
class Disabled(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

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

  • file_type – Enumerated file types known by SPIRIT.

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

Parameters:

  • source_name (str | None)

  • file_type (SourceFileFileType | None)

  • user_file_type (str | None)

file_type: SourceFileFileType | None
source_name: str | None
user_file_type: str | None
argument: Iterable[Argument]
disabled: Disabled | None
entry_point: str | None
file_ref: str | None
replicate: bool
return_type: FunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
description: str | None
display_name: str | None
file: Iterable[File]
function: Iterable['FileSetType.Function']
group: Iterable[str]
name: str | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.FileSetRef(value='')

Bases: object

A reference to a fileSet.

Parameters:

value (str)

value: str
class org.accellera.spirit.v1_4.FileSetType(name=None, display_name=None, description=None, group=<factory>, file=<factory>, default_file_builder=<factory>, dependency=<factory>, function=<factory>, vendor_extensions=None)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • 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 – Default command and flags used to build derived files from the sourceName files in this file set.

  • dependency

  • function – Generator information if this file set describes a function. For example, this file set may describe diagnostics for which the DE can generate a diagnostics driver.

  • vendor_extensions

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • group (Iterable[str])

  • file (Iterable[File])

  • default_file_builder (Iterable[FileBuilderType])

  • dependency (Iterable[Dependency])

  • function (Iterable[Function])

  • vendor_extensions (VendorExtensions | None)

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

Bases: object

Variables:

  • entry_point – Optional name for the function.

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

  • return_type – Function return type. Possible values are void and int.

  • 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 element and its value is in the spirit:value element.

  • disabled – Specifies if the SW function is enabled. If not present the function is always enabled.

  • source_file – Location information for the source file of this function.

  • replicate – If true directs the generator to compile a separate object module for each instance of the component in the design. If false (default) the function will be called with different arguments for each instance.

Parameters:
class Argument(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>, data_type=None)

Bases: NameValuePairType

Variables:

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

  • data_type (DataTypeType | None)

any_attributes: Mapping[str, str]
data_type: DataTypeType | None
description: str | None
display_name: str | None
name: str | None
value: Value | None
vendor_extensions: VendorExtensions | None
class Disabled(value: Optional[bool] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.BOOL: 'bool'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.INT: 'int'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (bool | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: bool | None
class SourceFile(source_name=None, file_type=None, user_file_type=None)

Bases: object

Variables:

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

  • file_type – Enumerated file types known by SPIRIT.

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

Parameters:

  • source_name (str | None)

  • file_type (SourceFileFileType | None)

  • user_file_type (str | None)

file_type: SourceFileFileType | None
source_name: str | None
user_file_type: str | None
argument: Iterable[Argument]
disabled: Disabled | None
entry_point: str | None
file_ref: str | None
replicate: bool
return_type: FunctionReturnType | None
source_file: Iterable[SourceFile]
default_file_builder: Iterable[FileBuilderType]
dependency: Iterable[Dependency]
description: str | None
display_name: str | None
file: Iterable[File]
function: Iterable[Function]
group: Iterable[str]
name: str | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.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_4.FormatType(*values)

Bases: Enum

This is an indication on the formatof the value for user defined properties.

bitString means either a double quoted string of 1’s an 0’s or a spiritNumberFormat number. bool means a boolean (true, false) is expected. float means a decimal floating point number is expected. long means an value of spiritNumberFormat is expected. String means any text is acceptable.

BIT_STRING = 'bitString'
BOOL = 'bool'
FLOAT = 'float'
LONG = 'long'
STRING = 'string'
class org.accellera.spirit.v1_4.FunctionReturnType(*values)

Bases: Enum

INT = 'int'
VOID = 'void'
class org.accellera.spirit.v1_4.Generator(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False)

Bases: GeneratorType

Specifies a set of generators.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • phase (Phase | None)

  • parameters (Parameters | None)

  • api_type (GeneratorTypeApiType | None)

  • transport_methods (GeneratorType.TransportMethods | None)

  • generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

  • hidden (bool)

api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.GeneratorChain(vendor=None, library=None, name=None, version=None, generator_chain_selector=<factory>, component_generator_selector=<factory>, generator=<factory>, chain_group=<factory>, display_name=None, description=None, choices=None, vendor_extensions=None, hidden=False)

Bases: object

Variables:

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

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

  • name – The name of the object.

  • version – Indicates the version of the named element.

  • generator_chain_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 selected based on the selection criteria, DE will prompt the user to resolve to a single generator.

  • component_generator_selector – Selects generators declared in components 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.

  • display_name – Short description string, typically for user interface

  • description – Full description string, typically for documentation

  • choices

  • vendor_extensions

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

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

  • generator_chain_selector (Iterable[GeneratorChainSelector])

  • component_generator_selector (Iterable[GeneratorSelectorType])

  • generator (Iterable[Generator])

  • chain_group (Iterable[str])

  • display_name (str | None)

  • description (str | None)

  • choices (Choices | None)

  • vendor_extensions (VendorExtensions | None)

  • hidden (bool)

class GeneratorChainSelector(group_selector=None, generator_chain_ref=None, unique=False)

Bases: object

Variables:

  • group_selector

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

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

Parameters:
generator_chain_ref: LibraryRefType | None
group_selector: GroupSelector | None
unique: bool
chain_group: Iterable[str]
choices: Choices | None
component_generator_selector: Iterable[GeneratorSelectorType]
description: str | None
display_name: str | None
generator: Iterable[Generator]
generator_chain_selector: Iterable[GeneratorChainSelector]
hidden: bool
library: str | None
name: str | None
vendor: str | None
vendor_extensions: VendorExtensions | None
version: str | None
class org.accellera.spirit.v1_4.GeneratorRef(value='')

Bases: object

A reference to a generator element.

Parameters:

value (str)

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

Bases: object

Parameters:

group_selector (GroupSelector | None)

group_selector: GroupSelector | None
class org.accellera.spirit.v1_4.GeneratorType(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False)

Bases: object

Types of generators.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • phase

  • parameters

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

  • transport_methods

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

  • vendor_extensions

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

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • phase (Phase | None)

  • parameters (Parameters | None)

  • api_type (GeneratorTypeApiType | None)

  • transport_methods (TransportMethods | None)

  • generator_exe (str | None)

  • vendor_extensions (VendorExtensions | None)

  • hidden (bool)

api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
transport_methods: TransportMethods | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.GeneratorTypeApiType(*values)

Bases: Enum

NONE = 'none'
TGI = 'TGI'
class org.accellera.spirit.v1_4.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 – Specifies a generator group name or a generator chain group name to be selected for inclusion in the generator chain.

  • multiple_group_selection_operator – Specifies the OR or AND selection operator if there is more than one group name.

Parameters:
multiple_group_selection_operator: GroupSelectorMultipleGroupSelectionOperator
name: Iterable[str]
class org.accellera.spirit.v1_4.GroupSelectorMultipleGroupSelectionOperator(*values)

Bases: Enum

AND = 'and'
OR = 'or'
class org.accellera.spirit.v1_4.Initiative(value=None)

Bases: object

If this element is present, the type of access is restricted to the specified value.

Parameters:

value (InitiativeValue | None)

value: InitiativeValue | None
class org.accellera.spirit.v1_4.InitiativeValue(*values)

Bases: Enum

BOTH = 'both'
PHANTOM = 'phantom'
PROVIDES = 'provides'
REQUIRES = 'requires'
class org.accellera.spirit.v1_4.InstanceGeneratorType(name=None, display_name=None, description=None, phase=None, parameters=None, api_type=None, transport_methods=None, generator_exe=None, vendor_extensions=None, hidden=False, 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:
api_type: GeneratorTypeApiType | None
description: str | None
display_name: str | None
generator_exe: str | None
group: Iterable[str]
hidden: bool
name: str | None
parameters: Parameters | None
phase: Phase | None
scope: InstanceGeneratorTypeScope
transport_methods: 'GeneratorType.TransportMethods' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.InstanceGeneratorTypeScope(*values)

Bases: Enum

ENTITY = 'entity'
INSTANCE = 'instance'
class org.accellera.spirit.v1_4.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_4.Interconnection(name=None, display_name=None, description=None, active_interface=<factory>)

Bases: object

Describes a connection between two active (not monitor) busInterfaces.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • active_interface – Describes one interface of the interconnection. The componentRef and busRef attributes indicate the instance name and bus interface name of one end of the connection.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • active_interface (Iterable[Interface])

active_interface: Iterable[Interface]
description: str | None
display_name: str | None
name: str | None
class org.accellera.spirit.v1_4.Interconnections(interconnection=<factory>, monitor_interconnection=<factory>)

Bases: object

Connections between internal sub components.

Parameters:
interconnection: Iterable[Interconnection]
monitor_interconnection: Iterable[MonitorInterconnection]
class org.accellera.spirit.v1_4.Interface(component_ref=None, bus_ref=None)

Bases: object

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

Variables:

  • component_ref – Reference to a component instance name.

  • bus_ref – Reference to the components bus interface

Parameters:

  • component_ref (str | None)

  • bus_ref (str | None)

bus_ref: str | None
component_ref: str | None
class org.accellera.spirit.v1_4.LibraryRefType(vendor=None, library=None, name=None, version=None)

Bases: object

Base IP-XACT document reference type.

Contains vendor, library, name and version attributes.

Parameters:

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

library: str | None
name: str | None
vendor: str | None
version: str | None
class org.accellera.spirit.v1_4.LoadConstraint(cell_specification=None, count=None)

Bases: object

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

Variables:

  • cell_specification

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

Parameters:
cell_specification: CellSpecification | None
count: int | None
class org.accellera.spirit.v1_4.LocalMemoryMapType(name=None, display_name=None, description=None, 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:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • address_block

  • bank

  • subspace_map – Maps in an address subspace from across 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:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • address_block (Iterable[AddressBlock])

  • bank (Iterable[Bank])

  • subspace_map (Iterable[SubspaceRefType])

address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
description: str | None
display_name: str | None
name: str | None
subspace_map: Iterable[SubspaceRefType]
class org.accellera.spirit.v1_4.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_4.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_4.MemoryMapType(name=None, display_name=None, description=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 – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • address_block

  • bank

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

  • memory_remap

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • address_block (Iterable[AddressBlock])

  • bank (Iterable[Bank])

  • subspace_map (Iterable[SubspaceRefType])

  • memory_remap (Iterable[MemoryRemapType])

address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
description: str | None
display_name: str | None
memory_remap: Iterable[MemoryRemapType]
name: str | None
subspace_map: Iterable[SubspaceRefType]
class org.accellera.spirit.v1_4.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, display_name: Optional[str] = None, description: Optional[str] = None, address_block: collections.abc.Iterable[org.accellera.spirit.v1_4.address_block.AddressBlock] = <factory>, bank: collections.abc.Iterable[org.accellera.spirit.v1_4.bank.Bank] = <factory>, subspace_map: collections.abc.Iterable[org.accellera.spirit.v1_4.subspace_ref_type.SubspaceRefType] = <factory>, memory_remap: collections.abc.Iterable[org.accellera.spirit.v1_4.memory_remap_type.MemoryRemapType] = <factory>, address_unit_bits: Optional[org.accellera.spirit.v1_4.address_unit_bits.AddressUnitBits] = None)

Bases: MemoryMapType

Parameters:
address_block: Iterable[AddressBlock]
address_unit_bits: AddressUnitBits | None
bank: Iterable[Bank]
description: str | None
display_name: str | None
memory_remap: Iterable[MemoryRemapType]
name: str | None
subspace_map: Iterable[SubspaceRefType]
memory_map: Iterable[MemoryMap]
class org.accellera.spirit.v1_4.MemoryRemapType(name=None, display_name=None, description=None, 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:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • address_block

  • bank

  • subspace_map – Maps in an address subspace from across 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:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • address_block (Iterable[AddressBlock])

  • bank (Iterable[Bank])

  • subspace_map (Iterable[SubspaceRefType])

  • state (str | None)

address_block: Iterable[AddressBlock]
bank: Iterable[Bank]
description: str | None
display_name: str | None
name: str | None
state: str | None
subspace_map: Iterable[SubspaceRefType]
class org.accellera.spirit.v1_4.Model(views=None, ports=None, model_parameters=None)

Bases: ModelType

Model information.

Parameters:
class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

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

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]
class Ports(port: collections.abc.Iterable[org.accellera.spirit.v1_4.port.Port] = <factory>)

Bases: object

Parameters:

port (Iterable[Port])

port: Iterable[Port]
class Views(view=<factory>)

Bases: object

Variables:

view – Single view of a component

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
model_parameters: 'ModelType.ModelParameters' | None
ports: 'ModelType.Ports' | None
views: 'ModelType.Views' | None
class org.accellera.spirit.v1_4.ModelType(views=None, ports=None, model_parameters=None)

Bases: object

Model information.

Variables:

  • views – View container

  • ports – Port container

  • model_parameters – Model parameter name value pairs container

Parameters:
class ModelParameters(model_parameter=<factory>)

Bases: object

Variables:

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

Parameters:

model_parameter (Iterable[NameValueTypeType])

model_parameter: Iterable[NameValueTypeType]
class Ports(port: collections.abc.Iterable[org.accellera.spirit.v1_4.port.Port] = <factory>)

Bases: object

Parameters:

port (Iterable[Port])

port: Iterable[Port]
class Views(view=<factory>)

Bases: object

Variables:

view – Single view of a component

Parameters:

view (Iterable[ViewType])

view: Iterable[ViewType]
model_parameters: ModelParameters | None
ports: Ports | None
views: Views | None
class org.accellera.spirit.v1_4.MonitorInterconnection(name=None, display_name=None, description=None, active_interface=None, monitor_interface=<factory>)

Bases: object

Describes a connection from the interface of one component to any number of monitor interfaces in the design.

An active interface can be connected to unlimited number of monitor interfaces.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • active_interface – Describes an active interface of the design that all the monitors will be connected to. The componentRef and busRef attributes indicate the instance name and bus interface name.

  • monitor_interface – Describes a list of monitor interfaces that are connected to the single active interface. The componentRef and busRef attributes indicate the instance name and bus interface name.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • active_interface (Interface | None)

  • monitor_interface (Iterable[Interface])

active_interface: Interface | None
description: str | None
display_name: str | None
monitor_interface: Iterable[Interface]
name: str | None
class org.accellera.spirit.v1_4.MonitorInterfaceMode(*values)

Bases: Enum

MASTER = 'master'
MIRRORED_MASTER = 'mirroredMaster'
MIRRORED_SLAVE = 'mirroredSlave'
MIRRORED_SYSTEM = 'mirroredSystem'
SLAVE = 'slave'
SYSTEM = 'system'
class org.accellera.spirit.v1_4.NameValuePairType(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>)

Bases: object

Name and value type for use in resolvable elements.

Variables:

  • name – Unique name

  • display_name – Short description string, typically for user interface

  • description – Full description string, typically for documentation

  • value – The value of the parameter.

  • vendor_extensions

  • any_attributes

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]
description: str | None
display_name: str | None
name: str | None
value: Value | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.NameValueTypeType(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>, data_type=None, usage_type=NameValueTypeTypeUsageType.NONTYPED)

Bases: NameValuePairType

Name value pair with data type information.

Variables:

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

  • usage_type – Indicates the type of the model parameter. Legal values are defined in the attribute enumeration list. Default value is ‘nontyped’.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (NameValuePairType.Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

  • data_type (str | None)

  • usage_type (NameValueTypeTypeUsageType)

any_attributes: Mapping[str, str]
data_type: str | None
description: str | None
display_name: str | None
name: str | None
usage_type: NameValueTypeTypeUsageType
value: 'NameValuePairType.Value' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.NameValueTypeTypeUsageType(*values)

Bases: Enum

NONTYPED = 'nontyped'
TYPED = 'typed'
class org.accellera.spirit.v1_4.OnMasterDirection(*values)

Bases: Enum

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

Bases: Enum

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

Bases: Enum

IN = 'in'
INOUT = 'inout'
OUT = 'out'
class org.accellera.spirit.v1_4.OtherClockDriver(clock_period=None, clock_pulse_offset=None, clock_pulse_value=None, clock_pulse_duration=None, clock_name=None, clock_source=None)

Bases: ClockDriverType

Describes a clock not directly associated with an input port.

The clockSource attribute can be used on these clocks to indicate the actual clock source (e.g. an output port of a clock generator cell).

Variables:

  • clock_name – Indicates the name of the clock.

  • clock_source – Indicates the name of the actual clock source (e.g. an output pin of a clock generator cell).

Parameters:
class ClockPeriod(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseDuration(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseOffset(value: collections.abc.Iterable[float] = <factory>, units: org.accellera.spirit.v1_4.delay_value_unit_type.DelayValueUnitType = <DelayValueUnitType.NS: 'ns'>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • units (DelayValueUnitType)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
units: DelayValueUnitType
value: Iterable[float]
class ClockPulseValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
clock_name: str | None
clock_period: ClockPeriod | None
clock_pulse_duration: ClockPulseDuration | None
clock_pulse_offset: ClockPulseOffset | None
clock_pulse_value: ClockPulseValue | None
clock_source: str | None
class org.accellera.spirit.v1_4.OtherClocks(other_clock_driver=<factory>)

Bases: object

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

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

Parameters:

other_clock_driver (Iterable[OtherClockDriver])

other_clock_driver: Iterable[OtherClockDriver]
class org.accellera.spirit.v1_4.Parameter(name=None, display_name=None, description=None, value=None, vendor_extensions=None, any_attributes=<factory>)

Bases: NameValuePairType

A name value pair.

The name is specified by the name element. The value is in the text content of the value element. This value element supports all configurability attributes.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • value (NameValuePairType.Value | None)

  • vendor_extensions (VendorExtensions | None)

  • any_attributes (Mapping[str, str])

any_attributes: Mapping[str, str]
description: str | None
display_name: str | None
name: str | None
value: 'NameValuePairType.Value' | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.Parameters(parameter=<factory>)

Bases: object

A collection of parameters.

Parameters:

parameter (Iterable[Parameter])

parameter: Iterable[Parameter]
class org.accellera.spirit.v1_4.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_4.PhaseScopeType(*values)

Bases: Enum

GLOBAL = 'global'
LOCAL = 'local'
class org.accellera.spirit.v1_4.Port(name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: PortType

Describes port characteristics.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
vendor_extensions: VendorExtensions | None
wire: PortWireType | None
class org.accellera.spirit.v1_4.PortAccessHandle(value='')

Bases: object

If present, a netlister should use this string instead of the port name to access the port.

Parameters:

value (str)

value: str
class org.accellera.spirit.v1_4.PortAccessType(value=None)

Bases: object

If present, indicates how a netlister accesses a port or all the ports of a busInterface.

Parameters:

value (PortAccessTypeValue | None)

value: PortAccessTypeValue | None
class org.accellera.spirit.v1_4.PortAccessTypeValue(*values)

Bases: Enum

PTR = 'ptr'
REF = 'ref'
class org.accellera.spirit.v1_4.PortDeclarationType(name=None, display_name=None, description=None, wire=None, transactional=None)

Bases: object

Basic port declarations.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • wire – Defines a port whose type resolves to simple bits.

  • transactional – Defines a port that implements or uses a service that can be implemented with functions or methods.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
wire: PortWireType | None
class org.accellera.spirit.v1_4.PortTransactionalType(trans_type_def=None, service=None, access=None, connection=None, all_logical_initiatives_allowed=False)

Bases: object

Transactional port type.

Variables:

  • trans_type_def – Definition of the port type expressed in the default language for this port (i.e. SystemC or SystemV).

  • service – Describes the interface protocol.

  • access – port access mode

  • connection – Bounds number of legal connections.

  • all_logical_initiatives_allowed – True if logical ports with different initiatives from the physical port initiative may be mapped onto this port. Forbidden for phantom ports, which always allow logical ports with all initiatives value to be mapped onto the physical port. Also ignored for “both” ports, since any logical port may be mapped to a physical “both” port.

Parameters:
class Access(port_access_type: org.accellera.spirit.v1_4.port_access_type.PortAccessType | None = None, port_access_handle: org.accellera.spirit.v1_4.port_access_handle.PortAccessHandle | None = None)

Bases: object

Parameters:
port_access_handle: PortAccessHandle | None
port_access_type: PortAccessType | None
class Connection(max_connections=None, min_connections=None)

Bases: object

Variables:

  • max_connections – Indicates the maximum number of connections this port supports. If this element is not present or set to 0 it implies an unbounded number of allowed connections.

  • min_connections – Indicates the minimum number of connections this port supports. If this element is not present, the minimum number of allowed connections is 1.

Parameters:

  • max_connections (int | None)

  • min_connections (int | None)

max_connections: int | None
min_connections: int | None
class Service(initiative=None, service_type_defs=None, vendor_extensions=None)

Bases: object

Variables:

  • initiative – Defines how the port accesses this service.

  • service_type_defs – The group of service type definitions.

  • vendor_extensions

Parameters:
initiative: Initiative | None
service_type_defs: ServiceTypeDefs | None
vendor_extensions: VendorExtensions | None
access: Access | None
all_logical_initiatives_allowed: bool
connection: Connection | None
service: Service | None
trans_type_def: TransTypeDef | None
class org.accellera.spirit.v1_4.PortType(name=None, display_name=None, description=None, wire=None, transactional=None, vendor_extensions=None)

Bases: PortDeclarationType

A port description, giving a name and an access type for high level ports.

Parameters:
description: str | None
display_name: str | None
name: str | None
transactional: PortTransactionalType | None
vendor_extensions: VendorExtensions | None
wire: PortWireType | None
class org.accellera.spirit.v1_4.PortWireType(direction=None, vector=None, wire_type_defs=None, driver=None, constraint_sets=None, all_logical_directions_allowed=False)

Bases: object

Wire port type for a component.

Variables:

  • direction – The direction of a wire style port. The basic directions for a port are ‘in’ for input ports, ‘out’ for output port and ‘inout’ for bidirectional and tristate ports. A value of ‘phantom’ is also allowed and define a port that exist on the IP-XACT component but not on the HDL model.

  • vector – Specific left and right vector bounds. Signal width is max(left,right)-min(left,right)+1 When the bounds are not present, a scalar port is assumed.

  • wire_type_defs

  • driver

  • constraint_sets

  • all_logical_directions_allowed – True if logical ports with different directions from the physical port direction may be mapped onto this port. Forbidden for phantom ports, which always allow logical ports with all direction value to be mapped onto the physical port. Also ignored for inout ports, since any logical port maybe mapped to a physical inout port.

Parameters:
all_logical_directions_allowed: bool
constraint_sets: ConstraintSets | None
direction: ComponentPortDirectionType | None
driver: Driver | None
vector: Vector | None
wire_type_defs: WireTypeDefs | None
class org.accellera.spirit.v1_4.Presence(value=PresenceValue.OPTIONAL)

Bases: object

If this element is present, the existance of the port is controlled by the specified value.

valid values are ‘illegal’, ‘required’ and ‘optional’.

Parameters:

value (PresenceValue)

value: PresenceValue
class org.accellera.spirit.v1_4.PresenceValue(*values)

Bases: Enum

ILLEGAL = 'illegal'
OPTIONAL = 'optional'
REQUIRED = 'required'
class org.accellera.spirit.v1_4.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_4.RemapStates(remap_state=<factory>)

Bases: object

Contains a list of remap state names and associated port values.

Variables:

remap_state – Contains a list of ports 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(name=None, display_name=None, description=None, remap_port=<factory>)

Bases: object

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • remap_port – Contains the name and value of a port on the component, the value indicates the logic value which this port must take to effect the remapping. The portMapRef attribute stores the name of the port which takes that value.

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • remap_port (Iterable[RemapPort])

class RemapPort(value='', port_name_ref=None, port_index=None)

Bases: object

Variables:

  • value

  • port_name_ref – This attribute identifies a signal on the component which affects the component’s memory layout

  • port_index – Index for a vectored type port. Must be a number between left and right for the port.

Parameters:

  • value (str)

  • port_name_ref (str | None)

  • port_index (int | None)

port_index: int | None
port_name_ref: str | None
value: str
description: str | None
display_name: str | None
name: str | None
remap_port: Iterable[RemapPort]
remap_state: Iterable[RemapState]
class org.accellera.spirit.v1_4.RequiresDriver(value=False, driver_type=RequiresDriverDriverType.ANY)

Bases: object

Specifies if a port 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

Variables:

  • value

  • driver_type – Defines the type of driver that is required. The default is any type of driver. The 2 other options are a clock type driver or a singleshot type driver.

Parameters:
driver_type: RequiresDriverDriverType
value: bool
class org.accellera.spirit.v1_4.RequiresDriverDriverType(*values)

Bases: Enum

ANY = 'any'
CLOCK = 'clock'
SINGLE_SHOT = 'singleShot'
class org.accellera.spirit.v1_4.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. Dependent means the value depends on the value of other properties. A dependency expression must be supplied in the dependency attribute. Generated means the value will be provided by a generator.

Variables:

  • IMMEDIATE – Property value is included in the XML file. It cannot be configured.

  • USER – Property content can be modified through confiugration. Modifications will be saved with the design.

  • DEPENDENT – Property value is expressed as an XPath expression which may refer to other properties. The expression must appear in the dendency attribute.

  • GENERATED – Generators may modify this property. Modifications get saved with the design.

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

Bases: object

Resolved SPIRIT document reference type.

Contains vendor, library, name and version attributes and the URI of the referenced SPIRIT document

Parameters:

  • value (str)

  • vendor (str | None)

  • library (str | None)

  • name (str | None)

  • version (str | None)

library: str | None
name: str | None
value: str
vendor: str | None
version: str | None
class org.accellera.spirit.v1_4.ServiceType(initiative=ServiceTypeInitiative.REQUIRES, type_name=<factory>, vendor_extensions=None)

Bases: object

The service that this transactional port can provide or requires.

Variables:

  • initiative – If this element is present, the type of access is restricted to the specified value.

  • type_name – Defines the name of the transactional interface type.

  • vendor_extensions

Parameters:
class TypeName(value='', implicit=False)

Bases: object

Variables:

  • value

  • implicit – Defines that the typeName supplied for this service is implicit and a netlister should not declare this service in a language specific top-level netlist

Parameters:

  • value (str)

  • implicit (bool)

implicit: bool
value: str
initiative: ServiceTypeInitiative
type_name: Iterable[TypeName]
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.ServiceTypeDef(type_name=None, type_definition=<factory>, parameters=None)

Bases: object

Definition of a single service type defintion.

Variables:

  • type_name – The name of the service type. Can be any predefined type such as booean or integer or any user-defined type such as addr_type or data_type.

  • type_definition – Where the definition of the type is contained if the type if not part of the language. For SystemC and SystemVerilog it is the include file containing the type definition.

  • parameters – list service parameters (e.g. parameters for a systemVerilog interface)

Parameters:

  • type_name (TypeName | None)

  • type_definition (Iterable[str])

  • parameters (Parameters | None)

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

Bases: object

Parameters:

parameter (Iterable[Parameter])

parameter: Iterable[Parameter]
class TypeName(value='', constrained=False, implicit=False)

Bases: object

Variables:

  • value

  • constrained – Defines that the type for the port has constrainted the number of bits in the vector

  • implicit – Defines that the typeName supplied for this service is implicit and a netlister should not declare this service in a language specific top-level netlist

Parameters:

  • value (str)

  • constrained (bool)

  • implicit (bool)

constrained: bool
implicit: bool
value: str
parameters: Parameters | None
type_definition: Iterable[str]
type_name: TypeName | None
class org.accellera.spirit.v1_4.ServiceTypeDefs(service_type_def=<factory>)

Bases: object

The group of type definitions.

If no match to a viewName is found then the default language types are to be used. See the User Guide for these default types.

Parameters:

service_type_def (Iterable[ServiceTypeDef])

service_type_def: Iterable[ServiceTypeDef]
class org.accellera.spirit.v1_4.ServiceTypeInitiative(*values)

Bases: Enum

BOTH = 'both'
PROVIDES = 'provides'
REQUIRES = 'requires'
class org.accellera.spirit.v1_4.SingleShotDriver(single_shot_offset=None, single_shot_value=None, single_shot_duration=None)

Bases: object

Describes a driven one-shot port.

Variables:

  • single_shot_offset – Time in nanoseconds until start of one- shot.

  • single_shot_value – Value of port after first edge of one- shot.

  • single_shot_duration – Duration in nanoseconds of the one shot.

Parameters:
class SingleShotDuration(value: collections.abc.Iterable[float] = <factory>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: Iterable[float]
class SingleShotOffset(value: collections.abc.Iterable[float] = <factory>, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.FLOAT: 'float'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (Iterable[float])

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: Iterable[float]
class SingleShotValue(value: str = '', format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (str)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: str
single_shot_duration: SingleShotDuration | None
single_shot_offset: SingleShotOffset | None
single_shot_value: SingleShotValue | None
class org.accellera.spirit.v1_4.SourceFileFileType(*values)

Bases: Enum

ASM_SOURCE = 'asmSource'
CPP_SOURCE = 'cppSource'
C_SOURCE = 'cSource'
EXECUTABLE_HDL = 'executableHdl'
E_SOURCE = 'eSource'
OVASOURCE = 'OVASource'
PERL_SOURCE = 'perlSource'
PSL_SOURCE = 'pslSource'
SDC = 'SDC'
SVASOURCE = 'SVASource'
SW_OBJECT = 'swObject'
SW_OBJECT_LIBRARY = 'swObjectLibrary'
SYSTEM_CSOURCE = 'systemCSource'
SYSTEM_CSOURCE_2_0 = 'systemCSource-2.0'
SYSTEM_CSOURCE_2_0_1 = 'systemCSource-2.0.1'
SYSTEM_CSOURCE_2_1 = 'systemCSource-2.1'
SYSTEM_VERILOG_SOURCE = 'systemVerilogSource'
SYSTEM_VERILOG_SOURCE_3_0 = 'systemVerilogSource-3.0'
SYSTEM_VERILOG_SOURCE_3_1 = 'systemVerilogSource-3.1'
SYSTEM_VERILOG_SOURCE_3_1A = 'systemVerilogSource-3.1a'
TCL_SOURCE = 'tclSource'
UNELABORATED_HDL = 'unelaboratedHdl'
UNKNOWN = 'unknown'
VERA_SOURCE = 'veraSource'
VERILOG_BINARY_LIBRARY = 'verilogBinaryLibrary'
VERILOG_SOURCE = 'verilogSource'
VERILOG_SOURCE_2001 = 'verilogSource-2001'
VERILOG_SOURCE_95 = 'verilogSource-95'
VHDL_BINARY_LIBRARY = 'vhdlBinaryLibrary'
VHDL_SOURCE = 'vhdlSource'
VHDL_SOURCE_87 = 'vhdlSource-87'
VHDL_SOURCE_93 = 'vhdlSource-93'
class org.accellera.spirit.v1_4.SubspaceRefType(name=None, display_name=None, description=None, base_address=None, parameters=None, vendor_extensions=None, master_ref=None)

Bases: object

Address subspace type.

Its subspaceReference attribute references the subspace from which the dimensions are taken.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • base_address

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

  • vendor_extensions

  • master_ref

Parameters:

  • name (str | None)

  • display_name (str | None)

  • description (str | None)

  • base_address (BaseAddress | None)

  • parameters (Parameters | None)

  • vendor_extensions (VendorExtensions | None)

  • master_ref (str | None)

base_address: BaseAddress | None
description: str | None
display_name: str | None
master_ref: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
class org.accellera.spirit.v1_4.TimingConstraint(value=None, clock_edge=EdgeValueType.RISE, delay_type=None, clock_name=None)

Bases: object

Defines a timing constraint for the associated port.

The constraint is relative to the clock specified by the clockName attribute. The clockEdge indicates which clock edge the constraint is associated with (default is rising edge). The delayType attribute can be specified to further refine the constraint.

Variables:

  • value

  • clock_edge

  • delay_type

  • clock_name – Indicates the name of the clock to which this constraint applies.

Parameters:
clock_edge: EdgeValueType
clock_name: str | None
delay_type: DelayValueType | None
value: float | None
class org.accellera.spirit.v1_4.TransTypeDef(type_name=None, type_definition=<factory>)

Bases: object

Definition of a single transactional type defintion.

Variables:

  • type_name – The name of the port type. Can be any predefined type such sc_port or sc_export in SystemC or any user-defined type such as tlm_port.

  • type_definition – Where the definition of the type is contained. For SystemC and SystemVerilog it is the include file containing the type definition.

Parameters:

  • type_name (TypeName | None)

  • type_definition (Iterable[str])

class TypeName(value='', constrained=False)

Bases: object

Variables:

  • value

  • constrained – Defines that the type for the port has constrainted the number of bits in the vector

Parameters:

  • value (str)

  • constrained (bool)

constrained: bool
value: str
type_definition: Iterable[str]
type_name: TypeName | None
class org.accellera.spirit.v1_4.TransportMethodsTransportMethod(*values)

Bases: Enum

FILE = 'file'
class org.accellera.spirit.v1_4.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_4.Vector(left=None, right=None)

Bases: object

Definition of the indecies for a vectored port.

Variables:

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

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

Parameters:
class Left(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
class Right(value: Optional[int] = None, format: org.accellera.spirit.v1_4.format_type.FormatType = <FormatType.LONG: 'long'>, resolve: org.accellera.spirit.v1_4.resolve_type.ResolveType = <ResolveType.IMMEDIATE: 'immediate'>, id: Optional[str] = None, dependency: Optional[str] = None, any_attributes: collections.abc.Mapping[str, str] = <factory>, choice_ref: Optional[str] = None, order: Optional[float] = None, config_groups: collections.abc.Iterable[str] = <factory>, bit_string_length: Optional[int] = None, minimum: Optional[str] = None, maximum: Optional[str] = None, range_type: org.accellera.spirit.v1_4.range_type_type.RangeTypeType = <RangeTypeType.FLOAT: 'float'>, prompt: Optional[str] = None)

Bases: object

Parameters:

  • value (int | None)

  • format (FormatType)

  • resolve (ResolveType)

  • id (str | None)

  • dependency (str | None)

  • any_attributes (Mapping[str, str])

  • choice_ref (str | None)

  • order (float | None)

  • config_groups (Iterable[str])

  • bit_string_length (int | None)

  • minimum (str | None)

  • maximum (str | None)

  • range_type (RangeTypeType)

  • prompt (str | None)

any_attributes: Mapping[str, str]
bit_string_length: int | None
choice_ref: str | None
config_groups: Iterable[str]
dependency: str | None
format: FormatType
id: str | None
maximum: str | None
minimum: str | None
order: float | None
prompt: str | None
range_type: RangeTypeType
resolve: ResolveType
value: int | None
left: Left | None
right: Right | None
class org.accellera.spirit.v1_4.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_4.ViewType(name=None, display_name=None, description=None, env_identifier=<factory>, hierarchy_ref=None, language=None, model_name=None, default_file_builder=<factory>, file_set_ref=<factory>, constraint_set_ref=<factory>, whitebox_element_refs=None, parameters=None, vendor_extensions=None)

Bases: object

Component view type.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • env_identifier – Defines the hardware environment in which this view applies. The format of the string is language:tool:vendor_extension, with each piece being optional. The language must be one of the types from spirit:fileType. The tool values are defined by the SPIRIT Consortium, and include generic values “*Simulation” and “*Synthesis” to imply any tool of the indicated type. Having more than one envIdentifier indicates that the view applies to multiple environments.

  • hierarchy_ref – References a SPIRIT design or configuration document (by VLNV) that provides a design for the component

  • language – The hardware description language used such as “verilog” or “vhdl”. If the attribute “strict” is “true”, this value must match the language being generated for the design.

  • model_name – Language specific name to identity the model. Verilog or SystemVerilog this is the module name. For VHDL this is, with ()’s, the entity(architecture) name pair or without, a single configuration name. For SystemC this is the class name.

  • default_file_builder – Default command and flags used to build derived files from the sourceName files in the referenced file sets.

  • file_set_ref

  • constraint_set_ref

  • whitebox_element_refs – Container for white box element references.

  • parameters

  • vendor_extensions

Parameters:
class Language(value='', strict=False)

Bases: object

Variables:

  • value

  • strict – A value of ‘true’ indicates that this value must match the language being generated for the design.

Parameters:

  • value (str)

  • strict (bool)

strict: bool
value: str
class WhiteboxElementRefs(whitebox_element_ref=<factory>)

Bases: object

Variables:

whitebox_element_ref – Reference to a white box element which is visible within this view.

Parameters:

whitebox_element_ref (Iterable[WhiteboxElementRefType])

whitebox_element_ref: Iterable[WhiteboxElementRefType]
constraint_set_ref: Iterable[ConstraintSetRef]
default_file_builder: Iterable[FileBuilderType]
description: str | None
display_name: str | None
env_identifier: Iterable[str]
file_set_ref: Iterable[FileSetRef]
hierarchy_ref: LibraryRefType | None
language: Language | None
model_name: str | None
name: str | None
parameters: Parameters | None
vendor_extensions: VendorExtensions | None
whitebox_element_refs: WhiteboxElementRefs | None
class org.accellera.spirit.v1_4.Volatile(value=False)

Bases: object

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

Parameters:

value (bool)

value: bool
class org.accellera.spirit.v1_4.WhiteboxElementRefType(whitebox_path=<factory>, name=None)

Bases: object

Reference to a whiteboxElement within a view.

The ‘name’ attribute must refer to a whiteboxElement defined within this component.

Variables:

  • whitebox_path – The whiteboxPath elements (as a set) define the name(s) needed to define the entire white box element in this view.

  • name – Reference to a whiteboxElement defined within this component.

Parameters:
class WhiteboxPath(path_name=None, left=None, right=None)

Bases: object

Variables:

  • path_name – The view specific name for a portion of the white box element.

  • left – Indicates the left bound value for the associated path name.

  • right – Indicates the right bound values for the associated path name.

Parameters:

  • path_name (str | None)

  • left (int | None)

  • right (int | None)

left: int | None
path_name: str | None
right: int | None
name: str | None
whitebox_path: Iterable[WhiteboxPath]
class org.accellera.spirit.v1_4.WhiteboxElementType(name=None, display_name=None, description=None, whitebox_type=None, driveable=None, register_ref=None, parameters=None, vendor_extensions=None)

Bases: object

Defines a white box reference point within the component.

Variables:

  • name – Unique name

  • display_name – Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name.

  • description – Full description string, typically for documentation

  • whitebox_type – Indicates the type of the element. The pin and signal types refer to elements within the HDL description. The register type refers to a register in the memory map. The interface type refers to a bus interface in a lower level component definition.

  • driveable – If true, indicates that the white box element can be driven (e.g. have a new value forced into it).

  • register_ref – Indicates the name of the register associated with this white box element. The name should be a full hierarchical path from the memory map to the register, using ‘/’ as a hierarchy separator. When specified, the whiteboxType must be ‘register’.

  • parameters

  • vendor_extensions

Parameters:
description: str | None
display_name: str | None
driveable: bool | None
name: str | None
parameters: Parameters | None
register_ref: str | None
vendor_extensions: VendorExtensions | None
whitebox_type: WhiteboxElementTypeWhiteboxType | None
class org.accellera.spirit.v1_4.WhiteboxElementTypeWhiteboxType(*values)

Bases: Enum

INTERFACE = 'interface'
PIN = 'pin'
REGISTER = 'register'
SIGNAL = 'signal'
class org.accellera.spirit.v1_4.WireTypeDef(type_name=None, type_definition=<factory>, view_name_ref=<factory>)

Bases: object

Definition of a single wire type defintion that can relate to multiple views.

Variables:

  • type_name – The name of the logic type. Examples could be std_logic, std_ulogic, std_logic_vector, sc_logic, …

  • type_definition – Where the definition of the type is contained. For std_logic, this is contained in IEEE.std_logic_1164.all. For sc_logic, this is contained in systemc.h. For VHDL this is the library and package as defined by the “used” statement. For SystemC and SystemVerilog it is the include file required. For verilog this is not needed.

  • view_name_ref – A reference to a view name in the file for which this type applies.

Parameters:

  • type_name (TypeName | None)

  • type_definition (Iterable[str])

  • view_name_ref (Iterable[str])

class TypeName(value='', constrained=False)

Bases: object

Variables:

  • value

  • constrained – Defines that the type for the port has constrainted the number of bits in the vector

Parameters:

  • value (str)

  • constrained (bool)

constrained: bool
value: str
type_definition: Iterable[str]
type_name: TypeName | None
view_name_ref: Iterable[str]
class org.accellera.spirit.v1_4.WireTypeDefs(wire_type_def=<factory>)

Bases: object

The group of wire type definitions.

If no match to a viewName is found then the default language types are to be used. See the User Guide for these default types.

Parameters:

wire_type_def (Iterable[WireTypeDef])

wire_type_def: Iterable[WireTypeDef]