event_handler.h

[詳解]

 
#ifndef EVENT_HANDLER_H_
#define EVENT_HANDLER_H_
 
#include "event_logger.h"
 
#ifdef EL_IS_ENABLE_TLOG
 
#include <stddef.h>
#include "../TimeManager/obc_time.h"
#include "../../TlmCmd/block_command_table.h"
#include <src_user/Settings/System/EventHandlerRules/event_handler_rules.h>
 
#define EH_RULE_TLM_PAGE_SIZE (20)  
#define EH_RULE_TLM_PAGE_MAX  (8)   
 
#define EH_LOG_TLM_PAGE_SIZE  (64)  
#define EH_LOG_TLM_PAGE_MAX   (2)   
 
#define EH_MAX_RULE_NUM_OF_EL_ID_DUPLICATES   (4)     
#define EH_MAX_RESPONSE_NUM_DEFAULT           (8)     
#define EH_MAX_CHECK_EVENT_NUM_DEFAULT        (64)    
#define EH_MAX_MULTI_LEVEL_NUM_DEFAULT        (4)     
 
// 以下のファイルにて，次のパラメタを上書き設定できる
// EH_RULE_TLM_PAGE_SIZE
// EH_RULE_TLM_PAGE_MAX
// EH_LOG_TLM_PAGE_SIZE
// EH_LOG_TLM_PAGE_MAX
// EH_MAX_RULE_NUM_OF_EL_ID_DUPLICATES
// EH_MAX_RESPONSE_NUM_DEFAULT
// EH_MAX_CHECK_EVENT_NUM_DEFAULT
// EH_MAX_MULTI_LEVEL_NUM_DEFAULT
#include <src_user/Settings/System/event_handler_params.h>
 
#define EH_RULE_MAX   (EH_RULE_ID)(EH_RULE_TLM_PAGE_SIZE * EH_RULE_TLM_PAGE_MAX)
#define EH_LOG_MAX    (EH_LOG_TLM_PAGE_SIZE * EH_LOG_TLM_PAGE_MAX)  
 
typedef enum
{
  EH_REGISTER_ACK_OK = 0,                   
  EH_REGISTER_ACK_ERR_FULL,                 
  EH_REGISTER_ACK_ERR_RULE_OVERWRITE,       
  EH_REGISTER_ACK_ERR_DUPLICATE_FULL,       
  EH_REGISTER_ACK_ILLEGAL_RULE_ID,          
  EH_REGISTER_ACK_ILLEGAL_GROUP,            
  EH_REGISTER_ACK_ILLEGAL_ERROR_LEVEL,      
  EH_REGISTER_ACK_ILLEGAL_MATCH_FLAG,       
  EH_REGISTER_ACK_ILLEGAL_CONDITION_TYPE,   
  EH_REGISTER_ACK_ILLEGAL_COUNT_THRESHOLD,  
  EH_REGISTER_ACK_ILLEGAL_BCT_ID,           
  EH_REGISTER_ACK_ILLEGAL_ACTIVE_FLAG,      
  EH_REGISTER_ACK_ILLEGAL_MULTI_LEVEL,      
  EH_REGISTER_ACK_UNKNOWN_ERR               
} EH_REGISTER_ACK;
 
typedef enum
{
  EH_CHECK_RULE_ACK_OK = 0,           
  EH_CHECK_RULE_ACK_INVALID_RULE_ID,  
  EH_CHECK_RULE_ACK_UNREGISTERED      
} EH_CHECK_RULE_ACK;
 
typedef enum
{
  EH_RESPONSE_CONDITION_SINGLE,       
  EH_RESPONSE_CONDITION_CONTINUOUS,   
  EH_RESPONSE_CONDITION_CUMULATIVE,   
  EH_RESPONSE_CONDITION_TYPE_MAX
} EH_RESPONSE_CONDITION_TYPE;
 
typedef struct
{
  struct
  {
    EL_GROUP group;                           
    uint32_t local;                           
    EL_ERROR_LEVEL err_level;                 
  } event;                                    
  uint8_t should_match_err_level;             
  struct
  {
    EH_RESPONSE_CONDITION_TYPE type;          
    uint16_t count_threshold;                 
    uint32_t time_threshold_ms;               
  } condition;                                
  bct_id_t deploy_bct_id;                     
  uint8_t  is_active;                         
} EH_RuleSettings;
 
typedef struct
{
  EH_RuleSettings settings;                   
  uint16_t counter;                           
  ObcTime  last_event_time;                   
} EH_Rule;
 
typedef struct
{
  EH_Rule  rules[EH_RULE_MAX];      
  uint16_t registered_rule_num;     
} EH_RuleTable;
 
typedef struct
{
  EL_GROUP group;           
  uint32_t local;           
  uint8_t  duplicate_id;    
  EH_RULE_ID rule_id;       
} EH_RuleSortedIndex;
 
typedef struct
{
  EH_RULE_ID   rule_id;
  cycle_t      respond_time_in_master_cycle;
  CCP_EXEC_STS deploy_cmd_ack;        // FIXME: 将来的に，最後に BC 展開したときのエラー情報が取得できるようになったら，それにする
} EH_Log;
 
typedef struct
{
  EH_Log   logs[EH_LOG_MAX];
  uint32_t respond_counter;
  uint16_t log_wp;
} EH_LogTable;
 
typedef struct
{
  uint32_t counter_total;                  
  uint32_t counters[EL_ERROR_LEVEL_MAX];   
} EH_ElEventCounter;
 
typedef struct
{
  uint8_t  max_response_num;      
  uint16_t max_check_event_num;   
  uint8_t  max_multi_level_num;   
} EH_ExecSettings;
 
typedef struct
{
  uint8_t current_multi_level;   
} EH_ExecInfo;
 
typedef struct
{
  EH_RULE_ID      rule_id;      
  EH_RuleSettings settings;     
  EH_REGISTER_ACK register_ack; 
} EH_RegisterFromCmd;
 
typedef struct
{
  struct
  {
    uint8_t page_no;
    EH_RULE_ID target_rule_id;
  } rule;
  struct
  {
    uint8_t page_no;
  } rule_sorted_index;
  struct
  {
    uint8_t page_no;
  } log;
} EH_TlmInfo;
 
typedef struct
{
  EH_RuleTable       rule_table;                
  EH_RuleSortedIndex sorted_idxes[EH_RULE_MAX]; 
  EH_LogTable        log_table;                 
  EH_ElEventCounter  el_event_counter;          
  EH_ExecSettings    exec_settings;             
  EH_ExecInfo        exec_info;                 
  EH_RegisterFromCmd reg_from_cmd;              
  EH_TlmInfo         tlm_info;                  
} EventHandler;
 
extern const EventHandler* const event_handler;
 
 
void EH_initialize(void);
 
void EH_execute(void);
 
EH_REGISTER_ACK EH_register_rule(EH_RULE_ID id, const EH_RuleSettings* settings);
 
EH_CHECK_RULE_ACK EH_init_rule(EH_RULE_ID id);
 
EH_CHECK_RULE_ACK EH_init_rule_for_multi_level(EH_RULE_ID id);
 
void EH_init_rule_by_event_group(EL_GROUP group);
 
void EH_init_rule_by_event_group_for_multi_level(EL_GROUP group);
 
EH_CHECK_RULE_ACK EH_activate_rule(EH_RULE_ID id);
 
EH_CHECK_RULE_ACK EH_inactivate_rule(EH_RULE_ID id);
 
EH_CHECK_RULE_ACK EH_activate_rule_for_multi_level(EH_RULE_ID id);
 
EH_CHECK_RULE_ACK EH_inactivate_rule_for_multi_level(EH_RULE_ID id);
 
void EH_activate_rule_by_event_group(EL_GROUP group);
 
void EH_inactivate_rule_by_event_group(EL_GROUP group);
 
void EH_activate_rule_by_event_group_for_multi_level(EL_GROUP group);
 
void EH_inactivate_rule_by_event_group_for_multi_level(EL_GROUP group);
 
uint8_t EH_get_rule_is_active(EH_RULE_ID id);
 
EH_CHECK_RULE_ACK EH_set_rule_counter(EH_RULE_ID id, uint16_t counter);
 
EH_CHECK_RULE_ACK EH_clear_rule_counter(EH_RULE_ID id);
 
void EH_clear_rule_counter_by_event(EL_GROUP group, uint32_t local, EL_ERROR_LEVEL err_level);
 
void EH_match_event_counter_to_el(void);
 
const EH_Log* EH_get_the_nth_log_from_the_latest(uint16_t n);
 
 
CCP_CmdRet Cmd_EH_INIT(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_CLEAR_ALL_RULE(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_LOAD_DEFAULT_RULE(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_REGISTER_RULE_EVENT_PARAM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_REGISTER_RULE_CONDITION_PARAM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_REGISTER_RULE(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_DELETE_RULE(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_INIT_RULE(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_INIT_RULE_FOR_MULTI_LEVEL(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_ACTIVATE_RULE(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_INACTIVATE_RULE(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_ACTIVATE_RULE_FOR_MULTI_LEVEL(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_INACTIVATE_RULE_FOR_MULTI_LEVEL(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_RULE_COUNTER(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_CLEAR_RULE_COUNTER(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_CLEAR_RULE_COUNTER_BY_EVENT(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_CLEAR_LOG(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_MAX_RESPONSE_NUM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_MAX_CHECK_EVENT_NUM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_MAX_MULTI_LEVEL_NUM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_PAGE_OF_RULE_TABLE_FOR_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_PAGE_OF_RULE_SORTED_IDX_FOR_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_PAGE_OF_LOG_TABLE_FOR_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_SET_TARGET_ID_OF_RULE_TABLE_FOR_TLM(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_MATCH_EVENT_COUNTER_TO_EL(const CommonCmdPacket* packet);
 
// by_event_group 関数
CCP_CmdRet Cmd_EH_INIT_RULE_BY_EVENT_GROUP(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_INIT_RULE_BY_EVENT_GROUP_FOR_MULTI_LEVEL(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_ACTIVATE_RULE_BY_EVENT_GROUP(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_INACTIVATE_RULE_BY_EVENT_GROUP(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_ACTIVATE_RULE_BY_EVENT_GROUP_FOR_MULTI_LEVEL(const CommonCmdPacket* packet);
 
CCP_CmdRet Cmd_EH_INACTIVATE_RULE_BY_EVENT_GROUP_FOR_MULTI_LEVEL(const CommonCmdPacket* packet);
 
#endif  // EL_IS_ENABLE_TLOG
 
#endif