docsis/src/docsis_symtable.h

/* 
 *  DOCSIS configuration file encoder. 
 *  Copyright (c) 2001 Cornel Ciocirlan, ctrl@users.sourceforge.net.
 *  Copyright (c) 2002,2003,2004,2005 Evvolve Media SRL,office@evvolve.com
 *  
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 *  DOCSIS is a registered trademark of Cablelabs, http://www.cablelabs.com
 */

/* 
    change history 
	2004-07-29 fix bug # 970994 ... SubMgmtControl had wrong docsis code 
	2003-01-10 added three new TLV types for BPI+ (courtesy of Adrian Kwong)

*/


#ifndef _DOCSIS_SYMTABLE_H


#include "docsis_common.h"
#include "docsis_decode.h"
#include "docsis_encode.h"

/* 
 * encode_nothing is used for non-trivial settings, where the encoding functions 
 * must have prototypes that don't match symbol_type (i.e. generic TLV, SNMP, etc).
 *
 * This is a list and a tree at the same time. The "parent_id" of each entry is a pointer to the 
 * parent row in this table; ClassId for example has "6" as parent ID which is the index 
 * in the table of ClassOfService
 */

/*id  "identifier" docsis_code parent_id encode_func decode_func low_limit high_limit */

symbol_type symtable[NUM_IDENTIFIERS] =  { 
{ 0,   "/* Pad */",            		0,   0,   (encode_nothing),   (decode_special),     0,        0          },
{ 1,   "DownstreamFrequency",  		1,   0,   (encode_uint),      (decode_uint),        88000000, 860000000  },
{ 2,   "UpstreamChannelId",    		2,   0,   (encode_uchar),     (decode_uchar),       0,        255        },
{ 3,   "NetworkAccess",        		3,   0,   (encode_uchar),     (decode_uchar),       0,        1          },
{ 4,   "CmMic",                		6,   0,   (encode_nothing),   (decode_md5),         0,        0          },
{ 5,   "CmtsMic",              		7,   0,   (encode_nothing),   (decode_md5),         0,        0          },
{ 6,   "ClassOfService",       		4,   0,   (encode_nothing),   (decode_aggregate),   0,        0          },
{ 7,   "ClassID",              		1,   6,   (encode_uchar),     (decode_uchar),       1,        16         },
{ 8,   "MaxRateDown",          		2,   6,   (encode_uint),      (decode_uint),        0,        52000000   },
{ 9,   "MaxRateUp",            		3,   6,   (encode_uint),      (decode_uint),        0,        10000000   },
{ 10,  "PriorityUp",           		4,   6,   (encode_uchar),     (decode_uchar),       0,        7          },
{ 11,  "GuaranteedUp",         		5,   6,   (encode_uint),      (decode_uint),        0,        10000000   },
{ 12,  "MaxBurstUp",           		6,   6,   (encode_ushort),    (decode_ushort),      0,        65535      },
{ 13,  "PrivacyEnable",        		7,   6,   (encode_uchar),     (decode_uchar),       0,        1          },
{ 14,  "SwUpgradeFilename",    		9,   0,   (encode_string),    (decode_string),      0,        0          },
{ 15,  "SnmpWriteControl",     		10,  0,   (encode_nothing),   (decode_snmp_wd),     0,        0          },
{ 16,  "SnmpMibObject",        		11,  0,   (encode_nothing),   (decode_snmp_object), 0,        0          },
{ 17,  "CpeMacAddress",        		14,  0,   (encode_ether),     (decode_ether),       0,        0          },
{ 18,  "BaselinePrivacy",      		17,  0,   (encode_nothing),   (decode_aggregate),   0,        0          },
{ 19,  "AuthTimeout",          		1,   18,  (encode_uint),      (decode_uint),        1,        30         },
{ 20,  "ReAuthTimeout",        		2,   18,  (encode_uint),      (decode_uint),        1,        30         },
{ 21,  "AuthGraceTime",        		3,   18,  (encode_uint),      (decode_uint),        1,        6047999    },
{ 22,  "OperTimeout",          		4,   18,  (encode_uint),      (decode_uint),        1,        10         },
{ 23,  "ReKeyTimeout",         		5,   18,  (encode_uint),      (decode_uint),        1,        10         },
{ 24,  "TEKGraceTime",         		6,   18,  (encode_uint),      (decode_uint),        1,        302399     },
{ 25,  "AuthRejectTimeout",    		7,   18,  (encode_uint),      (decode_uint),        1,        600        },
{ 26,  "MaxCPE",               		18,  0,   (encode_uchar),     (decode_uchar),       1,        254        },
{ 27,  "SwUpgradeServer",      		21,  0,   (encode_ip),        (decode_ip),          0,        0          },

/* DOCSIS 1.1-2.0 */

{ 28,  "UsPacketClass",        		22,  0,   (encode_nothing),   (decode_aggregate),   0,        0          },
{ 29,  "ClassifierRef",        		1,   28,  (encode_uchar),     (decode_uchar),       1,        255        },
{ 30,  "ClassifierId",         		2,   28,  (encode_ushort),    (decode_ushort),      1,        65535      },
{ 31,  "ServiceFlowRef",       		3,   28,  (encode_ushort),    (decode_ushort),      1,        65535      },
{ 32,  "ServiceFlowId",        		4,   28,  (encode_uint),      (decode_uint),        1,        0xFFFFFFFF },
{ 33,  "RulePriority",         		5,   28,  (encode_uchar),     (decode_uchar),       0,        255        },
{ 34,  "ActivationState",      		6,   28,  (encode_uchar),     (decode_uchar),       0,        1          },
{ 35,  "DscAction",            		7,   28,  (encode_uchar),     (decode_uchar),       0,        2          },
{ 36,  "IpPacketClassifier",   		9,   28,  (encode_nothing),   (decode_aggregate),   0,        0          },
{ 37,  "IpTos",                		1,   36,  (encode_hexstr),    (decode_hexstr),      3,        3          },
{ 38,  "IpProto",              		2,   36,  (encode_ushort),    (decode_ushort),      0,        257        },
{ 39,  "IpSrcAddr",            		3,   36,  (encode_ip),        (decode_ip),          0,        0          },
{ 40,  "IpSrcMask",            		4,   36,  (encode_ip),        (decode_ip),          0,        0          },
{ 41,  "IpDstAddr",            		5,   36,  (encode_ip),        (decode_ip),          0,        0          },
{ 42,  "IpDstMask",            		6,   36,  (encode_ip),        (decode_ip),          0,        0          },
{ 43,  "SrcPortStart",         		7,   36,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 44,  "SrcPortEnd",           		8,   36,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 45,  "DstPortStart",         		9,   36,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 46,  "DstPortEnd",           		10,  36,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 47,  "LLCPacketClassifier",  		10,  28,  (encode_nothing),   (decode_aggregate),   0,        0          },
{ 48,  "DstMacAddress",        		1,   47,  (encode_ethermask), (decode_ethermask),   0,        0          },
{ 49,  "SrcMacAddress",        		2,   47,  (encode_ether),     (decode_ether),       0,        0          },
{ 50,  "EtherType",            		3,   47,  (encode_hexstr),    (decode_hexstr),      3,        3          },
{ 51,  "IEEE802Classifier",    		11,  28,  (encode_nothing),   (decode_aggregate),   0,        0          },
{ 52,  "UserPriority",         		1,   51,  (encode_ushort),    (decode_ushort),      0,        0          },
{ 53,  "VlanID",               		2,   51,  (encode_ushort),    (decode_ushort),      0,        0          },

/* TODO: Vendor Specific support in the IEEE802Classifier */

{ 54,  "DsPacketClass",        		23,  0,   (encode_nothing),   (decode_aggregate),   0,        0          },
{ 55,  "ClassifierRef",        		1,   54,  (encode_uchar),     (decode_uchar),       1,        255        },
{ 56,  "ClassifierId",         		2,   54,  (encode_ushort),    (decode_ushort),      1,        65535      },
{ 57,  "ServiceFlowRef",       		3,   54,  (encode_ushort),    (decode_ushort),      1,        65535      },
{ 58,  "ServiceFlowId",        		4,   54,  (encode_uint),      (decode_uint),        1,        0xFFFFFFFF },
{ 59,  "RulePriority",         		5,   54,  (encode_uchar),     (decode_uchar),       0,        255        },
{ 60,  "ActivationState",      		6,   54,  (encode_uchar),     (decode_uchar),       0,        1          },
{ 61,  "DscAction",            		7,   54,  (encode_uchar),     (decode_uchar),       0,        2          },
{ 62,  "IpPacketClassifier",   		9,   54,  (encode_nothing),   (decode_aggregate),   0,        0          },
{ 63,  "IpTos",                		1,   62,  (encode_hexstr),    (decode_hexstr),      3,        3          },
{ 64,  "IpProto",              		2,   62,  (encode_ushort),    (decode_ushort),      0,        257        },
{ 65,  "IpSrcAddr",            		3,   62,  (encode_ip),        (decode_ip),          0,        0          },
{ 66,  "IpSrcMask",            		4,   62,  (encode_ip),        (decode_ip),          0,        0          },
{ 67,  "IpDstAddr",            		5,   62,  (encode_ip),        (decode_ip),          0,        0          },
{ 68,  "IpDstMask",            		6,   62,  (encode_ip),        (decode_ip),          0,        0          },
{ 69,  "SrcPortStart",         		7,   62,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 70,  "SrcPortEnd",           		8,   62,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 71,  "DstPortStart",         		9,   62,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 72,  "DstPortEnd",           		10,  62,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 73,  "LLCPacketClassifier",  		10,  54,  (encode_nothing),   (decode_aggregate),   0,        0          },
{ 74,  "DstMacAddress",        		1,   73,  (encode_ethermask), (decode_ethermask),   0,        0          },
{ 75,  "SrcMacAddress",        		2,   73,  (encode_ether),     (decode_ether),       0,        0          },
{ 76,  "EtherType",            		3,   73,  (encode_hexstr),    (decode_hexstr),      0,        255        },
{ 77,  "IEEE802Classifier",    		11,  54,  (encode_nothing),   (decode_aggregate),   0,        0          },
{ 78,  "UserPriority",         		1,   77,  (encode_ushort),    (decode_ushort),      0,        0          },
{ 79,  "VlanID",               		2,   77,  (encode_ushort),    (decode_ushort),      0,        0          },

/* Upstream Service Flow */

{ 80,  "UsServiceFlow",        		24,  0,   (encode_nothing),   (decode_aggregate),   0,        0          },
{ 81,  "UsServiceFlowRef",     		1,   80,  (encode_ushort),    (decode_ushort),      1,        65535      },
{ 82,  "UsServiceFlowId",      		2,   80,  (encode_uint),      (decode_uint),        1,        0xFFFFFFFF },
{ 83,  "ServiceClassName",     		4,   80,  (encode_strzero),   (decode_strzero),     2,        16         },
{ 84,  "QosParamSetType",      		6,   80,  (encode_uchar),     (decode_uchar),       0,        255        },
{ 85,  "TrafficPriority",      		7,   80,  (encode_uchar),     (decode_uchar),       0,        7          },
{ 86,  "MaxRateSustained",     		8,   80,  (encode_uint),      (decode_uint),        0,        0          },
{ 87,  "MaxTrafficBurst",      		9,   80,  (encode_uint),      (decode_uint),        0,        0          },
{ 88,  "MinReservedRate",      		10,  80,  (encode_uint),      (decode_uint),        0,        0          },
{ 89,  "MinResPacketSize",     		11,  80,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 90,  "ActQosParamsTimeout",  		12,  80,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 91,  "AdmQosParamsTimeout",  		13,  80,  (encode_ushort),    (decode_ushort),      0,        65535      },

/* Upstream Service Flow Specific params */

{ 92,  "MaxConcatenatedBurst",		14,  80,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 93,  "SchedulingType",       		15,  80,  (encode_uchar),     (decode_uchar),       0,        6          },
{ 94,  "RequestOrTxPolicy",    		16,  80,  (encode_hexstr),    (decode_hexstr),      4,        4          },
{ 95,  "NominalPollInterval",  		17,  80,  (encode_uint),      (decode_uint),        0,        0          },
{ 96,  "ToleratedPollJitter",  		18,  80,  (encode_uint),      (decode_uint),        0,        0          },
{ 97,  "UnsolicitedGrantSize", 		19,  80,  (encode_ushort),    (decode_ushort),      0,        65535      },
{ 98,  "NominalGrantInterval", 		20,  80,  (encode_uint),      (decode_uint),        0,        0          },
{ 99,  "ToleratedGrantJitter", 		21,  80,  (encode_uint),      (decode_uint),        0,        0          },
{ 100, "GrantsPerInterval",    		22,  80,  (encode_uchar),     (decode_uchar),       0,        127        },
{ 101, "IpTosOverwrite",       		23,  80,  (encode_hexstr),    (decode_hexstr),      2,        2          },
	
/* Downstream Service Flow */

{ 102, "DsServiceFlow",        		25,  0,   (encode_nothing),   (decode_aggregate),   0,        0          },
{ 103, "DsServiceFlowRef",     		1,   102, (encode_ushort),    (decode_ushort),      1,        65535      },
{ 104, "DsServiceFlowId",      		2,   102, (encode_uint),      (decode_uint),        1,        0xFFFFFFFF },
{ 105, "ServiceClassName",     		4,   102, (encode_strzero),   (decode_strzero),     2,        16         },
{ 106, "QosParamSetType",      		6,   102, (encode_uchar),     (decode_uchar),       0,        255        },
{ 107, "TrafficPriority",      		7,   102, (encode_uchar),     (decode_uchar),       0,        7          },
{ 108, "MaxRateSustained",     		8,   102, (encode_uint),      (decode_uint),        0,        0xFFFFFFFF },
{ 109, "MaxTrafficBurst",      		9,   102, (encode_uint),      (decode_uint),        0,        0xFFFFFFFF },
{ 110, "MinReservedRate",      		10,  102, (encode_uint),      (decode_uint),        0,        0xFFFFFFFF },
{ 111, "MinResPacketSize",     		11,  102, (encode_ushort),    (decode_ushort),      0,        65535      },
{ 112, "ActQosParamsTimeout",  		12,  102, (encode_ushort),    (decode_ushort),      0,        65535      },
{ 113, "AdmQosParamsTimeout",  		13,  102, (encode_ushort),    (decode_ushort),      0,        65535      },

/* Downstream Service Flow Specific Params */

{ 114, "MaxDsLatency",         		14,  102, (encode_uint),      (decode_uint),        0,        0          },

/* Payload Header Suppression - Appendix C.2.2.8 */

{ 115, "PHS",                  		26,  0,   (encode_nothing),   (decode_aggregate),   0,        0          },
{ 116, "PHSClassifierRef",        	1,   115, (encode_uchar),     (decode_uchar),       1,        255        },
{ 117, "PHSClassifierId",         	2,   115, (encode_ushort),    (decode_ushort),      1,        65535      },
{ 118, "PHSServiceFlowRef",       	3,   115, (encode_ushort),    (decode_ushort),      1,        65535      },
{ 119, "PHSServiceFlowId",        	4,   115, (encode_uint),      (decode_uint),        1,        0xFFFFFFFF },
/* Payload Header Suppression Rule - Appendix C.2.2.10 */
{ 120, "PHSField",        		7,   115, (encode_hexstr),    (decode_hexstr),      1,        255	      },
{ 121, "PHSIndex",        		8,   115, (encode_uchar),     (decode_uchar),       1,        255	      },
{ 122, "PHSMask",        		9,   115, (encode_hexstr),    (decode_hexstr),      1,        255	      },
{ 123, "PHSSize",        		10,  115, (encode_uchar),     (decode_uchar),       1,        255	      },
{ 124, "PHSVerify",        		11,  115, (encode_uchar),     (decode_uchar),       0,        1	      },

{ 125, "MaxClassifiers",       		28,  0,   (encode_ushort),    (decode_ushort),      0,        0          },
{ 126, "GlobalPrivacyEnable",  		29,  0,   (encode_uchar),     (decode_uchar),       0,        0          },

/* BPI+ SubTLV's */

{ 127, "SAMapWaitTimeout",     		8,   18,  (encode_uint),      (decode_uint),        1,        10         },
{ 128, "SAMapMaxRetries",      		9,   18,  (encode_uint),      (decode_uint),        0,        10         },
	
/* ManufacturerCVC */

{ 129, "MfgCVCData",           		32,   0,  (encode_hexstr),    (decode_hexstr),      0,        255        },

/* Vendor Specific */ 
{ 130, "VendorSpecific",       		43,   0,  (encode_nothing),   (decode_vspecific),   0,        0          },
{ 131, "VendorIdentifier",     		8,  130,  (encode_hexstr),    (decode_hexstr),      3,        3          },

/* SNMPv3 Kickstart */
{ 132, "SnmpV3Kickstart",   		34,   0,  (encode_nothing),   (decode_aggregate),   0,        0          },
/* TODO: SP-RFI-v2.0 says the SecurityName is UTF8 encoded */
{ 133, "SnmpV3SecurityName",   		1,  132,  (encode_string),   (decode_string),  	 1,        16         },
{ 134, "SnmpV3MgrPublicNumber", 	2,  132,  (encode_hexstr),    (decode_hexstr),   1,        514	      },

/* Snmpv3 Notification Receiver */
{ 135, "SnmpV3TrapReceiver",   		38,   0,  (encode_nothing),   (decode_aggregate), 0,        0          },
{ 136, "SnmpV3TrapRxIP", 		1,   135, (encode_ip),    	   (decode_ip),   0,        0          },
{ 137, "SnmpV3TrapRxPort",     		2,   135, (encode_ushort),    (decode_ushort),   0,        0          },
{ 138, "SnmpV3TrapRxType",     		3,   135, (encode_ushort),    (decode_ushort),   1,        5          },
{ 139, "SnmpV3TrapRxTimeout",  		4,   135, (encode_ushort),    (decode_ushort),   0,        65535      },
{ 140, "SnmpV3TrapRxRetries",  		5,   135, (encode_ushort),    (decode_ushort),   0,        65535      },
{ 141, "SnmpV3TrapRxFilterOID",		6,   135, (encode_oid),       (decode_oid),  	 1,        5          },
{ 142, "SnmpV3TrapRxSecurityName",	7,   135, (encode_string),   (decode_string),  	 1,        16         },
{ 143, "DocsisTwoEnable",      		39,   0,  (encode_uchar),     (decode_uchar),    0,        1          },
/* Modem Capabilities Encodings */
{ 144, "ModemCapabilities",             5,   0,   (encode_nothing),   (decode_aggregate), 0,      0      },
{ 145, "ConcatenationSupport",          1,   144, (encode_uchar),     (decode_uchar),           0,      1       },
{ 146, "ModemDocsisVersion",            2,   144, (encode_uchar),     (decode_uchar),           0,      2       },
{ 147, "FragmentationSupport",          3,   144, (encode_uchar),     (decode_uchar),           0,      1       },
{ 148, "PHSSupport",          		4,   144, (encode_uchar),     (decode_uchar),           0,      1       },
{ 149, "IGMPSupport",          		5,   144, (encode_uchar),     (decode_uchar),           0,      1       },
{ 150, "BaselinePrivacySupport",	6,   144, (encode_uchar),     (decode_uchar),           0,      1       },
{ 151, "DownstreamSAIDSupport",		7,   144, (encode_uchar),     (decode_uchar),           0,      255       },
{ 152, "UpstreamSIDSupport",		8,   144, (encode_uchar),     (decode_uchar),           0,      255       },
{ 153, "DCCSupport",			12,  144, (encode_uchar),     (decode_uchar),           0,      1       },
{ 154, "SubMgmtControl", 		35,  0,	  (encode_hexstr),    (decode_hexstr), 		3,	3 	},
{ 155, "SubMgmtFilters", 		37,  0,	  (encode_ushort_list), (decode_ushort_list), 	4,	4 	},
{ 156, "SnmpMibObject",   		64, 0,    (encode_nothing),     (decode_snmp_object),    1,        2048       },
/* PacketCable MTA Configuration File Delimiter  */
{ 157, "MtaConfigDelimiter",   		254, 0,   (encode_uchar),     (decode_uchar),    1,        255        },
{ 158, "DsChannelList",   		41, 0,    (encode_nothing),     (decode_aggregate),    1,        255        },
{ 159, "SingleDsChannel",   		1, 158,   (encode_nothing),     (decode_aggregate),    1,        255        },
{ 160, "SingleDsTimeout",   		1, 159,   (encode_ushort),     (decode_ushort),    0,        65535 },
{ 161, "SingleDsFrequency",   		2, 159,   (encode_uint),     (decode_uint),    0,        0xFFFFFFFF },
{ 162, "DsFreqRange",   		2, 158,   (encode_nothing),     (decode_aggregate),    1,        255        },
{ 163, "DsFreqRangeTimeout",   		1, 162,   (encode_ushort),     (decode_ushort),    0,        65535 },
{ 164, "DsFreqRangeStart",   		2, 162,   (encode_uint),     (decode_uint),    0,        0xFFFFFFFF },
{ 165, "DsFreqRangeEnd",   		3, 162,   (encode_uint),     (decode_uint),    0,        0xFFFFFFFF },
{ 166, "DsFreqRangeStepSize",   	4, 162,   (encode_uint),     (decode_uint),    0,        0xFFFFFFFF },
{ 167, "DefaultScanTimeout",   		3, 158,   (encode_ushort),     (decode_ushort),    0,        65535 },
{ 168, "TftpTimestamp",   		19, 0,    (encode_uint),     (decode_uint),    0,        0xFFFFFFFF        },
{ 169, "TftpModemAddress",   		20, 0,    (encode_ip),     (decode_ip),    0,        0     },
{ 170, "ManufacturerCVC",      		32,   0,  (encode_nothing),    (decode_hexstr),      0,        255    },
{ 171, "CoSignerCVCData",      		33,   0,  (encode_hexstr),    (decode_hexstr),      0,        255    },
{ 172, "CoSignerCVC",      		33,   0,  (encode_nothing),    (decode_hexstr),      0,        255    },

/* Generic TLV ... we only use the limits, code and length don't matter ...*/
{ 998, "GenericTLV",           		0, 0,     (encode_nothing),   (decode_special),  1,        255        }, 
{ 999, "/*EndOfDataMkr*/",     		255, 0,   (encode_nothing),   (decode_special),  0,        0          } 
};

#endif /* _DOCSIS_SYMTABLE_H */