Iris Developer Guide : 5.12.5 Debuggable state functions

5.12.5 Debuggable state functions

Describes the following functions:

debuggableState_getAcknowledge()

Queries the debuggable-state-acknowledge flag of an instance.

Arguments

instId

Type: NumberU64

Opaque number uniquely identifying the target instance.

Return value

Boolean

Returns true iff the instance is in a debuggable state, else false.

Errors

E_unknown_instance_id.

debuggableState_setRequest()

Sets or clears the debuggable-state-request flag in a specific instance. This flag is changed only by this function, and does not change spontaneously.

Arguments

instId

Type: NumberU64

Opaque number uniquely identifying the target instance.

request

Type: Boolean

Default: True

Optional. If missing or true, set the debuggable-state-request flag, that is, request to go into a debuggable state. If present and false, clear the debuggable-state-request flag, that is, resume normal execution. Default is true.

Return value

Function has no return value.

Errors

E_unknown_instance_id.

simulationTime_runUntilDebuggableState()

A variant of simulationTime_run() and generally has the same semantics, except that this function sets up a global state in which the progress of simulation time stops automatically when all instances that have the debuggable-state-request flag set also have the debuggable-state-acknowledge flag set.

Arguments

instId

Type: NumberU64

Opaque number uniquely identifying the target instance. Typically this is the instance framework.SimulationEngine.

Return value

Function has no return value.

Non-Confidential	PDF version	101196_0100_03_en
Copyright © 2018, 2019 Arm Limited or its affiliates. All rights reserved.