Functions

Add a fixed length array property without setters / getters

0 if the property was added

Add an array pseudo-property

0 if the property was added

Add field to meta register

Adds a field to the meta register.

Add an array of interfaces to a class

Interface arrays are especially useful when e.g. multiple "network ports" are available, although they can be added manually with distinct names (e.g. uartaiface, uartbiface, etc), the interface array registration allows for the addition of several interfaces at once. Individual interfaces are then referred to with normal index syntax, e.g. obj:uartiface[0].

Add a interface reference property.

temu_addLogginCategory adds a logging category to the class

0 for success, 1 indicates failure.

Make interface reference property and an interface inverses

A port is a bidirectional interface. Thus, if an interface reference is connected to another objects interface, the remote object will be told to issue a reverse connection. This is convenient as it simplifies device connection during system configuration and construction. That is, instead of calling the connect two times with the inverse connections explicitly, only one call is needed.

0 on success, non-zero otherwise.

Add a property to a class.

Add a interface reference property.

Add property without storage

A pseudo property does not have backing storage (and therefore no offset). They exist to provide access to computed properties.

Pseudo properties also work fine with C++ types with non-standard layout.

Pseudo properties are snapshotted if the set and get functions are implemented. The set and get should implement read and write without semantic effect. That is, if the property is a register, then the read and write should have the effect of an actual register access (including event rescheduling etc), while for a get/set, only the value of the register is modified, event restoration is done differently.

Add register property to class

Adds a register with the given name to a class. It returns a reference to a meta register which can be used to add fields.

A reference to a meta register which can be used to add fields.

Adds a register bank to a TEMU class

Pointer to the new register bank

Add a scalar (one element) property without setters / getters

0 if the property was added

Add a scalar (one element) pseudo-property

0 if the property was added

Get the ARM processor state register

APSR value

Get the ARM execution mode

Execution mode

Get the ARM FPEXC register

FPEXC value

Get the ARM FPINST register

FPINST value

Get the ARM FPSCR register

FPSCR value

Set the ARM processor state register

Set the ARM execution mode

Set the ARM FPEXC register

Set the ARM FPINST register

Set the ARM FPSCR register

Converts the given property to double

Returns the property as an unsigned integer

Converts the given propery to integer

Returns the property as integer

Converts the given property to unsigned integer

Returns the property as an unsigned integer

Assemble an instruction

Instruction bitpattern.

Assemble an instruction to memory

Add asynchronous event triggered by file descriptor changes

Returns the file descriptor (Sock) if successful, otherwise -1.

Remove an asynchronous event triggered by file descriptor changes

Stop the current scheduler

The function returns immediately, before the scheduler has stopped. The function is suitable for use in e.g. signal handlers.

Add asynchronously activated wall-clock timed events

The callback function will be called synchronously by the emulator core associated with Q. That means that when CB is executing it is safe to do anything that can be done from a normal event or MMIO handler.

Note that the event is only called when a CPU core or machine is running. When the timer has triggered, it is temporarily disabled and the CB is posted on the synchornous event queue as an async event. This will be executed when the next normal event expires (e.g. at the end of the current quanta). After the event has been called, depending on wether the timer is cyclic or not, it will be reactivated. This means that if the emulator is paused, at most one call to the event handler will be issued, and this will be done when the emulator is resumed.

Returns a file descriptor or timer ID.

Remove an async timer

Reverses bits in a 16 bit word.

Word with reversed bits.

Reverses bits in a 32 bit word.

Word with reversed bits.

Copy COW buffer. This will make a new buff object, but the underlying data will not be copied.

Buffer object referring to the same data as B.

Create a new COW buffer of size bytes.

Buffer object.

Delete buffer. The buffer B will be deleted. If there are no more copies of the buffer data anywhere, the data will be deallocated.

Get buffer length

Length of buffer in bytes

Get a pointer to readable buffer data

The pointer to the readable data will be returned.

Pointer to data buffer.

Remove len bytes from the start of the buffer.

Removing bytes from the buffer start will not change the underlying buffer object. And is not seen as a write for the purpose of the data block.

This does not affect other copies of this buffer.

Remove len bytes from the end of the buffer.

Removing bytes from the buffer tail will not change the underlying buffer object. And is not seen as a write for the purpose of the data block.

This does not affect other copies of this buffer.

Get a pointer to writable data.

If the data have more than one reference, a new copy of the data will be created.

Pointer to writable data.

Check object system sanity.

The function traverses all objects and their properties and ensures that all (scalar) interface properties are connected. An object can override the default check by implementing the checkSanity function in the ObjectIface.

Returns 0 if the object system is connected. Returns non-zero if the object system is not properly connected.

Get number of entries for the serialized property

Length of the property in elements. Negative on error.

Get value for named snapshot value

Property value with the contents saved to the snapshot

Add parameter to command

0 on success, other values indicates errors

Get named command option

Pointer to command argument or NULL in case it is not found.

Get named command option as signed integer

Can only get valid numeric parameters. The function will never fail if the type is numeric and the option is required. For optional arguments, use the generic access function temu_classCmdGetOption()

The value of the parameter converted to an integer.

Get named command option as unsigned integer

Can only get valid numeric parameters. The function will never fail if the type is numeric and the option is required. For optional arguments, use the generic access function temu_classCmdGetOption()

The value of the parameter converted to an unsigned integer.

Get the class pointer for the named class

Pointer to the class if found, otherwise NULL

Get the class for the given object.

Pointer to the class type object

Get an already registered command handle from class

This function can be used to for example get commands registered in the metaclass, such as the new command. The command can then have arguments added.

Opaque handle to command. NULL in case of failure.

Query whether the class has a specific command implemented

0 if command is not implemented by class, 1 if implemented.

Clear lower set bit in word

A copy of Word with ther lowest set bit cleared

Clear lower set bit in word

A copy of Word with ther lowest set bit cleared

Clear attribute on memory space location

Clear right most bit in a word

A copy of Word, in which right most bit to be cleared

Clear right most bit in a word

A copy of Word, in which right most bit to be cleared

Count leading zeroes

Number of leading zeros in Word

Count leading zeroes

Number of leading zeros in Word

Count leading zeroes

The number of leading zeros in Word

Add named argument to command

Get data pointer from command context This function shall be called in a command handler on the passed context.

data pointer

Get pointer to the command interpreter This function shall be called in a command handler on the passed context.

Pointer to interpreter

Get named option as integer from command context This function shall be called in a command handler on the passed context.

The integer bound to the named argument

Get named option as object pointer from command context This function shall be called in a command handler on the passed context.

Pointer to the option object

Get named option as double from command context This function shall be called in a command handler on the passed context.

The real value of the option as double

Get named option as string from command context This function shall be called in a command handler on the passed context.

C-string of the name of the option

Get positional option at index This function shall be called in a command handler on the passed context.

The option at position Idx as a C-string

Get number of positional options given This function shall be called in a command handler on the passed context.

The number of position optionals in Ctxt

Get a variable in the command line

In case the variable is not found NULL, otherwise a borrowed string.

Return 1 if the option is valid, 0 if invalid / not set This function shall be called in a command handler on the passed context.

1 if the option is valid, 0 if invalid / not set

Set a variable in the command line

Non-zero on errors

Add delegate interface to component

Delegate interfaces are interfaces in objects internal in the component. It is possible to use the connect function to attach directly to a component delegated interface (although, in practice the connection is done to the internal object’s interface).

Note that delegate interface do not support interface arrays, and can only expose a single interface instance at present.

Add delegate property to component

Delegate property are properties in objects internal in the component. It is possible to use the connect function to connect from a delegated property directly using the component instead of the underlying object.

Allocate a component object.

The component create shall be called in the component constructor/create function (the create function passed to the registerComponent function). It will allocate an opaque component object with the relevant name.

The returned component is what the component constructor should return.

Component pointer

Deallocate a component object

The component dispose shall be called by the component destructor/dispose function registered in the registerComponent call.

Note that a component is seen as owning all the objects created with createComponentObject, and subsequently, all objects created will be recursively deleted when deleting the component.

Query the component for a delegated interface

Normally this function is not needed for the end user, however some usecases can be seen for exposing this. It returns the IfaceRef that has been added as a delegate interface. The main use is to redelegate delegated interfaces in a component of components.

Interface reference associated with Name, if none is found, iref type will be teTY_Invalid.

Query the compontent for a delegated property

Normally this should not be called by the user. But is useful in case the user constructs components of components in which case a component can redelegate delegated properties.

Object name pair with the target object and property name.

Get named object in component

NULL if the object is not a member in the component

Connect an interface property in object A to the interface in object B. If A.PropName is an interface array, B,B:IfaceName will be appended to it. For dynamic arrays, it is pushed to the end, for static arrays, it is placed in the first null slot (unless, the indexing syntax is used in the property name).

0 on success, otherwise non-zero

Disable traps on processor

Enable traps on processor

Get a 32 bit floating point register

Host float with the content of the FPU register

Get a 32 bit floating point register

Floating point register contents

Get 64 bit floating point register as double

FPU register value

Get 64 bit floating point register contents

FPU register value

Get the clock frequency for the CPU

The configured clock frequency in Hz.

Get the Machine for a given CPU

Pointer to the machine object

Get the program counter

The program counter will be returned.

The value of the program counter register

Gets the register in the processor

Register value

Get the PowerPC SPR register

Value of SPR specified in RegId.

Get processor statistics

Statistics value

Raise a trap The function simulates a trap being raised at the current PC.

Reset the processor.

Resetting the CPU will result in a reset cascade where all connected devices are also reset.

Clear processor statistics

Run the processor for a number of cycles

The function runs the processor for a number of cycles. If you wish to run the processor with another time unit, you can compute the cycles from the clock frequency of the emulated processor.

In case the processor halts or enters idle mode and there are no pending events the function will return early.

The number of executed cycles.

Set floating point register value

Set 32 bit floating point register value

Set FPU register value

Set FPU register value

Set the program counter

The program counter will be set to the supplied value.

Set the register in the processor

Set the PowerPC SPR register

Run the processor for a number of steps

This function is different from temu_cpuRun, which runs for a time. The steps here indicates instructions executed (including trapping instructions). This can be contrasted to the run function which may advance the cycle counter by more than one for an instruction (depending on the timing models).

The function may return early in case the processor halts its execution or has entered idle mode and there are no events pending.

The number of executed steps.

Uses the MMU to translate the given virtual address Va to the physical address in the emulator

error code. 0 on success, non-zero otherwise,

Register a class command

Opaque handle to command. NULL in case of failure.

Create and register global command

Create an object in a component.

This function works as the temu_createObject, except that the object created is inserted in the component.

The function is indended to be used in the component constructor.

Object names are uniqued using the objnamefmt paramters and following varargs. Plus, that the name of the component itself is prefixed as '[compname]-'.

Pointer to created object.

Create a new GDB server

Opaque handle to GDB server.

Create object with class and name.

Allocated object. Result is NULL in case of: class does not exist, object already allocated with the given name, out of memory.

Checks whether A + L crosses power of 2 boundary (e.g. page)

True if boundary is crossed. False otherwise.

Checks whether A + L crosses power of 2 boundary (e.g. page)

True if boundary is crossed. False otherwise.

Count trailing zeroes, this can be used as a square root on a power of 2 word.

Number of trailing zeros in Word

Count trailing zeroes, this can be used as a square root on a power of 2 word.

Number of trailing zeros in Word

Count trailing zeroes

The number of trailing zeros in Word

Convert cycles to nanoseconds

Cycles converted to nanoseconds

Convert cycles to another frequency base, rounding upwards

Cycles, converted from source frequency to target frequency

Convert cycles to another frequency base, with truncated result

Cycles, converted from source frequency to target frequency