blob: 4e0cf45e4de46287d27c1360eda20e3a19f4cab8 [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 */
David K. Bainbridgeadf422d2021-04-09 16:06:41 +000017/*
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// XdslLineInventoryAndStatusDataPart5ClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL line inventory and status data part 5
Chip Boling610117d2021-09-09 11:24:34 -050030const XdslLineInventoryAndStatusDataPart5ClassID = ClassID(325) // 0x0145
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var xdsllineinventoryandstatusdatapart5BME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// XdslLineInventoryAndStatusDataPart5 (Class ID: #325 / 0x0145)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME extends the attributes defined in the xDSL line inventory and status data parts 1..4.
36// This ME reports FEXT and NEXT attributes, and pertains to Annex C of [ITUT G.992.3] (ADSL2) and
37// Annex C of [ITUT G.992.5] (ADSL2plus).
38//
39// Relationships
40// This is one of the status data MEs associated with an xDSL UNI. The ONU automatically creates or
41// deletes an instance of this ME upon creation or deletion of a PPTP xDSL UNI part 1 that supports
42// these attributes.
43//
44// Attributes
45// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050046// This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is
47// implicitly linked to an instance of the PPTP xDSL UNI part 1 ME. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060048//
49// Fext Downstream Snr Margin
Chip Boling610117d2021-09-09 11:24:34 -050050// The FEXT SNRMds attribute is the downstream SNR margin measured during FEXTR duration at the
51// ATU-R. The attribute value ranges from 0 (-64.0-dB) to 1270 (+63.0-dB). The special value 0xFFFF
52// indicates that the attribute is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060053//
54// Next Downstream Snr Margin
Chip Boling610117d2021-09-09 11:24:34 -050055// The NEXT SNRMds attribute is the downstream SNR margin measured during NEXTR duration at the
56// ATU-R. The attribute value ranges from 0 (-64.0-dB) to 1270 (+63.0-dB). The special value 0xFFFF
57// indicates that the attribute is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060058//
59// Fext Upstream Snr Margin
Chip Boling610117d2021-09-09 11:24:34 -050060// The FEXT SNRMus attribute is the upstream SNR margin (see clause 7.5.1.16 of [ITUT G.997.1])
61// measured during FEXTC duration at the ATU-C. The attribute value ranges from 0 (-64.0-dB) to
62// 1270 (+63.0-dB). The special value 0xFFFF indicates that the attribute is out of range. (R)
63// (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060064//
65// Next Upstream Snr Margin
Chip Boling610117d2021-09-09 11:24:34 -050066// The NEXT SNRMus attribute is the upstream SNR margin (see clause 7.5.1.16 of [ITUT-G.997.1])
67// measured during NEXTC duration at the ATU-C. The attribute value ranges from 0 (-64.0-dB) to
68// 1270 (+63.0-dB). The special value 0xFFFF indicates that the attribute is out of range. (R)
69// (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060070//
71// Fext Downstream Maximum Attainable Data Rate
Chip Boling610117d2021-09-09 11:24:34 -050072// The FEXT ATTNDRds attribute is the maximum downstream net data rate calculated from FEXT
73// downstream SNR(f) (see clause 7.5.1.28.3.1 of [ITUT G.997.1]). The rate is coded in bits per
74// second. (R) (mandatory) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060075//
76// Next Downstream Maximum Attainable Data Rate
Chip Boling610117d2021-09-09 11:24:34 -050077// The NEXT ATTNDRds attribute is the maximum downstream net data rate calculated from NEXT
78// downstream SNR(f) (see clause 7.5.1.28.3.2 of [ITUT G.997.1]). The rate is coded in bits per
79// second. (R) (mandatory) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060080//
81// Fext Upstream Maximum Attainable Data Rate
Chip Boling610117d2021-09-09 11:24:34 -050082// The FEXT ATTNDRus attribute is the maximum upstream net data rate calculated from FEXT upstream
83// SNR(f) (see clause 7.5.1.28.6.1 of [ITUT G.997.1]). The rate is coded in bits per second. (R)
84// (mandatory) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060085//
86// Next Upstream Maximum Attainable Data Rate
Chip Boling610117d2021-09-09 11:24:34 -050087// The NEXT ATTNDRus attribute is the maximum upstream net data rate calculated from NEXT upstream
88// SNR(f) (see clause 7.5.1.28.6.2 of [ITUT G.997.1]). The rate is coded in bits per second. (R)
89// (mandatory) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060090//
91// Fext Downstream Actual Power Spectral Density
Chip Boling610117d2021-09-09 11:24:34 -050092// The FEXT ACTPSDds attribute is the average downstream transmit PSD over the used subcarriers
93// (see clause-7.5.1.21.1 of [ITUT G.997.1]) calculated from the REFPSDds and RMSGIds for FEXTR
94// duration. The attribute value ranges from 0 (-90.0-dBm/Hz) to 900 (0.0-dBm/Hz). The special
95// value 0xFFFF indicates that the parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060096//
97// Next Downstream Actual Power Spectral Density
Chip Boling610117d2021-09-09 11:24:34 -050098// The NEXT ACTPSDds attribute is the average downstream transmit PSD over the used subcarriers
99// (see clause-7.5.1.21.2 of [ITUT G.997.1]) calculated from the REFPSDds and RMSGIds for NEXTR
100// duration. The attribute value ranges from 0 (-90.0-dBm/Hz) to 900 (0.0-dBm/Hz). The special
101// value 0xFFFF indicates that the parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600102//
103// Fext Upstream Actual Power Spectral Density
Chip Boling610117d2021-09-09 11:24:34 -0500104// The FEXT ACTPSDus attribute is the average upstream transmit PSD over the used subcarriers (see
105// clause-7.5.1.22.1 of [ITUT G.997.1]) calculated from the REFPSDus and RMSGIus for FEXTC
106// duration. The attribute value ranges from 0 (-90.0-dBm/Hz) to 900 (0.0-dBm/Hz). The special
107// value 0xFFFF indicates that the parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600108//
109// Next Upstream Actual Power Spectral Density
Chip Boling610117d2021-09-09 11:24:34 -0500110// The NEXT ACTPSDus attribute is the average upstream transmit PSD over the used subcarriers (see
111// clause-7.5.1.22.2 of [ITUT G.997.1]) calculated from the REFPSDus and RMSGIus for NEXTC
112// duration. The attribute value ranges from 0 (-90.0-dBm/Hz) to 900 (0.0-dBm/Hz). The special
113// value 0xFFFF indicates that the parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600114//
115// Fext Downstream Actual Aggregate Transmit Power
Chip Boling610117d2021-09-09 11:24:34 -0500116// The FEXT ACTATPds attribute is the total amount of transmit power (see clause 7.5.1.24.1 of
117// [ITUT G.997.1]) calculated from PSDds measured during FEXTR duration at the ATU-R. The attribute
118// value ranges from 0 (-31.0-dBm) to 620 (+31.0-dBm). The special value 0xFFFF indicates that the
119// parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600120//
121// Next Downstream Actual Aggregate Transmit Power
Chip Boling610117d2021-09-09 11:24:34 -0500122// The NEXT ACTATPds attribute is the total amount of transmit power (see clause 7.5.1.24.2 of
123// [ITUT G.997.1]) calculated from PSDds measured during NEXTR duration at the ATU-R. The attribute
124// value ranges from 0 (-31.0-dBm) to 620 (+31.0-dBm). The special value 0xFFFF indicates that the
125// parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600126//
127// Fext Upstream Actual Aggregate Transmit Power
Chip Boling610117d2021-09-09 11:24:34 -0500128// The FEXT ACTATPus attribute is the total transmit power (see clause 7.5.1.25.1 of [ITUT
129// G.997.1]) calculated from PSDus measured during FEXTC duration at the ATU-C. The attribute value
130// ranges from 0 (-31.0-dBm) to 620 (+31.0-dBm). The special value 0xFFFF indicates that the
131// parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600132//
133// Next Upstream Actual Aggregate Transmit Power
Chip Boling610117d2021-09-09 11:24:34 -0500134// The NEXT ACTATPus attribute is the total transmit power (see clause 7.5.1.25.2 of [ITUT
135// G.997.1]) calculated from PSDus measured during NEXTC duration at the ATU-C. The attribute value
136// ranges from 0 (-31.0-dBm) to 620 (+31.0-dBm). The special value 0xFFFF indicates that the
137// parameter is out of range. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600138//
139type XdslLineInventoryAndStatusDataPart5 struct {
140 ManagedEntityDefinition
141 Attributes AttributeValueMap
142}
143
144func init() {
145 xdsllineinventoryandstatusdatapart5BME = &ManagedEntityDefinition{
146 Name: "XdslLineInventoryAndStatusDataPart5",
147 ClassID: 325,
148 MessageTypes: mapset.NewSetWith(
149 Get,
150 ),
151 AllowedAttributeMask: 0xffff,
152 AttributeDefinitions: AttributeDefinitionMap{
153 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
154 1: Uint16Field("FextDownstreamSnrMargin", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
155 2: Uint16Field("NextDownstreamSnrMargin", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
156 3: Uint16Field("FextUpstreamSnrMargin", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
157 4: Uint16Field("NextUpstreamSnrMargin", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
158 5: Uint32Field("FextDownstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
159 6: Uint32Field("NextDownstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
160 7: Uint32Field("FextUpstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
161 8: Uint32Field("NextUpstreamMaximumAttainableDataRate", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
162 9: Uint16Field("FextDownstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
163 10: Uint16Field("NextDownstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
164 11: Uint16Field("FextUpstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11),
165 12: Uint16Field("NextUpstreamActualPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
166 13: Uint16Field("FextDownstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
167 14: Uint16Field("NextDownstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
168 15: Uint16Field("FextUpstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, false, false, 15),
169 16: Uint16Field("NextUpstreamActualAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0001, 0, mapset.NewSetWith(Read), false, false, false, 16),
170 },
171 Access: CreatedByOnu,
172 Support: UnknownSupport,
173 }
174}
175
176// NewXdslLineInventoryAndStatusDataPart5 (class ID 325) creates the basic
177// Managed Entity definition that is used to validate an ME of this type that
178// is received from or transmitted to the OMCC.
179func NewXdslLineInventoryAndStatusDataPart5(params ...ParamData) (*ManagedEntity, OmciErrors) {
180 return NewManagedEntity(*xdsllineinventoryandstatusdatapart5BME, params...)
181}