#include <runner.hpp>

Inherits QObject.

Public Member Functions
	Runner (QObject *parent=nullptr)
	Constructor. More...

	~Runner ()
	Destructor. More...

TSerialPortList	list () const
	Lists all serial ports that correspond to the device boards. More...

bool	open (const QString &path)
	Opens a serial port. More...

void	close ()
	Closes an opened serial port. More...

bool	isOpen () const
	Returns if a serial is opened. More...

bool	hasError () const
	Returns if an error was occurred. More...

QString	getPath () const
	Returns the current opened serial port path (if any). More...

uint32_t	getTimeOut () const
	Returns the current timeout value of the serial port communication. More...

void	setTimeOut (uint32_t value)
	Sets the timeout value of the serial port communication. More...

uint8_t	getBufferSize () const
	Returns the current buffer size value for buffer operations. More...

void	setBufferSize (uint8_t value)
	Sets the buffer size value for buffer operations. More...

bool	nop ()
	Runs the NOP opcode. More...

bool	vddCtrl (bool on=true)
	Runs the VDD Control opcode. More...

bool	vddSet (float value)
	Runs the VDD Set Voltage opcode. More...

float	vddGet ()
	Runs the VDD Get Voltage opcode. More...

float	vddGetDuty ()
	Runs the VDD Get Duty Cycle opcode. More...

bool	vddInitCal ()
	Runs the VDD Init Calibration opcode. More...

bool	vddSaveCal (float value)
	Runs the VDD Save Calibration opcode. More...

float	vddGetCal ()
	Runs the VDD Get Calibration opcode. More...

bool	vppCtrl (bool on=true)
	Runs the VPP Control opcode. More...

bool	vppSet (float value)
	Runs the VPP Set Voltage opcode. More...

float	vppGet ()
	Runs the VPP Get Voltage opcode. More...

float	vppGetDuty ()
	Runs the VPP Get Duty Cycle opcode. More...

bool	vppInitCal ()
	Runs the VPP Init Calibration opcode. More...

bool	vppSaveCal (float value)
	Runs the VPP Save Calibration opcode. More...

float	vppGetCal ()
	Runs the VPP Get Calibration opcode. More...

bool	vddOnVpp (bool on=true)
	Runs the VDD on VPP Control opcode. More...

bool	vppOnA9 (bool on=true)
	Runs the VPP on A9 Control opcode. More...

bool	vppOnA18 (bool on=true)
	Runs the VPP on A18 Control opcode. More...

bool	vppOnCE (bool on=true)
	Runs the VPP on CE Control opcode. More...

bool	vppOnOE (bool on=true)
	Runs the VPP on OE Control opcode. More...

bool	vppOnWE (bool on=true)
	Runs the VPP on WE Control opcode. More...

bool	setCE (bool on=true)
	Runs the CE Control opcode. More...

bool	setOE (bool on=true)
	Runs the OE Control opcode. More...

bool	setWE (bool on=true)
	Runs the WE Control opcode. More...

bool	addrClr ()
	Runs the Address Clear opcode. More...

bool	addrInc ()
	Runs the Address Increment opcode. More...

bool	addrSet (uint32_t value)
	Runs the Address Set (DWord) opcode. More...

bool	addrSetB (uint8_t value)
	Runs the Address Set Byte opcode. More...

bool	addrSetW (uint16_t value)
	Runs the Address Set Word opcode. More...

uint32_t	addrGet () const
	Returns the last address. More...

bool	dataClr ()
	Runs the Data Clear opcode. More...

bool	dataSet (uint8_t value)
	Runs the Data Set Byte opcode. More...

bool	dataSetW (uint16_t value)
	Runs the Data Set Word opcode. More...

uint8_t	dataGet ()
	Runs the Data Get Byte opcode. More...

uint16_t	dataGetW ()
	Runs the Data Get Word opcode. More...

bool	deviceSetTwp (uint32_t value)
	Runs the Device Set tWP opcode. More...

bool	deviceSetTwc (uint32_t value)
	Runs the Device Set tWC opcode. More...

bool	deviceConfigure (kCmdDeviceAlgorithmEnum algo, const TDeviceFlags &flags)
	Runs the Device Configure opcode. More...

bool	deviceSetupBus (kCmdDeviceOperationEnum operation)
	Runs the Device Setup Bus opcode. More...

bool	deviceResetBus ()
	Runs the Device Setup Bus opcode, with operation Reset. More...

QByteArray	deviceRead ()
	Runs the Device Read Buffer opcode. More...

bool	deviceWrite (const QByteArray &data)
	Runs the Device Write Buffer opcode. More...

bool	deviceWriteSector (const QByteArray &data, uint16_t sectorSize)
	Runs the Device Write Sector opcode. More...

bool	deviceVerify (const QByteArray &data)
	Runs the Device Verify Buffer opcode. More...

bool	deviceBlankCheck ()
	Runs the Device Blank Check Buffer opcode. More...

TDeviceID	deviceGetId ()
	Runs the Device Get ID opcode. More...

bool	deviceErase ()
	Runs the Device Erase opcode. More...

bool	deviceUnprotect ()
	Runs the Device Unprotect opcode. More...

bool	deviceProtect ()
	Runs the Device Protect opcode. More...

Static Public Member Functions
static void	usDelay (uint64_t value)
	Pauses the program execution for a specified time (microsecond precision). More...

static void	msDelay (uint32_t value)
	Pauses the program execution for a specified time (millisecond precision). More...

static void	processEvents ()
	Process Application Events. More...

Detailed Description

Runner Class.

The purpose of this class is to run commands and get response via USB-CDC.

Constructor & Destructor Documentation

◆ Runner()

Runner ( QObject * parent = nullptr )

explicit

Constructor.

Parameters

parent Pointer to parent object. Default is nullptr.

◆ ~Runner()

~Runner ( )

Destructor.

Member Function Documentation

◆ list()

TSerialPortList list ( ) const

Lists all serial ports that correspond to the device boards.

Returns: List of serial port info.

◆ open()

bool open ( const QString & path )

Opens a serial port.

Parameters

path	Path of the serial port (system dependent).

Returns: True if success, false otherwise.

◆ close()

void close ( )

Closes an opened serial port.

◆ isOpen()

bool isOpen ( ) const

Returns if a serial is opened.

Returns: True if a serial port is opened, false otherwise.

◆ hasError()

bool hasError ( ) const

Returns if an error was occurred.

Returns: True if an error was occurred, false otherwise.

◆ getPath()

QString getPath ( ) const

Returns the current opened serial port path (if any).

Returns: Path of opened serial port, or empty if none.

◆ getTimeOut()

uint32_t getTimeOut ( ) const

Returns the current timeout value of the serial port communication.

Returns: Timeout, in msec.

◆ setTimeOut()

void setTimeOut ( uint32_t value )

Sets the timeout value of the serial port communication.

Parameters

value Timeout, in msec.

◆ getBufferSize()

uint8_t getBufferSize ( ) const

Returns the current buffer size value for buffer operations.

Returns: Buffer size, in bytes.

◆ setBufferSize()

void setBufferSize ( uint8_t value )

Sets the buffer size value for buffer operations.

Parameters

value Buffer size, in bytes.

◆ nop()

bool nop ( )

Runs the NOP opcode.

Returns: True if success, false otherwise.

◆ vddCtrl()

bool vddCtrl ( bool on = true )

Runs the VDD Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ vddSet()

bool vddSet ( float value )

Runs the VDD Set Voltage opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ vddGet()

float vddGet ( )

Runs the VDD Get Voltage opcode.

Returns: VDD Voltage if success, -1.0f otherwise.

◆ vddGetDuty()

float vddGetDuty ( )

Runs the VDD Get Duty Cycle opcode.

Returns: VDD Duty Cycle if success, -1.0f otherwise.

◆ vddInitCal()

bool vddInitCal ( )

Runs the VDD Init Calibration opcode.

Returns: True if success, false otherwise.

◆ vddSaveCal()

bool vddSaveCal ( float value )

Runs the VDD Save Calibration opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ vddGetCal()

float vddGetCal ( )

Runs the VDD Get Calibration opcode.

Returns: VDD Calibration if success, -1.0f otherwise.

◆ vppCtrl()

bool vppCtrl ( bool on = true )

Runs the VPP Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ vppSet()

bool vppSet ( float value )

Runs the VPP Set Voltage opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ vppGet()

float vppGet ( )

Runs the VPP Get Voltage opcode.

Returns: VPP Voltage if success, -1.0f otherwise.

◆ vppGetDuty()

float vppGetDuty ( )

Runs the VPP Get Duty Cycle opcode.

Returns: VPP Duty Cycle if success, -1.0f otherwise.

◆ vppInitCal()

bool vppInitCal ( )

Runs the VPP Init Calibration opcode.

Returns: True if success, false otherwise.

◆ vppSaveCal()

bool vppSaveCal ( float value )

Runs the VPP Save Calibration opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ vppGetCal()

float vppGetCal ( )

Runs the VPP Get Calibration opcode.

Returns: VPP Calibration if success, -1.0f otherwise.

◆ vddOnVpp()

bool vddOnVpp ( bool on = true )

Runs the VDD on VPP Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ vppOnA9()

bool vppOnA9 ( bool on = true )

Runs the VPP on A9 Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ vppOnA18()

bool vppOnA18 ( bool on = true )

Runs the VPP on A18 Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ vppOnCE()

bool vppOnCE ( bool on = true )

Runs the VPP on CE Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ vppOnOE()

bool vppOnOE ( bool on = true )

Runs the VPP on OE Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ vppOnWE()

bool vppOnWE ( bool on = true )

Runs the VPP on WE Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ setCE()

bool setCE ( bool on = true )

Runs the CE Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ setOE()

bool setOE ( bool on = true )

Runs the OE Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ setWE()

bool setWE ( bool on = true )

Runs the WE Control opcode.

Parameters

on	If true (default), sets the pin. Resets otherwise.

Returns: True if success, false otherwise.

◆ addrClr()

bool addrClr ( )

Runs the Address Clear opcode.

Returns: True if success, false otherwise.

◆ addrInc()

bool addrInc ( )

Runs the Address Increment opcode.

Returns: True if success, false otherwise.

◆ addrSet()

bool addrSet ( uint32_t value )

Runs the Address Set (DWord) opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ addrSetB()

bool addrSetB ( uint8_t value )

Runs the Address Set Byte opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ addrSetW()

bool addrSetW ( uint16_t value )

Runs the Address Set Word opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ addrGet()

uint32_t addrGet ( ) const

Returns the last address.

Returns: The last address value.

◆ dataClr()

bool dataClr ( )

Runs the Data Clear opcode.

Returns: True if success, false otherwise.

◆ dataSet()

bool dataSet ( uint8_t value )

Runs the Data Set Byte opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ dataSetW()

bool dataSetW ( uint16_t value )

Runs the Data Set Word opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ dataGet()

uint8_t dataGet ( )

Runs the Data Get Byte opcode.

Returns: Data value if success, 0xFF otherwise.

◆ dataGetW()

uint16_t dataGetW ( )

Runs the Data Get Word opcode.

Returns: Data value if success, 0xFFFF otherwise.

◆ deviceSetTwp()

bool deviceSetTwp ( uint32_t value )

Runs the Device Set tWP opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ deviceSetTwc()

bool deviceSetTwc ( uint32_t value )

Runs the Device Set tWC opcode.

Parameters

value Value to set.

Returns: True if success, false otherwise.

◆ deviceConfigure()

bool deviceConfigure	(	kCmdDeviceAlgorithmEnum	algo,
		const TDeviceFlags &	flags
	)

Runs the Device Configure opcode.

Parameters

algo	Device Algorithm.
flags	Device Flags.

Returns: True if success, false otherwise.

◆ deviceSetupBus()

bool deviceSetupBus ( kCmdDeviceOperationEnum operation )

Runs the Device Setup Bus opcode.

Parameters

operation Operation to realize.

Returns: True if success, false otherwise.

◆ deviceResetBus()

bool deviceResetBus ( )

Runs the Device Setup Bus opcode, with operation Reset.

Returns: True if success, false otherwise.

◆ deviceRead()

QByteArray deviceRead ( )

Runs the Device Read Buffer opcode.

Returns: Read buffer if success, empty otherwise.

◆ deviceWrite()

bool deviceWrite ( const QByteArray & data )

Runs the Device Write Buffer opcode.

Parameters

data	Data to write.

Returns: True if success, false otherwise.

◆ deviceWriteSector()

bool deviceWriteSector	(	const QByteArray &	data,
		uint16_t	sectorSize
	)

Runs the Device Write Sector opcode.

Parameters

data	Data to write.
sectorSize	Size of sector to write, in bytes.

Returns: True if success, false otherwise.

◆ deviceVerify()

bool deviceVerify ( const QByteArray & data )

Runs the Device Verify Buffer opcode.

Parameters

data	Data to verify.

Returns: True if success, false otherwise.

◆ deviceBlankCheck()

bool deviceBlankCheck ( )

Runs the Device Blank Check Buffer opcode.

Returns: True if success, false otherwise.

◆ deviceGetId()

TDeviceID deviceGetId ( )

Runs the Device Get ID opcode.

Returns: Device/Manufacturer ID if success, zero values otherwise.

◆ deviceErase()

bool deviceErase ( )

Runs the Device Erase opcode.

Returns: True if success, false otherwise.

◆ deviceUnprotect()

bool deviceUnprotect ( )

Runs the Device Unprotect opcode.

Returns: True if success, false otherwise.

◆ deviceProtect()

bool deviceProtect ( )

Runs the Device Protect opcode.

Returns: True if success, false otherwise.

◆ usDelay()

void usDelay ( uint64_t value )

static

Pauses the program execution for a specified time (microsecond precision).

Parameters

value Sleep time, in usec.

◆ msDelay()

void msDelay ( uint32_t value )

static

Pauses the program execution for a specified time (millisecond precision).

Parameters

value Sleep time, in msec.

◆ processEvents()

void processEvents ( )

static

Process Application Events.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Runner()

◆ ~Runner()

Member Function Documentation

◆ list()

◆ open()

◆ close()

◆ isOpen()

◆ hasError()

◆ getPath()

◆ getTimeOut()

◆ setTimeOut()

◆ getBufferSize()

◆ setBufferSize()

◆ nop()

◆ vddCtrl()

◆ vddSet()

◆ vddGet()

◆ vddGetDuty()

◆ vddInitCal()

◆ vddSaveCal()

◆ vddGetCal()

◆ vppCtrl()

◆ vppSet()

◆ vppGet()

◆ vppGetDuty()

◆ vppInitCal()

◆ vppSaveCal()

◆ vppGetCal()

◆ vddOnVpp()

◆ vppOnA9()

◆ vppOnA18()

◆ vppOnCE()

◆ vppOnOE()

◆ vppOnWE()

◆ setCE()

◆ setOE()

◆ setWE()

◆ addrClr()

◆ addrInc()

◆ addrSet()

◆ addrSetB()

◆ addrSetW()

◆ addrGet()

◆ dataClr()

◆ dataSet()

◆ dataSetW()

◆ dataGet()

◆ dataGetW()

◆ deviceSetTwp()

◆ deviceSetTwc()

◆ deviceConfigure()

◆ deviceSetupBus()

◆ deviceResetBus()

◆ deviceRead()

◆ deviceWrite()

◆ deviceWriteSector()

◆ deviceVerify()

◆ deviceBlankCheck()

◆ deviceGetId()

◆ deviceErase()

◆ deviceUnprotect()

◆ deviceProtect()

◆ usDelay()

◆ msDelay()

◆ processEvents()