descriptors.h

Go to the documentation of this file.

#pragma once
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include "../utils/serialization.h"
#include "../mip_result.h"
 
#ifdef __cplusplus
 
#include <tuple>
#include <type_traits>
#include <functional>
 
namespace mip {
namespace C {
extern "C" {
#endif // __cplusplus
 
enum {
    MIP_INVALID_DESCRIPTOR_SET        = 0x00,
    MIP_DATA_DESCRIPTOR_SET_START     = 0x80,
    MIP_RESERVED_DESCRIPTOR_SET_START = 0xF0,
 
    MIP_INVALID_FIELD_DESCRIPTOR  = 0x00,
    MIP_REPLY_DESCRIPTOR          = 0xF1,
    MIP_RESERVED_DESCRIPTOR_START = 0xF0,
    MIP_RESPONSE_DESCRIPTOR_START = 0x80,
 
    MIP_SHARED_DATA_FIELD_DESCRIPTOR_START = 0xD0,
};
 
bool mip_is_valid_descriptor_set(uint8_t descriptor_set);
bool mip_is_data_descriptor_set(uint8_t descriptor_set);
bool mip_is_cmd_descriptor_set(uint8_t descriptor_set);
bool mip_is_reserved_descriptor_set(uint8_t descriptor_set);
bool mip_is_gnss_data_descriptor_set(uint8_t descriptor_set);
 
bool mip_is_valid_field_descriptor(uint8_t field_descriptor);
bool mip_is_cmd_field_descriptor(uint8_t field_descriptor);
bool mip_is_reply_field_descriptor(uint8_t field_descriptor);
bool mip_is_response_field_descriptor(uint8_t field_descriptor);
bool mip_is_reserved_cmd_field_descriptor(uint8_t field_descriptor);
bool mip_is_shared_data_field_descriptor(uint8_t field_descriptor);
 
enum mip_function_selector
{
    MIP_FUNCTION_WRITE = 0x01,
    MIP_FUNCTION_READ  = 0x02,
    MIP_FUNCTION_SAVE  = 0x03,
    MIP_FUNCTION_LOAD  = 0x04,
    MIP_FUNCTION_RESET = 0x05,
};
typedef enum mip_function_selector mip_function_selector;
void insert_mip_function_selector(mip_serializer* serializer, enum mip_function_selector self);
void extract_mip_function_selector(mip_serializer* serializer, enum mip_function_selector* self);
 
 
#ifdef __cplusplus
 
} // extern "C"
} // namespace "C"
 
 
struct CompositeDescriptor
{
    uint8_t descriptorSet;    
    uint8_t fieldDescriptor;  
 
    constexpr CompositeDescriptor(uint8_t descSet, uint8_t fieldDesc) : descriptorSet(descSet), fieldDescriptor(fieldDesc) {}
    constexpr CompositeDescriptor(uint16_t combo) : descriptorSet(combo >> 8), fieldDescriptor(combo & 0xFF) {}
 
    CompositeDescriptor& operator=(uint16_t combo) { return *this = CompositeDescriptor(combo); }
 
    constexpr uint16_t as_u16() const { return (uint16_t(descriptorSet) << 8) | fieldDescriptor; }
 
//    operator uint16_t() const { return as_u16(); }
 
    constexpr bool operator==(const CompositeDescriptor& other) const { return other.descriptorSet == descriptorSet && other.fieldDescriptor == fieldDescriptor; }
    constexpr bool operator<(const CompositeDescriptor& other) const { return as_u16() < other.as_u16(); }
 
};
 
 
template<typename DerivedT> struct Bitfield {};
 
template<class Derived> void insert (Serializer& serializer, const Bitfield<Derived>& bitfield) { insert(serializer, static_cast<const Derived&>(bitfield).value); }
template<class Derived> void extract(Serializer& serializer, Bitfield<Derived>& bitfield) { extract(serializer, static_cast<Derived&>(bitfield).value); }
 
 
enum class FunctionSelector : uint8_t
{
    WRITE = C::MIP_FUNCTION_WRITE,
    READ  = C::MIP_FUNCTION_READ,
    SAVE  = C::MIP_FUNCTION_SAVE,
    LOAD  = C::MIP_FUNCTION_LOAD,
    RESET = C::MIP_FUNCTION_RESET,
};
 
static constexpr uint8_t INVALID_FIELD_DESCRIPTOR = C::MIP_INVALID_FIELD_DESCRIPTOR;
static constexpr uint8_t INVALID_DESCRIPTOR_SET   = C::MIP_INVALID_DESCRIPTOR_SET;
 
inline bool isValidDescriptorSet   (uint8_t descriptorSet) { return C::mip_is_valid_descriptor_set(descriptorSet); }
inline bool isDataDescriptorSet    (uint8_t descriptorSet) { return C::mip_is_data_descriptor_set(descriptorSet); }
inline bool isCommandDescriptorSet (uint8_t descriptorSet) { return C::mip_is_cmd_descriptor_set(descriptorSet); }
inline bool isReservedDescriptorSet(uint8_t descriptorSet) { return C::mip_is_reserved_descriptor_set(descriptorSet); }
inline bool isGnssDataDescriptorSet(uint8_t descriptorSet) { return C::mip_is_gnss_data_descriptor_set(descriptorSet); }
 
inline bool isValidFieldDescriptor   (uint8_t fieldDescriptor)   { return C::mip_is_valid_field_descriptor(fieldDescriptor); }
inline bool isCommandFieldDescriptor (uint8_t fieldDescriptor)   { return C::mip_is_cmd_field_descriptor(fieldDescriptor); }
inline bool isReplyFieldDescriptor   (uint8_t fieldDescriptor)   { return C::mip_is_reply_field_descriptor(fieldDescriptor); }
inline bool isResponseFieldDescriptor(uint8_t fieldDescriptor)   { return C::mip_is_response_field_descriptor(fieldDescriptor); }
inline bool isReservedFieldDescriptor(uint8_t fieldDescriptor)   { return C::mip_is_reserved_cmd_field_descriptor(fieldDescriptor); }
inline bool isSharedDataFieldDescriptor(uint8_t fieldDescriptor) { return C::mip_is_shared_data_field_descriptor(fieldDescriptor); }
 
 
template<class MipCmd>
struct TypedResult : public CmdResult
{
    using Cmd = MipCmd;
 
    // Same constructor as CmdResult.
    using CmdResult::CmdResult;
 
    static constexpr CompositeDescriptor DESCRIPTOR = MipCmd::DESCRIPTOR;
 
    constexpr CompositeDescriptor descriptor() const { return DESCRIPTOR; }
};
 
} // namespace mip
 
#endif // __cplusplus