blob: 86f2383140640c681d8270fb9a433f1b8c69fac7 [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 */
Chip Boling2d51f052021-02-09 09:04:15 -060017/*
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
Chip Boling610117d2021-09-09 11:24:34 -050030const Vdsl2LineConfigurationExtensions2ClassID = ClassID(323) // 0x0143
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var vdsl2lineconfigurationextensions2BME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// Vdsl2LineConfigurationExtensions2 (Class ID: #323 / 0x0143)
Chip Boling6e27b352020-02-14 09:10:01 -060035// 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
Chip Boling610117d2021-09-09 11:24:34 -050052// This attribute uniquely identifies each instance of this ME. All xDSL and VDSL2 line
53// configuration profiles and extensions that pertain to a given PPTP xDSL must share a common ME
54// ID. (R, setbycreate) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060055//
56// Sos Time Downstream
Chip Boling610117d2021-09-09 11:24:34 -050057// The SOS-TIME-ds attribute is used in the specification of receiver initiated SOS (see clause
58// 13.4.3 of [ITUT G.993.2]). If the attribute value is not zero, the standard SOS triggering
59// criteria are enabled, and the value specifies the duration of the window used in the standard
60// SOS triggering criteria in the downstream direction. The special value zero indicates that the
61// standard SOS triggering criteria are disabled, i.e., vendor-discretionary values may be used
62// instead of the values configured in the MIB for the following parameters: SOS-NTONES-ds, SOS-
63// CRC-ds, SOS-TIME-ds. The valid range of non-zero values is from 1..255, specifying 64-ms to
64// 16320 ms in steps of 64-ms. (R,-W, setbycreate) (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060065//
66// Sos Time Upstream
Chip Boling610117d2021-09-09 11:24:34 -050067// The SOS-TIME-us attribute is used in the specification of receiver initiated SOS (see clause
68// 13.4.3 of [ITUT G.993.2]). If the attribute value is not zero, the standard SOS triggering
69// criteria are enabled, and the value specifies the duration of the window used in the standard
70// SOS triggering criteria in the upstream direction. The special value zero indicates that the
71// standard SOS triggering criteria are disabled, i.e., vendor-discretionary values may be used
72// instead of the values configured in the MIB for the following parameters: SOS-NTONES-us, SOS-
73// CRC-us, SOS-TIME-us. The valid range of non-zero values is from 1..255, specifying 64-ms to
Chip Boling6e27b352020-02-14 09:10:01 -060074// 16320-ms in steps of 64-ms. (R,-W, setbycreate) (optional) (1-byte)
75//
76// Sos Degraded Tones Threshold Downstream
Chip Boling610117d2021-09-09 11:24:34 -050077// The SOS-NTONES-ds attribute is the minimum percentage of tones in the downstream medley set that
78// must be degraded in order to arm the first subcondition of the standard SOS triggering criteria
79// in the downstream direction. The valid range of values is from 1 to 100% in steps of 1. Use of
80// the special value 0 is described in clause 13.4.3.2 of [ITUT G.993.2]. (R,-W, setbycreate)
81// (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060082//
83// Sos Degraded Tones Threshold Upstream
Chip Boling610117d2021-09-09 11:24:34 -050084// The SOS-NTONES-us attribute is the minimum percentage of tones in the upstream medley set that
85// must be degraded in order to arm the first subcondition of the standard SOS triggering criteria
86// in the upstream direction. The valid range of values is from 1 to 100% in steps of 1. Use of the
87// special value 0 is described in clause 13.4.3.2 of [ITUT-G.993.2]. (R,-W, setbycreate)
88// (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060089//
90// Sos Crc Threshold Downstream
Chip Boling610117d2021-09-09 11:24:34 -050091// The SOS-CRC-ds attribute is the minimum number of normalized CRC anomalies received in SOS-TIME-
92// ds seconds in order to arm the second sub-condition of the standard SOS triggering criteria (see
93// clause 13.4.3.2 of [ITU T G.993.2]) in the downstream direction. The valid range of SOS-CRC
94// values is 0.02 to (216-1)*0.02, in steps of 0.02. The value-0 specifies that the ONU uses its
95// internal default. (R, W, set-by-create) (optional) (2 bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060096//
97// Sos Crc Threshold Upstream
Chip Boling610117d2021-09-09 11:24:34 -050098// The SOS-CRC-us attribute is the minimum number of normalized CRC anomalies received in SOS-TIME-
99// us seconds in order to arm the second sub-condition of the standard SOS triggering criteria (see
100// clause 13.4.3.2 of [ITU T G.993.2]) in the upstream direction. The valid range of SOS-CRC values
101// is 0.02 to (216-1)*0.02, in steps of 0.02. The value-0 specifies that the ONU uses its internal
102// default. (R, W, set-by-create) (optional) (2 bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600103//
104// Max Sos Downstream
Chip Boling610117d2021-09-09 11:24:34 -0500105// The MAX-SOS-ds attribute is used in deactivation. If the number of successful SOS procedures in
106// the downstream direction performed within a 120-s interval exceeds MAX-SOS-ds, the modem goes to
107// state L3. See clause 12.1.4 of [ITUT G.993.2] for details. The valid range of values is 1 to 15,
108// with the special value 0 as described in clause 12.1 of [ITUT G.993.2]. (R,-W, setbycreate)
109// (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600110//
111// Max Sos Upstream
Chip Boling610117d2021-09-09 11:24:34 -0500112// The MAX-SOS-us attribute is used in deactivation. If the number of successful SOS procedures in
113// the upstream direction performed within a 120-s interval exceeds MAX-SOS-us, the modem goes to
114// state L3. See clause 12.1.4 of [ITUT G.993.2] for details. The valid range of values is 1 to 15,
115// with the special value 0 as described in clause 12.1 of [ITUT G.993.2]. (R,-W, setbycreate)
116// (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600117//
118// Snr Max Offset Downstream
Chip Boling610117d2021-09-09 11:24:34 -0500119// The SNRMOFFSET-ROC-ds attribute is the SNR margin offset for the ROC in the downstream
120// direction. The attribute is used in the specification of the channel initialization policy (see
121// clause 12.3.7.1 of [ITUT G.993.2]). The valid range of SNR margin offset values is from 0..31-dB
122// in 0.1-dB steps. (R,-W, setbycreate) (optional) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600123//
124// Snr Max Offset Upstream
Chip Boling610117d2021-09-09 11:24:34 -0500125// The SNRMOFFSET-ROC-us attribute is the SNR margin offset for the ROC in the upstream direction.
126// The attribute is used in the specification of the channel initialization policy (see
127// clause-12.3.7.1 of [ITUT G.993.2]). The valid range of SNR margin offset values is from 0..31-dB
128// in 0.1-dB steps. (R,-W, setbycreate) (optional) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600129//
130// Roc Minimum Impulse Noise Protection Downstream
Chip Boling610117d2021-09-09 11:24:34 -0500131// The INPMIN-ROC-ds attribute specifies the minimum INP to apply on the ROC in the downstream
132// direction expressed in multiples of equivalent 4k DMT, xDSL (DMT) symbol length. The minimum INP
133// is an integer ranging from 0 to 8. (R,-W, setbycreate) (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600134//
135// Roc Minimum Impulse Noise Protection Upstream
Chip Boling610117d2021-09-09 11:24:34 -0500136// The INPMIN-ROC-us attribute specifies the minimum impulse noise protection to apply on the ROC
137// in the upstream direction expressed in multiples of equivalent 4k DMT symbol length. The minimum
138// INP is an integer ranging from 0 to 8. (R,-W, setbycreate) (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600139//
140// Fext Downstream Transmitter Referred Virtual Noise Table
Chip Boling610117d2021-09-09 11:24:34 -0500141// The FEXT TXREFVNds attribute is the downstream transmitter referred virtual noise specified for
142// FEXTR duration in Annex C of [ITUT G.992.3] (ADSL2) and Annex C of [ITUT G.992.5] (ADSL2plus).
143// The syntax of this attribute is the same as that of the TXREFVNds table attribute of the VDSL2
144// line configuration extensions ME. (R,-W) (mandatory for Annex-C of [ITUT-G.992.3] and Annex-C of
145// [ITUT-G.992.5]) (3-*-N bytes, where N is the number of breakpoints)
Chip Boling6e27b352020-02-14 09:10:01 -0600146//
147// Next Downstream Transmitter Referred Virtual Noise Table
Chip Boling610117d2021-09-09 11:24:34 -0500148// The NEXT TXREFVNds attribute is the downstream transmitter referred virtual noise specified for
149// NEXTR duration in Annex C of [ITUT G.992.3] (ADSL2) and Annex C of [ITUT G.992.5] (ADSL2plus).
150// The syntax of this attribute is the same as that of the TXREFVNds table attribute of the VDSL2
151// line configuration extensions ME. (R,-W) (mandatory for Annex-C of [ITUT-G.992.3] and Annex-C of
152// [ITUT-G.992.5]) (3-*-N bytes, where N is the number of breakpoints)
Chip Boling6e27b352020-02-14 09:10:01 -0600153//
154type Vdsl2LineConfigurationExtensions2 struct {
155 ManagedEntityDefinition
156 Attributes AttributeValueMap
157}
158
159func init() {
160 vdsl2lineconfigurationextensions2BME = &ManagedEntityDefinition{
161 Name: "Vdsl2LineConfigurationExtensions2",
162 ClassID: 323,
163 MessageTypes: mapset.NewSetWith(
164 Create,
165 Delete,
166 Get,
167 GetNext,
168 Set,
Chip Boling2d51f052021-02-09 09:04:15 -0600169 SetTable,
Chip Boling6e27b352020-02-14 09:10:01 -0600170 ),
171 AllowedAttributeMask: 0xfffc,
172 AttributeDefinitions: AttributeDefinitionMap{
173 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
174 1: ByteField("SosTimeDownstream", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 1),
175 2: ByteField("SosTimeUpstream", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 2),
176 3: ByteField("SosDegradedTonesThresholdDownstream", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 3),
177 4: ByteField("SosDegradedTonesThresholdUpstream", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 4),
178 5: Uint16Field("SosCrcThresholdDownstream", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 5),
179 6: Uint16Field("SosCrcThresholdUpstream", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 6),
180 7: ByteField("MaxSosDownstream", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 7),
181 8: ByteField("MaxSosUpstream", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 8),
182 9: Uint16Field("SnrMaxOffsetDownstream", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 9),
183 10: Uint16Field("SnrMaxOffsetUpstream", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 10),
184 11: ByteField("RocMinimumImpulseNoiseProtectionDownstream", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 11),
185 12: ByteField("RocMinimumImpulseNoiseProtectionUpstream", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 12),
186 13: TableField("FextDownstreamTransmitterReferredVirtualNoiseTable", TableAttributeType, 0x0008, TableInfo{nil, 3}, mapset.NewSetWith(Read, Write), false, false, false, 13),
187 14: TableField("NextDownstreamTransmitterReferredVirtualNoiseTable", TableAttributeType, 0x0004, TableInfo{nil, 3}, mapset.NewSetWith(Read, Write), false, false, false, 14),
188 },
189 Access: CreatedByOlt,
190 Support: UnknownSupport,
191 }
192}
193
194// NewVdsl2LineConfigurationExtensions2 (class ID 323) creates the basic
195// Managed Entity definition that is used to validate an ME of this type that
196// is received from or transmitted to the OMCC.
197func NewVdsl2LineConfigurationExtensions2(params ...ParamData) (*ManagedEntity, OmciErrors) {
198 return NewManagedEntity(*vdsl2lineconfigurationextensions2BME, params...)
199}