path: root/epan/dissectors/packet-docsis-tlv.h

/* packet-docsis-tlv.h
 * Contains Definitions for Configuration types
 * Copyright 2002, Anand V. Narwani <anand[AT]narwani.org>
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */


/* Define Top Level TLV Types
 * Please see http://www.cablemodem.com/Specs/SP-RFIv1.1-I08-020301.pdf
 * Appendix C.
 */
#ifndef __PACKET_TLV_H__
#define __PACKET_TLV_H__
#define TLV_DOWN_FREQ 1
#define TLV_CHNL_ID 2
#define TLV_NET_ACCESS 3
#define TLV_COS 4
#define TLV_MODEM_CAP 5
#define TLV_CM_MIC 6
#define TLV_CMTS_MIC 7
#define TLV_VENDOR_ID 8
#define TLV_SW_UPG_FILE 9
#define TLV_SNMP_WRITE_CTRL 10
#define TLV_SNMP_OBJECT 11
#define TLV_MODEM_IP 12
#define TLV_SVC_UNAVAIL 13
#define TLV_ETHERNET_MAC 14
#define TLV_TEL_SETTINGS 15
#define TLV_BPI_CONFIG 17
#define TLV_MAX_CPES 18
#define TLV_TFTP_TIME 19
#define TLV_TFTP_MODEM_ADDRESS 20
#define TLV_SW_UPG_SRVR 21
#define TLV_UPSTREAM_CLASSIFIER 22
#define TLV_DOWN_CLASSIFIER 23
#define TLV_UPSTREAM_SERVICE_FLOW 24
#define TLV_DOWN_SERVICE_FLOW 25
#define TLV_PHS 26
#define TLV_HMAC_DIGEST 27
#define TLV_MAX_CLASSIFIERS 28
#define TLV_PRIVACY_ENABLE 29
#define TLV_AUTH_BLOCK 30
#define TLV_KEY_SEQ_NUM 31
#define TLV_MFGR_CVC 32
#define TLV_COSIGN_CVC 33
#define TLV_SNMPV3_KICKSTART 34
#define TLV_SUBS_MGMT_CTRL 35
#define TLV_SUBS_MGMT_CPE 36
#define TLV_SUBS_MGMT_FLTR 37
#define TLV_SNMPV3_NTFY_RCVR 38
#define TLV_ENABLE_20_MODE 39
#define TLV_ENABLE_TEST_MODES 40
#define TLV_DS_CH_LIST 41
#define TLV_MC_MAC_ADDRESS 42
#define TLV_DOCSIS_EXTENSION_FIELD 43
#define TLV_VENDOR_SPEC 44
#define TLV_DUT_FILTER 45
#define TLV_TCC 46
#define TLV_SID_CL 47
#define TLV_RCP 48
#define TLV_RCC 49
#define TLV_DSID 50
#define TLV_SEC_ASSOC 51
#define TLV_INIT_CH_TIMEOUT 52
#define TLV_SNMPV1V2_COEX 53
#define TLV_SNMPV3_ACC_VIEW 54
#define TLV_SNMP_CPE_ACC_CTRL 55
#define TLV_CH_ASGN 56
#define TLV_CM_INIT_REASON 57
#define TLV_SW_UPG_SRVR_IPV6 58
#define TLV_TFTP_PROV_CM_IPV6_ADDR 59
#define TLV_US_DROP_CLFY 60
#define TLV_SUBS_MGMT_IPV6_LST 61
#define TLV_US_DROP_CLFY_GROUP_ID 62
#define TLV_SUBS_MGMT_CTRL_MAX_CPE_IPV6 63
#define TLV_CMTS_MC_SESS_ENC 64
#define TLV_L2VPN_MAC_AGING 65
#define TLV_MGMT_EVENT_CTRL 66
#define TLV_EM_MODE_INDICATOR 75
#define TLV_EM_ID_LIST_FOR_CM 78
#define TLV_FDX_TG_ASSIGNMENT 85
#define TLV_FDX_RESET 86
#define TLV_END 255

/* Define DOCSIS 1.0 Class Of Service Configuration Types
 * These are subtypes of TLV_COS (4)
 */
#define COS_CLASSID 1
#define COS_MAX_DOWN 2
#define COS_MAX_UP 3
#define COS_UP_CH_PRIO 4
#define COS_MIN_UP_RATE 5
#define COS_MAX_UP_BURST 6
#define COS_BP_ENABLE 7

/* Define SNMPV3 KickStart subtypes
 * These are subtypes of TLV_SNMPV3_KICKSTART (34)
 */
#define SNMPV3_SEC_NAME 1
#define SNMPV3_MGR_PUB_NUM 2

/* Define Modem Capabilities Subtypes
 * These are subtypes of TLV_MODEM_CAP (5)
 */
#define CAP_CONCAT 1
#define CAP_DOCSIS_VER 2
#define CAP_FRAG 3
#define CAP_PHS 4
#define CAP_IGMP 5
#define CAP_PRIVACY 6
#define CAP_DOWN_SAID 7
#define CAP_UP_SID 8
#define CAP_OPT_FILT 9
#define CAP_XMIT_EQPERSYM 10
#define CAP_NUM_XMIT_EQ_TAPS 11
#define CAP_DCC 12
#define CAP_IP_FILTERS 13
#define CAP_LLC_FILTERS 14
#define CAP_EXP_UNICAST_SID 15
#define CAP_RNG_HOFF 16
#define CAP_L2VPN 17
#define CAP_L2VPN_ESAFE 18
#define CAP_DUT_FILTERING 19
#define CAP_US_FREQ_RNG 20
#define CAP_US_SRATE 21
#define CAP_SAC 22
#define CAP_CODE_HOP_M2 23
#define CAP_MTC 24
#define CAP_512_MSPS_UTC 25
#define CAP_256_MSPS_UTC 26
#define CAP_TOTAL_SID_CLUST 27
#define CAP_SID_PER_SF 28
#define CAP_MRC 29
#define CAP_TOTAL_DSID 30
#define CAP_RESEQ_DSID 31
#define CAP_MC_DSID 32
#define CAP_MC_DSID_FWD 33
#define CAP_FCTYPE_FWD 34
#define CAP_DPV 35
#define CAP_UGS 36
#define CAP_MAP_UCD 37
#define CAP_UDC 38
#define CAP_IPV6 39
#define CAP_EXT_US_TRNS_PWR 40
#define CAP_EM 44
#define CAP_CM_STATUS_ACK 46
#define CAP_EM_PREF 47
#define CAP_EXT_PKT_LEN_SUP_CAP 48
#define CAP_OFDM_MULT_RECV_CHAN_SUP 49
#define CAP_OFDMA_MULT_TRANS_CHAN_SUP 50
#define CAP_DOWN_OFDM_PROF_SUP 51
#define CAP_DOWN_OFDM_CHAN_SUBC_QAM_MOD_SUP 52
#define CAP_UP_OFDMA_CHAN_SUBC_QAM_MOD_SUP 53
#define CAP_DOWN_LOWER_BAND_EDGE_CONF 54
#define CAP_DOWN_UPPER_BAND_EDGE_CONF 55
#define CAP_DIPL_UP_UPPER_BAND_EDGE_CONF 56
#define CAP_DOCSIS_TIME_PROT_MODE 57
#define CAP_DOCSIS_TIME_PROT_PERF_SUP 58
#define CAP_PMAX 59
#define CAP_DIPL_DOWN_LOWER_BAND_EDGE 60
#define CAP_DIPL_DOWN_UPPER_BAND_EDGE 61
#define CAP_DIPL_UP_UPPER_BAND_EDGE 62
#define CAP_ADVANCED_BAND_PLAN 63
#define CAP_EXTENDED_SF_SID_CLUSTER_ASSIGN 74
#define CAP_LOW_LATENCY_SUP 76
#define CAP_ADVANCED_DOWN_LOWER_BAND_EDGE_CONF 79
#define CAP_ADVANCED_DOWN_UPPER_BAND_EDGE_CONF 80
#define CAP_ADVANCED_UP_UPPER_BAND_EDGE_CONF 81
#define CAP_ADVANCED_DOWN_LOWER_BAND_EDGE_OPTIONS_LIST 82
#define CAP_ADVANCED_DOWN_UPPER_BAND_EDGE_OPTIONS_LIST 83
#define CAP_ADVANCED_UP_UPPER_BAND_EDGE_OPTIONS_LIST 84
#define CAP_EXTENDED_POWER_OPTIONS 85


/* Define Classifier subtypes
 * These are subtypes of either:
 * TLV_UPSTREAM_CLASSIFIER (22)
 * TLV_DOWN_CLASSIFIER (23)
 */
#define CFR_REF 1
#define CFR_ID 2
#define CFR_SFLOW_REF 3
#define CFR_SFLOW_ID 4
#define CFR_RULE_PRI 5
#define CFR_ACT_STATE 6
#define CFR_DSA_ACTION 7
#define CFR_ERROR 8
#define CFR_IP_CLASSIFIER 9
#define CFR_ETH_CLASSIFIER 10
#define CFR_8021Q_CLASSIFIER 11
#define CFR_IP6_CLASSIFIER 12
#define CFR_VENDOR_SPEC 43

/* Define Classifier Error sub-subtypes
 * These are subtypes of CFR_ERROR ([22/23].8)
 */
#define CFR_ERR_PARAM 1
#define CFR_ERR_CODE 2
#define CFR_ERR_MSG 3

/* Define IP Classifier sub-subtypes
 * These are subtypes of CFR_IP_CLASSIFIER ([22/23].9)
 */
#define CFR_IP_TOS_RANGE_MASK 1
#define CFR_IP_PROTO 2
#define CFR_IP_SOURCE_ADDR 3
#define CFR_IP_SOURCE_MASK 4
#define CFR_IP_DEST_ADDR 5
#define CFR_IP_DEST_MASK 6
#define CFR_IP_SRCPORT_START 7
#define CFR_IP_SRCPORT_END 8
#define CFR_IP_DSTPORT_START 9
#define CFR_IP_DSTPORT_END 10

/* Define IPv6 Classifier sub-subtypes
 * These are subtypes of CFR_IP_CLASSIFIER ([22/23].12)
 */
#define CFR_IP6_TRAFFIC_CLASS 1
#define CFR_IP6_FLOW_LABEL 2
#define CFR_IP6_NEXT_HEADER 3
#define CFR_IP6_SOURCE_ADDR 4
#define CFR_IP6_SOURCE_PREFIX_LENGTH 5
#define CFR_IP6_DESTINATION_ADDR 6
#define CFR_IP6_DESTINATION_PREFIX_LENGTH 7

/* Define Ethertype Classifier sub-subtypes
 * These are subtypes of CFR_ETH_CLASSIFIER ([22/23].10)
 */
#define CFR_ETH_DST_MAC 1
#define CFR_ETH_SRC_MAC 2
#define CFR_ETH_DSAP 3

/* Define 802.1P/Q Classifier sub-subtypes
 * These are subtypes of CFR_8021Q_CLASSIFIER ([22/23].11)
 */
#define CFR_D1Q_USER_PRI 1
#define CFR_D1Q_VLAN_ID 2
#define CFR_D1Q_VENDOR_SPEC 43

/* Define Upstream/Downstream Service flow subtypes
 * These are subtypes of:
 * TLV_UPSTREAM_SERVICE_FLOW (24)
 * TLV_DOWN_SERVICE_FLOW (25)
 */
#define SFW_REF 1
#define SFW_ID 2
#define SFW_SID 3
#define SFW_SERVICE_CLASS_NAME 4
#define SFW_ERRORS 5
#define SFW_QOS_SET_TYPE 6
#define SFW_TRAF_PRI 7
#define SFW_MAX_SUSTAINED 8
#define SFW_MAX_BURST 9
#define SFW_MIN_RSVD_TRAF 10
#define SFW_MIN_RSVD_PACKETSIZE 11
#define SFW_ACTIVE_QOS_TIMEOUT 12
#define SFW_ADMITT_QOS_TIMEOUT 13
#define SFW_IP_TOS_OVERWRITE 23
#define SFW_PEAK_TRAFFIC_RATE 27
#define SFW_REQUIRED_ATTRIBUTE_MASK 31
#define SFW_FORBIDDEN_ATTRIBUTE_MASK 32
#define SFW_ATTRIBUTE_AGGREGATION_RULE_MASK 33
#define SFW_VENDOR_SPEC 43
/* The following types only apply to
 * TLV_UPSTREAM_SERVICE_FLOW (24)
 */
#define SFW_MAX_CONCAT_BURST 14
#define SFW_SCHEDULING_TYPE 15
#define SFW_REQ_XMIT_POL 16
#define SFW_NOM_POLL_INT 17
#define SFW_POLL_JTTR_TOL 18
#define SFW_UG_SIZE 19
#define SFW_NOM_GRNT_INTV 20
#define SFW_GRNT_JTTR_TOL 21
#define SFW_GRNTS_PER_INTV 22
#define SFW_UG_TIME_REF 24
#define SFW_CONTENTION_REQ_BACKOFF_WINDOW_MULT 25
#define SFW_NUM_OF_BYTES_REQUESTED_MULT 26

/* The following types only apply to
 * TLV_DOWN_SERVICE_FLOW (25)
 */
#define SFW_MAX_DOWN_LAT 14
#define SFW_DOWN_RESEQ 17

/* Define Service Flow Error sub-subtypes
 * These are subtypes of
 * SFW_ERRORS ([24/25].5)
 */
#define SFW_ERR_PARAM 1
#define SFW_ERR_CODE 2
#define SFW_ERR_MSG 3


/* Define Payload Header Suppression subtypes
 * These are subtypes of TLV_PHS (26)
 */
#define PHS_CLSFR_REF 1
#define PHS_CLSFR_ID 2
#define PHS_SFLOW_REF 3
#define PHS_SFLOW_ID 4
#define PHS_DSC_ACTION 5
#define PHS_ERRORS 6
#define PHS_FIELD 7
#define PHS_INDEX 8
#define PHS_MASK 9
#define PHS_SUP_SIZE 10
#define PHS_VERIFICATION 11
#define PHS_DBC_ACTION 13
#define PHS_VENDOR_SPEC 43

/* Define PHS Error sub-subtypes
 * These are subtypes of PHS_ERRORS (26.6)
 */
#define PHS_ERR_PARAM 1
#define PHS_ERR_CODE 2
#define PHS_ERR_MSG 3


/* Define DS Channel List sub-types
 * These are subtypes of TLV_DS_CHANNEL_LIST (41)
 */
#define DS_CH_LIST_SINGLE 1
#define DS_CH_LIST_RANGE 2
#define DS_CH_LIST_DEFAULT_TIMEOUT 3

/* Define Singe Downstream Channel sub-types
 * These are subtypes of DS_CH_LIST_SINGLE (41.1)
 */
#define SINGLE_CH_TIMEOUT 1
#define SINGLE_CH_FREQ 2

/* Define Singe Downstream Channel sub-types
 * These are subtypes of DS_CH_LIST_RANGE (41.2)
 */
#define FREQ_RNG_TIMEOUT 1
#define FREQ_RNG_START 2
#define FREQ_RNG_END 3
#define FREQ_RNG_STEP 4

/* Define DUT sub-types
 * These are subtypes of TLV_DUT_FILTER (45)
 */
#define DUT_CONTROL 1
#define DUT_CMIM 2

/* Define TCC sub-types
 * These are subtypes of TLV_TCC (46)
 */
#define TLV_TCC_REFID 1
#define TLV_TCC_US_CH_ACTION 2
#define TLV_TCC_US_CH_ID 3
#define TLV_TCC_NEW_US_CH_ID 4
#define TLV_TCC_UCD 5
#define TLV_TCC_RNG_SID 6
#define TLV_TCC_INIT_TECH 7
#define TLV_TCC_RNG_PARMS 8
#define TLV_TCC_DYN_RNG_WIN 9
#define TLV_TCC_P1_6HI 10
#define TLV_TCC_ASSIGN_OFDMA_UP_DATA_PROF 11
#define TLV_TCC_EXTENDED_DRW 14
#define TLV_TCC_EXTENDED_US_RNG_PWR 15
#define TLV_TCC_OUDP_SOUNDING_SID 16
#define TLV_TCC_ERR 254

/* Define TLV_TCC_RNG_PARMS sub-types
 * These are subtypes of TLV_TCC_RNG_PARMS (46.8)
 */
#define RNG_PARMS_US_CH_ID 1
#define RNG_PARMS_TIME_OFF_INT 2
#define RNG_PARMS_TIME_OFF_FRAC 3
#define RNG_PARMS_POWER_OFF 4
#define RNG_PARMS_FREQ_OFF 5

/* Define TLV_TCC_ERR sub-types
 * These are subtypes of TLV_TCC_ERR (46.254)
 */
#define TCC_ERR_SUBTYPE 1
#define TCC_ERR_CODE 2
#define TCC_ERR_MSG 3

/* Define TLV_SID_CLUSTER sub-types
 * These are subtypes of TLV_SID_CLUSTER (47)
 */
#define SID_CL_SF_ID 1
#define SID_CL_ENC 2
#define SID_CL_SO_CRIT 3

/* Define SID_CL_ENC sub-types
 * These are subtypes of SID_CL_ENC (47.2)
 */
#define SID_CL_ENC_ID 1
#define SID_CL_ENC_MAP 2

/* Define SID_CL_ENC_MAP sub-types
 * These are subtypes of SID_CL_ENC_MAP (47.2.2)
 */
#define SID_CL_MAP_US_CH_ID 1
#define SID_CL_MAP_SID 2
#define SID_CL_MAP_ACTION 3

/* Define SID_CL_SO_CRIT sub-types
 * These are subtypes of SID_CL_SO_CRIT (47.3)
 */
#define SID_CL_SO_MAX_REQ 1
#define SID_CL_SO_MAX_OUT_BYTES 2
#define SID_CL_SO_MAX_REQ_BYTES 3
#define SID_CL_SO_MAX_TIME 4

/* Define TLV_RCP sub-types
 * These are subtypes of TLV_RCP (48)
 */
#define TLV_RCP_ID 1
#define TLV_RCP_NAME 2
#define TLV_RCP_FREQ_SPC 3
#define TLV_RCP_RCV_MOD_ENC 4
#define TLV_RCP_RCV_CH 5
#define TLV_RCP_VEN_SPEC 43
#define TLV_RCC_ERR 254

/* Define TLV_RCC sub-types
 * These are subtypes of TLV_RCP (49), and not common with TLV_RCP (48)
 */
#define TLV_RCC_PARTIAL_SERV_DOWN_CHAN 6
#define TLV_RCC_SRCC 7
#define TLV_RCC_PRIM_DOWN_CHAN 8

/* Define TLV_RCC_SRCC sub-types (49.7)
 */
#define RCC_SRCC_PRIM_DS_CHAN_ASSIGN 1
#define RCC_SRCC_DS_CHAN_ASSIGN 2
#define RCC_SRCC_DS_PROF_ASSIGN 3

/* Define TLV_RCC_SRCC_DS_PROF_ASSIGN sub-types (49.7.3)
 */
#define RCC_SRCC_DS_PROF_ASSIGN_DCID 1
#define RCC_SRCC_DS_PROF_ASSIGN_PROF_LIST 2

/* Define TLV_RCP_RCV_MOD_ENC sub-types
 * These are subtypes of TLV_RCP_RCV_MOD_ENC (48.4)
 */
#define RCV_MOD_ENC_IDX 1
#define RCV_MOD_ENC_ADJ_CH 2
#define RCV_MOD_ENC_CH_BL_RNG 3
#define RCV_MOD_ENC_CTR_FREQ_ASGN 4
#define RCV_MOD_ENC_RSQ_CH_SUBS_CAP 5
#define RCV_MOD_ENC_CONN 6
#define RCV_MOD_ENC_PHY_LAYR_PARMS 7

/* Define RCV_MOD_ENC_CH_BL_RNG sub-types
 * These are subtypes of RCV_MOD_ENC_CH_BL_RNG (48.4.3)
 */
#define CH_BL_RNG_MIN_CTR_FREQ 1
#define CH_BL_RNG_MAX_CTR_FREQ 2

/* Define TLV_RCP_RCV_CH sub-types
 * These are subtypes of TLV_RCP_RCV_CH (48.5)
 */
#define RCV_CH_IDX 1
#define RCV_CH_CONN 2
#define RCV_CH_CONN_OFF 3
#define RCV_CH_CTR_FREQ_ASGN 4
#define RCV_CH_PRIM_DS_CH_IND 5

/* Define TLV_RCC_ERR sub-types
 * These are subtypes of TLV_RCC_ERR (49.254)
 */
#define RCC_ERR_MOD_OR_CH 1
#define RCC_ERR_IDX 2
#define RCC_ERR_PARAM 3
#define RCC_ERR_CODE 4
#define RCC_ERR_MSG 5


/* Define TLV_DSID sub-types
 * These are subtypes of TLV_DSID (50)
 */
#define TLV_DSID_ID 1
#define TLV_DSID_ACTION 2
#define TLV_DSID_DS_RESEQ 3
#define TLV_DSID_MC 4

/* Define TLV_DSID_DS_RESEQ sub-types
 * These are subtypes of TLV_DSID_DS_RESEQ (50.3)
 */
#define DS_RESEQ_DSID 1
#define DS_RESEQ_CH_LST 2
#define DS_RESEQ_WAIT_TIME 3
#define DS_RESEQ_WARN_THRESH 4
#define DS_RESEQ_HO_TIMER 5

/* Define TLV_DSID_MC sub-types
 * These are subtypes of TLV_DSID_DS_MC (50.4)
 */

#define TLV_DSID_MC_ADDR 1
#define TLV_DSID_MC_CMIM 2
#define TLV_DSID_MC_GROUP 3
#define TLV_DSID_MC_PHS 26

/* Define TLV_DSID_MC_ADDR sub-types
 * These are subtypes of TLV_DSID_MC_ADDR (50.4.1)
 */
#define MC_ADDR_ACTION 1
#define MC_ADDR_ADDR 2

/* Define TLV_SEC_ASSOC sub-types
 * These are subtypes of TLV_SEC_ASSOC (51)
 */
#define TLV_SEC_ASSOC_ACTION 1
#define TLV_SEC_ASSOC_DESC 2

/* Define TLV_CH_ASGN sub-types
 * These are subtypes of TLV_CH_ASGN (56)
 */
#define TLV_CH_ASGN_US_CH_ID 1
#define TLV_CH_ASGN_RX_FREQ 2

/* Define TLV_CMTS_MC_SESS_ENC sub-types
 * These are subtypes of TLV_CMTS_MC_SESS_ENC (64)
 */
#define CMTS_MC_SESS_ENC_GRP 1
#define CMTS_MC_SESS_ENC_SRC 2
#define CMTS_MC_SESS_ENC_CMIM 3

/* Define TLV_FDX_TG_ASSIGNMENT sub-types
 * These are subtypes of TLV_FDX_TG_ASSIGNMENT (85)
 */
#define TLV_FDX_TG_ASSIGNMENT_TG_ID 1
#define TLV_FDX_TG_ASSIGNMENT_RBA_TYPE 2
#define TLV_FDX_TG_ASSIGNMENT_RBA_MESSAGE 3

extern value_string_ext docsis_conf_code_ext;

#endif