ZAF_types.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef ZAF_APPLICATIONUTILITIES_ZAF_TYPES_H_
#define ZAF_APPLICATIONUTILITIES_ZAF_TYPES_H_
 
#include <ZW_security_api.h>
#include <ZW_classcmd.h>
#include <ZW_transport_api.h>

 
typedef struct _MULTICHAN_SOURCE_NODE_ID_{
  node_id_t nodeId;          
  uint8_t   endpoint   : 7;
  uint8_t   res        : 1;
} MULTICHAN_SOURCE_NODE_ID;
 
typedef struct _MULTICHAN_DEST_NODE_ID_{
  node_id_t nodeId;          
  uint8_t   endpoint   : 7;
  uint8_t   BitAddress : 1;
} MULTICHAN_DEST_NODE_ID;

typedef struct {
  uint8_t   nodeId;         
  uint8_t   endpoint   : 7;
  uint8_t   BitAddress : 1;
} MULTICHAN_DEST_NODE_ID_8bit;

typedef struct _RECEIVE_OPTIONS_TYPE_EX_{
  uint8_t rxStatus;                       
  security_key_t securityKey;
  MULTICHAN_SOURCE_NODE_ID sourceNode;
  MULTICHAN_DEST_NODE_ID destNode;
  uint8_t bSupervisionActive       : 1;   
  uint8_t sessionId                : 6;   
  uint8_t statusUpdate             : 1;   
} RECEIVE_OPTIONS_TYPE_EX;

typedef struct {
  uint8_t multichanCmdEncap[4]; //4 = sizeof(ZW_MULTI_CHANNEL_CMD_ENCAP_V2_FRAME) - sizeof(ALL_EXCEPT_ENCAP)
  ZW_SUPERVISION_GET_FRAME supervisionGet;
  ZW_APPLICATION_TX_BUFFER appTxBuf;
} ZAF_TRANSPORT_TX_BUFFER;

typedef enum {
  E_CMD_HANDLER_RETURN_CODE_FAIL,           
  E_CMD_HANDLER_RETURN_CODE_HANDLED,        
  E_CMD_HANDLER_RETURN_CODE_WORKING,        
  E_CMD_HANDLER_RETURN_CODE_NOT_SUPPORTED,  
  E_CMD_HANDLER_RETURN_CODE_NO_CHANGE,      
} e_cmd_handler_return_code_t;

typedef enum {
  RECEIVED_FRAME_STATUS_NO_SUPPORT = 0x00, 
  RECEIVED_FRAME_STATUS_WORKING = 0x01,    
  RECEIVED_FRAME_STATUS_FAIL = 0x02,       
  RECEIVED_FRAME_STATUS_CANCEL = 0x03,     
  RECEIVED_FRAME_STATUS_CC_NOT_FOUND = 0x04,  
  RECEIVED_FRAME_STATUS_SUCCESS = 0xFF     
} received_frame_status_t;

typedef struct {
  uint8_t cmdClass; 
  uint8_t cmd;      
} ccc_pair_t;

typedef ccc_pair_t cc_group_t;
typedef cc_group_t CMD_CLASS_GRP;

typedef struct {
  uint8_t profile_MS; 
  uint8_t profile_LS; 
} agi_profile_t;

typedef agi_profile_t AGI_PROFILE;

typedef enum {
  JOB_STATUS_SUCCESS = 0,     
  JOB_STATUS_BUSY,            
  JOB_STATUS_NO_DESTINATIONS  
} zaf_job_status_t;

typedef zaf_job_status_t job_status_t;
typedef job_status_t JOB_STATUS;

typedef enum {
  TRANSMISSION_RESULT_NOT_FINISHED, 
  TRANSMISSION_RESULT_FINISHED,     
  TRANSMISSION_RESULT_UNKNOWN       
} TRANSMISSION_RESULT_FINISH_STATUS;

typedef struct {
  node_id_t nodeId;  
  uint8_t   status;  
  TRANSMISSION_RESULT_FINISH_STATUS isFinished;
} transmission_result_t;

typedef transmission_result_t TRANSMISSION_RESULT;

typedef void (*cc_handler_t)(void); // Generic handler

typedef received_frame_status_t(*cc_handler_v1_t)(RECEIVE_OPTIONS_TYPE_EX *, ZW_APPLICATION_TX_BUFFER *, uint8_t);

typedef received_frame_status_t(*cc_handler_v2_t)(
  RECEIVE_OPTIONS_TYPE_EX *,
  ZW_APPLICATION_TX_BUFFER *,
  uint8_t,
  ZW_APPLICATION_TX_BUFFER *,
  uint8_t *);

typedef struct _cc_handler_input_t {
  RECEIVE_OPTIONS_TYPE_EX * rx_options;
  ZW_APPLICATION_TX_BUFFER * frame;
  uint8_t length;
} cc_handler_input_t;

typedef struct _cc_handler_output_t {
  ZW_APPLICATION_TX_BUFFER * frame;
  uint8_t length;
  uint8_t duration;
} cc_handler_output_t;

typedef received_frame_status_t(*cc_handler_v3_t)(
  cc_handler_input_t *,
  cc_handler_output_t *);

typedef void(* basic_set_mapper_t)(ZW_APPLICATION_TX_BUFFER * p_frame);

typedef void(* basic_get_mapper_t)(uint8_t endpoint, uint8_t * p_current_value, uint8_t * p_target_value, uint8_t * p_duration);
 
typedef void (*cc_init_function_t)(void); // Generic init function
typedef void (*cc_reset_function_t)(void); // Generic reset function

typedef uint8_t(*lifeline_report_get_t)(cc_group_t * p_cc_pair);

typedef struct {
  uint16_t CC;
  uint16_t version;
  cc_handler_t pHandler;
}
CC_handler_map_t;

typedef struct {
  uint32_t handler_api_version;
  uint16_t CC;
  uint16_t version;
  cc_handler_t handler;
}
CC_handler_map_v2_t;

typedef struct {
  uint32_t handler_api_version;
  uint16_t CC;
  uint16_t version;
  cc_handler_t handler;
  basic_set_mapper_t basic_set_mapper;
  basic_get_mapper_t basic_get_mapper;
  lifeline_report_get_t lifeline_report_get;
  uint32_t flags;
}
CC_handler_map_v3_t;

typedef struct {
  uint8_t handler_api_version;
  uint16_t CC;
  uint8_t version;
  cc_handler_t handler;
  basic_set_mapper_t basic_set_mapper;
  basic_get_mapper_t basic_get_mapper;
  lifeline_report_get_t lifeline_report_get;
  uint32_t flags;
  cc_init_function_t init;
  cc_reset_function_t reset;
}
CC_handler_map_v4_t;

typedef CC_handler_map_v4_t CC_handler_map_latest_t;
 
typedef void(*ZAF_TX_Callback_t)(transmission_result_t * pTxResult);

typedef void(*ZW_TX_Callback_t)(uint8_t txStatus, TX_STATUS_TYPE* extendedTxStatus);

typedef void(*ZW_TX_Multi_Callback_t)(uint8_t txStatus);

typedef void(*ZW_Void_Callback_t)(void);
 
#ifdef __APPLE__
#define HANDLER_V2_SECTION "__TEXT,__cc_handlers_v3"
extern CC_handler_map_v3_t __start__cc_handlers_v3 __asm("section$start$__TEXT$__cc_handlers_v3");
extern CC_handler_map_v3_t __stop__cc_handlers_v3 __asm("section$end$__TEXT$__cc_handlers_v3");
#else
#define HANDLER_SECTION "zw_cc_handlers_v3"
extern const CC_handler_map_latest_t __start_zw_cc_handlers_v3;
#define cc_handlers_start __start_zw_cc_handlers_v3
extern const CC_handler_map_latest_t __stop_zw_cc_handlers_v3;
#define cc_handlers_stop __stop_zw_cc_handlers_v3
#endif

#define REGISTER_CC_V5(cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb)                                                                                                                            \
  static const CC_handler_map_latest_t thisHandler##cc __attribute__((aligned(4), __used__, __section__(HANDLER_SECTION))) = { 3, cc, version, (cc_handler_t)handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb }; \
  void * dummy##cc

#define REGISTER_CC_V4(cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb)                                                                                                                            \
  static const CC_handler_map_latest_t thisHandler##cc __attribute__((aligned(4), __used__, __section__(HANDLER_SECTION))) = { 2, cc, version, (cc_handler_t)handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb }; \
  void * dummy##cc

#define REGISTER_CC_V3(cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags)                                                                                                                                        \
  static const CC_handler_map_latest_t thisHandler##cc __attribute__((aligned(4), __used__, __section__(HANDLER_SECTION))) = { 2, cc, version, (cc_handler_t)handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, NULL, NULL }; \
  void * dummy##cc

#define REGISTER_CC_V2(cc, version, handler)                                                                                                                                                             \
  static const CC_handler_map_latest_t thisHandler##cc __attribute__((aligned(4), __used__, __section__(HANDLER_SECTION))) = { 2, cc, version, (cc_handler_t)handler, NULL, NULL, NULL, 0, NULL, NULL }; \
  void * dummy##cc

#define REGISTER_CC(cc, version, handler)                                                                                                                                                                \
  static const CC_handler_map_latest_t thisHandler##cc __attribute__((aligned(4), __used__, __section__(HANDLER_SECTION))) = { 1, cc, version, (cc_handler_t)handler, NULL, NULL, NULL, 0, NULL, NULL }; \
  void * dummy##cc

typedef struct {
  RECEIVE_OPTIONS_TYPE_EX rxOpt;
  uint8_t endpoint;
} zaf_cc_config_t;
 
typedef struct {
  uint16_t command_class;
  zaf_cc_config_t * p_cc_configuration;
} zaf_cc_config_entry_v1_t;

typedef zaf_cc_config_entry_v1_t zaf_cc_config_entry_latest_t;
 
#ifdef __APPLE__
#define ZAF_CC_CONFIG_SECTION "__TEXT,__zaf_cc_config"
#else
#define ZAF_CC_CONFIG_SECTION "zw_zaf_cc_config"
#endif

#define ZAF_CC_REGISTER_CONFIG(cc, config, index)                                                                                                                                \
  static const zaf_cc_config_entry_latest_t cc_config##index##cc __attribute__((aligned(4), __used__, __section__(ZAF_CC_CONFIG_SECTION))) = { cc, (zaf_cc_config_t *) config }; \
  void * cc_register_config##index##cc
 
typedef struct {
  uint8_t list_size;
  uint8_t * cc_list;
} zaf_cc_list_t;

 
#endif /* ZAF_APPLICATIONUTILITIES_ZAF_TYPES_H_ */