doryan/BloomPatched
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Removed redundant 'Bloom' namespace from entire codebase

Browse Source
This commit is contained in:
Nav
2023-08-13 15:47:51 +01:00
parent 0935ba65cf
commit 5896306f1a
555 changed files with 6254 additions and 6510 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
src/DebugToolDrivers/DebugTool.hpp
View File

@@ -10,103 +10,100 @@
#include "TargetInterfaces/Microchip/AVR/AvrIspInterface.hpp"
namespace Bloom
/**
* A debug tool can be any device that provides access to the connected target. Debug tools are usually connected
* to the host machine via USB.
*
* Each debug tool must implement this interface. Note that target specific driver code should not be placed here.
* Each target family will expect the debug tool to provide an interface for that particular group of targets.
* For an example, see the Avr8DebugInterface class and DebugTool::getAvr8DebugInterface(), for the family of AVR
* 8-bit targets.
*/
class DebugTool
{
public:
DebugTool() = default;
virtual ~DebugTool() = default;
DebugTool(const DebugTool& other) = default;
DebugTool(DebugTool&& other) = default;
DebugTool& operator = (const DebugTool& other) = default;
DebugTool& operator = (DebugTool&& other) = default;
/**
* A debug tool can be any device that provides access to the connected target. Debug tools are usually connected
* to the host machine via USB.
*
* Each debug tool must implement this interface. Note that target specific driver code should not be placed here.
* Each target family will expect the debug tool to provide an interface for that particular group of targets.
* For an example, see the Avr8DebugInterface class and DebugTool::getAvr8DebugInterface(), for the family of AVR
* 8-bit targets.
* Should establish a connection to the device and prepare it for a debug session.
*/
class DebugTool
{
public:
DebugTool() = default;
virtual ~DebugTool() = default;
virtual void init() = 0;
DebugTool(const DebugTool& other) = default;
DebugTool(DebugTool&& other) = default;
/**
* Should disconnect from the device after performing any tasks required to formally end the debug session.
*/
virtual void close() = 0;
DebugTool& operator = (const DebugTool& other) = default;
DebugTool& operator = (DebugTool&& other) = default;
virtual std::string getName() = 0;
/**
* Should establish a connection to the device and prepare it for a debug session.
*/
virtual void init() = 0;
virtual std::string getSerialNumber() = 0;
/**
* Should disconnect from the device after performing any tasks required to formally end the debug session.
*/
virtual void close() = 0;
/**
* All debug tools that support target power management functions must provide an implementation of the
* TargetPowerManagementInterface class, via this function.
*
* For debug tools that cannot manage target power, a nullptr should be returned.
*
* Note: the caller of this function will not manage the lifetime of the returned TargetPowerManagementInterface
* instance.
*
* @return
*/
virtual DebugToolDrivers::TargetInterfaces::TargetPowerManagementInterface* getTargetPowerManagementInterface() {
return nullptr;
}
virtual std::string getName() = 0;
/**
* All debug tools that support debugging operations on AVR8 targets must provide an implementation of
* the Avr8DebugInterface class, via this function.
*
* For debug tools that do not support debugging on AVR8 targets, this function should return a nullptr.
*
* Note: the caller of this function will not manage the lifetime of the returned Avr8DebugInterface instance.
*
* @return
*/
virtual DebugToolDrivers::TargetInterfaces::Microchip::Avr::Avr8::Avr8DebugInterface* getAvr8DebugInterface(
const Targets::Microchip::Avr::Avr8Bit::Avr8TargetConfig& targetConfig,
Targets::Microchip::Avr::Avr8Bit::Family targetFamily,
const Targets::Microchip::Avr::Avr8Bit::TargetParameters& targetParameters,
const Targets::TargetRegisterDescriptorMapping& targetRegisterDescriptorsById
) {
return nullptr;
}
virtual std::string getSerialNumber() = 0;
/**
* All debug tools that support interfacing with AVR targets via the ISP interface must provide an
* implementation of the AvrIspInterface class, via this function.
*
* For debug tools that do not support the interface, a nullptr should be returned.
*
* Note: the caller of this function will not manage the lifetime of the returned AvrIspInterface instance.
*
* @return
*/
virtual DebugToolDrivers::TargetInterfaces::Microchip::Avr::AvrIspInterface* getAvrIspInterface(
const Targets::Microchip::Avr::Avr8Bit::Avr8TargetConfig& targetConfig
) {
return nullptr;
}
/**
* All debug tools that support target power management functions must provide an implementation of the
* TargetPowerManagementInterface class, via this function.
*
* For debug tools that cannot manage target power, a nullptr should be returned.
*
* Note: the caller of this function will not manage the lifetime of the returned TargetPowerManagementInterface
* instance.
*
* @return
*/
virtual DebugToolDrivers::TargetInterfaces::TargetPowerManagementInterface* getTargetPowerManagementInterface() {
return nullptr;
}
[[nodiscard]] bool isInitialised() const {
return this->initialised;
}
/**
* All debug tools that support debugging operations on AVR8 targets must provide an implementation of
* the Avr8DebugInterface class, via this function.
*
* For debug tools that do not support debugging on AVR8 targets, this function should return a nullptr.
*
* Note: the caller of this function will not manage the lifetime of the returned Avr8DebugInterface instance.
*
* @return
*/
virtual DebugToolDrivers::TargetInterfaces::Microchip::Avr::Avr8::Avr8DebugInterface* getAvr8DebugInterface(
const Targets::Microchip::Avr::Avr8Bit::Avr8TargetConfig& targetConfig,
Targets::Microchip::Avr::Avr8Bit::Family targetFamily,
const Targets::Microchip::Avr::Avr8Bit::TargetParameters& targetParameters,
const Targets::TargetRegisterDescriptorMapping& targetRegisterDescriptorsById
) {
return nullptr;
}
protected:
void setInitialised(bool initialised) {
this->initialised = initialised;
}
/**
* All debug tools that support interfacing with AVR targets via the ISP interface must provide an
* implementation of the AvrIspInterface class, via this function.
*
* For debug tools that do not support the interface, a nullptr should be returned.
*
* Note: the caller of this function will not manage the lifetime of the returned AvrIspInterface instance.
*
* @return
*/
virtual DebugToolDrivers::TargetInterfaces::Microchip::Avr::AvrIspInterface* getAvrIspInterface(
const Targets::Microchip::Avr::Avr8Bit::Avr8TargetConfig& targetConfig
) {
return nullptr;
}
[[nodiscard]] bool isInitialised() const {
return this->initialised;
}
protected:
void setInitialised(bool initialised) {
this->initialised = initialised;
}
private:
bool initialised = false;
};
}
private:
bool initialised = false;
};