5.20.4 Instance properties

The function instance_getProperties() gets detailed information that is inherent to the instance and does not change, for example the type of component and whether certain features are supported or not. Properties should not be confused with parameters, which are variable characteristics of a component, set at compile time or runtime.

instance_getProperties() returns a set of arbitrary key/value pairs. The following tables list all properties that have defined semantics in Iris. Instances can report additional properties that are not listed here. All instance properties are optional.

Table 5-16 Instance properties defined by Iris, typically only for component instances

Property Type Description
register.canonicalRnScheme String Canonical register number scheme used by the canonicalRn member of RegisterInfo. Canonical register numbers are intended to be target-specific numbers that identify registers in the device. The format of this field is domain_name/string. The domain_name is that of the organization specifying the scheme. The organization specifies the string. Arm® components use arm.com/registers, if they expose registers.
memory.canonicalMsnScheme String Canonical memory space number scheme used by the canonicalMsn member of MemorySpaceInfo. Canonical memory space numbers are intended to be target-specific numbers that identify memory spaces in the device. The format of this field is domain_name/string. The domain_name is that of the organization specifying the scheme. The organization specifies the string. Arm components use arm.com/memoryspaces, if they expose memory spaces, see 5.7.6 Canonical memory space number scheme.

Table 5-17 Instance properties defined by LISA+, typically only for component instances

Property Type Description
componentName String The name of the component that this is an instance of. For example RAMDevice.
version String Component version, as defined in the LISA+ properties section.
componentType String

Component type. For example:

  • Bridge
  • Bus
  • Clocking
  • Core
  • Media
  • Other
  • Peripheral
  • Signals
  • SystemIP
Components can report other component types. If a strong classification is needed for these, they should be included in the same class as Other. The LISA+ name is component_type.
description String Short description of the functionality of the component. Can contain linefeeds, but is usually just a single line of text.
documentationFile String Filename of the documentation for this component. A user interface can open this file upon request. The LISA+ name is documentation_file.
executesSoftware NumberU64 A hint that is set to 1 if the component can execute software. Clients can take this as a hint that this component is a CPU-like debug target, in contrast to a peripheral, which might also be inspected but which generally does not execute software. The LISA+ name is executes_software.
loadfileExtension String A hint for clients about which filename extensions are usually suitable for the image_loadFile() function. Clients should offer them to users in addition to All Files. Clients that use their own loader and always send binary data to the target should ignore this property. The list contains glob-style wildcard expressions, separated by semicolons, for example "*.txt" or "*.axf;*.elf". The LISA+ name is loadfile_extension.

Table 5-18 Instance properties for client instances and for instances connected using IPC

Property Type Description
name String Human readable name of a client. Single line, usually prettier than the instance name, for example "Arm Development Studio v1.0". This does not need to be unique for different clients, if they are of the same type.
description String Multiple-line description of this client.
connectionInfo String

Single line that describes the way this instance is connected to the simulation. This can be either:

"in-process"
For DSO plug-ins, for example. This should be the default interpretation when this property is missing.
"iris://<ip>:<port>"
For an IPC client on <ip> and <port>.
Non-ConfidentialPDF file icon PDF version101196_0100_03_en
Copyright © 2018, 2019 Arm Limited or its affiliates. All rights reserved.