Kernel improvements (#485)

* **New Features**
  * Added public accessors for querying module/device start and ready state.

* **Refactor**
  * Internal state moved to opaque internal objects; module/device/driver initializers now explicitly initialize internal pointers.
  * Lifecycle handling updated to construct/destruct internal state and use accessors.

* **Tests**
  * Tests updated to use public accessors and explicit construct/destruct lifecycle calls.

* **Chores**
  * Test build/include paths and small metadata updated.
This commit is contained in:
Ken Van Hoeylandt 2026-02-06 16:32:30 +01:00 committed by GitHub
parent 1757af859c
commit 79e43b093a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
105 changed files with 338 additions and 331 deletions

View File

@ -134,6 +134,7 @@ def write_device_structs(file, device: Device, parent_device: Device, bindings:
file.write(f"\t.name = \"{device.node_name}\",\n") # Use original name file.write(f"\t.name = \"{device.node_name}\",\n") # Use original name
file.write(f"\t.config = &{config_variable_name},\n") file.write(f"\t.config = &{config_variable_name},\n")
file.write(f"\t.parent = {parent_value},\n") file.write(f"\t.parent = {parent_value},\n")
file.write("\t.internal = NULL\n")
file.write("};\n\n") file.write("};\n\n")
# Child devices # Child devices
for child_device in device.devices: for child_device in device.devices:

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "btt-panda-touch", .name = "btt-panda-touch",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-2432s024c", .name = "cyd-2432s024c",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-2432s028r", .name = "cyd-2432s028r",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-2432s028rv3", .name = "cyd-2432s028rv3",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-2432s032c", .name = "cyd-2432s032c",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-4848s040c", .name = "cyd-4848s040c",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-8048s043c", .name = "cyd-8048s043c",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-e32r28t", .name = "cyd-e32r28t",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "cyd-e32r32p", .name = "cyd-e32r32p",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "elecrow-crowpanel-advance-35", .name = "elecrow-crowpanel-advance-35",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "elecrow-crowpanel-advance-50", .name = "elecrow-crowpanel-advance-50",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "elecrow-crowpanel-basic-28", .name = "elecrow-crowpanel-basic-28",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "elecrow-crowpanel-basic-35", .name = "elecrow-crowpanel-basic-35",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "elecrow-crowpanel-basic-50", .name = "elecrow-crowpanel-basic-50",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "generic-esp32", .name = "generic-esp32",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "generic-esp32c6", .name = "generic-esp32c6",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "generic-esp32p4", .name = "generic-esp32p4",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "generic-esp32s3", .name = "generic-esp32s3",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "guition-jc1060p470ciwy", .name = "guition-jc1060p470ciwy",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "guition-jc2432w328c", .name = "guition-jc2432w328c",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "guition-jc3248w535c", .name = "guition-jc3248w535c",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "guition-jc8048w550c", .name = "guition-jc8048w550c",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "heltec-wifi-lora-32-v3", .name = "heltec-wifi-lora-32-v3",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "lilygo-tdeck", .name = "lilygo-tdeck",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "lilygo-tdisplay-s3", .name = "lilygo-tdisplay-s3",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "lilygo-tdisplay", .name = "lilygo-tdisplay",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "lilygo-tdongle-s3", .name = "lilygo-tdongle-s3",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -24,7 +24,7 @@ Driver tlora_pager_driver = {
.api = nullptr, .api = nullptr,
.device_type = nullptr, .device_type = nullptr,
.owner = &device_module, .owner = &device_module,
.driver_private = nullptr .internal = nullptr
}; };
} }

View File

@ -25,7 +25,8 @@ struct Module device_module = {
.name = "lilygo-tlora-pager", .name = "lilygo-tlora-pager",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-cardputer-adv", .name = "m5stack-cardputer-adv",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-cardputer", .name = "m5stack-cardputer",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-core2", .name = "m5stack-core2",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-cores3", .name = "m5stack-cores3",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -55,8 +55,8 @@
scl-pullup; scl-pullup;
}; };
// TODO: Enable speaker via I2C: https://github.com/m5stack/M5Unified/blob/a6256725481f1bc366655fa48cf03b6095e30ad1/src/M5Unified.cpp#L417 // TODO: Enable speaker via ES7210 I2C: https://github.com/m5stack/M5Unified/blob/a6256725481f1bc366655fa48cf03b6095e30ad1/src/M5Unified.cpp#L417
// TODO: Enable microphone via I2C: https://github.com/m5stack/M5Unified/blob/a6256725481f1bc366655fa48cf03b6095e30ad1/src/M5Unified.cpp#L616 // TODO: Enable microphone via ES7210 I2C: https://github.com/m5stack/M5Unified/blob/a6256725481f1bc366655fa48cf03b6095e30ad1/src/M5Unified.cpp#L616
i2s0 { i2s0 {
// Note: M5Unified sets the following for speaker: magnification = 2, oversampling = 1 // Note: M5Unified sets the following for speaker: magnification = 2, oversampling = 1
// Note: M5Unified sets the following for microphone: magnification = 4 // Note: M5Unified sets the following for microphone: magnification = 4

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-papers3", .name = "m5stack-papers3",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-stickc-plus", .name = "m5stack-stickc-plus",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-stickc-plus2", .name = "m5stack-stickc-plus2",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "m5stack-tab5", .name = "m5stack-tab5",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "simulator", .name = "simulator",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "unphone", .name = "unphone",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "waveshare-esp32-s3-geek", .name = "waveshare-esp32-s3-geek",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "waveshare-s3-lcd-13", .name = "waveshare-s3-lcd-13",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "waveshare-s3-touch-lcd-128", .name = "waveshare-s3-touch-lcd-128",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "waveshare-s3-touch-lcd-147", .name = "waveshare-s3-touch-lcd-147",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "waveshare-s3-touch-lcd-43", .name = "waveshare-s3-touch-lcd-43",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -17,7 +17,8 @@ struct Module device_module = {
.name = "wireless-tag-wt32-sc01-plus", .name = "wireless-tag-wt32-sc01-plus",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -14,7 +14,7 @@ struct HalDevicePrivate {
std::shared_ptr<tt::hal::Device> halDevice; std::shared_ptr<tt::hal::Device> halDevice;
}; };
#define GET_DATA(device) ((struct HalDevicePrivate*)device->internal.driver_data) #define GET_DATA(device) ((HalDevicePrivate*)device_get_driver_data(device))
static enum HalDeviceType getHalDeviceType(tt::hal::Device::Type type) { static enum HalDeviceType getHalDeviceType(tt::hal::Device::Type type) {
switch (type) { switch (type) {
@ -94,7 +94,9 @@ void hal_device_set_device(::Device* kernelDevice, std::shared_ptr<Device> halDe
static error_t start(Device* device) { static error_t start(Device* device) {
LOG_I(TAG, "start %s", device->name); LOG_I(TAG, "start %s", device->name);
device->internal.driver_data = new HalDevicePrivate(); auto hal_device_data = new(std::nothrow) HalDevicePrivate();
if (hal_device_data == nullptr) return ERROR_OUT_OF_MEMORY;
device_set_driver_data(device, hal_device_data);
return ERROR_NONE; return ERROR_NONE;
} }
@ -120,7 +122,7 @@ Driver hal_device_driver = {
.api = nullptr, .api = nullptr,
.device_type = &HAL_DEVICE_TYPE, .device_type = &HAL_DEVICE_TYPE,
.owner = &hal_device_module, .owner = &hal_device_module,
.driver_private = nullptr .internal = nullptr
}; };
} }

View File

@ -25,7 +25,8 @@ struct Module hal_device_module = {
.name = "hal-device", .name = "hal-device",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -64,5 +64,6 @@ struct Module lvgl_module = {
.name = "lvgl", .name = "lvgl",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = (const struct ModuleSymbol*)lvgl_module_symbols .symbols = (const struct ModuleSymbol*)lvgl_module_symbols,
.internal = NULL
}; };

View File

@ -123,7 +123,7 @@ Driver esp32_gpio_driver = {
.api = (void*)&esp32_gpio_api, .api = (void*)&esp32_gpio_api,
.device_type = &GPIO_CONTROLLER_TYPE, .device_type = &GPIO_CONTROLLER_TYPE,
.owner = &platform_module, .owner = &platform_module,
.driver_private = nullptr .internal = nullptr
}; };
} // extern "C" } // extern "C"

View File

@ -25,7 +25,7 @@ struct InternalData {
}; };
#define GET_CONFIG(device) ((Esp32I2cConfig*)device->config) #define GET_CONFIG(device) ((Esp32I2cConfig*)device->config)
#define GET_DATA(device) ((InternalData*)device->internal.driver_data) #define GET_DATA(device) ((InternalData*)device_get_driver_data(device))
#define lock(data) mutex_lock(&data->mutex); #define lock(data) mutex_lock(&data->mutex);
#define unlock(data) mutex_unlock(&data->mutex); #define unlock(data) mutex_unlock(&data->mutex);
@ -216,7 +216,7 @@ Driver esp32_i2c_driver = {
.api = (void*)&esp32_i2c_api, .api = (void*)&esp32_i2c_api,
.device_type = &I2C_CONTROLLER_TYPE, .device_type = &I2C_CONTROLLER_TYPE,
.owner = &platform_module, .owner = &platform_module,
.driver_private = nullptr .internal = nullptr
}; };
} // extern "C" } // extern "C"

View File

@ -31,7 +31,7 @@ struct InternalData {
}; };
#define GET_CONFIG(device) ((Esp32I2sConfig*)device->config) #define GET_CONFIG(device) ((Esp32I2sConfig*)device->config)
#define GET_DATA(device) ((InternalData*)device->internal.driver_data) #define GET_DATA(device) ((InternalData*)device_get_driver_data(device))
#define lock(data) mutex_lock(&data->mutex); #define lock(data) mutex_lock(&data->mutex);
#define unlock(data) mutex_unlock(&data->mutex); #define unlock(data) mutex_unlock(&data->mutex);
@ -236,7 +236,7 @@ Driver esp32_i2s_driver = {
.api = (void*)&esp32_i2s_api, .api = (void*)&esp32_i2s_api,
.device_type = &I2S_CONTROLLER_TYPE, .device_type = &I2S_CONTROLLER_TYPE,
.owner = &platform_module, .owner = &platform_module,
.driver_private = nullptr .internal = nullptr
}; };
} // extern "C" } // extern "C"

View File

@ -31,7 +31,8 @@ struct Module platform_module = {
.name = "platform-esp32", .name = "platform-esp32",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -18,7 +18,8 @@ struct Module platform_module = {
.name = "platform-posix", .name = "platform-posix",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = nullptr .symbols = nullptr,
.internal = nullptr
}; };
} }

View File

@ -18,12 +18,10 @@ struct Mutex {
}; };
inline static void mutex_construct(struct Mutex* mutex) { inline static void mutex_construct(struct Mutex* mutex) {
assert(mutex->handle == NULL);
mutex->handle = xSemaphoreCreateMutex(); mutex->handle = xSemaphoreCreateMutex();
} }
inline static void mutex_destruct(struct Mutex* mutex) { inline static void mutex_destruct(struct Mutex* mutex) {
assert(mutex->handle != NULL);
vPortAssertIfInISR(); vPortAssertIfInISR();
vSemaphoreDelete(mutex->handle); vSemaphoreDelete(mutex->handle);
mutex->handle = NULL; mutex->handle = NULL;

View File

@ -16,39 +16,30 @@ extern "C" {
#endif #endif
struct Driver; struct Driver;
struct DevicePrivate; struct DeviceInternal;
/** Enables discovering devices of the same type */ /** Enables discovering devices of the same type */
struct DeviceType { struct DeviceType {
/* Placeholder because empty structs have a different size with C vs C++ compilers */ const char* name;
uint8_t _;
}; };
/** Represents a piece of hardware */ /** Represents a piece of hardware */
struct Device { struct Device {
/** The name of the device. Valid characters: a-z a-Z 0-9 - _ . */ /** The name of the device. Valid characters: a-z a-Z 0-9 - _ . */
const char* name; const char* name;
/** The configuration data for the device's driver */ /** The configuration data for the device's driver */
const void* config; const void* config;
/** The parent device that this device belongs to. Can be NULL, but only the root device should have a NULL parent. */ /** The parent device that this device belongs to. Can be NULL, but only the root device should have a NULL parent. */
struct Device* parent; struct Device* parent;
/** Internal data */
struct { /**
/** Address of the API exposed by the device instance. */ * Internal state managed by the kernel.
struct Driver* driver; * Device implementers should initialize this to NULL.
/** The driver data for this device (e.g. a mutex) */ * Do not access or modify directly; use device_* functions.
void* driver_data; */
/** The mutex for device operations */ struct DeviceInternal* internal;
struct Mutex mutex;
/** The device state */
struct {
int start_result;
bool started : 1;
bool added : 1;
} state;
/** Private data */
struct DevicePrivate* device_private;
} internal;
}; };
/** /**

View File

@ -12,7 +12,7 @@ extern "C" {
struct Device; struct Device;
struct DeviceType; struct DeviceType;
struct Module; struct Module;
struct DriverPrivate; struct DriverInternal;
struct Driver { struct Driver {
/** The driver name */ /** The driver name */
@ -29,8 +29,12 @@ struct Driver {
const struct DeviceType* device_type; const struct DeviceType* device_type;
/** The module that owns this driver. When it is NULL, the system owns the driver and it cannot be removed from registration. */ /** The module that owns this driver. When it is NULL, the system owns the driver and it cannot be removed from registration. */
const struct Module* owner; const struct Module* owner;
/** Internal data */ /**
struct DriverPrivate* driver_private; * Internal state managed by the kernel.
* Driver implementers should initialize this to NULL.
* Do not access or modify directly; use driver_* functions.
*/
struct DriverInternal* internal;
}; };
/** /**

View File

@ -25,6 +25,8 @@ struct ModuleSymbol {
const void* symbol; const void* symbol;
}; };
struct ModuleInternal;
/** /**
* A module is a collection of drivers or other functionality that can be loaded and unloaded at runtime. * A module is a collection of drivers or other functionality that can be loaded and unloaded at runtime.
*/ */
@ -36,7 +38,6 @@ struct Module {
* Desirable format "platform-esp32", "lilygo-tdeck", etc. * Desirable format "platform-esp32", "lilygo-tdeck", etc.
*/ */
const char* name; const char* name;
/** /**
* A function to initialize the module. * A function to initialize the module.
* Should never be NULL. * Should never be NULL.
@ -44,24 +45,24 @@ struct Module {
* @return ERROR_NONE if successful * @return ERROR_NONE if successful
*/ */
error_t (*start)(void); error_t (*start)(void);
/** /**
* Deinitializes the module. * Deinitializes the module.
* Should never be NULL. * Should never be NULL.
* @return ERROR_NONE if successful * @return ERROR_NONE if successful
*/ */
error_t (*stop)(void); error_t (*stop)(void);
/** /**
* A list of symbols exported by the module. * A list of symbols exported by the module.
* Should be terminated by MODULE_SYMBOL_TERMINATOR. * Should be terminated by MODULE_SYMBOL_TERMINATOR.
* Can be a NULL value. * Can be a NULL value.
*/ */
const struct ModuleSymbol* symbols; const struct ModuleSymbol* symbols;
/**
struct { * Internal state managed by the kernel.
bool started; * Module implementers should initialize this to NULL.
} internal; * Do not access or modify directly; use module_* functions.
*/
struct ModuleInternal* internal;
}; };
/** /**

View File

@ -13,8 +13,21 @@
#define TAG "device" #define TAG "device"
struct DevicePrivate { struct DeviceInternal {
std::vector<Device*> children; /** Address of the API exposed by the device instance. */
struct Driver* driver = nullptr;
/** The driver data for this device (e.g. a mutex) */
void* driver_data = nullptr;
/** The mutex for device operations */
struct Mutex mutex {};
/** The device state */
struct {
int start_result = 0;
bool started : 1 = false;
bool added : 1 = false;
} state;
/** Attached child devices */
std::vector<Device*> children {};
}; };
struct DeviceLedger { struct DeviceLedger {
@ -42,47 +55,55 @@ extern "C" {
#define ledger_lock() mutex_lock(&ledger.mutex) #define ledger_lock() mutex_lock(&ledger.mutex)
#define ledger_unlock() mutex_unlock(&ledger.mutex) #define ledger_unlock() mutex_unlock(&ledger.mutex)
#define get_device_private(device) static_cast<DevicePrivate*>(device->internal.device_private) #define lock_internal(internal) mutex_lock(&internal->mutex)
#define unlock_internal(internal) mutex_unlock(&internal->mutex)
error_t device_construct(Device* device) { error_t device_construct(Device* device) {
device->internal.device_private = new(std::nothrow) DevicePrivate; device->internal = new(std::nothrow) DeviceInternal;
if (device->internal.device_private == nullptr) { if (device->internal == nullptr) {
return ERROR_OUT_OF_MEMORY; return ERROR_OUT_OF_MEMORY;
} }
LOG_D(TAG, "construct %s", device->name); LOG_D(TAG, "construct %s", device->name);
mutex_construct(&device->internal.mutex); mutex_construct(&device->internal->mutex);
return ERROR_NONE; return ERROR_NONE;
} }
error_t device_destruct(Device* device) { error_t device_destruct(Device* device) {
if (device->internal.state.started || device->internal.state.added) { lock_internal(device->internal);
auto* internal = device->internal;
if (internal->state.started || internal->state.added) {
unlock_internal(device->internal);
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
if (!get_device_private(device)->children.empty()) { if (!internal->children.empty()) {
unlock_internal(device->internal);
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
LOG_D(TAG, "destruct %s", device->name); LOG_D(TAG, "destruct %s", device->name);
mutex_destruct(&device->internal.mutex);
delete get_device_private(device); device->internal = nullptr;
device->internal.device_private = nullptr; mutex_unlock(&internal->mutex);
delete internal;
return ERROR_NONE; return ERROR_NONE;
} }
/** Add a child to the list of children */ /** Add a child to the list of children */
static void device_add_child(struct Device* device, struct Device* child) { static void device_add_child(struct Device* device, struct Device* child) {
device_lock(device); device_lock(device);
assert(device->internal.state.added); check(device->internal->state.added);
get_device_private(device)->children.push_back(child); device->internal->children.push_back(child);
device_unlock(device); device_unlock(device);
} }
/** Remove a child from the list of children */ /** Remove a child from the list of children */
static void device_remove_child(struct Device* device, struct Device* child) { static void device_remove_child(struct Device* device, struct Device* child) {
device_lock(device); device_lock(device);
auto* parent_data = get_device_private(device); const auto iterator = std::ranges::find(device->internal->children, child);
const auto iterator = std::ranges::find(parent_data->children, child); if (iterator != device->internal->children.end()) {
if (iterator != parent_data->children.end()) { device->internal->children.erase(iterator);
parent_data->children.erase(iterator);
} }
device_unlock(device); device_unlock(device);
} }
@ -91,7 +112,7 @@ error_t device_add(Device* device) {
LOG_D(TAG, "add %s", device->name); LOG_D(TAG, "add %s", device->name);
// Already added // Already added
if (device->internal.state.started || device->internal.state.added) { if (device->internal->state.started || device->internal->state.added) {
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
@ -106,14 +127,14 @@ error_t device_add(Device* device) {
device_add_child(parent, device); device_add_child(parent, device);
} }
device->internal.state.added = true; device->internal->state.added = true;
return ERROR_NONE; return ERROR_NONE;
} }
error_t device_remove(Device* device) { error_t device_remove(Device* device) {
LOG_D(TAG, "remove %s", device->name); LOG_D(TAG, "remove %s", device->name);
if (device->internal.state.started || !device->internal.state.added) { if (device->internal->state.started || !device->internal->state.added) {
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
@ -132,7 +153,7 @@ error_t device_remove(Device* device) {
ledger.devices.erase(iterator); ledger.devices.erase(iterator);
ledger_unlock(); ledger_unlock();
device->internal.state.added = false; device->internal->state.added = false;
return ERROR_NONE; return ERROR_NONE;
failed_ledger_lookup: failed_ledger_lookup:
@ -147,41 +168,41 @@ failed_ledger_lookup:
error_t device_start(Device* device) { error_t device_start(Device* device) {
LOG_I(TAG, "start %s", device->name); LOG_I(TAG, "start %s", device->name);
if (!device->internal.state.added) { if (!device->internal->state.added) {
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
if (device->internal.driver == nullptr) { if (device->internal->driver == nullptr) {
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
// Already started // Already started
if (device->internal.state.started) { if (device->internal->state.started) {
return ERROR_NONE; return ERROR_NONE;
} }
error_t bind_error = driver_bind(device->internal.driver, device); error_t bind_error = driver_bind(device->internal->driver, device);
device->internal.state.started = (bind_error == ERROR_NONE); device->internal->state.started = (bind_error == ERROR_NONE);
device->internal.state.start_result = bind_error; device->internal->state.start_result = bind_error;
return bind_error == ERROR_NONE ? ERROR_NONE : ERROR_RESOURCE; return bind_error == ERROR_NONE ? ERROR_NONE : ERROR_RESOURCE;
} }
error_t device_stop(struct Device* device) { error_t device_stop(struct Device* device) {
LOG_I(TAG, "stop %s", device->name); LOG_I(TAG, "stop %s", device->name);
if (!device->internal.state.added) { if (!device->internal->state.added) {
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
if (!device->internal.state.started) { if (!device->internal->state.started) {
return ERROR_NONE; return ERROR_NONE;
} }
if (driver_unbind(device->internal.driver, device) != ERROR_NONE) { if (driver_unbind(device->internal->driver, device) != ERROR_NONE) {
return ERROR_RESOURCE; return ERROR_RESOURCE;
} }
device->internal.state.started = false; device->internal->state.started = false;
device->internal.state.start_result = 0; device->internal->state.start_result = 0;
return ERROR_NONE; return ERROR_NONE;
} }
@ -236,7 +257,7 @@ on_construct_add_error:
} }
void device_set_parent(Device* device, Device* parent) { void device_set_parent(Device* device, Device* parent) {
assert(!device->internal.state.started); assert(!device->internal->state.started);
device->parent = parent; device->parent = parent;
} }
@ -245,43 +266,43 @@ Device* device_get_parent(struct Device* device) {
} }
void device_set_driver(struct Device* device, struct Driver* driver) { void device_set_driver(struct Device* device, struct Driver* driver) {
device->internal.driver = driver; device->internal->driver = driver;
} }
struct Driver* device_get_driver(struct Device* device) { struct Driver* device_get_driver(struct Device* device) {
return device->internal.driver; return device->internal->driver;
} }
bool device_is_ready(const struct Device* device) { bool device_is_ready(const struct Device* device) {
return device->internal.state.started; return device->internal->state.started;
} }
void device_set_driver_data(struct Device* device, void* driver_data) { void device_set_driver_data(struct Device* device, void* driver_data) {
device->internal.driver_data = driver_data; device->internal->driver_data = driver_data;
} }
void* device_get_driver_data(struct Device* device) { void* device_get_driver_data(struct Device* device) {
return device->internal.driver_data; return device->internal->driver_data;
} }
bool device_is_added(const struct Device* device) { bool device_is_added(const struct Device* device) {
return device->internal.state.added; return device->internal->state.added;
} }
void device_lock(struct Device* device) { void device_lock(struct Device* device) {
mutex_lock(&device->internal.mutex); mutex_lock(&device->internal->mutex);
} }
bool device_try_lock(struct Device* device) { bool device_try_lock(struct Device* device) {
return mutex_try_lock(&device->internal.mutex); return mutex_try_lock(&device->internal->mutex);
} }
void device_unlock(struct Device* device) { void device_unlock(struct Device* device) {
mutex_unlock(&device->internal.mutex); mutex_unlock(&device->internal->mutex);
} }
const struct DeviceType* device_get_type(struct Device* device) { const struct DeviceType* device_get_type(struct Device* device) {
return device->internal.driver ? device->internal.driver->device_type : NULL; return device->internal->driver ? device->internal->driver->device_type : NULL;
} }
void device_for_each(void* callback_context, bool(*on_device)(Device* device, void* context)) { void device_for_each(void* callback_context, bool(*on_device)(Device* device, void* context)) {
@ -295,8 +316,7 @@ void device_for_each(void* callback_context, bool(*on_device)(Device* device, vo
} }
void device_for_each_child(Device* device, void* callbackContext, bool(*on_device)(struct Device* device, void* context)) { void device_for_each_child(Device* device, void* callbackContext, bool(*on_device)(struct Device* device, void* context)) {
auto* data = get_device_private(device); for (auto* child_device : device->internal->children) {
for (auto* child_device : data->children) {
if (!on_device(child_device, callbackContext)) { if (!on_device(child_device, callbackContext)) {
break; break;
} }
@ -306,7 +326,7 @@ void device_for_each_child(Device* device, void* callbackContext, bool(*on_devic
void device_for_each_of_type(const DeviceType* type, void* callbackContext, bool(*on_device)(Device* device, void* context)) { void device_for_each_of_type(const DeviceType* type, void* callbackContext, bool(*on_device)(Device* device, void* context)) {
ledger_lock(); ledger_lock();
for (auto* device : ledger.devices) { for (auto* device : ledger.devices) {
auto* driver = device->internal.driver; auto* driver = device->internal->driver;
if (driver != nullptr) { if (driver != nullptr) {
if (driver->device_type == type) { if (driver->device_type == type) {
if (!on_device(device, callbackContext)) { if (!on_device(device, callbackContext)) {

View File

@ -12,23 +12,14 @@
#define TAG "driver" #define TAG "driver"
struct DriverPrivate { struct DriverInternal {
Mutex mutex { 0 };
int use_count = 0; int use_count = 0;
bool destroying = false; bool destroying = false;
DriverPrivate() {
mutex_construct(&mutex);
}
~DriverPrivate() {
mutex_destruct(&mutex);
}
}; };
struct DriverLedger { struct DriverLedger {
std::vector<Driver*> drivers; std::vector<Driver*> drivers;
Mutex mutex { 0 }; Mutex mutex {};
DriverLedger() { mutex_construct(&mutex); } DriverLedger() { mutex_construct(&mutex); }
~DriverLedger() { mutex_destruct(&mutex); } ~DriverLedger() { mutex_destruct(&mutex); }
@ -37,43 +28,32 @@ struct DriverLedger {
void unlock() { mutex_unlock(&mutex); } void unlock() { mutex_unlock(&mutex); }
}; };
static DriverLedger& get_ledger() { static DriverLedger ledger;
static DriverLedger ledger;
return ledger;
}
#define ledger get_ledger()
#define get_driver_private(driver) static_cast<DriverPrivate*>(driver->driver_private)
#define driver_lock(driver) mutex_lock(&get_driver_private(driver)->mutex);
#define driver_unlock(driver) mutex_unlock(&get_driver_private(driver)->mutex);
extern "C" { extern "C" {
error_t driver_construct(Driver* driver) { error_t driver_construct(Driver* driver) {
driver->driver_private = new(std::nothrow) DriverPrivate; driver->internal = new(std::nothrow) DriverInternal;
if (driver->driver_private == nullptr) { if (driver->internal == nullptr) {
return ERROR_OUT_OF_MEMORY; return ERROR_OUT_OF_MEMORY;
} }
return ERROR_NONE; return ERROR_NONE;
} }
error_t driver_destruct(Driver* driver) { error_t driver_destruct(Driver* driver) {
driver_lock(driver); auto* internal = driver->internal;
// No module means the system owns it and it cannot be destroyed
if (driver->owner == nullptr) { if (driver->owner == nullptr) {
driver_unlock(driver);
return ERROR_NOT_ALLOWED; return ERROR_NOT_ALLOWED;
} }
if (get_driver_private(driver)->use_count != 0 || get_driver_private(driver)->destroying) { if (internal->use_count != 0 || internal->destroying) {
driver_unlock(driver);
return ERROR_INVALID_STATE; return ERROR_INVALID_STATE;
} }
get_driver_private(driver)->destroying = true; internal->destroying = true;
driver_unlock(driver); // Nullify internal reference before deletion to prevent use-after-free
delete get_driver_private(driver); driver->internal = nullptr;
driver->driver_private = nullptr; delete internal;
return ERROR_NONE; return ERROR_NONE;
} }
@ -143,10 +123,8 @@ Driver* driver_find_compatible(const char* compatible) {
} }
error_t driver_bind(Driver* driver, Device* device) { error_t driver_bind(Driver* driver, Device* device) {
driver_lock(driver);
error_t error = ERROR_NONE; error_t error = ERROR_NONE;
if (get_driver_private(driver)->destroying || !device_is_added(device)) { if (driver->internal->destroying || !device_is_added(device)) {
error = ERROR_INVALID_STATE; error = ERROR_INVALID_STATE;
goto error; goto error;
} }
@ -158,23 +136,18 @@ error_t driver_bind(Driver* driver, Device* device) {
} }
} }
get_driver_private(driver)->use_count++; driver->internal->use_count++;
driver_unlock(driver);
LOG_I(TAG, "bound %s to %s", driver->name, device->name); LOG_I(TAG, "bound %s to %s", driver->name, device->name);
return ERROR_NONE; return ERROR_NONE;
error: error:
driver_unlock(driver);
return error; return error;
} }
error_t driver_unbind(Driver* driver, Device* device) { error_t driver_unbind(Driver* driver, Device* device) {
driver_lock(driver);
error_t error = ERROR_NONE; error_t error = ERROR_NONE;
if (get_driver_private(driver)->destroying || !device_is_added(device)) { if (driver->internal->destroying || !device_is_added(device)) {
error = ERROR_INVALID_STATE; error = ERROR_INVALID_STATE;
goto error; goto error;
} }
@ -186,16 +159,13 @@ error_t driver_unbind(Driver* driver, Device* device) {
} }
} }
get_driver_private(driver)->use_count--; driver->internal->use_count--;
driver_unlock(driver);
LOG_I(TAG, "unbound %s from %s", driver->name, device->name); LOG_I(TAG, "unbound %s from %s", driver->name, device->name);
return ERROR_NONE; return ERROR_NONE;
error: error:
driver_unlock(driver);
return error; return error;
} }

View File

@ -32,6 +32,8 @@ error_t gpio_controller_get_pin_count(struct Device* device, uint32_t* count) {
return GPIO_DRIVER_API(driver)->get_pin_count(device, count); return GPIO_DRIVER_API(driver)->get_pin_count(device, count);
} }
extern const struct DeviceType GPIO_CONTROLLER_TYPE { 0 }; extern const struct DeviceType GPIO_CONTROLLER_TYPE {
.name = "gpio-controller"
};
} }

View File

@ -49,6 +49,8 @@ error_t i2c_controller_has_device_at_address(Device* device, uint8_t address, Ti
return I2C_DRIVER_API(driver)->write(device, address, message, 2, timeout); return I2C_DRIVER_API(driver)->write(device, address, message, 2, timeout);
} }
extern const struct DeviceType I2C_CONTROLLER_TYPE { 0 }; extern const struct DeviceType I2C_CONTROLLER_TYPE {
.name = "i2c-controller"
};
} }

View File

@ -32,6 +32,8 @@ error_t i2s_controller_reset(struct Device* device) {
return I2S_DRIVER_API(driver)->reset(device); return I2S_DRIVER_API(driver)->reset(device);
} }
extern const struct DeviceType I2S_CONTROLLER_TYPE { 0 }; extern const struct DeviceType I2S_CONTROLLER_TYPE {
.name = "i2s-controller"
};
} }

View File

@ -23,7 +23,8 @@ struct Module root_module = {
.name = "kernel", .name = "kernel",
.start = start, .start = start,
.stop = stop, .stop = stop,
.symbols = (const struct ModuleSymbol*)KERNEL_SYMBOLS .symbols = (const struct ModuleSymbol*)KERNEL_SYMBOLS,
.internal = nullptr
}; };
error_t kernel_init(struct Module* platform_module, struct Module* device_module, struct CompatibleDevice devicetree_devices[]) { error_t kernel_init(struct Module* platform_module, struct Module* device_module, struct CompatibleDevice devicetree_devices[]) {

View File

@ -1,14 +1,19 @@
#include <vector> #include <cstring>
#include <string.h>
#include <algorithm> #include <algorithm>
#include <new>
#include <tactility/concurrent/mutex.h> #include <tactility/concurrent/mutex.h>
#include <tactility/module.h> #include <tactility/module.h>
#include <vector>
#define TAG "module" #define TAG "module"
struct ModuleInternal {
bool started = false;
};
struct ModuleLedger { struct ModuleLedger {
std::vector<struct Module*> modules; std::vector<struct Module*> modules;
struct Mutex mutex = { 0 }; struct Mutex mutex {};
ModuleLedger() { mutex_construct(&mutex); } ModuleLedger() { mutex_construct(&mutex); }
~ModuleLedger() { mutex_destruct(&mutex); } ~ModuleLedger() { mutex_destruct(&mutex); }
@ -19,11 +24,14 @@ static ModuleLedger ledger;
extern "C" { extern "C" {
error_t module_construct(struct Module* module) { error_t module_construct(struct Module* module) {
module->internal.started = false; module->internal = new (std::nothrow) ModuleInternal();
if (module->internal == nullptr) return ERROR_OUT_OF_MEMORY;
return ERROR_NONE; return ERROR_NONE;
} }
error_t module_destruct(struct Module* module) { error_t module_destruct(struct Module* module) {
delete static_cast<ModuleInternal*>(module->internal);
module->internal = nullptr;
return ERROR_NONE; return ERROR_NONE;
} }
@ -44,28 +52,30 @@ error_t module_remove(struct Module* module) {
error_t module_start(struct Module* module) { error_t module_start(struct Module* module) {
LOG_I(TAG, "start %s", module->name); LOG_I(TAG, "start %s", module->name);
if (module->internal.started) return ERROR_NONE; auto* internal = static_cast<ModuleInternal*>(module->internal);
if (internal->started) return ERROR_NONE;
error_t error = module->start(); error_t error = module->start();
module->internal.started = (error == ERROR_NONE); internal->started = (error == ERROR_NONE);
return error; return error;
} }
bool module_is_started(struct Module* module) { bool module_is_started(struct Module* module) {
return module->internal.started; return static_cast<ModuleInternal*>(module->internal)->started;
} }
error_t module_stop(struct Module* module) { error_t module_stop(struct Module* module) {
LOG_I(TAG, "stop %s", module->name); LOG_I(TAG, "stop %s", module->name);
if (!module->internal.started) return ERROR_NONE; auto* internal = static_cast<ModuleInternal*>(module->internal);
if (!internal->started) return ERROR_NONE;
error_t error = module->stop(); error_t error = module->stop();
if (error != ERROR_NONE) { if (error != ERROR_NONE) {
return error; return error;
} }
module->internal.started = false; internal->started = false;
return error; return error;
} }
@ -106,4 +116,3 @@ bool module_resolve_symbol_global(const char* symbol_name, uintptr_t* symbol_add
} }
} }

View File

@ -1,6 +1,6 @@
project(tests) project(tests)
set(DOCTESTINC ${PROJECT_SOURCE_DIR}/Include) set(DOCTESTINC ${PROJECT_SOURCE_DIR}/Doctest/Include)
enable_testing() enable_testing()
add_subdirectory(TactilityCore) add_subdirectory(TactilityCore)

View File

@ -4,16 +4,12 @@ enable_language(C CXX ASM)
set(CMAKE_CXX_COMPILER g++) set(CMAKE_CXX_COMPILER g++)
file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/*.cpp) file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/Source/*.cpp)
add_executable(TactilityTests EXCLUDE_FROM_ALL ${TEST_SOURCES}) add_executable(TactilityTests EXCLUDE_FROM_ALL ${TEST_SOURCES})
target_include_directories(TactilityTests PRIVATE target_include_directories(TactilityTests PRIVATE ${DOCTESTINC})
${DOCTESTINC}
)
add_test(NAME TactilityTests add_test(NAME TactilityTests COMMAND TactilityTests)
COMMAND TactilityTests
)
target_link_libraries(TactilityTests PRIVATE target_link_libraries(TactilityTests PRIVATE
Tactility Tactility

View File

@ -1,7 +1,7 @@
#include "../TactilityCore/TestFile.h" #include "../../TactilityCore/Source/TestFile.h"
#include "doctest.h" #include "../../Tactility/Include/Tactility/file/PropertiesFile.h"
#include <../../Tactility/Include/Tactility/file/PropertiesFile.h> #include "doctest.h"
using namespace tt; using namespace tt;

View File

@ -4,16 +4,12 @@ enable_language(C CXX ASM)
set(CMAKE_CXX_COMPILER g++) set(CMAKE_CXX_COMPILER g++)
file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/*.cpp) file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/Source/*.cpp)
add_executable(TactilityCoreTests EXCLUDE_FROM_ALL ${TEST_SOURCES}) add_executable(TactilityCoreTests EXCLUDE_FROM_ALL ${TEST_SOURCES})
target_include_directories(TactilityCoreTests PRIVATE target_include_directories(TactilityCoreTests PRIVATE ${DOCTESTINC})
${DOCTESTINC}
)
add_test(NAME TactilityCoreTests add_test(NAME TactilityCoreTests COMMAND TactilityCoreTests)
COMMAND TactilityCoreTests
)
target_link_libraries(TactilityCoreTests PUBLIC target_link_libraries(TactilityCoreTests PUBLIC
TactilityCore TactilityCore

View File

@ -4,16 +4,12 @@ enable_language(C CXX ASM)
set(CMAKE_CXX_COMPILER g++) set(CMAKE_CXX_COMPILER g++)
file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/*.cpp) file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/Source/*.cpp)
add_executable(TactilityFreeRtosTests EXCLUDE_FROM_ALL ${TEST_SOURCES}) add_executable(TactilityFreeRtosTests EXCLUDE_FROM_ALL ${TEST_SOURCES})
target_include_directories(TactilityFreeRtosTests PRIVATE target_include_directories(TactilityFreeRtosTests PRIVATE ${DOCTESTINC})
${DOCTESTINC}
)
add_test(NAME TactilityFreeRtosTests add_test(NAME TactilityFreeRtosTests COMMAND TactilityFreeRtosTests)
COMMAND TactilityFreeRtosTests
)
target_link_libraries(TactilityFreeRtosTests PUBLIC target_link_libraries(TactilityFreeRtosTests PUBLIC
TactilityFreeRtos TactilityFreeRtos

View File

@ -4,7 +4,7 @@ enable_language(C CXX ASM)
set(CMAKE_CXX_COMPILER g++) set(CMAKE_CXX_COMPILER g++)
file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/*.cpp) file(GLOB_RECURSE TEST_SOURCES ${PROJECT_SOURCE_DIR}/Source/*.cpp)
add_executable(TactilityKernelTests EXCLUDE_FROM_ALL ${TEST_SOURCES}) add_executable(TactilityKernelTests EXCLUDE_FROM_ALL ${TEST_SOURCES})
target_include_directories(TactilityKernelTests PRIVATE ${DOCTESTINC}) target_include_directories(TactilityKernelTests PRIVATE ${DOCTESTINC})

View File

@ -12,30 +12,26 @@ static Module module = {
.stop = nullptr .stop = nullptr
}; };
TEST_CASE("device_construct and device_destruct should set and unset the correct fields") { TEST_CASE("device_construct and device_destruct should set and unset the internal field") {
Device device = { 0 }; Device device = { 0 };
error_t error = device_construct(&device); error_t error = device_construct(&device);
CHECK_EQ(error, ERROR_NONE); CHECK_EQ(error, ERROR_NONE);
CHECK_NE(device.internal.device_private, nullptr); CHECK_NE(device.internal, nullptr);
CHECK_NE(device.internal.mutex.handle, nullptr);
CHECK_EQ(device_destruct(&device), ERROR_NONE); CHECK_EQ(device_destruct(&device), ERROR_NONE);
CHECK_EQ(device.internal.device_private, nullptr); CHECK_EQ(device.internal, nullptr);
CHECK_EQ(device.internal.mutex.handle, nullptr);
Device comparison_device = { 0 };
comparison_device.internal.device_private = device.internal.device_private;
comparison_device.internal.mutex.handle = device.internal.mutex.handle;
// Check that no other data was set
CHECK_EQ(memcmp(&device, &comparison_device, sizeof(Device)), 0);
} }
TEST_CASE("device_add should add the device to the list of all devices") { TEST_CASE("device_add should add the device to the list of all devices") {
Device device = { 0 }; Device device = {
.name = "device",
.config = nullptr,
.parent = nullptr,
.internal = nullptr
};
CHECK_EQ(device_construct(&device), ERROR_NONE); CHECK_EQ(device_construct(&device), ERROR_NONE);
CHECK_EQ(device_add(&device), ERROR_NONE); CHECK_EQ(device_add(&device), ERROR_NONE);
@ -55,12 +51,18 @@ TEST_CASE("device_add should add the device to the list of all devices") {
} }
TEST_CASE("device_add should add the device to its parent") { TEST_CASE("device_add should add the device to its parent") {
Device parent = { 0 }; Device parent = {
.name = "parent",
.config = nullptr,
.parent = nullptr,
.internal = nullptr
};
Device child = { Device child = {
.name = nullptr, .name = "child",
.config = nullptr, .config = nullptr,
.parent = &parent .parent = &parent,
.internal = nullptr
}; };
CHECK_EQ(device_construct(&parent), ERROR_NONE); CHECK_EQ(device_construct(&parent), ERROR_NONE);
@ -88,19 +90,31 @@ TEST_CASE("device_add should add the device to its parent") {
} }
TEST_CASE("device_add should set the state to 'added'") { TEST_CASE("device_add should set the state to 'added'") {
Device device = { 0 }; Device device = {
.name = "device",
.config = nullptr,
.parent = nullptr,
.internal = nullptr
};
CHECK_EQ(device_construct(&device), ERROR_NONE); CHECK_EQ(device_construct(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.added, false); CHECK_EQ(device_is_added(&device), false);
CHECK_EQ(device_add(&device), ERROR_NONE); CHECK_EQ(device_add(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.added, true); CHECK_EQ(device_is_added(&device), true);
CHECK_EQ(device_remove(&device), ERROR_NONE); CHECK_EQ(device_remove(&device), ERROR_NONE);
CHECK_EQ(device_destruct(&device), ERROR_NONE); CHECK_EQ(device_destruct(&device), ERROR_NONE);
} }
TEST_CASE("device_remove should remove it from the list of all devices") { TEST_CASE("device_remove should remove it from the list of all devices") {
Device device = { 0 }; Device device = {
.name = "device",
.config = nullptr,
.parent = nullptr,
.internal = nullptr
};
CHECK_EQ(device_construct(&device), ERROR_NONE); CHECK_EQ(device_construct(&device), ERROR_NONE);
CHECK_EQ(device_add(&device), ERROR_NONE); CHECK_EQ(device_add(&device), ERROR_NONE);
CHECK_EQ(device_remove(&device), ERROR_NONE); CHECK_EQ(device_remove(&device), ERROR_NONE);
@ -119,12 +133,18 @@ TEST_CASE("device_remove should remove it from the list of all devices") {
} }
TEST_CASE("device_remove should remove the device from its parent") { TEST_CASE("device_remove should remove the device from its parent") {
Device parent = { 0 }; Device parent = {
.name = "parent",
.config = nullptr,
.parent = nullptr,
.internal = nullptr
};
Device child = { Device child = {
.name = nullptr, .name = "child",
.config = nullptr, .config = nullptr,
.parent = &parent .parent = &parent,
.internal = nullptr
}; };
CHECK_EQ(device_construct(&parent), ERROR_NONE); CHECK_EQ(device_construct(&parent), ERROR_NONE);
@ -151,13 +171,19 @@ TEST_CASE("device_remove should remove the device from its parent") {
} }
TEST_CASE("device_remove should clear the state 'added'") { TEST_CASE("device_remove should clear the state 'added'") {
Device device = { 0 }; Device device = {
.name = "device",
.config = nullptr,
.parent = nullptr,
.internal = nullptr
};
CHECK_EQ(device_construct(&device), ERROR_NONE); CHECK_EQ(device_construct(&device), ERROR_NONE);
CHECK_EQ(device_add(&device), ERROR_NONE); CHECK_EQ(device_add(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.added, true); CHECK_EQ(device_is_added(&device), true);
CHECK_EQ(device_remove(&device), ERROR_NONE); CHECK_EQ(device_remove(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.added, false); CHECK_EQ(device_is_added(&device), false);
CHECK_EQ(device_destruct(&device), ERROR_NONE); CHECK_EQ(device_destruct(&device), ERROR_NONE);
} }
@ -172,7 +198,7 @@ TEST_CASE("device_is_ready should return true only when it is started") {
.api = nullptr, .api = nullptr,
.device_type = nullptr, .device_type = nullptr,
.owner = &module, .owner = &module,
.driver_private = nullptr .internal = nullptr
}; };
Device device = { 0 }; Device device = { 0 };
@ -180,17 +206,17 @@ TEST_CASE("device_is_ready should return true only when it is started") {
CHECK_EQ(driver_construct_add(&driver), ERROR_NONE); CHECK_EQ(driver_construct_add(&driver), ERROR_NONE);
CHECK_EQ(device_construct(&device), ERROR_NONE); CHECK_EQ(device_construct(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.started, false); CHECK_EQ(device_is_ready(&device), false);
device_set_driver(&device, &driver); device_set_driver(&device, &driver);
CHECK_EQ(device.internal.state.started, false); CHECK_EQ(device_is_ready(&device), false);
CHECK_EQ(device_add(&device), ERROR_NONE); CHECK_EQ(device_add(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.started, false); CHECK_EQ(device_is_ready(&device), false);
CHECK_EQ(device_start(&device), ERROR_NONE); CHECK_EQ(device_start(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.started, true); CHECK_EQ(device_is_ready(&device), true);
CHECK_EQ(device_stop(&device), ERROR_NONE); CHECK_EQ(device_stop(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.started, false); CHECK_EQ(device_is_ready(&device), false);
CHECK_EQ(device_remove(&device), ERROR_NONE); CHECK_EQ(device_remove(&device), ERROR_NONE);
CHECK_EQ(device.internal.state.started, false); CHECK_EQ(device_is_ready(&device), false);
CHECK_EQ(device_destruct(&device), ERROR_NONE); CHECK_EQ(device_destruct(&device), ERROR_NONE);
CHECK_EQ(driver_remove_destruct(&driver), ERROR_NONE); CHECK_EQ(driver_remove_destruct(&driver), ERROR_NONE);

View File

@ -38,7 +38,7 @@ static Driver integration_driver = {
.api = nullptr, .api = nullptr,
.device_type = nullptr, .device_type = nullptr,
.owner = &module, .owner = &module,
.driver_private = nullptr, .internal = nullptr,
}; };
TEST_CASE("driver with with start success and stop success should start and stop a device") { TEST_CASE("driver with with start success and stop success should start and stop a device") {

View File

@ -15,10 +15,10 @@ TEST_CASE("driver_construct and driver_destruct should set and unset the correct
CHECK_EQ(driver_construct(&driver), ERROR_NONE); CHECK_EQ(driver_construct(&driver), ERROR_NONE);
CHECK_EQ(driver_add(&driver), ERROR_NONE); CHECK_EQ(driver_add(&driver), ERROR_NONE);
CHECK_NE(driver.driver_private, nullptr); CHECK_NE(driver.internal, nullptr);
CHECK_EQ(driver_remove(&driver), ERROR_NONE); CHECK_EQ(driver_remove(&driver), ERROR_NONE);
CHECK_EQ(driver_destruct(&driver), ERROR_NONE); CHECK_EQ(driver_destruct(&driver), ERROR_NONE);
CHECK_EQ(driver.driver_private, nullptr); CHECK_EQ(driver.internal, nullptr);
} }
TEST_CASE("a driver without a module should not be destructible") { TEST_CASE("a driver without a module should not be destructible") {
@ -40,7 +40,7 @@ TEST_CASE("driver_is_compatible should return true if a compatible value is foun
.api = nullptr, .api = nullptr,
.device_type = nullptr, .device_type = nullptr,
.owner = &module, .owner = &module,
.driver_private = nullptr .internal = nullptr
}; };
CHECK_EQ(driver_is_compatible(&driver, "test_compatible"), true); CHECK_EQ(driver_is_compatible(&driver, "test_compatible"), true);
CHECK_EQ(driver_is_compatible(&driver, "nope"), false); CHECK_EQ(driver_is_compatible(&driver, "nope"), false);
@ -57,7 +57,7 @@ TEST_CASE("driver_find should only find a compatible driver when the driver was
.api = nullptr, .api = nullptr,
.device_type = nullptr, .device_type = nullptr,
.owner = &module, .owner = &module,
.driver_private = nullptr .internal = nullptr
}; };
Driver* found_driver = driver_find_compatible("test_compatible"); Driver* found_driver = driver_find_compatible("test_compatible");

View File

@ -23,12 +23,12 @@ TEST_CASE("Module construction and destruction") {
.start = test_start, .start = test_start,
.stop = test_stop, .stop = test_stop,
.symbols = nullptr, .symbols = nullptr,
.internal = {.started = false} .internal = nullptr
}; };
// Test successful construction // Test successful construction
CHECK_EQ(module_construct(&module), ERROR_NONE); CHECK_EQ(module_construct(&module), ERROR_NONE);
CHECK_EQ(module.internal.started, false); CHECK_EQ(module_is_started(&module), false);
// Test successful destruction // Test successful destruction
CHECK_EQ(module_destruct(&module), ERROR_NONE); CHECK_EQ(module_destruct(&module), ERROR_NONE);
@ -40,7 +40,7 @@ TEST_CASE("Module registration") {
.start = test_start, .start = test_start,
.stop = test_stop, .stop = test_stop,
.symbols = nullptr, .symbols = nullptr,
.internal = {.started = false} .internal = nullptr
}; };
// module_add should succeed // module_add should succeed
@ -61,9 +61,11 @@ TEST_CASE("Module lifecycle") {
.start = test_start, .start = test_start,
.stop = test_stop, .stop = test_stop,
.symbols = nullptr, .symbols = nullptr,
.internal = {.started = false} .internal = nullptr
}; };
CHECK_EQ(module_construct(&module), ERROR_NONE);
// 1. Successful start (no parent required anymore) // 1. Successful start (no parent required anymore)
CHECK_EQ(module_start(&module), ERROR_NONE); CHECK_EQ(module_start(&module), ERROR_NONE);
CHECK_EQ(module_is_started(&module), true); CHECK_EQ(module_is_started(&module), true);
@ -104,6 +106,8 @@ TEST_CASE("Module lifecycle") {
// Clean up: fix stop result so we can stop it // Clean up: fix stop result so we can stop it
test_stop_result = ERROR_NONE; test_stop_result = ERROR_NONE;
CHECK_EQ(module_stop(&module), ERROR_NONE); CHECK_EQ(module_stop(&module), ERROR_NONE);
CHECK_EQ(module_destruct(&module), ERROR_NONE);
} }
TEST_CASE("Global symbol resolution") { TEST_CASE("Global symbol resolution") {
@ -117,9 +121,11 @@ TEST_CASE("Global symbol resolution") {
.start = test_start, .start = test_start,
.stop = test_stop, .stop = test_stop,
.symbols = test_symbols, .symbols = test_symbols,
.internal = {.started = false} .internal = nullptr
}; };
REQUIRE_EQ(module_construct(&module), ERROR_NONE);
uintptr_t addr; uintptr_t addr;
// Should fail as it is not added or started // Should fail as it is not added or started
CHECK_EQ(module_resolve_symbol_global("symbol_test_function", &addr), false); CHECK_EQ(module_resolve_symbol_global("symbol_test_function", &addr), false);
@ -128,8 +134,8 @@ TEST_CASE("Global symbol resolution") {
REQUIRE_EQ(module_start(&module), ERROR_NONE); REQUIRE_EQ(module_start(&module), ERROR_NONE);
// Still fails as symbols are null // Still fails as symbols are null
CHECK_EQ(module_resolve_symbol_global("symbol_test_function", &addr), true); CHECK_EQ(module_resolve_symbol_global("symbol_test_function", &addr), true);
// Cleanup // Cleanup
CHECK_EQ(module_remove(&module), ERROR_NONE); CHECK_EQ(module_remove(&module), ERROR_NONE);
CHECK_EQ(module_destruct(&module), ERROR_NONE); CHECK_EQ(module_destruct(&module), ERROR_NONE);
} }

Some files were not shown because too many files have changed in this diff Show More