1 // Copyright (C) 2013-2021 Internet Systems Consortium, Inc. ("ISC") 2 // 3 // This Source Code Form is subject to the terms of the Mozilla Public 4 // License, v. 2.0. If a copy of the MPL was not distributed with this 5 // file, You can obtain one at http://mozilla.org/MPL/2.0/. 6 7 #ifndef DOCSIS3_OPTION_DEFS_H 8 #define DOCSIS3_OPTION_DEFS_H 9 10 #include <dhcp/std_option_defs.h> 11 #include <dhcp/option_data_types.h> 12 13 /// @brief global docsis3 option spaces 14 #define DOCSIS3_V4_OPTION_SPACE "docsis3-v4" 15 #define DOCSIS3_V6_OPTION_SPACE "docsis3-v6" 16 17 namespace isc { 18 namespace dhcp { 19 20 #define VENDOR_ID_CABLE_LABS 4491 21 22 #define DOCSIS3_V4_ORO 1 23 #define DOCSIS3_V4_TFTP_SERVERS 2 24 25 /// @brief Definitions of standard DHCPv4 options. 26 const OptionDefParams DOCSIS3_V4_OPTION_DEFINITIONS[] = { 27 { "oro", DOCSIS3_V4_ORO, 28 DOCSIS3_V4_OPTION_SPACE, OPT_UINT8_TYPE, true, NO_RECORD_DEF, "" }, 29 { "tftp-servers", DOCSIS3_V4_TFTP_SERVERS, 30 DOCSIS3_V4_OPTION_SPACE, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" } 31 }; 32 33 /// Number of option definitions defined. 34 const int DOCSIS3_V4_OPTION_DEFINITIONS_SIZE = 35 sizeof(DOCSIS3_V4_OPTION_DEFINITIONS) / 36 sizeof(DOCSIS3_V4_OPTION_DEFINITIONS[0]); 37 38 /// @todo define remaining docsis3 v6 codes 39 #define DOCSIS3_V6_ORO 1 40 #define DOCSIS3_V6_DEVICE_TYPE 2 41 #define DOCSIS3_V6_VENDOR_NAME 10 42 #define DOCSIS3_V6_TFTP_SERVERS 32 43 #define DOCSIS3_V6_CONFIG_FILE 33 44 #define DOCSIS3_V6_SYSLOG_SERVERS 34 45 #define DOCSIS3_V6_DEVICE_ID 36 46 #define DOCSIS3_V6_TIME_SERVERS 37 47 #define DOCSIS3_V6_TIME_OFFSET 38 48 49 // The following DOCSIS3 options are inserted by the CMTS (which acts as 50 // a relay agent) 51 #define DOCSIS3_V6_CMTS_CM_MAC 1026 52 53 /// @brief Definitions of standard DHCPv6 options. 54 const OptionDefParams DOCSIS3_V6_OPTION_DEFINITIONS[] = { 55 { "oro", DOCSIS3_V6_ORO, 56 DOCSIS3_V6_OPTION_SPACE, OPT_UINT16_TYPE, true, NO_RECORD_DEF, "" }, 57 { "device-type", DOCSIS3_V6_DEVICE_TYPE, 58 DOCSIS3_V6_OPTION_SPACE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" }, 59 { "vendor-type", DOCSIS3_V6_VENDOR_NAME, 60 DOCSIS3_V6_OPTION_SPACE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" }, 61 { "tftp-servers", DOCSIS3_V6_TFTP_SERVERS, 62 DOCSIS3_V6_OPTION_SPACE, OPT_IPV6_ADDRESS_TYPE, true, NO_RECORD_DEF, "" }, 63 { "time-servers", DOCSIS3_V6_TIME_SERVERS, 64 DOCSIS3_V6_OPTION_SPACE, OPT_IPV6_ADDRESS_TYPE, true, NO_RECORD_DEF, "" }, 65 { "config-file", DOCSIS3_V6_CONFIG_FILE, 66 DOCSIS3_V6_OPTION_SPACE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" }, 67 { "syslog-servers", DOCSIS3_V6_SYSLOG_SERVERS, 68 DOCSIS3_V6_OPTION_SPACE, OPT_IPV6_ADDRESS_TYPE, true, NO_RECORD_DEF, "" }, 69 { "device-id", DOCSIS3_V6_DEVICE_ID, 70 DOCSIS3_V6_OPTION_SPACE, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" }, 71 { "time-offset", DOCSIS3_V6_TIME_OFFSET, 72 DOCSIS3_V6_OPTION_SPACE, OPT_INT32_TYPE, false, NO_RECORD_DEF, "" }, 73 { "cmts-cm-mac", DOCSIS3_V6_CMTS_CM_MAC, 74 DOCSIS3_V6_OPTION_SPACE, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" } 75 // @todo add definitions for all remaining options. 76 }; 77 78 /// Number of option definitions defined. 79 const int DOCSIS3_V6_OPTION_DEFINITIONS_SIZE = 80 sizeof(DOCSIS3_V6_OPTION_DEFINITIONS) / 81 sizeof(DOCSIS3_V6_OPTION_DEFINITIONS[0]); 82 83 /// The class as specified in vendor-class option by the devices 84 extern const char* DOCSIS3_CLASS_EROUTER; 85 extern const char* DOCSIS3_CLASS_MODEM; 86 87 } // namespace dhcp 88 } // namespace isc 89 90 #endif // DOCSIS3_OPTION_DEFS_H 91