openlcb_defines.h

Go to the documentation of this file.

 
// This is a guard condition so that contents of this file are not included
// more than once.
#ifndef __OPENLCB_OPENLCB_DEFINES__
#define __OPENLCB_OPENLCB_DEFINES__
 
// ---------------------------------------------------------------------------
// Library version
// ---------------------------------------------------------------------------
#define OPENLCB_C_LIB_VERSION_MAJOR  1
#define OPENLCB_C_LIB_VERSION_MINOR  0
#define OPENLCB_C_LIB_VERSION_PATCH  0
#define OPENLCB_C_LIB_VERSION        "1.0.0"
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef  __cplusplus
  extern "C" {
#endif /* __cplusplus */
 
#define RUNSTATE_INIT 0
 
#define RUNSTATE_GENERATE_SEED 1
 
#define RUNSTATE_GENERATE_ALIAS 2
 
#define RUNSTATE_LOAD_CHECK_ID_07 3
 
#define RUNSTATE_LOAD_CHECK_ID_06 4
 
#define RUNSTATE_LOAD_CHECK_ID_05 5
 
#define RUNSTATE_LOAD_CHECK_ID_04 6
 
#define RUNSTATE_WAIT_200ms 7
 
#define RUNSTATE_LOAD_RESERVE_ID 8
 
#define RUNSTATE_LOAD_ALIAS_MAP_DEFINITION 9
 
#define RUNSTATE_LOAD_INITIALIZATION_COMPLETE 10
 
#define RUNSTATE_LOAD_CONSUMER_EVENTS 11
 
#define RUNSTATE_LOAD_PRODUCER_EVENTS 12
 
#define RUNSTATE_LOGIN_COMPLETE 13
 
#define RUNSTATE_RUN 14
 
 // end of node_login_states
 
#define RESERVED_TOP_BIT 0x10000000
 
#define CAN_OPENLCB_MSG 0x08000000
 
#define MASK_CAN_FRAME_SEQUENCE_NUMBER 0x07000000
 
#define MASK_CAN_FRAME_TYPE MASK_CAN_FRAME_SEQUENCE_NUMBER
 
#define MASK_CAN_VARIABLE_FIELD 0x00FFF000
 
#define OPENLCB_MESSAGE_STANDARD_FRAME_TYPE 0x01000000
 
#define CAN_FRAME_TYPE_DATAGRAM_ONLY 0x02000000
 
#define CAN_FRAME_TYPE_DATAGRAM_FIRST 0x03000000
 
#define CAN_FRAME_TYPE_DATAGRAM_MIDDLE 0x04000000
 
#define CAN_FRAME_TYPE_DATAGRAM_FINAL 0x05000000
 
#define CAN_FRAME_TYPE_RESERVED 0x06000000
 
#define CAN_FRAME_TYPE_STREAM 0x07000000
 
 // end of can_frame_format
 
#define MTI_INITIALIZATION_COMPLETE 0x0100
 
#define MTI_INITIALIZATION_COMPLETE_SIMPLE 0x0101
 
#define MTI_VERIFY_NODE_ID_ADDRESSED 0x0488
 
#define MTI_VERIFY_NODE_ID_GLOBAL 0x0490
 
#define MTI_VERIFIED_NODE_ID 0x0170
 
#define MTI_VERIFIED_NODE_ID_SIMPLE 0x0171
 
#define MTI_OPTIONAL_INTERACTION_REJECTED 0x0068
 
#define MTI_TERMINATE_DUE_TO_ERROR 0x00A8
 
#define MTI_PROTOCOL_SUPPORT_INQUIRY 0x0828
 
#define MTI_PROTOCOL_SUPPORT_REPLY 0x0668
 
 // end of mti_message_network
 
#define MTI_CONSUMER_IDENTIFY 0x08F4
 
#define MTI_CONSUMER_RANGE_IDENTIFIED 0x04A4
 
#define MTI_CONSUMER_IDENTIFIED_UNKNOWN 0x04C7
 
#define MTI_CONSUMER_IDENTIFIED_SET 0x04C4
 
#define MTI_CONSUMER_IDENTIFIED_CLEAR 0x04C5
 
#define MTI_CONSUMER_IDENTIFIED_RESERVED 0x04C6
 
#define MTI_PRODUCER_IDENTIFY 0x0914
 
#define MTI_PRODUCER_RANGE_IDENTIFIED 0x0524
 
#define MTI_PRODUCER_IDENTIFIED_UNKNOWN 0x0547
 
#define MTI_PRODUCER_IDENTIFIED_SET 0x0544
 
#define MTI_PRODUCER_IDENTIFIED_CLEAR 0x0545
 
#define MTI_PRODUCER_IDENTIFIED_RESERVED 0x0546
 
#define MTI_EVENTS_IDENTIFY_DEST 0x0968
 
#define MTI_EVENTS_IDENTIFY 0x0970
 
#define MTI_EVENT_LEARN 0x0594
 
#define MTI_PC_EVENT_REPORT 0x05B4
 
#define MTI_PC_EVENT_REPORT_WITH_PAYLOAD 0x0F14
 
 // end of mti_event_transport
 
#define MTI_SIMPLE_NODE_INFO_REQUEST 0x0DE8
 
#define MTI_SIMPLE_NODE_INFO_REPLY 0x0A08
 
 // end of mti_snip
 
#define MTI_TRAIN_PROTOCOL 0x05EB
 
#define MTI_TRAIN_REPLY 0x01E9
 
#define MTI_SIMPLE_TRAIN_INFO_REQUEST 0x0DA8
 
#define MTI_SIMPLE_TRAIN_INFO_REPLY 0x09C8
 
 // end of mti_train
 
#define MTI_STREAM_INIT_REQUEST 0x0CC8
 
#define MTI_STREAM_INIT_REPLY 0x0868
 
#define MTI_FRAME_TYPE_CAN_STREAM_SEND 0xF000
 
#define MTI_STREAM_SEND 0x1F88
 
#define MTI_STREAM_PROCEED 0x0888
 
#define MTI_STREAM_COMPLETE 0x08A8
 
 // end of mti_stream
 
#define MTI_DATAGRAM 0x1C48
 
#define MTI_DATAGRAM_OK_REPLY 0x0A28
 
#define MTI_DATAGRAM_REJECTED_REPLY 0x0A48
 
 // end of mti_datagram
 
#define MASK_MULTIFRAME_BITS 0x30
 
#define MULTIFRAME_ONLY 0x00
 
#define MULTIFRAME_FIRST 0x10
 
#define MULTIFRAME_MIDDLE 0x30
 
#define MULTIFRAME_FINAL 0x20
 
 // end of data_field_masks
 
#define MASK_STREAM_OR_DATAGRAM 0x01000
 
#define MASK_PRIORITY 0x00C00
 
#define MASK_SIMPLE_PROTOCOL 0x00010
 
#define MASK_DEST_ADDRESS_PRESENT 0x00008
 
#define MASK_EVENT_PRESENT 0x00004
 
#define MASK_PRIORITY_MODIFIER 0x00003
 
 // end of mti_field_masks
 
#define CAN_CONTROL_FRAME_CID7 0x07000000
 
#define CAN_CONTROL_FRAME_CID6 0x06000000
 
#define CAN_CONTROL_FRAME_CID5 0x05000000
 
#define CAN_CONTROL_FRAME_CID4 0x04000000
 
#define CAN_CONTROL_FRAME_CID3 0x03000000
 
#define CAN_CONTROL_FRAME_CID2 0x02000000
 
#define CAN_CONTROL_FRAME_CID1 0x01000000
 
#define CAN_CONTROL_FRAME_RID 0x00700000
 
#define CAN_CONTROL_FRAME_AMD 0x00701000
 
#define CAN_CONTROL_FRAME_AME 0x00702000
 
#define CAN_CONTROL_FRAME_AMR 0x00703000
 
#define CAN_CONTROL_FRAME_ERROR_INFO_REPORT_0 0x00710000
 
#define CAN_CONTROL_FRAME_ERROR_INFO_REPORT_1 0x00711000
 
#define CAN_CONTROL_FRAME_ERROR_INFO_REPORT_2 0x00712000
 
#define CAN_CONTROL_FRAME_ERROR_INFO_REPORT_3 0x00713000
 
 // end of can_control_frames
 
#define MASK_CAN_STREAM_OR_DATAGRAM 0x01000000
 
#define MASK_CAN_PRIORITY 0x00C00000
 
#define MASK_CAN_SIMPLE_PROTOCOL 0x00010000
 
#define MASK_CAN_DEST_ADDRESS_PRESENT 0x00008000
 
#define MASK_CAN_EVENT_PRESENT 0x00004000
 
#define MASK_CAN_PRIORITY_MODIFIER 0x00003000
 
#define MASK_CAN_SOURCE_ALIAS 0x00000FFF
 
 // end of can_identifier_masks
 
#define PSI_SIMPLE 0x800000
 
#define PSI_DATAGRAM 0x400000
 
#define PSI_STREAM 0x200000
 
#define PSI_MEMORY_CONFIGURATION 0x100000
 
#define PSI_RESERVATION 0x080000
 
#define PSI_EVENT_EXCHANGE 0x040000
 
#define PSI_IDENTIFICATION 0x020000
 
#define PSI_TEACHING_LEARNING 0x010000
 
#define PSI_REMOTE_BUTTON 0x008000
 
#define PSI_ABBREVIATED_DEFAULT_CDI 0x004000
 
#define PSI_DISPLAY 0x002000
 
#define PSI_SIMPLE_NODE_INFORMATION 0x001000
 
#define PSI_CONFIGURATION_DESCRIPTION_INFO 0x000800
 
#define PSI_TRAIN_CONTROL 0x000400
 
#define PSI_FUNCTION_DESCRIPTION 0x000200
 
#define PSI_RESERVED_0 0x000100
 
#define PSI_RESERVED_1 0x000080
 
#define PSI_FUNCTION_CONFIGURATION 0x000040
 
#define PSI_FIRMWARE_UPGRADE 0x000020
 
#define PSI_FIRMWARE_UPGRADE_ACTIVE 0x000010
 
 // end of protocol_support_bits
 
#define EVENT_ID_EMERGENCY_OFF 0x010000000000FFFF
 
#define EVENT_ID_CLEAR_EMERGENCY_OFF 0x010000000000FFFE
 
#define EVENT_ID_EMERGENCY_STOP 0x010000000000FFFD
 
#define EVENT_ID_CLEAR_EMERGENCY_STOP 0x010000000000FFFC
 
#define EVENT_ID_NODE_RECORDED_NEW_LOG 0x010000000000FFF8
 
#define EVENT_ID_POWER_SUPPLY_BROWN_OUT_NODE 0x010000000000FFF1
 
#define EVENT_ID_POWER_SUPPLY_BROWN_OUT_STANDARD 0x010000000000FFF0
 
#define EVENT_ID_IDENT_BUTTON_COMBO_PRESSED 0x010000000000FF00
 
#define EVENT_ID_LINK_ERROR_CODE_1 0x010000000000FF01
 
#define EVENT_ID_LINK_ERROR_CODE_2 0x010000000000FF02
 
#define EVENT_ID_LINK_ERROR_CODE_3 0x010000000000FF03
 
#define EVENT_ID_LINK_ERROR_CODE_4 0x010000000000FF04
 
 // end of well_known_events_auto
 
#define EVENT_ID_DUPLICATE_NODE_DETECTED 0x0101000000000201
 
#define EVENT_ID_TRAIN 0x0101000000000303
 
#define EVENT_ID_TRAIN_PROXY 0x0101000000000304
 
#define EVENT_ID_FIRMWARE_CORRUPTED 0x0101000000000601
 
#define EVENT_ID_FIRMWARE_UPGRADE_BY_HARDWARE_SWITCH 0x0101000000000602
 
#define EVENT_ID_CBUS_OFF_SPACE 0x0101010000000000
 
#define EVENT_ID_CBUS_ON_SPACE 0x0101010100000000
 
#define EVENT_ID_DCC_ACCESSORY_ACTIVATE 0x0101020000FF0000
 
#define EVENT_ID_DCC_ACCESSORY_DEACTIVATE 0x0101020000FE0000
 
#define EVENT_ID_DCC_TURNOUT_FEEDBACK_HIGH 0x0101020000FD0000
 
#define EVENT_ID_DCC_TURNOUT_FEEDBACK_LOW 0x0101020000FC0000
 
#define EVENT_ID_DCC_SENSOR_FEEDBACK_HIGH 0x0101020000FB0000
 
#define EVENT_ID_DCC_SENSOR_FEEDBACK_LO 0x0101020000FA0000
 
#define EVENT_ID_DCC_EXTENDED_ACCESSORY_CMD_SPACE 0x01010200010000FF
 
#define EVENT_TRAIN_SEARCH_SPACE 0x090099FF00000000
 
#define TRAIN_SEARCH_MASK              0xFFFFFFFF00000000ULL
 
#define TRAIN_SEARCH_FLAG_ALLOCATE     0x80
#define TRAIN_SEARCH_FLAG_EXACT        0x40
#define TRAIN_SEARCH_FLAG_ADDRESS_ONLY 0x20
#define TRAIN_SEARCH_FLAG_DCC          0x08
#define TRAIN_SEARCH_FLAG_LONG_ADDR    0x04
#define TRAIN_SEARCH_SPEED_STEP_MASK   0x03
 
#define TRAIN_MAX_DCC_SHORT_ADDRESS          128
 
 // end of well_known_events_local
 // end of well_known_events
 
#define S_OK 0x00
 
#define ERROR_PERMANENT 0x1000
 
#define ERROR_PERMANENT_CONFIG_MEM_ADDRESS_SPACE_UNKNOWN 0x1081
 
#define ERROR_PERMANENT_CONFIG_MEM_OUT_OF_BOUNDS_INVALID_ADDRESS 0x1082
 
#define ERROR_PERMANENT_CONFIG_MEM_ADDRESS_WRITE_TO_READ_ONLY 0x1083
 
#define ERROR_PERMANENT_SOURCE_NOT_PERMITTED 0x1020
 
#define ERROR_PERMANENT_NOT_IMPLEMENTED 0x1040
 
#define ERROR_PERMANENT_NOT_IMPLEMENTED_SUBCOMMAND_UNKNOWN 0x1041
 
#define ERROR_PERMANENT_NOT_IMPLEMENTED_COMMAND_UNKNOWN 0x1042
 
#define ERROR_PERMANENT_NOT_IMPLEMENTED_UNKNOWN_MTI_OR_TRANPORT_PROTOCOL 0x1043
 
#define ERROR_CODE_PERMANENT_COUNT_OUT_OF_RANGE 0x1044
 
#define ERROR_PERMANENT_INVALID_ARGUMENTS 0x1080
 
#define ERROR_TEMPORARY 0x2000
 
#define ERROR_TEMPORARY_BUFFER_UNAVAILABLE 0x2020
 
#define ERROR_TEMPORARY_NOT_EXPECTED_OUT_OF_ORDER 0x2040
 
#define ERROR_TEMPORARY_TRANSFER_ERROR 0x2080
 
#define ERROR_TEMPORARY_TIME_OUT 0x2011
 
#define ERROR_TEMPORARY_OUT_OF_ORDER_MIDDLE_END_WITH_NO_START 0x2041
 
#define ERROR_TEMPORARY_OUT_OF_ORDER_START_BEFORE_LAST_END 0x2042
 
 // end of error_codes
 
#define DATAGRAM_OK_REPLY_PENDING 0x80
 
 // end of datagram_flags
 
#define CONFIG_MEM_CONFIGURATION 0x20
 
 // end of config_mem_protocol
 
#define CONFIG_MEM_READ_SPACE_IN_BYTE_6 0x40
 
#define CONFIG_MEM_READ_SPACE_FD 0x41
 
#define CONFIG_MEM_READ_SPACE_FE 0x42
 
#define CONFIG_MEM_READ_SPACE_FF 0x43
 
#define CONFIG_MEM_READ_REPLY_OK_SPACE_IN_BYTE_6 0x50
 
#define CONFIG_MEM_READ_REPLY_OK_SPACE_FD 0x51
 
#define CONFIG_MEM_READ_REPLY_OK_SPACE_FE 0x52
 
#define CONFIG_MEM_READ_REPLY_OK_SPACE_FF 0x53
 
#define CONFIG_MEM_READ_REPLY_FAIL_SPACE_IN_BYTE_6 0x58
 
#define CONFIG_MEM_READ_REPLY_FAIL_SPACE_FD 0x59
 
#define CONFIG_MEM_READ_REPLY_FAIL_SPACE_FE 0x5A
 
#define CONFIG_MEM_READ_REPLY_FAIL_SPACE_FF 0x5B
 
 // end of config_mem_read
 
#define CONFIG_MEM_READ_STREAM_SPACE_IN_BYTE_6 0x60
 
#define CONFIG_MEM_READ_STREAM_SPACE_FD 0x61
 
#define CONFIG_MEM_READ_STREAM_SPACE_FE 0x62
 
#define CONFIG_MEM_READ_STREAM_SPACE_FF 0x63
 
#define CONFIG_MEM_READ_STREAM_REPLY_OK_SPACE_IN_BYTE_6 0x70
 
#define CONFIG_MEM_READ_STREAM_REPLY_OK_SPACE_FD 0x71
 
#define CONFIG_MEM_READ_STREAM_REPLY_OK_SPACE_FE 0x72
 
#define CONFIG_MEM_READ_STREAM_REPLY_OK_SPACE_FF 0x73
 
#define CONFIG_MEM_READ_STREAM_REPLY_FAIL_SPACE_IN_BYTE_6 0x78
 
#define CONFIG_MEM_READ_STREAM_REPLY_FAIL_SPACE_FD 0x79
 
#define CONFIG_MEM_READ_STREAM_REPLY_FAIL_SPACE_FE 0x7A
 
#define CONFIG_MEM_READ_STREAM_REPLY_FAIL_SPACE_FF 0x7B
 
 // end of config_mem_read_stream
 
#define CONFIG_MEM_WRITE_SPACE_IN_BYTE_6 0x00
 
#define CONFIG_MEM_WRITE_SPACE_FD 0x01
 
#define CONFIG_MEM_WRITE_SPACE_FE 0x02
 
#define CONFIG_MEM_WRITE_SPACE_FF 0x03
 
#define CONFIG_MEM_WRITE_REPLY_OK_SPACE_IN_BYTE_6 0x10
 
#define CONFIG_MEM_WRITE_REPLY_OK_SPACE_FD 0x11
 
#define CONFIG_MEM_WRITE_REPLY_OK_SPACE_FE 0x12
 
#define CONFIG_MEM_WRITE_REPLY_OK_SPACE_FF 0x13
 
#define CONFIG_MEM_WRITE_REPLY_FAIL_SPACE_IN_BYTE_6 0x18
 
#define CONFIG_MEM_WRITE_REPLY_FAIL_SPACE_FD 0x19
 
#define CONFIG_MEM_WRITE_REPLY_FAIL_SPACE_FE 0x1A
 
#define CONFIG_MEM_WRITE_REPLY_FAIL_SPACE_FF 0x1B
 
 // end of config_mem_write
 
#define CONFIG_MEM_WRITE_UNDER_MASK_SPACE_IN_BYTE_6 0x08
 
#define CONFIG_MEM_WRITE_UNDER_MASK_SPACE_FD 0x09
 
#define CONFIG_MEM_WRITE_UNDER_MASK_SPACE_FE 0x0A
 
#define CONFIG_MEM_WRITE_UNDER_MASK_SPACE_FF 0x0B
 
 // end of config_mem_write_mask
 
#define CONFIG_MEM_WRITE_STREAM_SPACE_IN_BYTE_6 0x20
 
#define CONFIG_MEM_WRITE_STREAM_SPACE_FD 0x21
 
#define CONFIG_MEM_WRITE_STREAM_SPACE_FE 0x22
 
#define CONFIG_MEM_WRITE_STREAM_SPACE_FF 0x23
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_OK_SPACE_IN_BYTE_6 0x30
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_OK_SPACE_FD 0x31
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_OK_SPACE_FE 0x32
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_OK_SPACE_FF 0x33
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_FAIL_SPACE_IN_BYTE_6 0x38
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_FAIL_SPACE_FD 0x39
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_FAIL_SPACE_FE 0x3A
 
#define CONFIG_MEM_WRITE_STREAM_REPLY_FAIL_SPACE_FF 0x3B
 
 // end of config_mem_write_stream
 
#define CONFIG_MEM_OPTIONS_CMD 0x80
 
#define CONFIG_MEM_OPTIONS_REPLY 0x82
 
#define CONFIG_MEM_GET_ADDRESS_SPACE_INFO_CMD 0x84
 
#define CONFIG_MEM_GET_ADDRESS_SPACE_INFO_REPLY_NOT_PRESENT 0x86
 
#define CONFIG_MEM_GET_ADDRESS_SPACE_INFO_REPLY_PRESENT 0x87
 
#define CONFIG_MEM_RESERVE_LOCK 0x88
 
#define CONFIG_MEM_RESERVE_LOCK_REPLY 0x8A
 
#define CONFIG_MEM_GET_UNIQUE_ID 0x8C
 
#define CONFIG_MEM_GET_UNIQUE_ID_REPLY 0x8D
 
#define CONFIG_MEM_UNFREEZE 0xA0
 
#define CONFIG_MEM_FREEZE 0xA1
 
#define CONFIG_MEM_UPDATE_COMPLETE 0xA8
 
#define CONFIG_MEM_RESET_REBOOT 0xA9
 
#define CONFIG_MEM_FACTORY_RESET 0xAA
 
 // end of config_mem_operations
 
#define CONFIG_MEM_SPACE_CONFIGURATION_DEFINITION_INFO 0xFF
 
#define CONFIG_MEM_SPACE_ALL 0xFE
 
#define CONFIG_MEM_SPACE_CONFIGURATION_MEMORY 0xFD
 
#define CONFIG_MEM_SPACE_ACDI_MANUFACTURER_ACCESS 0xFC
 
#define CONFIG_MEM_SPACE_ACDI_USER_ACCESS 0xFB
 
#define CONFIG_MEM_SPACE_TRAIN_FUNCTION_DEFINITION_INFO 0xFA
 
#define CONFIG_MEM_SPACE_TRAIN_FUNCTION_CONFIGURATION_MEMORY 0xF9
 
#define CONFIG_MEM_SPACE_FIRMWARE 0xEF
 
 // end of address_spaces
 
#define CONFIG_MEM_ACDI_MANUFACTURER_VERSION_ADDRESS 0x00
 
#define CONFIG_MEM_ACDI_MANUFACTURER_ADDRESS 0x01
 
#define CONFIG_MEM_ACDI_MODEL_ADDRESS 0x2A
 
#define CONFIG_MEM_ACDI_HARDWARE_VERSION_ADDRESS 0x53
 
#define CONFIG_MEM_ACDI_SOFTWARE_VERSION_ADDRESS 0x68
 
#define CONFIG_MEM_ACDI_VERSION_LEN 1
 
#define CONFIG_MEM_ACDI_MANUFACTURER_LEN 41
 
#define CONFIG_MEM_ACDI_MODEL_LEN 41
 
#define CONFIG_MEM_ACDI_HARDWARE_VERSION_LEN 21
 
#define CONFIG_MEM_ACDI_SOFTWARE_VERSION_LEN 21
 
 // end of acdi_manufacturer_layout
 
#define CONFIG_MEM_USER_MODEL_ADDRESS 0x00
 
#define CONFIG_MEM_USER_DESCRIPTION_ADDRESS 0x3F
 
#define CONFIG_MEM_ACDI_USER_VERSION_ADDRESS 0x00
 
#define CONFIG_MEM_ACDI_USER_NAME_ADDRESS 0x01
 
#define CONFIG_MEM_ACDI_USER_DESCRIPTION_ADDRESS 0x40
 
#define CONFIG_MEM_ACDI_USER_VERSION_LEN 1
 
#define CONFIG_MEM_ACDI_USER_NAME_LEN 63
 
#define CONFIG_MEM_ACDI_USER_DESCRIPTION_LEN 64
 
#define CONFIG_MEM_CONFIG_USER_NAME_OFFSET 0x00000000
 
#define CONFIG_MEM_CONFIG_USER_DESCRIPTION_OFFSET 63   /* CONFIG_MEM_ACDI_USER_NAME_LEN (63) */
 
 // end of acdi_user_layout
 
#define CONFIG_MEM_REPLY_OK_OFFSET 0x10
 
#define CONFIG_MEM_REPLY_FAIL_OFFSET 0x18
 
 // end of config_mem_reply_offsets
 
#define CONFIG_OPTIONS_COMMANDS_WRITE_UNDER_MASK 0x8000
 
#define CONFIG_OPTIONS_COMMANDS_UNALIGNED_READS 0x4000
 
#define CONFIG_OPTIONS_COMMANDS_UNALIGNED_WRITES 0x2000
 
#define CONFIG_OPTIONS_COMMANDS_ACDI_MANUFACTURER_READ 0x0800
 
#define CONFIG_OPTIONS_COMMANDS_ACDI_USER_READ 0x0400
 
#define CONFIG_OPTIONS_COMMANDS_ACDI_USER_WRITE 0x0200
 
 // end of config_options_bits
 
#define CONFIG_OPTIONS_WRITE_LENGTH_RESERVED (0x80 | 0x40 | 0x20 | 0x02)
 
#define CONFIG_OPTIONS_WRITE_LENGTH_STREAM_READ_WRITE 0x01
 
 // end of config_write_length_flags
 
#define CONFIG_OPTIONS_SPACE_INFO_FLAG_READ_ONLY 0x01
 
#define CONFIG_OPTIONS_SPACE_INFO_FLAG_USE_LOW_ADDRESS 0x02
 
 // end of address_space_info_flags
 
#define MAX_INTERNAL_ENUM_KEYS_VALUES 4
 
#define MAX_USER_ENUM_KEYS_VALUES 4
 
#define USER_ENUM_KEYS_VALUES_1 0
 
#define USER_ENUM_KEYS_VALUES_2 1
 
#define USER_ENUM_KEYS_VALUES_3 2
 
#define USER_ENUM_KEYS_VALUES_4 3
 
#define MAX_NODE_ENUM_KEY_VALUES (MAX_USER_ENUM_KEYS_VALUES + MAX_INTERNAL_ENUM_KEYS_VALUES)
 
#define OPENLCB_MAIN_STATMACHINE_NODE_ENUMERATOR_INDEX MAX_USER_ENUM_KEYS_VALUES
 
#define OPENLCB_LOGIN_STATMACHINE_NODE_ENUMERATOR_INDEX (MAX_USER_ENUM_KEYS_VALUES + 1)
 
#define CAN_STATEMACHINE_NODE_ENUMRATOR_KEY (MAX_USER_ENUM_KEYS_VALUES + 2)
 
#define DATAGRAM_TIMEOUT_ENUM_KEY (MAX_USER_ENUM_KEYS_VALUES + 3)
 
 // end of node_enum_keys
 
#define BROADCAST_TIME_ID_DEFAULT_FAST_CLOCK       0x0101000001000000ULL
 
#define BROADCAST_TIME_ID_DEFAULT_REALTIME_CLOCK   0x0101000001010000ULL
 
#define BROADCAST_TIME_ID_ALTERNATE_CLOCK_1        0x0101000001020000ULL
 
#define BROADCAST_TIME_ID_ALTERNATE_CLOCK_2        0x0101000001030000ULL
 
#define BROADCAST_TIME_MASK_CLOCK_ID               0xFFFFFFFFFFFF0000ULL
 
#define BROADCAST_TIME_MASK_COMMAND_DATA           0x000000000000FFFFULL
 
#define BROADCAST_TIME_REPORT_TIME_BASE            0x0000
 
#define BROADCAST_TIME_REPORT_DATE_BASE            0x2100
 
#define BROADCAST_TIME_REPORT_YEAR_BASE            0x3000
 
#define BROADCAST_TIME_REPORT_RATE_BASE            0x4000
 
#define BROADCAST_TIME_SET_TIME_BASE               0x8000
 
#define BROADCAST_TIME_SET_DATE_BASE               0xA100
 
#define BROADCAST_TIME_SET_YEAR_BASE               0xB000
 
#define BROADCAST_TIME_SET_RATE_BASE               0xC000
 
#define BROADCAST_TIME_QUERY                       0xF000
 
#define BROADCAST_TIME_STOP                        0xF001
 
#define BROADCAST_TIME_START                       0xF002
 
#define BROADCAST_TIME_DATE_ROLLOVER               0xF003
 
#define BROADCAST_TIME_SET_COMMAND_OFFSET          0x8000
 
 // end of broadcast_time_events
 
    // Train instruction byte bit fields
 
#define TRAIN_INSTRUCTION_P_BIT          0x80
 
    // Train instruction bytes (byte 0 of payload, bits 6:0)
 
#define TRAIN_SET_SPEED_DIRECTION    0x00
 
#define TRAIN_SET_FUNCTION           0x01
 
#define TRAIN_EMERGENCY_STOP         0x02
 
#define TRAIN_QUERY_SPEEDS           0x10
 
#define TRAIN_QUERY_FUNCTION         0x11
 
#define TRAIN_CONTROLLER_CONFIG      0x20
 
#define TRAIN_LISTENER_CONFIG        0x30
 
#define TRAIN_MANAGEMENT             0x40
 
    // Controller config sub-commands (byte 1)
 
#define TRAIN_CONTROLLER_ASSIGN      0x01
 
#define TRAIN_CONTROLLER_RELEASE     0x02
 
#define TRAIN_CONTROLLER_QUERY       0x03
 
#define TRAIN_CONTROLLER_CHANGED     0x04
 
    // Listener config sub-commands (byte 1)
 
#define TRAIN_LISTENER_ATTACH        0x01
 
#define TRAIN_LISTENER_DETACH        0x02
 
#define TRAIN_LISTENER_QUERY         0x03
 
    // Management sub-commands (byte 1)
 
#define TRAIN_MGMT_RESERVE           0x01
 
#define TRAIN_MGMT_RELEASE           0x02
 
#define TRAIN_MGMT_NOOP             0x03
 
    // Listener flags
 
#define TRAIN_LISTENER_FLAG_REVERSE       0x02
 
#define TRAIN_LISTENER_FLAG_LINK_F0       0x04
 
#define TRAIN_LISTENER_FLAG_LINK_FN       0x08
 
#define TRAIN_LISTENER_FLAG_HIDE          0x80
 
 // end of train_protocol
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __OPENLCB_OPENLCB_DEFINES__ */