X-Git-Url: http://git.samba.org/?a=blobdiff_plain;f=epan%2Fdissectors%2Fpacket-zbee-zcl-se.c;h=9166bb2750d335a88782838f80341c29a8ec3631;hb=f36d9e922edf1bb0812ed4ffca9e3c11b5870ed3;hp=9c8394339fd8785a230a86611c7f47fd331d3ec0;hpb=3bd69dac73b0c63e35cd2022344e6a357d90da43;p=metze%2Fwireshark%2Fwip.git diff --git a/epan/dissectors/packet-zbee-zcl-se.c b/epan/dissectors/packet-zbee-zcl-se.c index 9c8394339f..9166bb2750 100644 --- a/epan/dissectors/packet-zbee-zcl-se.c +++ b/epan/dissectors/packet-zbee-zcl-se.c @@ -41,7 +41,6 @@ /* #### common to all SE clusters ########################################### */ /* ########################################################################## */ -#define ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS 0xFFFE #define ZBEE_ZCL_SE_ATTR_REPORT_PENDING 0x00 #define ZBEE_ZCL_SE_ATTR_REPORT_COMPLETE 0x01 @@ -51,146 +50,119 @@ static const value_string zbee_zcl_se_reporting_status_names[] = { { 0, NULL } }; -#define ZBEE_ZCL_SE_ATTR_NAMES \ - { ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS, "Attribute Reporting Status" } - /*************************/ /* Global Variables */ /*************************/ /* ########################################################################## */ -/* #### (0x0703) MESSAGING CLUSTER ########################################## */ +/* #### (0x0700) PRICE CLUSTER ############################################## */ /* ########################################################################## */ -/* Attributes - None (other than Attribute Reporting Status) */ -static const value_string zbee_zcl_msg_attr_names[] = { - ZBEE_ZCL_SE_ATTR_NAMES, - { 0, NULL } -}; +/* Attributes */ +#define zbee_zcl_price_attr_names_VALUE_STRING_LIST(XXX) \ +/* Block Threshold (Delivered) Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_BLOCK_1_THRESHOLD, 0x0100, "Block 1 Threshold" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_BLOCK_2_THRESHOLD, 0x0101, "Block 2 Threshold" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_BLOCK_3_THRESHOLD, 0x0102, "Block 3 Threshold" ) \ +/* Block Period (Delivered) Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_THRESHOLD_MULTIPLIER, 0x0202, "Threshold Multiplier" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_THRESHOLD_DIVISOR, 0x0203, "Threshold Divisor" ) \ +/* Commodity */ \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_COMMODITY_TYPE, 0x0300, "Commodity Type" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_STANDING_CHARGE, 0x0301, "Standing Charge" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_CONVERSION_FACTOR, 0x0302, "Conversion Factor" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_CONVERSION_FACTOR_TRAILING_DIGIT,0x0303, "Conversion Factor TrailingDigit" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_CALORIFIC_VALUE, 0x0304, "Calorific Value" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_CALORIFIC_VALUE_UNIT, 0x0305, "Calorific Value Unit" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_CALORIFIC_VALUE_TRAILING_DIGIT, 0x0306, "Calorific Value Trailing Digit" ) \ +/* Block Price Information (Delivered) */ \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_NO_TIER_BLOCK_1_PRICE, 0x0400, "No Tier Block 1 Price" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_NO_TIER_BLOCK_2_PRICE, 0x0401, "No Tier Block 2 Price" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_NO_TIER_BLOCK_3_PRICE, 0x0402, "No Tier Block 3 Price" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_NO_TIER_BLOCK_4_PRICE, 0x0403, "No Tier Block 4 Price" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_TIER_1_BLOCK_1_PRICE, 0x0410, "Tier 1 Block 1 Price" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_TIER_2_BLOCK_1_PRICE, 0x0420, "Tier 2 Block 1 Price" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_TIER_3_BLOCK_1_PRICE, 0x0430, "Tier 3 Block 1 Price" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_TIER_4_BLOCK_1_PRICE, 0x0440, "Tier 4 Block 1 Price" ) \ +/* Tariff Information Set (Delivered) */ \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_UNIT_OF_MEASURE, 0x0615, "Unit of Measure" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_CURRENCY, 0x0616, "Currency" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PRICE_PRICE_TRAILING_DIGIT, 0x0617, "Price Trailing Digit" ) \ +/* Smart Energy */ \ + XXX(ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_PRICE, 0xFFFE, "Attribute Reporting Status" ) + +VALUE_STRING_ENUM(zbee_zcl_price_attr_names); +VALUE_STRING_ARRAY(zbee_zcl_price_attr_names); /* Server Commands Received */ -#define ZBEE_ZCL_CMD_ID_MSG_GET_LAST_MSG 0x00 /* Get Last Message */ -#define ZBEE_ZCL_CMD_ID_MSG_MSG_CONFIRM 0x01 /* Message Confirmation */ -#define ZBEE_ZCL_CMD_ID_MSG_GET_MESSAGE_CANCEL 0x02 /* Get Message Cancellation */ +#define zbee_zcl_price_srv_rx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_CURRENT_PRICE, 0x00, "Get Current Price" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_SCHEDULED_PRICES, 0x01, "Get Scheduled Prices" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_PRICE_ACKNOWLEDGEMENT, 0x02, "Price Acknowledgement" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_BLOCK_PERIOD, 0x03, "Get Block Period(s)" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_CONVERSION_FACTOR, 0x04, "Get Conversion Factor" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_CALORIFIC_VALUE, 0x05, "Get Calorific Value" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_TARIFF_INFORMATION, 0x06, "Get Tariff Information" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_PRICE_MATRIX, 0x07, "Get Price Matrix" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_BLOCK_THRESHOLDS, 0x08, "Get Block Thresholds" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_CO2_VALUE, 0x09, "Get CO2 Value" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_TIER_LABELS, 0x0A, "Get Tier Labels" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_BILLING_PERIOD, 0x0B, "Get Billing Period" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_CONSOLIDATED_BILL, 0x0C, "Get Consolidated Bill" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_CPP_EVENT_RESPONSE, 0x0D, "CPP Event Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_CREDIT_PAYMENT, 0x0E, "Get Credit Payment" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_CURRENCY_CONVERSION, 0x0F, "Get Currency Conversion" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_GET_TARIFF_CANCELLATION, 0x10, "Get Tariff Cancellation" ) + +VALUE_STRING_ENUM(zbee_zcl_price_srv_rx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_price_srv_rx_cmd_names); /* Server Commands Generated */ -#define ZBEE_ZCL_CMD_ID_MSG_DISPLAY_MSG 0x00 /* Display Message */ -#define ZBEE_ZCL_CMD_ID_MSG_CANCEL_MSG 0x01 /* Cancel Message */ -#define ZBEE_ZCL_CMD_ID_MSG_DISPLAY_PROTECTED_MSG 0x02 /* Display Protected Message */ -#define ZBEE_ZCL_CMD_ID_MSG_CANCEL_ALL_MSG 0x03 /* Cancel All Messages */ - -/* Message Control Field Bit Map */ -#define ZBEE_ZCL_MSG_CTRL_TX_MASK 0x03 -#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MASK 0x0C -#define ZBEE_ZCL_MSG_CTRL_RESERVED_MASK 0x50 -#define ZBEE_ZCL_MSG_CTRL_ENHANCED_CONFIRM_MASK 0x20 -#define ZBEE_ZCL_MSG_CTRL_CONFIRM_MASK 0x80 - -#define ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ONLY 0x00 /* Normal Transmission Only */ -#define ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ANON_INTERPAN 0x01 /* Normal and Anonymous Inter-PAN Transmission Only */ -#define ZBEE_ZCL_MSG_CTRL_TX_ANON_INTERPAN_ONLY 0x02 /* Anonymous Inter-PAN Transmission Only */ - -#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_LOW 0x00 /* Low */ -#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MEDIUM 0x01 /* Medium */ -#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_HIGH 0x02 /* High */ -#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_CRITICAL 0x03 /* Critical */ - -#define ZBEE_ZCL_MSG_EXT_CTRL_STATUS_MASK 0x01 - -#define ZBEE_ZCL_MSG_CONFIRM_CTRL_MASK 0x01 - -#define ZBEE_ZCL_MSG_START_TIME_NOW 0x00000000 /* Now */ +#define zbee_zcl_price_srv_tx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_PRICE, 0x00, "Publish Price" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_BLOCK_PERIOD, 0x01, "Publish Block Period" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CONVERSION_FACTOR, 0x02, "Publish Conversion Factor" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CALORIFIC_VALUE, 0x03, "Publish Calorific Value" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_TARIFF_INFORMATION, 0x04, "Publish Tariff Information" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_PRICE_MATRIX, 0x05, "Publish Price Matrix" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_BLOCK_THRESHOLDS, 0x06, "Publish Block Thresholds" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CO2_VALUE, 0x07, "Publish CO2 Value" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_TIER_LABELS, 0x08, "Publish Tier Labels" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_BILLING_PERIOD, 0x09, "PublishBillingPeriod" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CONSOLIDATED_BILL, 0x0A, "Publish Consolidated Bill" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CPP_EVENT, 0x0B, "Publish CPP Event" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CREDIT_PAYMENT, 0x0C, "Publish Credit Payment" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CURRENCY_CONVERSION, 0x0D, "Publish Currency Conversion" ) \ + XXX(ZBEE_ZCL_CMD_ID_PRICE_CANCEL_TARIFF, 0x0E, "Cancel Tariff" ) + +VALUE_STRING_ENUM(zbee_zcl_price_srv_tx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_price_srv_tx_cmd_names); /*************************/ /* Function Declarations */ /*************************/ -void proto_register_zbee_zcl_msg(void); -void proto_reg_handoff_zbee_zcl_msg(void); +void proto_register_zbee_zcl_price(void); +void proto_reg_handoff_zbee_zcl_price(void); /* Attribute Dissector Helpers */ -static void dissect_zcl_msg_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); - -/* Command Dissector Helpers */ -static void dissect_zcl_msg_display (tvbuff_t *tvb, proto_tree *tree, guint *offset); -static void dissect_zcl_msg_cancel (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset); -static void dissect_zcl_msg_confirm (tvbuff_t *tvb, proto_tree *tree, guint *offset); -static void dissect_zcl_msg_cancel_all (tvbuff_t *tvb, proto_tree *tree, guint *offset); -static void dissect_zcl_msg_get_cancel (tvbuff_t *tvb, proto_tree *tree, guint *offset); - -/* Private functions prototype */ -static void decode_zcl_msg_duration (gchar *s, guint16 value); +static void dissect_zcl_price_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); /*************************/ /* Global Variables */ /*************************/ +static dissector_handle_t price_handle; + /* Initialize the protocol and registered fields */ -static int proto_zbee_zcl_msg = -1; +static int proto_zbee_zcl_price = -1; -static int hf_zbee_zcl_msg_srv_tx_cmd_id = -1; -static int hf_zbee_zcl_msg_srv_rx_cmd_id = -1; -static int hf_zbee_zcl_msg_attr_id = -1; -static int hf_zbee_zcl_msg_attr_reporting_status = -1; -static int hf_zbee_zcl_msg_message_id = -1; -static int hf_zbee_zcl_msg_ctrl = -1; -static int hf_zbee_zcl_msg_ctrl_tx = -1; -static int hf_zbee_zcl_msg_ctrl_importance = -1; -static int hf_zbee_zcl_msg_ctrl_enh_confirm = -1; -static int hf_zbee_zcl_msg_ctrl_reserved = -1; -static int hf_zbee_zcl_msg_ctrl_confirm = -1; -static int hf_zbee_zcl_msg_ext_ctrl = -1; -static int hf_zbee_zcl_msg_ext_ctrl_status = -1; -static int hf_zbee_zcl_msg_start_time = -1; -static int hf_zbee_zcl_msg_duration = -1; -static int hf_zbee_zcl_msg_message_length = - 1; -static int hf_zbee_zcl_msg_message = -1; -static int hf_zbee_zcl_msg_confirm_time = -1; -static int hf_zbee_zcl_msg_confirm_ctrl = -1; -static int hf_zbee_zcl_msg_confirm_response = -1; -static int hf_zbee_zcl_msg_confirm_response_length = - 1; -static int hf_zbee_zcl_msg_implementation_time = -1; -static int hf_zbee_zcl_msg_earliest_time = -1; +static int hf_zbee_zcl_price_srv_tx_cmd_id = -1; +static int hf_zbee_zcl_price_srv_rx_cmd_id = -1; +static int hf_zbee_zcl_price_attr_id = -1; +static int hf_zbee_zcl_price_attr_reporting_status = -1; /* Initialize the subtree pointers */ -static gint ett_zbee_zcl_msg = -1; -static gint ett_zbee_zcl_msg_message_control = -1; -static gint ett_zbee_zcl_msg_ext_message_control = -1; - -static expert_field ei_zbee_zcl_msg_msg_ctrl_depreciated = EI_INIT; - -/* Server Commands Received */ -static const value_string zbee_zcl_msg_srv_rx_cmd_names[] = { - { ZBEE_ZCL_CMD_ID_MSG_GET_LAST_MSG, "Get Last Message" }, - { ZBEE_ZCL_CMD_ID_MSG_MSG_CONFIRM, "Message Confirmation" }, - { ZBEE_ZCL_CMD_ID_MSG_GET_MESSAGE_CANCEL, "Get Message Cancellation" }, - { 0, NULL } -}; - -/* Server Commands Generated */ -static const value_string zbee_zcl_msg_srv_tx_cmd_names[] = { - { ZBEE_ZCL_CMD_ID_MSG_DISPLAY_MSG, "Display Message" }, - { ZBEE_ZCL_CMD_ID_MSG_CANCEL_MSG, "Cancel Message" }, - { ZBEE_ZCL_CMD_ID_MSG_DISPLAY_PROTECTED_MSG, "Display Protected Message"}, - { ZBEE_ZCL_CMD_ID_MSG_CANCEL_ALL_MSG, "Cancel All Messages" }, - { 0, NULL } -}; - -/* Message Control Transmission */ -static const value_string zbee_zcl_msg_ctrl_tx_names[] = { - { ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ONLY, "Normal Transmission Only" }, - { ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ANON_INTERPAN, "Normal and Anonymous Inter-PAN Transmission Only" }, - { ZBEE_ZCL_MSG_CTRL_TX_ANON_INTERPAN_ONLY, "Anonymous Inter-PAN Transmission Only" }, - { 0, NULL } -}; - -/* Message Control Importance */ -static const value_string zbee_zcl_msg_ctrl_importance_names[] = { - { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_LOW, "Low" }, - { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MEDIUM, "Medium" }, - { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_HIGH, "High" }, - { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_CRITICAL, "Critical" }, - { 0, NULL } -}; +static gint ett_zbee_zcl_price = -1; /*************************/ /* Function Bodies */ @@ -206,14 +178,12 @@ static const value_string zbee_zcl_msg_ctrl_importance_names[] = { *@param data_type attribute data type */ static void -dissect_zcl_msg_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) +dissect_zcl_price_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { switch (attr_id) { - /* no cluster specific attributes */ - /* applies to all SE clusters */ - case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS: - proto_tree_add_item(tree, hf_zbee_zcl_msg_attr_reporting_status, tvb, *offset, 1, ENC_NA); + case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_PRICE: + proto_tree_add_item(tree, hf_zbee_zcl_price_attr_reporting_status, tvb, *offset, 1, ENC_NA); *offset += 1; break; @@ -221,19 +191,18 @@ dissect_zcl_msg_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint1 dissect_zcl_attr_data(tvb, tree, offset, data_type); break; } -} /*dissect_zcl_ias_zone_attr_data*/ +} /*dissect_zcl_price_attr_data*/ /** - *ZigBee ZCL Messaging cluster dissector for wireshark. + *ZigBee ZCL Price cluster dissector for wireshark. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to data tree Wireshark uses to display packet. */ static int -dissect_zbee_zcl_msg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) +dissect_zbee_zcl_price(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { - proto_tree *payload_tree; zbee_zcl_packet *zcl; guint offset = 0; guint8 cmd_id; @@ -249,30 +218,86 @@ dissect_zbee_zcl_msg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* if (zcl->direction == ZBEE_ZCL_FCF_TO_SERVER) { /* Append the command name to the info column. */ col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", - val_to_str_const(cmd_id, zbee_zcl_msg_srv_rx_cmd_names, "Unknown Command"), + val_to_str_const(cmd_id, zbee_zcl_price_srv_rx_cmd_names, "Unknown Command"), zcl->tran_seqno); /* Add the command ID. */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_srv_rx_cmd_id, tvb, offset, 1, cmd_id); + proto_tree_add_uint(tree, hf_zbee_zcl_price_srv_rx_cmd_id, tvb, offset, 1, cmd_id); /* Check is this command has a payload, than add the payload tree */ rem_len = tvb_reported_length_remaining(tvb, ++offset); if (rem_len > 0) { - payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_msg, NULL, "Payload"); + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_price, NULL, "Payload"); /* Call the appropriate command dissector */ switch (cmd_id) { - case ZBEE_ZCL_CMD_ID_MSG_GET_LAST_MSG: - /* No payload */ + case ZBEE_ZCL_CMD_ID_PRICE_GET_CURRENT_PRICE: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_MSG_MSG_CONFIRM: - dissect_zcl_msg_confirm(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_PRICE_GET_SCHEDULED_PRICES: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_MSG_GET_MESSAGE_CANCEL: - dissect_zcl_msg_get_cancel(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_PRICE_GET_PRICE_ACKNOWLEDGEMENT: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_BLOCK_PERIOD: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_CONVERSION_FACTOR: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_CALORIFIC_VALUE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_TARIFF_INFORMATION: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_PRICE_MATRIX: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_BLOCK_THRESHOLDS: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_CO2_VALUE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_TIER_LABELS: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_BILLING_PERIOD: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_CONSOLIDATED_BILL: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_CPP_EVENT_RESPONSE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_CREDIT_PAYMENT: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_CURRENCY_CONVERSION: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_GET_TARIFF_CANCELLATION: + /* Add function to dissect payload */ break; default: @@ -283,34 +308,78 @@ dissect_zbee_zcl_msg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* else { /* ZBEE_ZCL_FCF_TO_CLIENT */ /* Append the command name to the info column. */ col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", - val_to_str_const(cmd_id, zbee_zcl_msg_srv_tx_cmd_names, "Unknown Command"), + val_to_str_const(cmd_id, zbee_zcl_price_srv_tx_cmd_names, "Unknown Command"), zcl->tran_seqno); /* Add the command ID. */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + proto_tree_add_uint(tree, hf_zbee_zcl_price_srv_tx_cmd_id, tvb, offset, 1, cmd_id); /* Check is this command has a payload, than add the payload tree */ rem_len = tvb_reported_length_remaining(tvb, ++offset); if (rem_len > 0) { - payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_msg, NULL, "Payload"); + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_price, NULL, "Payload"); /* Call the appropriate command dissector */ switch (cmd_id) { - case ZBEE_ZCL_CMD_ID_MSG_DISPLAY_MSG: - dissect_zcl_msg_display(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_PRICE: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_MSG_CANCEL_MSG: - dissect_zcl_msg_cancel(tvb, pinfo, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_BLOCK_PERIOD: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_MSG_DISPLAY_PROTECTED_MSG: - dissect_zcl_msg_display(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CONVERSION_FACTOR: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_MSG_CANCEL_ALL_MSG: - dissect_zcl_msg_cancel_all(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CALORIFIC_VALUE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_TARIFF_INFORMATION: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_PRICE_MATRIX: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_BLOCK_THRESHOLDS: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CO2_VALUE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_TIER_LABELS: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_BILLING_PERIOD: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CONSOLIDATED_BILL: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CPP_EVENT: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CREDIT_PAYMENT: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_PUBLISH_CURRENCY_CONVERSION: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PRICE_CANCEL_TARIFF: + /* Add function to dissect payload */ break; default: @@ -320,525 +389,2502 @@ dissect_zbee_zcl_msg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* } return tvb_captured_length(tvb); -} /*dissect_zbee_zcl_msg*/ +} /*dissect_zbee_zcl_price*/ /** - *This function manages the Display Message payload + *This function registers the ZCL Price dissector * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller */ -static void -dissect_zcl_msg_display(tvbuff_t *tvb, proto_tree *tree, guint *offset) +void +proto_register_zbee_zcl_price(void) { - guint msg_len; - guint8 *msg_data; - - static const int * message_ctrl_flags[] = { - &hf_zbee_zcl_msg_ctrl_tx, - &hf_zbee_zcl_msg_ctrl_importance, - &hf_zbee_zcl_msg_ctrl_enh_confirm, - &hf_zbee_zcl_msg_ctrl_reserved, - &hf_zbee_zcl_msg_ctrl_confirm, - NULL - }; - - static const int * message_ext_ctrl_flags[] = { - &hf_zbee_zcl_msg_ext_ctrl_status, - NULL - }; + static hf_register_info hf[] = { - /* Message ID */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_message_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); - *offset += 4; + { &hf_zbee_zcl_price_attr_id, + { "Attribute", "zbee_zcl_se.price.attr_id", FT_UINT16, BASE_HEX, VALS(zbee_zcl_price_attr_names), + 0x0, NULL, HFILL } }, - /* Message Control */ - proto_tree_add_bitmask(tree, tvb, *offset, hf_zbee_zcl_msg_ctrl, ett_zbee_zcl_msg_message_control, message_ctrl_flags, ENC_NA); - *offset += 1; + { &hf_zbee_zcl_price_attr_reporting_status, /* common to all SE clusters */ + { "Attribute Reporting Status", "zbee_zcl_se.price.attr.attr_reporting_status", + FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, - /* Start Time */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_start_time, tvb, *offset, 4, ENC_LITTLE_ENDIAN); - *offset += 4; + { &hf_zbee_zcl_price_srv_tx_cmd_id, + { "Command", "zbee_zcl_se.price.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_price_srv_tx_cmd_names), + 0x00, NULL, HFILL } }, - /* Duration In Minutes*/ - proto_tree_add_item(tree, hf_zbee_zcl_msg_duration, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; + { &hf_zbee_zcl_price_srv_rx_cmd_id, + { "Command", "zbee_zcl_se.price.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_price_srv_rx_cmd_names), + 0x00, NULL, HFILL } }, - /* Message Length */ - msg_len = tvb_get_guint8(tvb, *offset); /* string length */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_message_length, tvb, *offset, 1, ENC_NA); - *offset += 1; + }; - /* Message */ - msg_data = tvb_get_string_enc(wmem_packet_scope(), tvb, *offset, msg_len, ENC_LITTLE_ENDIAN); - proto_tree_add_string(tree, hf_zbee_zcl_msg_message, tvb, *offset, msg_len, msg_data); - *offset += msg_len; + /* ZCL Price subtrees */ + gint *ett[] = { + &ett_zbee_zcl_price, + }; - /* (Optional) Extended Message Control */ - if (tvb_reported_length_remaining(tvb, *offset) > 0) { - proto_tree_add_bitmask(tree, tvb, *offset, hf_zbee_zcl_msg_ext_ctrl, ett_zbee_zcl_msg_ext_message_control, message_ext_ctrl_flags, ENC_NA); - *offset += 1; - } + /* Register the ZigBee ZCL Price cluster protocol name and description */ + proto_zbee_zcl_price = proto_register_protocol("ZigBee ZCL Price", "ZCL Price", ZBEE_PROTOABBREV_ZCL_PRICE); + proto_register_field_array(proto_zbee_zcl_price, hf, array_length(hf)); + proto_register_subtree_array(ett, array_length(ett)); -} /*dissect_zcl_msg_display*/ + /* Register the ZigBee ZCL Price dissector. */ + price_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_PRICE, dissect_zbee_zcl_price, proto_zbee_zcl_price); +} /*proto_register_zbee_zcl_price*/ /** - *This function manages the Cancel Message payload + *Hands off the Zcl Price dissector. * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller */ -static void -dissect_zcl_msg_cancel(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset) +void +proto_reg_handoff_zbee_zcl_price(void) { - gint8 msg_ctrl; + /* Register our dissector with the ZigBee application dissectors. */ + dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_PRICE, price_handle); + + zbee_zcl_init_cluster( proto_zbee_zcl_price, + ett_zbee_zcl_price, + ZBEE_ZCL_CID_PRICE, + hf_zbee_zcl_price_attr_id, + hf_zbee_zcl_price_srv_rx_cmd_id, + hf_zbee_zcl_price_srv_tx_cmd_id, + (zbee_zcl_fn_attr_data)dissect_zcl_price_attr_data + ); +} /*proto_reg_handoff_zbee_zcl_price*/ - /* Message ID */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_message_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); - *offset += 4; +/* ########################################################################## */ +/* #### (0x0702) METERING CLUSTER ########################################## */ +/* ########################################################################## */ - /* Message Control */ - msg_ctrl = tvb_get_guint8(tvb, *offset); - proto_tree_add_item(tree, hf_zbee_zcl_msg_ctrl, tvb, *offset, 1, ENC_NA); - *offset += 1; +/* Attributes */ +#define zbee_zcl_met_attr_names_VALUE_STRING_LIST(XXX) \ +/* Client: Notification AttributeSet / Server: Reading Information Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_FUNC_NOTI_FLAGS_CUR_SUM_DEL, 0x0000, "Client: Functional Notification Flags / Server: Current Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_NOT_FLAGS2_CUR_SUM_RECV, 0x0001, "Client: Notification Flag 2 / Server: Current Summation Received" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_NOT_FLAGS3_CUR_MAX_DE_DEL, 0x0002, "Client: Notification Flag 3 / Server: Current Max Demand Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_NOT_FLAGS4_CUR_MAX_DE_RECV, 0x0003, "Client: Notification Flag 4 / Server: Current Max Demand Received" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_NOT_FLAGS5_DFT_SUM, 0x0004, "Client: Notification Flag 5 / Server: DFTSummation" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_NOT_FLAGS6_DAI_FREE_TIME, 0x0005, "Client: Notification Flag 6 / Server: Daily Freeze Time" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_NOT_FLAGS7_POW_FAC, 0x0006, "Client: Notification Flag 7 / Server: Power Factor" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_NOT_FLAGS8_READ_SNAP_TIME, 0x0007, "Client: Notification Flag 8 / Server: Reading Snapshot Time" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_MAX_DEMAND_DEL_TIME, 0x0008, "Current Max Demand Delivered Time" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_MAX_DEMAND_RECV_TIME, 0x0009, "Current Max Demand Received Time" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_DEFAULT_UPDATE_PERIOD, 0x000A, "Default Update Period" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_FAST_POLL_UPDATE_PERIOD, 0x000B, "Fast Poll Update Period" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_BLOCK_PER_CON_DEL, 0x000C, "Current Block Period Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_DAILY_CON_TARGET, 0x000D, "Daily Consumption Target" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CURRENT_BLOCK, 0x000E, "Current Block" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PROFILE_INTERVAL_PERIOD, 0x000F, "Profile Interval Period" ) \ +/* XXX(ZBEE_ZCL_ATTR_ID_MET_DEPRECATED, 0x0010, "Deprecated" }, */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PRESET_READING_TIME, 0x0011, "Preset Reading Time" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_VOLUME_PER_REPORT, 0x0012, "Volume Per Report" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_FLOW_RESTRICTION, 0x0013, "Flow Restriction" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_SUPPLY_STATUS, 0x0014, "Supply Status" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_INLET_ENER_CAR_SUM, 0x0015, "Current Inlet Energy Carrier Summation" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_OUTLET_ENER_CAR_SUM, 0x0016, "Current Outlet Energy Carrier Summation" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_INLET_TEMPERATURE, 0x0017, "Inlet Temperature" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_OUTLET_TEMPERATURE, 0x0018, "Outlet Temperature" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CONTROL_TEMPERATURE, 0x0019, "Control Temperature" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_INLET_ENER_CAR_DEM, 0x001A, "Current Inlet Energy Carrier Demand" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_OUTLET_ENER_CAR_DEM, 0x001B, "Current Outlet Energy Carrier Demand" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_BLOCK_CON_DEL, 0x001C, "Previous Block Period Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_BLOCL_CON_RECV, 0x001D, "Current Block Period Consumption Received" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CURRENT_BLOCK_RECEIVED, 0x001E, "Current Block Received" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_DFT_SUMMATION_RECEIVED, 0x001F, "DFT Summation Received" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_ACTIVE_REG_TIER_DEL, 0x0020, "Active Register Tier Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_ACTIVE_REG_TIER_RECV, 0x0021, "Active Register Tier Received" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_LAST_BLOCK_SWITCH_TIME, 0x0022, "Last Block Switch Time" ) \ +/* Summation TOU Information Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CURRENT_TIER_1_SUM_DEL, 0x0100, "Current Tier 1 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CURRENT_TIER_2_SUM_DEL, 0x0102, "Current Tier 2 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CURRENT_TIER_3_SUM_DEL, 0x0104, "Current Tier 3 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CURRENT_TIER_4_SUM_DEL, 0x0106, "Current Tier 4 Summation Delivered" ) \ +/* Meter Status Attribute Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_STATUS, 0x0200, "Status" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_REMAIN_BAT_LIFE_DAYS, 0x0205, "Remaining Battery Life in Days" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CURRENT_METER_ID, 0x0206, "Current Meter ID" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_AMBIENT_CON_IND, 0x0207, "Ambient Consumption Indicator" ) \ +/* Formatting */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_UNIT_OF_MEASURE, 0x0300, "Unit of Measure" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_MULTIPLIER, 0x0301, "Multiplier" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_DIVISOR, 0x0302, "Divisor" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_SUMMATION_FORMATTING, 0x0303, "Summation Formatting" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_METERING_DEVICE_TYPE, 0x0306, "Metering Device Type" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_SITE_ID, 0x0307, "Site ID" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUSTOMER_ID_NUMBER, 0x0311, "Customer ID Number" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_ALT_UNIT_OF_MEASURE, 0x0312, "Alternative Unit of Measure" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_ALT_CON_FORMATTING, 0x0314, "Alternative Consumption Formatting" ) \ +/* Historical Consumption Attribute */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_INSTANT_DEMAND, 0x0400, "Instantaneous Demand" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_DAY_CON_DEL, 0x0401, "Current Day Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_CON_DEL, 0x0403, "Previous Day Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_2_DAY_CON_DEL, 0x0420, "Previous Day 2 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_3_DAY_CON_DEL, 0x0422, "Previous Day 3 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_4_DAY_CON_DEL, 0x0424, "Previous Day 4 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_5_DAY_CON_DEL, 0x0426, "Previous Day 5 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_6_DAY_CON_DEL, 0x0428, "Previous Day 6 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_7_DAY_CON_DEL, 0x042A, "Previous Day 7 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_8_DAY_CON_DEL, 0x042C, "Previous Day 8 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_WEEK_CON_DEL, 0x0430, "Current Week Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_CON_DEL, 0x0432, "Previous Week Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_2_CON_DEL, 0x0434, "Previous Week 2 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_3_CON_DEL, 0x0436, "Previous Week 3 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_4_CON_DEL, 0x0438, "Previous Week 4 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_5_CON_DEL, 0x043A, "Previous Week 5 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_MONTH_CON_DEL, 0x0440, "Current Month Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_CON_DEL, 0x0442, "Previous Month Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_2_CON_DEL, 0x0444, "Previous Month 2 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_3_CON_DEL, 0x0446, "Previous Month 3 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_4_CON_DEL, 0x0448, "Previous Month 4 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_5_CON_DEL, 0x044A, "Previous Month 5 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_6_CON_DEL, 0x044C, "Previous Month 6 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_7_CON_DEL, 0x044E, "Previous Month 7 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_8_CON_DEL, 0x0450, "Previous Month 8 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_9_CON_DEL, 0x0452, "Previous Month 9 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_10_CON_DEL, 0x0454, "Previous Month 10 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_11_CON_DEL, 0x0456, "Previous Month 11 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_12_CON_DEL, 0x0458, "Previous Month 12 Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_13_CON_DEL, 0x045A, "Previous Month 13 Consumption Delivered" ) \ +/* Supply Limit Attributes */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_SUPPLY_TAMPER_STATE, 0x0607, "Supply Tamper State" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_SUPPLY_DEPLETION_STATE, 0x0608, "Supply Depletion State" ) \ +/* Block Information Attribute Set (Delivered) */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_NO_TIER_BLOCK_1_SUM_DEL, 0x0700, "Current No Tier Block 1 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_NO_TIER_BLOCK_2_SUM_DEL, 0x0701, "Current No Tier Block 2 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_NO_TIER_BLOCK_3_SUM_DEL, 0x0702, "Current No Tier Block 3 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_NO_TIER_BLOCK_4_SUM_DEL, 0x0703, "Current No Tier Block 4 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_1_BLOCK_1_SUM_DEL, 0x0710, "Current Tier 1 Block 1 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_1_BLOCK_2_SUM_DEL, 0x0711, "Current Tier 1 Block 2 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_1_BLOCK_3_SUM_DEL, 0x0712, "Current Tier 1 Block 3 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_1_BLOCK_4_SUM_DEL, 0x0713, "Current Tier 1 Block 4 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_2_BLOCK_1_SUM_DEL, 0x0720, "Current Tier 2 Block 1 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_2_BLOCK_2_SUM_DEL, 0x0721, "Current Tier 2 Block 2 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_2_BLOCK_3_SUM_DEL, 0x0722, "Current Tier 2 Block 3 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_2_BLOCK_4_SUM_DEL, 0x0723, "Current Tier 2 Block 4 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_3_BLOCK_1_SUM_DEL, 0x0730, "Current Tier 3 Block 1 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_3_BLOCK_2_SUM_DEL, 0x0731, "Current Tier 3 Block 2 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_3_BLOCK_3_SUM_DEL, 0x0732, "Current Tier 3 Block 3 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_3_BLOCK_4_SUM_DEL, 0x0733, "Current Tier 3 Block 4 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_4_BLOCK_1_SUM_DEL, 0x0740, "Current Tier 4 Block 1 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_4_BLOCK_2_SUM_DEL, 0x0741, "Current Tier 4 Block 2 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_4_BLOCK_3_SUM_DEL, 0x0742, "Current Tier 4 Block 3 Summation Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_TIER_4_BLOCK_4_SUM_DEL, 0x0743, "Current Tier 4 Block 4 Summation Delivered" ) \ +/* Meter Billing Attribute Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_BILL_TO_DATE_DELIVERED, 0x0A00, "Bill To Date Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_BILL_TO_DATE_TIMESTAMP_DEL, 0x0A01, "BillToDateTimeStampDelivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_BILL_DELIVERED_TRAILING_DIGIT, 0x0A04, "Bill Delivered Trailing Digit" ) \ +/* Alternative Historical Consumption Attribute Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_DAY_ALT_CON_DEL, 0x0C01, "Current Day Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_ALT_CON_DEL, 0x0C03, "Previous Day Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_2_ALT_CON_DEL, 0x0C20, "Previous Day 2 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_3_ALT_CON_DEL, 0x0C22, "Previous Day 3 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_4_ALT_CON_DEL, 0x0C24, "Previous Day 4 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_5_ALT_CON_DEL, 0x0C26, "Previous Day 5 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_6_ALT_CON_DEL, 0x0C28, "Previous Day 6 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_7_ALT_CON_DEL, 0x0C2A, "Previous Day 7 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_DAY_8_ALT_CON_DEL, 0x0C2C, "Previous Day 8 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_WEEK_ALT_CON_DEL, 0x0C30, "Current Week Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_ALT_CON_DEL, 0x0C32, "Previous Week Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_2_ALT_CON_DEL, 0x0C34, "Previous Week 2 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_3_ALT_CON_DEL, 0x0C36, "Previous Week 3 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_4_ALT_CON_DEL, 0x0C38, "Previous Week 4 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_WEEK_5_ALT_CON_DEL, 0x0C3A, "Previous Week 5 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_CUR_MONTH_ALT_CON_DEL, 0x0C40, "Current Month Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_ALT_CON_DEL, 0x0C42, "Previous Month Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_2_ALT_CON_DEL, 0x0C44, "Previous Month 2 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_3_ALT_CON_DEL, 0x0C46, "Previous Month 3 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_4_ALT_CON_DEL, 0x0C48, "Previous Month 4 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_5_ALT_CON_DEL, 0x0C4A, "Previous Month 5 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_6_ALT_CON_DEL, 0x0C4C, "Previous Month 6 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_7_ALT_CON_DEL, 0x0C4E, "Previous Month 7 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_8_ALT_CON_DEL, 0x0C50, "Previous Month 8 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_9_ALT_CON_DEL, 0x0C52, "Previous Month 9 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_10_ALT_CON_DEL, 0x0C54, "Previous Month 10 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_11_ALT_CON_DEL, 0x0C56, "Previous Month 11 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_12_ALT_CON_DEL, 0x0C58, "Previous Month 12 Alternative Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_MET_PREV_MONTH_13_ALT_CON_DEL, 0x0C5A, "Previous Month 13 Alternative Consumption Delivered" ) \ +/* Smart Energy */ \ + XXX(ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_MET, 0xFFFE, "Attribute Reporting Status" ) + +VALUE_STRING_ENUM(zbee_zcl_met_attr_names); +VALUE_STRING_ARRAY(zbee_zcl_met_attr_names); +static value_string_ext zbee_zcl_met_attr_names_ext = VALUE_STRING_EXT_INIT(zbee_zcl_met_attr_names); - if (msg_ctrl != 0x00) { - expert_add_info(pinfo, tree, &ei_zbee_zcl_msg_msg_ctrl_depreciated); - } +/* Server Commands Received */ +#define zbee_zcl_met_srv_rx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_MET_GET_PROFILE, 0x00, "Get Profile" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_REQUEST_MIRROR_RSP, 0x01, "Request Mirror Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_MIRROR_REMOVED, 0x02, "Mirror Removed" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_REQUEST_FAST_POLL_MODE, 0x03, "Request Fast Poll Mode" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_SCHEDULE_SNAPSHOT, 0x04, "Schedule Snapshot" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_TAKE_SNAPSHOT, 0x05, "Take Snapshot" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_GET_SNAPSHOT, 0x06, "Get Snapshot" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_START_SAMPLING, 0x07, "Start Sampling" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_GET_SAMPLED_DATA, 0x08, "Get Sampled Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_MIRROR_REPORT_ATTRIBUTE_RESPONSE, 0x09, "Mirror Report Attribute Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_RESET_LOAD_LIMIT_COUNTER, 0x0A, "Reset Load Limit Counter" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_CHANGE_SUPPLY, 0x0B, "Change Supply" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_LOCAL_CHANGE_SUPPLY, 0x0C, "Local Change Supply" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_SET_SUPPLY_STATUS, 0x0D, "Set Supply Status" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_SET_UNCONTROLLED_FLOW_THRESHOLD, 0x0E, "Set Uncontrolled Flow Threshold" ) + +VALUE_STRING_ENUM(zbee_zcl_met_srv_rx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_met_srv_rx_cmd_names); -} /* dissect_zcl_msg_cancel */ +/* Server Commands Generated */ +#define zbee_zcl_met_srv_tx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_MET_GET_PROFILE_RESPONSE, 0x00, "Get Profile Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_REQUEST_MIRROR, 0x01, "Request Mirror" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_REMOVE_MIRROR, 0x02, "Remove Mirror" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_REQUEST_FAST_POLL_MODE_RESPONSE, 0x03, "Request Fast Poll Mode Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_SCHEDULE_SNAPSHOT_RESPONSE, 0x04, "Schedule Snapshot Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_TAKE_SNAPSHOT_RESPONSE, 0x05, "Take Snapshot Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_PUBLISH_SNAPSHOT, 0x06, "Publish Snapshot" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_GET_SAMPLED_DATA_RSP, 0x07, "Get Sampled Data Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_CONFIGURE_MIRROR, 0x08, "Configure Mirror" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_CONFIGURE_NOTIFICATION_SCHEME, 0x09, "Configure Notification Scheme" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_CONFIGURE_NOTIFICATION_FLAG, 0x0A, "Configure Notification Flag" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_GET_NOTIFIED_MESSAGE, 0x0B, "Get Notified Message" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_SUPPLY_STATUS_RESPONSE, 0x0C, "Supply Status Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_MET_START_SAMPLING_RESPONSE, 0x0D, "Start Sampling Response" ) + +VALUE_STRING_ENUM(zbee_zcl_met_srv_tx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_met_srv_tx_cmd_names); + +/*************************/ +/* Function Declarations */ +/*************************/ +void proto_register_zbee_zcl_met(void); +void proto_reg_handoff_zbee_zcl_met(void); + +/* Attribute Dissector Helpers */ +static void dissect_zcl_met_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); + +/* Command Dissector Helpers */ +static void dissect_zcl_met_request_mirror_rsp (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_met_get_snapshot (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_met_get_sampled_data (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_met_local_change_supply (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_met_publish_snapshot (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_met_get_sampled_data_rsp (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_met_configure_mirror (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_met_get_notified_msg (tvbuff_t *tvb, proto_tree *tree, guint *offset); + +/*************************/ +/* Global Variables */ +/*************************/ + +static dissector_handle_t met_handle; + +/* Initialize the protocol and registered fields */ +static int proto_zbee_zcl_met = -1; + +static int hf_zbee_zcl_met_srv_tx_cmd_id = -1; +static int hf_zbee_zcl_met_srv_rx_cmd_id = -1; +static int hf_zbee_zcl_met_attr_id = -1; +static int hf_zbee_zcl_met_attr_reporting_status = -1; +static int hf_zbee_zcl_met_request_mirror_rsp_endpoint_id = -1; +static int hf_zbee_zcl_met_get_snapshot_start_time = -1; +static int hf_zbee_zcl_met_get_snapshot_end_time = -1; +static int hf_zbee_zcl_met_get_snapshot_snapshot_offset = -1; +static int hf_zbee_zcl_met_get_snapshot_snapshot_cause = -1; +static int hf_zbee_zcl_met_get_sampled_data_sample_id = -1; +static int hf_zbee_zcl_met_get_sampled_data_sample_start_time = -1; +static int hf_zbee_zcl_met_get_sampled_data_sample_type = -1; +static int hf_zbee_zcl_met_get_sampled_data_number_of_samples = -1; +static int hf_zbee_zcl_met_local_change_supply_supply_status = -1; +static int hf_zbee_zcl_met_publish_snapshot_snapshot_id = -1; +static int hf_zbee_zcl_met_publish_snapshot_snapshot_time = -1; +static int hf_zbee_zcl_met_publish_snapshot_snapshots_found = -1; +static int hf_zbee_zcl_met_publish_snapshot_cmd_index = -1; +static int hf_zbee_zcl_met_publish_snapshot_total_commands = -1; +static int hf_zbee_zcl_met_publish_snapshot_snapshot_cause = -1; +static int hf_zbee_zcl_met_publish_snapshot_snapshot_payload_type = -1; +static int hf_zbee_zcl_met_publish_snapshot_snapshot_sub_payload = -1; +static int hf_zbee_zcl_met_get_sampled_data_rsp_sample_id = -1; +static int hf_zbee_zcl_met_get_sampled_data_rsp_sample_start_time = -1; +static int hf_zbee_zcl_met_get_sampled_data_rsp_sample_type = -1; +static int hf_zbee_zcl_met_get_sampled_data_rsp_sample_request_interval = -1; +static int hf_zbee_zcl_met_get_sampled_data_rsp_sample_number_of_samples = -1; +static int hf_zbee_zcl_met_get_sampled_data_rsp_sample_samples = -1; +static int hf_zbee_zcl_met_configure_mirror_issuer_event_id = -1; +static int hf_zbee_zcl_met_configure_mirror_reporting_interval = -1; +static int hf_zbee_zcl_met_configure_mirror_mirror_notification_reporting = -1; +static int hf_zbee_zcl_met_configure_mirror_notification_scheme = -1; +static int hf_zbee_zcl_met_get_notified_msg_notification_scheme = -1; +static int hf_zbee_zcl_met_get_notified_msg_notification_flag_attribute_id = -1; +static int hf_zbee_zcl_met_get_notified_msg_notification_flags = -1; +/* Initialize the subtree pointers */ +static gint ett_zbee_zcl_met = -1; + +/*************************/ +/* Function Bodies */ +/*************************/ /** - *Send Cancel All command + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ +static void +dissect_zcl_met_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) +{ + switch (attr_id) { + /* applies to all SE clusters */ + case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_MET: + proto_tree_add_item(tree, hf_zbee_zcl_met_attr_reporting_status, tvb, *offset, 1, ENC_NA); + *offset += 1; + break; + + default: /* Catch all */ + dissect_zcl_attr_data(tvb, tree, offset, data_type); + break; + } +} /*dissect_zcl_met_attr_data*/ + +/** + *ZigBee ZCL Metering cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ +static int +dissect_zbee_zcl_met(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) +{ + proto_tree *payload_tree; + zbee_zcl_packet *zcl; + guint offset = 0; + guint8 cmd_id; + gint rem_len; + + /* Reject the packet if data is NULL */ + if (data == NULL) + return 0; + zcl = (zbee_zcl_packet *)data; + cmd_id = zcl->cmd_id; + + /* Create a subtree for the ZCL Command frame, and add the command ID to it. */ + if (zcl->direction == ZBEE_ZCL_FCF_TO_SERVER) { + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_met_srv_rx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_met_srv_rx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_met, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_MET_REQUEST_MIRROR_RSP: + dissect_zcl_met_request_mirror_rsp(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MET_GET_SNAPSHOT: + dissect_zcl_met_get_snapshot(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MET_GET_SAMPLED_DATA: + dissect_zcl_met_get_sampled_data(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MET_LOCAL_CHANGE_SUPPLY: + dissect_zcl_met_local_change_supply(tvb, payload_tree, &offset); + break; + + default: + break; + } + } + } + else { /* ZBEE_ZCL_FCF_TO_CLIENT */ + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_met_srv_tx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_met_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_met, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_MET_REQUEST_MIRROR: + /* No payload */ + break; + + case ZBEE_ZCL_CMD_ID_MET_PUBLISH_SNAPSHOT: + dissect_zcl_met_publish_snapshot(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MET_GET_SAMPLED_DATA_RSP: + dissect_zcl_met_get_sampled_data_rsp(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MET_CONFIGURE_MIRROR: + dissect_zcl_met_configure_mirror(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MET_GET_NOTIFIED_MESSAGE: + dissect_zcl_met_get_notified_msg(tvb, payload_tree, &offset); + break; + + default: + break; + } + } + } + + return tvb_captured_length(tvb); +} /*dissect_zbee_zcl_met*/ + +/** + *This function manages the Request Mirror Response payload * *@param tvb pointer to buffer containing raw packet. *@param tree pointer to data tree Wireshark uses to display packet. *@param offset pointer to offset from caller */ static void -dissect_zcl_msg_cancel_all(tvbuff_t *tvb, proto_tree *tree, guint *offset) +dissect_zcl_met_request_mirror_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) { - nstime_t impl_time; + /* EndPoint ID */ + proto_tree_add_item(tree, hf_zbee_zcl_met_request_mirror_rsp_endpoint_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} /*dissect_zcl_met_get_snapshot*/ - /* Retrieve "Confirmation Time" field */ - impl_time.secs = tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; - impl_time.nsecs = 0; - proto_tree_add_time(tree, hf_zbee_zcl_msg_implementation_time, tvb, *offset, 4, &impl_time); +/** + *This function manages the Get Snapshot payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_met_get_snapshot(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + nstime_t start_time; + nstime_t end_time; + gint rem_len = tvb_reported_length_remaining(tvb, *offset); + + /* Start Time */ + start_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + start_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_met_get_snapshot_start_time, tvb, *offset, 4, &start_time); *offset += 4; -} /* dissect_zcl_msg_cancel_all */ + if (rem_len > 9) { + /* End Time - not part of SE 1.1b specification */ + end_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + end_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_met_get_snapshot_end_time, tvb, *offset, 4, &end_time); + *offset += 4; + } + + /* Snapshot Offset */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_snapshot_snapshot_offset, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; + + /* Snapshot Cause */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_snapshot_snapshot_cause, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; +} /*dissect_zcl_met_get_snapshot*/ /** - *Send Cancel All command + *This function manages the Get Sampled Data payload * *@param tvb pointer to buffer containing raw packet. *@param tree pointer to data tree Wireshark uses to display packet. *@param offset pointer to offset from caller */ static void -dissect_zcl_msg_get_cancel(tvbuff_t *tvb, proto_tree *tree, guint *offset) +dissect_zcl_met_get_sampled_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) { - nstime_t impl_time; + nstime_t sample_time; - /* Earliest Implementation Time */ - impl_time.secs = tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; - impl_time.nsecs = 0; - proto_tree_add_time(tree, hf_zbee_zcl_msg_earliest_time, tvb, *offset, 4, &impl_time); + /* Sample ID */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_sampled_data_sample_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + /* Sample Start Time */ + sample_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + sample_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_met_get_sampled_data_sample_start_time, tvb, *offset, 4, &sample_time); *offset += 4; -} /* dissect_zcl_msg_get_cancel */ + /* Sample Type */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_sampled_data_sample_type, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; + /* Number of Samples */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_sampled_data_number_of_samples, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} /*dissect_zcl_met_get_sampled_data*/ /** - *This function manages the Message Confirmation payload + *This function manages the Local Change Supply payload * *@param tvb pointer to buffer containing raw packet. *@param tree pointer to data tree Wireshark uses to display packet. *@param offset pointer to offset from caller */ static void -dissect_zcl_msg_confirm(tvbuff_t *tvb, proto_tree *tree, guint *offset) +dissect_zcl_met_local_change_supply(tvbuff_t *tvb, proto_tree *tree, guint *offset) { - guint msg_len; - guint8 *msg_data; - nstime_t confirm_time; + /* Proposed Supply Status */ + proto_tree_add_item(tree, hf_zbee_zcl_met_local_change_supply_supply_status, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; +} /*dissect_zcl_met_local_change_supply*/ - /* Retrieve "Message ID" field */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_message_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); +/** + *This function manages the Publish Snapshot payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_met_publish_snapshot(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + nstime_t snapshot_time; + gint rem_len; + + /* Snapshot ID */ + proto_tree_add_item(tree, hf_zbee_zcl_met_publish_snapshot_snapshot_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); *offset += 4; - /* Retrieve "Confirmation Time" field */ - confirm_time.secs = tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; - confirm_time.nsecs = 0; - proto_tree_add_time(tree, hf_zbee_zcl_msg_confirm_time, tvb, *offset, 4, &confirm_time); + /* Snapshot Time */ + snapshot_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + snapshot_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_met_publish_snapshot_snapshot_time, tvb, *offset, 4, &snapshot_time); *offset += 4; - /* (Optional) Confirm Control */ - if ( tvb_reported_length_remaining(tvb, *offset) <= 0 ) return; - proto_tree_add_item(tree, hf_zbee_zcl_msg_confirm_ctrl, tvb, *offset, 1, ENC_NA); + /* Total Snapshots Found */ + proto_tree_add_item(tree, hf_zbee_zcl_met_publish_snapshot_snapshots_found, tvb, *offset, 1, ENC_LITTLE_ENDIAN); *offset += 1; - /* (Optional) Response Text Length */ - if ( tvb_reported_length_remaining(tvb, *offset) <= 0 ) return; - msg_len = tvb_get_guint8(tvb, *offset); /* string length */ - proto_tree_add_item(tree, hf_zbee_zcl_msg_confirm_response_length, tvb, *offset, 1, ENC_NA); + /* Command Index */ + proto_tree_add_item(tree, hf_zbee_zcl_met_publish_snapshot_cmd_index, tvb, *offset, 1, ENC_LITTLE_ENDIAN); *offset += 1; - /* (Optional) Response Text, but is we have a length we expect to find the subsequent string */ - if (msg_len > 0) { - msg_data = tvb_get_string_enc(wmem_packet_scope(), tvb, *offset, msg_len, ENC_LITTLE_ENDIAN); - proto_tree_add_string(tree, hf_zbee_zcl_msg_confirm_response, tvb, *offset, msg_len, msg_data); - *offset += msg_len; - } + /* Total Number of Commands */ + proto_tree_add_item(tree, hf_zbee_zcl_met_publish_snapshot_total_commands, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; -} /* dissect_zcl_msg_confirm */ + /* Snapshot Cause */ + proto_tree_add_item(tree, hf_zbee_zcl_met_publish_snapshot_snapshot_cause, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; + + /* Snapshot Payload Type */ + proto_tree_add_item(tree, hf_zbee_zcl_met_publish_snapshot_snapshot_payload_type, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; + + /* Snapshot Sub-Payload */ + rem_len = tvb_reported_length_remaining(tvb, *offset); + proto_tree_add_item(tree, hf_zbee_zcl_met_publish_snapshot_snapshot_sub_payload, tvb, *offset, rem_len, ENC_NA); + *offset += rem_len; +} /*dissect_zcl_met_publish_snapshot*/ /** - *This function decodes duration in minute type variable + *This function manages the Get Sampled Data Response payload * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller */ static void -decode_zcl_msg_duration(gchar *s, guint16 value) +dissect_zcl_met_get_sampled_data_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) { - if (value == 0xffff) - g_snprintf(s, ITEM_LABEL_LENGTH, "Until changed"); - else - g_snprintf(s, ITEM_LABEL_LENGTH, "%d minutes", value); - return; -} /*decode_zcl_msg_duration*/ + nstime_t sample_start_time; + gint rem_len; + + /* Snapshot ID */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_sampled_data_rsp_sample_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + /* Sample Start Time */ + sample_start_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + sample_start_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_met_get_sampled_data_rsp_sample_start_time, tvb, *offset, 4, &sample_start_time); + *offset += 4; + + /* Sample Type */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_sampled_data_rsp_sample_type, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; + + /* Sample Request Interval */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_sampled_data_rsp_sample_request_interval, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + /* Number of Samples */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_sampled_data_rsp_sample_number_of_samples, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + /* Samples */ + rem_len = tvb_reported_length_remaining(tvb, *offset); + while (rem_len >= 3) { + guint32 val = tvb_get_guint24(tvb, *offset, ENC_LITTLE_ENDIAN); + proto_tree_add_uint(tree, hf_zbee_zcl_met_get_sampled_data_rsp_sample_samples, tvb, *offset, 3, val); + *offset += 3; + rem_len -= 3; + } +} /*dissect_zcl_met_get_sampled_data_rsp*/ /** - *This function decodes start time, with peculiarity case for + *This function manages the Configure Mirror payload * - *@param s string to display - *@param value value to decode + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller */ static void -decode_zcl_msg_start_time(gchar *s, guint32 value) +dissect_zcl_met_configure_mirror(tvbuff_t *tvb, proto_tree *tree, guint *offset) { - if (value == ZBEE_ZCL_MSG_START_TIME_NOW) - g_snprintf(s, ITEM_LABEL_LENGTH, "Now"); - else { - gchar *start_time; - value += ZBEE_ZCL_NSTIME_UTC_OFFSET; - start_time = abs_time_secs_to_str (NULL, value, ABSOLUTE_TIME_LOCAL, TRUE); - g_snprintf(s, ITEM_LABEL_LENGTH, "%s", start_time); - wmem_free(NULL, start_time); - } -} /* decode_zcl_msg_start_time */ + /* Issuer Event ID */ + proto_tree_add_item(tree, hf_zbee_zcl_met_configure_mirror_issuer_event_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; + + /* Reporting Interval */ + proto_tree_add_item(tree, hf_zbee_zcl_met_configure_mirror_reporting_interval, tvb, *offset, 3, ENC_LITTLE_ENDIAN); + *offset += 3; + + /* Mirror Notification Reporting */ + proto_tree_add_item(tree, hf_zbee_zcl_met_configure_mirror_mirror_notification_reporting, tvb, *offset, 1, ENC_NA); + *offset += 1; + + /* Notification Scheme */ + proto_tree_add_item(tree, hf_zbee_zcl_met_configure_mirror_notification_scheme, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; +} /*dissect_zcl_met_configure_mirror*/ /** - *This function registers the ZCL Messaging dissector + *This function manages the Get Notified Message payload * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller */ -void -proto_register_zbee_zcl_msg(void) +static void +dissect_zcl_met_get_notified_msg(tvbuff_t *tvb, proto_tree *tree, guint *offset) { - static hf_register_info hf[] = { + /* Notification Scheme */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_notified_msg_notification_scheme, tvb, *offset, 1, ENC_LITTLE_ENDIAN); + *offset += 1; - { &hf_zbee_zcl_msg_attr_id, - { "Attribute", "zbee_zcl_se.msg.attr_id", FT_UINT16, BASE_HEX, VALS(zbee_zcl_msg_attr_names), - 0x0, NULL, HFILL } }, + /* Notification Flag attribute ID */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_notified_msg_notification_flag_attribute_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; - { &hf_zbee_zcl_msg_attr_reporting_status, /* common to all SE clusters */ - { "Attribute Reporting Status", "zbee_zcl_se.msg.attr.attr_reporting_status", - FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, + /* Notification Flags #N */ + proto_tree_add_item(tree, hf_zbee_zcl_met_get_notified_msg_notification_flags, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; +} /*dissect_zcl_met_get_notified_msg*/ - { &hf_zbee_zcl_msg_srv_tx_cmd_id, - { "Command", "zbee_zcl_se.msg.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_srv_tx_cmd_names), +/** + *This function registers the ZCL Metering dissector + * +*/ +void +proto_register_zbee_zcl_met(void) +{ + static hf_register_info hf[] = { + + { &hf_zbee_zcl_met_attr_id, + { "Attribute", "zbee_zcl_se.met.attr_id", FT_UINT16, BASE_HEX | BASE_EXT_STRING, &zbee_zcl_met_attr_names_ext, + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_met_attr_reporting_status, /* common to all SE clusters */ + { "Attribute Reporting Status", "zbee_zcl_se.met.attr.attr_reporting_status", + FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_srv_tx_cmd_id, + { "Command", "zbee_zcl_se.met.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_met_srv_tx_cmd_names), 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_srv_rx_cmd_id, - { "Command", "zbee_zcl_se.msg.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_srv_rx_cmd_names), + { &hf_zbee_zcl_met_srv_rx_cmd_id, + { "Command", "zbee_zcl_se.met.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_met_srv_rx_cmd_names), 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_message_id, - { "Message ID", "zbee_zcl_se.msg.message.id", FT_UINT32, BASE_HEX, NULL, + { &hf_zbee_zcl_met_request_mirror_rsp_endpoint_id, + { "EndPoint ID", "zbee_zcl_se.met.request_mirror_rsp.endpoint_id", FT_UINT16, BASE_DEC, NULL, 0x00, NULL, HFILL } }, -/* Start of 'Message Control' fields */ - { &hf_zbee_zcl_msg_ctrl, - { "Message Control", "zbee_zcl_se.msg.message.ctrl", FT_UINT8, BASE_HEX, NULL, - 0x0, NULL, HFILL } }, + { &hf_zbee_zcl_met_get_snapshot_start_time, + { "Start Time", "zbee_zcl_se.met.get_snapshot.start_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_ctrl_tx, - { "Transmission", "zbee_zcl_se.msg.message.ctrl.tx", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_ctrl_tx_names), - ZBEE_ZCL_MSG_CTRL_TX_MASK, NULL, HFILL } }, + { &hf_zbee_zcl_met_get_snapshot_end_time, + { "End Time", "zbee_zcl_se.met.get_snapshot.end_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_ctrl_importance, - { "Importance", "zbee_zcl_se.msg.message.ctrl.importance", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_ctrl_importance_names), - ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MASK, NULL, HFILL } }, + { &hf_zbee_zcl_met_get_snapshot_snapshot_offset, + { "Snapshot Offset", "zbee_zcl_se.met.get_snapshot.snapshot_offset", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_ctrl_enh_confirm, - { "Confirmation", "zbee_zcl_se.msg.message.ctrl.enhconfirm", FT_BOOLEAN, 8, TFS(&tfs_required_not_required), - ZBEE_ZCL_MSG_CTRL_ENHANCED_CONFIRM_MASK, NULL, HFILL } }, + { &hf_zbee_zcl_met_get_snapshot_snapshot_cause, + { "Snapshot Cause", "zbee_zcl_se.met.get_snapshot.snapshot_cause", FT_UINT32, BASE_HEX, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_ctrl_reserved, - { "Reserved", "zbee_zcl_se.msg.message.ctrl.reserved", FT_UINT8, BASE_HEX, NULL, - ZBEE_ZCL_MSG_CTRL_RESERVED_MASK, NULL, HFILL } }, + { &hf_zbee_zcl_met_get_sampled_data_sample_id, + { "Sample ID", "zbee_zcl_se.met.get_sampled_data.sample_id", FT_UINT16, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_ctrl_confirm, - { "Confirmation", "zbee_zcl_se.msg.message.ctrl.confirm", FT_BOOLEAN, 8, TFS(&tfs_required_not_required), - ZBEE_ZCL_MSG_CTRL_CONFIRM_MASK, NULL, HFILL } }, -/* End of 'Message Control' fields */ + { &hf_zbee_zcl_met_get_sampled_data_sample_start_time, + { "Sample Start Time", "zbee_zcl_se.met.get_sampled_data.sample_start_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, + 0x00, NULL, HFILL } }, -/* Start of 'Extended Message Control' fields */ - { &hf_zbee_zcl_msg_ext_ctrl, - { "Extended Message Control", "zbee_zcl_se.msg.message.ext.ctrl", FT_UINT8, BASE_HEX, NULL, - 0x0, NULL, HFILL } }, + { &hf_zbee_zcl_met_get_sampled_data_sample_type, + { "Sample Type", "zbee_zcl_se.met.get_sampled_data.sample_type", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_ext_ctrl_status, - { "Message Confirmation Satus", "zbee_zcl_se.msg.message.ext.ctrl.status", FT_BOOLEAN, 8, TFS(&tfs_confirmed_unconfirmed), - ZBEE_ZCL_MSG_EXT_CTRL_STATUS_MASK, NULL, HFILL } }, -/* End of 'Extended Message Control' fields */ + { &hf_zbee_zcl_met_get_sampled_data_number_of_samples, + { "Number of Samples", "zbee_zcl_se.met.get_sampled_data.number_of_samples", FT_UINT16, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_start_time, - { "Start Time", "zbee_zcl_se.msg.message.start_time", FT_UINT32, BASE_CUSTOM, CF_FUNC(decode_zcl_msg_start_time), + { &hf_zbee_zcl_met_local_change_supply_supply_status, + { "Proposed Supply Status", "zbee_zcl_se.met.local_change_supply.supply_status", FT_UINT8, BASE_DEC, NULL, 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_duration, - { "Duration", "zbee_zcl_se.msg.message.duration", FT_UINT16, BASE_CUSTOM, CF_FUNC(decode_zcl_msg_duration), + { &hf_zbee_zcl_met_publish_snapshot_snapshot_id, + { "Snapshot ID", "zbee_zcl_se.met.publish_snapshot.snapshot_id", FT_UINT32, BASE_DEC, NULL, 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_message_length, - { "Message Length", "zbee_zcl_se.msg.message.length", FT_UINT8, BASE_DEC, NULL, + { &hf_zbee_zcl_met_publish_snapshot_snapshot_time, + { "Snapshot Time", "zbee_zcl_se.met.publish_snapshot.snapshot_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_message, - { "Message", "zbee_zcl_se.msg.message", FT_STRING, BASE_NONE, NULL, + { &hf_zbee_zcl_met_publish_snapshot_snapshots_found, + { "Total Snapshots Found", "zbee_zcl_se.met.publish_snapshot.snapshots_found", FT_UINT8, BASE_DEC, NULL, 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_confirm_time, - { "Confirmation Time", "zbee_zcl_se.msg.message.confirm_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_LOCAL, NULL, - 0x0, NULL, HFILL } }, + { &hf_zbee_zcl_met_publish_snapshot_cmd_index, + { "Command Index", "zbee_zcl_se.met.publish_snapshot.command_index", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_confirm_ctrl, - { "Confirmation Control", "zbee_zcl_se.msg.message.confirm.ctrl", FT_BOOLEAN, 8, TFS(&tfs_no_yes), - ZBEE_ZCL_MSG_CONFIRM_CTRL_MASK, NULL, HFILL } }, + { &hf_zbee_zcl_met_publish_snapshot_total_commands, + { "Total Number of Commands", "zbee_zcl_se.met.publish_snapshot.total_commands", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_confirm_response_length, - { "Response Length", "zbee_zcl_se.msg.message.length", FT_UINT8, BASE_DEC, NULL, + { &hf_zbee_zcl_met_publish_snapshot_snapshot_cause, + { "Snapshot Cause", "zbee_zcl_se.met.publish_snapshot.snapshot_cause", FT_UINT32, BASE_HEX, NULL, 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_confirm_response, - { "Response", "zbee_zcl_se.msg.message", FT_STRING, BASE_NONE, NULL, + { &hf_zbee_zcl_met_publish_snapshot_snapshot_payload_type, + { "Snapshot Payload Type", "zbee_zcl_se.met.publish_snapshot.payload_type", FT_UINT8, BASE_DEC, NULL, 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_implementation_time, - { "Implementation Time", "zbee_zcl_se.msg.impl_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, - 0, NULL, HFILL } }, + { &hf_zbee_zcl_met_publish_snapshot_snapshot_sub_payload, + { "Snapshot Sub-Payload", "zbee_zcl_se.met.publish_snapshot.sub_payload", FT_BYTES, BASE_NONE, NULL, + 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_msg_earliest_time, - { "Earliest Implementation Time", "zbee_zcl_se.msg.earliest_impl_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, - 0, NULL, HFILL } }, + { &hf_zbee_zcl_met_get_sampled_data_rsp_sample_id, + { "Sample ID", "zbee_zcl_se.met.get_sampled_data_rsp.sample_id", FT_UINT16, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, - }; + { &hf_zbee_zcl_met_get_sampled_data_rsp_sample_start_time, + { "Sample Start Time", "zbee_zcl_se.met.get_sampled_data_rsp.sample_start_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, + 0x00, NULL, HFILL } }, - /* ZCL Messaging subtrees */ - gint *ett[] = { - &ett_zbee_zcl_msg, - &ett_zbee_zcl_msg_message_control, - &ett_zbee_zcl_msg_ext_message_control, + { &hf_zbee_zcl_met_get_sampled_data_rsp_sample_type, + { "Sample Type", "zbee_zcl_se.met.get_sampled_data_rsp.sample_type", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_get_sampled_data_rsp_sample_request_interval, + { "Sample Request Interval", "zbee_zcl_se.met.get_sampled_data_rsp.sample_request_interval", FT_UINT16, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_get_sampled_data_rsp_sample_number_of_samples, + { "Number of Samples", "zbee_zcl_se.met.get_sampled_data_rsp.number_of_samples", FT_UINT16, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_get_sampled_data_rsp_sample_samples, + { "Samples", "zbee_zcl_se.met.get_sampled_data_rsp.samples", FT_UINT24, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_configure_mirror_issuer_event_id, + { "Issuer Event ID", "zbee_zcl_se.met.configure_mirror.issuer_event_id", FT_UINT32, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_configure_mirror_reporting_interval, + { "Reporting Interval", "zbee_zcl_se.met.configure_mirror.reporting_interval", FT_UINT24, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_configure_mirror_mirror_notification_reporting, + { "Mirror Notification Reporting", "zbee_zcl_se.met.configure_mirror.mirror_notification_reporting", FT_BOOLEAN, BASE_NONE, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_configure_mirror_notification_scheme, + { "Notification Scheme", "zbee_zcl_se.met.configure_mirror.notification_scheme", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_get_notified_msg_notification_scheme, + { "Notification Scheme", "zbee_zcl_se.met.get_notified_msg.notification_scheme", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_get_notified_msg_notification_flag_attribute_id, + { "Notification Flag attribute ID", "zbee_zcl_se.met.get_notified_msg.notification_flag_attribute_id", FT_UINT16, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_met_get_notified_msg_notification_flags, + { "Notification Flags", "zbee_zcl_se.met.get_notified_msg.notification_flags", FT_UINT32, BASE_HEX, NULL, + 0x00, NULL, HFILL } } }; - /* Expert Info */ - expert_module_t* expert_zbee_zcl_msg; - static ei_register_info ei[] = { - { &ei_zbee_zcl_msg_msg_ctrl_depreciated, { "zbee_zcl_se.msg.msg_ctrl.depreciated", PI_PROTOCOL, PI_WARN, "Message Control depreciated in this message, should be 0x00", EXPFILL }}, + /* ZCL Metering subtrees */ + gint *ett[] = { + &ett_zbee_zcl_met, }; - /* Register the ZigBee ZCL Messaging cluster protocol name and description */ - proto_zbee_zcl_msg = proto_register_protocol("ZigBee ZCL Messaging", "ZCL Messaging", ZBEE_PROTOABBREV_ZCL_MSG); - proto_register_field_array(proto_zbee_zcl_msg, hf, array_length(hf)); + /* Register the ZigBee ZCL Metering cluster protocol name and description */ + proto_zbee_zcl_met = proto_register_protocol("ZigBee ZCL Metering", "ZCL Metering", ZBEE_PROTOABBREV_ZCL_MET); + proto_register_field_array(proto_zbee_zcl_met, hf, array_length(hf)); proto_register_subtree_array(ett, array_length(ett)); - expert_zbee_zcl_msg = expert_register_protocol(proto_zbee_zcl_msg); - expert_register_field_array(expert_zbee_zcl_msg, ei, array_length(ei)); - - /* Register the ZigBee ZCL Messaging dissector. */ - register_dissector(ZBEE_PROTOABBREV_ZCL_MSG, dissect_zbee_zcl_msg, proto_zbee_zcl_msg); -} /*proto_register_zbee_zcl_msg*/ + /* Register the ZigBee ZCL Metering dissector. */ + met_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_MET, dissect_zbee_zcl_met, proto_zbee_zcl_met); +} /*proto_register_zbee_zcl_met*/ /** - *Hands off the Zcl Messaging dissector. + *Hands off the Zcl Metering dissector. * */ void -proto_reg_handoff_zbee_zcl_msg(void) +proto_reg_handoff_zbee_zcl_met(void) { - dissector_handle_t msg_handle; - /* Register our dissector with the ZigBee application dissectors. */ - msg_handle = find_dissector(ZBEE_PROTOABBREV_ZCL_MSG); - dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_MESSAGE, msg_handle); - - zbee_zcl_init_cluster( proto_zbee_zcl_msg, - ett_zbee_zcl_msg, - ZBEE_ZCL_CID_MESSAGE, - hf_zbee_zcl_msg_attr_id, - hf_zbee_zcl_msg_srv_rx_cmd_id, - hf_zbee_zcl_msg_srv_tx_cmd_id, - (zbee_zcl_fn_attr_data)dissect_zcl_msg_attr_data + dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_SIMPLE_METERING, met_handle); + + zbee_zcl_init_cluster( proto_zbee_zcl_met, + ett_zbee_zcl_met, + ZBEE_ZCL_CID_SIMPLE_METERING, + hf_zbee_zcl_met_attr_id, + hf_zbee_zcl_met_srv_rx_cmd_id, + hf_zbee_zcl_met_srv_tx_cmd_id, + (zbee_zcl_fn_attr_data)dissect_zcl_met_attr_data ); -} /*proto_reg_handoff_zbee_zcl_msg*/ +} /*proto_reg_handoff_zbee_zcl_met*/ /* ########################################################################## */ -/* #### (0x0704) TUNNELING CLUSTER ########################################### */ +/* #### (0x0703) MESSAGING CLUSTER ########################################## */ /* ########################################################################## */ -/* Attributes */ -#define ZBEE_ZCL_ATTR_ID_TUN_CLOSE_TIMEOUT 0x0000 /* Close Tunnel Timeout */ +/* Attributes - None (other than Attribute Reporting Status) */ +#define zbee_zcl_msg_attr_names_VALUE_STRING_LIST(XXX) \ +/* Smart Energy */ \ + XXX(ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_MSG, 0xFFFE, "Attribute Reporting Status" ) -static const value_string zbee_zcl_tun_attr_names[] = { - { ZBEE_ZCL_ATTR_ID_TUN_CLOSE_TIMEOUT, "Close Tunnel Timeout" }, - ZBEE_ZCL_SE_ATTR_NAMES, - { 0, NULL } -}; +VALUE_STRING_ENUM(zbee_zcl_msg_attr_names); +VALUE_STRING_ARRAY(zbee_zcl_msg_attr_names); /* Server Commands Received */ -#define ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL 0x00 /* Request Tunnel */ -#define ZBEE_ZCL_CMD_ID_TUN_CLOSE_TUNNEL 0x01 /* Close Tunnel */ -#define ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA 0x02 /* Transfer Data */ -#define ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR 0x03 /* Transfer Data Error */ -#define ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA 0x04 /* Ack Transfer Data */ -#define ZBEE_ZCL_CMD_ID_TUN_READY_DATA 0x05 /* Ready Data */ -#define ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS 0x06 /* Get Supported Tunnel Protocols */ +#define zbee_zcl_msg_srv_rx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_MSG_GET_LAST_MSG, 0x00, "Get Last Message" ) \ + XXX(ZBEE_ZCL_CMD_ID_MSG_MSG_CONFIRM, 0x01, "Message Confirmation" ) \ + XXX(ZBEE_ZCL_CMD_ID_MSG_GET_MESSAGE_CANCEL, 0x02, "Get Message Cancellation" ) + +VALUE_STRING_ENUM(zbee_zcl_msg_srv_rx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_msg_srv_rx_cmd_names); /* Server Commands Generated */ -#define ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL_RSP 0x00 /* Request Tunnel Response*/ -#define ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_TX 0x01 /* Transfer Data */ -#define ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR_TX 0x02 /* Transfer Data Error */ -#define ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA_TX 0x03 /* Ack Transfer Data */ -#define ZBEE_ZCL_CMD_ID_TUN_READY_DATA_TX 0x04 /* Ready Data */ -#define ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS_RSP 0x05 /* Get Supported Tunnel Protocols */ -#define ZBEE_ZCL_CMD_ID_TUN_CLOSURE_NOTIFY 0x06 /* Tunnel Closure Notification */ +#define zbee_zcl_msg_srv_tx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_MSG_DISPLAY_MSG, 0x00, "Display Message" ) \ + XXX(ZBEE_ZCL_CMD_ID_MSG_CANCEL_MSG, 0x01, "Cancel Message" ) \ + XXX(ZBEE_ZCL_CMD_ID_MSG_DISPLAY_PROTECTED_MSG, 0x02, "Display Protected Message" ) \ + XXX(ZBEE_ZCL_CMD_ID_MSG_CANCEL_ALL_MSG, 0x03, "Cancel All Messages" ) + +VALUE_STRING_ENUM(zbee_zcl_msg_srv_tx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_msg_srv_tx_cmd_names); + +/* Message Control Field Bit Map */ +#define ZBEE_ZCL_MSG_CTRL_TX_MASK 0x03 +#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MASK 0x0C +#define ZBEE_ZCL_MSG_CTRL_RESERVED_MASK 0x50 +#define ZBEE_ZCL_MSG_CTRL_ENHANCED_CONFIRM_MASK 0x20 +#define ZBEE_ZCL_MSG_CTRL_CONFIRM_MASK 0x80 + +#define ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ONLY 0x00 /* Normal Transmission Only */ +#define ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ANON_INTERPAN 0x01 /* Normal and Anonymous Inter-PAN Transmission Only */ +#define ZBEE_ZCL_MSG_CTRL_TX_ANON_INTERPAN_ONLY 0x02 /* Anonymous Inter-PAN Transmission Only */ + +#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_LOW 0x00 /* Low */ +#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MEDIUM 0x01 /* Medium */ +#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_HIGH 0x02 /* High */ +#define ZBEE_ZCL_MSG_CTRL_IMPORTANCE_CRITICAL 0x03 /* Critical */ + +#define ZBEE_ZCL_MSG_EXT_CTRL_STATUS_MASK 0x01 + +#define ZBEE_ZCL_MSG_CONFIRM_CTRL_MASK 0x01 + +#define ZBEE_ZCL_MSG_START_TIME_NOW 0x00000000 /* Now */ /*************************/ /* Function Declarations */ /*************************/ -void proto_register_zbee_zcl_tun(void); -void proto_reg_handoff_zbee_zcl_tun(void); +void proto_register_zbee_zcl_msg(void); +void proto_reg_handoff_zbee_zcl_msg(void); /* Attribute Dissector Helpers */ -static void dissect_zcl_tun_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); +static void dissect_zcl_msg_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); + +/* Command Dissector Helpers */ +static void dissect_zcl_msg_display (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_msg_cancel (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset); +static void dissect_zcl_msg_confirm (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_msg_cancel_all (tvbuff_t *tvb, proto_tree *tree, guint *offset); +static void dissect_zcl_msg_get_cancel (tvbuff_t *tvb, proto_tree *tree, guint *offset); /* Private functions prototype */ +static void decode_zcl_msg_duration (gchar *s, guint16 value); /*************************/ /* Global Variables */ /*************************/ +static dissector_handle_t msg_handle; + /* Initialize the protocol and registered fields */ -static int proto_zbee_zcl_tun = -1; +static int proto_zbee_zcl_msg = -1; -static int hf_zbee_zcl_tun_srv_tx_cmd_id = -1; -static int hf_zbee_zcl_tun_srv_rx_cmd_id = -1; -static int hf_zbee_zcl_tun_attr_id = -1; -static int hf_zbee_zcl_tun_attr_reporting_status = -1; -static int hf_zbee_zcl_tun_attr_close_timeout = -1; -static int hf_zbee_zcl_tun_protocol_id = -1; -static int hf_zbee_zcl_tun_manufacturer_code = -1; -static int hf_zbee_zcl_tun_flow_control_support = -1; -static int hf_zbee_zcl_tun_max_in_size = -1; -static int hf_zbee_zcl_tun_tunnel_id = -1; -static int hf_zbee_zcl_tun_num_octets_left = -1; -static int hf_zbee_zcl_tun_protocol_offset = -1; -static int hf_zbee_zcl_tun_protocol_list_complete = -1; -static int hf_zbee_zcl_tun_protocol_count = -1; -static int hf_zbee_zcl_tun_transfer_status = -1; -static int hf_zbee_zcl_tun_transfer_data = -1; -static int hf_zbee_zcl_tun_transfer_data_status = -1; +static int hf_zbee_zcl_msg_srv_tx_cmd_id = -1; +static int hf_zbee_zcl_msg_srv_rx_cmd_id = -1; +static int hf_zbee_zcl_msg_attr_id = -1; +static int hf_zbee_zcl_msg_attr_reporting_status = -1; +static int hf_zbee_zcl_msg_message_id = -1; +static int hf_zbee_zcl_msg_ctrl = -1; +static int hf_zbee_zcl_msg_ctrl_tx = -1; +static int hf_zbee_zcl_msg_ctrl_importance = -1; +static int hf_zbee_zcl_msg_ctrl_enh_confirm = -1; +static int hf_zbee_zcl_msg_ctrl_reserved = -1; +static int hf_zbee_zcl_msg_ctrl_confirm = -1; +static int hf_zbee_zcl_msg_ext_ctrl = -1; +static int hf_zbee_zcl_msg_ext_ctrl_status = -1; +static int hf_zbee_zcl_msg_start_time = -1; +static int hf_zbee_zcl_msg_duration = -1; +static int hf_zbee_zcl_msg_message_length = - 1; +static int hf_zbee_zcl_msg_message = -1; +static int hf_zbee_zcl_msg_confirm_time = -1; +static int hf_zbee_zcl_msg_confirm_ctrl = -1; +static int hf_zbee_zcl_msg_confirm_response = -1; +static int hf_zbee_zcl_msg_confirm_response_length = - 1; +static int hf_zbee_zcl_msg_implementation_time = -1; +static int hf_zbee_zcl_msg_earliest_time = -1; + +/* Initialize the subtree pointers */ +static gint ett_zbee_zcl_msg = -1; +static gint ett_zbee_zcl_msg_message_control = -1; +static gint ett_zbee_zcl_msg_ext_message_control = -1; + +static expert_field ei_zbee_zcl_msg_msg_ctrl_depreciated = EI_INIT; + +/* Message Control Transmission */ +static const value_string zbee_zcl_msg_ctrl_tx_names[] = { + { ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ONLY, "Normal Transmission Only" }, + { ZBEE_ZCL_MSG_CTRL_TX_NORMAL_ANON_INTERPAN, "Normal and Anonymous Inter-PAN Transmission Only" }, + { ZBEE_ZCL_MSG_CTRL_TX_ANON_INTERPAN_ONLY, "Anonymous Inter-PAN Transmission Only" }, + { 0, NULL } +}; + +/* Message Control Importance */ +static const value_string zbee_zcl_msg_ctrl_importance_names[] = { + { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_LOW, "Low" }, + { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MEDIUM, "Medium" }, + { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_HIGH, "High" }, + { ZBEE_ZCL_MSG_CTRL_IMPORTANCE_CRITICAL, "Critical" }, + { 0, NULL } +}; + +/*************************/ +/* Function Bodies */ +/*************************/ + +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ +static void +dissect_zcl_msg_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) +{ + switch (attr_id) { + /* no cluster specific attributes */ + + /* applies to all SE clusters */ + case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_MSG: + proto_tree_add_item(tree, hf_zbee_zcl_msg_attr_reporting_status, tvb, *offset, 1, ENC_NA); + *offset += 1; + break; + + default: /* Catch all */ + dissect_zcl_attr_data(tvb, tree, offset, data_type); + break; + } +} /*dissect_zcl_ias_zone_attr_data*/ + +/** + *ZigBee ZCL Messaging cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ +static int +dissect_zbee_zcl_msg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) +{ + proto_tree *payload_tree; + zbee_zcl_packet *zcl; + guint offset = 0; + guint8 cmd_id; + gint rem_len; + + /* Reject the packet if data is NULL */ + if (data == NULL) + return 0; + zcl = (zbee_zcl_packet *)data; + cmd_id = zcl->cmd_id; + + /* Create a subtree for the ZCL Command frame, and add the command ID to it. */ + if (zcl->direction == ZBEE_ZCL_FCF_TO_SERVER) { + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_msg_srv_rx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_msg_srv_rx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_msg, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_MSG_GET_LAST_MSG: + /* No payload */ + break; + + case ZBEE_ZCL_CMD_ID_MSG_MSG_CONFIRM: + dissect_zcl_msg_confirm(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MSG_GET_MESSAGE_CANCEL: + dissect_zcl_msg_get_cancel(tvb, payload_tree, &offset); + break; + + default: + break; + } + } + } + else { /* ZBEE_ZCL_FCF_TO_CLIENT */ + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_msg_srv_tx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_msg_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_msg, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_MSG_DISPLAY_MSG: + dissect_zcl_msg_display(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MSG_CANCEL_MSG: + dissect_zcl_msg_cancel(tvb, pinfo, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MSG_DISPLAY_PROTECTED_MSG: + dissect_zcl_msg_display(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_MSG_CANCEL_ALL_MSG: + dissect_zcl_msg_cancel_all(tvb, payload_tree, &offset); + break; + + default: + break; + } + } + } + + return tvb_captured_length(tvb); +} /*dissect_zbee_zcl_msg*/ + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_msg_display(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + guint msg_len; + guint8 *msg_data; + + static const int * message_ctrl_flags[] = { + &hf_zbee_zcl_msg_ctrl_tx, + &hf_zbee_zcl_msg_ctrl_importance, + &hf_zbee_zcl_msg_ctrl_enh_confirm, + &hf_zbee_zcl_msg_ctrl_reserved, + &hf_zbee_zcl_msg_ctrl_confirm, + NULL + }; + + static const int * message_ext_ctrl_flags[] = { + &hf_zbee_zcl_msg_ext_ctrl_status, + NULL + }; + + /* Message ID */ + proto_tree_add_item(tree, hf_zbee_zcl_msg_message_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; + + /* Message Control */ + proto_tree_add_bitmask(tree, tvb, *offset, hf_zbee_zcl_msg_ctrl, ett_zbee_zcl_msg_message_control, message_ctrl_flags, ENC_NA); + *offset += 1; + + /* Start Time */ + proto_tree_add_item(tree, hf_zbee_zcl_msg_start_time, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; + + /* Duration In Minutes*/ + proto_tree_add_item(tree, hf_zbee_zcl_msg_duration, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + /* Message Length */ + msg_len = tvb_get_guint8(tvb, *offset); /* string length */ + proto_tree_add_item(tree, hf_zbee_zcl_msg_message_length, tvb, *offset, 1, ENC_NA); + *offset += 1; + + /* Message */ + msg_data = tvb_get_string_enc(wmem_packet_scope(), tvb, *offset, msg_len, ENC_LITTLE_ENDIAN); + proto_tree_add_string(tree, hf_zbee_zcl_msg_message, tvb, *offset, msg_len, msg_data); + *offset += msg_len; + + /* (Optional) Extended Message Control */ + if (tvb_reported_length_remaining(tvb, *offset) > 0) { + proto_tree_add_bitmask(tree, tvb, *offset, hf_zbee_zcl_msg_ext_ctrl, ett_zbee_zcl_msg_ext_message_control, message_ext_ctrl_flags, ENC_NA); + *offset += 1; + } + +} /*dissect_zcl_msg_display*/ + +/** + *This function manages the Cancel Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_msg_cancel(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint *offset) +{ + gint8 msg_ctrl; + + /* Message ID */ + proto_tree_add_item(tree, hf_zbee_zcl_msg_message_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; + + /* Message Control */ + msg_ctrl = tvb_get_guint8(tvb, *offset); + proto_tree_add_item(tree, hf_zbee_zcl_msg_ctrl, tvb, *offset, 1, ENC_NA); + *offset += 1; + + if (msg_ctrl != 0x00) { + expert_add_info(pinfo, tree, &ei_zbee_zcl_msg_msg_ctrl_depreciated); + } + +} /* dissect_zcl_msg_cancel */ + + +/** + *Send Cancel All command + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_msg_cancel_all(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + nstime_t impl_time; + + /* Retrieve "Confirmation Time" field */ + impl_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + impl_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_msg_implementation_time, tvb, *offset, 4, &impl_time); + *offset += 4; + +} /* dissect_zcl_msg_cancel_all */ + +/** + *Send Cancel All command + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_msg_get_cancel(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + nstime_t impl_time; + + /* Earliest Implementation Time */ + impl_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + impl_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_msg_earliest_time, tvb, *offset, 4, &impl_time); + *offset += 4; + +} /* dissect_zcl_msg_get_cancel */ + + +/** + *This function manages the Message Confirmation payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_msg_confirm(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + guint msg_len; + guint8 *msg_data; + nstime_t confirm_time; + + /* Retrieve "Message ID" field */ + proto_tree_add_item(tree, hf_zbee_zcl_msg_message_id, tvb, *offset, 4, ENC_LITTLE_ENDIAN); + *offset += 4; + + /* Retrieve "Confirmation Time" field */ + confirm_time.secs = (time_t)tvb_get_letohl(tvb, *offset) + ZBEE_ZCL_NSTIME_UTC_OFFSET; + confirm_time.nsecs = 0; + proto_tree_add_time(tree, hf_zbee_zcl_msg_confirm_time, tvb, *offset, 4, &confirm_time); + *offset += 4; + + /* (Optional) Confirm Control */ + if ( tvb_reported_length_remaining(tvb, *offset) <= 0 ) return; + proto_tree_add_item(tree, hf_zbee_zcl_msg_confirm_ctrl, tvb, *offset, 1, ENC_NA); + *offset += 1; + + /* (Optional) Response Text Length */ + if ( tvb_reported_length_remaining(tvb, *offset) <= 0 ) return; + msg_len = tvb_get_guint8(tvb, *offset); /* string length */ + proto_tree_add_item(tree, hf_zbee_zcl_msg_confirm_response_length, tvb, *offset, 1, ENC_NA); + *offset += 1; + + /* (Optional) Response Text, but is we have a length we expect to find the subsequent string */ + if (msg_len > 0) { + msg_data = tvb_get_string_enc(wmem_packet_scope(), tvb, *offset, msg_len, ENC_LITTLE_ENDIAN); + proto_tree_add_string(tree, hf_zbee_zcl_msg_confirm_response, tvb, *offset, msg_len, msg_data); + *offset += msg_len; + } + +} /* dissect_zcl_msg_confirm */ + +/** + *This function decodes duration in minute type variable + * +*/ +static void +decode_zcl_msg_duration(gchar *s, guint16 value) +{ + if (value == 0xffff) + g_snprintf(s, ITEM_LABEL_LENGTH, "Until changed"); + else + g_snprintf(s, ITEM_LABEL_LENGTH, "%d minutes", value); + return; +} /*decode_zcl_msg_duration*/ + +/** + * This function decodes start time, with a special case for + * ZBEE_ZCL_MSG_START_TIME_NOW. + * + * @param s string to display + * @param value value to decode +*/ +static void +decode_zcl_msg_start_time(gchar *s, guint32 value) +{ + if (value == ZBEE_ZCL_MSG_START_TIME_NOW) + g_snprintf(s, ITEM_LABEL_LENGTH, "Now"); + else { + gchar *start_time; + time_t epoch_time = (time_t)value + ZBEE_ZCL_NSTIME_UTC_OFFSET; + start_time = abs_time_secs_to_str (NULL, epoch_time, ABSOLUTE_TIME_LOCAL, TRUE); + g_snprintf(s, ITEM_LABEL_LENGTH, "%s", start_time); + wmem_free(NULL, start_time); + } +} /* decode_zcl_msg_start_time */ + +/** + *This function registers the ZCL Messaging dissector + * +*/ +void +proto_register_zbee_zcl_msg(void) +{ + static hf_register_info hf[] = { + + { &hf_zbee_zcl_msg_attr_id, + { "Attribute", "zbee_zcl_se.msg.attr_id", FT_UINT16, BASE_HEX, VALS(zbee_zcl_msg_attr_names), + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_attr_reporting_status, /* common to all SE clusters */ + { "Attribute Reporting Status", "zbee_zcl_se.msg.attr.attr_reporting_status", + FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_srv_tx_cmd_id, + { "Command", "zbee_zcl_se.msg.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_srv_tx_cmd_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_srv_rx_cmd_id, + { "Command", "zbee_zcl_se.msg.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_srv_rx_cmd_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_message_id, + { "Message ID", "zbee_zcl_se.msg.message.id", FT_UINT32, BASE_HEX, NULL, + 0x00, NULL, HFILL } }, + +/* Start of 'Message Control' fields */ + { &hf_zbee_zcl_msg_ctrl, + { "Message Control", "zbee_zcl_se.msg.message.ctrl", FT_UINT8, BASE_HEX, NULL, + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_ctrl_tx, + { "Transmission", "zbee_zcl_se.msg.message.ctrl.tx", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_ctrl_tx_names), + ZBEE_ZCL_MSG_CTRL_TX_MASK, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_ctrl_importance, + { "Importance", "zbee_zcl_se.msg.message.ctrl.importance", FT_UINT8, BASE_HEX, VALS(zbee_zcl_msg_ctrl_importance_names), + ZBEE_ZCL_MSG_CTRL_IMPORTANCE_MASK, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_ctrl_enh_confirm, + { "Confirmation", "zbee_zcl_se.msg.message.ctrl.enhconfirm", FT_BOOLEAN, 8, TFS(&tfs_required_not_required), + ZBEE_ZCL_MSG_CTRL_ENHANCED_CONFIRM_MASK, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_ctrl_reserved, + { "Reserved", "zbee_zcl_se.msg.message.ctrl.reserved", FT_UINT8, BASE_HEX, NULL, + ZBEE_ZCL_MSG_CTRL_RESERVED_MASK, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_ctrl_confirm, + { "Confirmation", "zbee_zcl_se.msg.message.ctrl.confirm", FT_BOOLEAN, 8, TFS(&tfs_required_not_required), + ZBEE_ZCL_MSG_CTRL_CONFIRM_MASK, NULL, HFILL } }, +/* End of 'Message Control' fields */ + +/* Start of 'Extended Message Control' fields */ + { &hf_zbee_zcl_msg_ext_ctrl, + { "Extended Message Control", "zbee_zcl_se.msg.message.ext.ctrl", FT_UINT8, BASE_HEX, NULL, + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_ext_ctrl_status, + { "Message Confirmation Status", "zbee_zcl_se.msg.message.ext.ctrl.status", FT_BOOLEAN, 8, TFS(&tfs_confirmed_unconfirmed), + ZBEE_ZCL_MSG_EXT_CTRL_STATUS_MASK, NULL, HFILL } }, +/* End of 'Extended Message Control' fields */ + + { &hf_zbee_zcl_msg_start_time, + { "Start Time", "zbee_zcl_se.msg.message.start_time", FT_UINT32, BASE_CUSTOM, CF_FUNC(decode_zcl_msg_start_time), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_duration, + { "Duration", "zbee_zcl_se.msg.message.duration", FT_UINT16, BASE_CUSTOM, CF_FUNC(decode_zcl_msg_duration), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_message_length, + { "Message Length", "zbee_zcl_se.msg.message.length", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_message, + { "Message", "zbee_zcl_se.msg.message", FT_STRING, BASE_NONE, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_confirm_time, + { "Confirmation Time", "zbee_zcl_se.msg.message.confirm_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_LOCAL, NULL, + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_confirm_ctrl, + { "Confirmation Control", "zbee_zcl_se.msg.message.confirm.ctrl", FT_BOOLEAN, 8, TFS(&tfs_no_yes), + ZBEE_ZCL_MSG_CONFIRM_CTRL_MASK, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_confirm_response_length, + { "Response Length", "zbee_zcl_se.msg.message.length", FT_UINT8, BASE_DEC, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_confirm_response, + { "Response", "zbee_zcl_se.msg.message", FT_STRING, BASE_NONE, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_implementation_time, + { "Implementation Time", "zbee_zcl_se.msg.impl_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, + 0, NULL, HFILL } }, + + { &hf_zbee_zcl_msg_earliest_time, + { "Earliest Implementation Time", "zbee_zcl_se.msg.earliest_impl_time", FT_ABSOLUTE_TIME, ABSOLUTE_TIME_UTC, NULL, + 0, NULL, HFILL } }, + + }; + + /* ZCL Messaging subtrees */ + gint *ett[] = { + &ett_zbee_zcl_msg, + &ett_zbee_zcl_msg_message_control, + &ett_zbee_zcl_msg_ext_message_control, + }; + + /* Expert Info */ + expert_module_t* expert_zbee_zcl_msg; + static ei_register_info ei[] = { + { &ei_zbee_zcl_msg_msg_ctrl_depreciated, { "zbee_zcl_se.msg.msg_ctrl.depreciated", PI_PROTOCOL, PI_WARN, "Message Control depreciated in this message, should be 0x00", EXPFILL }}, + }; + + /* Register the ZigBee ZCL Messaging cluster protocol name and description */ + proto_zbee_zcl_msg = proto_register_protocol("ZigBee ZCL Messaging", "ZCL Messaging", ZBEE_PROTOABBREV_ZCL_MSG); + proto_register_field_array(proto_zbee_zcl_msg, hf, array_length(hf)); + proto_register_subtree_array(ett, array_length(ett)); + + expert_zbee_zcl_msg = expert_register_protocol(proto_zbee_zcl_msg); + expert_register_field_array(expert_zbee_zcl_msg, ei, array_length(ei)); + + /* Register the ZigBee ZCL Messaging dissector. */ + msg_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_MSG, dissect_zbee_zcl_msg, proto_zbee_zcl_msg); +} /*proto_register_zbee_zcl_msg*/ + +/** + *Hands off the Zcl Messaging dissector. + * +*/ +void +proto_reg_handoff_zbee_zcl_msg(void) +{ + /* Register our dissector with the ZigBee application dissectors. */ + dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_MESSAGE, msg_handle); + + zbee_zcl_init_cluster( proto_zbee_zcl_msg, + ett_zbee_zcl_msg, + ZBEE_ZCL_CID_MESSAGE, + hf_zbee_zcl_msg_attr_id, + hf_zbee_zcl_msg_srv_rx_cmd_id, + hf_zbee_zcl_msg_srv_tx_cmd_id, + (zbee_zcl_fn_attr_data)dissect_zcl_msg_attr_data + ); +} /*proto_reg_handoff_zbee_zcl_msg*/ + +/* ########################################################################## */ +/* #### (0x0704) TUNNELING CLUSTER ########################################### */ +/* ########################################################################## */ + +/* Attributes */ +#define zbee_zcl_tun_attr_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_ATTR_ID_TUN_CLOSE_TIMEOUT, 0x0000, "Close Tunnel Timeout" ) \ +/* Smart Energy */ \ + XXX(ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_TUN, 0xFFFE, "Attribute Reporting Status" ) + +VALUE_STRING_ENUM(zbee_zcl_tun_attr_names); +VALUE_STRING_ARRAY(zbee_zcl_tun_attr_names); + +/* Server Commands Received */ +#define zbee_zcl_tun_srv_rx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL, 0x00, "Request Tunnel" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_CLOSE_TUNNEL, 0x01, "Close Tunnel" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA, 0x02, "Transfer Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR, 0x03, "Transfer Data Error" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA, 0x04, "Ack Transfer Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_READY_DATA, 0x05, "Ready Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS, 0x06, "Get Supported Protocols" ) + +VALUE_STRING_ENUM(zbee_zcl_tun_srv_rx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_tun_srv_rx_cmd_names); + +/* Server Commands Generated */ +#define zbee_zcl_tun_srv_tx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL_RSP, 0x00, "Request Tunnel Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_TX, 0x01, "Transfer Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR_TX, 0x02, "Transfer Data Error" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA_TX, 0x03, "Ack Transfer Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_READY_DATA_TX, 0x04, "Ready Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS_RSP, 0x05, "Get Supported Tunnel Protocols" ) \ + XXX(ZBEE_ZCL_CMD_ID_TUN_CLOSURE_NOTIFY, 0x06, "Tunnel Closure Notification" ) + +VALUE_STRING_ENUM(zbee_zcl_tun_srv_tx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_tun_srv_tx_cmd_names); + +/*************************/ +/* Function Declarations */ +/*************************/ +void proto_register_zbee_zcl_tun(void); +void proto_reg_handoff_zbee_zcl_tun(void); + +/* Attribute Dissector Helpers */ +static void dissect_zcl_tun_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); + +/* Private functions prototype */ + +/*************************/ +/* Global Variables */ +/*************************/ + +static dissector_handle_t tun_handle; + +/* Initialize the protocol and registered fields */ +static int proto_zbee_zcl_tun = -1; + +static int hf_zbee_zcl_tun_srv_tx_cmd_id = -1; +static int hf_zbee_zcl_tun_srv_rx_cmd_id = -1; +static int hf_zbee_zcl_tun_attr_id = -1; +static int hf_zbee_zcl_tun_attr_reporting_status = -1; +static int hf_zbee_zcl_tun_attr_close_timeout = -1; +static int hf_zbee_zcl_tun_protocol_id = -1; +static int hf_zbee_zcl_tun_manufacturer_code = -1; +static int hf_zbee_zcl_tun_flow_control_support = -1; +static int hf_zbee_zcl_tun_max_in_size = -1; +static int hf_zbee_zcl_tun_tunnel_id = -1; +static int hf_zbee_zcl_tun_num_octets_left = -1; +static int hf_zbee_zcl_tun_protocol_offset = -1; +static int hf_zbee_zcl_tun_protocol_list_complete = -1; +static int hf_zbee_zcl_tun_protocol_count = -1; +static int hf_zbee_zcl_tun_transfer_status = -1; +static int hf_zbee_zcl_tun_transfer_data = -1; +static int hf_zbee_zcl_tun_transfer_data_status = -1; + +/* Initialize the subtree pointers */ +static gint ett_zbee_zcl_tun = -1; + +/* Subdissector handles. */ +static dissector_handle_t ipv4_handle; +static dissector_handle_t ipv6_handle; + +#define zbee_zcl_tun_protocol_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_TUN_PROTO_DLMS, 0x00, "DLMS/COSEM (IEC 62056)" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_IEC_61107, 0x01, "IEC 61107" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_ANSI_C12, 0x02, "ANSI C12" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_M_BUS, 0x03, "M-BUS" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_SML, 0x04, "SML" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_CLIMATE_TALK, 0x05, "ClimateTalk" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_GB_HRGP, 0x06, "GB-HRGP" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_IPV6, 0x07, "IPv6" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_IPV4, 0x08, "IPv4" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_NULL, 0x09, "null" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_TEST, 199, "test" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_MANUFACTURER, 200, "Manufacturer Specific" ) \ + XXX(ZBEE_ZCL_TUN_PROTO_RESERVED, 0xFF, "Reserved" ) + +VALUE_STRING_ENUM(zbee_zcl_tun_protocol_names); +VALUE_STRING_ARRAY(zbee_zcl_tun_protocol_names); + +#define zbee_zcl_tun_trans_data_status_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_TUN_TRANS_STATUS_NO_TUNNEL, 0x00, "Tunnel ID Does Not Exist" ) \ + XXX(ZBEE_ZCL_TUN_TRANS_STATUS_WRONG_DEV, 0x01, "Wrong Device" ) \ + XXX(ZBEE_ZCL_TUN_TRANS_STATUS_OVERFLOW, 0x02, "Data Overflow" ) + +VALUE_STRING_ENUM(zbee_zcl_tun_trans_data_status_names); +VALUE_STRING_ARRAY(zbee_zcl_tun_trans_data_status_names); + +#define zbee_zcl_tun_status_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_TUN_STATUS_SUCCESS, 0x00, "Success" ) \ + XXX(ZBEE_ZCL_TUN_STATUS_BUSY, 0x01, "Busy" ) \ + XXX(ZBEE_ZCL_TUN_STATUS_NO_MORE_IDS, 0x02, "No More Tunnel IDs" ) \ + XXX(ZBEE_ZCL_TUN_STATUS_PROTO_NOT_SUPP, 0x03, "Protocol Not Supported" ) \ + XXX(ZBEE_ZCL_TUN_STATUS_FLOW_CONTROL_NOT_SUPP, 0x04, "Flow Control Not Supported" ) + +VALUE_STRING_ENUM(zbee_zcl_tun_status_names); +VALUE_STRING_ARRAY(zbee_zcl_tun_status_names); + +/*************************/ +/* Function Bodies */ +/*************************/ + +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ +static void +dissect_zcl_tun_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) +{ + switch (attr_id) { + /* cluster specific attributes */ + case ZBEE_ZCL_ATTR_ID_TUN_CLOSE_TIMEOUT: + proto_tree_add_item(tree, hf_zbee_zcl_tun_attr_close_timeout, tvb, *offset, 2, ENC_NA); + *offset += 2; + break; + + /* applies to all SE clusters */ + case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_TUN: + proto_tree_add_item(tree, hf_zbee_zcl_tun_attr_reporting_status, tvb, *offset, 1, ENC_NA); + *offset += 1; + break; + + default: /* Catch all */ + dissect_zcl_attr_data(tvb, tree, offset, data_type); + break; + } +} /*dissect_zcl_ias_zone_attr_data*/ + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_request_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_id, tvb, *offset, 1, ENC_NA); + *offset += 1; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_manufacturer_code, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_flow_control_support, tvb, *offset, 1, ENC_NA); + *offset += 1; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_max_in_size, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_close_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + gint length; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + length = tvb_reported_length_remaining(tvb, *offset); + proto_tree_add_item(tree, hf_zbee_zcl_tun_transfer_data, tvb, *offset, length, ENC_NA); + *offset += length; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_transfer_data_error(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_transfer_data_status, tvb, *offset, 1, ENC_NA); + *offset += 1; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_ack_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_num_octets_left, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_ready_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_num_octets_left, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_get_supported(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_offset, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_request_tunnel_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_transfer_status, tvb, *offset, 1, ENC_NA); + *offset += 1; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_max_in_size, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_get_supported_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + guint16 mfg_code; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_list_complete, tvb, *offset, 1, ENC_NA); + *offset += 1; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_count, tvb, *offset, 1, ENC_NA); + *offset += 1; + + while (tvb_reported_length_remaining(tvb, *offset) > 0) { + mfg_code = tvb_get_letohs(tvb, *offset); + if (mfg_code == 0xFFFF) { + proto_tree_add_string(tree, hf_zbee_zcl_tun_manufacturer_code, tvb, *offset, 2, "Standard Protocol (Mfg Code 0xFFFF)"); + } + else { + proto_tree_add_item(tree, hf_zbee_zcl_tun_manufacturer_code, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + } + *offset += 2; + + proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_id, tvb, *offset, 1, ENC_NA); + *offset += 1; + } +} + +/** + *This function manages the Display Message payload + * + *@param tvb pointer to buffer containing raw packet. + *@param tree pointer to data tree Wireshark uses to display packet. + *@param offset pointer to offset from caller +*/ +static void +dissect_zcl_tun_closure_notify(tvbuff_t *tvb, proto_tree *tree, guint *offset) +{ + proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); + *offset += 2; +} + +/** + *ZigBee ZCL Messaging cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ +static int +dissect_zbee_zcl_tun(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) +{ + proto_tree *payload_tree; + zbee_zcl_packet *zcl; + guint offset = 0; + guint8 cmd_id; + gint rem_len; + + /* Reject the packet if data is NULL */ + if (data == NULL) + return 0; + zcl = (zbee_zcl_packet *)data; + cmd_id = zcl->cmd_id; + + /* Create a subtree for the ZCL Command frame, and add the command ID to it. */ + if (zcl->direction == ZBEE_ZCL_FCF_TO_SERVER) { + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_tun_srv_rx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_tun_srv_rx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_tun, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL: + dissect_zcl_tun_request_tunnel(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_CLOSE_TUNNEL: + dissect_zcl_tun_close_tunnel(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA: + dissect_zcl_tun_transfer_data(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR: + dissect_zcl_tun_transfer_data_error(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA: + dissect_zcl_tun_ack_transfer_data(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_READY_DATA: + dissect_zcl_tun_ready_data(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS: + dissect_zcl_tun_get_supported(tvb, payload_tree, &offset); + break; + + default: + break; + } + } + } + else { /* ZBEE_ZCL_FCF_TO_CLIENT */ + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_tun_srv_tx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_tun_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_tun, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL_RSP: + dissect_zcl_tun_request_tunnel_rsp(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_TX: + dissect_zcl_tun_transfer_data(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR_TX: + dissect_zcl_tun_transfer_data_error(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA_TX: + dissect_zcl_tun_ack_transfer_data(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_READY_DATA_TX: + dissect_zcl_tun_ready_data(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS_RSP: + dissect_zcl_tun_get_supported_rsp(tvb, payload_tree, &offset); + break; + + case ZBEE_ZCL_CMD_ID_TUN_CLOSURE_NOTIFY: + dissect_zcl_tun_closure_notify(tvb, payload_tree, &offset); + break; + + default: + break; + } + } + } + + return tvb_captured_length(tvb); +} /*dissect_zbee_zcl_tun*/ + +/** + *This function registers the ZCL Messaging dissector + * +*/ +void +proto_register_zbee_zcl_tun(void) +{ + static hf_register_info hf[] = { + + { &hf_zbee_zcl_tun_attr_id, + { "Attribute", "zbee_zcl_se.tun.attr_id", FT_UINT16, BASE_HEX, VALS(zbee_zcl_tun_attr_names), + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_attr_reporting_status, /* common to all SE clusters */ + { "Attribute Reporting Status", "zbee_zcl_se.tun.attr.attr_reporting_status", + FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_attr_close_timeout, + { "Close Tunnel Timeout", "zbee_zcl_se.tun.attr.close_tunnel", FT_UINT16, BASE_DEC, NULL, + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_srv_tx_cmd_id, + { "Command", "zbee_zcl_se.tun.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_srv_tx_cmd_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_srv_rx_cmd_id, + { "Command", "zbee_zcl_se.tun.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_srv_rx_cmd_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_protocol_id, + { "Protocol ID", "zbee_zcl_se.tun.protocol_id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_protocol_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_manufacturer_code, + { "Manufacturer Code", "zbee_zcl_se.tun.manufacturer_code", FT_UINT16, BASE_HEX, VALS(zbee_mfr_code_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_flow_control_support, + { "Flow Control Supported", "zbee_zcl_se.tun.flow_control_supported", FT_BOOLEAN, 8, TFS(&tfs_true_false), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_max_in_size, + { "Max Incoming Transfer Size", "zbee_zcl_se.tun.max_in_transfer_size", FT_UINT16, BASE_HEX, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_tunnel_id, + { "Tunnel Id", "zbee_zcl_se.tun.tunnel_id", FT_UINT16, BASE_HEX, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_num_octets_left, + { "Num Octets Left", "zbee_zcl_se.tun.octets_left", FT_UINT16, BASE_HEX, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_protocol_offset, + { "Protocol Offset", "zbee_zcl_se.tun.protocol_offset", FT_UINT8, BASE_HEX, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_transfer_status, + { "Transfer Status", "zbee_zcl_se.tun.transfer_status", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_status_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_transfer_data, + { "Transfer Data", "zbee_zcl_se.tun.transfer_data", FT_BYTES, BASE_NONE, NULL, + 0, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_transfer_data_status, + { "Transfer Data Status", "zbee_zcl_se.tun.transfer_data_status", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_trans_data_status_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_protocol_count, + { "Protocol Count", "zbee_zcl_se.tun.protocol_count", FT_UINT8, BASE_HEX, NULL, + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_tun_protocol_list_complete, + { "List Complete", "zbee_zcl_se.tun.protocol_list_complete", FT_BOOLEAN, 8, TFS(&tfs_true_false), + 0x00, NULL, HFILL } }, + + }; + + /* ZCL Messaging subtrees */ + gint *ett[] = { + &ett_zbee_zcl_tun, + }; + + /* Register the ZigBee ZCL Messaging cluster protocol name and description */ + proto_zbee_zcl_tun = proto_register_protocol("ZigBee ZCL Tunneling", "ZCL Tunneling", ZBEE_PROTOABBREV_ZCL_TUN); + proto_register_field_array(proto_zbee_zcl_tun, hf, array_length(hf)); + proto_register_subtree_array(ett, array_length(ett)); + + /* Register the ZigBee ZCL Messaging dissector. */ + tun_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_TUN, dissect_zbee_zcl_tun, proto_zbee_zcl_tun); + +} /* proto_register_zbee_zcl_tun */ + +/** + *Hands off the Zcl Messaging dissector. + * +*/ +void +proto_reg_handoff_zbee_zcl_tun(void) +{ + ipv4_handle = find_dissector("ipv4"); + ipv6_handle = find_dissector("ipv6"); + + /* Register our dissector with the ZigBee application dissectors. */ + dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_TUNNELING, tun_handle); + + zbee_zcl_init_cluster( proto_zbee_zcl_tun, + ett_zbee_zcl_tun, + ZBEE_ZCL_CID_TUNNELING, + hf_zbee_zcl_tun_attr_id, + hf_zbee_zcl_tun_srv_rx_cmd_id, + hf_zbee_zcl_tun_srv_tx_cmd_id, + (zbee_zcl_fn_attr_data)dissect_zcl_tun_attr_data + ); +} /* proto_reg_handoff_zbee_zcl_tun */ + + +/* ########################################################################## */ +/* #### (0x0705) PREPAYMENT CLUSTER ########################################## */ +/* ########################################################################## */ + +/* Attributes */ +#define zbee_zcl_pp_attr_names_VALUE_STRING_LIST(XXX) \ +/* Prepayment Information Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PAYMENT_CONTROL_CONFIGURATION, 0x0000, "Payment Control Configuration" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CREDIT_REMAINING, 0x0001, "Credit Remaining" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_EMERGENCY_CREDIT_REMAINING, 0x0002, "Emergency Credit Remaining" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_ACCUMULATED_DEBT, 0x0005, "Accumulated Debt" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_OVERALL_DEBT_CAP, 0x0006, "Overall Debt Cap" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_EMERGENCY_CREDIT_LIMIT, 0x0010, "Emergency Credit Limit / Allowance" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_EMERGENCY_CREDIT_THRESHOLD, 0x0011, "Emergency Credit Threshold" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_MAX_CREDIT_LIMIT, 0x0021, "Max Credit Limit" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_MAX_CREDIT_PER_TOPUP, 0x0022, "Max Credit Per Top Up" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_LOW_CREDIT_WARNING, 0x0031, "Low Credit Warning" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CUT_OFF_VALUE, 0x0040, "Cut Off Value" ) \ +/* Debt Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_AMOUNT_1, 0x0211, "Debt Amount 1" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_FREQ_1, 0x0216, "Debt Recovery Frequency 1" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_AMOUNT_1, 0x0217, "Debt Recovery Amount 1" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_TOP_UP_PERCENTAGE_1, 0x0219, "Debt Recovery Top Up Percentage 1" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_AMOUNT_2, 0x0221, "Debt Amount 2" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_FREQ_2, 0x0226, "Debt Recovery Frequency 2" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_AMOUNT_2, 0x0227, "Debt Recovery Amount 2" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_TOP_UP_PERCENTAGE_2, 0x0229, "Debt Recovery Top Up Percentage 2" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_AMOUNT_3, 0x0231, "Debt Amount 3" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_FREQ_3, 0x0236, "Debt Recovery Frequency 3" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_AMOUNT_3, 0x0237, "Debt Recovery Amount 3" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_DEBT_RECOVERY_TOP_UP_PERCENTAGE_3, 0x0239, "Debt Recovery Top Up Percentage 3" ) \ +/* Alarm Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREPAYMENT_ALARM_STATUS, 0x0400, "Prepayment Alarm Status" ) \ +/* Historical Cost Consumption Information Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_PP_HISTORICAL_COST_CON_FORMAT, 0x0500, "Historical Cost Consumption Formatting" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CONSUMPTION_UNIT_OF_MEASUREMENT, 0x0501, "Consumption Unit of Measurement" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CURRENCY_SCALING_FACTOR, 0x0502, "Currency Scaling Factor" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CURRENCY, 0x0503, "Currency" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CURRENT_DAY_COST_CON_DELIVERED, 0x051C, "Current Day Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_COST_CON_DELIVERED, 0x051E, "Previous Day Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_2_COST_CON_DELIVERED, 0x0520, "Previous Day 2 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_3_COST_CON_DELIVERED, 0x0522, "Previous Day 3 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_4_COST_CON_DELIVERED, 0x0524, "Previous Day 4 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_5_COST_CON_DELIVERED, 0x0526, "Previous Day 5 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_6_COST_CON_DELIVERED, 0x0528, "Previous Day 6 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_7_COST_CON_DELIVERED, 0x052A, "Previous Day 7 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_DAY_8_COST_CON_DELIVERED, 0x052C, "Previous Day 8 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CURRENT_WEEK_COST_CON_DELIVERED, 0x0530, "Current Week Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_WEEK_COST_CON_DELIVERED, 0x0532, "Previous Week Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_WEEK_2_COST_CON_DELIVERED, 0x0534, "Previous Week 2 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_WEEK_3_COST_CON_DELIVERED, 0x0536, "Previous Week 3 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_WEEK_4_COST_CON_DELIVERED, 0x0538, "Previous Week 4 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_WEEK_5_COST_CON_DELIVERED, 0x053A, "Previous Week 5 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_CURRENT_MON_COST_CON_DELIVERED, 0x0540, "Current Month Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_COST_CON_DELIVERED, 0x0542, "Previous Month Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_2_COST_CON_DELIVERED, 0x0544, "Previous Month 2 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_3_COST_CON_DELIVERED, 0x0546, "Previous Month 3 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_4_COST_CON_DELIVERED, 0x0548, "Previous Month 4 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_5_COST_CON_DELIVERED, 0x054A, "Previous Month 5 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_6_COST_CON_DELIVERED, 0x054C, "Previous Month 6 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_7_COST_CON_DELIVERED, 0x054E, "Previous Month 7 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_8_COST_CON_DELIVERED, 0x0550, "Previous Month 8 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_9_COST_CON_DELIVERED, 0x0552, "Previous Month 9 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_10_COST_CON_DELIVERED, 0x0554, "Previous Month 10 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_11_COST_CON_DELIVERED, 0x0556, "Previous Month 11 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_12_COST_CON_DELIVERED, 0x0558, "Previous Month 12 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_PREVIOUS_MON_13_COST_CON_DELIVERED, 0x055A, "Previous Month 13 Cost Consumption Delivered" ) \ + XXX(ZBEE_ZCL_ATTR_ID_PP_HISTORICAL_FREEZE_TIME, 0x055C, "Historical Freeze Time" ) \ +/* Smart Energy */ \ + XXX(ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_PP, 0xFFFE, "Attribute Reporting Status" ) + +VALUE_STRING_ENUM(zbee_zcl_pp_attr_names); +VALUE_STRING_ARRAY(zbee_zcl_pp_attr_names); +static value_string_ext zbee_zcl_pp_attr_names_ext = VALUE_STRING_EXT_INIT(zbee_zcl_pp_attr_names); + +/* Server Commands Received */ +#define zbee_zcl_pp_srv_rx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_PP_SELECT_AVAILABLE_EMERGENCY_CREDIT, 0x00, "Select Available Emergency Credit" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_CHANGE_DEBT, 0x02, "Change Debt" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_EMERGENCY_CREDIT_SETUP, 0x03, "Emergency Credit Setup" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_CONSUMER_TOP_UP, 0x04, "Consumer Top Up" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_CREDIT_ADJUSTMENT, 0x05, "Credit Adjustment" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_CHANGE_PAYMENT_MODE, 0x06, "Change Payment Mode" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_GET_PREPAY_SNAPTSHOT, 0x07, "Get Prepay Snapshot" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_GET_TOP_UP_LOG, 0x08, "Get Top Up Log" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_SET_LOW_CREDIT_WARNING_LEVEL, 0x09, "Set Low Credit Warning Level" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_GET_DEBT_REPAYMENT_LOG, 0x0A, "Get Debt Repayment Log" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_SET_MAXIMUM_CREDIT_LIMIT, 0x0B, "Set Maximum Credit Limit" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_SET_OVERALL_DEBT_CAP, 0x0C, "Set Overall Debt Cap" ) + +VALUE_STRING_ENUM(zbee_zcl_pp_srv_rx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_pp_srv_rx_cmd_names); + +/* Server Commands Generated */ +#define zbee_zcl_pp_srv_tx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_PP_PUBLISH_PREPAY_SNAPSHOT, 0x01, "Publish Prepay Snapshot" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_CHANGE_PAYMENT_MODE_RESPONSE, 0x02, "Change Payment Mode Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_CONSUMER_TOP_UP_RESPONSE, 0x03, "Consumer Top Up Response" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_PUBLISH_TOP_UP_LOG, 0x05, "Publish Top Up Log" ) \ + XXX(ZBEE_ZCL_CMD_ID_PP_PUBLISH_DEBT_LOG, 0x06, "Publish Debt Log" ) + +VALUE_STRING_ENUM(zbee_zcl_pp_srv_tx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_pp_srv_tx_cmd_names); + +/*************************/ +/* Function Declarations */ +/*************************/ +void proto_register_zbee_zcl_pp(void); +void proto_reg_handoff_zbee_zcl_pp(void); + +/* Attribute Dissector Helpers */ +static void dissect_zcl_pp_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); + +/*************************/ +/* Global Variables */ +/*************************/ + +static dissector_handle_t pp_handle; + +/* Initialize the protocol and registered fields */ +static int proto_zbee_zcl_pp = -1; + +static int hf_zbee_zcl_pp_srv_tx_cmd_id = -1; +static int hf_zbee_zcl_pp_srv_rx_cmd_id = -1; +static int hf_zbee_zcl_pp_attr_id = -1; +static int hf_zbee_zcl_pp_attr_reporting_status = -1; + +/* Initialize the subtree pointers */ +static gint ett_zbee_zcl_pp = -1; + +/*************************/ +/* Function Bodies */ +/*************************/ + +/** + *This function is called by ZCL foundation dissector in order to decode + * + *@param tree pointer to data tree Wireshark uses to display packet. + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type +*/ +static void +dissect_zcl_pp_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) +{ + switch (attr_id) { + /* applies to all SE clusters */ + case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_PP: + proto_tree_add_item(tree, hf_zbee_zcl_pp_attr_reporting_status, tvb, *offset, 1, ENC_NA); + *offset += 1; + break; + + default: /* Catch all */ + dissect_zcl_attr_data(tvb, tree, offset, data_type); + break; + } +} /*dissect_zcl_pp_attr_data*/ + +/** + *ZigBee ZCL Prepayment cluster dissector for wireshark. + * + *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields + *@param tree pointer to data tree Wireshark uses to display packet. +*/ +static int +dissect_zbee_zcl_pp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) +{ + zbee_zcl_packet *zcl; + guint offset = 0; + guint8 cmd_id; + gint rem_len; + + /* Reject the packet if data is NULL */ + if (data == NULL) + return 0; + zcl = (zbee_zcl_packet *)data; + cmd_id = zcl->cmd_id; + + /* Create a subtree for the ZCL Command frame, and add the command ID to it. */ + if (zcl->direction == ZBEE_ZCL_FCF_TO_SERVER) { + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_pp_srv_rx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_pp_srv_rx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_pp, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_PP_SELECT_AVAILABLE_EMERGENCY_CREDIT: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PP_CONSUMER_TOP_UP: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PP_GET_PREPAY_SNAPTSHOT: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PP_GET_TOP_UP_LOG: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PP_GET_DEBT_REPAYMENT_LOG: + /* Add function to dissect payload */ + break; + + default: + break; + } + } + } + else { /* ZBEE_ZCL_FCF_TO_CLIENT */ + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_pp_srv_tx_cmd_names, "Unknown Command"), + zcl->tran_seqno); + + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_pp_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_pp, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_PP_PUBLISH_PREPAY_SNAPSHOT: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PP_CONSUMER_TOP_UP_RESPONSE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PP_PUBLISH_TOP_UP_LOG: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_PP_PUBLISH_DEBT_LOG: + /* Add function to dissect payload */ + break; + + default: + break; + } + } + } + + return tvb_captured_length(tvb); +} /*dissect_zbee_zcl_pp*/ + +/** + *This function registers the ZCL Prepayment dissector + * +*/ +void +proto_register_zbee_zcl_pp(void) +{ + static hf_register_info hf[] = { + + { &hf_zbee_zcl_pp_attr_id, + { "Attribute", "zbee_zcl_se.pp.attr_id", FT_UINT16, BASE_HEX | BASE_EXT_STRING, &zbee_zcl_pp_attr_names_ext, + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_pp_attr_reporting_status, /* common to all SE clusters */ + { "Attribute Reporting Status", "zbee_zcl_se.pp.attr.attr_reporting_status", + FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_pp_srv_tx_cmd_id, + { "Command", "zbee_zcl_se.pp.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_pp_srv_tx_cmd_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_pp_srv_rx_cmd_id, + { "Command", "zbee_zcl_se.pp.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_pp_srv_rx_cmd_names), + 0x00, NULL, HFILL } }, + + }; + + /* ZCL Prepayment subtrees */ + gint *ett[] = { + &ett_zbee_zcl_pp, + }; + + /* Register the ZigBee ZCL Prepayment cluster protocol name and description */ + proto_zbee_zcl_pp = proto_register_protocol("ZigBee ZCL Prepayment", "ZCL Prepayment", ZBEE_PROTOABBREV_ZCL_PRE_PAYMENT); + proto_register_field_array(proto_zbee_zcl_pp, hf, array_length(hf)); + proto_register_subtree_array(ett, array_length(ett)); + + /* Register the ZigBee ZCL Prepayment dissector. */ + pp_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_PRE_PAYMENT, dissect_zbee_zcl_pp, proto_zbee_zcl_pp); +} /*proto_register_zbee_zcl_pp*/ + +/** + *Hands off the Zcl Prepayment dissector. + * +*/ +void +proto_reg_handoff_zbee_zcl_pp(void) +{ + /* Register our dissector with the ZigBee application dissectors. */ + dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_PRE_PAYMENT, pp_handle); + + zbee_zcl_init_cluster( proto_zbee_zcl_pp, + ett_zbee_zcl_pp, + ZBEE_ZCL_CID_PRE_PAYMENT, + hf_zbee_zcl_pp_attr_id, + hf_zbee_zcl_pp_srv_rx_cmd_id, + hf_zbee_zcl_pp_srv_tx_cmd_id, + (zbee_zcl_fn_attr_data)dissect_zcl_pp_attr_data + ); +} /*proto_reg_handoff_zbee_zcl_pp*/ -/* Initialize the subtree pointers */ -static gint ett_zbee_zcl_tun = -1; +/* ########################################################################## */ +/* #### (0x0707) CALENDAR CLUSTER ########################################### */ +/* ########################################################################## */ -/* Subdissector handles. */ -static dissector_handle_t ipv4_handle; -static dissector_handle_t ipv6_handle; +/* Attributes */ +#define zbee_zcl_calendar_attr_names_VALUE_STRING_LIST(XXX) \ +/* Auxiliary Switch Label Attribute Set */ \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_1_LABEL, 0x0000, "Aux Switch 1 Label" ) \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_2_LABEL, 0x0001, "Aux Switch 2 Label" ) \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_3_LABEL, 0x0002, "Aux Switch 3 Label" ) \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_4_LABEL, 0x0003, "Aux Switch 4 Label" ) \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_5_LABEL, 0x0004, "Aux Switch 5 Label" ) \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_6_LABEL, 0x0005, "Aux Switch 6 Label" ) \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_7_LABEL, 0x0006, "Aux Switch 7 Label" ) \ + XXX(ZBEE_ZCL_ATTR_ID_CAL_AUX_SWITCH_8_LABEL, 0x0007, "Aux Switch 8 Label" ) \ +/* Smart Energy */ \ + XXX(ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_CAL, 0xFFFE, "Attribute Reporting Status" ) + +VALUE_STRING_ENUM(zbee_zcl_calendar_attr_names); +VALUE_STRING_ARRAY(zbee_zcl_calendar_attr_names); /* Server Commands Received */ -static const value_string zbee_zcl_tun_srv_rx_cmd_names[] = { - { ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL, "Request Tunnel" }, - { ZBEE_ZCL_CMD_ID_TUN_CLOSE_TUNNEL, "Close Tunnel" }, - { ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA, "Transfer Data" }, - { ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR, "Transfer Data Error" }, - { ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA, "Ack Transfer Data" }, - { ZBEE_ZCL_CMD_ID_TUN_READY_DATA, "Ready Data" }, - { ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS, "Get Supported Protocols" }, - { 0, NULL } -}; +#define zbee_zcl_calendar_srv_rx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_GET_CALENDAR, 0x00, "Get Calendar" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_GET_DAY_PROFILES, 0x01, "Get Day Profiles" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_GET_WEEK_PROFILES, 0x02, "Get Week Profiles" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_GET_SEASONS, 0x03, "Get Seasons" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_GET_SPECIAL_DAYS, 0x04, "Get Special Days" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_GET_CALENDAR_CANCELLATION, 0x05, "Get Calendar Cancellation" ) + +VALUE_STRING_ENUM(zbee_zcl_calendar_srv_rx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_calendar_srv_rx_cmd_names); /* Server Commands Generated */ -static const value_string zbee_zcl_tun_srv_tx_cmd_names[] = { - { ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL_RSP, "Request Tunnel Response" }, - { ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_TX, "Transfer Data" }, - { ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR_TX, "Transfer Data Error" }, - { ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA_TX, "Ack Transfer Data" }, - { ZBEE_ZCL_CMD_ID_TUN_READY_DATA_TX, "Ready Data" }, - { ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS_RSP, "Get Supported Tunnel Protocols" }, - { ZBEE_ZCL_CMD_ID_TUN_CLOSURE_NOTIFY, "Tunnel Closure Notification" }, - { 0, NULL } -}; +#define zbee_zcl_calendar_srv_tx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_PUBLISH_CALENDAR, 0x00, "Publish Calendar" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_PUBLISH_DAY_PROFILE, 0x01, "Publish Day Profile" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_PUBLISH_WEEK_PROFILE, 0x02, "Publish Week Profile" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_PUBLISH_SEASONS, 0x03, "Publish Seasons" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_PUBLISH_SPECIAL_DAYS, 0x04, "Publish Special Days" ) \ + XXX(ZBEE_ZCL_CMD_ID_CAL_CANCEL_CALENDAR, 0x05, "Cancel Calendar" ) -#define ZBEE_ZCL_TUN_PROTO_DLMS 0x00 -#define ZBEE_ZCL_TUN_PROTO_IEC_61107 0x01 -#define ZBEE_ZCL_TUN_PROTO_ANSI_C12 0x02 -#define ZBEE_ZCL_TUN_PROTO_M_BUS 0x03 -#define ZBEE_ZCL_TUN_PROTO_SML 0x04 -#define ZBEE_ZCL_TUN_PROTO_CLIMATE_TALK 0x05 -#define ZBEE_ZCL_TUN_PROTO_GB_HRGP 0x06 -#define ZBEE_ZCL_TUN_PROTO_IPV6 0x07 -#define ZBEE_ZCL_TUN_PROTO_IPV4 0x08 -#define ZBEE_ZCL_TUN_PROTO_NULL 0x09 -#define ZBEE_ZCL_TUN_PROTO_TEST 199 -#define ZBEE_ZCL_TUN_PROTO_MANUFACTURER 200 -#define ZBEE_ZCL_TUN_PROTO_RESERVED 0xFF - -static const value_string zbee_zcl_tun_protocol_names[] = { - { ZBEE_ZCL_TUN_PROTO_DLMS, "DLMS/COSEM (IEC 62056)" }, - { ZBEE_ZCL_TUN_PROTO_IEC_61107, "IEC 61107" }, - { ZBEE_ZCL_TUN_PROTO_ANSI_C12, "ANSI C12" }, - { ZBEE_ZCL_TUN_PROTO_M_BUS, "M-BUS" }, - { ZBEE_ZCL_TUN_PROTO_SML, "SML" }, - { ZBEE_ZCL_TUN_PROTO_CLIMATE_TALK, "ClimateTalk" }, - { ZBEE_ZCL_TUN_PROTO_GB_HRGP, "GB-HRGP" }, - { ZBEE_ZCL_TUN_PROTO_IPV6, "IPv6" }, - { ZBEE_ZCL_TUN_PROTO_IPV4, "IPv4" }, - { ZBEE_ZCL_TUN_PROTO_NULL, "null" }, - { ZBEE_ZCL_TUN_PROTO_TEST, "test" }, - { ZBEE_ZCL_TUN_PROTO_MANUFACTURER, "Manufacturer Specific" }, - { ZBEE_ZCL_TUN_PROTO_RESERVED, "Reserved" }, - { 0, NULL } -}; +VALUE_STRING_ENUM(zbee_zcl_calendar_srv_tx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_calendar_srv_tx_cmd_names); -#define ZBEE_ZCL_TUN_TRANS_STATUS_NO_TUNNEL 0x00 -#define ZBEE_ZCL_TUN_TRANS_STATUS_WRONG_DEV 0x01 -#define ZBEE_ZCL_TUN_TRANS_STATUS_OVERFLOW 0x02 +/*************************/ +/* Function Declarations */ +/*************************/ +void proto_register_zbee_zcl_calendar(void); +void proto_reg_handoff_zbee_zcl_calendar(void); -static const value_string zbee_zcl_tun_trans_data_status_names[] = { - { ZBEE_ZCL_TUN_TRANS_STATUS_NO_TUNNEL, "Tunnel ID Does Not Exist" }, - { ZBEE_ZCL_TUN_TRANS_STATUS_WRONG_DEV, "Wrong Device" }, - { ZBEE_ZCL_TUN_TRANS_STATUS_OVERFLOW, "Data Overflow" }, - { 0, NULL } -}; +/* Attribute Dissector Helpers */ +static void dissect_zcl_calendar_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); -#define ZBEE_ZCL_TUN_STATUS_SUCCESS 0x00 -#define ZBEE_ZCL_TUN_STATUS_BUSY 0x01 -#define ZBEE_ZCL_TUN_STATUS_NO_MORE_IDS 0x02 -#define ZBEE_ZCL_TUN_STATUS_PROTO_NOT_SUPP 0x03 -#define ZBEE_ZCL_TUN_STATUS_FLOW_CONTROL_NOT_SUPP 0x04 - -static const value_string zbee_zcl_tun_status_names[] = { - { ZBEE_ZCL_TUN_STATUS_SUCCESS, "Success" }, - { ZBEE_ZCL_TUN_STATUS_BUSY, "Busy" }, - { ZBEE_ZCL_TUN_STATUS_NO_MORE_IDS, "No More Tunnel IDs" }, - { ZBEE_ZCL_TUN_STATUS_PROTO_NOT_SUPP, "Protocol Not Supported" }, - { ZBEE_ZCL_TUN_STATUS_FLOW_CONTROL_NOT_SUPP, "Flow Control Not Supported" }, - { 0, NULL } -}; +/*************************/ +/* Global Variables */ +/*************************/ + +static dissector_handle_t calendar_handle; + +/* Initialize the protocol and registered fields */ +static int proto_zbee_zcl_calendar = -1; + +static int hf_zbee_zcl_calendar_srv_tx_cmd_id = -1; +static int hf_zbee_zcl_calendar_srv_rx_cmd_id = -1; +static int hf_zbee_zcl_calendar_attr_id = -1; +static int hf_zbee_zcl_calendar_attr_reporting_status = -1; + +/* Initialize the subtree pointers */ +static gint ett_zbee_zcl_calendar = -1; /*************************/ /* Function Bodies */ @@ -854,18 +2900,12 @@ static const value_string zbee_zcl_tun_status_names[] = { *@param data_type attribute data type */ static void -dissect_zcl_tun_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) +dissect_zcl_calendar_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { switch (attr_id) { - /* cluster specific attributes */ - case ZBEE_ZCL_ATTR_ID_TUN_CLOSE_TIMEOUT: - proto_tree_add_item(tree, hf_zbee_zcl_tun_attr_close_timeout, tvb, *offset, 2, ENC_NA); - *offset += 2; - break; - /* applies to all SE clusters */ - case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS: - proto_tree_add_item(tree, hf_zbee_zcl_tun_attr_reporting_status, tvb, *offset, 1, ENC_NA); + case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_CAL: + proto_tree_add_item(tree, hf_zbee_zcl_calendar_attr_reporting_status, tvb, *offset, 1, ENC_NA); *offset += 1; break; @@ -873,208 +2913,281 @@ dissect_zcl_tun_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint1 dissect_zcl_attr_data(tvb, tree, offset, data_type); break; } -} /*dissect_zcl_ias_zone_attr_data*/ +} /*dissect_zcl_calendar_attr_data*/ /** - *This function manages the Display Message payload + *ZigBee ZCL Calendar cluster dissector for wireshark. * *@param tvb pointer to buffer containing raw packet. + *@param pinfo pointer to packet information fields *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller */ -static void -dissect_zcl_tun_request_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) +static int +dissect_zbee_zcl_calendar(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { - proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_id, tvb, *offset, 1, ENC_NA); - *offset += 1; + zbee_zcl_packet *zcl; + guint offset = 0; + guint8 cmd_id; + gint rem_len; - proto_tree_add_item(tree, hf_zbee_zcl_tun_manufacturer_code, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; + /* Reject the packet if data is NULL */ + if (data == NULL) + return 0; + zcl = (zbee_zcl_packet *)data; + cmd_id = zcl->cmd_id; - proto_tree_add_item(tree, hf_zbee_zcl_tun_flow_control_support, tvb, *offset, 1, ENC_NA); - *offset += 1; + /* Create a subtree for the ZCL Command frame, and add the command ID to it. */ + if (zcl->direction == ZBEE_ZCL_FCF_TO_SERVER) { + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_calendar_srv_rx_cmd_names, "Unknown Command"), + zcl->tran_seqno); - proto_tree_add_item(tree, hf_zbee_zcl_tun_max_in_size, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; -} + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_calendar_srv_rx_cmd_id, tvb, offset, 1, cmd_id); -/** - *This function manages the Display Message payload - * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller -*/ -static void -dissect_zcl_tun_close_tunnel(tvbuff_t *tvb, proto_tree *tree, guint *offset) -{ - proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; -} + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_calendar, NULL, "Payload"); -/** - *This function manages the Display Message payload - * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller -*/ -static void -dissect_zcl_tun_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) -{ - gint length; + /* Call the appropriate command dissector */ + switch (cmd_id) { - proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; + case ZBEE_ZCL_CMD_ID_CAL_GET_CALENDAR: + /* Add function to dissect payload */ + break; - length = tvb_reported_length_remaining(tvb, *offset); - proto_tree_add_item(tree, hf_zbee_zcl_tun_transfer_data, tvb, *offset, length, ENC_NA); - *offset += length; -} + case ZBEE_ZCL_CMD_ID_CAL_GET_DAY_PROFILES: + /* Add function to dissect payload */ + break; -/** - *This function manages the Display Message payload - * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller -*/ -static void -dissect_zcl_tun_transfer_data_error(tvbuff_t *tvb, proto_tree *tree, guint *offset) -{ - proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; + case ZBEE_ZCL_CMD_ID_CAL_GET_WEEK_PROFILES: + /* Add function to dissect payload */ + break; - proto_tree_add_item(tree, hf_zbee_zcl_tun_transfer_data_status, tvb, *offset, 1, ENC_NA); - *offset += 1; -} + case ZBEE_ZCL_CMD_ID_CAL_GET_SEASONS: + /* Add function to dissect payload */ + break; -/** - *This function manages the Display Message payload - * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller -*/ -static void -dissect_zcl_tun_ack_transfer_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) -{ - proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; + case ZBEE_ZCL_CMD_ID_CAL_GET_SPECIAL_DAYS: + /* Add function to dissect payload */ + break; - proto_tree_add_item(tree, hf_zbee_zcl_tun_num_octets_left, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; -} + case ZBEE_ZCL_CMD_ID_CAL_GET_CALENDAR_CANCELLATION: + /* Add function to dissect payload */ + break; -/** - *This function manages the Display Message payload - * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller -*/ -static void -dissect_zcl_tun_ready_data(tvbuff_t *tvb, proto_tree *tree, guint *offset) -{ - proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; + default: + break; + } + } + } + else { /* ZBEE_ZCL_FCF_TO_CLIENT */ + /* Append the command name to the info column. */ + col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", + val_to_str_const(cmd_id, zbee_zcl_calendar_srv_tx_cmd_names, "Unknown Command"), + zcl->tran_seqno); - proto_tree_add_item(tree, hf_zbee_zcl_tun_num_octets_left, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; -} + /* Add the command ID. */ + proto_tree_add_uint(tree, hf_zbee_zcl_calendar_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + + /* Check is this command has a payload, than add the payload tree */ + rem_len = tvb_reported_length_remaining(tvb, ++offset); + if (rem_len > 0) { + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_calendar, NULL, "Payload"); + + /* Call the appropriate command dissector */ + switch (cmd_id) { + + case ZBEE_ZCL_CMD_ID_CAL_PUBLISH_CALENDAR: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_CAL_PUBLISH_DAY_PROFILE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_CAL_PUBLISH_WEEK_PROFILE: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_CAL_PUBLISH_SEASONS: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_CAL_PUBLISH_SPECIAL_DAYS: + /* Add function to dissect payload */ + break; + + case ZBEE_ZCL_CMD_ID_CAL_CANCEL_CALENDAR: + /* Add function to dissect payload */ + break; + + default: + break; + } + } + } + + return tvb_captured_length(tvb); +} /*dissect_zbee_zcl_calendar*/ /** - *This function manages the Display Message payload + *This function registers the ZCL Calendar dissector * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller */ -static void -dissect_zcl_tun_get_supported(tvbuff_t *tvb, proto_tree *tree, guint *offset) +void +proto_register_zbee_zcl_calendar(void) { - proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_offset, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; -} + static hf_register_info hf[] = { + + { &hf_zbee_zcl_calendar_attr_id, + { "Attribute", "zbee_zcl_se.calendar.attr_id", FT_UINT16, BASE_HEX, VALS(zbee_zcl_calendar_attr_names), + 0x0, NULL, HFILL } }, + + { &hf_zbee_zcl_calendar_attr_reporting_status, /* common to all SE clusters */ + { "Attribute Reporting Status", "zbee_zcl_se.calendar.attr.attr_reporting_status", + FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_calendar_srv_tx_cmd_id, + { "Command", "zbee_zcl_se.calendar.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_calendar_srv_tx_cmd_names), + 0x00, NULL, HFILL } }, + + { &hf_zbee_zcl_calendar_srv_rx_cmd_id, + { "Command", "zbee_zcl_se.calendar.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_calendar_srv_rx_cmd_names), + 0x00, NULL, HFILL } }, + + }; + + /* ZCL Calendar subtrees */ + gint *ett[] = { + &ett_zbee_zcl_calendar, + }; + + /* Register the ZigBee ZCL Calendar cluster protocol name and description */ + proto_zbee_zcl_calendar = proto_register_protocol("ZigBee ZCL Calendar", "ZCL Calendar", ZBEE_PROTOABBREV_ZCL_CALENDAR); + proto_register_field_array(proto_zbee_zcl_calendar, hf, array_length(hf)); + proto_register_subtree_array(ett, array_length(ett)); + + /* Register the ZigBee ZCL Calendar dissector. */ + calendar_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_CALENDAR, dissect_zbee_zcl_calendar, proto_zbee_zcl_calendar); +} /*proto_register_zbee_zcl_calendar*/ /** - *This function manages the Display Message payload + *Hands off the Zcl Calendar dissector. * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller */ -static void -dissect_zcl_tun_request_tunnel_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) +void +proto_reg_handoff_zbee_zcl_calendar(void) { - proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; + /* Register our dissector with the ZigBee application dissectors. */ + dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_CALENDAR, calendar_handle); + + zbee_zcl_init_cluster( proto_zbee_zcl_calendar, + ett_zbee_zcl_calendar, + ZBEE_ZCL_CID_CALENDAR, + hf_zbee_zcl_calendar_attr_id, + hf_zbee_zcl_calendar_srv_rx_cmd_id, + hf_zbee_zcl_calendar_srv_tx_cmd_id, + (zbee_zcl_fn_attr_data)dissect_zcl_calendar_attr_data + ); +} /*proto_reg_handoff_zbee_zcl_calendar*/ - proto_tree_add_item(tree, hf_zbee_zcl_tun_transfer_status, tvb, *offset, 1, ENC_NA); - *offset += 1; +/* ########################################################################## */ +/* #### (0x0709) EVENTS CLUSTER ############################################# */ +/* ########################################################################## */ - proto_tree_add_item(tree, hf_zbee_zcl_tun_max_in_size, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; -} +/* Attributes */ +#define zbee_zcl_events_attr_names_VALUE_STRING_LIST(XXX) \ +/* Smart Energy */ \ + XXX(ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_EVENTS, 0xFFFE, "Attribute Reporting Status" ) + +VALUE_STRING_ENUM(zbee_zcl_events_attr_names); +VALUE_STRING_ARRAY(zbee_zcl_events_attr_names); + +/* Server Commands Received */ +#define zbee_zcl_events_srv_rx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_EVENTS_GET_EVENT_LOG, 0x00, "Get Event Log" ) \ + XXX(ZBEE_ZCL_CMD_ID_EVENTS_CLEAR_EVENT_LOG_REQUEST, 0x01, "Clear Event Log Request" ) + +VALUE_STRING_ENUM(zbee_zcl_events_srv_rx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_events_srv_rx_cmd_names); + +/* Server Commands Generated */ +#define zbee_zcl_events_srv_tx_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_EVENTS_PUBLISH_EVENT, 0x00, "Publish Event" ) \ + XXX(ZBEE_ZCL_CMD_ID_EVENTS_PUBLISH_EVENT_LOG, 0x01, "Publish Event Log" ) \ + XXX(ZBEE_ZCL_CMD_ID_EVENTS_CLEAR_EVENT_LOG_RESPONSE, 0x02, "Clear Event Log Response" ) + +VALUE_STRING_ENUM(zbee_zcl_events_srv_tx_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_events_srv_tx_cmd_names); + +/*************************/ +/* Function Declarations */ +/*************************/ +void proto_register_zbee_zcl_events(void); +void proto_reg_handoff_zbee_zcl_events(void); + +/* Attribute Dissector Helpers */ +static void dissect_zcl_events_attr_data (proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type); + +/*************************/ +/* Global Variables */ +/*************************/ -/** - *This function manages the Display Message payload - * - *@param tvb pointer to buffer containing raw packet. - *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller -*/ -static void -dissect_zcl_tun_get_supported_rsp(tvbuff_t *tvb, proto_tree *tree, guint *offset) -{ - guint16 mfg_code; +static dissector_handle_t events_handle; - proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_list_complete, tvb, *offset, 1, ENC_NA); - *offset += 1; +/* Initialize the protocol and registered fields */ +static int proto_zbee_zcl_events = -1; - proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_count, tvb, *offset, 1, ENC_NA); - *offset += 1; +static int hf_zbee_zcl_events_srv_tx_cmd_id = -1; +static int hf_zbee_zcl_events_srv_rx_cmd_id = -1; +static int hf_zbee_zcl_events_attr_id = -1; +static int hf_zbee_zcl_events_attr_reporting_status = -1; - while (tvb_reported_length_remaining(tvb, *offset) > 0) { - mfg_code = tvb_get_letohs(tvb, *offset); - if (mfg_code == 0xFFFF) { - proto_tree_add_string(tree, hf_zbee_zcl_tun_manufacturer_code, tvb, *offset, 2, "Standard Protocol (Mfg Code 0xFFFF)"); - } - else { - proto_tree_add_item(tree, hf_zbee_zcl_tun_manufacturer_code, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - } - *offset += 2; +/* Initialize the subtree pointers */ +static gint ett_zbee_zcl_events = -1; - proto_tree_add_item(tree, hf_zbee_zcl_tun_protocol_id, tvb, *offset, 1, ENC_NA); - *offset += 1; - } -} +/*************************/ +/* Function Bodies */ +/*************************/ /** - *This function manages the Display Message payload + *This function is called by ZCL foundation dissector in order to decode * - *@param tvb pointer to buffer containing raw packet. *@param tree pointer to data tree Wireshark uses to display packet. - *@param offset pointer to offset from caller + *@param tvb pointer to buffer containing raw packet. + *@param offset pointer to buffer offset + *@param attr_id attribute identifier + *@param data_type attribute data type */ static void -dissect_zcl_tun_closure_notify(tvbuff_t *tvb, proto_tree *tree, guint *offset) +dissect_zcl_events_attr_data(proto_tree *tree, tvbuff_t *tvb, guint *offset, guint16 attr_id, guint data_type) { - proto_tree_add_item(tree, hf_zbee_zcl_tun_tunnel_id, tvb, *offset, 2, ENC_LITTLE_ENDIAN); - *offset += 2; -} + switch (attr_id) { + /* applies to all SE clusters */ + case ZBEE_ZCL_ATTR_ID_SE_ATTR_REPORT_STATUS_EVENTS: + proto_tree_add_item(tree, hf_zbee_zcl_events_attr_reporting_status, tvb, *offset, 1, ENC_NA); + *offset += 1; + break; + + default: /* Catch all */ + dissect_zcl_attr_data(tvb, tree, offset, data_type); + break; + } +} /*dissect_zcl_events_attr_data*/ /** - *ZigBee ZCL Messaging cluster dissector for wireshark. + *ZigBee ZCL Events cluster dissector for wireshark. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to data tree Wireshark uses to display packet. */ static int -dissect_zbee_zcl_tun(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) +dissect_zbee_zcl_events(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { - proto_tree *payload_tree; zbee_zcl_packet *zcl; guint offset = 0; guint8 cmd_id; @@ -1090,46 +3203,26 @@ dissect_zbee_zcl_tun(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* if (zcl->direction == ZBEE_ZCL_FCF_TO_SERVER) { /* Append the command name to the info column. */ col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", - val_to_str_const(cmd_id, zbee_zcl_tun_srv_rx_cmd_names, "Unknown Command"), + val_to_str_const(cmd_id, zbee_zcl_events_srv_rx_cmd_names, "Unknown Command"), zcl->tran_seqno); /* Add the command ID. */ - proto_tree_add_item(tree, hf_zbee_zcl_tun_srv_rx_cmd_id, tvb, offset, 1, cmd_id); + proto_tree_add_uint(tree, hf_zbee_zcl_events_srv_rx_cmd_id, tvb, offset, 1, cmd_id); /* Check is this command has a payload, than add the payload tree */ rem_len = tvb_reported_length_remaining(tvb, ++offset); if (rem_len > 0) { - payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_tun, NULL, "Payload"); + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_events, NULL, "Payload"); /* Call the appropriate command dissector */ switch (cmd_id) { - case ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL: - dissect_zcl_tun_request_tunnel(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_CLOSE_TUNNEL: - dissect_zcl_tun_close_tunnel(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA: - dissect_zcl_tun_transfer_data(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR: - dissect_zcl_tun_transfer_data_error(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA: - dissect_zcl_tun_ack_transfer_data(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_READY_DATA: - dissect_zcl_tun_ready_data(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_EVENTS_GET_EVENT_LOG: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS: - dissect_zcl_tun_get_supported(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_EVENTS_CLEAR_EVENT_LOG_REQUEST: + /* Add function to dissect payload */ break; default: @@ -1140,46 +3233,30 @@ dissect_zbee_zcl_tun(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* else { /* ZBEE_ZCL_FCF_TO_CLIENT */ /* Append the command name to the info column. */ col_append_fstr(pinfo->cinfo, COL_INFO, "%s, Seq: %u", - val_to_str_const(cmd_id, zbee_zcl_tun_srv_tx_cmd_names, "Unknown Command"), + val_to_str_const(cmd_id, zbee_zcl_events_srv_tx_cmd_names, "Unknown Command"), zcl->tran_seqno); /* Add the command ID. */ - proto_tree_add_item(tree, hf_zbee_zcl_tun_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + proto_tree_add_uint(tree, hf_zbee_zcl_events_srv_tx_cmd_id, tvb, offset, 1, cmd_id); /* Check is this command has a payload, than add the payload tree */ rem_len = tvb_reported_length_remaining(tvb, ++offset); if (rem_len > 0) { - payload_tree = proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_tun, NULL, "Payload"); + proto_tree_add_subtree(tree, tvb, offset, rem_len, ett_zbee_zcl_events, NULL, "Payload"); /* Call the appropriate command dissector */ switch (cmd_id) { - case ZBEE_ZCL_CMD_ID_TUN_REQUEST_TUNNEL_RSP: - dissect_zcl_tun_request_tunnel_rsp(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_TX: - dissect_zcl_tun_transfer_data(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_TRANSFER_DATA_ERROR_TX: - dissect_zcl_tun_transfer_data_error(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_ACK_TRANSFER_DATA_TX: - dissect_zcl_tun_ack_transfer_data(tvb, payload_tree, &offset); - break; - - case ZBEE_ZCL_CMD_ID_TUN_READY_DATA_TX: - dissect_zcl_tun_ready_data(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_EVENTS_PUBLISH_EVENT: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_TUN_GET_SUPPORTED_PROTOCOLS_RSP: - dissect_zcl_tun_get_supported_rsp(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_EVENTS_PUBLISH_EVENT_LOG: + /* Add function to dissect payload */ break; - case ZBEE_ZCL_CMD_ID_TUN_CLOSURE_NOTIFY: - dissect_zcl_tun_closure_notify(tvb, payload_tree, &offset); + case ZBEE_ZCL_CMD_ID_EVENTS_CLEAR_EVENT_LOG_RESPONSE: + /* Add function to dissect payload */ break; default: @@ -1189,127 +3266,68 @@ dissect_zbee_zcl_tun(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* } return tvb_captured_length(tvb); -} /*dissect_zbee_zcl_tun*/ +} /*dissect_zbee_zcl_events*/ /** - *This function registers the ZCL Messaging dissector + *This function registers the ZCL Events dissector * */ void -proto_register_zbee_zcl_tun(void) +proto_register_zbee_zcl_events(void) { static hf_register_info hf[] = { - { &hf_zbee_zcl_tun_attr_id, - { "Attribute", "zbee_zcl_se.tun.attr_id", FT_UINT16, BASE_HEX, VALS(zbee_zcl_tun_attr_names), + { &hf_zbee_zcl_events_attr_id, + { "Attribute", "zbee_zcl_se.events.attr_id", FT_UINT16, BASE_HEX, VALS(zbee_zcl_events_attr_names), 0x0, NULL, HFILL } }, - { &hf_zbee_zcl_tun_attr_reporting_status, /* common to all SE clusters */ - { "Attribute Reporting Status", "zbee_zcl_se.tun.attr.attr_reporting_status", + { &hf_zbee_zcl_events_attr_reporting_status, /* common to all SE clusters */ + { "Attribute Reporting Status", "zbee_zcl_se.events.attr.attr_reporting_status", FT_UINT8, BASE_HEX, VALS(zbee_zcl_se_reporting_status_names), 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_tun_attr_close_timeout, - { "Close Tunnel Timeout", "zbee_zcl_se.tun.attr.close_tunnel", FT_UINT16, BASE_DEC, NULL, - 0x0, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_srv_tx_cmd_id, - { "Command", "zbee_zcl_se.tun.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_srv_tx_cmd_names), - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_srv_rx_cmd_id, - { "Command", "zbee_zcl_se.tun.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_srv_rx_cmd_names), - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_protocol_id, - { "Protocol ID", "zbee_zcl_se.tun.protocol_id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_protocol_names), - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_manufacturer_code, - { "Manufacturer Code", "zbee_zcl_se.tun.manufacturer_code", FT_UINT16, BASE_HEX, VALS(zbee_mfr_code_names), - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_flow_control_support, - { "Flow Control Supported", "zbee_zcl_se.tun.flow_control_supported", FT_BOOLEAN, 8, TFS(&tfs_true_false), - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_max_in_size, - { "Max Incoming Transfer Size", "zbee_zcl_se.tun.max_in_transfer_size", FT_UINT16, BASE_HEX, NULL, - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_tunnel_id, - { "Tunnel Id", "zbee_zcl_se.tun.tunnel_id", FT_UINT16, BASE_HEX, NULL, - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_num_octets_left, - { "Num Octets Left", "zbee_zcl_se.tun.octets_left", FT_UINT16, BASE_HEX, NULL, - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_protocol_offset, - { "Protocol Offset", "zbee_zcl_se.tun.protocol_offset", FT_UINT8, BASE_HEX, NULL, - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_transfer_status, - { "Transfer Status", "zbee_zcl_se.tun.transfer_status", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_status_names), - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_transfer_data, - { "Transfer Data", "zbee_zcl_se.tun.transfer_data", FT_BYTES, BASE_NONE, NULL, - 0, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_transfer_data_status, - { "Transfer Data Status", "zbee_zcl_se.tun.transfer_data_status", FT_UINT8, BASE_HEX, VALS(zbee_zcl_tun_trans_data_status_names), - 0x00, NULL, HFILL } }, - - { &hf_zbee_zcl_tun_protocol_count, - { "Protocol Count", "zbee_zcl_se.tun.protocol_count", FT_UINT8, BASE_HEX, NULL, + { &hf_zbee_zcl_events_srv_tx_cmd_id, + { "Command", "zbee_zcl_se.events.cmd.srv_tx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_events_srv_tx_cmd_names), 0x00, NULL, HFILL } }, - { &hf_zbee_zcl_tun_protocol_list_complete, - { "List Complete", "zbee_zcl_se.tun.protocol_list_complete", FT_BOOLEAN, 8, TFS(&tfs_true_false), + { &hf_zbee_zcl_events_srv_rx_cmd_id, + { "Command", "zbee_zcl_se.events.cmd.srv_rx.id", FT_UINT8, BASE_HEX, VALS(zbee_zcl_events_srv_rx_cmd_names), 0x00, NULL, HFILL } }, }; - /* ZCL Messaging subtrees */ + /* ZCL Events subtrees */ gint *ett[] = { - &ett_zbee_zcl_tun, + &ett_zbee_zcl_events, }; - /* Register the ZigBee ZCL Messaging cluster protocol name and description */ - proto_zbee_zcl_tun = proto_register_protocol("ZigBee ZCL Tunneling", "ZCL Tunneling", ZBEE_PROTOABBREV_ZCL_TUN); - proto_register_field_array(proto_zbee_zcl_tun, hf, array_length(hf)); + /* Register the ZigBee ZCL Events cluster protocol name and description */ + proto_zbee_zcl_events = proto_register_protocol("ZigBee ZCL Events", "ZCL Events", ZBEE_PROTOABBREV_ZCL_EVENTS); + proto_register_field_array(proto_zbee_zcl_events, hf, array_length(hf)); proto_register_subtree_array(ett, array_length(ett)); - /* Register the ZigBee ZCL Messaging dissector. */ - register_dissector(ZBEE_PROTOABBREV_ZCL_TUN, dissect_zbee_zcl_tun, proto_zbee_zcl_tun); - -} /* proto_register_zbee_zcl_tun */ + /* Register the ZigBee ZCL Events dissector. */ + events_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_EVENTS, dissect_zbee_zcl_events, proto_zbee_zcl_events); +} /*proto_register_zbee_zcl_events*/ /** - *Hands off the Zcl Messaging dissector. + *Hands off the Zcl Events dissector. * */ void -proto_reg_handoff_zbee_zcl_tun(void) +proto_reg_handoff_zbee_zcl_events(void) { - dissector_handle_t msg_handle; - - ipv4_handle = find_dissector("ipv4"); - ipv6_handle = find_dissector("ipv6"); - /* Register our dissector with the ZigBee application dissectors. */ - msg_handle = find_dissector(ZBEE_PROTOABBREV_ZCL_TUN); - dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_TUNNELING, msg_handle); - - zbee_zcl_init_cluster( proto_zbee_zcl_tun, - ett_zbee_zcl_tun, - ZBEE_ZCL_CID_TUNNELING, - hf_zbee_zcl_tun_attr_id, - hf_zbee_zcl_tun_srv_rx_cmd_id, - hf_zbee_zcl_tun_srv_tx_cmd_id, - (zbee_zcl_fn_attr_data)dissect_zcl_tun_attr_data + dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_EVENTS, events_handle); + + zbee_zcl_init_cluster( proto_zbee_zcl_events, + ett_zbee_zcl_events, + ZBEE_ZCL_CID_EVENTS, + hf_zbee_zcl_events_attr_id, + hf_zbee_zcl_events_srv_rx_cmd_id, + hf_zbee_zcl_events_srv_tx_cmd_id, + (zbee_zcl_fn_attr_data)dissect_zcl_events_attr_data ); -} /* proto_reg_handoff_zbee_zcl_tun */ +} /*proto_reg_handoff_zbee_zcl_events*/ /* ########################################################################## */ /* #### (0x0800) KEY ESTABLISHMENT ########################################## */ @@ -1319,13 +3337,61 @@ proto_reg_handoff_zbee_zcl_tun(void) /* Defines */ /*************************/ -/* Initialize the subtree pointers */ -static gint ett_zbee_zcl_ke = -1; -static gint ett_zbee_zcl_ke_cert = -1; -static gint ett_zbee_zcl_ke_key_usage = -1; +#define ZBEE_ZCL_KE_USAGE_KEY_AGREEMENT 0x08 +#define ZBEE_ZCL_KE_USAGE_DIGITAL_SIGNATURE 0x80 /* Attributes */ -#define ZBEE_ZCL_ATTR_ID_KE_SUITE 0x0000 /* Key Establishment Suite */ +#define zbee_zcl_ke_attr_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_ATTR_ID_KE_SUITE, 0x0000, "Supported Key Establishment Suites" ) + +VALUE_STRING_ARRAY(zbee_zcl_ke_attr_names); + +/* Server Commands Received and Generated */ +#define zbee_zcl_ke_srv_cmd_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_CMD_ID_KE_INITIATE, 0x00, "Initiate Key Establishment" ) \ + XXX(ZBEE_ZCL_CMD_ID_KE_EPHEMERAL, 0x01, "Ephemeral Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_KE_CONFIRM, 0x02, "Confirm Key Data" ) \ + XXX(ZBEE_ZCL_CMD_ID_KE_TERMINATE, 0x03, "Terminate Key Establishment" ) + +VALUE_STRING_ENUM(zbee_zcl_ke_srv_cmd_names); +VALUE_STRING_ARRAY(zbee_zcl_ke_srv_cmd_names); + +/* Suite Names */ +#define zbee_zcl_ke_suite_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_KE_SUITE_1, 0x0001, "Crypto Suite 1 (CBKE K163)" ) \ + XXX(ZBEE_ZCL_KE_SUITE_2, 0x0002, "Crypto Suite 2 (CBKE K283)" ) + +VALUE_STRING_ENUM(zbee_zcl_ke_suite_names); +VALUE_STRING_ARRAY(zbee_zcl_ke_suite_names); + +/* Crypto Suite 2 Type Names */ +#define zbee_zcl_ke_type_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_KE_TYPE_NO_EXT, 0x00, "No Extensions" ) + +VALUE_STRING_ARRAY(zbee_zcl_ke_type_names); + +/* Crypto Suite 2 Curve Names */ +#define zbee_zcl_ke_curve_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_KE_CURVE_SECT283K1, 0x0D, "sect283k1" ) + +VALUE_STRING_ARRAY(zbee_zcl_ke_curve_names); + +/* Crypto Suite 2 Hash Names */ +#define zbee_zcl_ke_hash_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_KE_HASH_AES_MMO, 0x08, "AES MMO" ) + +VALUE_STRING_ARRAY(zbee_zcl_ke_hash_names); + +#define zbee_zcl_ke_status_names_VALUE_STRING_LIST(XXX) \ + XXX(ZBEE_ZCL_KE_STATUS_RESERVED, 0x00, "Reserved" ) \ + XXX(ZBEE_ZCL_KE_STATUS_UNKNOWN_ISSUER, 0x01, "Unknown Issuer" ) \ + XXX(ZBEE_ZCL_KE_STATUS_BAD_KEY_CONFIRM, 0x02, "Bad Key Confirm" ) \ + XXX(ZBEE_ZCL_KE_STATUS_BAD_MESSAGE, 0x03, "Bad Message" ) \ + XXX(ZBEE_ZCL_KE_STATUS_NO_RESOURCES, 0x04, "No Resources" ) \ + XXX(ZBEE_ZCL_KE_STATUS_UNSUPPORTED_SUITE, 0x05, "Unsupported Suite" ) \ + XXX(ZBEE_ZCL_KE_STATUS_INVALID_CERTIFICATE, 0x06, "Invalid Certificate" ) + +VALUE_STRING_ARRAY(zbee_zcl_ke_status_names); /*************************/ /* Function Declarations */ @@ -1340,6 +3406,8 @@ void proto_reg_handoff_zbee_zcl_ke(void); /* Global Variables */ /*************************/ +static dissector_handle_t ke_handle; + /* Initialize the protocol and registered fields */ static int proto_zbee_zcl_ke = -1; static int hf_zbee_zcl_ke_srv_tx_cmd_id = -1; @@ -1367,88 +3435,15 @@ static int hf_zbee_zcl_ke_ephemeral_qev = -1; static int hf_zbee_zcl_ke_macu = -1; static int hf_zbee_zcl_ke_macv = -1; -/* Server Commands Received and Generates (symmetrical) */ -#define ZBEE_ZCL_CMD_ID_KE_INITIATE 0x00 /* Initiate Key Establishment */ -#define ZBEE_ZCL_CMD_ID_KE_EPHEMERAL 0x01 /* Ephemeral Data Request */ -#define ZBEE_ZCL_CMD_ID_KE_CONFIRM 0x02 /* Confirm Key Data Request */ -#define ZBEE_ZCL_CMD_ID_KE_TERMINATE 0x03 /* Terminate Key Establishment */ - -#define ZBEE_ZCL_KE_SUITE_1 0x0001 -#define ZBEE_ZCL_KE_SUITE_2 0x0002 - -#define ZBEE_ZCL_KE_TYPE_NO_EXT 0x00 /* no extensions were used */ - -#define ZBEE_ZCL_KE_CURVE_SECT283K1 0x0D - -#define ZBEE_ZCL_KE_HASH_AES_MMO 0x08 - -#define ZBEE_ZCL_KE_USAGE_KEY_AGREEMENT 0x08 -#define ZBEE_ZCL_KE_USAGE_DIGITAL_SIGNATURE 0x80 - -/* Attributes */ -static const value_string zbee_zcl_ke_attr_names[] = { - { ZBEE_ZCL_ATTR_ID_KE_SUITE, "Supported Key Establishment Suites" }, - { 0, NULL } -}; - -/* Server Commands Received and Generated */ -static const value_string zbee_zcl_ke_srv_cmd_names[] = { - { ZBEE_ZCL_CMD_ID_KE_INITIATE, "Initiate Key Establishment" }, - { ZBEE_ZCL_CMD_ID_KE_EPHEMERAL, "Ephemeral Data" }, - { ZBEE_ZCL_CMD_ID_KE_CONFIRM, "Confirm Key Data" }, - { ZBEE_ZCL_CMD_ID_KE_TERMINATE, "Terminate Key Establishment" }, - { 0, NULL } -}; - -/* Suite Names */ -static const value_string zbee_zcl_ke_suite_names[] = { - { ZBEE_ZCL_KE_SUITE_1, "Crypto Suite 1 (CBKE K163)" }, - { ZBEE_ZCL_KE_SUITE_2, "Crypto Suite 2 (CBKE K283)" }, - { 0, NULL } -}; - -/* Crypto Suite 2 Type Names */ -static const value_string zbee_zcl_ke_type_names[] = { - { ZBEE_ZCL_KE_TYPE_NO_EXT, "No Extensions" }, - { 0, NULL } -}; - -/* Crypto Suite 2 Curve Names */ -static const value_string zbee_zcl_ke_curve_names[] = { - { ZBEE_ZCL_KE_CURVE_SECT283K1, "sect283k1" }, - { 0, NULL } -}; - -/* Crypto Suite 2 Hash Names */ -static const value_string zbee_zcl_ke_hash_names[] = { - { ZBEE_ZCL_KE_HASH_AES_MMO, "AES MMO" }, - { 0, NULL } -}; - -#define ZBEE_ZCL_KE_STATUS_RESERVED 0x00 -#define ZBEE_ZCL_KE_STATUS_UNKNOWN_ISSUER 0x01 -#define ZBEE_ZCL_KE_STATUS_BAD_KEY_CONFIRM 0x02 -#define ZBEE_ZCL_KE_STATUS_BAD_MESSAGE 0x03 -#define ZBEE_ZCL_KE_STATUS_NO_RESOURCES 0x04 -#define ZBEE_ZCL_KE_STATUS_UNSUPPORTED_SUITE 0x05 -#define ZBEE_ZCL_KE_STATUS_INVALID_CERTIFICATE 0x06 - -static const value_string zbee_zcl_ke_status_names[] = { - { ZBEE_ZCL_KE_STATUS_RESERVED, "Reserved" }, - { ZBEE_ZCL_KE_STATUS_UNKNOWN_ISSUER, "Unknown Issuer"}, - { ZBEE_ZCL_KE_STATUS_BAD_KEY_CONFIRM, "Bad Key Confirm"}, - { ZBEE_ZCL_KE_STATUS_BAD_MESSAGE, "Bad Message"}, - { ZBEE_ZCL_KE_STATUS_NO_RESOURCES, "No Resources"}, - { ZBEE_ZCL_KE_STATUS_UNSUPPORTED_SUITE, "Unsupported Suite"}, - { ZBEE_ZCL_KE_STATUS_INVALID_CERTIFICATE, "Invalid Certificate"}, - { 0, NULL } -}; +/* Initialize the subtree pointers */ +static gint ett_zbee_zcl_ke = -1; +static gint ett_zbee_zcl_ke_cert = -1; +static gint ett_zbee_zcl_ke_key_usage = -1; /*************************/ /* Function Bodies */ /*************************/ - /** *This function dissects the Suite 1 Certificate * @@ -1696,7 +3691,7 @@ dissect_zbee_zcl_ke(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* d zcl->tran_seqno); /* Add the command ID. */ - proto_tree_add_item(tree, hf_zbee_zcl_ke_srv_rx_cmd_id, tvb, offset, 1, cmd_id); + proto_tree_add_uint(tree, hf_zbee_zcl_ke_srv_rx_cmd_id, tvb, offset, 1, cmd_id); /* Check is this command has a payload, than add the payload tree */ rem_len = tvb_reported_length_remaining(tvb, offset); @@ -1731,7 +3726,7 @@ dissect_zbee_zcl_ke(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* d zcl->tran_seqno); /* Add the command ID. */ - proto_tree_add_item(tree, hf_zbee_zcl_ke_srv_tx_cmd_id, tvb, offset, 1, cmd_id); + proto_tree_add_uint(tree, hf_zbee_zcl_ke_srv_tx_cmd_id, tvb, offset, 1, cmd_id); /* Check is this command has a payload, than add the payload tree */ rem_len = tvb_reported_length_remaining(tvb, ++offset); @@ -1824,7 +3819,7 @@ proto_register_zbee_zcl_ke(void) 0, NULL, HFILL } }, { &hf_zbee_zcl_ke_cert_serialno, - { "Serial No", "zbee_zcl_se.ke.cert.type", FT_UINT64, BASE_HEX, NULL, + { "Serial No", "zbee_zcl_se.ke.cert.serialno", FT_UINT64, BASE_HEX, NULL, 0, NULL, HFILL } }, { &hf_zbee_zcl_ke_cert_curve, @@ -1881,7 +3876,7 @@ proto_register_zbee_zcl_ke(void) proto_register_subtree_array(ett, array_length(ett)); /* Register the ZigBee ZCL Messaging dissector. */ - register_dissector(ZBEE_PROTOABBREV_ZCL_KE, dissect_zbee_zcl_ke, proto_zbee_zcl_ke); + ke_handle = register_dissector(ZBEE_PROTOABBREV_ZCL_KE, dissect_zbee_zcl_ke, proto_zbee_zcl_ke); } /*proto_register_zbee_zcl_ke*/ /** @@ -1891,10 +3886,7 @@ proto_register_zbee_zcl_ke(void) void proto_reg_handoff_zbee_zcl_ke(void) { - dissector_handle_t ke_handle; - /* Register our dissector with the ZigBee application dissectors. */ - ke_handle = find_dissector(ZBEE_PROTOABBREV_ZCL_KE); dissector_add_uint("zbee.zcl.cluster", ZBEE_ZCL_CID_KE, ke_handle); zbee_zcl_init_cluster( proto_zbee_zcl_ke,