cff0605b0a
- Added `tt::hal::Device` and functions (de)register devices and search for them. - Refactored apps: `Power` and `Display` settings apps now use the device API to find devices. - Implemented the new API for all existing drivers for all devices, including the simulator. - Updated HAL Configuration to return `std::shared_ptr` instead of raw pointers. - Added test project for headless tests and implemented tests for the new code.
84 lines
1.9 KiB
C++
84 lines
1.9 KiB
C++
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace tt::hal {
|
|
|
|
/**
|
|
* Base class for HAL-related devices.
|
|
*/
|
|
class Device {
|
|
|
|
public:
|
|
|
|
enum class Type {
|
|
I2c,
|
|
Display,
|
|
Touch,
|
|
SdCard,
|
|
Keyboard,
|
|
Power
|
|
};
|
|
|
|
typedef uint32_t Id;
|
|
|
|
private:
|
|
|
|
Id id;
|
|
|
|
public:
|
|
|
|
Device();
|
|
virtual ~Device() = default;
|
|
|
|
Id getId() const { return id; }
|
|
|
|
/** The type of device. */
|
|
virtual Type getType() const = 0;
|
|
|
|
/** The part number or hardware name e.g. TdeckTouch, TdeckDisplay, BQ24295, etc. */
|
|
virtual std::string getName() const = 0;
|
|
|
|
/** A short description of what this device does.
|
|
* e.g. "USB charging controller with I2C interface."
|
|
*/
|
|
virtual std::string getDescription() const = 0;
|
|
};
|
|
|
|
|
|
/**
|
|
* Adds a device to the registry.
|
|
* @warning This will leak memory if you want to destroy a device and don't call deregisterDevice()!
|
|
*/
|
|
void registerDevice(const std::shared_ptr<Device>& device);
|
|
|
|
/** Remove a device from the registry. */
|
|
void deregisterDevice(const std::shared_ptr<Device>& device);
|
|
|
|
/** Find a device in the registry by its name. */
|
|
std::shared_ptr<Device> _Nullable findDevice(std::string name);
|
|
|
|
/** Find a device in the registry by its identifier. */
|
|
std::shared_ptr<Device> _Nullable findDevice(Device::Id id);
|
|
|
|
/** Find 0, 1 or more devices in the registry by type. */
|
|
std::vector<std::shared_ptr<Device>> findDevices(Device::Type type);
|
|
|
|
/** Get a copy of the entire device registry in its current state. */
|
|
std::vector<std::shared_ptr<Device>> getDevices();
|
|
|
|
template<class DeviceType>
|
|
std::shared_ptr<DeviceType> findFirstDevice(Device::Type type) {
|
|
auto devices = findDevices(type);
|
|
if (devices.empty()) {
|
|
return {};
|
|
} else {
|
|
auto& first = devices[0];
|
|
return std::static_pointer_cast<DeviceType>(first);
|
|
}
|
|
}
|
|
|
|
}
|