common/inc/vlcb/common/module.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
 
typedef uint32_t VlcbModuleParamLoadAddr;
#define VLCB_MODULE_LOAD_ADDR_EMPTY (VlcbModuleParamLoadAddr)0
 
typedef char VlcbModuleParamCpuManuId[4];
#define VLCB_MODULE_CPU_MANUID_UNKNOWN                                         \
  (VlcbModuleParamCpuManuId){'?', '?', '?', '?'}
 
#define VLCB_VERSION(major, minor)                                             \
  (VlcbModuleVersion){.major = major, .minor = minor.beta = 0}
#define VLCB_VERSION_BETA(major, minor, beta)                                  \
  (VlcbModuleVersion) { .major = major, .minor = minor.beta = beta }
 
typedef struct {
  uint8_t major;
  char minor;
  uint8_t beta;
} VlcbModuleVersion;
 
typedef uint8_t VlcbServiceVersion;
 
typedef uint8_t VlcbCommandError;
enum VlcbCommandError {
  VLCB_CMDERR_INVALID_COMMAND = 1,
 
  VLCB_CMDERR_NOT_IN_LEARN_MODE = 2,
 
  VLCB_CMDERR_NOT_IN_SETUP_MODE = 3,
 
  VLCB_CMDERR_TOO_MANY_EVENTS = 4,
 
  VLCB_CMDERR_NO_EV = 5,
 
  VLCB_CMDERR_INVALID_EV_INDEX = 6,
 
  VLCB_CMDERR_INVALID_EVENT = 7,
 
  VLCB_CMDERR_INVALID_EVENT_INDEX = 8,
 
  VLCB_CMDERR_INVALID_PARAM_INDEX = 9,
 
  VLCB_CMDERR_INVALID_NV_INDEX = 10,
 
  VLCB_CMDERR_INVALID_EV_VALUE = 11,
 
  VLCB_CMDERR_INVALID_NV_VALUE = 12,
 
  VLCB_CMDERR_ANOTHER_MODULE_IS_IN_LEARN_MODE = 13,
};
 
typedef uint8_t VlcbModuleFlags;
enum VlcbModuleFlags {
  VLCB_MODULE_FLAG_EVENT_CONSUMER = 0x1,
 
  VLCB_MODULE_FLAG_EVENT_PRODUCER = 0x2,
 
  VLCB_MODULE_FLAG_EVENT_COMBI = 0x3,
 
  VLCB_MODULE_FLAG_NORMAL_MODE = 0x4,
 
  VLCB_MODULE_FLAG_BOOTLOADER = 0x8,
 
  VLCB_MODULE_FLAG_CONSUME_OWN_EVENTS = 0x10,
 
  VLCB_MODULE_FLAG_LEARN_MODE = 0x20,
 
  VLCB_MODULE_FLAG_VLCB = 0x40,
 
  VLCB_MODULE_FLAG_SERVICE_DISCOVERY = 0x40,
 
};
typedef uint8_t VlcbModuleParam;
enum VlcbModuleParam {
 
  VLCB_MODULE_PARAM_MODULE_PARAMETER_COUNT = 0,
 
  VLCB_MODULE_PARAM_MODULE_MANUFACTURER = 1,
 
  VLCB_MODULE_PARAM_MINOR_VERSION = 2,
 
  VLCB_MODULE_PARAM_MODULE_TYPE = 3,
 
  VLCB_MODULE_PARAM_MAX_EVENT_COUNT = 4,
 
  VLCB_MODULE_PARAM_EVENT_VARIABLE_COUNT = 5,
 
  VLCB_MODULE_PARAM_NODE_VARIABLE_COUNT = 6,
 
  VLCB_MODULE_PARAM_MAJOR_VERSION = 7,
 
  VLCB_MODULE_PARAM_FLAGS = 8,
 
  VLCB_MODULE_PARAM_CPU_ID = 9,
 
  VLCB_MODULE_PARAM_BUS_TYPE = 10,
 
  VLCB_MODULE_PARAM_LOAD_ADDRESS = 11,
 
  VLCB_MODULE_PARAM_CPU_MANUFACTURER_ID = 15,
 
  VLCB_MODULE_PARAM_CPU_MANUFACTURER = 19,
 
  VLCB_MODULE_PARAM_BETA_VERSION = 20,
 
};