2009-07-29 11:29:53 +00:00
|
|
|
/* packet-zbee-zcl.h
|
|
|
|
|
* Dissector routines for the ZigBee Cluster Library (ZCL)
|
|
|
|
|
* By Fred Fierling <fff@exegin.com>
|
|
|
|
|
* Copyright 2009 Exegin Technologies Limited
|
|
|
|
|
*
|
|
|
|
|
* Wireshark - Network traffic analyzer
|
|
|
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
|
|
|
* Copyright 1998 Gerald Combs
|
|
|
|
|
*
|
2018-02-12 11:23:27 +00:00
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
2009-07-29 11:29:53 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef PACKET_ZBEE_ZCL_H
|
|
|
|
|
#define PACKET_ZBEE_ZCL_H
|
|
|
|
|
|
|
|
|
|
/* Structure to contain the ZCL frame information */
|
|
|
|
|
typedef struct{
|
2013-03-21 19:49:49 +00:00
|
|
|
gboolean mfr_spec;
|
2009-07-29 11:29:53 +00:00
|
|
|
gboolean direction;
|
|
|
|
|
gboolean disable_default_resp;
|
2013-03-21 19:49:49 +00:00
|
|
|
|
2009-07-29 11:29:53 +00:00
|
|
|
guint8 frame_type;
|
|
|
|
|
guint16 mfr_code;
|
|
|
|
|
guint8 tran_seqno;
|
|
|
|
|
guint8 cmd_id;
|
|
|
|
|
} zbee_zcl_packet;
|
|
|
|
|
|
|
|
|
|
/* ZCL Commands */
|
|
|
|
|
#define ZBEE_ZCL_CMD_READ_ATTR 0x00
|
|
|
|
|
#define ZBEE_ZCL_CMD_READ_ATTR_RESP 0x01
|
|
|
|
|
#define ZBEE_ZCL_CMD_WRITE_ATTR 0x02
|
|
|
|
|
#define ZBEE_ZCL_CMD_WRITE_ATTR_UNDIVIDED 0x03
|
|
|
|
|
#define ZBEE_ZCL_CMD_WRITE_ATTR_RESP 0x04
|
|
|
|
|
#define ZBEE_ZCL_CMD_WRITE_ATTR_NO_RESP 0x05
|
|
|
|
|
#define ZBEE_ZCL_CMD_CONFIG_REPORT 0x06
|
|
|
|
|
#define ZBEE_ZCL_CMD_CONFIG_REPORT_RESP 0x07
|
|
|
|
|
#define ZBEE_ZCL_CMD_READ_REPORT_CONFIG 0x08
|
|
|
|
|
#define ZBEE_ZCL_CMD_READ_REPORT_CONFIG_RESP 0x09
|
|
|
|
|
#define ZBEE_ZCL_CMD_REPORT_ATTR 0x0a
|
|
|
|
|
#define ZBEE_ZCL_CMD_DEFAULT_RESP 0x0b
|
|
|
|
|
#define ZBEE_ZCL_CMD_DISCOVER_ATTR 0x0c
|
|
|
|
|
#define ZBEE_ZCL_CMD_DISCOVER_ATTR_RESP 0x0d
|
|
|
|
|
#define ZBEE_ZCL_CMD_READ_ATTR_STRUCT 0x0e
|
|
|
|
|
#define ZBEE_ZCL_CMD_WRITE_ATTR_STRUCT 0x0f
|
|
|
|
|
#define ZBEE_ZCL_CMD_WRITE_ATTR_STRUCT_RESP 0x10
|
2013-11-29 03:40:16 +00:00
|
|
|
#define ZBEE_ZCL_CMD_DISCOVER_CMDS_REC 0x11
|
|
|
|
|
#define ZBEE_ZCL_CMD_DISCOVER_CMDS_REC_RESP 0x12
|
2009-07-29 11:29:53 +00:00
|
|
|
|
|
|
|
|
/* ZCL Data Types */
|
|
|
|
|
#define ZBEE_ZCL_NO_DATA 0x00
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_8_BIT_DATA 0x08
|
|
|
|
|
#define ZBEE_ZCL_16_BIT_DATA 0x09
|
|
|
|
|
#define ZBEE_ZCL_24_BIT_DATA 0x0a
|
|
|
|
|
#define ZBEE_ZCL_32_BIT_DATA 0x0b
|
|
|
|
|
#define ZBEE_ZCL_40_BIT_DATA 0x0c
|
|
|
|
|
#define ZBEE_ZCL_48_BIT_DATA 0x0d
|
|
|
|
|
#define ZBEE_ZCL_56_BIT_DATA 0x0e
|
|
|
|
|
#define ZBEE_ZCL_64_BIT_DATA 0x0f
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_BOOLEAN 0x10
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_8_BIT_BITMAP 0x18
|
|
|
|
|
#define ZBEE_ZCL_16_BIT_BITMAP 0x19
|
|
|
|
|
#define ZBEE_ZCL_24_BIT_BITMAP 0x1a
|
|
|
|
|
#define ZBEE_ZCL_32_BIT_BITMAP 0x1b
|
|
|
|
|
#define ZBEE_ZCL_40_BIT_BITMAP 0x1c
|
|
|
|
|
#define ZBEE_ZCL_48_BIT_BITMAP 0x1d
|
|
|
|
|
#define ZBEE_ZCL_56_BIT_BITMAP 0x1e
|
|
|
|
|
#define ZBEE_ZCL_64_BIT_BITMAP 0x1f
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_8_BIT_UINT 0x20
|
|
|
|
|
#define ZBEE_ZCL_16_BIT_UINT 0x21
|
|
|
|
|
#define ZBEE_ZCL_24_BIT_UINT 0x22
|
|
|
|
|
#define ZBEE_ZCL_32_BIT_UINT 0x23
|
|
|
|
|
#define ZBEE_ZCL_40_BIT_UINT 0x24
|
|
|
|
|
#define ZBEE_ZCL_48_BIT_UINT 0x25
|
|
|
|
|
#define ZBEE_ZCL_56_BIT_UINT 0x26
|
|
|
|
|
#define ZBEE_ZCL_64_BIT_UINT 0x27
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_8_BIT_INT 0x28
|
|
|
|
|
#define ZBEE_ZCL_16_BIT_INT 0x29
|
|
|
|
|
#define ZBEE_ZCL_24_BIT_INT 0x2a
|
|
|
|
|
#define ZBEE_ZCL_32_BIT_INT 0x2b
|
|
|
|
|
#define ZBEE_ZCL_40_BIT_INT 0x2c
|
|
|
|
|
#define ZBEE_ZCL_48_BIT_INT 0x2d
|
|
|
|
|
#define ZBEE_ZCL_56_BIT_INT 0x2e
|
|
|
|
|
#define ZBEE_ZCL_64_BIT_INT 0x2f
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_8_BIT_ENUM 0x30
|
|
|
|
|
#define ZBEE_ZCL_16_BIT_ENUM 0x31
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_SEMI_FLOAT 0x38
|
|
|
|
|
#define ZBEE_ZCL_SINGLE_FLOAT 0x39
|
|
|
|
|
#define ZBEE_ZCL_DOUBLE_FLOAT 0x3a
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_OCTET_STRING 0x41
|
|
|
|
|
#define ZBEE_ZCL_CHAR_STRING 0x42
|
|
|
|
|
#define ZBEE_ZCL_LONG_OCTET_STRING 0x43
|
|
|
|
|
#define ZBEE_ZCL_LONG_CHAR_STRING 0x44
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_ARRAY 0x48
|
|
|
|
|
#define ZBEE_ZCL_STRUCT 0x4c
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_SET 0x50
|
|
|
|
|
#define ZBEE_ZCL_BAG 0x51
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_TIME 0xe0
|
|
|
|
|
#define ZBEE_ZCL_DATE 0xe1
|
|
|
|
|
#define ZBEE_ZCL_UTC 0xe2
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_CLUSTER_ID 0xe8
|
|
|
|
|
#define ZBEE_ZCL_ATTR_ID 0xe9
|
|
|
|
|
#define ZBEE_ZCL_BACNET_OID 0xea
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_IEEE_ADDR 0xf0
|
|
|
|
|
#define ZBEE_ZCL_SECURITY_KEY 0xf1
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_UNKNOWN 0xff
|
|
|
|
|
|
|
|
|
|
/* ZCL Miscellaneous */
|
|
|
|
|
#define ZBEE_ZCL_INVALID_STR_LENGTH 0xff
|
|
|
|
|
#define ZBEE_ZCL_INVALID_LONG_STR_LENGTH 0xffff
|
2014-11-07 22:11:02 +00:00
|
|
|
#define ZBEE_ZCL_NUM_INDIVIDUAL_ETT 2
|
2009-07-29 11:29:53 +00:00
|
|
|
#define ZBEE_ZCL_NUM_ATTR_ETT 64
|
2013-03-21 19:49:49 +00:00
|
|
|
#define ZBEE_ZCL_NUM_ARRAY_ELEM_ETT 16
|
|
|
|
|
#define ZBEE_ZCL_NUM_TOTAL_ETT (ZBEE_ZCL_NUM_INDIVIDUAL_ETT + ZBEE_ZCL_NUM_ATTR_ETT + ZBEE_ZCL_NUM_ARRAY_ELEM_ETT)
|
2009-07-29 11:29:53 +00:00
|
|
|
#define ZBEE_ZCL_DIR_REPORTED 0
|
|
|
|
|
#define ZBEE_ZCL_DIR_RECEIVED 1
|
2013-03-21 19:49:49 +00:00
|
|
|
/* seconds elapsed from year 1970 to 2000 */
|
2009-07-29 11:29:53 +00:00
|
|
|
#define ZBEE_ZCL_NSTIME_UTC_OFFSET (((3*365 + 366)*7 + 2*365)*24*3600)
|
2015-04-14 17:30:18 +00:00
|
|
|
#define IS_ANALOG_SUBTYPE(x) ( (x & 0xF0) == 0x20 || (x & 0xF8) == 0x38 || (x & 0xF8) == 0xE0 )
|
2009-07-29 11:29:53 +00:00
|
|
|
|
|
|
|
|
/* ZCL Status Enumerations */
|
|
|
|
|
#define ZBEE_ZCL_STAT_SUCCESS 0x00
|
|
|
|
|
#define ZBEE_ZCL_STAT_FAILURE 0x01
|
|
|
|
|
|
|
|
|
|
#define ZBEE_ZCL_STAT_NOT_AUTHORIZED 0x7e
|
|
|
|
|
#define ZBEE_ZCL_STAT_RESERVED_FIELD_NOT_ZERO 0x7f
|
|
|
|
|
#define ZBEE_ZCL_STAT_MALFORMED_CMD 0x80
|
|
|
|
|
#define ZBEE_ZCL_STAT_UNSUP_CLUSTER_CMD 0x81
|
|
|
|
|
#define ZBEE_ZCL_STAT_UNSUP_GENERAL_CMD 0x82
|
|
|
|
|
#define ZBEE_ZCL_STAT_UNSUP_MFR_CLUSTER_CMD 0x83
|
|
|
|
|
#define ZBEE_ZCL_STAT_UNSUP_MFR_GENERAL_CMD 0x84
|
|
|
|
|
#define ZBEE_ZCL_STAT_INVALID_FIELD 0x85
|
|
|
|
|
#define ZBEE_ZCL_STAT_UNSUPPORTED_ATTR 0x86
|
2011-12-09 17:00:28 +00:00
|
|
|
#define ZBEE_ZCL_STAT_INVALID_VALUE 0x87
|
|
|
|
|
#define ZBEE_ZCL_STAT_READ_ONLY 0x88
|
|
|
|
|
#define ZBEE_ZCL_STAT_INSUFFICIENT_SPACE 0x89
|
|
|
|
|
#define ZBEE_ZCL_STAT_DUPLICATE_EXISTS 0x8a
|
|
|
|
|
#define ZBEE_ZCL_STAT_NOT_FOUND 0x8b
|
|
|
|
|
#define ZBEE_ZCL_STAT_UNREPORTABLE_ATTR 0x8c
|
|
|
|
|
#define ZBEE_ZCL_STAT_INVALID_DATA_TYPE 0x8d
|
|
|
|
|
#define ZBEE_ZCL_STAT_INVALID_SELECTOR 0x8e
|
|
|
|
|
#define ZBEE_ZCL_STAT_WRITE_ONLY 0x8f
|
|
|
|
|
#define ZBEE_ZCL_STAT_INCONSISTENT_STARTUP_STATE 0x90
|
|
|
|
|
#define ZBEE_ZCL_STAT_DEFINED_OUT_OF_BAND 0x91
|
2015-12-02 07:18:20 +00:00
|
|
|
#define ZBEE_ZCL_STAT_INCONSISTENT 0x92
|
|
|
|
|
#define ZBEE_ZCL_STAT_ACTION_DENIED 0x93
|
|
|
|
|
#define ZBEE_ZCL_STAT_TIMEOUT 0x94
|
2014-01-12 03:17:51 +00:00
|
|
|
#define ZBEE_ZCL_STAT_OTA_ABORT 0x95
|
|
|
|
|
#define ZBEE_ZCL_STAT_OTA_INVALID_IMAGE 0x96
|
|
|
|
|
#define ZBEE_ZCL_STAT_OTA_WAIT_FOR_DATA 0x97
|
|
|
|
|
#define ZBEE_ZCL_STAT_OTA_NO_IMAGE_AVAILABLE 0x98
|
|
|
|
|
#define ZBEE_ZCL_STAT_OTA_REQUIRE_MORE_IMAGE 0x99
|
2017-08-29 23:08:00 +00:00
|
|
|
#define ZBEE_ZCL_STAT_OTA_NOTIFICATION_PENDING 0x9a
|
2011-12-09 17:00:28 +00:00
|
|
|
#define ZBEE_ZCL_STAT_HARDWARE_FAILURE 0xc0
|
|
|
|
|
#define ZBEE_ZCL_STAT_SOFTWARE_FAILURE 0xc1
|
|
|
|
|
#define ZBEE_ZCL_STAT_CALIBRATION_ERROR 0xc2
|
2017-07-17 23:54:06 +00:00
|
|
|
#define ZBEE_ZCL_STAT_UNSUPPORTED_CLUSTER 0xc3
|
|
|
|
|
#define ZBEE_ZCL_STAT_LIMIT_REACHED 0xc4
|
2009-07-29 11:29:53 +00:00
|
|
|
|
|
|
|
|
/* Misc. */
|
|
|
|
|
#define INT24_SIGN_BITS 0xffff8000
|
|
|
|
|
#define MONTHS_PER_YEAR 12
|
|
|
|
|
#define YEAR_OFFSET 1900
|
|
|
|
|
|
2018-03-12 09:57:31 +00:00
|
|
|
/* ZigBee ZCL Cluster Key */
|
|
|
|
|
#define ZCL_CLUSTER_MFR_KEY(cluster_id,mfr_code) (((mfr_code)<<16) | (cluster_id))
|
|
|
|
|
|
2018-03-31 19:23:47 +00:00
|
|
|
typedef void (*zbee_zcl_fn_attr_data)(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type, gboolean client_attr);
|
2013-05-25 01:45:16 +00:00
|
|
|
|
|
|
|
|
typedef struct _zbee_zcl_cluster_desc {
|
|
|
|
|
int proto_id;
|
|
|
|
|
protocol_t *proto;
|
|
|
|
|
const char *name;
|
|
|
|
|
int ett;
|
2018-03-31 19:23:47 +00:00
|
|
|
int hf_attr_server_id;
|
|
|
|
|
int hf_attr_client_id;
|
2014-11-07 22:11:02 +00:00
|
|
|
int hf_cmd_rx_id;
|
|
|
|
|
int hf_cmd_tx_id;
|
2013-05-25 01:45:16 +00:00
|
|
|
guint16 cluster_id;
|
2018-03-12 09:57:31 +00:00
|
|
|
guint16 mfr_code;
|
2013-05-25 01:45:16 +00:00
|
|
|
zbee_zcl_fn_attr_data fn_attr_data;
|
|
|
|
|
} zbee_zcl_cluster_desc;
|
|
|
|
|
|
2013-06-20 21:52:22 +00:00
|
|
|
extern const value_string zbee_zcl_short_data_type_names[];
|
2014-01-12 03:17:51 +00:00
|
|
|
extern const value_string zbee_mfr_code_names[];
|
|
|
|
|
extern const value_string zbee_zcl_status_names[];
|
2013-06-20 21:52:22 +00:00
|
|
|
|
|
|
|
|
/* Dissector functions */
|
2018-03-31 19:23:47 +00:00
|
|
|
extern void dissect_zcl_read_attr (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset, guint16 cluster_id, guint16 mfr_code, gboolean direction);
|
|
|
|
|
extern void dissect_zcl_write_attr (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset, guint16 cluster_id, guint16 mfr_code, gboolean direction);
|
|
|
|
|
extern void dissect_zcl_report_attr(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint *offset, guint16 cluster_id, guint16 mfr_code, gboolean direction);
|
|
|
|
|
extern void dissect_zcl_read_attr_resp (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset, guint16 cluster_id, guint16 mfr_code, gboolean direction);
|
2018-05-30 14:29:05 +00:00
|
|
|
extern void dissect_zcl_attr_id(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint16 cluster_id, guint16 mfr_code, gboolean client_attr);
|
|
|
|
|
extern void dissect_zcl_attr_data_type_val(tvbuff_t *tvb, proto_tree *tree, guint *offset, guint16 attr_id, guint16 cluster_id, guint16 mfr_code, gboolean client_attr);
|
|
|
|
|
extern guint dissect_zcl_attr_uint8 (tvbuff_t *tvb, proto_tree *tree, guint *offset, int *length);
|
2013-05-25 01:45:16 +00:00
|
|
|
|
2013-06-20 20:24:51 +00:00
|
|
|
/* Helper functions */
|
2018-03-12 09:57:31 +00:00
|
|
|
zbee_zcl_cluster_desc *zbee_zcl_get_cluster_desc(guint16 cluster_id, guint16 mfr_code);
|
2013-05-25 01:45:16 +00:00
|
|
|
|
2018-03-12 10:59:32 +00:00
|
|
|
/* Exported DLL functions */
|
|
|
|
|
WS_DLL_PUBLIC void decode_zcl_time_in_100ms (gchar *s, guint16 value);
|
|
|
|
|
WS_DLL_PUBLIC void decode_zcl_time_in_seconds (gchar *s, guint16 value);
|
|
|
|
|
WS_DLL_PUBLIC void decode_zcl_time_in_minutes (gchar *s, guint16 value);
|
2018-03-31 19:23:47 +00:00
|
|
|
WS_DLL_PUBLIC void dissect_zcl_attr_data (tvbuff_t *tvb, proto_tree *tree, guint *offset, guint data_type, gboolean client_attr);
|
2018-03-12 10:59:32 +00:00
|
|
|
|
2018-03-31 19:23:47 +00:00
|
|
|
WS_DLL_PUBLIC void zbee_zcl_init_cluster(const char *proto_abbrev, int proto, gint ett, guint16 cluster_id, guint16 mfr_code, int hf_attr_server_id, int hf_attr_client_id, int hf_cmd_rx_id, int hf_cmd_tx_id, zbee_zcl_fn_attr_data fn_attr_data);
|
2018-03-12 10:59:32 +00:00
|
|
|
|
2013-11-29 03:40:16 +00:00
|
|
|
/* Cluster-specific commands and parameters */
|
|
|
|
|
#define ZBEE_ZCL_CSC_IAS_ZONE_C_ERC_NEP 0x02
|
|
|
|
|
#define ZBEE_ZCL_CSC_IAS_ZONE_C_ERC_NS 0x01
|
|
|
|
|
#define ZBEE_ZCL_CSC_IAS_ZONE_C_ERC_S 0x00
|
|
|
|
|
#define ZBEE_ZCL_CSC_IAS_ZONE_C_ERC_TMZ 0x03
|
|
|
|
|
#define ZBEE_ZCL_CSC_IAS_ZONE_C_ZER 0x00
|
|
|
|
|
#define ZBEE_ZCL_CSC_IAS_ZONE_S_ZER 0x01
|
|
|
|
|
#define ZBEE_ZCL_CSC_IAS_ZONE_S_ZSCN 0x00
|
|
|
|
|
#define ZBEE_ZCL_CSC_POLL_CONTROL_C_CIR 0x00
|
|
|
|
|
#define ZBEE_ZCL_CSC_POLL_CONTROL_C_FPS 0x01
|
|
|
|
|
#define ZBEE_ZCL_CSC_POLL_CONTROL_C_SLPI 0x02
|
|
|
|
|
#define ZBEE_ZCL_CSC_POLL_CONTROL_C_SSPI 0x03
|
|
|
|
|
#define ZBEE_ZCL_CSC_POLL_CONTROL_S_CI 0x00
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_CWS 0x03
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_GWS 0x02
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SRL 0x00
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS 0x01
|
2013-11-29 13:42:09 +00:00
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_AV 0x80
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_FR 0x20
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_MO 0x02
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_SA 0x40
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_SU 0x01
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_TH 0x10
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_TU 0x04
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_DOW_WE 0x08
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_SP_B 0x03
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_SP_C 0x02
|
|
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_C_SWS_SP_H 0x01
|
2013-11-29 03:40:16 +00:00
|
|
|
#define ZBEE_ZCL_CSC_THERMOSTAT_S_GWSR 0x00
|
|
|
|
|
|
2009-07-29 11:29:53 +00:00
|
|
|
#endif /* PACKET_ZBEE_ZCL_H*/
|
