VSI Python interface

VSI python interface. More...

Content
	Python environment setup

Namespaces
namespace	arm_vsi0
	Documentation for VSI peripherals module.

Functions
def	init ()
	Initialize.
def	rdIRQ ()
	Read interrupt request (the VSI IRQ Status Register)
def	wrIRQ (value)
	Write interrupt request (the VSI IRQ Status Register)
def	wrTimer (index, value)
	Write Timer registers (the VSI Timer Registers)
def	timerEvent ()
	Timer event (called at Timer Overflow)
def	wrDMA (index, value)
	Write DMA registers (the VSI DMA Registers)
def	rdDataDMA (size)
	Read data from peripheral for DMA P2M transfer (VSI DMA)
def	wrDataDMA (data, size)
	Write data to peripheral for DMA M2P transfer (VSI DMA)
def	rdRegs (index)
	Read user registers (the VSI User Registers)
def	wrRegs (index, value)
	Write user registers (the VSI User Registers)

Variables
logging	verbosity = logging.ERROR
	Set verbosity level verbosity = logging.DEBUG.

Description

VSI python interface.

The Python interface described in this section gets executed upon access to corresponding VSI peripheral registers and events explained in the VSI API.

Each peripheral instance has a separate dedicated Python script file with the names arm_vsi0.py, arm_vsi1.py, ..., arm_vsi7.py.

The path to the python files implementing used interfaces shall be provided via the model configuration parameter v_path, that depending on the model is part of the mps2_board, mps3_board or mps4_board component. Section Running User Applications in CLI gives an example.

Function Documentation

init()

def init

(

)

Initialize.

Returns

None

rdIRQ()

def rdIRQ

(

)

Read interrupt request (the VSI IRQ Status Register)

Returns

value value read (32-bit)

wrIRQ()

def wrIRQ

(

value

)

Write interrupt request (the VSI IRQ Status Register)

Parameters

value

value to write (32-bit)

Returns

value value written (32-bit)

wrTimer()

def wrTimer	(		index,
			value
	)

Write Timer registers (the VSI Timer Registers)

Parameters

index	Timer register index (zero based)
value	value to write (32-bit)

Returns

value value written (32-bit)

timerEvent()

def timerEvent

(

)

Timer event (called at Timer Overflow)

Returns

None

wrDMA()

def wrDMA	(		index,
			value
	)

Write DMA registers (the VSI DMA Registers)

Parameters

index	DMA register index (zero based)
value	value to write (32-bit)

Returns

value value written (32-bit)

rdDataDMA()

def rdDataDMA

(

size

)

Read data from peripheral for DMA P2M transfer (VSI DMA)

Parameters

size	size of data to read (in bytes, multiple of 4)

Returns

data data read (bytearray)

wrDataDMA()

def wrDataDMA	(		data,
			size
	)

Write data to peripheral for DMA M2P transfer (VSI DMA)

Parameters

data	data to write (bytearray)
size	size of data to write (in bytes, multiple of 4)

Returns

None

rdRegs()

def rdRegs

(

index

)

Read user registers (the VSI User Registers)

Parameters

index

user register index (zero based)

Returns

value value read (32-bit)

wrRegs()

def wrRegs	(		index,
			value
	)

Write user registers (the VSI User Registers)

Parameters

index	user register index (zero based)
value	value to write (32-bit)

Returns

value value written (32-bit)