help/html/alias__mappings_8h_source.html

// This is a guard condition so that contents of this file are not included

// more than once.

#ifndef __DRIVERS_CANBUS_ALIAS_MAPPINGS__

#define __DRIVERS_CANBUS_ALIAS_MAPPINGS__


#include <stdbool.h>

#include <stdint.h>


#include "can_types.h"

#include "../../openlcb/openlcb_types.h"


#ifdef __cplusplus

extern "C"

{

#endif /* __cplusplus */


    extern void AliasMappings_initialize(void);


    extern alias_mapping_info_t *AliasMappings_get_alias_mapping_info(void);


    extern void AliasMappings_set_has_duplicate_alias_flag(void);


    extern void AliasMappings_clear_has_duplicate_alias_flag(void);


    extern alias_mapping_t *AliasMappings_register(uint16_t alias, node_id_t node_id);


    extern void AliasMappings_unregister(uint16_t alias);


    extern alias_mapping_t *AliasMappings_find_mapping_by_alias(uint16_t alias);


    extern alias_mapping_t *AliasMappings_find_mapping_by_node_id(node_id_t node_id);


    extern void AliasMappings_flush(void);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* __DRIVERS_CANBUS_ALIAS_MAPPINGS__ */

AliasMappings_find_mapping_by_node_id
alias_mapping_t * AliasMappings_find_mapping_by_node_id(node_id_t node_id)
Finds the mapping entry for the given Node ID.
Definition alias_mappings.c:266

AliasMappings_set_has_duplicate_alias_flag
void AliasMappings_set_has_duplicate_alias_flag(void)
Signals the main loop that an incoming message used one of our reserved aliases.
Definition alias_mappings.c:97

AliasMappings_get_alias_mapping_info
alias_mapping_info_t * AliasMappings_get_alias_mapping_info(void)
Returns a pointer to the internal alias mapping info structure.
Definition alias_mappings.c:90

AliasMappings_find_mapping_by_alias
alias_mapping_t * AliasMappings_find_mapping_by_alias(uint16_t alias)
Finds the mapping entry for the given alias.
Definition alias_mappings.c:226

AliasMappings_flush
void AliasMappings_flush(void)
Clears all alias mappings and resets all flags.
Definition alias_mappings.c:289

AliasMappings_initialize
void AliasMappings_initialize(void)
Initializes the alias mapping buffer, clearing all entries and flags.
Definition alias_mappings.c:79

AliasMappings_unregister
void AliasMappings_unregister(uint16_t alias)
Removes the entry matching the given alias from the buffer.
Definition alias_mappings.c:189

AliasMappings_clear_has_duplicate_alias_flag
void AliasMappings_clear_has_duplicate_alias_flag(void)
Clears the duplicate alias flag after the conflict has been resolved.
Definition alias_mappings.c:104

AliasMappings_register
alias_mapping_t * AliasMappings_register(uint16_t alias, node_id_t node_id)
Registers a CAN alias / Node ID pair in the buffer.
Definition alias_mappings.c:141

can_types.h
Type definitions and constants for the CAN transport layer.

openlcb_types.h
Core type definitions, structures, and configuration constants for the OpenLCB library.

node_id_t
uint64_t node_id_t
48-bit Node ID stored in a 64-bit type (upper 16 bits unused).
Definition openlcb_types.h:359

alias_mapping_info_struct
Definition can_types.h:190

alias_mapping_struct
Definition can_types.h:173