Logo
UNICENS V2.3.0-4567
User Manual and API Reference

Network Supervisor related types. More...

Data Structures

struct  Ucs_Prg_Command_t
 Represents a programming task. More...
 
struct  Ucs_Prg_Report_t
 Structure containing the programming report. More...
 

Callback Functions

typedef void(* Ucs_Prg_ReportCb_t )(Ucs_Prg_Report_t *result_ptr, void *user_ptr)
 Function signature of result callback used by Programming service.
 
typedef void(* Ucs_Fbp_ReportCb_t )(Ucs_Fbp_ResCode_t result, void *user_ptr)
 Report function for Fallback Protection.
 
typedef void(* Ucs_Supv_ReportCb_t )(Ucs_Supv_Report_t code, Ucs_Signature_t *signature_ptr, Ucs_Rm_Node_t *node_ptr, void *user_ptr)
 Optional callback function that reports events on found and configured nodes.
 
typedef void(* Ucs_Supv_ModeReportCb_t )(Ucs_Supv_Mode_t mode, Ucs_Supv_State_t state, void *user_ptr)
 Optional callback function for monitoring the current Supervisor Operation Mode and State.
 
typedef void(* Ucs_Supv_ProgramLocalNodeCb_t )(Ucs_Signature_t *signature_ptr, Ucs_Prg_Command_t **program_pptr, Ucs_Prg_ReportCb_t *result_fptr, void *user_ptr)
 Optional callback function to program the local node.
 
typedef void(* Ucs_Supv_ProgramSignatureCb_t )(Ucs_Signature_t *signature_ptr, void *user_ptr)
 Optional callback notifying the signature of a discovered remote node.
 
typedef void(* Ucs_Supv_ProgramEventCb_t )(Ucs_Supv_ProgramEvent_t code, void *user_ptr)
 Optional callback notifying processing states and errors of the Supervisor Programming Mode.
 

Enumerations

enum  Ucs_Prg_SessionType_t {
  UCS_PRG_ST_CS = 0x01U,
  UCS_PRG_ST_IS = 0x02U,
  UCS_PRG_ST_PS = 0x40U
}
 Defines the set of MemIDs and the memory access types. More...
 
enum  Ucs_Prg_MemId_t {
  UCS_PRG_MID_CS = 0x00U,
  UCS_PRG_MID_IS = 0x01U,
  UCS_PRG_MID_CSTEST = 0x0CU,
  UCS_PRG_MID_ISTEST = 0x0DU,
  UCS_PRG_MID_PS = 0x0EU,
  UCS_PRG_MID_PSTEST = 0x0FU
}
 Represents the memory resource to be written. More...
 
enum  Ucs_Prg_ResCode_t {
  UCS_PRG_RES_SUCCESS = 0x01U,
  UCS_PRG_RES_TIMEOUT = 0x02U,
  UCS_PRG_RES_NET_OFF = 0x03U,
  UCS_PRG_RES_FKT_SYNCH = 0x04U,
  UCS_PRG_RES_FKT_ASYNCH = 0x05U,
  UCS_PRG_RES_ERROR = 0x06U,
  UCS_PRG_RES_PARAM = 0x07U
}
 Result values of the Programming service. More...
 
enum  Ucs_Prg_Func_t {
  UCS_PRG_FKT_DUMMY = 0x00U,
  UCS_PRG_FKT_WELCOME = 0x01U,
  UCS_PRG_FKT_WELCOME_NOSUCCESS = 0x02U,
  UCS_PRG_FKT_MEM_OPEN = 0x03U,
  UCS_PRG_FKT_MEM_WRITE = 0x04U,
  UCS_PRG_FKT_MEM_CLOSE = 0x05U,
  UCS_PRG_FKT_MEM_CLOSE_CRC_ERR = 0x06U,
  UCS_PRG_FKT_INIT = 0x07U
}
 Denotes the function where an error occurred. More...
 
enum  Ucs_Fbp_ResCode_t {
  UCS_FBP_RES_SUCCESS = 0x00U,
  UCS_FBP_RES_NOSUCCESS = 0x01U,
  UCS_FBP_RES_END = 0xEEU,
  UCS_FBP_RES_ERROR = 0xFDU,
  UCS_FBP_RES_TIMEOUT = 0xFEU,
  UCS_FBP_RES_NORESULT = 0xFFU
}
 Result values of the Fallback Protection. More...
 
enum  Ucs_Supv_Mode_t {
  UCS_SUPV_MODE_NORMAL = 0x01U,
  UCS_SUPV_MODE_INACTIVE = 0x02U,
  UCS_SUPV_MODE_FALLBACK = 0x04U,
  UCS_SUPV_MODE_DIAGNOSIS = 0x08U,
  UCS_SUPV_MODE_PROGRAMMING = 0x10U
}
 Supervisor Operation Modes that can be set before initialization or during runtime. More...
 
enum  Ucs_Supv_State_t {
  UCS_SUPV_STATE_BUSY = 0x01U,
  UCS_SUPV_STATE_READY = 0x02U
}
 The Supervisor Operation State changes to UCS_SUPV_STATE_BUSY as soon as the supervisor is running tasks to force the desired network state for a certain Supervisor Operation Mode. The Supervisor Operation State changes to UCS_SUPV_STATE_READY if the desired network state is reached and the respective nodes management is initiated. More...
 
enum  Ucs_Supv_DiagType_t {
  UCS_SUPV_DT_HDX = 0x00U,
  UCS_SUPV_DT_FDX = 0x01U
}
 The kind of diagnosis the Network Supervisor shall execute in the Supervisor Diagnosis Mode. More...
 
enum  Ucs_Supv_Report_t {
  UCS_SUPV_REP_NOT_AVAILABLE = 0,
  UCS_SUPV_REP_IGNORED_UNKNOWN = 1,
  UCS_SUPV_REP_IGNORED_DUPLICATE = 2,
  UCS_SUPV_REP_WELCOMED = 3,
  UCS_SUPV_REP_SCRIPT_FAILURE = 4,
  UCS_SUPV_REP_IRRECOVERABLE = 5,
  UCS_SUPV_REP_SCRIPT_SUCCESS = 6,
  UCS_SUPV_REP_AVAILABLE = 7
}
 Supervisor Report Codes which are basically notified during Supervisor Normal Operation Mode. More...
 
enum  Ucs_Supv_ProgramEvent_t {
  UCS_SUPV_PROG_INFO_EXIT = 0,
  UCS_SUPV_PROG_INFO_SCAN_NEW = 1,
  UCS_SUPV_PROG_ERROR_INIT_NWS = 2,
  UCS_SUPV_PROG_ERROR_LOCAL_CFG = 3,
  UCS_SUPV_PROG_ERROR_STARTUP = 4,
  UCS_SUPV_PROG_ERROR_STARTUP_TO = 5,
  UCS_SUPV_PROG_ERROR_UNSTABLE = 6,
  UCS_SUPV_PROG_ERROR_PROGRAM = 7
}
 Supervisor Programming Events. All errors lead to the termination of the Supervisor Programming Mode. More...
 

Detailed Description

Network Supervisor related types.