blob: 8fb381ca74c1f44bc45e41bac7f84e673c4cbe5b [file] [log] [blame]
Chip Boling6e27b352020-02-14 09:10:01 -06001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
Andrea Campanella7167ebb2020-02-24 09:56:38 +01003 * Copyright 2020-present Open Networking Foundation
4
Chip Boling6e27b352020-02-14 09:10:01 -06005 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
Andrea Campanella7167ebb2020-02-24 09:56:38 +01008
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Andrea Campanella7167ebb2020-02-24 09:56:38 +010010
Chip Boling6e27b352020-02-14 09:10:01 -060011 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
Andrea Campanella7167ebb2020-02-24 09:56:38 +010017 /*
Chip Boling6e27b352020-02-14 09:10:01 -060018 * NOTE: This file was generated, manual edits will be overwritten!
19 *
20 * Generated by 'goCodeGenerator.py':
21 * https://github.com/cboling/OMCI-parser/README.md
22 */
23
24package generated
25
26import "github.com/deckarep/golang-set"
27
28// Vdsl2LineConfigurationExtensions2ClassID is the 16-bit ID for the OMCI
29// Managed entity VDSL2 line configuration extensions 2
30const Vdsl2LineConfigurationExtensions2ClassID ClassID = ClassID(323)
31
32var vdsl2lineconfigurationextensions2BME *ManagedEntityDefinition
33
34// Vdsl2LineConfigurationExtensions2 (class ID #323)
35// This ME extends the xDSL line configuration MEs. The ME name was chosen because its attributes
36// were initially unique to ITU-T G.993.2 VDSL2. Due to continuing standards development, two of
37// the attributes (FEXT and NEXT TXREFVNds) are also used in [ITUT-G.992.3] and [ITUT-G.992.5].
38// This ME therefore pertains to the latter Recommendations as well as to [ITU-T-G.993.2].
39//
40// The attributes of this ME are further defined in [ITU-T G.997.1].
41//
42// An instance of this ME is created and deleted by the OLT.
43//
44// Relationships
45// An instance of this ME may be associated with zero or more instances of the PPTP xDSL UNI part
46// 1.//// The overall xDSL line configuration profile is modelled in several parts, all of which are
47// associated together through a common ME ID. (The client PPTP xDSL UNI part 1 has a single
48// pointer, which refers to the entire set of line configuration parts.)
49//
50// Attributes
51// Managed Entity Id
52// Managed entity ID: This attribute uniquely identifies each instance of this ME. All xDSL and
53// VDSL2 line configuration profiles and extensions that pertain to a given PPTP xDSL must share a
54// common ME ID. (R, setbycreate) (mandatory) (2-bytes)
55//
56// Sos Time Downstream
57// SOS time downstream: The SOS-TIME-ds attribute is used in the specification of receiver
58// initiated SOS (see clause 13.4.3 of [ITUT G.993.2]). If the attribute value is not zero, the
59// standard SOS triggering criteria are enabled, and the value specifies the duration of the window
60// used in the standard SOS triggering criteria in the downstream direction. The special value zero
61// indicates that the standard SOS triggering criteria are disabled, i.e., vendor-discretionary
62// values may be used instead of the values configured in the MIB for the following parameters:
63// SOS-NTONES-ds, SOS-CRC-ds, SOS-TIME-ds. The valid range of non-zero values is from 1..255,
64// specifying 64-ms to 16320 ms in steps of 64-ms. (R,-W, setbycreate) (optional) (1-byte)
65//
66// Sos Time Upstream
67// SOS time upstream: The SOS-TIME-us attribute is used in the specification of receiver initiated
68// SOS (see clause 13.4.3 of [ITUT G.993.2]). If the attribute value is not zero, the standard SOS
69// triggering criteria are enabled, and the value specifies the duration of the window used in the
70// standard SOS triggering criteria in the upstream direction. The special value zero indicates
71// that the standard SOS triggering criteria are disabled, i.e., vendor-discretionary values may be
72// used instead of the values configured in the MIB for the following parameters: SOS-NTONES-us,
73// SOS-CRC-us, SOS-TIME-us. The valid range of non-zero values is from 1..255, specifying 64-ms to
74// 16320-ms in steps of 64-ms. (R,-W, setbycreate) (optional) (1-byte)
75//
76// Sos Degraded Tones Threshold Downstream
77// SOS degraded tones threshold downstream: The SOS-NTONES-ds attribute is the minimum percentage
78// of tones in the downstream medley set that must be degraded in order to arm the first
79// subcondition of the standard SOS triggering criteria in the downstream direction. The valid
80// range of values is from 1 to 100% in steps of 1. Use of the special value 0 is described in
81// clause 13.4.3.2 of [ITUT G.993.2]. (R,-W, setbycreate) (optional) (1-byte)
82//
83// Sos Degraded Tones Threshold Upstream
84// SOS degraded tones threshold upstream: The SOS-NTONES-us attribute is the minimum percentage of
85// tones in the upstream medley set that must be degraded in order to arm the first subcondition of
86// the standard SOS triggering criteria in the upstream direction. The valid range of values is
87// from 1 to 100% in steps of 1. Use of the special value 0 is described in clause 13.4.3.2 of
88// [ITUT-G.993.2]. (R,-W, setbycreate) (optional) (1-byte)
89//
90// Sos Crc Threshold Downstream
91// SOS CRC threshold downstream: The SOS-CRC-ds attribute is the minimum number of normalized CRC
92// anomalies received in SOS-TIME-ds seconds in order to arm the second sub-condition of the
93// standard SOS triggering criteria (see clause 13.4.3.2 of [ITU T G.993.2]) in the downstream
94// direction. The valid range of SOS-CRC values is 0.02 to (216-1)*0.02, in steps of 0.02. The
95// value-0 specifies that the ONU uses its internal default. (R, W, set-by-create) (optional) (2
96// bytes)
97//
98// Sos Crc Threshold Upstream
99// SOS CRC threshold upstream: The SOS-CRC-us attribute is the minimum number of normalized CRC
100// anomalies received in SOS-TIME-us seconds in order to arm the second sub-condition of the
101// standard SOS triggering criteria (see clause 13.4.3.2 of [ITU T G.993.2]) in the upstream
102// direction. The valid range of SOS-CRC values is 0.02 to (216-1)*0.02, in steps of 0.02. The
103// value-0 specifies that the ONU uses its internal default. (R, W, set-by-create) (optional) (2
104// bytes)
105//
106// Max Sos Downstream
107// MAX SOS downstream: The MAX-SOS-ds attribute is used in deactivation. If the number of
108// successful SOS procedures in the downstream direction performed within a 120-s interval exceeds
109// MAX-SOS-ds, the modem goes to state L3. See clause 12.1.4 of [ITUT G.993.2] for details. The
110// valid range of values is 1 to 15, with the special value 0 as described in clause 12.1 of [ITUT
111// G.993.2]. (R,-W, setbycreate) (optional) (1-byte)
112//
113// Max Sos Upstream
114// MAX SOS upstream: The MAX-SOS-us attribute is used in deactivation. If the number of successful
115// SOS procedures in the upstream direction performed within a 120-s interval exceeds MAX-SOS-us,
116// the modem goes to state L3. See clause 12.1.4 of [ITUT G.993.2] for details. The valid range of
117// values is 1 to 15, with the special value 0 as described in clause 12.1 of [ITUT G.993.2].
118// (R,-W, setbycreate) (optional) (1-byte)
119//
120// Snr Max Offset Downstream
121// SNR max offset downstream: The SNRMOFFSET-ROC-ds attribute is the SNR margin offset for the ROC
122// in the downstream direction. The attribute is used in the specification of the channel
123// initialization policy (see clause 12.3.7.1 of [ITUT G.993.2]). The valid range of SNR margin
124// offset values is from 0..31-dB in 0.1-dB steps. (R,-W, setbycreate) (optional) (2-bytes)
125//
126// Snr Max Offset Upstream
127// SNR max offset upstream: The SNRMOFFSET-ROC-us attribute is the SNR margin offset for the ROC in
128// the upstream direction. The attribute is used in the specification of the channel initialization
129// policy (see clause-12.3.7.1 of [ITUT G.993.2]). The valid range of SNR margin offset values is
130// from 0..31-dB in 0.1-dB steps. (R,-W, setbycreate) (optional) (2-bytes)
131//
132// Roc Minimum Impulse Noise Protection Downstream
133// ROC minimum impulse noise protection downstream: The INPMIN-ROC-ds attribute specifies the
134// minimum INP to apply on the ROC in the downstream direction expressed in multiples of equivalent
135// 4k DMT, xDSL (DMT) symbol length. The minimum INP is an integer ranging from 0 to 8. (R,-W,
136// setbycreate) (optional) (1-byte)
137//
138// Roc Minimum Impulse Noise Protection Upstream
139// ROC minimum impulse noise protection upstream: The INPMIN-ROC-us attribute specifies the minimum
140// impulse noise protection to apply on the ROC in the upstream direction expressed in multiples of
141// equivalent 4k DMT symbol length. The minimum INP is an integer ranging from 0 to 8. (R,-W,
142// setbycreate) (optional) (1-byte)
143//
144// Fext Downstream Transmitter Referred Virtual Noise Table
145// FEXT downstream transmitter referred virtual noise table: The FEXT TXREFVNds attribute is the
146// downstream transmitter referred virtual noise specified for FEXTR duration in Annex C of [ITUT
147// G.992.3] (ADSL2) and Annex C of [ITUT G.992.5] (ADSL2plus). The syntax of this attribute is the
148// same as that of the TXREFVNds table attribute of the VDSL2 line configuration extensions ME.
149// (R,-W) (mandatory for Annex-C of [ITUT-G.992.3] and Annex-C of [ITUT-G.992.5]) (3-*-N bytes,
150// where N is the number of breakpoints)
151//
152// Next Downstream Transmitter Referred Virtual Noise Table
153// NEXT downstream transmitter referred virtual noise table: The NEXT TXREFVNds attribute is the
154// downstream transmitter referred virtual noise specified for NEXTR duration in Annex C of [ITUT
155// G.992.3] (ADSL2) and Annex C of [ITUT G.992.5] (ADSL2plus). The syntax of this attribute is the
156// same as that of the TXREFVNds table attribute of the VDSL2 line configuration extensions ME.
157// (R,-W) (mandatory for Annex-C of [ITUT-G.992.3] and Annex-C of [ITUT-G.992.5]) (3-*-N bytes,
158// where N is the number of breakpoints)
159//
160type Vdsl2LineConfigurationExtensions2 struct {
161 ManagedEntityDefinition
162 Attributes AttributeValueMap
163}
164
165func init() {
166 vdsl2lineconfigurationextensions2BME = &ManagedEntityDefinition{
167 Name: "Vdsl2LineConfigurationExtensions2",
168 ClassID: 323,
169 MessageTypes: mapset.NewSetWith(
170 Create,
171 Delete,
172 Get,
173 GetNext,
174 Set,
175 ),
176 AllowedAttributeMask: 0xfffc,
177 AttributeDefinitions: AttributeDefinitionMap{
178 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
179 1: ByteField("SosTimeDownstream", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 1),
180 2: ByteField("SosTimeUpstream", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 2),
181 3: ByteField("SosDegradedTonesThresholdDownstream", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 3),
182 4: ByteField("SosDegradedTonesThresholdUpstream", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 4),
183 5: Uint16Field("SosCrcThresholdDownstream", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 5),
184 6: Uint16Field("SosCrcThresholdUpstream", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 6),
185 7: ByteField("MaxSosDownstream", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 7),
186 8: ByteField("MaxSosUpstream", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 8),
187 9: Uint16Field("SnrMaxOffsetDownstream", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 9),
188 10: Uint16Field("SnrMaxOffsetUpstream", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 10),
189 11: ByteField("RocMinimumImpulseNoiseProtectionDownstream", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 11),
190 12: ByteField("RocMinimumImpulseNoiseProtectionUpstream", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 12),
191 13: TableField("FextDownstreamTransmitterReferredVirtualNoiseTable", TableAttributeType, 0x0008, TableInfo{nil, 3}, mapset.NewSetWith(Read, Write), false, false, false, 13),
192 14: TableField("NextDownstreamTransmitterReferredVirtualNoiseTable", TableAttributeType, 0x0004, TableInfo{nil, 3}, mapset.NewSetWith(Read, Write), false, false, false, 14),
193 },
194 Access: CreatedByOlt,
195 Support: UnknownSupport,
196 }
197}
198
199// NewVdsl2LineConfigurationExtensions2 (class ID 323) creates the basic
200// Managed Entity definition that is used to validate an ME of this type that
201// is received from or transmitted to the OMCC.
202func NewVdsl2LineConfigurationExtensions2(params ...ParamData) (*ManagedEntity, OmciErrors) {
203 return NewManagedEntity(*vdsl2lineconfigurationextensions2BME, params...)
204}