Skip to content
Snippets Groups Projects
Unverified Commit 9bc44384 authored by Grigoris Pavlakis's avatar Grigoris Pavlakis
Browse files

Update docs

parent 22749839
No related branches found
No related tags found
No related merge requests found
......@@ -20,6 +20,7 @@
* @typedef ParamId: the unique ID of a parameter, used for searching
* @typedef ValueType: the type of the parameter's value (changing types is WIP)
* @typedef UpdatePtr: pointer to a void function, with a single ValueType* argument (return address)
* @typedef Flags: container for the binary flags
*/
typedef uint16_t ParamId;
typedef uint32_t ValueType;
......@@ -38,7 +39,7 @@ typedef etl::bitset<NUM_OF_FLAGS> Flags;
*
* Additional features (not included in standard):
* @private flags: Various binary flags (number and meaning TBD).
* Current flag meanings (starting from LSB, big-endian):
* @warning Current flag meanings (starting from LSB, big-endian):
* Index 0: update with priority
* Index 1: manual update available
* Index 2: automatic update available
......
......@@ -9,10 +9,8 @@
// Number of stored parameters. MAX_PARAMS is just a dummy number for now.
#define MAX_PARAMS 5
// TODO: 2) Implement flags and use them above
// TODO: 3) Write more and better tests
// TODO: 4) Make sure that docs are up to date
// TODO: 5) Optimize stuff if possible
/**
* Implementation of the ST[20] parameter management service,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment