dcc/Defs.hxx

Go to the documentation of this file.

 
#ifndef _DCC_DEFS_HXX_
#define _DCC_DEFS_HXX_
 
#include <stdint.h>
 
namespace dcc
{
 
enum class TrainAddressType : uint8_t
{
    DCC_SHORT_ADDRESS = 1,
    DCC_LONG_ADDRESS,
    MM,
    DCC_ACCY_BASIC_OUTPUT,
    DCC_ACCY_EXT,
    UNSUPPORTED = 255,
    UNSPECIFIED = 254,
};
 
namespace Defs
{
 
enum
{
    MARKLIN_DEFAULT_CMD = 0b00100110,
    // Direction change bits for marklin-old format.
    MARKLIN_CHANGE_DIR_B2 = 0b11000000,
 
    DCC_DEFAULT_CMD = 0,
    DCC_LONG_PREAMBLE_CMD = 0b00001100,
    DCC_SERVICE_MODE_5X_WITH_ACK_CMD = 0b00111000,
    // standard dcc packet with 5x repeat.
    DCC_SERVICE_MODE_5X_CMD = 0b00101000,
    DCC_SERVICE_MODE_1X_CMD = 0b00001000,
    DCC_LONG_ADDRESS_FIRST = 0b11000000,
 
    // Baseline packet: speed and direction.
    DCC_BASELINE_SPEED = 0b01000000,
    DCC_BASELINE_SPEED_FORWARD = 0b00100000,
    DCC_BASELINE_SPEED_LIGHT = 0b00010000,
    DCC_FUNCTION1 = 0b10000000,
    DCC_FUNCTION1_F0 = 0b00010000,
    DCC_FUNCTION2_F5 = 0b10110000,
    DCC_FUNCTION2_F9 = 0b10100000,
    DCC_FEATURE_EXP_F13 = 0b11011110,
    DCC_FEATURE_EXP_F21 = 0b11011111,
    DCC_FEATURE_EXP_FNHI = 0b11011000,
    DCC_BINARY_SHORT = 0b11011101,
    DCC_BINARY_LONG = 0b11000000,
    DCC_ANALOG_FN = 0b00111101,
 
    DCC_PROG_READ1 = 0b11100100,
    DCC_PROG_WRITE1 = 0b11101100,
    DCC_PROG_READ4 = 0b11100000,
 
    DCC_SVC_BIT_MANIPULATE = 0b01111000,
    DCC_SVC_WRITE = 0b01111100,
    DCC_SVC_VERIFY = 0b01110100,
    DCC_SVC_MASK = 0b11111100,
 
    DCC_SVC_BITVAL_WRITE = 0b11110000,
    DCC_SVC_BITVAL_VERIFY = 0b11100000,
    DCC_SVC_BITVAL_VALUE = 0b00001000,
    DCC_SVC_BITVAL_MASK = 0b11110000,
 
    DCC_SVC_PAGED_WRITE = 0b01111000,
    DCC_SVC_PAGED_VERIFY = 0b01110000,
    DCC_SVC_PAGED_MASK = 0b11111000,
 
    // Byte 1 of dcc accessory control packet
    DCC_BASIC_ACCESSORY_B1 = 0b10000000,
    // Mask to check on DCC_BASIC_ACCESSORY_B1
    DCC_BASIC_ACCESSORY_MASK1 = 0b11000000,
    // Byte 2 of dcc basic accessory control packet
    DCC_BASIC_ACCESSORY_B2 = 0b10000000,
    // Mask for dcc basic accessory control packet
    DCC_BASIC_ACCESSORY_MASK2 = 0b10000000,
    // Byte 2 of DCC extended accessory control packet
    DCC_EXT_ACCESSORY_B2 = 0b00000001,
    // Mask for DCC_EXT_ACCESSORY_B2
    DCC_EXT_ACCESSORY_MASK2 = 0b10001001,
 
    // Basic accy activate command (in byte 2)
    DCC_BASIC_ACCESSORY_B2_ACTIVATE = 0b00001000,
    // Basic accy deactivate command (in byte 2)
    DCC_BASIC_ACCESSORY_B2_DEACTIVATE = 0b00000000,
    // Mask for activate/deactivate
    DCC_BASIC_ACCESSORY_B2_ACTIVATE_MASK = DCC_BASIC_ACCESSORY_B2_ACTIVATE,
    // Basic accy thrown / reverse / red / off command (in byte 2)
    DCC_BASIC_ACCESSORY_B2_THROWN = 0b00000000,
    // Basic accy closed / normal / green / on command (in byte 2)
    DCC_BASIC_ACCESSORY_B2_CLOSED = 0b00000001,
    // Mask for thrown / closed
    DCC_BASIC_ACCESSORY_B2_DIR_MASK = DCC_BASIC_ACCESSORY_B2_CLOSED,
 
    // Extended packet: 128-step speed.
    DCC_EXT_SPEED = 0b00111111,
    DCC_EXT_SPEED_FORWARD = 0x80,
 
    ADDRESS_LOGON = 254,
    ADDRESS_EXT = 253,
 
    // Logon commands
    DCC_LOGON_ENABLE = 0b11111100,
    DCC_LOGON_ENABLE_MASK = 0b11111100,
    DCC_SELECT = 0b11010000,
    DCC_SELECT_MASK = 0b11110000,
    DCC_GET_DATA_START = 0,
    DCC_GET_DATA_CONT = 1,
    DCC_LOGON_ASSIGN = 0b11100000,
    DCC_LOGON_ASSIGN_MASK = 0b11110000,
 
    DCC_DID_MIN = DCC_SELECT,
    DCC_DID_MAX = DCC_LOGON_ASSIGN + 0xF,
    DCC_DID_MASK = 0xF0,
 
    // Commands in 254 Select and 253 addressed.
    CMD_READ_SHORT_INFO = 0b11111111,
    CMD_READ_BLOCK = 0b11111110,
    CMD_READ_BACKGROUND = 0b11111101,
    CMD_WRITE_BLOCK = 0b11111100,
 
    // Address partitions as defined by S-9.2.1.1. These are 6-bit values for
    // the first byte of the reported and assigned address.
 
    ADR_MASK = 0b111111,
 
    ADR_MOBILE_SHORT = 0b00111000,
    ADR_MOBILE_SHORT_MASK = 0xFF,
    ADR_MOBILE_LONG = 0,
    MAX_MOBILE_LONG = 0b00100111,
    ADR_ACC_EXT = 0b00101000,
    MASK_ACC_EXT = 0b00111000,
    ADR_ACC_BASIC = 0b00110000,
    MASK_ACC_BASIC = 0b00111000,
 
    ADR_INVALID = (ADR_MOBILE_SHORT << 8),
};
 
bool decode_address_partition(uint16_t addr14, uint16_t* addr, uint8_t* partition, dcc::TrainAddressType* atype);
 
static inline unsigned accy_address_user_to_binary(unsigned user)
{
    if (user >= 2045)
    {
        return user - 2045;
    }
    else
    {
        return user + 3;
    }
}
 
static inline unsigned accy_address_binary_to_user(unsigned binary)
{
    if (binary < 4)
    {
        return binary + 2045;
    }
    else
    {
        return binary - 3;
    }
}
 
enum class LogonEnableParam
{
    NOW = 0b11,
    LOCO = 0b01,
    ACC = 0b10,
    ALL = 0b00,
};
 
} // namespace dcc::Defs
 
} // namespace dcc
 
#endif