VM Operations - Smartrek

You are here:

KB Home
Virtual machine
VM Operations

Estimated reading time: 1 min

In this article

UserCall Functions

The virtual machine compiler interacts with native code through UserCall functions, which use the following syntax:

$ufX(Y, param1, param2, param3, …)

where, X is the function number fn#, and Y is the ALIAS#. Alias names are also available for more readable code.

Internal Buffer

Most VM operations access the internal byte-aligned general-purpose buffer. This buffer, referred to as the buffer in this document, can be used for multi-byte operations, in which case the index will refer to the index to the first byte of the data.

Operations Summary

Here are available VM functions.

Click on the + button to expand a row. For more information on a specific VM function, click on More to go the API documentation page of that function.

VM Functions

Alias Name	fn nb	Alias Nb	argc	argv	Category	Admin	Description	Link
GetBuffer_S8(r)	0	0x20	2	aliasID, r	Buffer commands	1	Get buffer byte at r as (int8), and return cast to int16
GetBuffer_U8(r)	0	0x21	2	aliasID, r	Buffer commands	1	Get buffer byte at r as (uint8), and return cast to int16
GetBuffer_16(r)	0	0x22	2	aliasID, r	Buffer commands	1	Get buffer r, 2 first bytes, as int16 / uint16, and return it verbatim (as int16)
InvBuffer_S32(r)	0	0x25	2	aliasID, r	Buffer commands	0	Invert the int32 at index r of the buffer.
GetRegisterRAMBUF(r, regOffset)	0	0x50	3	aliasID, r, regOffset	Buffer commands	0	Fetch register at regOffset, put it in r (RAMBUF)
GetRegisterRAM(r, regOffset)	0	0x51	3	aliasID, r, regOffset	Buffer commands	0	Fetch register at regOffset, put it in r (RAM)
GetRegisterEEPROM(r, regOffset)	0	0x52	3	aliasID, r, regOffset	Buffer commands	0	Fetch register at regOffset, put it in r (EEPROM)
SetRegisterRAMBUF(r, regOffset)	0	0x54	3	aliasID, r, regoffset	Buffer commands	0	Put content of r in register at regOffset (RAMBUF)
AssertBcastPinFromLastBcast10Us(r)	0	0x26	2	aliasID, r	Buffer commands	0	Assert broadcast LED at a time 10us (int32)buffer[r], from the beginning of the last broadcast cycle.
AssertBcastPinAtSystemTime10Us(r)	0	0x27	2	aliasID, r	Buffer commands	0	Assert bcast LED at buffer[r] where buffer[r] is in 10us (64 bit) increments, and is the time since beginning of last bcast cycle. The reference used is the system clock.
Alias Name	fn nb	Alias Nb	argc	argv	Category	Admin	Description	Link

Math functions

Some of the above functions are mathematical operations.

One variable math functions:

Math1VarExt_F32(r, rIn, funcID)
Math1Var_F32(r, funcID)

Two variables math functions:

Math2Var_F32(r1, r2, funcID)
Math2Var_I32(r1, r2, funcID)
Math2Var_I64(r1, r2, funcID)

The following math operations identified by funcId can be used with the VM math functions above.

One variable math functions

funcId	Function	Link
0	Invert
1	Sqrt
2	SqrtRount
3	ln
4	log base 2
5	log base 10
6	exp
7	exp base 2
8	exp base 10
9	sin

Two variable math functions

funcId	Function	Link
0	add
1	subtract
2	multiply
3	divide
4	modulo
5	shift left
6	atan2

Was this article helpful?

Like 0 Dislike 0