descriptors.h File Reference

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
#include "../utils/serialization.h"
#include "../mip_result.h"

Include dependency graph for descriptors.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef enum mip_function_selector	mip_function_selector

Enumerations
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 }
enum	mip_function_selector {   MIP_FUNCTION_WRITE = 0x01, MIP_FUNCTION_READ = 0x02, MIP_FUNCTION_SAVE = 0x03, MIP_FUNCTION_LOAD = 0x04,   MIP_FUNCTION_RESET = 0x05 }

Functions
void	extract_mip_function_selector (mip_serializer *serializer, enum mip_function_selector *self)
void	insert_mip_function_selector (mip_serializer *serializer, enum mip_function_selector self)
bool	mip_is_cmd_descriptor_set (uint8_t descriptor_set)
	Determines if the descriptor set contains commands. More...
bool	mip_is_cmd_field_descriptor (uint8_t field_descriptor)
	Determines if the field descriptor is a command. More...
bool	mip_is_data_descriptor_set (uint8_t descriptor_set)
	Determines if the descriptor set represents some kind of data. More...
bool	mip_is_gnss_data_descriptor_set (uint8_t descriptor_set)
	Determines if the descriptor set represents some kind of GNSS data. More...
bool	mip_is_reply_field_descriptor (uint8_t field_descriptor)
	Determines if the field descriptor is for an ack/nack reply. More...
bool	mip_is_reserved_cmd_field_descriptor (uint8_t field_descriptor)
	Determines if the field descriptor is reserved. More...
bool	mip_is_reserved_descriptor_set (uint8_t descriptor_set)
	Determines if the descriptor is reserved for special purposes. More...
bool	mip_is_response_field_descriptor (uint8_t field_descriptor)
	Determines if the field descriptor contains response data from a command. More...
bool	mip_is_shared_data_field_descriptor (uint8_t field_descriptor)
	Determines if the field descriptor is from the shared data set. More...
bool	mip_is_valid_descriptor_set (uint8_t descriptor_set)
	Determines if the descriptor set is valid. More...
bool	mip_is_valid_field_descriptor (uint8_t field_descriptor)
	Determines if the field descriptor is valid. More...

Typedef Documentation

mip_function_selector

typedef enum mip_function_selector mip_function_selector

Definition at line 54 of file descriptors.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
MIP_INVALID_DESCRIPTOR_SET
MIP_DATA_DESCRIPTOR_SET_START
MIP_RESERVED_DESCRIPTOR_SET_START
MIP_INVALID_FIELD_DESCRIPTOR
MIP_REPLY_DESCRIPTOR
MIP_RESERVED_DESCRIPTOR_START
MIP_RESPONSE_DESCRIPTOR_START
MIP_SHARED_DATA_FIELD_DESCRIPTOR_START

Definition at line 20 of file descriptors.h.

mip_function_selector

enum mip_function_selector

Enumerator
MIP_FUNCTION_WRITE
MIP_FUNCTION_READ
MIP_FUNCTION_SAVE
MIP_FUNCTION_LOAD
MIP_FUNCTION_RESET

Definition at line 46 of file descriptors.h.

Function Documentation

extract_mip_function_selector()

void extract_mip_function_selector	(	mip_serializer *	serializer,
		enum mip_function_selector *	self
	)

Definition at line 159 of file descriptors.c.

insert_mip_function_selector()

void insert_mip_function_selector	(	mip_serializer *	serializer,
		enum mip_function_selector	self
	)

Definition at line 154 of file descriptors.c.

mip_is_cmd_descriptor_set()

bool mip_is_cmd_descriptor_set

(

uint8_t

descriptor_set

)

Determines if the descriptor set contains commands.

Parameters

descriptor_set

Returns

true if the descriptor set contains commands.

Definition at line 43 of file descriptors.c.

mip_is_cmd_field_descriptor()

bool mip_is_cmd_field_descriptor

(

uint8_t

field_descriptor

)

Determines if the field descriptor is a command.

Parameters

field_descriptor

Returns

true if the field descriptor represents a command.

Definition at line 93 of file descriptors.c.

mip_is_data_descriptor_set()

bool mip_is_data_descriptor_set

(

uint8_t

descriptor_set

)

Determines if the descriptor set represents some kind of data.

Parameters

descriptor_set

Returns

true if the descriptor set represents data.

Definition at line 31 of file descriptors.c.

mip_is_gnss_data_descriptor_set()

bool mip_is_gnss_data_descriptor_set

(

uint8_t

descriptor_set

)

Determines if the descriptor set represents some kind of GNSS data.

Parameters

descriptor_set

Returns

true if the descriptor set represents GNSS data.

Definition at line 67 of file descriptors.c.

mip_is_reply_field_descriptor()

bool mip_is_reply_field_descriptor

(

uint8_t

field_descriptor

)

Determines if the field descriptor is for an ack/nack reply.

Parameters

field_descriptor

Returns

true if the field descriptor represents an ack/nack reply code.

Definition at line 105 of file descriptors.c.

mip_is_reserved_cmd_field_descriptor()

bool mip_is_reserved_cmd_field_descriptor

(

uint8_t

field_descriptor

)

Determines if the field descriptor is reserved.

The descriptor set is assumed to be a command set.

Parameters

field_descriptor

Returns

true if the associated field is neither a command nor response.

Definition at line 134 of file descriptors.c.

mip_is_reserved_descriptor_set()

bool mip_is_reserved_descriptor_set

(

uint8_t

descriptor_set

)

Determines if the descriptor is reserved for special purposes.

Parameters

descriptor_set

Returns

true if the descriptor set is reserved.

Definition at line 55 of file descriptors.c.

mip_is_response_field_descriptor()

bool mip_is_response_field_descriptor

(

uint8_t

field_descriptor

)

Determines if the field descriptor contains response data from a command.

The descriptor set is assumed to be a command set.

Parameters

field_descriptor

Returns

true if the associated field contains response data.

Definition at line 120 of file descriptors.c.

mip_is_shared_data_field_descriptor()

bool mip_is_shared_data_field_descriptor

(

uint8_t

field_descriptor

)

Determines if the field descriptor is from the shared data set.

The descriptor set is assumed to be a data set.

Parameters

field_descriptor

Returns

true if the associated field is from the shared data set.

Definition at line 148 of file descriptors.c.

mip_is_valid_descriptor_set()

bool mip_is_valid_descriptor_set

(

uint8_t

descriptor_set

)

Determines if the descriptor set is valid.

Parameters

descriptor_set

Returns

true if the descriptor set is valid.

Definition at line 19 of file descriptors.c.

mip_is_valid_field_descriptor()

bool mip_is_valid_field_descriptor

(

uint8_t

field_descriptor

)

Determines if the field descriptor is valid.

Parameters

field_descriptor

Returns

true if the field descriptor is valid.

Definition at line 81 of file descriptors.c.