blob: 107c9c6b21682a9d640ba6d5f271bd2d25a7b66e [file] [log] [blame]
Chip Boling610117d2021-09-09 11:24:34 -05001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
3 * Copyright 2020-present Open Networking Foundation
4
5 * 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
8
9 * http://www.apache.org/licenses/LICENSE-2.0
10
11 * 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 */
17/*
18 * 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// Vdsl2LineInventoryAndStatusDataPart4ClassID is the 16-bit ID for the OMCI
29// Managed entity VDSL2 line inventory and status data part 4
30const Vdsl2LineInventoryAndStatusDataPart4ClassID = ClassID(415) // 0x019f
31
32var vdsl2lineinventoryandstatusdatapart4BME *ManagedEntityDefinition
33
34// Vdsl2LineInventoryAndStatusDataPart4 (Class ID: #415 / 0x019f)
35// This ME extends the other xDSL line inventory and status data MEs with attributes specific to
36// VDSL2.
37//
38// Relationships
39// This is one of the status data MEs associated with an xDSL UNI. It is required only if VDSL2 is
40// supported by the PPTP. The ONU automatically creates or deletes an instance of this ME upon
41// creation or deletion of a PPTP xDSL UNI part 1 that supports these attributes.
42//
43// Attributes
44// Managed Entity Id
45// This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is
46// implicitly linked to an instance of the PPTP xDSL UNI part 1 ME. (R) (mandatory) (2-bytes)
47//
48// Vtu_O Estimated Upstream Power Back_Off Electrical Length Per Band Upbokle_Pb
49// VTU-O estimated upstream power back-off electrical length per band (UPBOKLE-pb): This parameter
50// is a vector of UPBO electrical length per-band estimates for each supported upstream band except
51// US0, calculated by the VTU-O, based on separate measurements in the supported upstream bands
52// excluding US0. This parameter is required for the alternative electrical length estimation
53// method (ELE-M1). Each per-band estimate is represented by 2-bytes, where the estimate is defined
54// as the integer value multiplied by 0.1-dB. The valid range of values is given in clause
55// 7.5.1.23.3 of [ITU-T G.997.1] (R) (optional) (4 bands- 2-bytes)
56//
57// Vtu_R Estimated Upstream Power Back_Off Electrical Length Per Band Upbokle_R_Pb
58// VTU-R estimated upstream power back-off electrical length per band (UPBOKLE-R-pb): This
59// parameter is a vector of UPBO electrical length per-band estimates for each supported downstream
60// band, calculated by the VTU-R, based on separate measurements in the supported downstream bands.
61// This parameter is required for the alternative electrical length estimation method (ELEM1). Each
62// per-band estimate is represented by 2-bytes, where the estimate is defined as the integer value
63// multiplied by 0.1-dB. The valid range of values is given in clause 7.5.1.23.4 of [ITU-T G.997.1]
64// (R) (optional) (3-bands- 2-bytes)
65//
66// Upbo Downstream Receiver Signal Level Threshold Rxthrshds
67// UPBO downstream receiver signal level threshold (RXTHRSHds): This parameter reports the
68// downstream received signal level threshold value used in the alternative electrical length
69// estimation method (ELE-M1). Valid values range from 0 (-64-dB) to 64 (0 dB). See clause
70// 7.5.1.23.5 of [ITU-T G.997.1] (R) (optional) (1-byte)
71//
72// Upbo Upstream Receiver Signal Level Threshold Rxthrshus
73// UPBO upstream receiver signal level threshold (RXTHRSHus): This parameter reports the upstream
74// received signal level threshold value used in the alternative electrical length estimation
75// method. Valid values range from 0 (-64 dB) to 64-(0 dB). See clause 7.5.1.23.6 of [ITU-T
76// G.997.1] (R) (optional) (1-byte)
77//
78// Actual Alternative Electrical Length Estimation Mod E Act_Aele_Mode
79// Actual alternative electrical length estimation mode (ACT-AELE-MODE): This parameter reports the
80// actual AELE-MODE. Valid values are given in clause-7.5.1.23.7 of [ITU-T G.997.1] (R) (optional)
81// (1-byte)
82//
83// Actual Downstream Ripolicy Actripolicyds
84// Actual downstream RIPOLICY (ACTRIPOLICYds): This parameter indicates the actual re-
85// initialization policy in use in the downstream direction. Valid values are given in clause
86// 7.5.1.40.1 of [ITU-T G.997.1] (R) (optional) (1-byte)
87//
88// Actual Upstream Ripolicy Actripolicyus
89// Actual upstream RIPOLICY (ACTRIPOLICYus): This parameter indicates the actual reinitialization
90// policy in use in the upstream direction. Valid values are given in clause 7.5.1.40.2 of [ITU-T
91// G.997.1] (R) (optional) (1-byte)
92//
93// Attndr Actual M Ethod Attndr_Actmethod
94// ATTNDR actual method (ATTNDR_ACTMETHOD): This parameter indicates the actual ATTNDR Method used
95// for calculation of the ATTNDR in the downstream and upstream direction. Valid values are given
96// in clause 7.5.1.41.1 of [ITUT-G.997.1] (R) (optional) (1-byte)
97//
98// Attndr Downstream A Ctual Impulse Noise Protection Attndr_Actinpds
99// ATTNDR downstream actual impulse noise protection (ATTNDR_ACTINPds): If retransmission is not
100// used in the downstream direction, this parameter indicates the actual INP used in the improved
101// calculation of the ATTNDR in the downstream direction. If retransmission is used in the
102// downstream direction, this parameter indicates the actual INP against SHINE used in the improved
103// calculation of the ATTNDR in the downstream direction. The format and usage is identical to that
104// of the ACTINP attribute defined in the xDSL channel downstream status data ME. See clause
105// 7.5.1.41.2 of [ITU-T G.997.1] (R) (optional) (1-byte)
106//
107// Attndr Upstream A Ctual Impulse Noise Protection Attndr_Actinpus
108// ATTNDR upstream actual impulse noise protection (ATTNDR_ACTINPus): If retransmission is not used
109// in the upstream direction, this parameter indicates the actual INP used in the improved
110// calculation of the ATTNDR in the upstream direction. If retransmission is used in the upstream
111// direction, this parameter indicates the actual INP against SHINE used in the improved
112// calculation of the ATTNDR in the upstream direction. The format and usage is identical to that
113// of the ACTINP attribute defined in the xDSL channel downstream status data ME. See clause
114// 7.5.1.41.3 of [ITU-T G.997.1] (R) (optional) (1-byte)
115//
116// Attndr Downstream A Ctual Impulse Noise Protection Against Rein Attndr_Actinp_Reinds
117// ATTNDR downstream actual impulse noise protection against REIN (ATTNDR_ACTINP_REINds): If
118// retransmission is used in the downstream direction, this parameter reports the actual INP
119// against REIN used in the improved calculation of the ATTNDR in the downstream direction. The
120// format and usage is identical to that of the ACTINP_REIN attribute defined in the xDSL channel
121// downstream status data ME. See clause 7.5.1.41.4 of [ITU-T G.997.1] (R) (optional) (1-byte)
122//
123// Attndr Upstream A Ctual Impulse Noise Protection Against Rein Attndr_Actinp_Reinus
124// ATTNDR upstream actual impulse noise protection against REIN (ATTNDR_ACTINP_REINus): If
125// retransmission is used in the upstream direction, this parameter reports the actual INP against
126// REIN used in the improved calculation of the ATTNDR in the upstream direction. The format and
127// usage is identical to that of the ACTINP_REIN attribute defined in the xDSL channel downstream
128// status data ME. See clause 7.5.1.41.5 of [ITUT-G.997.1] (R) (optional) (1-byte)
129//
130// Attndr Downstream Actual Delay Attndr_Actdelayds
131// ATTNDR downstream actual delay (ATTNDR_ACTDELAYds): This parameter indicates the actual delay
132// used in the improved calculation of the ATTNDR in the downstream direction. The delay of this
133// attribute is equal to the integer value multiplied by 0.1-ms. Valid values are given in clause
134// 7.5.1.41.6 of [ITUT G.997.1] (R) (optional) (1-byte)
135//
136// Attndr Upstream A Ctual Delay Attndr_Actdelayus
137// ATTNDR upstream actual delay (ATTNDR_ACTDELAYus): This parameter indicates the actual delay used
138// in the improved calculation of the ATTNDR in the upstream direction. The delay of this attribute
139// is equal to the integer value multiplied by 0.1-ms. Valid values are given in clause 7.5.1.41.7
140// of [ITUT-G.997.1] (R) (optional) (1-byte)
141//
142// Near_End A Ggregate Achievable Net Data Rate Aggachndr_Ne
143// Near-end aggregate achievable net data rate (AGGACHNDR_NE): This parameter reports the aggregate
144// achievable net data rate of the VTU-O, in bits per second. See clause 7.5.1.42.1 of [ITU-T
145// G.997.1] (R) (optional) (4-bytes)
146//
147// Far_End Aggregate Achievable Net Data Rate Aggachndr_Fe
148// Far-end aggregate achievable net data rate (AGGACHNDR_FE): This parameter reports the aggregate
149// achievable net data rate of the VTU-R, in bits per second. See clause-7.5.1.42.2 of [ITU-T
150// G.997.1] (R) (optional) (4-bytes)
151//
152type Vdsl2LineInventoryAndStatusDataPart4 struct {
153 ManagedEntityDefinition
154 Attributes AttributeValueMap
155}
156
157func init() {
158 vdsl2lineinventoryandstatusdatapart4BME = &ManagedEntityDefinition{
159 Name: "Vdsl2LineInventoryAndStatusDataPart4",
160 ClassID: 415,
161 MessageTypes: mapset.NewSetWith(
162 Get,
163 ),
164 AllowedAttributeMask: 0xffff,
165 AttributeDefinitions: AttributeDefinitionMap{
166 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
167 1: Uint32Field("VtuOEstimatedUpstreamPowerBackOffElectricalLengthPerBandUpboklePb", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, true, false, 1),
168 2: MultiByteField("VtuREstimatedUpstreamPowerBackOffElectricalLengthPerBandUpbokleRPb", OctetsAttributeType, 0x4000, 3, toOctets("AAAA"), mapset.NewSetWith(Read), false, true, false, 2),
169 3: ByteField("UpboDownstreamReceiverSignalLevelThresholdRxthrshds", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, true, false, 3),
170 4: ByteField("UpboUpstreamReceiverSignalLevelThresholdRxthrshus", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, true, false, 4),
171 5: ByteField("ActualAlternativeElectricalLengthEstimationModEActAeleMode", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, true, false, 5),
172 6: ByteField("ActualDownstreamRipolicyActripolicyds", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, true, false, 6),
173 7: ByteField("ActualUpstreamRipolicyActripolicyus", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, true, false, 7),
174 8: ByteField("AttndrActualMEthodAttndrActmethod", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, true, false, 8),
175 9: ByteField("AttndrDownstreamACtualImpulseNoiseProtectionAttndrActinpds", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, true, false, 9),
176 10: ByteField("AttndrUpstreamACtualImpulseNoiseProtectionAttndrActinpus", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, true, false, 10),
177 11: ByteField("AttndrDownstreamACtualImpulseNoiseProtectionAgainstReinAttndrActinpReinds", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, true, false, 11),
178 12: ByteField("AttndrUpstreamACtualImpulseNoiseProtectionAgainstReinAttndrActinpReinus", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, true, false, 12),
179 13: ByteField("AttndrDownstreamActualDelayAttndrActdelayds", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, true, false, 13),
180 14: ByteField("AttndrUpstreamACtualDelayAttndrActdelayus", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, true, false, 14),
181 15: Uint32Field("NearEndAGgregateAchievableNetDataRateAggachndrNe", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, true, false, 15),
182 16: Uint32Field("FarEndAggregateAchievableNetDataRateAggachndrFe", UnsignedIntegerAttributeType, 0x0001, 0, mapset.NewSetWith(Read), false, true, false, 16),
183 },
184 Access: CreatedByOnu,
185 Support: UnknownSupport,
186 }
187}
188
189// NewVdsl2LineInventoryAndStatusDataPart4 (class ID 415) creates the basic
190// Managed Entity definition that is used to validate an ME of this type that
191// is received from or transmitted to the OMCC.
192func NewVdsl2LineInventoryAndStatusDataPart4(params ...ParamData) (*ManagedEntity, OmciErrors) {
193 return NewManagedEntity(*vdsl2lineinventoryandstatusdatapart4BME, params...)
194}