Abstract radio interface. More...

#include <radiointerface.hh>

Inheritance diagram for RadioInterface:

[legend]

Public Member Functions
virtual	~RadioInterface ()
	Destructor.

virtual bool	isOpen () const =0
	Return `true` if a connection to the device has been established.

virtual void	close ()=0
	Closes the connection to the device.

virtual RadioInfo	identifier (const ErrorStack &err=ErrorStack())=0
	Returns a device identifier.

virtual bool	write_start (uint32_t bank, uint32_t addr, const ErrorStack &err=ErrorStack())=0
	Starts the write process into the specified bank and at the given address. More...

virtual bool	write (uint32_t bank, uint32_t addr, uint8_t *data, int nbytes, const ErrorStack &err=ErrorStack())=0
	Writes a chunk of `data` at the address `addr`. More...

virtual bool	write_finish (const ErrorStack &err=ErrorStack())=0
	This function ends a series of `write` operations. More...

virtual bool	read_start (uint32_t bank, uint32_t addr, const ErrorStack &err=ErrorStack())=0
	Starts the read process from the specified bank and at the given address. More...

virtual bool	read (uint32_t bank, uint32_t addr, uint8_t *data, int nbytes, const ErrorStack &err=ErrorStack())=0
	Reads a chunk of data from the block-address `bno` (block number). More...

virtual bool	read_finish (const ErrorStack &err=ErrorStack())=0
	This function ends a series of `read` operations. More...

virtual bool	reboot (const ErrorStack &err=ErrorStack())
	Some radios need to be rebooted after being read or programmed. More...

Protected Member Functions
	RadioInterface ()
	Hidden constructor.

Detailed Description

Abstract radio interface.

A radion interface must provide means to communicate with the device. That is, open a connection to the device, allow for reading and writing specific memory blocks.

This class defines the common interface for all radio-interface classes, irrespective of the actual communication protocoe l being used by the device.

Member Function Documentation

◆ read()

virtual bool RadioInterface::read	(	uint32_t	bank,
		uint32_t	addr,
		uint8_t *	data,
		int	nbytes,
		const ErrorStack &	err = `ErrorStack()`
	)

pure virtual

Reads a chunk of data from the block-address bno (block number).

Parameters

bank	Specifies the memory bank to read from. Usually there is only one bank. Some radios, however, to have several memory banks to hold the codeplug. For example the Open GD77 has EEPROM and Flash memory banks with independent addresses.
addr	Specifies the address to read from.
data	Pointer where to store the read data.
nbytes	Specifies the number of bytes to read.
err	Passes an error stack to put error messages on.

Returns: true on success.

Implemented in TyTInterface, OpenRTXInterface, OpenGD77Interface, and AnytoneInterface.

◆ read_finish()

virtual bool RadioInterface::read_finish ( const ErrorStack & err = ErrorStack() )

pure virtual

This function ends a series of read operations.

This function will be re-implemented by certain interfaces that need completion of read operations (e.g., HID).

Parameters

err	Passes an error stack to put error messages on.

Implemented in TyTInterface, RadioddityInterface, OpenRTXInterface, OpenGD77Interface, and AnytoneInterface.

◆ read_start()

virtual bool RadioInterface::read_start	(	uint32_t	bank,
		uint32_t	addr,
		const ErrorStack &	err = `ErrorStack()`
	)

pure virtual

Starts the read process from the specified bank and at the given address.

Parameters

bank	Specifies the memory bank to read from. Usually there is only one bank. Some radios, however, to have several memory banks to hold the codeplug. For example the Open GD77 has EEPROM and Flash memory banks with independent addresses.
addr	Specifies the address to read from.
err	Passes an error stack to put error messages on.

Implemented in TyTInterface, RadioddityInterface, OpenRTXInterface, OpenGD77Interface, and AnytoneInterface.

◆ reboot()

bool RadioInterface::reboot ( const ErrorStack & err = ErrorStack() )

virtual

Some radios need to be rebooted after being read or programmed.

This function will be re-implemented by some interfaces (e.g., DFUDevice) to reboot the radio. By default this function does nothing.

Parameters

err	Passes an error stack to put error messages on.

Reimplemented in TyTInterface, OpenRTXInterface, OpenGD77Interface, and AnytoneInterface.

◆ write()

virtual bool RadioInterface::write	(	uint32_t	bank,
		uint32_t	addr,
		uint8_t *	data,
		int	nbytes,
		const ErrorStack &	err = `ErrorStack()`
	)

pure virtual

Writes a chunk of data at the address addr.

Parameters

bank	Specifies the memory bank to write to. Usually there is only one bank. Some radios, however, to have several memory banks to hold the codeplug. For example the Open GD77 has EEPROM and Flash memory banks with independent addresses.
addr	Specifies the address to write to.
data	Pointer to the actual data to be written.
nbytes	Specifies the number of bytes to write.
err	Passes an error stack to put error messages on.

Returns: true on success.

Implemented in TyTInterface, OpenRTXInterface, OpenGD77Interface, and AnytoneInterface.

◆ write_finish()

bool RadioInterface::write_finish ( const ErrorStack & err = ErrorStack() )

pure virtual

This function ends a series of write operations.

This function will be implemented by certain interfaces that need completion of write operations (e.g., HID).

Parameters

err	Passes an error stack to put error messages on.

Implemented in TyTInterface, RadioddityInterface, OpenRTXInterface, OpenGD77Interface, and AnytoneInterface.

◆ write_start()

virtual bool RadioInterface::write_start	(	uint32_t	bank,
		uint32_t	addr,
		const ErrorStack &	err = `ErrorStack()`
	)

pure virtual

Starts the write process into the specified bank and at the given address.

Parameters

bank	Specifies the memory bank to write to. Usually there is only one bank. Some radios, however, to have several memory banks to hold the codeplug. For example the Open GD77 has EEPROM and Flash memory banks with independent addresses.
addr	Specifies the address to write to.
err	Passes an error stack to put error messages on.

Implemented in TyTInterface, RadioddityInterface, OpenRTXInterface, OpenGD77Interface, and AnytoneInterface.

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

/home/hannes/Software/qdmr/lib/radiointerface.hh
/home/hannes/Software/qdmr/lib/radiointerface.cc

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ read()

◆ read_finish()

◆ read_start()

◆ reboot()

◆ write()

◆ write_finish()

◆ write_start()