#include <device.hpp>

Inheritance diagram for Device:

Signals
void	onProgress (uint32_t current=0, uint32_t total=0, bool done=false, bool success=true, bool canceled=false)
	Triggered when progress is changed, or operation is done or canceled. More...

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

virtual	~Device ()
	Destructor. More...

virtual bool	is16Bit () const
	Returns if device is 16-Bit. More...

virtual void	setSize (uint32_t value)
	Sets the device size. More...

virtual uint32_t	getSize () const
	Returns the device size (in bytes). More...

virtual void	setPort (const QString &path)
	Sets the serial port path. More...

virtual QString	getPort () const
	Returns the serial port path (if any). 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...

virtual void	setTwp (uint32_t us)
	Sets the tWP. More...

virtual uint32_t	getTwp () const
	Returns the configured tWP (in microseconds). More...

virtual void	setTwc (uint32_t us)
	Sets the tWC. More...

virtual uint32_t	getTwc () const
	Returns the configured tWC (in microseconds). More...

virtual void	setVddRd (float value)
	Sets the VDD to Read. More...

virtual float	getVddRd () const
	Returns the configured VDD to Read (in volts). More...

virtual void	setVddWr (float value)
	Sets the VDD to Program. More...

virtual float	getVddWr () const
	Returns the configured VDD to Program (in volts). More...

virtual void	setVpp (float value)
	Sets the VPP. More...

virtual float	getVpp () const
	Returns the configured VPP (in volts). More...

virtual void	setVee (float value)
	Sets the VEE. More...

virtual float	getVee () const
	Returns the configured VEE (in volts). More...

virtual void	setSkipFF (bool value=true)
	Sets the Skip Prog 0xFF. More...

virtual bool	getSkipFF () const
	Returns the configured Skip Prog 0xFF. More...

virtual void	setFastProg (bool value=true)
	Sets the Fast Prog/Erase. More...

virtual bool	getFastProg () const
	Returns the configured Fast Prog/Erase. More...

virtual void	setSectorSize (uint16_t value)
	Sets the Sector Size. More...

virtual uint16_t	getSectorSize () const
	Returns the configured Sector Size (in bytes). More...

virtual TDeviceInformation	getInfo () const
	Returns the Device Information. More...

virtual void	cancel ()
	Cancels the active operation (if any). More...

virtual bool	getId (TDeviceID &result)
	Gets the Device ID. More...

virtual bool	read (QByteArray &buffer)
	Read the Device. More...

virtual bool	program (const QByteArray &buffer, bool verify=false)
	Program the Device. More...

virtual bool	verify (const QByteArray &buffer)
	Verifies the Device. More...

virtual bool	erase (bool check=false)
	Erases the Device. More...

virtual bool	blankCheck ()
	Verifies if the Device is blank. More...

virtual bool	unprotect ()
	Unprotects the Device. More...

virtual bool	protect ()
	Protects the Device. More...

Detailed Description

Device Base Class.

The purpose of this class is to provide a base class of a memory device that can be read and/or written/erased.

Constructor & Destructor Documentation

◆ Device()

Device ( QObject * parent = nullptr )

explicit

Constructor.

Parameters

parent Pointer to parent object. Default is nullptr.

◆ ~Device()

~Device ( )

virtual

Destructor.

Member Function Documentation

◆ is16Bit()

bool is16Bit ( ) const

virtual

Returns if device is 16-Bit.

Returns: True if device is 16-Bit. False if device is 8-Bit.

◆ setSize()

void setSize ( uint32_t value )

virtual

Sets the device size.

Parameters

value Device size, in bytes.

Reimplemented in EPROM, EEPROM28AT, EEPROM, and Dummy.

◆ getSize()

uint32_t getSize ( ) const

virtual

Returns the device size (in bytes).

Returns: Device size, in bytes.

◆ setPort()

void setPort ( const QString & path )

virtual

Sets the serial port path.

Parameters

path	Serial port path.

◆ getPort()

QString getPort ( ) const

virtual

Returns the serial port path (if any).

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

◆ 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.

◆ setTwp()

void setTwp ( uint32_t us )

virtual

Sets the tWP.

Parameters

us	tWP value, in microseconds.

◆ getTwp()

uint32_t getTwp ( ) const

virtual

Returns the configured tWP (in microseconds).

Returns: tWP value, in microseconds.

◆ setTwc()

void setTwc ( uint32_t us )

virtual

Sets the tWC.

Parameters

us	tWC value, in microseconds.

◆ getTwc()

uint32_t getTwc ( ) const

virtual

Returns the configured tWC (in microseconds).

Returns: tWC value, in microseconds.

◆ setVddRd()

void setVddRd ( float value )

virtual

Sets the VDD to Read.

Parameters

value VDD value, in volts.

◆ getVddRd()

float getVddRd ( ) const

virtual

Returns the configured VDD to Read (in volts).

Returns: VDD value, in volts.

◆ setVddWr()

void setVddWr ( float value )

virtual

Sets the VDD to Program.

Parameters

value VDD value, in volts.

◆ getVddWr()

float getVddWr ( ) const

virtual

Returns the configured VDD to Program (in volts).

Returns: VDD value, in volts.

◆ setVpp()

void setVpp ( float value )

virtual

Sets the VPP.

Parameters

value VPP value, in volts.

◆ getVpp()

float getVpp ( ) const

virtual

Returns the configured VPP (in volts).

Returns: VPP value, in volts.

◆ setVee()

void setVee ( float value )

virtual

Sets the VEE.

Parameters

value VEE value, in volts.

◆ getVee()

float getVee ( ) const

virtual

Returns the configured VEE (in volts).

Returns: VEE value, in volts.

◆ setSkipFF()

void setSkipFF ( bool value = true )

virtual

Sets the Skip Prog 0xFF.

Parameters

value If true (default), enables skip prog 0xFF, disables otherwise.

◆ getSkipFF()

bool getSkipFF ( ) const

virtual

Returns the configured Skip Prog 0xFF.

Returns: If true, skip prog 0xFF is enabled, disabled otherwise.

◆ setFastProg()

void setFastProg ( bool value = true )

virtual

Sets the Fast Prog/Erase.

Parameters

value If true (default), enables fast prog/erase, disables otherwise.

◆ getFastProg()

bool getFastProg ( ) const

virtual

Returns the configured Fast Prog/Erase.

Returns: If true, fast prog/erase is enabled, disabled otherwise.

◆ setSectorSize()

void setSectorSize ( uint16_t value )

virtual

Sets the Sector Size.

Parameters

value Sector size, in bytes.

◆ getSectorSize()

uint16_t getSectorSize ( ) const

virtual

Returns the configured Sector Size (in bytes).

Returns: Sector size value, in bytes.

◆ getInfo()

TDeviceInformation getInfo ( ) const

virtual

Returns the Device Information.

Returns: Device Information.

◆ cancel()

void cancel ( )

virtual

Cancels the active operation (if any).

◆ getId()

bool getId ( TDeviceID & result )

virtual

Gets the Device ID.

Parameters

[out] result Reference to TDeviceID structure to receive data.

Returns: True if success, false otherwise.

Reimplemented in ParDevice, and Dummy.

◆ read()

bool read ( QByteArray & buffer )

virtual

Read the Device.

Parameters

[out] buffer Reference to QByteArray to receive data.

Returns: True if success, false otherwise.

Reimplemented in ParDevice, and Dummy.

◆ program()

bool program	(	const QByteArray &	buffer,
		bool	verify = `false`
	)

virtual

Program the Device.

Parameters

[out]	buffer	Data to write.
	verify	If true, calls Device::verify() after program. Default is false.

Returns: True if success, false otherwise.

Reimplemented in SRAM, ParDevice, and Dummy.

◆ verify()

bool verify ( const QByteArray & buffer )

virtual

Verifies the Device.

Parameters

buffer Data to compare.

Returns: True if success, false otherwise.

Reimplemented in ParDevice, and Dummy.

◆ erase()

bool erase ( bool check = false )

virtual

Erases the Device.

Parameters

check If true, calls Device::blankCheck() after erase. Default is false.

Returns: True if success, false otherwise.

Reimplemented in ParDevice, and Dummy.

◆ blankCheck()

bool blankCheck ( )

virtual

Verifies if the Device is blank.

Returns: True if device is blank, false otherwise.

Reimplemented in ParDevice, and Dummy.

◆ unprotect()

bool unprotect ( )

virtual

Unprotects the Device.

Returns: True if success, false otherwise.

Reimplemented in ParDevice, and Dummy.

◆ protect()

bool protect ( )

virtual

Protects the Device.

Returns: True if success, false otherwise.

Reimplemented in ParDevice, and Dummy.

◆ onProgress

void onProgress	(	uint32_t	current = `0`,
		uint32_t	total = `0`,
		bool	done = `false`,
		bool	success = `true`,
		bool	canceled = `false`
	)

signal

Triggered when progress is changed, or operation is done or canceled.

Parameters

current	Current address (default is zero).
total	Total size [last address + 1] (default is zero).
done	True if operation was finished, false otherwise (default).
success	True if success (default), false otherwise.
canceled	True if operation was canceled, false otherwise (default).

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

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Device()

◆ ~Device()

Member Function Documentation

◆ is16Bit()

◆ setSize()

◆ getSize()

◆ setPort()

◆ getPort()

◆ getBufferSize()

◆ setBufferSize()

◆ setTwp()

◆ getTwp()

◆ setTwc()

◆ getTwc()

◆ setVddRd()

◆ getVddRd()

◆ setVddWr()

◆ getVddWr()

◆ setVpp()

◆ getVpp()

◆ setVee()

◆ getVee()

◆ setSkipFF()

◆ getSkipFF()

◆ setFastProg()

◆ getFastProg()

◆ setSectorSize()

◆ getSectorSize()

◆ getInfo()

◆ cancel()

◆ getId()

◆ read()

◆ program()

◆ verify()

◆ erase()

◆ blankCheck()

◆ unprotect()

◆ protect()

◆ onProgress