TactilityKernel improvements (#464)
* **New Features** * Thread API with lifecycle, priority, affinity and state monitoring * Timer subsystem: one-shot/periodic timers, reset, pending callbacks, expiry queries * Expanded I²C: register-level ops, bulk writes, presence checks, ESP32 integration and new config properties * GPIO controller: pin level and options APIs * Error utilities: new error code, error-to-string, timeout helper and common macros * Device construction helpers (construct+start) * **Tests** * New unit tests for thread and timer behavior * **Documentation** * Expanded coding style guide (files/folders, C conventions)
This commit is contained in:
committed by
GitHub
parent
f6ddb14ec1
commit
71f8369377
+36
-2
@@ -1,6 +1,6 @@
|
||||
# C coding Style
|
||||
|
||||
## Naming
|
||||
## Files & Folders
|
||||
|
||||
### Files
|
||||
|
||||
@@ -8,7 +8,7 @@ Files are lower snake case.
|
||||
|
||||
- Files: `^[0-9a-z_]+$`
|
||||
- Directories: `^[0-9a-z_]+$`
|
||||
|
||||
|
||||
Example:
|
||||
```c
|
||||
some_feature.c
|
||||
@@ -22,6 +22,8 @@ Project folders include:
|
||||
- `private` for private header files
|
||||
- `include` for projects that require separate header files
|
||||
|
||||
## C language
|
||||
|
||||
### Macros and consts
|
||||
|
||||
These are all upper snake case:
|
||||
@@ -94,3 +96,35 @@ Examples:
|
||||
```c
|
||||
typedef uint32_t thread_id_t;
|
||||
```
|
||||
|
||||
### Function comments
|
||||
|
||||
```c
|
||||
/**
|
||||
* @brief Validates a number
|
||||
* @param[in] number the integer to validate
|
||||
* @return true if validation was succesful and there were no issues
|
||||
*/
|
||||
bool validate(int number);
|
||||
|
||||
/**
|
||||
* @brief Run the action.
|
||||
* @param timeout[in] the maximum time the task should run
|
||||
* @retval ERROR_TIMEOUT when the task couldn't be completed on time
|
||||
* @retval ERROR_NONE when the task completed successfully
|
||||
*/
|
||||
error_t runAction(TickType_t timeout);
|
||||
|
||||
/**
|
||||
* @brief Increase a number.
|
||||
* @param[inout] number
|
||||
*/
|
||||
void increase(int* number);
|
||||
|
||||
/**
|
||||
* A function with a longer description here.
|
||||
*
|
||||
* @brief short description
|
||||
*/
|
||||
void something();
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user