From af5d1b1c1aaf220abe41dd3486b8933fa9261530 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Sun, 20 Aug 2023 00:02:00 +0200 Subject: [PATCH 1/2] Added IP-XACT 1.5 schema files. --- ipxact-1.5/README.md | 3 + ipxact-1.5/TGI/TGI.html | 4894 +++++++++++ ipxact-1.5/TGI/TGI.wsdl | 11320 +++++++++++++++++++++++++ ipxact-1.5/TGI/TGI.xml | 2723 ++++++ ipxact-1.5/TGI/TGI.xsd | 154 + ipxact-1.5/abstractionDefinition.xsd | 364 + ipxact-1.5/abstractor.xsd | 188 + ipxact-1.5/autoConfigure.xsd | 258 + ipxact-1.5/busDefinition.xsd | 131 + ipxact-1.5/busInterface.xsd | 671 ++ ipxact-1.5/commonStructures.xsd | 221 + ipxact-1.5/component.xsd | 285 + ipxact-1.5/configurable.xsd | 114 + ipxact-1.5/constraints.xsd | 315 + ipxact-1.5/design.xsd | 137 + ipxact-1.5/designConfig.xsd | 176 + ipxact-1.5/file.xsd | 592 ++ ipxact-1.5/fileType.xsd | 118 + ipxact-1.5/generator.xsd | 272 + ipxact-1.5/identifier.xsd | 125 + ipxact-1.5/index.xsd | 99 + ipxact-1.5/memoryMap.xsd | 1039 +++ ipxact-1.5/model.xsd | 323 + ipxact-1.5/port.xsd | 473 ++ ipxact-1.5/signalDrivers.xsd | 252 + ipxact-1.5/simpleTypes.xsd | 122 + ipxact-1.5/subInstances.xsd | 288 + 27 files changed, 25657 insertions(+) create mode 100644 ipxact-1.5/README.md create mode 100644 ipxact-1.5/TGI/TGI.html create mode 100644 ipxact-1.5/TGI/TGI.wsdl create mode 100644 ipxact-1.5/TGI/TGI.xml create mode 100644 ipxact-1.5/TGI/TGI.xsd create mode 100644 ipxact-1.5/abstractionDefinition.xsd create mode 100644 ipxact-1.5/abstractor.xsd create mode 100644 ipxact-1.5/autoConfigure.xsd create mode 100644 ipxact-1.5/busDefinition.xsd create mode 100644 ipxact-1.5/busInterface.xsd create mode 100644 ipxact-1.5/commonStructures.xsd create mode 100644 ipxact-1.5/component.xsd create mode 100644 ipxact-1.5/configurable.xsd create mode 100644 ipxact-1.5/constraints.xsd create mode 100644 ipxact-1.5/design.xsd create mode 100644 ipxact-1.5/designConfig.xsd create mode 100644 ipxact-1.5/file.xsd create mode 100644 ipxact-1.5/fileType.xsd create mode 100644 ipxact-1.5/generator.xsd create mode 100644 ipxact-1.5/identifier.xsd create mode 100644 ipxact-1.5/index.xsd create mode 100644 ipxact-1.5/memoryMap.xsd create mode 100644 ipxact-1.5/model.xsd create mode 100644 ipxact-1.5/port.xsd create mode 100644 ipxact-1.5/signalDrivers.xsd create mode 100644 ipxact-1.5/simpleTypes.xsd create mode 100644 ipxact-1.5/subInstances.xsd diff --git a/ipxact-1.5/README.md b/ipxact-1.5/README.md new file mode 100644 index 0000000..9c2441c --- /dev/null +++ b/ipxact-1.5/README.md @@ -0,0 +1,3 @@ +© Copyright Accellera Systems Initiative. All rights reserved. + +Source: http://www.accellera.org/XMLSchema/SPIRIT/1.5/ diff --git a/ipxact-1.5/TGI/TGI.html b/ipxact-1.5/TGI/TGI.html new file mode 100644 index 0000000..eeda291 --- /dev/null +++ b/ipxact-1.5/TGI/TGI.html @@ -0,0 +1,4894 @@ + + + + + +TGI API Documentation + + + + +

TGI API Documentation

+
Generated on Thu May 21 14:00:14 CDT 2009
+

Category Index

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Abstraction Definition OperationsAbstractor Instance OperationsAbstractor Operations
Address Map OperationsBus Definition OperationsBus Interface Operations
Component Instance OperationsComponent OperationsConstraint Operations
Design OperationsField OperationsFile and Fileset Operations
Generator OperationsInterface OperationsMiscellaneous Operations
Port OperationsRegister File OperationsRegister Operations
Remap OperationsService OperationsTypeDef Operations
View OperationsWhitebox OperationsAll ID Types
+

+

Abstraction Definition Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getAbstractionDefIDID for the abstraction definition with the given VLNV 
getAbstractionDefVLNVVendor Library Name Version of the abstraction definition 
getAbstractionDefBusTypeVLNVGet VLNV of the bus definition 
getAbstractionDefExtendsVendor Library Name Version of the abstraction definition being extendedNew in 1.5
getAbstractionDefPortIDsList of abstraction definition port element IDs 
getAbstractionDefPortLogicalNameLogical name of this abstraction definition port 
getAbstractionDefPortRequiresDriverDoes this port require a driver 
getAbstractionDefPortRequiredDriverTypeRequired driver type for this port 
getAbstractionDefPortStyleReturns 'wire' or 'transactional' to indicate the port style 
getAbstractionDefPortIsAddressIs this port an address port 
getAbstractionDefPortIsDataIs this port a data port 
getAbstractionDefPortIsClockIs this port a clock port 
getAbstractionDefPortIsResetIs this port a reset port 
getAbstractionDefPortModeIDReturns an ID for accessing the given port in the given interface modeInvalid in 1.5
getAbstractionDefPortModeIDsReturns an array of IDs for accessing the given port in the given interface mode. The array shall only contain one element if the modeValue input is master or slave. The array may contain multiple elements for modeValue system.New in 1.5
getAbstractionDefPortModeGroupGroup name when present on a system interface 
getAbstractionDefPortModeBitWidthBit width constraint when present on an interface of the given type 
getAbstractionDefPortModeDirectionPort direction constraint when present on an interface of the given type 
getAbstractionDefPortNonMirroredConstraintIDsList of constraint IDs for a non-mirrored port 
getAbstractionDefPortMirroredConstraintIDsList of constraint IDs for a mirrored port 
getAbstractionDefPortDriveConstraintIDsList of drive constraint IDs of the port 
getAbstractionDefPortLoadConstraintIDsList of load constraint IDs of the port 
getAbstractionDefPortTimingConstraintIDsList of timing constraint IDs of the port 
getAbstractionDefPortDefaultValueDefault value for port when not connected 
getAbstractionDefPortModePresenceExistence requirement for this port on an interface of the given type 
getAbstractionDefPortModeServiceIDsAbstractionDef service IDs on a transactional portInvalid in 1.5
getAbstractionDefPortModeServiceIDAbstractionDef service ID on a transactional portNew in 1.5
+

+

Abstractor Instance Operations

+ + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getAbstractorInstanceNameInstance name of the abstractor 
getAbstractorInstanceVLNVVendor Library Name Version of the abstractor (from the design file) 
getAbstractorInstanceAbstractorIDID for the abstractor associated with given instance (crossing from design configuration to abstractor file) 
getAbstractorInstanceXMLReturn the abstractor XML in text format. Schema version is DE dependent. 
+

+

Abstractor Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getAbstractorAbstractorModeGet the mode that the abstractor can be master, slave, direct or system. 
getAbstractorBusTypeVLNVList of VLNV of the bus definition 
getAbstractorAbstractorInterfaceIDsList of 2 interface IDs 
getAbstractorViewIDsA list of model view IDsModified in 1.5
getAbstractorPortIDsA list of abstractor model port IDs 
getAbstractorModelParameterIDsA list of model parameter IDs 
getAbstractorGeneratorIDsList of generator IDs of the abstractor 
getAbstractorChoiceIDsList of choices IDs 
getAbstractorFileSetIDsList of file set IDs 
+

+

Address Map Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getAddressSpaceRangeThe address range of an address block expressed as the number of accessable and addressable units., Configurable 
getAddressSpaceWidthThe bit width of an address block., Configurable 
getAddressSpaceLocalMemoryMapIDThe ID for the local memory map of the address space.New in 1.5
getAddressSpaceSegmentIDsList of IDs for address block segments for the address space.New in 1.5
getSegmentAddressOffsetThe address offset of an address space segment in an address space, ConfigurableNew in 1.5
setSegmentAddressOffsetSet the address offset of an address space segment expressed in the number addressable units.New in 1.5
getSegmentRangeThe address range of an address space segment expressed as the number of accessable addressable units., ConfigurableNew in 1.5
setSegmentRangeSet the address range of an address space segment expressed as the number of accessable addressable units.New in 1.5
getAddressSpaceAddressUnitBitsThe number bits in an addressable unit. If none exists, the default 8 bits is returned. 
getExecutableImageIDsThe IDs of the executable images belonging to the specified address space. 
getExecutableImageTypeThe type of the executable image if existent. 
getExecutableImageLinkerCommandThe linker command for the current executable image., Configurable 
getExecutableImageLinkerFlagsThe flags of the current executable image linker command., Configurable 
getExecutableImageLinkerCommandFileIDElement ID of linkerCommandFile associated with given executable image. 
getExecutableImageFileBuilderIDsList of default file builder IDs of the executable image 
getExecutableImageFileSetIDsThe group of file set reference IDs complying with the tool set of the current executable image. 
getLinkerCommandFileNameThe name of the linker command file., Configurable 
getLinkerCommandFileLineSwitchThe command line switch to specify with the linker command file., Configurable 
getLinkerCommandFileEnableIndicates whether or not to generate and enable the linker command file., Configurable 
getLinkerCommandGeneratorIDsReference IDs to the generator elements for generating the linker command file. 
getMemoryMapElementIDsList of element IDs (addressBlockID, bankID, subspaceMapID) within a memory map, memory remap, local memory map, or bankModified in 1.5
getMemoryMapElementTypeIndicates type of memory map element: addressBlock, bank or subspaceMap 
getMemoryMapAddressUnitBitsThe number bits in an addressable unit for a memory map. If none exists, the default 8 bits is returned. 
getAddressBlockBaseAddressThe base address of an address block, Configurable 
getAddressBlockRangeThe address range of an address block expressed as the number of accessable and addressable units., Configurable 
getAddressBlockWidthThe bit width of an address block in the local memory map., Configurable 
getAddressBlockUsageIndicates the usage of this address block. 
getAddressBlockVolatilityIndicates whether or not the data is volatile. 
getAddressBlockAccessThe accessibility of the data in the local address block. 
getAddressBlockRegisterIDsThe IDs of the available registers in the address block. 
getAddressBlockRegisterFileIDsThe IDs of the available register files in the address block.New in 1.5
getTypeIdentifierIndicates the type identifier of an addressBlock, registerFile, register or field.New in 1.5
getBankAlignmentThe bank alignment value, serial or parallel 
getBankBaseAddressThe base address of an address bank, Configurable 
getBankUsageIndicates the usage of this address bank. 
getBankVolatilityIndicates whether or not the data is volatile. 
getBankAccessThe accessibility of the data in the local address bank. 
getSubspaceMapMasterIDMaster bus interface ID on the other side of a bus bridge . 
getSubspaceMapSegmentIDAddress space segment ID on the other side of a bus bridge .New in 1.5
getSubspaceMapBaseAddressThe base address of a memory subspace, Configurable 
getMemoryMapRemapElementIDsList of IDs for memory map 'remap' elements of the given memory map 
getMemoryRemapStateIDRemap State ID for which this remap is applicable 
setAddressSpaceRangeSet the address range of an address block expressed as the number of accessable and addressable units. 
setAddressSpaceWidthSet the bit width of an address block. 
setExecutableImageLinkerCommandSet the linker command for the current executable image. 
setExecutableImageLinkerFlagsSet the flags of the current executable image linker command. 
setLinkerCommandFileNameSet the name of the linker command file. 
setLinkerCommandFileLineSwitchSet the command line switch to specify with the linker command file. 
setLinkerCommandFileEnableSet whether or not to generate and enable the linker command file. 
setAddressBlockBaseAddressSet the base address of an address block 
setAddressBlockRangeSet the address range of an address block expressed as the number of accessable and addressable units. 
setAddressBlockWidthSet the bit width of an address block 
setBankBaseAddressSet the base address of an address bank 
setSubspaceMapBaseAddressSet the base address of a memory subspace 
+

+

Bus Definition Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getBusDefinitionIDID for the bus definition with the given VLNV 
getBusDefinitionVLNVVendor Library Name Version of the bus definition 
getBusDefinitionDirectConnectionIndicates whether or not the bus definition supports direct connections 
getBusDefinitionIsAddressableIndicates whether or not the bus definition is an addressable bus 
getBusDefinitionExtendsVendor Library Name Version of the bus definition being extended 
getBusDefinitionMaxMastersMaximum # of masters supported by this bus definition 
getBusDefinitionMaxSlavesMaximum # of slaves supported by this bus definition 
getBusDefinitionSystemGroupNamesList of system group names for this bus definition 
+

+

Bus Interface Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getBusInterfaceMasterAddressSpaceIDID of the master addressSpace 
getBusInterfaceMasterBaseAddressBase address of the master addressSpace, Configurable 
getBusInterfaceSlaveMemoryMapIDID of the memoryMap referenced from a slave interface 
getBusInterfaceSlaveBridgeIDsList of slave bridge IDs 
getBridgeMasterIDThe slave interface master interface reference ID 
getBridgeIsOpaqueValue of the opaque attribute 
getBusInterfaceSlaveFileSetGroupIDsList of fileSetGroup IDs 
getBusInterfaceGroupNameGroup name of a system, mirroredSystem, or monitor bus interface 
getBusInterfaceMirroredSlaveRemapAddressIDsList of remap address IDs of the mirrored slave interface 
getRemapAddressValueRemap address of the given remap address element 
getRemapAddressRemapStateIDRemap state ID of the given remap address element 
getBusInterfaceMirroredSlaveRangeThe address range of the mirrored slave interface 
getBusInterfaceMonitorInterfaceModeIndicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave 
getBusInterfaceConnectionRequiredConnection required for this bus interface 
getBusInterfaceBitSteeringBit steering description of the bus interface: on or off, Configurable 
getBusInterfaceEndiannessThe endianess of the bus interface, big or little. The default is little. 
getBusInterfaceBitsInLAUThe number bits in the least addressable unit. If none exists, the default 8 bits is returned. 
setBusInterfaceMasterBaseAddressSet base address of the master bus interface. 
setRemapAddressValueSet remap address value for the associated interface. 
setBusInterfaceMirroredSlaveRangeSet address range for the associated interface. 
setBusInterfaceBitSteeringSet bus interface bit steering value. 
+

+

Component Instance Operations

+ + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getComponentInstanceNameInstance name of the component 
getComponentInstanceVLNVVendor Library Name Version of the component (from the design file) 
getComponentInstanceComponentIDID for the component associated with given instance (crossing from design to component file) 
getComponentInstanceXMLReturn the component XML in text format. Schema version is DE dependent. 
+

+

Component Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getComponentVLNVVendor Library Name Version of the component (from the component file) 
getComponentElementTypeReturns the name of the XML element associated with the component (currently only 'component'). This call is being provided to cover a future scenario where there can be different types of component elements instantiated in a design (e.g. macroComponent elements). 
getChannelBusInterfaceIDsList of busInterface IDs in this channel 
getComponentAddressSpaceIDsList of IDs for the logical address spaces in the component. 
getComponentRemapStateIDsA list of remap state IDs 
getComponentViewIDsA list of model view IDs 
getComponentBusInterfaceIDsList of interface IDs 
getComponentChannelIDsA list of channel IDs 
getComponentPortIDsA list of component model port IDs 
getComponentModelParameterIDsA list of model parameter IDs 
getComponentGeneratorIDsList of generator IDs of the component 
getComponentChoiceIDsList of choices IDs 
getComponentFileSetIDsList of file set IDs 
getComponentWhiteboxElementIDsList of whitebox element IDs of the component 
getComponentCpuIDsList of cpu IDs of the component 
getCpuAddressSpaceIDsList of address space reference IDs of the cpu 
getComponentOtherClockDriverIDsList of clock driver IDs of the component 
getComponentMemoryMapIDsList of IDs for memory map elements in the given component 
+

+

Constraint Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getPortConstraintSetReferenceNameReference name of the given port constraint set 
getPortConstraintSetRangeList of the left and right range of a port referenced by this constraint set 
getPortConstraintSetDriveConstraintIDsList of drive constraint IDs of the port 
getPortConstraintSetLoadConstraintIDsList of load constraint IDs of the port 
getPortConstraintSetTimingConstraintIDsList of timing constraint IDs of the port 
getDriveConstraintTypeIndicates the type of drive constraint: function class 
getDriveConstraintValueReturns the drive constraint. Format depends on the constraint type. 
getLoadConstraintTypeIndicates the type of load constraint: function class 
getLoadConstraintValueReturns the load constraint. Format is cell function and strength or cell class and strength. 
getLoadConstraintCountReturns the load constraint count, the number of loads. 
getTimingConstraintClockDetailsIndicates the clock name, clock edge, and delay type 
getTimingConstraintValueReturns the timing constraint value (cycle time percentage). 
+

+

Design Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getDesignIDGet ID of the current or top design 
getDesignVLNVVendor Library Name Version of the design 
getDesignComponentInstanceIDsComponents instances IDs of the given design 
getComponentInstanceIDReturn the component instance ID of the named component instance in the given design 
getDesignInterconnectionIDsList of interconnection element IDs 
getInterconnectionActiveInterfacesReturns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRefModified in 1.5
getDesignInterconnectionAbstractorInstanceIDsList of abstractor instances IDs for this interconnection 
getDesignMonitorInterconnectionIDsList of monitorInterconnection element IDs 
getMonitorInterconnectionInterfacesReturns the active interface and monitor interfaces as a list in componentPathRef, componentRef, componentInterface, monitorPathRef, monitorRef, monitorInterface format, the active interface comes first in the list.Modified in 1.5
getDesignAdHocConnectionIDsList of ad-hoc connection element IDs 
getAdHocConnectionTiedValueGet the tied value for an ad-hoc connection 
getAdHocConnectionInternalPortReferenceIDsList of internal ad-hoc port reference element IDs 
getAdHocConnectionInternalPortReferenceDetailsList for an internal connection containing the componentRef, portRef, left, and right attribute values 
getAdHocConnectionExternalPortReferenceIDsList of external ad-hoc port reference element IDs 
getAdHocConnectionExternalPortDetailsList for an external connection containing the portRef, left, and right attribute values 
getDesignHierConnectionIDsList of hierarchical connection element IDs 
getHierConnectionDetailsList containing the interface name, component reference, and interface reference 
addComponentInstanceAdd new component instance. 
removeComponentInstanceRemove specified component instance. 
replaceComponentInstanceReplace specified component with new provided component. 
appendAbstractorInstanceAppend a new abstractor instance to the interconnection. 
removeAbstractorInstanceRemove specified abstractor instance. 
replaceAbstractorInstanceReplace specified abstractor with new provided abstractor. 
addInterconnectionAdd new interconnection between components. 
removeInterconnectionRemove interconnection between components, and any abstractors if present. 
addMonitorInterconnectionAdd new interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element. 
addHierarchicalMonitorInterconnectionAdd new hierarchical interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element.New in 1.5
removeMonitorInterconnectionRemove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed. 
removeHierarchicalMonitorInterconnectionRemove a hierarchical interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.New in 1.5
addHierConnectionAdd new hierarchical connection. 
removeHierConnectionRemove existing hierarchical connection. 
addAdHocConnectionAdd new ad-hoc connection. 
addAdHocInternalPortReferenceAdd an internal port reference to an existing ad-hoc connection. An identical port reference must not already exist in the ad-hoc connection. 
addAdHocExternalPortReferenceAdd an external port reference to an existing ad-hoc connection. 
removeAdHocInternalPortReferenceRemove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed. 
removeAdHocExternalPortReferenceRemove an external port reference from existing ad-hoc connection. 
+

+

Field Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getRegisterFieldBitOffsetBit offset of the fields LSB inside the register. 
getRegisterFieldBitWidthWidth of the field in bits., Configurable 
setRegisterFieldBitWidthSet the width of the field in bits., Configurable 
getRegisterFieldVolatilityIndicates whether or not the data is volatile. The presumed value is 'false' if the element is not present.Modified in 1.5
getRegisterFieldAccessThe accessibility of the data in the field. 
getRegisterFieldValueIDsList of IDs for field values for the given register field. 
getRegisterFieldValueUsageEnumerated bit field usage.New in 1.5
getRegisterFieldValueEnumerated bit field value. 
getRegisterFieldValueNameEnumerated name for this register field value. Deprecated - use getName. 
getRegisterFieldModifiedWriteValueThe modified write value for the fieldNew in 1.5
getRegisterFieldWriteValueConstraintWriteAsReadThe write value constraint is write as read.New in 1.5
getRegisterFieldWriteValueConstraintUseEnumeratedValuesThe write value constraint shall use the enumerated values.New in 1.5
getRegisterFieldWriteValueConstraintMinMaxThe value of a write constraint.New in 1.5
getRegisterFieldReadActionThe read action for the fieldNew in 1.5
getRegisterFieldTestableTrue if the field can be tested with a simple register test.New in 1.5
getRegisterFieldTestConstraintThe test constraint required if the field can be tested with a simple register test.New in 1.5
+

+

File and Fileset Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getFileSetGroupNameName of file set group 
getFileSetGroupFileSetIDsList of file set IDs in this file set group 
getFileNameGet name of the given fileID., Configurable 
getFileBuilderFileTypeFileType or userFileType of the file builder 
getFileBuilderCommandCommand of the file builder, Configurable 
getFileBuilderFlagsFlags of the file builder, Configurable 
getFileBuilderReplaceDefaultFlagsValue of the replaceDefaultFlags element of the file builder, Configurable 
getFileSetGroupsList of group names of the file set 
getFileSetFileIDsList of file IDs of the file set 
getFileTypeFileType or userFileType of the file 
getFileIsIncludeFileIndicates that the given file is an include file 
getFileHasExternalDeclarationsIndicates that the file includes external declarations required by the top-level netlist file 
getFileLogicalNameLogical name of the file 
getFileLogicalNameDefaultDefault attribute of logical name of the file 
getFileExportedNamesList of exported names of the file 
getFileBuildCommandNameName of the build command of the file, Configurable 
getFileBuildCommandFlagsFlags of the file build command, Configurable 
getFileBuildCommandFlagsIsAppendValue of append attribute on the flag element 
getFileBuildCommandReplaceDefaultFlagsIndicates whether or not to replace default flags, Configurable 
getFileBuildCommandTargetNameTarget name of the file build command, Configurable 
getFileDependenciesList of dependent locations for the file, typically directories 
getFileDefineSymbolIDsList of define symbol IDs used in the file 
getFileImageTypesList of image types of the file 
getFileSetFileBuilderIDsList of file builder IDs used for this fileSet 
getFileSetDependenciesList of dependent locations for the fileSet, typically directories 
getFileSetFunctionIDsList of function IDs 
getFunctionReplicateValue of replicate attribute on function element 
getFunctionEntryPointEntry point of the function 
getFunctionFileIDFile ID containing the function entry point 
getFunctionReturnTypeReturn type of the function 
getFunctionArgumentIDsList of argument IDs of the function of the file set 
getFunctionArgumentDataTypeData type of the argument 
getFunctionDisabledIndicates whether or not the function is disabled, Configurable 
getFunctionSourceFileIDsList of source file IDs of the function of the file set 
getFunctionSourceFileNameName of the source file 
getFunctionSourceFileTypeFileType or userFileType of the source file 
setFileNameSet name of the given file. 
setFileBuildCommandNameSet command name for the given file builder. 
setFileBuildCommandFlagsSet command flags for the given file builder. 
setFileBuildCommandReplaceDefaultFlagsSet replace default flags for the given file builder. 
setFileBuildCommandTargetNameSet target name for build command for the given file 
setFileBuilderCommandSet command associated with file builder. 
setFileBuilderFlagsSet flags associated with the given file builder. 
setFileBuilderReplaceDefaultFlagsSet value of replace default flags in file builder. 
setFunctionDisabledSet disable flag on function. 
+

+

Generator Operations

+ + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getGeneratorScopeScope of the generator 
getGeneratorIsHiddenValue of hidden attribute on the generator 
getGeneratorPhasePhase number of the generator 
getGeneratorApiTypeApi type of the generator 
getGeneratorExecutableExecutable name associated with the generator  
getGeneratorGroupsList of group names of the generator 
getGeneratorTransportMethodsList of transport methods of the generator 
+

+

Interface Operations

+ + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getInterfaceBusTypeVLNVList of VLNV of the bus definition 
getInterfaceAbstractionTypeVLNVList of VLNV of the abstraction definition 
getInterfaceModeMode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor 
getInterfacePortMapIDsList of interface port map IDs 
getLogicalPhysicalMapIDsList of the logical and physical port map IDs 
getPortMapRangeList of left and right range of the port map, Configurable 
setPortMapRangeSet left/right range of an interface port map. 
+

+

Miscellaneous Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getVendorExtensionsReturns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document. 
getVendorAttributeGet vendor defined attribute from the given element 
getParameterIDsList of parameter IDs from the given element (any which contains spirit:parameter elements) 
getValueGet the value of a parameterID, fileDefineIDs or argumentIDs., Configurable 
getValueAttributeReturns the value of the given attribute name on the elementID/value element 
getModelParameterDataTypeData type of the model parameter 
getModelParameterUsageTypeUsage type of the model parameter 
getIdValueReturn the value of the spirit:id attribute on a IDNew in 1.5
getNameReturn the name of the specified elementModified in 1.5
getDescriptionReturn the description of the specified elementModified in 1.5
getDisplayNameReturn the displayName of the specified elementModified in 1.5
getUnconfiguredIDReturn the unconfigured ID from a configured IDNew in 1.5
getChoiceNameName of the choice 
getChoiceEnumerationIDsList of choice enumeration IDs of the choice 
getChoiceEnumerationValueValue of the enumeration element 
getChoiceEnumerationTextValue of the enumeration text attribute 
getChoiceEnumerationHelpValue of the enumeration help attribute 
registerVLNVIndicate to DE where the file resides for the IP-XACT element with the given VLNV. 
getXMLForVLNVReturn XML of the IP-XACT object identified by the given VLNV. 
getGeneratorContextComponentInstanceIDID for the component instance associated with the currently invoked generator 
initAPI initialization function. Must be called before any other API call. 
messageSend message level and message text to Design Environment. 
getErrorMessageGet error message from prior callback. 
getWarningCountReturn count of how many potentially incompatible API calls have been made. 
endTerminate connection to the Design Environment. 
setVendorExtensionsSet vendor extensions. NOTE: This call is only supported for elements within a spirit:design. 
setVendorAttributeSet vendor defined attribute on the given element 
setValueSet the value of a parameterID, fileDefineIDs or argumentIDs. 
+

+

Port Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getPortStyleReturns 'wire' or 'transactional' to indicate the port style 
getAllLogicalDirectionsAllowedGet the value of the allLogicalDirectionAllowed attributeNew in 1.5
getPortDirectionDirection of the port 
getPortRangeList of the left and right range of the port 
getPortWireTypeDefIDsList of typeDefs for a wire portIDNew in 1.5
getPortTransactionalTypeDefIDThe type definition for a transactional portIDNew in 1.5
getPortServiceIDID of element representing the service of a transactional port 
getPortAccessTypeIndicates the access type for this portModified in 1.5
getPortAccessHandleAlternate name to be used when accessing this portModified in 1.5
getPortMaxAllowedConnectionsMax allowed connections for this transactional port 
getPortMinAllowedConnectionsMin allowed connections for this transactional port 
getPortDefaultValueDefault value of the port, if not set returns "", Configurable 
getPortClockDriverIDElement ID of clock driver element, if present 
getClockDriverPeriodClock period of the given clock, Configurable 
getClockDriverPeriodUnitsUnits of the clock period of the given clockNew in 1.5
getClockDriverPulseOffsetClock pulse offset of the given clock, Configurable 
getClockDriverPulseOffsetUnitsUnits of the clock pulse offset of the given clockNew in 1.5
getClockDriverPulseValueClock pulse value of the given clock, Configurable 
getClockDriverPulseDurationClock period of the given clock, Configurable 
getClockDriverPulseDurationUnitsUnits of the clock pulse duration of the given clockNew in 1.5
getClockDriverNameName of the clock driver 
getClockDriverSourceSource name of the clock driver 
getPortSingleShotDriverIDElement ID of single shot driver element, if present 
getPortSingleShotPulseOffsetClock pulse offset of the port, Configurable 
getPortSingleShotPulseValueClock pulse value of the port, Configurable 
getPortSingleShotPulseDurationClock period of the port, Configurable 
getPortConstraintSetIDsList of constraint sets IDs of the port 
setPortRangeSet left/right range for the given port. 
setPortDefaultValueSet default value of the given port. 
setClockDriverPeriodSet period of the given clock port. 
setClockDriverPulseOffsetSet pulse offset value of the given clock port. 
setClockDriverPulseValueSet pulse value of the given clock port. 
setClockDriverPulseDurationSet pulse duration of the given clock port. 
setPortSingleShotPulseOffsetSet pulse offset of given single shot port. 
setPortSingleShotPulseValueSet pulse value of given single shot port. 
setPortSingleShotPulseDurationSet pulse duration of given single shot port. 
+

+

Register File Operations

+ + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getRegisterFileDimensionsDimensions of a register file array.New in 1.5
getRegisterFileAddressOffsetThe offset from the base address.New in 1.5
getRegisterFileRangeThe register file range in number of addressable units., ConfigurableNew in 1.5
setRegisterFileRangeSet the register file range in addressable units., ConfigurableNew in 1.5
getRegisterFileRegisterIDsList of IDs for the registers of the given register fileNew in 1.5
getRegisterFileRegisterFileIDsList of IDs for the register files of the given register fileNew in 1.5
+

+

Register Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getRegisterDimensionsDimensions of a register array. 
getRegisterAddressOffsetThe offset from the base address. 
getRegisterAlternateRegisterIDsList of IDs for the alternate registers of the given registerNew in 1.5
getRegisterAccessThe accessibility of the data in the register 
getRegisterSizeThe register size in bits., Configurable 
setRegisterSizeSet the register size in bits., Configurable 
getRegisterVolatilityIndicates whether or not the data is volatile.Modified in 1.5
getRegisterResetValueRegister value at reset., ConfigurableModified in 1.5
setRegisterResetValueSet register value at reset., ConfigurableModified in 1.5
getRegisterResetMaskMask to be ANDed with the value before comparing to reset value., ConfigurableModified in 1.5
setRegisterResetMaskSet the mask to be ANDed with the value before comparing to reset value., ConfigurableModified in 1.5
getRegisterFieldIDsList of IDs for the fields of the given registerModified in 1.5
getRegisterAlternateGroupsIndicates the group names for an alternate register.New in 1.5
+

+

Remap Operations

+ + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getRemapStatePortIDsList of remap port IDs of a remap state 
getRemapStatePortPortIDPort ID for the remap state 
getRemapStatePortPortIndexIndex of the port if a vector for the remap state 
getRemapStatePortPortValueValue of the port for the remap state 
+

+

Service Operations

+ + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getAbstractionDefServiceInitiativePort service initiative from the abstraction definition 
getAbstractionDefServiceIDsList of typeDefs for an abstractionServiceIDInvalid in 1.5
getAbstractionDefAbstractionServiceTypeDefIDsList of type definitions for an abstractionServiceIDNew in 1.5
getServiceInitiativeInitiative of the service 
getServiceTypeDefIDsList of typeDefs for a serviceIDModified in 1.5
+

+

TypeDef Operations

+ + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getTypeDefTypeNameName of the typeModified in 1.5
getTypeDefConstrainedIs the type name constrainedModified in 1.5
getTypeDefImplicitIs the type name implicitModified in 1.5
getTypeDefTypeDefinitionsList of type definition for the given typeModified in 1.5
getTypeDefTypeViewIDsList of type viewIDs for the given typeModified in 1.5
+

+

View Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getViewDesignIDID of the design associated with a hierarchical view 
getViewEnvIdentifiersList of environment identifiers of the view 
getViewLanguageView Language 
getViewLanguageIsStrictValue of 'strict' attribute on view language element 
getViewModelNameGet the model name for this view 
getViewDefaultFileBuilderIDsList of default file builder IDs of the view 
getViewFileSetIDsList of fileSet IDs for fileSets referenced by the view 
getViewPortConstraintSetIDsConstraint set ID for the port referenced by the viewModified in 1.5
getViewWhiteboxElementRefIDsList of whitebox element reference IDs of the view 
+

+

Whitebox Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionCompatability
Restrictions
getWhiteboxElementRefIDWhite box element reference ID 
getWhiteboxRefPathIDsList of path IDs of the white box element reference 
getWhiteboxRefPathNameName of the whitebox reference path element 
getWhiteboxRefPathRangeList of left and right range of the whitebox reference path element 
getWhiteboxElementTypeType of the whitebox element 
getWhiteboxElementDrivableIndicates whether or not the whitebox element is drivable 
getWhiteboxElementRegisterIDRegister reference ID of the whitebox elementInvalid in 1.5
getWhiteboxElementRegisterIDsRegister reference IDs of the whitebox elementNew in 1.5
+

+
+

Abstraction Definition Operations

+
+ +

getAbstractionDefID

+Description: ID for the abstraction definition with the given VLNV  + + +

getAbstractionDefVLNV

+Description: Vendor Library Name Version of the abstraction definition  + + +

getAbstractionDefBusTypeVLNV

+Description: Get VLNV of the bus definition  + + +

getAbstractionDefExtends

+Description: Vendor Library Name Version of the abstraction definition being extended- New in 1.5 + + +

getAbstractionDefPortIDs

+Description: List of abstraction definition port element IDs  + + +

getAbstractionDefPortLogicalName

+Description: Logical name of this abstraction definition port  + + +

getAbstractionDefPortRequiresDriver

+Description: Does this port require a driver  + + +

getAbstractionDefPortRequiredDriverType

+Description: Required driver type for this port  + + +

getAbstractionDefPortStyle

+Description: Returns 'wire' or 'transactional' to indicate the port style  + + +

getAbstractionDefPortIsAddress

+Description: Is this port an address port  + + +

getAbstractionDefPortIsData

+Description: Is this port a data port  + + +

getAbstractionDefPortIsClock

+Description: Is this port a clock port  + + +

getAbstractionDefPortIsReset

+Description: Is this port a reset port  + + +

getAbstractionDefPortModeID

 +Description: Returns an ID for accessing the given port in the given interface mode- Invalid in 1.5 + + +

getAbstractionDefPortModeIDs

+Description: Returns an array of IDs for accessing the given port in the given interface mode. The array shall only contain one element if the modeValue input is master or slave. The array may contain multiple elements for modeValue system.- New in 1.5 + + +

getAbstractionDefPortModeGroup

+Description: Group name when present on a system interface  + + +

getAbstractionDefPortModeBitWidth

+Description: Bit width constraint when present on an interface of the given type  + + +

getAbstractionDefPortModeDirection

+Description: Port direction constraint when present on an interface of the given type  + + +

getAbstractionDefPortNonMirroredConstraintIDs

+Description: List of constraint IDs for a non-mirrored port  + + +

getAbstractionDefPortMirroredConstraintIDs

+Description: List of constraint IDs for a mirrored port  + + +

getAbstractionDefPortDriveConstraintIDs

+Description: List of drive constraint IDs of the port  + + +

getAbstractionDefPortLoadConstraintIDs

+Description: List of load constraint IDs of the port  + + +

getAbstractionDefPortTimingConstraintIDs

+Description: List of timing constraint IDs of the port  + + +

getAbstractionDefPortDefaultValue

+Description: Default value for port when not connected  + + +

getAbstractionDefPortModePresence

+Description: Existence requirement for this port on an interface of the given type  + + +

getAbstractionDefPortModeServiceIDs

 +Description: AbstractionDef service IDs on a transactional port- Invalid in 1.5 + + +

getAbstractionDefPortModeServiceID

+Description: AbstractionDef service ID on a transactional port- New in 1.5 + +

+
+

Abstractor Instance Operations

+
+ +

getAbstractorInstanceName

+Description: Instance name of the abstractor  + + +

getAbstractorInstanceVLNV

+Description: Vendor Library Name Version of the abstractor (from the design file)  + + +

getAbstractorInstanceAbstractorID

+Description: ID for the abstractor associated with given instance (crossing from design configuration to abstractor file)  + + +

getAbstractorInstanceXML

+Description: Return the abstractor XML in text format. Schema version is DE dependent.  + +

+
+

Abstractor Operations

+
+ +

getAbstractorAbstractorMode

+Description: Get the mode that the abstractor can be master, slave, direct or system.  + + +

getAbstractorBusTypeVLNV

+Description: List of VLNV of the bus definition  + + +

getAbstractorAbstractorInterfaceIDs

+Description: List of 2 interface IDs  + + +

getAbstractorViewIDs

+Description: A list of model view IDs- Modified in 1.5 + + +

getAbstractorPortIDs

+Description: A list of abstractor model port IDs  + + +

getAbstractorModelParameterIDs

+Description: A list of model parameter IDs  + + +

getAbstractorGeneratorIDs

+Description: List of generator IDs of the abstractor  + + +

getAbstractorChoiceIDs

+Description: List of choices IDs  + + +

getAbstractorFileSetIDs

+Description: List of file set IDs  + +

+
+

Address Map Operations

+
+ +

getAddressSpaceRange

+Description: The address range of an address block expressed as the number of accessable and addressable units.  + + +

getAddressSpaceWidth

+Description: The bit width of an address block.  + + +

getAddressSpaceLocalMemoryMapID

+Description: The ID for the local memory map of the address space.- New in 1.5 + + +

getAddressSpaceSegmentIDs

+Description: List of IDs for address block segments for the address space.- New in 1.5 + + +

getSegmentAddressOffset

+Description: The address offset of an address space segment in an address space- New in 1.5 + + +

setSegmentAddressOffset

+Description: Set the address offset of an address space segment expressed in the number addressable units.- New in 1.5 + + +

getSegmentRange

+Description: The address range of an address space segment expressed as the number of accessable addressable units.- New in 1.5 + + +

setSegmentRange

+Description: Set the address range of an address space segment expressed as the number of accessable addressable units.- New in 1.5 + + +

getAddressSpaceAddressUnitBits

+Description: The number bits in an addressable unit. If none exists, the default 8 bits is returned.  + + +

getExecutableImageIDs

+Description: The IDs of the executable images belonging to the specified address space.  + + +

getExecutableImageType

+Description: The type of the executable image if existent.  + + +

getExecutableImageLinkerCommand

+Description: The linker command for the current executable image.  + + +

getExecutableImageLinkerFlags

+Description: The flags of the current executable image linker command.  + + +

getExecutableImageLinkerCommandFileID

+Description: Element ID of linkerCommandFile associated with given executable image.  + + +

getExecutableImageFileBuilderIDs

+Description: List of default file builder IDs of the executable image  + + +

getExecutableImageFileSetIDs

+Description: The group of file set reference IDs complying with the tool set of the current executable image.  + + +

getLinkerCommandFileName

+Description: The name of the linker command file.  + + +

getLinkerCommandFileLineSwitch

+Description: The command line switch to specify with the linker command file.  + + +

getLinkerCommandFileEnable

+Description: Indicates whether or not to generate and enable the linker command file.  + + +

getLinkerCommandGeneratorIDs

+Description: Reference IDs to the generator elements for generating the linker command file.  + + + + + +

getMemoryMapElementIDs

+Description: List of element IDs (addressBlockID, bankID, subspaceMapID) within a memory map, memory remap, local memory map, or bank- Modified in 1.5 + + +

getMemoryMapElementType

+Description: Indicates type of memory map element: addressBlock, bank or subspaceMap  + + +

getMemoryMapAddressUnitBits

+Description: The number bits in an addressable unit for a memory map. If none exists, the default 8 bits is returned.  + + +

getAddressBlockBaseAddress

+Description: The base address of an address block  + + +

getAddressBlockRange

+Description: The address range of an address block expressed as the number of accessable and addressable units.  + + +

getAddressBlockWidth

+Description: The bit width of an address block in the local memory map.  + + +

getAddressBlockUsage

+Description: Indicates the usage of this address block.  + + +

getAddressBlockVolatility

+Description: Indicates whether or not the data is volatile.  + + +

getAddressBlockAccess

+Description: The accessibility of the data in the local address block.  + + +

getAddressBlockRegisterIDs

+Description: The IDs of the available registers in the address block.  + + +

getAddressBlockRegisterFileIDs

+Description: The IDs of the available register files in the address block.- New in 1.5 + + +

getTypeIdentifier

+Description: Indicates the type identifier of an addressBlock, registerFile, register or field.- New in 1.5 + + +

getBankAlignment

+Description: The bank alignment value, serial or parallel  + + +

getBankBaseAddress

+Description: The base address of an address bank  + + +

getBankUsage

+Description: Indicates the usage of this address bank.  + + +

getBankVolatility

+Description: Indicates whether or not the data is volatile.  + + +

getBankAccess

+Description: The accessibility of the data in the local address bank.  + + +

getSubspaceMapMasterID

+Description: Master bus interface ID on the other side of a bus bridge .  + + +

getSubspaceMapSegmentID

+Description: Address space segment ID on the other side of a bus bridge .- New in 1.5 + + +

getSubspaceMapBaseAddress

+Description: The base address of a memory subspace  + + +

getMemoryMapRemapElementIDs

+Description: List of IDs for memory map 'remap' elements of the given memory map  + + +

getMemoryRemapStateID

+Description: Remap State ID for which this remap is applicable  + + +

setAddressSpaceRange

+Description: Set the address range of an address block expressed as the number of accessable and addressable units.  + + +

setAddressSpaceWidth

+Description: Set the bit width of an address block.  + + +

setExecutableImageLinkerCommand

+Description: Set the linker command for the current executable image.  + + +

setExecutableImageLinkerFlags

+Description: Set the flags of the current executable image linker command.  + + +

setLinkerCommandFileName

+Description: Set the name of the linker command file.  + + +

setLinkerCommandFileLineSwitch

+Description: Set the command line switch to specify with the linker command file.  + + +

setLinkerCommandFileEnable

+Description: Set whether or not to generate and enable the linker command file.  + + +

setAddressBlockBaseAddress

+Description: Set the base address of an address block  + + +

setAddressBlockRange

+Description: Set the address range of an address block expressed as the number of accessable and addressable units.  + + +

setAddressBlockWidth

+Description: Set the bit width of an address block  + + +

setBankBaseAddress

+Description: Set the base address of an address bank  + + +

setSubspaceMapBaseAddress

+Description: Set the base address of a memory subspace  + +

+
+

Bus Definition Operations

+
+ +

getBusDefinitionID

+Description: ID for the bus definition with the given VLNV  + + +

getBusDefinitionVLNV

+Description: Vendor Library Name Version of the bus definition  + + +

getBusDefinitionDirectConnection

+Description: Indicates whether or not the bus definition supports direct connections  + + +

getBusDefinitionIsAddressable

+Description: Indicates whether or not the bus definition is an addressable bus  + + +

getBusDefinitionExtends

+Description: Vendor Library Name Version of the bus definition being extended  + + +

getBusDefinitionMaxMasters

+Description: Maximum # of masters supported by this bus definition  + + +

getBusDefinitionMaxSlaves

+Description: Maximum # of slaves supported by this bus definition  + + +

getBusDefinitionSystemGroupNames

+Description: List of system group names for this bus definition  + +

+
+

Bus Interface Operations

+
+ +

getBusInterfaceMasterAddressSpaceID

+Description: ID of the master addressSpace  + + +

getBusInterfaceMasterBaseAddress

+Description: Base address of the master addressSpace  + + +

getBusInterfaceSlaveMemoryMapID

+Description: ID of the memoryMap referenced from a slave interface  + + +

getBusInterfaceSlaveBridgeIDs

+Description: List of slave bridge IDs  + + +

getBridgeMasterID

+Description: The slave interface master interface reference ID  + + +

getBridgeIsOpaque

+Description: Value of the opaque attribute  + + +

getBusInterfaceSlaveFileSetGroupIDs

+Description: List of fileSetGroup IDs  + + +

getBusInterfaceGroupName

+Description: Group name of a system, mirroredSystem, or monitor bus interface  + + +

getBusInterfaceMirroredSlaveRemapAddressIDs

+Description: List of remap address IDs of the mirrored slave interface  + + +

getRemapAddressValue

+Description: Remap address of the given remap address element  + + +

getRemapAddressRemapStateID

+Description: Remap state ID of the given remap address element  + + +

getBusInterfaceMirroredSlaveRange

+Description: The address range of the mirrored slave interface  + + +

getBusInterfaceMonitorInterfaceMode

+Description: Indicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave  + + +

getBusInterfaceConnectionRequired

+Description: Connection required for this bus interface  + + +

getBusInterfaceBitSteering

+Description: Bit steering description of the bus interface: on or off  + + +

getBusInterfaceEndianness

+Description: The endianess of the bus interface, big or little. The default is little.  + + +

getBusInterfaceBitsInLAU

+Description: The number bits in the least addressable unit. If none exists, the default 8 bits is returned.  + + +

setBusInterfaceMasterBaseAddress

+Description: Set base address of the master bus interface.  + + +

setRemapAddressValue

+Description: Set remap address value for the associated interface.  + + +

setBusInterfaceMirroredSlaveRange

+Description: Set address range for the associated interface.  + + +

setBusInterfaceBitSteering

+Description: Set bus interface bit steering value.  + +

+
+

Component Instance Operations

+
+ +

getComponentInstanceName

+Description: Instance name of the component  + + +

getComponentInstanceVLNV

+Description: Vendor Library Name Version of the component (from the design file)  + + +

getComponentInstanceComponentID

+Description: ID for the component associated with given instance (crossing from design to component file)  + + +

getComponentInstanceXML

+Description: Return the component XML in text format. Schema version is DE dependent.  + +

+
+

Component Operations

+
+ +

getComponentVLNV

+Description: Vendor Library Name Version of the component (from the component file)  + + +

getComponentElementType

+Description: Returns the name of the XML element associated with the component (currently only 'component'). This call is being provided to cover a future scenario where there can be different types of component elements instantiated in a design (e.g. macroComponent elements).  + + +

getChannelBusInterfaceIDs

+Description: List of busInterface IDs in this channel  + + +

getComponentAddressSpaceIDs

+Description: List of IDs for the logical address spaces in the component.  + + +

getComponentRemapStateIDs

+Description: A list of remap state IDs  + + +

getComponentViewIDs

+Description: A list of model view IDs  + + +

getComponentBusInterfaceIDs

+Description: List of interface IDs  + + +

getComponentChannelIDs

+Description: A list of channel IDs  + + +

getComponentPortIDs

+Description: A list of component model port IDs  + + +

getComponentModelParameterIDs

+Description: A list of model parameter IDs  + + +

getComponentGeneratorIDs

+Description: List of generator IDs of the component  + + +

getComponentChoiceIDs

+Description: List of choices IDs  + + +

getComponentFileSetIDs

+Description: List of file set IDs  + + +

getComponentWhiteboxElementIDs

+Description: List of whitebox element IDs of the component  + + +

getComponentCpuIDs

+Description: List of cpu IDs of the component  + + +

getCpuAddressSpaceIDs

+Description: List of address space reference IDs of the cpu  + + +

getComponentOtherClockDriverIDs

+Description: List of clock driver IDs of the component  + + +

getComponentMemoryMapIDs

+Description: List of IDs for memory map elements in the given component  + +

+
+

Constraint Operations

+
+ +

getPortConstraintSetReferenceName

+Description: Reference name of the given port constraint set  + + +

getPortConstraintSetRange

+Description: List of the left and right range of a port referenced by this constraint set  + + +

getPortConstraintSetDriveConstraintIDs

+Description: List of drive constraint IDs of the port  + + +

getPortConstraintSetLoadConstraintIDs

+Description: List of load constraint IDs of the port  + + +

getPortConstraintSetTimingConstraintIDs

+Description: List of timing constraint IDs of the port  + + +

getDriveConstraintType

+Description: Indicates the type of drive constraint: function class  + + +

getDriveConstraintValue

+Description: Returns the drive constraint. Format depends on the constraint type.  + + +

getLoadConstraintType

+Description: Indicates the type of load constraint: function class  + + +

getLoadConstraintValue

+Description: Returns the load constraint. Format is cell function and strength or cell class and strength.  + + +

getLoadConstraintCount

+Description: Returns the load constraint count, the number of loads.  + + +

getTimingConstraintClockDetails

+Description: Indicates the clock name, clock edge, and delay type  + + +

getTimingConstraintValue

+Description: Returns the timing constraint value (cycle time percentage).  + +

+
+

Design Operations

+
+ +

getDesignID

+Description: Get ID of the current or top design  + + +

getDesignVLNV

+Description: Vendor Library Name Version of the design  + + +

getDesignComponentInstanceIDs

+Description: Components instances IDs of the given design  + + +

getComponentInstanceID

+Description: Return the component instance ID of the named component instance in the given design  + + +

getDesignInterconnectionIDs

+Description: List of interconnection element IDs  + + +

getInterconnectionActiveInterfaces

+Description: Returns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRef- Modified in 1.5 + + +

getDesignInterconnectionAbstractorInstanceIDs

+Description: List of abstractor instances IDs for this interconnection  + + +

getDesignMonitorInterconnectionIDs

+Description: List of monitorInterconnection element IDs  + + +

getMonitorInterconnectionInterfaces

+Description: Returns the active interface and monitor interfaces as a list in componentPathRef, componentRef, componentInterface, monitorPathRef, monitorRef, monitorInterface format, the active interface comes first in the list.- Modified in 1.5 + + +

getDesignAdHocConnectionIDs

+Description: List of ad-hoc connection element IDs  + + +

getAdHocConnectionTiedValue

+Description: Get the tied value for an ad-hoc connection  + + +

getAdHocConnectionInternalPortReferenceIDs

+Description: List of internal ad-hoc port reference element IDs  + + +

getAdHocConnectionInternalPortReferenceDetails

+Description: List for an internal connection containing the componentRef, portRef, left, and right attribute values  + + +

getAdHocConnectionExternalPortReferenceIDs

+Description: List of external ad-hoc port reference element IDs  + + +

getAdHocConnectionExternalPortDetails

+Description: List for an external connection containing the portRef, left, and right attribute values  + + +

getDesignHierConnectionIDs

+Description: List of hierarchical connection element IDs  + + +

getHierConnectionDetails

+Description: List containing the interface name, component reference, and interface reference  + + +

addComponentInstance

+Description: Add new component instance.  + + +

removeComponentInstance

+Description: Remove specified component instance.  + + +

replaceComponentInstance

+Description: Replace specified component with new provided component.  + + +

appendAbstractorInstance

+Description: Append a new abstractor instance to the interconnection.  + + +

removeAbstractorInstance

+Description: Remove specified abstractor instance.  + + +

replaceAbstractorInstance

+Description: Replace specified abstractor with new provided abstractor.  + + +

addInterconnection

+Description: Add new interconnection between components.  + + +

removeInterconnection

+Description: Remove interconnection between components, and any abstractors if present.  + + +

addMonitorInterconnection

+Description: Add new interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element.  + + +

addHierarchicalMonitorInterconnection

+Description: Add new hierarchical interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element.- New in 1.5 + + +

removeMonitorInterconnection

+Description: Remove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.  + + +

removeHierarchicalMonitorInterconnection

+Description: Remove a hierarchical interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.- New in 1.5 + + +

addHierConnection

+Description: Add new hierarchical connection.  + + +

removeHierConnection

+Description: Remove existing hierarchical connection.  + + +

addAdHocConnection

+Description: Add new ad-hoc connection.  + + +

addAdHocInternalPortReference

+Description: Add an internal port reference to an existing ad-hoc connection. An identical port reference must not already exist in the ad-hoc connection.  + + +

addAdHocExternalPortReference

+Description: Add an external port reference to an existing ad-hoc connection.  + + +

removeAdHocInternalPortReference

+Description: Remove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed.  + + +

removeAdHocExternalPortReference

+Description: Remove an external port reference from existing ad-hoc connection.  + +

+
+

Field Operations

+
+ +

getRegisterFieldBitOffset

+Description: Bit offset of the fields LSB inside the register.  + + +

getRegisterFieldBitWidth

+Description: Width of the field in bits.  + + +

setRegisterFieldBitWidth

+Description: Set the width of the field in bits.  + + +

getRegisterFieldVolatility

+Description: Indicates whether or not the data is volatile. The presumed value is 'false' if the element is not present.- Modified in 1.5 + + +

getRegisterFieldAccess

+Description: The accessibility of the data in the field.  + + +

getRegisterFieldValueIDs

+Description: List of IDs for field values for the given register field.  + + +

getRegisterFieldValueUsage

+Description: Enumerated bit field usage.- New in 1.5 + + +

getRegisterFieldValue

+Description: Enumerated bit field value.  + + +

getRegisterFieldValueName

+Description: Enumerated name for this register field value. Deprecated - use getName.  + + +

getRegisterFieldModifiedWriteValue

+Description: The modified write value for the field- New in 1.5 + + +

getRegisterFieldWriteValueConstraintWriteAsRead

+Description: The write value constraint is write as read.- New in 1.5 + + +

getRegisterFieldWriteValueConstraintUseEnumeratedValues

+Description: The write value constraint shall use the enumerated values.- New in 1.5 + + +

getRegisterFieldWriteValueConstraintMinMax

+Description: The value of a write constraint.- New in 1.5 + + +

getRegisterFieldReadAction

+Description: The read action for the field- New in 1.5 + + +

getRegisterFieldTestable

+Description: True if the field can be tested with a simple register test.- New in 1.5 + + +

getRegisterFieldTestConstraint

+Description: The test constraint required if the field can be tested with a simple register test.- New in 1.5 + +

+
+

File and Fileset Operations

+
+ +

getFileSetGroupName

+Description: Name of file set group  + + +

getFileSetGroupFileSetIDs

+Description: List of file set IDs in this file set group  + + +

getFileName

+Description: Get name of the given fileID.  + + +

getFileBuilderFileType

+Description: FileType or userFileType of the file builder  + + +

getFileBuilderCommand

+Description: Command of the file builder  + + +

getFileBuilderFlags

+Description: Flags of the file builder  + + +

getFileBuilderReplaceDefaultFlags

+Description: Value of the replaceDefaultFlags element of the file builder  + + +

getFileSetGroups

+Description: List of group names of the file set  + + +

getFileSetFileIDs

+Description: List of file IDs of the file set  + + +

getFileType

+Description: FileType or userFileType of the file  + + +

getFileIsIncludeFile

+Description: Indicates that the given file is an include file  + + +

getFileHasExternalDeclarations

+Description: Indicates that the file includes external declarations required by the top-level netlist file  + + +

getFileLogicalName

+Description: Logical name of the file  + + +

getFileLogicalNameDefault

+Description: Default attribute of logical name of the file  + + +

getFileExportedNames

+Description: List of exported names of the file  + + +

getFileBuildCommandName

+Description: Name of the build command of the file  + + +

getFileBuildCommandFlags

+Description: Flags of the file build command  + + +

getFileBuildCommandFlagsIsAppend

+Description: Value of append attribute on the flag element  + + +

getFileBuildCommandReplaceDefaultFlags

+Description: Indicates whether or not to replace default flags  + + +

getFileBuildCommandTargetName

+Description: Target name of the file build command  + + +

getFileDependencies

+Description: List of dependent locations for the file, typically directories  + + +

getFileDefineSymbolIDs

+Description: List of define symbol IDs used in the file  + + +

getFileImageTypes

+Description: List of image types of the file  + + +

getFileSetFileBuilderIDs

+Description: List of file builder IDs used for this fileSet  + + +

getFileSetDependencies

+Description: List of dependent locations for the fileSet, typically directories  + + +

getFileSetFunctionIDs

+Description: List of function IDs  + + +

getFunctionReplicate

+Description: Value of replicate attribute on function element  + + +

getFunctionEntryPoint

+Description: Entry point of the function  + + +

getFunctionFileID

+Description: File ID containing the function entry point  + + +

getFunctionReturnType

+Description: Return type of the function  + + +

getFunctionArgumentIDs

+Description: List of argument IDs of the function of the file set  + + +

getFunctionArgumentDataType

+Description: Data type of the argument  + + +

getFunctionDisabled

+Description: Indicates whether or not the function is disabled  + + +

getFunctionSourceFileIDs

+Description: List of source file IDs of the function of the file set  + + +

getFunctionSourceFileName

+Description: Name of the source file  + + +

getFunctionSourceFileType

+Description: FileType or userFileType of the source file  + + +

setFileName

+Description: Set name of the given file.  + + +

setFileBuildCommandName

+Description: Set command name for the given file builder.  + + +

setFileBuildCommandFlags

+Description: Set command flags for the given file builder.  + + +

setFileBuildCommandReplaceDefaultFlags

+Description: Set replace default flags for the given file builder.  + + +

setFileBuildCommandTargetName

+Description: Set target name for build command for the given file  + + +

setFileBuilderCommand

+Description: Set command associated with file builder.  + + +

setFileBuilderFlags

+Description: Set flags associated with the given file builder.  + + +

setFileBuilderReplaceDefaultFlags

+Description: Set value of replace default flags in file builder.  + + +

setFunctionDisabled

+Description: Set disable flag on function.  + +

+
+

Generator Operations

+
+ +

getGeneratorScope

+Description: Scope of the generator  + + +

getGeneratorIsHidden

+Description: Value of hidden attribute on the generator  + + +

getGeneratorPhase

+Description: Phase number of the generator  + + +

getGeneratorApiType

+Description: Api type of the generator  + + +

getGeneratorExecutable

+Description: Executable name associated with the generator   + + +

getGeneratorGroups

+Description: List of group names of the generator  + + +

getGeneratorTransportMethods

+Description: List of transport methods of the generator  + +

+
+

Interface Operations

+
+ +

getInterfaceBusTypeVLNV

+Description: List of VLNV of the bus definition  + + +

getInterfaceAbstractionTypeVLNV

+Description: List of VLNV of the abstraction definition  + + +

getInterfaceMode

+Description: Mode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor  + + +

getInterfacePortMapIDs

+Description: List of interface port map IDs  + + +

getLogicalPhysicalMapIDs

+Description: List of the logical and physical port map IDs  + + +

getPortMapRange

+Description: List of left and right range of the port map  + + +

setPortMapRange

+Description: Set left/right range of an interface port map.  + +

+
+

Miscellaneous Operations

+
+ +

getVendorExtensions

+Description: Returns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document.  + + +

getVendorAttribute

+Description: Get vendor defined attribute from the given element  + + +

getParameterIDs

+Description: List of parameter IDs from the given element (any which contains spirit:parameter elements)  + + +

getValue

+Description: Get the value of a parameterID, fileDefineIDs or argumentIDs.  + + +

getValueAttribute

+Description: Returns the value of the given attribute name on the elementID/value element  + + +

getModelParameterDataType

+Description: Data type of the model parameter  + + +

getModelParameterUsageType

+Description: Usage type of the model parameter  + + +

getIdValue

+Description: Return the value of the spirit:id attribute on a ID- New in 1.5 + + +

getName

+Description: Return the name of the specified element- Modified in 1.5 + + +

getDescription

+Description: Return the description of the specified element- Modified in 1.5 + + +

getDisplayName

+Description: Return the displayName of the specified element- Modified in 1.5 + + + + + + + + + + + + + + + + + + + + + + + + +

getUnconfiguredID

+Description: Return the unconfigured ID from a configured ID- New in 1.5 + + +

getChoiceName

+Description: Name of the choice  + + +

getChoiceEnumerationIDs

+Description: List of choice enumeration IDs of the choice  + + +

getChoiceEnumerationValue

+Description: Value of the enumeration element  + + +

getChoiceEnumerationText

+Description: Value of the enumeration text attribute  + + +

getChoiceEnumerationHelp

+Description: Value of the enumeration help attribute  + + +

registerVLNV

+Description: Indicate to DE where the file resides for the IP-XACT element with the given VLNV.  + + +

getXMLForVLNV

+Description: Return XML of the IP-XACT object identified by the given VLNV.  + + +

getGeneratorContextComponentInstanceID

+Description: ID for the component instance associated with the currently invoked generator  + + +

init

+Description: API initialization function. Must be called before any other API call.  + + +

message

+Description: Send message level and message text to Design Environment.  + + +

getErrorMessage

+Description: Get error message from prior callback.  + + +

getWarningCount

+Description: Return count of how many potentially incompatible API calls have been made.  + + +

end

+Description: Terminate connection to the Design Environment.  + + +

setVendorExtensions

+Description: Set vendor extensions. NOTE: This call is only supported for elements within a spirit:design.  + + +

setVendorAttribute

+Description: Set vendor defined attribute on the given element  + + +

setValue

+Description: Set the value of a parameterID, fileDefineIDs or argumentIDs.  + +

+
+

Port Operations

+
+ +

getPortStyle

+Description: Returns 'wire' or 'transactional' to indicate the port style  + + +

getAllLogicalDirectionsAllowed

+Description: Get the value of the allLogicalDirectionAllowed attribute- New in 1.5 + + +

getPortDirection

+Description: Direction of the port  + + +

getPortRange

+Description: List of the left and right range of the port  + + +

getPortWireTypeDefIDs

+Description: List of typeDefs for a wire portID- New in 1.5 + + +

getPortTransactionalTypeDefID

+Description: The type definition for a transactional portID- New in 1.5 + + +

getPortServiceID

+Description: ID of element representing the service of a transactional port  + + +

getPortAccessType

+Description: Indicates the access type for this port- Modified in 1.5 + + +

getPortAccessHandle

+Description: Alternate name to be used when accessing this port- Modified in 1.5 + + +

getPortMaxAllowedConnections

+Description: Max allowed connections for this transactional port  + + +

getPortMinAllowedConnections

+Description: Min allowed connections for this transactional port  + + +

getPortDefaultValue

+Description: Default value of the port, if not set returns ""  + + +

getPortClockDriverID

+Description: Element ID of clock driver element, if present  + + +

getClockDriverPeriod

+Description: Clock period of the given clock  + + +

getClockDriverPeriodUnits

+Description: Units of the clock period of the given clock- New in 1.5 + + +

getClockDriverPulseOffset

+Description: Clock pulse offset of the given clock  + + +

getClockDriverPulseOffsetUnits

+Description: Units of the clock pulse offset of the given clock- New in 1.5 + + +

getClockDriverPulseValue

+Description: Clock pulse value of the given clock  + + +

getClockDriverPulseDuration

+Description: Clock period of the given clock  + + +

getClockDriverPulseDurationUnits

+Description: Units of the clock pulse duration of the given clock- New in 1.5 + + +

getClockDriverName

+Description: Name of the clock driver  + + +

getClockDriverSource

+Description: Source name of the clock driver  + + +

getPortSingleShotDriverID

+Description: Element ID of single shot driver element, if present  + + +

getPortSingleShotPulseOffset

+Description: Clock pulse offset of the port  + + +

getPortSingleShotPulseValue

+Description: Clock pulse value of the port  + + +

getPortSingleShotPulseDuration

+Description: Clock period of the port  + + +

getPortConstraintSetIDs

+Description: List of constraint sets IDs of the port  + + +

setPortRange

+Description: Set left/right range for the given port.  + + +

setPortDefaultValue

+Description: Set default value of the given port.  + + +

setClockDriverPeriod

+Description: Set period of the given clock port.  + + +

setClockDriverPulseOffset

+Description: Set pulse offset value of the given clock port.  + + +

setClockDriverPulseValue

+Description: Set pulse value of the given clock port.  + + +

setClockDriverPulseDuration

+Description: Set pulse duration of the given clock port.  + + +

setPortSingleShotPulseOffset

+Description: Set pulse offset of given single shot port.  + + +

setPortSingleShotPulseValue

+Description: Set pulse value of given single shot port.  + + +

setPortSingleShotPulseDuration

+Description: Set pulse duration of given single shot port.  + +

+
+

Register File Operations

+
+ +

getRegisterFileDimensions

+Description: Dimensions of a register file array.- New in 1.5 + + +

getRegisterFileAddressOffset

+Description: The offset from the base address.- New in 1.5 + + +

getRegisterFileRange

+Description: The register file range in number of addressable units.- New in 1.5 + + +

setRegisterFileRange

+Description: Set the register file range in addressable units.- New in 1.5 + + +

getRegisterFileRegisterIDs

+Description: List of IDs for the registers of the given register file- New in 1.5 + + +

getRegisterFileRegisterFileIDs

+Description: List of IDs for the register files of the given register file- New in 1.5 + +

+
+

Register Operations

+
+ +

getRegisterDimensions

+Description: Dimensions of a register array.  + + +

getRegisterAddressOffset

+Description: The offset from the base address.  + + +

getRegisterAlternateRegisterIDs

+Description: List of IDs for the alternate registers of the given register- New in 1.5 + + +

getRegisterAccess

+Description: The accessibility of the data in the register  + + +

getRegisterSize

+Description: The register size in bits.  + + +

setRegisterSize

+Description: Set the register size in bits.  + + +

getRegisterVolatility

+Description: Indicates whether or not the data is volatile.- Modified in 1.5 + + +

getRegisterResetValue

+Description: Register value at reset.- Modified in 1.5 + + +

setRegisterResetValue

+Description: Set register value at reset.- Modified in 1.5 + + +

getRegisterResetMask

+Description: Mask to be ANDed with the value before comparing to reset value.- Modified in 1.5 + + +

setRegisterResetMask

+Description: Set the mask to be ANDed with the value before comparing to reset value.- Modified in 1.5 + + +

getRegisterFieldIDs

+Description: List of IDs for the fields of the given register- Modified in 1.5 + + +

getRegisterAlternateGroups

+Description: Indicates the group names for an alternate register.- New in 1.5 + +

+
+

Remap Operations

+
+ +

getRemapStatePortIDs

+Description: List of remap port IDs of a remap state  + + +

getRemapStatePortPortID

+Description: Port ID for the remap state  + + +

getRemapStatePortPortIndex

+Description: Index of the port if a vector for the remap state  + + +

getRemapStatePortPortValue

+Description: Value of the port for the remap state  + +

+
+

Service Operations

+
+ +

getAbstractionDefServiceInitiative

+Description: Port service initiative from the abstraction definition  + + +

getAbstractionDefServiceIDs

 +Description: List of typeDefs for an abstractionServiceID- Invalid in 1.5 + + +

getAbstractionDefAbstractionServiceTypeDefIDs

+Description: List of type definitions for an abstractionServiceID- New in 1.5 + + +

getServiceInitiative

+Description: Initiative of the service  + + +

getServiceTypeDefIDs

+Description: List of typeDefs for a serviceID- Modified in 1.5 + +

+
+

TypeDef Operations

+
+ +

getTypeDefTypeName

+Description: Name of the type- Modified in 1.5 + + +

getTypeDefConstrained

+Description: Is the type name constrained- Modified in 1.5 + + +

getTypeDefImplicit

+Description: Is the type name implicit- Modified in 1.5 + + +

getTypeDefTypeDefinitions

+Description: List of type definition for the given type- Modified in 1.5 + + +

getTypeDefTypeViewIDs

+Description: List of type viewIDs for the given type- Modified in 1.5 + +

+
+

View Operations

+
+ +

getViewDesignID

+Description: ID of the design associated with a hierarchical view  + + +

getViewEnvIdentifiers

+Description: List of environment identifiers of the view  + + +

getViewLanguage

+Description: View Language  + + +

getViewLanguageIsStrict

+Description: Value of 'strict' attribute on view language element  + + +

getViewModelName

+Description: Get the model name for this view  + + +

getViewDefaultFileBuilderIDs

+Description: List of default file builder IDs of the view  + + +

getViewFileSetIDs

+Description: List of fileSet IDs for fileSets referenced by the view  + + +

getViewPortConstraintSetIDs

+Description: Constraint set ID for the port referenced by the view- Modified in 1.5 + + +

getViewWhiteboxElementRefIDs

+Description: List of whitebox element reference IDs of the view  + +

+
+

Whitebox Operations

+
+ +

getWhiteboxElementRefID

+Description: White box element reference ID  + + +

getWhiteboxRefPathIDs

+Description: List of path IDs of the white box element reference  + + +

getWhiteboxRefPathName

+Description: Name of the whitebox reference path element  + + +

getWhiteboxRefPathRange

+Description: List of left and right range of the whitebox reference path element  + + +

getWhiteboxElementType

+Description: Type of the whitebox element  + + +

getWhiteboxElementDrivable

+Description: Indicates whether or not the whitebox element is drivable  + + +

getWhiteboxElementRegisterID

 +Description: Register reference ID of the whitebox element- Invalid in 1.5 + + +

getWhiteboxElementRegisterIDs

+Description: Register reference IDs of the whitebox element- New in 1.5 + +
+

All ID Types

+
+

+Each item is a link to a function call that can return this type of ID. If there is more than one function then the return variable will be a link to the second function in the list, and so on. The last function in the list will be a BOLD link and will return to the first function. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
abstractionDefIDabstractionDefPortIDabstractionDefPortModeConstraintIDabstractionDefPortModeID
abstractionServiceIDabstractionServiceTypeDefIDabstractorIDabstractorInstanceID
adHocConnectionIDadHocExternalPortReferenceIDadHocInternalPortReferenceIDaddressBlockID
addressBlockUIDaddressSpaceIDaddressSpaceUIDalternateRegisterID
alternateRegisterUIDargumentIDargumentUIDbankID
bankUIDbridgeIDbusdefIDchannelID
choiceEnumerationIDchoiceIDclockDriverIDclockDriverUID
componentIDcomponentInstanceIDcpuIDdesignID
driveConstraintIDelementIDexecutableImageIDexecutableImageUID
fileBuilderIDfileBuilderUIDfileDefineIDfileDefineUID
fileIDfileSetGroupIDfileSetIDfileUID
functionIDfunctionSourceFileIDfunctionUIDgeneratorID
hierConnectionIDinterconnectionIDinterfaceIDinterfacePortMapID
interfaceUIDlinkerCommandFileIDlinkerCommandFileUIDloadConstraintID
localMemoryMapIDmemoryMapElementIDmemoryMapIDmemoryRemapID
monitorInterconnectionIDparameterIDparameterUIDportConstraintSetID
portIDportMapIDportMapUIDportUID
regFieldIDregFieldUIDregFieldValueIDregisterFileID
registerFileUIDregisterIDregisterUIDremapAddressID
remapStateIDremapStatePortIDsegmentIDsegmentUID
serviceIDserviceTypeDefIDsingleShotDriverIDsingleShotDriverUID
subspaceMapIDsubspaceMapUIDtimingConstraintIDtransactionalTypeDefID
typeDefIDviewIDwhiteboxElementIDwhiteboxRefID
whiteboxRefPathIDwireTypeDefID
+ + diff --git a/ipxact-1.5/TGI/TGI.wsdl b/ipxact-1.5/TGI/TGI.wsdl new file mode 100644 index 0000000..702a404 --- /dev/null +++ b/ipxact-1.5/TGI/TGI.wsdl @@ -0,0 +1,11320 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + SPIRIT URI, like a standard xsd:anyURI except that it can contain environment variables in the ${ } form, to be replaced by their value to provide the underlying URI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ipxact-1.5/TGI/TGI.xml b/ipxact-1.5/TGI/TGI.xml new file mode 100644 index 0000000..59c93d9 --- /dev/null +++ b/ipxact-1.5/TGI/TGI.xml @@ -0,0 +1,2723 @@ + + + + + + + get ID of the current or top design + + The ID of the current design or the top design if the 'top' argument is true. + + + + + Vendor Library Name Version of the design + + + + + components instances IDs of the given design + + + + + return the component instance ID of the named component instance in the given design + + + + + + List of interconnection element IDs + + + + + Returns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRef + + + 1.5 + + + List of abstractor instances IDs for this interconnection + + + + + + List of monitorInterconnection element IDs + + + + + Returns the active interface and monitor interfaces as a list in componentPathRef, componentRef, componentInterface, monitorPathRef, monitorRef, monitorInterface format, the active interface comes first in the list. + + + 1.5 + + + List of ad-hoc connection element IDs + + + + + Get the tied value for an ad-hoc connection + + + + + List of internal ad-hoc port reference element IDs + + + + + List for an internal connection containing the componentRef, portRef, left, and right attribute values + + + + + List of external ad-hoc port reference element IDs + + + + + List for an external connection containing the portRef, left, and right attribute values + + + + + List of hierarchical connection element IDs + + + + + List containing the interface name, component reference, and interface reference + + + + + + Instance name of the component + + + + + Vendor Library Name Version of the component (from the design file) + + + + + ID for the component associated with given instance (crossing from design to component file) + + + + + Return the component XML in text format. Schema version is DE dependent. + + + + + + Instance name of the abstractor + + + + + Vendor Library Name Version of the abstractor (from the design file) + + + + + ID for the abstractor associated with given instance (crossing from design configuration to abstractor file) + + + + + Return the abstractor XML in text format. Schema version is DE dependent. + + + + + + List of VLNV of the bus definition + + + + + List of VLNV of the abstraction definition + + + + + Mode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor + + + + + list of interface port map IDs + + + + + list of the logical and physical port map IDs + + + + + list of left and right range of the port map + + The return array value is in the format of logical vector left, right, physical vector left, right + + + + + + + + + ID of the master addressSpace + + + + + Base address of the master addressSpace + + + + + + + + ID of the memoryMap referenced from a slave interface + + + + + List of slave bridge IDs + + + + + The slave interface master interface reference ID + + + + + Value of the opaque attribute + + + + + List of fileSetGroup IDs + + + + + Name of file set group + + + + + list of file set IDs in this file set group + + + + + Group name of a system, mirroredSystem, or monitor bus interface + + + + + List of remap address IDs of the mirrored slave interface + + + + + remap address of the given remap address element + + + + + remap state ID of the given remap address element + + + + + The address range of the mirrored slave interface + + + + + Indicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave + + + + + connection required for this bus interface + + + + + Bit steering description of the bus interface: on or off + + + + + + + + the endianess of the bus interface, big or little. The default is little. + + + + + the number bits in the least addressable unit. If none exists, the default 8 bits is returned. + + + + + + get the mode that the abstractor can be master, slave, direct or system. + + + + + List of VLNV of the bus definition + + + + + List of 2 interface IDs + + + + + a list of model view IDs + + + + If true returns only the view configured by a designConfiguration. If false returns all views. + + 1.5 + + + a list of abstractor model port IDs + + + + + a list of model parameter IDs + + + + Restrict returned parameters to those that match the given usageType. nontyped or typed or all if not specified. + + + + list of generator IDs of the abstractor + + + + + list of choices IDs + + + + + list of file set IDs + + + + + + Vendor Library Name Version of the component (from the component file) + + + + + Returns the name of the XML element associated with the component (currently only 'component'). This call is being provided to cover a future scenario where there can be different types of component elements instantiated in a design (e.g. macroComponent elements). + + + + + list of busInterface IDs in this channel + + + + + list of IDs for the logical address spaces in the component. + + + + + a list of remap state IDs + + + + + a list of model view IDs + + + + If true returns only the view configured by a designConfiguration or NULL if not configured. If false returns all views. + + + + List of interface IDs + + + + + a list of channel IDs + + + + + a list of component model port IDs + + + + + a list of model parameter IDs + + + + Restrict returned parameters to those that match the given usageType. nontyped or typed or userdefined or all if not specified. + + + + list of generator IDs of the component + + + + + list of choices IDs + + + + + list of file set IDs + + + + + list of whitebox element IDs of the component + + + + + list of cpu IDs of the component + + + + + list of address space reference IDs of the cpu + + + + + list of clock driver IDs of the component + + + + + + dimensions of a register file array. + + + 1.5 + + + the offset from the base address. + + + 1.5 + + + the register file range in number of addressable units. + + + + + + 1.5 + + + set the register file range in addressable units. + + + + 1.5 + + + list of IDs for the registers of the given register file + + + 1.5 + + + list of IDs for the register files of the given register file + + + 1.5 + + + + dimensions of a register array. + + + + + the offset from the base address. + + + + + list of IDs for the alternate registers of the given register + + + 1.5 + + + the accessibility of the data in the register + + + + + + + + the register size in bits. + + + + + + + + set the register size in bits. + + + + + + indicates whether or not the data is volatile. + + returns "true", "false" or "". + + + + + + 1.5 + + + register value at reset. + + + + + + + + 1.5 + + + set register value at reset. + + + + + + + 1.5 + + + mask to be ANDed with the value before comparing to reset value. + + + + + + + + 1.5 + + + set the mask to be ANDed with the value before comparing to reset value. + + + + + + + 1.5 + + + list of IDs for the fields of the given register + + + + + + + 1.5 + + + + indicates the group names for an alternate register. + + + 1.5 + + + + bit offset of the fields LSB inside the register. + + + + + width of the field in bits. + + + + + + + + set the width of the field in bits. + + + + + + indicates whether or not the data is volatile. The presumed value is 'false' if the element is not present. + + returns "true" or "false" + + + 1.5 + + + the accessibility of the data in the field. + + + + + list of IDs for field values for the given register field. + + + + + enumerated bit field usage. + + + 1.5 + + + enumerated bit field value. + + + + + Enumerated name for this register field value. Deprecated - use getName. + + + + + + The modified write value for the field + + one of "", "onetoClear", "oneToSet", "oneToToggle", "zeroToClear", "zeroToSet","zeroToToggle", "clear", "set" or "modified" + + + 1.5 + + + the write value constraint is write as read. + + + 1.5 + + + the write value constraint shall use the enumerated values. + + + 1.5 + + + the value of a write constraint. + + array of minimum and maximum or zero element array if not specified + + + 1.5 + + + The read action for the field + + one of "", "clear", "set" or "modify" + + + 1.5 + + + true if the field can be tested with a simple register test. + + + 1.5 + + + the test constraint required if the field can be tested with a simple register test. + + + 1.5 + + + + list of remap port IDs of a remap state + + + + + port ID for the remap state + + + + + index of the port if a vector for the remap state + + + + + value of the port for the remap state + + + + + + the address range of an address block expressed as the number of accessable and addressable units. + + + + + + + + the bit width of an address block. + + + + + + + + the ID for the local memory map of the address space. + + + 1.5 + + + list of IDs for address block segments for the address space. + + + 1.5 + + + the address offset of an address space segment in an address space + + + + + + 1.5 + + + set the address offset of an address space segment expressed in the number addressable units. + + + + 1.5 + + + the address range of an address space segment expressed as the number of accessable addressable units. + + + + + + 1.5 + + + set the address range of an address space segment expressed as the number of accessable addressable units. + + + + 1.5 + + + the number bits in an addressable unit. If none exists, the default 8 bits is returned. + + + + + the IDs of the executable images belonging to the specified address space. + + + + + the type of the executable image if existent. + + + + + the linker command for the current executable image. + + + + + + + + the flags of the current executable image linker command. + + + + + + + + element ID of linkerCommandFile associated with given executable image. + + + + + list of default file builder IDs of the executable image + + + + + the group of file set reference IDs complying with the tool set of the current executable image. + + + + + the name of the linker command file. + + + + + + + + the command line switch to specify with the linker command file. + + + + + + + + indicates whether or not to generate and enable the linker command file. + + + + + + + + reference IDs to the generator elements for generating the linker command file. + + + + + List of element IDs (addressBlockID, bankID, subspaceMapID) within a memory map, memory remap, local memory map, or bank + + + + + + + + + + + + 1.5 + + + Indicates type of memory map element: addressBlock, bank or subspaceMap + + The return value is one of "addressBlock", "bank", "subspaceMap" or "" for unknown + + + + + + + + + the number bits in an addressable unit for a memory map. If none exists, the default 8 bits is returned. + + + + + the base address of an address block + + + + + + + + the address range of an address block expressed as the number of accessable and addressable units. + + + + + + + + the bit width of an address block in the local memory map. + + + + + + + + indicates the usage of this address block. + + one of "memory", "register", "reserved" or "" if not set. + + + + + indicates whether or not the data is volatile. + + returns "true", "false" or "". + + + + + the accessibility of the data in the local address block. + + + + + the IDs of the available registers in the address block. + + + + + the IDs of the available register files in the address block. + + + 1.5 + + + indicates the type identifier of an addressBlock, registerFile, register or field. + + + + + + + + + 1.5 + + + the bank alignment value, serial or parallel + + + + + the base address of an address bank + + + + + + + + indicates the usage of this address bank. + + + + + indicates whether or not the data is volatile. + + returns "true", "false" or "". + + + + + the accessibility of the data in the local address bank. + + + + + master bus interface ID on the other side of a bus bridge . + + + + + address space segment ID on the other side of a bus bridge . + + + 1.5 + + + the base address of a memory subspace + + + + + + + + List of IDs for memory map elements in the given component + + + + + List of IDs for memory map 'remap' elements of the given memory map + + + + + Remap State ID for which this remap is applicable + + + + + + ID of the design associated with a hierarchical view + + + + + list of environment identifiers of the view + + + + + view Language + + + + + value of 'strict' attribute on view language element + + + + + get the model name for this view + + + + + list of default file builder IDs of the view + + + + + list of fileSet IDs for fileSets referenced by the view + + + + + constraint set ID for the port referenced by the view + + + + 1.5 + + + list of whitebox element reference IDs of the view + + + + + + Returns 'wire' or 'transactional' to indicate the port style + + + + + get the value of the allLogicalDirectionAllowed attribute + + + 1.5 + + + direction of the port + + + + + list of the left and right range of the port + + array of left and right or zero element array if not specified + + + + + list of typeDefs for a wire portID + + + 1.5 + + + the type definition for a transactional portID + + + 1.5 + + + ID of element representing the service of a transactional port + + + + + indicates the access type for this port + + + 1.5 + + + Alternate name to be used when accessing this port + + + 1.5 + + + max allowed connections for this transactional port + + + + + min allowed connections for this transactional port + + + + + default value of the port, if not set returns "" + + + + + + + + element ID of clock driver element, if present + + + + + clock period of the given clock + + + + + + + + units of the clock period of the given clock + + + 1.5 + + + clock pulse offset of the given clock + + + + + + + + units of the clock pulse offset of the given clock + + + 1.5 + + + clock pulse value of the given clock + + + + + + + + clock period of the given clock + + + + + + + + units of the clock pulse duration of the given clock + + + 1.5 + + + name of the clock driver + + + + + source name of the clock driver + + + + + element ID of single shot driver element, if present + + + + + clock pulse offset of the port + + + + + clock pulse value of the port + + + + + clock period of the port + + + + + + + + list of constraint sets IDs of the port + + + + + + name of the type + + + + + + + + 1.5 + + + is the type name constrained + + + + + + + 1.5 + + + is the type name implicit + + + + + + 1.5 + + + list of type definition for the given type + + + + + + + 1.5 + + + list of type viewIDs for the given type + + + 1.5 + + + + port service initiative from the abstraction definition + + + + + list of typeDefs for an abstractionServiceID + + + 1.5 + + + list of type definitions for an abstractionServiceID + + + 1.5 + + + initiative of the service + + + + + list of typeDefs for a serviceID + + + 1.5 + + + + reference name of the given port constraint set + + + + + list of the left and right range of a port referenced by this constraint set + + + + + list of drive constraint IDs of the port + + + + + list of load constraint IDs of the port + + + + + list of timing constraint IDs of the port + + + + + indicates the type of drive constraint: function class + + + + + Returns the drive constraint. Format depends on the constraint type. + + + + + indicates the type of load constraint: function class + + + + + Returns the load constraint. Format is cell function and strength or cell class and strength. + + + + + Returns the load constraint count, the number of loads. + + + + + indicates the clock name, clock edge, and delay type + + + + + Returns the timing constraint value (cycle time percentage). + + + + + + Get name of the given fileID. + + + + + + + True=DE shall return an absolute file path, False=actual XML text returned + + + + fileType or userFileType of the file builder + + + + + command of the file builder + + + + + + + + flags of the file builder + + + + + + + + value of the replaceDefaultFlags element of the file builder + + + + + + + + list of group names of the file set + + + + + list of file IDs of the file set + + + + + fileType or userFileType of the file + + + + + indicates that the given file is an include file + + + + + indicates that the file includes external declarations required by the top-level netlist file + + + + + logical name of the file + + + + + default attribute of logical name of the file + + + + + list of exported names of the file + + + + + name of the build command of the file + + + + + + + + flags of the file build command + + + + + + + + value of append attribute on the flag element + + + + + indicates whether or not to replace default flags + + + + + + + + target name of the file build command + + + + + + + + list of dependent locations for the file, typically directories + + + + + list of define symbol IDs used in the file + + + + + list of image types of the file + + + + + list of file builder IDs used for this fileSet + + + + + list of dependent locations for the fileSet, typically directories + + + + + list of function IDs + + + + + value of replicate attribute on function element + + + + + entry point of the function + + + + + file ID containing the function entry point + + + + + return type of the function + + + + + list of argument IDs of the function of the file set + + + + + data type of the argument + + + + + indicates whether or not the function is disabled + + + + + + + + list of source file IDs of the function of the file set + + + + + name of the source file + + + + + fileType or userFileType of the source file + + + + + + white box element reference ID + + + + + list of path IDs of the white box element reference + + + + + Name of the whitebox reference path element + + + + + list of left and right range of the whitebox reference path element + + + + + type of the whitebox element + + + + + indicates whether or not the whitebox element is drivable + + + + + register reference ID of the whitebox element + + + 1.5 + + + register reference IDs of the whitebox element + + + 1.5 + + + + scope of the generator + + + + + value of hidden attribute on the generator + + + + + phase number of the generator + + + + + api type of the generator + + + + + executable name associated with the generator + + + + + List of group names of the generator + + + + + list of transport methods of the generator + + + + + + ID for the bus definition with the given VLNV + + + + + Vendor Library Name Version of the bus definition + + + + + indicates whether or not the bus definition supports direct connections + + + + + indicates whether or not the bus definition is an addressable bus + + + + + Vendor Library Name Version of the bus definition being extended + + + + + maximum # of masters supported by this bus definition + + -1 indicates unbounded + + + + + maximum # of slaves supported by this bus definition + + -1 indicates unbounded + + + + + list of system group names for this bus definition + + + + + + ID for the abstraction definition with the given VLNV + + + + + Vendor Library Name Version of the abstraction definition + + + + + get VLNV of the bus definition + + + + + Vendor Library Name Version of the abstraction definition being extended + + + 1.5 + + + List of abstraction definition port element IDs + + + + + logical name of this abstraction definition port + + + + + does this port require a driver + + + + + required driver type for this port + + + + + Returns 'wire' or 'transactional' to indicate the port style + + + + + is this port an address port + + + + + is this port a data port + + + + + is this port a clock port + + + + + is this port a reset port + + + + + Returns an ID for accessing the given port in the given interface mode + + + modeValue should be one of master, slave or system + + + 1.5 + + + Returns an array of IDs for accessing the given port in the given interface mode. The array shall only contain one element if the modeValue input is master or slave. The array may contain multiple elements for modeValue system. + + + modeValue should be one of master, slave or system + + + 1.5 + + + group name when present on a system interface + + + + + bit width constraint when present on an interface of the given type + + a return value of 0 indicates unbounded + + + + + port direction constraint when present on an interface of the given type + + + + + list of constraint IDs for a non-mirrored port + + + + + list of constraint IDs for a mirrored port + + + + + list of drive constraint IDs of the port + + + + + list of load constraint IDs of the port + + + + + list of timing constraint IDs of the port + + + + + default value for port when not connected + + + + + existence requirement for this port on an interface of the given type + + + + + abstractionDef service IDs on a transactional port + + + 1.5 + + + abstractionDef service ID on a transactional port + + + 1.5 + + + + Returns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + get vendor defined attribute from the given element + + + + + + + + + + + + list of parameter IDs from the given element (any which contains spirit:parameter elements) + + + + + + + + + + + + + + + + + + + + + + + + + Get the value of a parameterID, fileDefineIDs or argumentIDs. + + + + + + + + + + + + + Returns the value of the given attribute name on the elementID/value element + + + + + + + + This is a namespace qualified attribute + + + + data type of the model parameter + + + + + usage type of the model parameter + + possible values are nontyped and typed + + + + + Return the value of the spirit:id attribute on a ID + + + + + + + + + + + + 1.5 + + + Return the name of the specified element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1.5 + + + Return the description of the specified element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1.5 + + + Return the displayName of the specified element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1.5 + + + Return the unconfigured ID from a configured ID + + Unconfigured ID + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1.5 + + + name of the choice + + + + + list of choice enumeration IDs of the choice + + + + + value of the enumeration element + + + + + value of the enumeration text attribute + + + + + value of the enumeration help attribute + + + + + Indicate to DE where the file resides for the IP-XACT element with the given VLNV. + + True=VLNV registered, False=VLNV not registered + + + + True=always register, False=do not register if the VLNV already exists + + + + Return XML of the IP-XACT object identified by the given VLNV. + + + + + ID for the component instance associated with the currently invoked generator + + + Generator name for use within DE in case of errors + + + + API initialization function. Must be called before any other API call. + + + Indicates the API version the generator is defined to work with. + + + Compatability failure mode: fail -- DE should return an error on the init call if it's API version does not match the one passed to the init call, error -- DE should return an error each time a potentially incompatible API call is made, warning -- DE should increment a warning count each time a potentially incompatible API call is made + + + Message which the DE may display to the user. + + + + Send message level and message text to Design Environment. + + + + + + Get error message from prior callback. + + + ID string for debugging calls to this command within the DE. Any value is okay. + + + + Return count of how many potentially incompatible API calls have been made. + + + ID string for debugging calls to this command within the DE. Any value is okay. + + + + Terminate connection to the Design Environment. + + Status indicator from the DE. Non-zero implies an error. + + + Status indicator from the generator. Non-zero implies an error. + + + Message which the DE may display to the user. + + + + + + Set left/right range of an interface port map. + + + + + + + Set base address of the master bus interface. + + + + + + Set remap address value for the associated interface. + + + + + + Set address range for the associated interface. + + + + + + Set bus interface bit steering value. + + + + + + + Set name of the given file. + + + + File name may be not be a relative path. + + + + Set command name for the given file builder. + + + + + + Set command flags for the given file builder. + + + + + + Set replace default flags for the given file builder. + + + + + + Set target name for build command for the given file + + + + + + Set command associated with file builder. + + + + + + Set flags associated with the given file builder. + + + + + + Set value of replace default flags in file builder. + + + + + + Set disable flag on function. + + + + + + + Set left/right range for the given port. + + + + + + Set default value of the given port. + + + + + + Set period of the given clock port. + + + + + + Set pulse offset value of the given clock port. + + + + + + Set pulse value of the given clock port. + + + + + + Set pulse duration of the given clock port. + + + + + + Set pulse offset of given single shot port. + + + + + + Set pulse value of given single shot port. + + + + + + Set pulse duration of given single shot port. + + + + + + + Add new component instance. + + Element ID of the newly added component instance. + + + + + + + + + Remove specified component instance. + + + + + Replace specified component with new provided component. + + + + + + + Append a new abstractor instance to the interconnection. + + Element ID of the newly added abstractor instance. + + + + + + + + + + Remove specified abstractor instance. + + + + + Replace specified abstractor with new provided abstractor. + + + + + + + Add new interconnection between components. + + Element ID of the newly added interconnection. + + + + The component instance name. + + + + The component instance name. + + + + + + + + Remove interconnection between components, and any abstractors if present. + + + + The component instance name. + + + + The component instance name. + + + + + Add new interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element. + + Element ID of the new/modified monitor interconnection. + + + The design that contains the interconnection. + + + The component instance name. + + + + The component instance name with the monitor interface. + + + + + + + + Add new hierarchical interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element. + + Element ID of the new/modified monitor interconnection. + + + The design that contains the interconnection. + + + The instance name path to the design that contains the component instance. + + + The component instance name. + + + + The instance name path to the design that contains the monitor instance. + + + The component instance name with the monitor interface. + + + + + + 1.5 + + + Remove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed. + + + + The component instance name. + + + + The component instance name with the monitor interface. + + + + + Remove a hierarchical interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed. + + + + The instance name path to the design that contains the component instance. + + + The component instance name. + + + + The instance name path to the design that contains the monitor instance. + + + The component instance name with the monitor interface. + + + 1.5 + + + Add new hierarchical connection. + + Element ID of the newly added hierarchical connection. + + + + + + + + Remove existing hierarchical connection. + + + + + + + Add new ad-hoc connection. + + Element ID of the newly added ad hoc connection. + + + + + + + + + + + Tied value for this connection, if blank no tied value. + + + + Add an internal port reference to an existing ad-hoc connection. An identical port reference must not already exist in the ad-hoc connection. + + Element ID of the newly added internal port reference. + + + + + + + + + + Add an external port reference to an existing ad-hoc connection. + + Element ID of the newly added external port reference. + + + + + + + + + Remove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed. + + + + + + + + Remove an external port reference from existing ad-hoc connection. + + + + + + + + set the address range of an address block expressed as the number of accessable and addressable units. + + + + + + set the bit width of an address block. + + + + + + set the linker command for the current executable image. + + + + + + set the flags of the current executable image linker command. + + + + + + set the name of the linker command file. + + + + + + set the command line switch to specify with the linker command file. + + + + + + set whether or not to generate and enable the linker command file. + + + + + + set the base address of an address block + + + + + + set the address range of an address block expressed as the number of accessable and addressable units. + + + + + + set the bit width of an address block + + + + + + set the base address of an address bank + + + + + + set the base address of a memory subspace + + + + + + + Set vendor extensions. NOTE: This call is only supported for elements within a spirit:design. + + + + + + + + Complete vendor extension text as a well formed XML document with top-level element of spirit:vendorExtensions + + + + set vendor defined attribute on the given element + + + + + + + + + + + + + Set the value of a parameterID, fileDefineIDs or argumentIDs. + + + + + + + + + diff --git a/ipxact-1.5/TGI/TGI.xsd b/ipxact-1.5/TGI/TGI.xsd new file mode 100644 index 0000000..3045348 --- /dev/null +++ b/ipxact-1.5/TGI/TGI.xsd @@ -0,0 +1,154 @@ + + + + + + + + List of API callbacks + + + + + + Defines a single callback in the API. The name attribute defines the callback name and the group attribute is used to group similar calls in the generated documentation. + + + + + + Description of the callback. + + + + + Defines the callback output. The argument type defaults to xsd:string if not specified. The argument name defaults to [type]Value where [type] is the argType value with the namespace designator removed. + + + + + + Description of the output argument. + + + + + + + + + + + + + + + + Defines a callback input argument. The argument type defaults to xsd:string if not specified. The argument name defaults to [type]Value where [type] is the argType value with the namespace designator removed. + + + + + + Description of the input argument. + + + + + List of compatible ID type for the input agrument. + + + + + Name of the compatible ID + + + + + Type of the compatible ID + + + + + + + + Name of the argument + + + + + Argument type, xsd:string(default), xsd:boolean , xsd:integer, xsd:float, xsd:positiveInteger, ... + + + + + + + Specifies the API version at which this API call was modified. The modificationType attribute indicates the type of change. Valid changes types include: new -- implying an API call added in the specified version of the API, invalid -- implying that the specified call has been invalidated as of the specified version of the API, and modified -- implying that the API call functionality has been chagned as of the specified version of the API. + + + + + + + + + + + + + + + + + + + + + + Name of the SOAP message + + + + + Group category for documentation organization. + + + + + Configurable value returned + + + + + + + + diff --git a/ipxact-1.5/abstractionDefinition.xsd b/ipxact-1.5/abstractionDefinition.xsd new file mode 100644 index 0000000..61b82cd --- /dev/null +++ b/ipxact-1.5/abstractionDefinition.xsd @@ -0,0 +1,364 @@ + + + + + + + + + + + If this element is present, the existance of the port is controlled by the specified value. valid values are 'illegal', 'required' and 'optional'. + + + + + + + + + + + + The service that this transactional port can provide or requires. + + + + + If this element is present, the type of access is restricted to the specified value. + + + + + + + + + + + + Defines the name of the transactional interface type. + + + + + + + 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 + + + + + + + + + + + + Group of elements used in a transactional port. + + + + + + The service that this transactional port can provide or requires. + + + + + + + Group of elements used in a wire port. + + + + + + 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. + + + + + 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. + + + + + + + + + + + + + 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. + + + + + Specifies default constraints for the enclosing wire type port when it appears in a mirrored-'mode' bus interface. + + + + + + + + Define the ports and other information of a particular abstraction of the bus + + + + + + + Reference to the busDefinition that this abstractionDefinition implements. + + + + + 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 + + + + + This is a list of logical ports defined by the bus. + + + + + + + + + The assigned name of this port in bus specifications. + + + + + + + Port style. + + + + A port that carries logic or an array of logic values + + + + + + 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 + + + + + + + If this element is present, the port contains address information. + + + + + If this element is present, the port contains data information. + + + + + + If this element is present, the port contains only clock information. + + + + + Is this element is present, the port contains only reset information. + + + + + + + + Defines constraints for this port when present in a system bus interface with a matching group name. + + + + + + Used to group system ports into different groups within a common bus. + + + + + + + + + Defines constraints for this port when present in a master bus interface. + + + + + + + + Defines constraints for this port when present in a slave bus interface. + + + + + + + + + Indicates the default value for this wire port. + + + + + + + + + + A port that carries complex information modeled at a high level of abstraction. + + + + + + The type of information this port carries A transactional port can carry both address and data information. + + + + + + If this element is present, the port contains address information. + + + + + If this element is present, the port contains data information. + + + + + + + + Defines constraints for this port when present in a system bus interface with a matching group name. + + + + + + Used to group system ports into different groups within a common bus. + + + + + + + + + Defines constraints for this port when present in a master bus interface. + + + + + + + + Defines constraints for this port when present in a slave bus interface. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ipxact-1.5/abstractor.xsd b/ipxact-1.5/abstractor.xsd new file mode 100644 index 0000000..eb3f030 --- /dev/null +++ b/ipxact-1.5/abstractor.xsd @@ -0,0 +1,188 @@ + + + + + + + + + + + + + Abstractor-specific extension to abstractorType + + + + + + 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 + + + + + + + Define the system group if the mode is set to system + + + + + + + + + The bus type of both interfaces. Refers to bus definition using vendor, library, name, version attributes. + + + + + The interfaces supported by this abstractor + + + + + + An abstractor must have exactly 2 Interfaces. + + + + + + + + Model information. + + + + + Generator list is tools-specific. + + + + + + + + + + + + This is the root element for abstractors + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Mode for this abstractor + + + + + + + + + diff --git a/ipxact-1.5/autoConfigure.xsd b/ipxact-1.5/autoConfigure.xsd new file mode 100644 index 0000000..7a61126 --- /dev/null +++ b/ipxact-1.5/autoConfigure.xsd @@ -0,0 +1,258 @@ + + + + + + + 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 scaledInteger number. bool means a boolean (true, false) is expected. float means a decimal floating point number is expected. long means an value of scaledInteger is expected. String means any text is acceptable. + + + + + + + + + + + + This is an indication on the format of the value for user defined properties. bitString means a double quoted string of 1's an 0's, the input maybe in this format or a scaledInteger number. A bitStringLength attribute is required for bitString formats. bool means a boolean (true, false) is expected. float means a decimal floating point number is expected. long means an value of scaledInteger is expected. String means any text is acceptable. + + + + + Length of the bit string, required if the format is bitString + + + + + Provides a string used to prompt the user for user-resolved property values. + + + + + For user-resolved properties with numeric values, this indicates the minimum value allowed. Only valid for formats long and float. + + + + + For user-resolved properties with numeric values, this indicates the maximum value allowed. Only valid for formats long and float + + + + + 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. + + + + + + + + + + + + Indicates the data type of the range attributes (minimum and maximum). For reasons of backward compatibility, this attribute is assumed to have the value 'float' if not present. + + + + + Indicates legal units for delay values. + + + + + + + + + For components with auto-generated configuration forms, the user-resolved properties with order attibutes will be presented in ascending order. + + + + + For user defined properties, refers the choice element enumerating the values to choose from. + + + + + Tags configurable properties so that they may be grouped together. Configurable properties with matching values for this attribute are contained in the same group. The format of this attribute is a string. There is no semantic meaning to this attribute. + + + + + Use this attribute group on boolean elements for which the schema supplies a default prompt attribute. + + + + + + + + Use this attribute group on boolean elements. + + + + + + + Use this attribute group on float elements for which the schema supplies a default prompt attribute. + + + + + + + + Use this attribute group on float elements. + + + + + + + Use this attribute group on long integer elements for which the schema supplies a default prompt attribute. + + + + + + + + Use this attribute group on long integer elements. + + + + + + + Use this attribute group on string elements for which the schema supplies a default prompt attribute. + + + + + + + + Use this attribute group on string elements. + + + + + + + For internal use only. + + + + + + + + + + + + Choices used by elements with an attribute spirit:choiceRef. + + + + + + Non-empty set of legal values for a elements with an attribute spirit:choiceRef. + + + + + + Choice key, available for reference by the spirit:choiceRef attribute. + + + + + One possible value of spirit:choice + + + + + + + When specified, displayed in place of the spirit:enumeration value + + + + + Text that may be displayed if the user requests help about the meaning of an element + + + + + + + + + + + + + diff --git a/ipxact-1.5/busDefinition.xsd b/ipxact-1.5/busDefinition.xsd new file mode 100644 index 0000000..c533fbf --- /dev/null +++ b/ipxact-1.5/busDefinition.xsd @@ -0,0 +1,131 @@ + + + + + + + + + + + + + + + + + + + Defines the structural information associated with a bus type, independent of the abstraction level. + + + + + + + This element indicates that a master interface may be directly connected to a slave interface (under certain conditions) for busses of this type. + + + + + If true, indicates that this is an addressable bus. + + + + + Optional name of bus type that this bus definition is compatible with. This bus definition may change the definitions in the existing bus definition + + + + + Indicates the maximum number of masters this bus supports. If this element is not present, the number of masters allowed is unbounded. + + + + + Indicates the maximum number of slaves this bus supports. If the element is not present, the number of slaves allowed is unbounded. + + + + + Indicates the list of system group names that are defined for this bus definition. + + + + + + Indicates the name of a system group defined for this bus definition. + + + + + + + + + + + + + + + diff --git a/ipxact-1.5/busInterface.xsd b/ipxact-1.5/busInterface.xsd new file mode 100644 index 0000000..f4d2ef4 --- /dev/null +++ b/ipxact-1.5/busInterface.xsd @@ -0,0 +1,671 @@ + + + + + + + + + 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"). + + + + + + + + + '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. + + + + + + + + + The number of bits in the least addressable unit. The default is byte addressable (8 bits). + + + + + Describes one of the bus interfaces supported by this component. + + + + + A list of bus interfaces supported by this component. + + + + + + + + + + Type definition for a busInterface in a component + + + + + + The bus type of this interface. Refers to bus definition using vendor, library, name, version attributes. + + + + + 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. + + + + + Indicates the usage mode of this instance of the bus interface. + + + + + Indicates whether a connection to this interface is required for proper component functionality. + + + + + Listing of maps between component ports and bus ports. + + + + + + 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. + + + + + + Logical port from abstraction definition + + + + + + Bus port name as specified inside the abstraction definition + + + + + Definition of the logical indecies for a vectored port. + + + + + + Defines which logical bit maps to the physical left bit below + + + + + + + + + + + + Defines which logical bit maps to the physical right bit below + + + + + + + + + + + + + + + + + + Physical port from this component + + + + + + Component port name as specified inside the model port section + + + + + + + + + + + + + + + + + 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"). + + + + + + + + + + + + '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. + + + + + + + + + + Indicates which system interface is being mirrored. Name must match a group name present on one or more ports in the corresonding bus definition. + + + + + Lists all channel connections between mirror interfaces of this component. + + + + + + Defines a set of mirrored interfaces of this component that are connected to one another. + + + + + + + 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. + + + + + + + + + + + + + + + Contains a list of remap state names and associated port values + + + + + + Contains a list of ports and values in remapPort and a list of registers and values that when all evaluate to true which tell the decoder to enter this remap state. The name attribute identifies the name of the state. If a list of remapPorts and/or remapRegisters is not defined then the condition for that state cannot be defined. + + + + + + + List of ports and their values that shall invoke this remap state. + + + + + + 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. + + + + + + + This attribute identifies a signal on the component which affects the component's memory layout + + + + + Index for a vectored type port. Must be a number between left and right for the port. + + + + + + + + + + + + + + + + + + Group of the different modes a busInterface can take on in a component + + + + + If this element is present, the bus interface can serve as a master. This element encapsulates additional information related to its role as master. + + + + + + If this master connects to an addressable bus, this element references the address space it maps to. + + + + + + + If the master's mapping to the physical address space is not zero based, the baseAddress element may be used to indicate the offset. If not specified the offset is 0. The baseAddress is in units of the addressSpace addressUnitBits + + + + Base of an address space. + + + + + + + + + + + + + + + + + + + + + If this element is present, the bus interface can serve as a slave. + + + + + + + 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. + + + + + The name of the master bus interface to which this interface bridges. + + + + + If true, then this bridge is opaque; the whole of the address range is mappeed by the bridge and there are no gaps. + + + + + + + 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. + + + + + + Abritray name assigned to the collections of fileSets. + + + + + + + + + + + + If this element is present, the bus interface is a system interface, neither master nor slave, with a specific function on the bus. + + + + + + + + + + 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. + + + + + + Represents a set of remap base addresses. + + + + + + Base of an address block, expressed as the number of bitsInLAU from the containing busInterface. The state attribute indicates the name of the remap state for which this address is valid. + + + + + + + + + Name of the state in which this remapped address range is valid + + + + + + + + + The address range of mirrored slave, expressed as the number of bitsInLAU from the containing busInterface. + + + + + + + + + + + + + + + + + + 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. + + + + + + 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. + + + + + + + + + + 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. + + + + + + Indicates which system interface is being monitored. Name must match a group name present on one or more ports in the corresonding bus definition. + + + + + + + + + + + + + + + + + + + + + + Group of the different modes a busInterface can take on in an abstractor + + + + + If this element is present, the bus interface can serve as a master. This element encapsulates additional information related to its role as master. + + + + + + If this element is present, the bus interface can serve as a slave. + + + + + + If this element is present, the bus interface is a system interface, neither master nor slave, with a specific function on the bus. + + + + + + + + + + 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. + + + + + + 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. + + + + + + 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. + + + + + + + + + + + + Type definition for a busInterface in a component + + + + + + 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. + + + + + Listing of maps between logical ports and physical ports. + + + + + + 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. + + + + + + Logical port from abstraction definition + + + + + + Bus port name as specified inside the abstraction definition + + + + + Definition of the logical indecies for a vectored port. + + + + + + Defines which logical bit maps to the physical left bit below + + + + + + + + + + + + Defines which logical bit maps to the physical right bit below + + + + + + + + + + + + + + + + + + Physical port from this component + + + + + + Component port name as specified inside the model port section + + + + + + + + + + + + + + + + + + + diff --git a/ipxact-1.5/commonStructures.xsd b/ipxact-1.5/commonStructures.xsd new file mode 100644 index 0000000..ebbfb1d --- /dev/null +++ b/ipxact-1.5/commonStructures.xsd @@ -0,0 +1,221 @@ + + + + + + + + Name value pair with data type information. + + + + + + The data type of the argument as pertains to the language. Example: "int", "double", "char *". + + + + + Indicates the type of the model parameter. Legal values are defined in the attribute enumeration list. Default value is 'nontyped'. + + + + + + + + + + + + + + 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. + + + + + A collection of parameters. + + + + + + + + + + Container for vendor specific extensions. + + + + + + Accepts any element(s) the content provider wants to put here, including elements from the spirit namespace. + + + + + + + + A group of elements for name (xs:name), displayName and description + + + + + Unique name + + + + + + + + + A group of elements for name (xs:name), displayName and description where the name is optional + + + + + Unique name + + + + + + + + + A group of elements for name(xs:NMTOKEN), displayName and description + + + + + Unique name + + + + + + + + + A group of elements for name(portName), displayName and description + + + + + Unique name + + + + + + + + + Name and value type for use in resolvable elements + + + + + + The value of the parameter. + + + + + + + + + + + + + + + + A group of elements for name(xs:string), displayName and description + + + + + Unique name + + + + + + + + + Element name for display purposes. Typically a few words providing a more detailed and/or user-friendly name than the spirit:name. + + + + + Full description string, typically for documentation + + + diff --git a/ipxact-1.5/component.xsd b/ipxact-1.5/component.xsd new file mode 100644 index 0000000..d7a3d00 --- /dev/null +++ b/ipxact-1.5/component.xsd @@ -0,0 +1,285 @@ + + + + + + + + + + + + + Component-specific extension to componentType + + + + + + + + + + + + Generator list is tools-specific. + + + + + + + A list of whiteboxElements + + + + + + 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. + + + + + + + + cpu's in the component + + + + + + Describes a processor in this component. + + + + + + The name of the cpu instance relative to the platform core. + + + + + Indicates which address space maps into this cpu. + + + + + Data specific to the cpu. + + + + + + + + + + + + Defines a set of clock drivers that are not directly associated with an input port of the component. + + + + + + + + + + This is the root element for all non platform-core components. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Defines a white box reference point within the component. + + + + + + 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 group of signals addressed as a single unit. + + + + + + + + + + + + + If true, indicates that the white box element can be driven (e.g. have a new value forced into it). + + + + + 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'. + + + + + + + diff --git a/ipxact-1.5/configurable.xsd b/ipxact-1.5/configurable.xsd new file mode 100644 index 0000000..85618a4 --- /dev/null +++ b/ipxact-1.5/configurable.xsd @@ -0,0 +1,114 @@ + + + + + + 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. + + + + + Property value is included in the XML file. It cannot be configured. + + + + + Property content can be modified through confiugration. Modifications will be saved with the design. + + + + + Property value is expressed as an XPath expression which may refer to other properties. The expression must appear in the dendency attribute. + + + + + Generators may modify this property. Modifications get saved with the design. + + + + + + + Determines how a property value is resolved. + + + + + ID attribute for uniquely identifying an element within its document. On elements with spirit:resolve attribute is used to refer to this element and otherwise can be used as a documentation ID. + + + + + Required on properties with a resolve = "dependent" attribute. This is an XPath expression supplying the resultant value for the containing element in terms of other properties in the containing file. + + + + + Base set of attributes for an element to be configurable. + + + + + + + diff --git a/ipxact-1.5/constraints.xsd b/ipxact-1.5/constraints.xsd new file mode 100644 index 0000000..8e1d073 --- /dev/null +++ b/ipxact-1.5/constraints.xsd @@ -0,0 +1,315 @@ + + + + + + + + + Indicates legal cell function values. + + + + + + + + + + + + + + Indicates legal cell class values. + + + + + + + + + Indicates legal cell strength values. + + + + + + + + + + Indicates legal values for edge specification attributes. + + + + + + + + + Indicates the type of delay value - minimum or maximum delay. + + + + + + + + + Type used to record percentage values. + + + + + + + + + Defines a non-negative floating point number. + + + + + + + + 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. + + + + + + + + Indicates the desired strength of the specified cell. + + + + + Indicates the clock edge that a timing constraint is relative to. + + + + + Indicates the type of delay in a timing constraint - minimum or maximum. + + + + + Indicates a name for this set of constraints. Constraints are tied to a view using this name in the constraintSetRef element. + + + + + Used to provide a generic description of a technology library cell. + + + + + + Defines a technology library cell in library independent fashion, based on specification of a cell function and strength. + + + + + + + + + + + + Defines a technology library cell in library independent fashion, based on specification of a cell class and strength. + + + + + + + + + + + + + + + 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. + + + + + + + + + Indicates the name of the clock to which this constraint applies. + + + + + + + + + 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. + + + + + + + + + + Defines a constraint indicating the type of load on an output port. + + + + + + + Indicates how many loads of the specified cell are connected. If not present, 3 is assumed. + + + + + + + + Defines constraints that apply to a component port. If multiple constraintSet elements are used, each must have a unique value for the constraintSetId attribute. + + + + + + + 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. + + + + + + The optional elements left and right can be used to select a bit-slice of a vector. + + + + + + + + + + The optional elements left and right can be used to select a bit-slice of a vector. + + + + + + + + + + + + + + + + + + + + List of constraintSet elements for a component port. + + + + + + + + + + A reference to a set of port constraints. + + + + + Defines constraints that apply to a wire type port in an abstraction definition. + + + + + + + + + + + + + + + + + diff --git a/ipxact-1.5/design.xsd b/ipxact-1.5/design.xsd new file mode 100644 index 0000000..b89a402 --- /dev/null +++ b/ipxact-1.5/design.xsd @@ -0,0 +1,137 @@ + + + + + + + + + + Root element for a platform design. + + + + + + + + + + A list of hierarchy connections between bus interfaces on component instances and the bus interfaces on the encompassing component. + + + + + + Represents a hierarchy connection + + + + + + Component and bus reference to export to the upper level component. + +The componentRef and busRef attributes indicate the instance name and bus interface name (active or monitor) of the hierachical connection. + + + + + + + This is the name of the bus interface on the upper level component. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ipxact-1.5/designConfig.xsd b/ipxact-1.5/designConfig.xsd new file mode 100644 index 0000000..6ef979b --- /dev/null +++ b/ipxact-1.5/designConfig.xsd @@ -0,0 +1,176 @@ + + + + + + + + + + Top level element for describing the current configuration of a design. Does not describe instance parameterization + + + + + + + The design to which this configuration applies + + + + + 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. + + + + + + References a generatorChain. + + + + + + + + + Contains the information about the abstractors required to cross between two interfaces at with different abstractionDefs. + + + + + + Reference to the interconnection name, monitor interconnection name or possibly a hierConnection interfaceName in a design file. + + + + + List of abstractors for this interconnection + + + + + + 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. + + + + + + Instance name for the abstractor + + + + + + + Abstractor reference + + + + + + The name of the active view for this abstractor instance. + + + + + + + + + + + + + + Contains the active view for each instance in the design + + + + + + + The name of the active view for this instance + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ipxact-1.5/file.xsd b/ipxact-1.5/file.xsd new file mode 100644 index 0000000..08551bc --- /dev/null +++ b/ipxact-1.5/file.xsd @@ -0,0 +1,592 @@ + + + + + + + + + IP-XACT reference to a file or directory. + + + + + + Path to the file or directory. If this path is a relative path, then it is relative to the containing XML file. + + + + + + + + + + + + + + + Indicate that the file is include file. + + + + + + + the File contains some declarations that are needed in top file + + + + + + + + + Logical name for this file or directory e.g. VHDL library name. + + + + + + + The logical name shall only be used as a default and another process may override this name. + + + + + + + + + Defines exported names that can be accessed externally, e.g. exported function names from a C source file. + + + + + 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. + + + + + + Command used to build this file. + + + + + + + + + + + + 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. + + + + + + + "true" indicates that the flags shall be appended to any existing flags, "false"indicates these flags will replace any existing 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. + + + + + + + + + + + + Pathname to the file that is derived (built) from the source file. + + + + + + + + + + + + + + + + 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. + + + + + Relates the current file to a certain executable image type in the design. + + + + + String for describing this file to users + + + + + + + Unique ID for this file, referenced in fileSet/function/fileRef + + + + + + + + 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. + + + + + 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. + + + + + + Name of the executable image file. + + + + + + + + + + String for describing this executable image to users + + + + + Additional information about the load module, e.g. stack base addresses, table addresses, etc. + + + + + Default commands and flags for software language tools needed to build the executable image. + + + + + + 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. + + + + + + + Default command used to build files of the specified fileType. + + + + + + + + + + + + Flags given to the build command when building files of this type. + + + + + + + + + + + + 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies a linker command file. + + + + + + Linker command file name. + + + + + + + + + + + + The command line switch to specify the linker command file. + + + + + + + + + + + + Specifies whether to generate and enable the linker command file. + + + + + + + + + + + + + + + + + + + + Contains a group of file set references that indicates the set of file sets complying with the tool set of the current executable image. + + + + + + + + + + + + Unique ID for the executableImage, referenced in fileSet/function/fileRef + + + + + Open element to describe the type of image. The contents is model and/or generator specific. + + + + + + + A reference to a fileSet. + + + + + + Refers to a fileSet defined within this description. + + + + + + + + Specifies a location on which files or fileSets may be dependent. Typically, this would be a directory that would contain included files. + + + + + List of file sets associated with component. + + + + + + + + + + + + + Default command used to build files of the specified fileType. + + + + + + + + + + + + Flags given to the build command when building files of this type. + + + + + + + + + + + + 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. + + + + + + + + + + + + + + + + + Identifies this filleSet as belonging to a particular group or having a particular purpose. Examples might be "diagnostics", "boot", "application", "interrupt", "deviceDriver", etc. + + + + + + Default command and flags used to build derived files from the sourceName files in this file set. + + + + + + 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. + + + + + + Optional name for the function. + + + + + A reference to the file that contains the entry point function. + + + + + Function return type. Possible values are void and int. + + + + + + + + + + + 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. + + + + + + + The data type of the argument as pertains to the language. Example: "int", "double", "char *". + + + + + + + + + Specifies if the SW function is enabled. If not present the function is always enabled. + + + + + + + + + + + + Location information for the source file of this function. + + + + + + Source file for the boot load. Relative names are searched for in the project directory and the source of the component directory. + + + + + + + + + + + + + + + + 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. + + + + + + + + + + IP-XACT URI, like a standard xs:anyURI except that it can contain environment variables in the ${ } form, to be replaced by their value to provide the underlying URI + + + + + + Enumerates C argument data types. + + + + + + + + + + + + + + + A reference to a generator element. + + + diff --git a/ipxact-1.5/fileType.xsd b/ipxact-1.5/fileType.xsd new file mode 100644 index 0000000..1c7fa02 --- /dev/null +++ b/ipxact-1.5/fileType.xsd @@ -0,0 +1,118 @@ + + + + + + The type of a file refenced by IP-XACT. +Either: fileType - a known IP-XACT file type, or userFileType - a file type not yet known by IP-XACT. If multiple types are specified, the order is important. The first type is the primary type of the file and the latter types are types that may be embedded in the file. For example a Verilog file containing PSL assertions. + + + + + Enumerated file types known by IP-XACT. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Free form file type, not - yet - known by IP-XACT . + + + + + diff --git a/ipxact-1.5/generator.xsd b/ipxact-1.5/generator.xsd new file mode 100644 index 0000000..c29cca6 --- /dev/null +++ b/ipxact-1.5/generator.xsd @@ -0,0 +1,272 @@ + + + + + + + + + + + + + + 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. + + + + + + + Select another generator chain using the unique identifier of this generator chain. + + + + + + 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. + + + + + + + Selects generators declared in components of the current design for inclusion into this generator chain. + + + + + + + Identifies this generator chain as belonging to the named group. This is used by other generator chains to select this chain for programmatic inclusion. + + + + + + + + + + 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. + + + + + + + Specifies a set of generators. + + + + + + + + + + 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. + + + + + + + + + + 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. + + + + + 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). + + + + + + Specifies a generator group name or a generator chain group name to be selected for inclusion in the generator chain. + + + + + + Specifies the OR or AND selection operator if there is more than one group name. + + + + + + + + + + + + + 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. + + + + + + + + + + + + + + An identifier to specify the generator group. This is used by generator chains for selecting which generators to run. + + + + + + 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. + + + + + + + + + + + + + + + + + + + List of component generators. + + + + + + + + + + List of abstractor generators. + + + + + + + + + + Types of generators + + + + + + + + Indicates the type of API used by the generator. Valid value are TGI, and none. If this element is not present, TGI is assumed. + + + + + + + + + + + + + + Defines a SOAP transport protocol other than HTTP which is supported by this generator. The only other currently supported protocol is 'file'. + + + + + + + + + + + + + The pathname to the executable file that implements the generator + + + + + + + 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. + + + + diff --git a/ipxact-1.5/identifier.xsd b/ipxact-1.5/identifier.xsd new file mode 100644 index 0000000..7a47825 --- /dev/null +++ b/ipxact-1.5/identifier.xsd @@ -0,0 +1,125 @@ + + + + + + Base IP-XACT identifier group. Identify an IP-XACT document by its by vendor, library and name. + + + + + + This group of elements identifies a top level item (e.g. a component or a bus definition) with vendor, library, name and a version number. + + + + + Name of the vendor who supplies this file. + + + + + Name of the logical library this element belongs to. + + + + + The name of the object. + + + + + Indicates the version of the named element. + + + + + + + Base IP-XACT document reference. Contains vendor, library, name and version attributes. + + + + + + + + + Base IP-XACT document reference type. Contains vendor, library, name and version attributes. + + + + Base IP-XACT document reference. Contains vendor, library, name and version attributes. + + + + + + Resolved IP-XACT document reference type. Contains vendor, library, name and version attributes and the URI of the referenced IP-XACT document + + + + + + + + diff --git a/ipxact-1.5/index.xsd b/ipxact-1.5/index.xsd new file mode 100644 index 0000000..b5643bf --- /dev/null +++ b/ipxact-1.5/index.xsd @@ -0,0 +1,99 @@ + + + + + + + + + + + + This IP-XACT schema documentation is part of the IP-XACT standard deliverables. The diagrams in this documentation represent the relationships between elements of the schema together with their attributes and expected values. Valid IP-XACT XML files must have a top-level type that is one of the elements listed here. + + + + + To define all elements and attributes supported when defining a bus. + + + + + + To define all elements and attributes supported when defining a component. + + + + + + To define all elements and attributes supported when defining a design and its configured components + + + + + To define all elements and attributes supported for defining generator chains. + + + + + + diff --git a/ipxact-1.5/memoryMap.xsd b/ipxact-1.5/memoryMap.xsd new file mode 100644 index 0000000..9c75997 --- /dev/null +++ b/ipxact-1.5/memoryMap.xsd @@ -0,0 +1,1039 @@ + + + + + + + + The read/write accessability of an addess block. + + + + + + + + + + + + 'serial' or 'parallel' bank alignment. + + + + + + + + + Describes the usage of an address block. + + + + + Denotes an address range that can be used for read-write or read-only data storage. + + + + + Denotes an address block that is used to communicate with hardware. + + + + + Denotes an address range that must remain unoccupied. + + + + + + + A reference to a unique address space. + + + + + A reference to a unique memory map. + + + + + Describes whether this bank's blocks are aligned in 'parallel' or 'serial'. + + + + + For subspaceMap elements, this attribute identifies the master that contains the address space to be mapped. + + + + + Refernce to a segment of the addressSpace of the masterRef attribute. + + + + + Top level bank the specify an address + + + + + + + + + + + Top level address block that specify an address + + + + + + + + + + + + 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. + + + + + + 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. + + + + + + Banks nested inside a bank do not specify address. + + + + + + + + + + Address blocks inside a bank do not specify address. + + + + + + + + + + + + Subspace references inside banks do not specify an address. + + + + + + Any parameters that may apply to the subspace reference. + + + + + + + + + A field within a register + + + + + + Offset of this field's bit 0 from bit 0 of the register. + + + + + + + + + + + A group elements for a memoryMap + + + + + + + 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. + + + + + + + Map of address space blocks on slave slave bus interface. + + + + + + + Additional memory map elements that are dependent on the component state. + + + + + + + + + + + + + + Map of address space blocks on a slave bus interface in a specific remap state. + + + + + + + + State of the component in which the memory map is active. + + + + + + + Map of address space blocks on the local memory map of a master bus interface. + + + + + + + + + + Address subspace type. Its subspaceReference attribute references the subspace from which the dimensions are taken. + + + + Any parameters that may apply to the subspace reference. + + + + + + Any parameters that may apply to the subspace reference. + + + + + + + + + + Indicates whether the data is volatile. + + + + + Indicates the accessibility of the data in the address bank, address block, register or field. Possible values are 'read-write', 'read-only', 'write-only', 'writeOnce' and 'read-writeOnce'. If not specified the value is inherited from the containing object. + + + + + + + + This is a single contiguous block of memory inside a memory map. + + + + + + + + + References the address space. The name of the address space is kept in its addressSpaceRef attribute. + + + + + If this component is a bus master, this lists all the address spaces +defined by the component. + + + + + + This defines a logical space, referenced by a bus master. + + + + + + + + Address segments withing an addressSpace + + + + + + Address segment withing an addressSpace + + + + + + + Address offset of the segment within the containing address space. + + + + + + + + + + + + The address range of asegment. Expressed as the number of addressable units accessible to the segment. + + + + + + + + + + + + + + + + + + + + + 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. + + + + + + + + + Data specific to this address space. + + + + + + + + + + + + + + + + References the memory map. The name of the memory map is kept in its memoryMapRef attribute. + + + + + Lists all the slave memory maps defined by the component. + + + + + + The set of address blocks a bus slave contributes to the bus' address space. + + + + + + + + + + + + + + + + Represents a bank of memory made up of address blocks or other banks. It has a bankAlignment attribute indicating whether its blocks are aligned in 'parallel' (occupying adjacent bit fields) or 'serial' (occupying contiguous addresses). Its child blocks do not contain addresses or bit offsets. + + + + + + + + + Base of an address block, bank, subspace map or address space. Expressed as the number of addressable units from the containing memoryMap or localMemoryMap. + + + + + + + + + + + + + The number of data bits in an addressable unit. The default is byte addressable (8 bits). + + + + + This is a group of optional elements commonly added to various types of address blocks in a memory map. + + + + + + + + + This group of elements describes an absolute or relative address of an address block in a memory map. + +Note that this is a group, not an element. It does not appear in the XML, but its contents may. + + + + + + + + This group of elements is common to top level banks and banked banks. + + + + + + An address block within the bank. No address information is supplied. + + + + + + + + + A nested bank of blocks within a bank. No address information is supplied. + + + + + + + + + A subspace map within the bank. No address information is supplied. + + + + + + + + + + This group of elements describes the number of addressable units and the width of a row of an address block in a memory map. + +Note that this is a group, not an element. It does not appear in the XML, but its contents may. + + + + + 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:addressUnitBits * spirit:range + number_of_rows_in_block = number_of_bits_in_block / spirit: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 + + + + + + + + + + + + + + + This group of optional elements can be used to provide additional descriptions to an address block or bank. + +Note that this is a group, not an element. It does not appear in the XML, but its contents may. + + + + + Indicates the usage of this block. Possible values are 'memory', 'register' and 'reserved'. + + + + + + + Any additional parameters needed to describe this address block to the generators. + + + + + + + This group of optional elements describes the memory mapped registers of an address block + + + + + A single register + + + + + + + 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. + + + + + Offset from the address block's baseAddress or the containing register file's addressOffset, expressed as the number of addressUnitBits from the containing memoryMap or localMemoryMap. + + + + + + Alternate definitions for the current register + + + + + + Alternate definition for the current register + + + + + + + Defines a list of grouping names that this register description belongs. + + + + + + Defines a grouping name that this register description belongs. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A structure of registers and register files + + + + + + + Enumerates specific values that can be assigned to the bit field. + + + + + + Enumerates specific values that can be assigned to the bit field. The name of this enumerated value. This may be used as a token in generating code. + + + + + + + Enumerated bit field value. + + + + + + + Usage for the enumeration. 'read' for a software read access. 'write' for a software write access. 'read-write' for a software read or write access. + + + + + + + + + + + + + + + + + + + + + This type is used to specify a value and optional mask that are configurable + + + + + + Additional field data + + + + + Indicates whether the data is volatile. The presumed value is 'false' if not present. + + + + + + + If present this element describes the modification of field data caused by a write operation. 'oneToClear' means that in a bitwise fashion each write data bit of a one will clear the corresponding bit in the field. 'oneToSet' means that in a bitwise fashion each write data bit of a one will set the corresponding bit in the field. 'oneToToggle' means that in a bitwise fashion each write data bit of a one will toggle the corresponding bit in the field. 'zeroToClear' means that in a bitwise fashion each write data bit of a zero will clear the corresponding bit in the field. 'zeroToSet' means that in a bitwise fashion each write data bit of a zero will set the corresponding bit in the field. 'zeroToToggle' means that in a bitwise fashion each write data bit of a zero will toggle the corresponding bit in the field. 'clear' means any write to this field clears the field. 'set' means any write to the field sets the field. 'modify' means any write to this field may modify that data. If this element is not present the write operation data is written. + + + + + + + + + + + + + + + + + + The legal values that may be written to a field. If not specified the legal values are not specified. + + + + + A list of possible actions for a read to set the field after the read. 'clear' means that after a read the field is cleared. 'set' means that after a read the field is set. 'modify' means after a read the field is modified. If not present the field value is not modified after a read. + + + + + + + + + + + + Can the field be tested with an automated register test routine. The presumed value is true if not specified. + + + + + + + Constraint for an automated register test routine. 'unconstrained' (default) means may read and write all legal values. 'restore' means may read and write legal values but the value must be restored to the initially read value before accessing another register. 'writeAsRead' has limitations on testability where only the value read before a write may be written to the field. 'readOnly' has limitations on testability where values may only be read from the field. + + + + + + + + + + + + + + + + + + + A constraint on the values that can be written to this field. Absence of this element implies that any value that fits can be written to it. + + + + + writeAsRead indicates that only a value immediately read before a write is a legal value to be written. + + + + + useEnumeratedValues indicates that only write enumeration value shall be legal values to be written. + + + + + + The minimum legal value that may be written to a field + + + + + + + + + + + + The maximum legal value that may be written to a field + + + + + + + + + + + + + + + A structure of registers and register files + + + + + + + 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. + + + + + Offset from the address block's baseAddress or the containing register file's addressOffset, expressed as the number of addressUnitBits from the containing memoryMap or localMemoryMap. + + + + + + + + + + + + + + + + Field definition specific information + + + + + Identifier name used to indicate that multiple field elements contain the exact same information for the elements in the fieldDefinitionGroup. + + + + + Width of the field in bits. + + + + + + + + + + + + + + + Register file defnition specific information + + + + + Identifier name used to indicate that multiple registerFile elements contain the exact same information except for the elements in the registerFileInstanceGroup. + + + + + The range of a register file. Expressed as the number of addressable units accessible to the block. Specified in units of addressUnitBits. + + + + + + + + + + + + + + + Address block definition specific information + + + + + Identifier name used to indicate that multiple addressBlock elements contain the exact same information except for the elements in the addressBlockInstanceGroup. + + + + + + + + + + Register definition specific information + + + + + Identifier name used to indicate that multiple register elements contain the exact same information for the elements in the registerDefinitionGroup. + + + + + Width of the register in bits. + + + + + + + + + + + + + + Register value at reset. + + + + + + The value itself. + + + + + + + + + + + + Mask to be anded with the value before comparing to the reset value. + + + + + + + + + + + + + + + Describes individual bit fields within the register. + + + + + + + Alternate register file defnition specific information + + + + + Identifier name used to indicate that multiple register elements contain the exact same information for the elements in the alternateRegisterDefinitionGroup. + + + + + + + Register value at reset. + + + + + + The value itself. + + + + + + + + + + + + Mask to be anded with the value before comparing to the reset value. + + + + + + + + + + + + + + + Describes individual bit fields within the register. + + + + + diff --git a/ipxact-1.5/model.xsd b/ipxact-1.5/model.xsd new file mode 100644 index 0000000..86f9431 --- /dev/null +++ b/ipxact-1.5/model.xsd @@ -0,0 +1,323 @@ + + + + + + + + + Component view type + + + + + + 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. + + + + + + + + + + + References an IP-XACT design or configuration document (by VLNV) that provides a design for the component + + + + + + 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. + + + + + + + A value of 'true' indicates that this value must match the language being generated for the design. + + + + + + + + + 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 command and flags used to build derived files from the sourceName files in the referenced file sets. + + + + + + + Container for white box element references. + + + + + + Reference to a white box element which is visible within this view. + + + + + + + + + + + + + + Abstraction view type + + + + + + 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. + + + + + + + + + + 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. + + + + + + + A value of 'true' indicates that this value must match the language being generated for the design. + + + + + + + + + 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 command and flags used to build derived files from the sourceName files in the referenced file sets. + + + + + + + + + + Model information. + + + + + + View container + + + + + + Single view of a component + + + + + + + + Port container + + + + + + + + + + Model parameter name value pairs container + + + + + + 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. + + + + + + + + + + + Model information for an abstractor. + + + + + View container + + + + + + Single view of an abstractor + + + + + + + + Port container + + + + + + + + + + Model parameter name value pairs container + + + + + + 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. + + + + + + + + + + + Model information. + + + + + Reference to a whiteboxElement within a view. The 'name' attribute must refer to a whiteboxElement defined within this component. + + + + + The whiteboxPath elements (as a set) define the name(s) needed to define the entire white box element in this view. + + + + + + The view specific name for a portion of the white box element. + + + + + Optional bound on the path name. If not specified, the size of the element referred to by pathName must be determined from the referenced element. + + + + Indicates the left bound value for the associated path name. + + + + + Indicates the right bound values for the associated path name. + + + + + + + + + + Reference to a whiteboxElement defined within this component. + + + + diff --git a/ipxact-1.5/port.xsd b/ipxact-1.5/port.xsd new file mode 100644 index 0000000..3b90d60 --- /dev/null +++ b/ipxact-1.5/port.xsd @@ -0,0 +1,473 @@ + + + + + + + + + The direction of a component port. + + + + + + + + + + + Definition of the indecies for a vectored port. + + + + + + The optional elements left and right can be used to select a bit-slice of a port vector to map to the bus interface. + + + + + + + + + + + + The optional elements left and right can be used to select a bit-slice of a port vector to map to the bus interface. + + + + + + + + + + + + + + + Basic port declarations. + + + + + + Port style + + + + Defines a port whose type resolves to simple bits. + + + + + Defines a port that implements or uses a service that can be implemented with functions or methods. + + + + + + + Port access characteristics. + + + + + + + + A port description, giving a name and an access type for high level ports. + + + + + + + + + + + + A port description, giving a name and an access type for high level ports. + + + + + + + + + Port style + + + + Defines a port whose type resolves to simple bits. + + + + + Defines a port that implements or uses a service that can be implemented with functions or methods. + + + + + + + Port access characteristics. + + + + + + + + + + + + + + If this element is present, the type of access is restricted to the specified value. + + + + + + + + + + + + + Indicates how a netlister accesses a port. 'ref' means accessed by reference (default) and 'ptr' means accessed by pointer. + + + + + + + + + + + Definition of a single transactional type defintion + + + + + + 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. + + + + + + + Defines that the type for the port has constrainted the number of bits in the vector + + + + + + + + + Where the definition of the type is contained. For SystemC and SystemVerilog it is the include file containing the type definition. + + + + + + + + Definition of a single service type defintion + + + + + + 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. + + + + + + + Defines that the type for the port has constrainted the number of bits in the vector + + + + + 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 + + + + + + + + + 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. + + + + + list service parameters (e.g. parameters for a systemVerilog interface) + + + + + + + + + + + + + Definition of a single wire type defintion that can relate to multiple views. + + + + + + The name of the logic type. Examples could be std_logic, std_ulogic, std_logic_vector, sc_logic, ... + + + + + + + Defines that the type for the port has constrainted the number of bits in the vector + + + + + + + + + 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. + + + + + A reference to a view name in the file for which this type applies. + + + + + + + + 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. + + + + + + + + + + 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. + + + + + + + + + + + + + + If present, is a method to be used to get hold of the object representing the port. This is typically a function call or array element reference in systemC. + + + + + Describes port characteristics. + + + + + Wire port type for a component. + + + + + 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. + + + + + 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. + + + + + + + + + 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. + + + + + + Transactional port type. + + + + + Definition of the port type expressed in the default language for this port (i.e. SystemC or SystemV). + + + + + Describes the interface protocol. + + + + + + Defines how the port accesses this service. + + + + + The group of service type definitions. + + + + + + + + + Bounds number of legal 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. + + + + + Indicates the minimum number of connections this port supports. If this element is not present, the minimum number of allowed connections is 1. + + + + + + + + + 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. + + + + + + Wire port type for an abstractor. + + + + + + + + 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. + + + + + + + + + + + + + Indicates how a netlister accesses a port. 'ref' means accessed by reference (default) and 'ptr' means accessed through a pointer. + + + + + + diff --git a/ipxact-1.5/signalDrivers.xsd b/ipxact-1.5/signalDrivers.xsd new file mode 100644 index 0000000..456d923 --- /dev/null +++ b/ipxact-1.5/signalDrivers.xsd @@ -0,0 +1,252 @@ + + + + + + + + Default value for a wire port. + + + + + + + + + + + + Describes a driven clock port. + + + + + + + Indicates the name of the cllock. If not specified the name is assumed to be the name of the containing port. + + + + + + + + + Describes a driven one-shot port. + + + + + + Time in nanoseconds until start of one-shot. + + + + + + + + + + + + Value of port after first edge of one-shot. + + + + + + + + + + + + Duration in nanoseconds of the one shot. + + + + + + + + + + + + + + + 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 + + + + + + + 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. + + + + + + + + + + + + + + + + Wire port driver type. + + + + + + + + + + Wire port driver element. + + + + + + + Clock period in units defined by the units attribute. Default is nanoseconds. + + + + + + + + + + + + + Time until first pulse. Units are defined by the units attribute. Default is nanoseconds. + + + + + + + + + + + + + Value of port after first clock edge. + + + + + + + + + + + + Duration of first state in cycle. Units are defined by the units attribute. Default is nanoseconds. + + + + + + + + + + + + + + + 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). + + + + + + + Indicates the name of the clock. + + + + + Indicates the name of the actual clock source (e.g. an output pin of a clock generator cell). + + + + + + + diff --git a/ipxact-1.5/simpleTypes.xsd b/ipxact-1.5/simpleTypes.xsd new file mode 100644 index 0000000..9ff1475 --- /dev/null +++ b/ipxact-1.5/simpleTypes.xsd @@ -0,0 +1,122 @@ + + + + + + A scaled integer. It supports any string recognized by java.lang.Long.decode(). It also supports a magnitude scale suffix of upper or lower case K (kilo=2^10), M (mega=2^20), G (giga=2^30) or T (tera=2^40). + + + + + + + + A scaled nonnegative integer that consists of the value set {0, 1, ...}. It is derived from scaledInteger and it supports a magnitude scale suffix of upper or lower case K (kilo=2^10), M (mega=2^20), G (giga=2^30) or T (tera=2^40). + + + + + + + + A scaled positive integer that consists of the value set {1, 2, ...}. It is derived from scaledNonNegativeInteger and it supports a magnitude scale suffix of upper or lower case K (kilo=2^10), M (mega=2^20), G (giga=2^30) or T (tera=2^40). + + + + + + + + List of doubles. Used to build configurableDouble type. + + + + + + Can be a double or an empty string. + + + + + + + + + A type for a port name string, allows letters, digits, dash, colon, underscore and period + + + + + + + + + A type for a instance name path string, allows letters, digits, dash, colon, underscore, period and slash + + + + + + + + + diff --git a/ipxact-1.5/subInstances.xsd b/ipxact-1.5/subInstances.xsd new file mode 100644 index 0000000..a6fb430 --- /dev/null +++ b/ipxact-1.5/subInstances.xsd @@ -0,0 +1,288 @@ + + + + + + + + + + All configuration information for a contained component, generator, generator chain or abstractor instance. + + + + + + Describes the content of a configurable element. The required referenceId attribute refers to the ID attribute of the configurable element. + + + + + + + + Describes the content of a configurable element. The required referenceId attribute refers to the ID attribute of the configurable element. + + + + + + + Refers to the ID attribute of the configurable element. + + + + + + + + + An instance name assigned to subcomponent instances and contained channels, that is unique within the parent component. + + + + + Component instance element. The instance name is contained in the unique-value instanceName attribute. + + + + + + + + + References a component to be found in an external library. The four attributes define the VLNV of the referenced element. + + + + + + + + + + Sub instances of internal components. + + + + + + + + + + Represents an ad-hoc connection between component ports. + + + + + + + Defines a reference to a port on a component contained within the design. + + + + + A reference to the instanceName element of a component in this design. + + + + + A port on the on the referenced component from componentRef. + + + + + Left index of a vector. + + + + + Right index of a vector. + + + + + + + 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. + + + + + A port on the top level component. + + + + + Left index of a vector. + + + + + Right index of a vector. + + + + + + + + The logic value of this connection. Only valid for ports of style wire. + + + + + + + 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). + + + + + + + + + + Describes a connection between two active (not monitor) busInterfaces. + + + + + + + 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. + + + + + + + + Connections between internal sub components. + + + + + + + + + + + A representation of a component/bus interface relation; i.e. a bus interface belonging to a certain component. + + + + Reference to a component instance name. + + + + + Reference to the components bus interface + + + + + + 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. + + + + + + + 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. The optional path attribute indicates the hierarchical instance name path to the component. + + + + + 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. The optional path attribute indicates the hierarchical instance name path to the component. + + + + + + + + Hierarchical reference to an interface + + + + + + A decending hierarchical (slash separated - example x/y/z) path to the component instance containing the specified component instance in componentRef. If not specified the componentRef instance shall exist in the current design. + + + + + + From b9df71fc292ee02937c06f14f9c09c3ef37d74c4 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Sun, 20 Aug 2023 00:02:43 +0200 Subject: [PATCH 2/2] Added README entry and matching test cases. --- README.md | 2 ++ tests/unit/IPXACT.py | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/README.md b/README.md index 2fffb8c..0105fae 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ Around the time of DAC 2005, the IEEE P1685 working group was formed. **Unknown License State** +* [IP-XACT 1.5](http://www.accellera.org/XMLSchema/SPIRIT/1.5/) + ❌ © Copyright Accellera Systems Initiative. All rights reserved. * [IP-XACT 1.4](http://www.accellera.org/XMLSchema/SPIRIT/1.4/) ❌ © Copyright Accellera Systems Initiative. All rights reserved. * [IP-XACT 1.2](http://www.accellera.org/XMLSchema/SPIRIT/1.2/) diff --git a/tests/unit/IPXACT.py b/tests/unit/IPXACT.py index 0bfd500..5513159 100644 --- a/tests/unit/IPXACT.py +++ b/tests/unit/IPXACT.py @@ -96,3 +96,22 @@ def test_Schema14(self): schemaFile = directory / file print(f" {schemaFile}") _ = XMLSchema(schemaFile) + + def test_Schema15(self): + print() + print(f"CWD: {Path.cwd()}") + + directory = self._root / "ipxact-1.5" + print(f"Schema directory: {directory}") + + schemaFiles = ( + "design.xsd", + "component.xsd", + "busDefinition.xsd", + "generator.xsd", + ) + print(f"Reading schemas ...") + for file in schemaFiles: + schemaFile = directory / file + print(f" {schemaFile}") + _ = XMLSchema(schemaFile)