help/html/protocol__config__mem__read__handler_8h_source.html

#ifndef __OPENLCB_PROTOCOL_CONFIG_MEM_READ_HANDLER__

#define    __OPENLCB_PROTOCOL_CONFIG_MEM_READ_HANDLER__


#include <stdbool.h>

#include <stdint.h>


#include "openlcb_types.h"


typedef struct {


    // ---- Required ----


    void (*load_datagram_received_ok_message)(openlcb_statemachine_info_t *statemachine_info, uint16_t reply_pending_time_in_seconds);


    void (*load_datagram_received_rejected_message)(openlcb_statemachine_info_t *statemachine_info, uint16_t return_code);


    uint16_t(*config_memory_read)(openlcb_node_t* openlcb_node, uint32_t address, uint16_t count, configuration_memory_buffer_t* buffer);


    // ---- Optional SNIP field loaders (needed only for ACDI 0xFC / 0xFB spaces) ----


    uint16_t(*snip_load_manufacturer_version_id)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);

    uint16_t(*snip_load_name)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);

    uint16_t(*snip_load_model)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);

    uint16_t(*snip_load_hardware_version)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);

    uint16_t(*snip_load_software_version)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);

    uint16_t(*snip_load_user_version_id)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);

    uint16_t(*snip_load_user_name)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);

    uint16_t(*snip_load_user_description)(openlcb_node_t* openlcb_node, openlcb_msg_t* worker_msg, uint16_t payload_index, uint16_t requested_bytes);


    // ---- Optional per-space read request overrides ----


    void (*read_request_config_definition_info)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);

    void (*read_request_all)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);

    void (*read_request_config_mem)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);

    void (*read_request_acdi_manufacturer)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);

    void (*read_request_acdi_user)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);

    void (*read_request_train_function_config_definition_info)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);

    void (*read_request_train_function_config_memory)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);


    uint16_t (*delayed_reply_time)(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t* config_mem_read_request_info);


} interface_protocol_config_mem_read_handler_t;


#ifdef    __cplusplus

extern "C" {

#endif /* __cplusplus */


    extern void ProtocolConfigMemReadHandler_initialize(const interface_protocol_config_mem_read_handler_t *interface_protocol_config_mem_read_handler);


    // ---- Incoming read commands (server side — this node is being read) ----


    extern void ProtocolConfigMemReadHandler_read_space_config_description_info(openlcb_statemachine_info_t *statemachine_info);


    extern void ProtocolConfigMemReadHandler_read_space_all(openlcb_statemachine_info_t *statemachine_info);


    extern void ProtocolConfigMemReadHandler_read_space_config_memory(openlcb_statemachine_info_t *statemachine_info);


    extern void ProtocolConfigMemReadHandler_read_space_acdi_manufacturer(openlcb_statemachine_info_t *statemachine_info);


    extern void ProtocolConfigMemReadHandler_read_space_acdi_user(openlcb_statemachine_info_t *statemachine_info);


    extern void ProtocolConfigMemReadHandler_read_space_train_function_definition_info(openlcb_statemachine_info_t *statemachine_info);


    extern void ProtocolConfigMemReadHandler_read_space_train_function_config_memory(openlcb_statemachine_info_t *statemachine_info);


    // ---- Outgoing read requests (client side — reading from another node) ----


    extern void ProtocolConfigMemReadHandler_read_request_config_definition_info(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info);


    extern void ProtocolConfigMemReadHandler_read_request_config_mem(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info);


    extern void ProtocolConfigMemReadHandler_read_request_acdi_manufacturer(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info);


    extern void ProtocolConfigMemReadHandler_read_request_acdi_user(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info);


    extern void ProtocolConfigMemReadHandler_read_request_train_function_definition_info(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info);


    extern void ProtocolConfigMemReadHandler_read_request_train_function_config_memory(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info);


    // ---- Generic message handlers (stubs for future use) ----


    extern void ProtocolConfigMemReadHandler_read_message(openlcb_statemachine_info_t *statemachine_info, uint8_t space, uint8_t return_msg_ok, uint8_t return_msg_fail);


    extern void ProtocolConfigMemReadHandler_read_reply_ok_message(openlcb_statemachine_info_t *statemachine_info, uint8_t space);


    extern void ProtocolConfigMemReadHandler_read_reply_reject_message(openlcb_statemachine_info_t *statemachine_info, uint8_t space);


#ifdef    __cplusplus

}

#endif /* __cplusplus */


#endif    /* __OPENLCB_PROTOCOL_CONFIG_MEM_READ_HANDLER__ */

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

configuration_memory_buffer_t
uint8_t configuration_memory_buffer_t[LEN_DATAGRAM_MAX_PAYLOAD]
Configuration memory read/write operation buffer (64 bytes).
Definition openlcb_types.h:365

ProtocolConfigMemReadHandler_read_reply_ok_message
void ProtocolConfigMemReadHandler_read_reply_ok_message(openlcb_statemachine_info_t *statemachine_info, uint8_t space)
Generic read reply OK handler. Placeholder.
Definition protocol_config_mem_read_handler.c:636

ProtocolConfigMemReadHandler_read_space_all
void ProtocolConfigMemReadHandler_read_space_all(openlcb_statemachine_info_t *statemachine_info)
Read from All space (0xFE).
Definition protocol_config_mem_read_handler.c:556

ProtocolConfigMemReadHandler_read_request_train_function_definition_info
void ProtocolConfigMemReadHandler_read_request_train_function_definition_info(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info)
Send read request targeting Train FDI (0xFA) on another node.
Definition protocol_config_mem_read_handler.c:234

ProtocolConfigMemReadHandler_read_reply_reject_message
void ProtocolConfigMemReadHandler_read_reply_reject_message(openlcb_statemachine_info_t *statemachine_info, uint8_t space)
Generic read reply reject handler. Placeholder.
Definition protocol_config_mem_read_handler.c:642

ProtocolConfigMemReadHandler_read_space_acdi_user
void ProtocolConfigMemReadHandler_read_space_acdi_user(openlcb_statemachine_info_t *statemachine_info)
Read from ACDI-User space (0xFB).
Definition protocol_config_mem_read_handler.c:592

ProtocolConfigMemReadHandler_read_space_train_function_definition_info
void ProtocolConfigMemReadHandler_read_space_train_function_definition_info(openlcb_statemachine_info_t *statemachine_info)
Read from Train FDI space (0xFA).
Definition protocol_config_mem_read_handler.c:604

ProtocolConfigMemReadHandler_initialize
void ProtocolConfigMemReadHandler_initialize(const interface_protocol_config_mem_read_handler_t *interface_protocol_config_mem_read_handler)
Stores the callback interface. Call once at startup.
Definition protocol_config_mem_read_handler.c:66

ProtocolConfigMemReadHandler_read_request_acdi_manufacturer
void ProtocolConfigMemReadHandler_read_request_acdi_manufacturer(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info)
Send read request targeting ACDI-Mfg (0xFC) on another node.
Definition protocol_config_mem_read_handler.c:338

ProtocolConfigMemReadHandler_read_message
void ProtocolConfigMemReadHandler_read_message(openlcb_statemachine_info_t *statemachine_info, uint8_t space, uint8_t return_msg_ok, uint8_t return_msg_fail)
Generic read message handler. Placeholder.
Definition protocol_config_mem_read_handler.c:630

ProtocolConfigMemReadHandler_read_space_acdi_manufacturer
void ProtocolConfigMemReadHandler_read_space_acdi_manufacturer(openlcb_statemachine_info_t *statemachine_info)
Read from ACDI-Mfg space (0xFC).
Definition protocol_config_mem_read_handler.c:580

ProtocolConfigMemReadHandler_read_space_config_description_info
void ProtocolConfigMemReadHandler_read_space_config_description_info(openlcb_statemachine_info_t *statemachine_info)
Read from CDI space (0xFF).
Definition protocol_config_mem_read_handler.c:544

ProtocolConfigMemReadHandler_read_request_acdi_user
void ProtocolConfigMemReadHandler_read_request_acdi_user(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info)
Send read request targeting ACDI-User (0xFB) on another node.
Definition protocol_config_mem_read_handler.c:462

ProtocolConfigMemReadHandler_read_request_config_mem
void ProtocolConfigMemReadHandler_read_request_config_mem(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info)
Send read request targeting Config (0xFD) on another node.
Definition protocol_config_mem_read_handler.c:299

ProtocolConfigMemReadHandler_read_request_config_definition_info
void ProtocolConfigMemReadHandler_read_request_config_definition_info(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info)
Send read request targeting CDI (0xFF) on another node.
Definition protocol_config_mem_read_handler.c:219

ProtocolConfigMemReadHandler_read_request_train_function_config_memory
void ProtocolConfigMemReadHandler_read_request_train_function_config_memory(openlcb_statemachine_info_t *statemachine_info, config_mem_read_request_info_t *config_mem_read_request_info)
Send read request targeting Train Fn Config (0xF9) on another node.
Definition protocol_config_mem_read_handler.c:254

ProtocolConfigMemReadHandler_read_space_train_function_config_memory
void ProtocolConfigMemReadHandler_read_space_train_function_config_memory(openlcb_statemachine_info_t *statemachine_info)
Read from Train Fn Config space (0xF9).
Definition protocol_config_mem_read_handler.c:616

ProtocolConfigMemReadHandler_read_space_config_memory
void ProtocolConfigMemReadHandler_read_space_config_memory(openlcb_statemachine_info_t *statemachine_info)
Read from Config space (0xFD).
Definition protocol_config_mem_read_handler.c:568

config_mem_read_request_info_TAG
Request info for a configuration memory read operation.
Definition openlcb_types.h:799

interface_protocol_config_mem_read_handler_t
Callback interface for config memory reads. Datagram ACK and config_memory_read are REQUIRED; SNIP lo...
Definition protocol_config_mem_read_handler.h:50

openlcb_msg_t
Core OpenLCB message structure.
Definition openlcb_types.h:480

openlcb_node_TAG
OpenLCB virtual node.
Definition openlcb_types.h:679

openlcb_statemachine_info_t
Complete context passed to protocol handler functions.
Definition openlcb_types.h:743