Skip to content

Commit

Permalink
PR comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Diamond committed Oct 15, 2024
1 parent 5b4b029 commit 190f9b2
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions src/point_one/fusion_engine/messages/configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -1480,22 +1480,19 @@ struct P1_ALIGNAS(4) ExportDataMessage {
* See also @ref ExportDataMessage.
*
* Changes:
* - Version 1: Added data_validity field.
* - Version 1: Added @ref data_validity field.
* - Version 2: Changed data_validity to a @ref Response enum and added
* @ref source field.
* - Version 3: Added flags field.
* - Version 3: Added @ref flags field.
*/
struct P1_ALIGNAS(4) PlatformStorageDataMessage {
static constexpr MessageType MESSAGE_TYPE =
MessageType::PLATFORM_STORAGE_DATA;
static constexpr uint8_t MESSAGE_VERSION = 3;

/**
* @ref DataType::USER_CONFIG flag that does not specify what platform the
* configuration corresponds to.
*/
/** @ref DataType::USER_CONFIG the flags field is not set. */
static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED = 0;
/** @ref DataType::USER_CONFIG flag for posix platforms. */
/** @ref DataType::USER_CONFIG flag for POSIX platforms. */
static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_POSIX = 1;
/** @ref DataType::USER_CONFIG flag for embedded platforms. */
static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_EMBEDDED = 2;
Expand All @@ -1516,7 +1513,15 @@ struct P1_ALIGNAS(4) PlatformStorageDataMessage {
* ConfigurationSource::ACTIVE.
*/
ConfigurationSource source = ConfigurationSource::ACTIVE;
/** @ref DataType specific flags. */
/**
* @ref DataType specific flags.
*
* Currently, only defined for @ref DataType::USER_CONFIG contents. This value
* can optionally set to one of the `FLAG_USER_CONFIG_PLATFORM_*` values to
* indicate which type of platform the UserConfig is valid for. This value
* can be left at `0` for backwards compatibility or to indicate the platform
* type is unknown.
*/
uint8_t flags = 0;
/** Version of data contents. */
DataVersion data_version;
Expand Down

0 comments on commit 190f9b2

Please sign in to comment.