Remove old HAL components and refactored GPS-related code (#583)
- Added generic GPS/GNSS support with device detection, configuration, and persistent settings. - Improved device and module lifecycle management. - Added flexible filesystem locking support for displays and storage. - Improved display-idle and keyboard backlight handling. - Updated architecture, driver, module, testing, and licensing documentation. - Removed old HAL device and related code.
This commit is contained in:
committed by
GitHub
parent
29e80cfd65
commit
2a2558b29a
@@ -0,0 +1,167 @@
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
#include <gps/private/gps_ledger.h>
|
||||
|
||||
#include <gps/gps.h>
|
||||
#include <gps/gps_settings.h>
|
||||
#include <tactility/device.h>
|
||||
#include <tactility/driver.h>
|
||||
#include <tactility/log.h>
|
||||
|
||||
#include <cstdio>
|
||||
#include <cstring>
|
||||
#include <new>
|
||||
#include <vector>
|
||||
|
||||
constexpr auto* TAG = "gps_ledger";
|
||||
|
||||
struct GpsConfig {
|
||||
uint32_t baud_rate;
|
||||
enum GpsModel model;
|
||||
};
|
||||
|
||||
// A GPS_TYPE device the ledger constructed for a persisted GpsConfiguration. Device is the first
|
||||
// member so `reinterpret_cast<GpsLedgerEntry*>(device)` is safe when a Device* obtained from the
|
||||
// device tree needs to be freed.
|
||||
struct GpsLedgerEntry {
|
||||
Device device {};
|
||||
GpsConfig config {};
|
||||
// device->name points into this buffer - must outlive the device (device->name only stores a
|
||||
// pointer, it doesn't copy).
|
||||
char name[16] {};
|
||||
};
|
||||
|
||||
// Unique across every device the ledger creates, so device names ("gpsN") never collide.
|
||||
static uint32_t next_device_index = 0;
|
||||
|
||||
static bool device_matches_configuration(Device* device, const GpsConfiguration& configuration) {
|
||||
auto* parent = device_get_parent(device);
|
||||
if (parent == nullptr || strcmp(parent->name, configuration.uart_name) != 0) {
|
||||
return false;
|
||||
}
|
||||
const auto* config = static_cast<const GpsConfig*>(device->config);
|
||||
return config->baud_rate == configuration.baud_rate && config->model == configuration.model;
|
||||
}
|
||||
|
||||
// Constructs+adds (not started) a GPS_TYPE device wired to `configuration`'s named UART, tagged
|
||||
// DEVICE_FLAG_DYNAMIC so the ledger recognizes it as its own on a later sync.
|
||||
static bool create_device(const GpsConfiguration& configuration) {
|
||||
Device* uart = nullptr;
|
||||
if (device_get_by_name(configuration.uart_name, &uart) != ERROR_NONE) {
|
||||
LOG_E(TAG, "Failed to find device %s", configuration.uart_name);
|
||||
return false;
|
||||
}
|
||||
|
||||
auto* entry = new(std::nothrow) GpsLedgerEntry();
|
||||
if (entry == nullptr) {
|
||||
device_put(uart);
|
||||
return false;
|
||||
}
|
||||
entry->config = GpsConfig { .baud_rate = configuration.baud_rate, .model = configuration.model };
|
||||
snprintf(entry->name, sizeof(entry->name), "gps%u", (unsigned)next_device_index++);
|
||||
|
||||
auto* device = &entry->device;
|
||||
device->address = 0;
|
||||
device->name = entry->name;
|
||||
device->config = &entry->config;
|
||||
device->parent = nullptr;
|
||||
device->flags = DEVICE_FLAG_DYNAMIC;
|
||||
device->internal = nullptr;
|
||||
|
||||
bool ok = false;
|
||||
if (device_construct(device) == ERROR_NONE) {
|
||||
device_set_parent(device, uart);
|
||||
|
||||
Driver* driver = driver_find_compatible("tactility,gps-generic");
|
||||
if (driver != nullptr) {
|
||||
device_set_driver(device, driver);
|
||||
ok = device_add(device) == ERROR_NONE;
|
||||
if (!ok) {
|
||||
LOG_E(TAG, "Failed to add %s", device->name);
|
||||
}
|
||||
} else {
|
||||
LOG_E(TAG, "No driver registered for tactility,gps-generic");
|
||||
}
|
||||
|
||||
if (!ok) {
|
||||
device_destruct(device);
|
||||
}
|
||||
} else {
|
||||
LOG_E(TAG, "Failed to construct %s", device->name);
|
||||
}
|
||||
|
||||
device_put(uart);
|
||||
|
||||
if (!ok) {
|
||||
delete entry;
|
||||
}
|
||||
return ok;
|
||||
}
|
||||
|
||||
// Stops (if needed), removes and destructs a ledger-owned device, and frees its entry.
|
||||
static void destroy_device(Device* device) {
|
||||
if (device_is_ready(device)) {
|
||||
device_stop(device);
|
||||
}
|
||||
device_remove(device);
|
||||
device_destruct(device);
|
||||
delete reinterpret_cast<GpsLedgerEntry*>(device);
|
||||
}
|
||||
|
||||
static bool is_ledger_owned(const Device* device) {
|
||||
return !(device->flags & DEVICE_FLAG_DTS) && (device->flags & DEVICE_FLAG_DYNAMIC);
|
||||
}
|
||||
|
||||
// Collects the ledger-owned GPS_TYPE devices. device_remove()/device_stop() must not run while
|
||||
// device_for_each_of_type() holds the device ledger lock, so callers process the result afterwards.
|
||||
static std::vector<Device*> collect_owned_devices() {
|
||||
std::vector<Device*> owned;
|
||||
device_for_each_of_type(&GPS_TYPE, &owned, [](Device* device, void* context) {
|
||||
if (is_ledger_owned(device)) {
|
||||
static_cast<std::vector<Device*>*>(context)->push_back(device);
|
||||
}
|
||||
return true;
|
||||
});
|
||||
return owned;
|
||||
}
|
||||
|
||||
void gps_ledger_sync() {
|
||||
std::vector<GpsConfiguration> configurations;
|
||||
gps_settings_for_each_configuration(&configurations, [](const GpsConfiguration* configuration, size_t, void* context) {
|
||||
static_cast<std::vector<GpsConfiguration>*>(context)->push_back(*configuration);
|
||||
});
|
||||
|
||||
std::vector<bool> matched(configurations.size(), false);
|
||||
std::vector<Device*> stale;
|
||||
|
||||
for (auto* device : collect_owned_devices()) {
|
||||
bool found = false;
|
||||
for (size_t i = 0; i < configurations.size(); i++) {
|
||||
if (!matched[i] && device_matches_configuration(device, configurations[i])) {
|
||||
matched[i] = true;
|
||||
found = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!found) {
|
||||
stale.push_back(device);
|
||||
}
|
||||
}
|
||||
|
||||
// Configuration disappeared - stop, destruct and drop the device that was created for it.
|
||||
for (auto* device : stale) {
|
||||
destroy_device(device);
|
||||
}
|
||||
|
||||
// New configuration - create a (not started) device for it.
|
||||
for (size_t i = 0; i < configurations.size(); i++) {
|
||||
if (!matched[i]) {
|
||||
create_device(configurations[i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void gps_ledger_clear() {
|
||||
for (auto* device : collect_owned_devices()) {
|
||||
destroy_device(device);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user