openlcb_utilities.h

Go to the documentation of this file.

 
#ifndef __OPENLCB_OPENLCB_UTILITIES__
#define __OPENLCB_OPENLCB_UTILITIES__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "openlcb_defines.h"
#include "openlcb_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
    // =========================================================================
    // Message Structure Operations
    // =========================================================================
 
    extern void OpenLcbUtilities_load_openlcb_message(openlcb_msg_t *openlcb_msg, uint16_t source_alias, uint64_t source_id, uint16_t dest_alias, uint64_t dest_id, uint16_t mti);
 
    extern void OpenLcbUtilities_clear_openlcb_message_payload(openlcb_msg_t *openlcb_msg);
 
    extern void OpenLcbUtilities_clear_openlcb_message(openlcb_msg_t *openlcb_msg);
 
    // =========================================================================
    // Payload Insert Functions (all big-endian, all increment payload_count)
    // =========================================================================
 
    extern void OpenLcbUtilities_copy_event_id_to_openlcb_payload(openlcb_msg_t *openlcb_msg, event_id_t event_id);
 
    extern void OpenLcbUtilities_copy_node_id_to_openlcb_payload(openlcb_msg_t *openlcb_msg, node_id_t node_id, uint16_t offset);
 
    extern void OpenLcbUtilities_copy_byte_to_openlcb_payload(openlcb_msg_t *openlcb_msg, uint8_t byte, uint16_t offset);
 
    extern void OpenLcbUtilities_copy_word_to_openlcb_payload(openlcb_msg_t *openlcb_msg, uint16_t word, uint16_t offset);
 
    extern void OpenLcbUtilities_copy_dword_to_openlcb_payload(openlcb_msg_t *openlcb_msg, uint32_t doubleword, uint16_t offset);
 
    extern uint16_t OpenLcbUtilities_copy_string_to_openlcb_payload(openlcb_msg_t *openlcb_msg, const char string[], uint16_t offset);
 
    extern uint16_t OpenLcbUtilities_copy_byte_array_to_openlcb_payload(openlcb_msg_t *openlcb_msg, const uint8_t byte_array[], uint16_t offset, uint16_t requested_bytes);
 
    // =========================================================================
    // Payload Extract Functions (all big-endian, none modify payload_count)
    // =========================================================================
 
    extern node_id_t OpenLcbUtilities_extract_node_id_from_openlcb_payload(openlcb_msg_t *openlcb_msg, uint16_t offset);
 
    extern event_id_t OpenLcbUtilities_extract_event_id_from_openlcb_payload(openlcb_msg_t *openlcb_msg);
 
    extern uint8_t OpenLcbUtilities_extract_byte_from_openlcb_payload(openlcb_msg_t *openlcb_msg, uint16_t offset);
 
    extern uint16_t OpenLcbUtilities_extract_word_from_openlcb_payload(openlcb_msg_t *openlcb_msg, uint16_t offset);
 
    extern uint32_t OpenLcbUtilities_extract_dword_from_openlcb_payload(openlcb_msg_t *openlcb_msg, uint16_t offset);
 
    // =========================================================================
    // Message Classification
    // =========================================================================
 
    extern uint8_t OpenLcbUtilities_count_nulls_in_openlcb_payload(openlcb_msg_t *openlcb_msg);
 
    extern bool OpenLcbUtilities_is_addressed_openlcb_message(openlcb_msg_t *openlcb_msg);
 
    extern bool OpenLcbUtilities_is_addressed_message_for_node(openlcb_node_t *openlcb_node, openlcb_msg_t *openlcb_msg);
 
    extern void OpenLcbUtilities_set_multi_frame_flag(uint8_t *target, uint8_t flag);
 
    // =========================================================================
    // Event Assignment Lookups
    // =========================================================================
 
    extern bool OpenLcbUtilities_is_producer_event_assigned_to_node(openlcb_node_t *openlcb_node, event_id_t event_id, uint16_t *event_index);
 
    extern bool OpenLcbUtilities_is_consumer_event_assigned_to_node(openlcb_node_t *openlcb_node, event_id_t event_id, uint16_t *event_index);
 
    // =========================================================================
    // Node / Buffer Helpers
    // =========================================================================
 
    extern uint32_t OpenLcbUtilities_calculate_memory_offset_into_node_space(openlcb_node_t *openlcb_node);
 
    extern uint16_t OpenLcbUtilities_payload_type_to_len(payload_type_enum payload_type);
 
    // =========================================================================
    // Configuration Memory Buffer Operations (all big-endian)
    // =========================================================================
 
    extern node_id_t OpenLcbUtilities_extract_node_id_from_config_mem_buffer(configuration_memory_buffer_t *buffer, uint8_t index);
 
    extern uint16_t OpenLcbUtilities_extract_word_from_config_mem_buffer(configuration_memory_buffer_t *buffer, uint8_t index);
 
    extern void OpenLcbUtilities_copy_node_id_to_config_mem_buffer(configuration_memory_buffer_t *buffer, node_id_t node_id, uint8_t index);
 
    extern void OpenLcbUtilities_copy_event_id_to_config_mem_buffer(configuration_memory_buffer_t *buffer, event_id_t event_id, uint8_t index);
 
    extern event_id_t OpenLcbUtilities_copy_config_mem_buffer_to_event_id(configuration_memory_buffer_t *buffer, uint8_t index);
 
    // =========================================================================
    // Configuration Memory Reply Builders
    // =========================================================================
 
    extern void OpenLcbUtilities_load_config_mem_reply_write_fail_message_header(openlcb_statemachine_info_t *statemachine_info, config_mem_write_request_info_t *config_mem_write_request_info, uint16_t error_code);
 
    extern void OpenLcbUtilities_load_config_mem_reply_write_ok_message_header(openlcb_statemachine_info_t *statemachine_info, config_mem_write_request_info_t *config_mem_write_request_info);
 
    extern void OpenLcbUtilities_load_config_mem_reply_read_fail_message_header(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info, uint16_t error_code);
 
    extern void OpenLcbUtilities_load_config_mem_reply_read_ok_message_header(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info);
 
    // =========================================================================
    // Event Range Utilities
    // =========================================================================
 
    extern event_id_t OpenLcbUtilities_generate_event_range_id(event_id_t base_event_id, event_range_count_enum count);
 
    extern bool OpenLcbUtilities_is_event_id_in_consumer_ranges(openlcb_node_t *openlcb_node, event_id_t event_id);
 
    extern bool OpenLcbUtilities_is_event_id_in_producer_ranges(openlcb_node_t *openlcb_node, event_id_t event_id);
 
    // =========================================================================
    // Broadcast Time Event Utilities
    // =========================================================================
 
    extern bool OpenLcbUtilities_is_broadcast_time_event(event_id_t event_id);
 
    extern uint64_t OpenLcbUtilities_extract_clock_id_from_time_event(event_id_t event_id);
 
    extern broadcast_time_event_type_enum OpenLcbUtilities_get_broadcast_time_event_type(event_id_t event_id);
 
    extern bool OpenLcbUtilities_extract_time_from_event_id(event_id_t event_id, uint8_t *hour, uint8_t *minute);
 
    extern bool OpenLcbUtilities_extract_date_from_event_id(event_id_t event_id, uint8_t *month, uint8_t *day);
 
    extern bool OpenLcbUtilities_extract_year_from_event_id(event_id_t event_id, uint16_t *year);
 
    extern bool OpenLcbUtilities_extract_rate_from_event_id(event_id_t event_id, int16_t *rate);
 
    extern event_id_t OpenLcbUtilities_create_time_event_id(uint64_t clock_id, uint8_t hour, uint8_t minute, bool is_set);
 
    extern event_id_t OpenLcbUtilities_create_date_event_id(uint64_t clock_id, uint8_t month, uint8_t day, bool is_set);
 
    extern event_id_t OpenLcbUtilities_create_year_event_id(uint64_t clock_id, uint16_t year, bool is_set);
 
    extern event_id_t OpenLcbUtilities_create_rate_event_id(uint64_t clock_id, int16_t rate, bool is_set);
 
    extern event_id_t OpenLcbUtilities_create_command_event_id(uint64_t clock_id, broadcast_time_event_type_enum command);
 
    // =========================================================================
    // Train Search Event Utilities
    // =========================================================================
 
    extern bool OpenLcbUtilities_is_train_search_event(event_id_t event_id);
 
    extern void OpenLcbUtilities_extract_train_search_digits(event_id_t event_id, uint8_t *digits);
 
    extern uint8_t OpenLcbUtilities_extract_train_search_flags(event_id_t event_id);
 
    extern uint16_t OpenLcbUtilities_train_search_digits_to_address(const uint8_t *digits);
 
    extern event_id_t OpenLcbUtilities_create_train_search_event_id(uint16_t address, uint8_t flags);
 
    extern bool OpenLcbUtilities_is_emergency_event(event_id_t event_id);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __OPENLCB_OPENLCB_UTILITIES__ */