blob: 2cb56d8d47205ff84a944cb89586684becec9e41 [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// Vdsl2LineInventoryAndStatusDataPart2ClassID is the 16-bit ID for the OMCI
29// Managed entity VDSL2 line inventory and status data part 2
30const Vdsl2LineInventoryAndStatusDataPart2ClassID ClassID = ClassID(169)
31
32var vdsl2lineinventoryandstatusdatapart2BME *ManagedEntityDefinition
33
34// Vdsl2LineInventoryAndStatusDataPart2 (class ID #169)
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, some
37// attributes - and therefore this ME - have also become applicable to other Recommendations,
38// specifically [ITU-T G.992.3] and [ITU-T G.992.5].
39//
40// This ME contains upstream attributes.
41//
42// Relationships
43// This is one of the status data MEs associated with an xDSL UNI. It is meaningful if the PPTP
44// supports [ITU-T G.992.3], [ITU-T G.992.5] or [ITU-T G.993.2]. The ONU automatically creates or
45// deletes an instance of this ME upon creation and deletion of a PPTP xDSL UNI part 1 that
46// supports these attributes.
47//
48// Attributes
49// Managed Entity Id
50// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
51// identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1 ME. (R)
52// (mandatory) (2-bytes)
53//
54// Vdsl2 Transmission System Capability Xtu_R
55// VDSL2 transmission system capability xTU-R: This attribute extends the xTU-R transmission system
56// capability attribute of the xDSL line inventory and status data part 1 to include xTUR VDSL2
57// capabilities. It is a defined by bits 57..64 of Table 9.7.12-1. (R) (mandatory) (1-byte)
58//
59// Actsnrmodeus
60// (R) (mandatory) (1-byte)
61//
62// Upbokle
63// UPBOKLE: This attribute contains the electrical length estimated by the VTU-O expressed in
64// decibels at 1-MHz, kl0 (see O-UPDATE in clause 12.3.3.2.1.2 of [ITUT-G.993.2]). This is the
65// final electrical length that would have been sent from the VTU-O to the VTU-R if the electrical
66// length were not forced by the OLT. The value lies in the range 0 (0.0-dB) to 1280 (128.0-dB) (R)
67// (mandatory) (2-bytes)
68//
69// Hlingus
70// HLINGus: This attribute is the number of subcarriers per group used to report HLINpsus. (R)
71// (mandatory) (1-byte)
72//
73// Hloggus
74// HLOGGus: This attribute is the number of subcarriers per group used to report HLOGpsus. (R)
75// (mandatory) (1-byte)
76//
77// Qlngus
78// QLNGus: This attribute is the number of subcarriers per group used to report QLNpsus. (R)
79// (mandatory) (1-byte)
80//
81// Snrgus
82// SNRGus: This attribute is the number of subcarriers per group used to report SNRpsus. (R)
83// (mandatory) (1-byte)
84//
85// Mrefpsdus Table
86// (R) (mandatory) (3 * N bytes, where N is the number of breakpoints)
87//
88// Trellisus
89// (R) (mandatory for ITU-T G.993.2 VDSL2, optional for others) (1-byte)
90//
91// Actualce
92// ACTUALCE: This attribute reports the cyclic extension used on the line. It is coded as an
93// unsigned integer from 2 to 16 in units of N/32 samples, where 2N is the IDFT size. (R)
94// (mandatory) (1-byte)
95//
96// Upbokle_R
97// UPBOKLE-R: This attribute contains the electrical length estimated by the VTU-R expressed in
98// decibels at 1-MHz. This is the value contained in the message RMSG1 (see clause 12.3.3.2.2.1of
99// [ITUT G.993.2]). Its value lies in the range 0 (0.0-dB) to 1280 (128.0-dB) (R) (optional)
100// (2-bytes)
101//
102// Actual Rate Adaptation Mode Upstream
103// (R) (optional) (1-byte)
104//
105// Actual Impulse Noise Protection Roc Upstream
106// Actual impulse noise protection ROC upstream: The ACTINP-ROC-us attribute reports the actual INP
107// of the ROC in the upstream direction expressed in multiples of T4k. The INP of this attribute is
108// equal to the integer value multiplied by 0.1 symbols. Valid values and usage are given in clause
109// 7.5.1.34.2 of [ITUT-G.997.1]. (R) (optional) (1-byte)
110//
111// Snr Margin Roc Upstream
112// SNR margin ROC upstream: The SNRM-ROC-us attribute reports the actual signal-to-noise margin of
113// the ROC in the upstream direction. Its value ranges from 0 (-64.0-dB) to 1270 (+63.0-dB). The
114// special value 0xFFFF indicates that the attribute is out of range. (R) (optional) (2-bytes)
115//
116type Vdsl2LineInventoryAndStatusDataPart2 struct {
117 ManagedEntityDefinition
118 Attributes AttributeValueMap
119}
120
121func init() {
122 vdsl2lineinventoryandstatusdatapart2BME = &ManagedEntityDefinition{
123 Name: "Vdsl2LineInventoryAndStatusDataPart2",
124 ClassID: 169,
125 MessageTypes: mapset.NewSetWith(
126 Get,
127 GetNext,
128 ),
129 AllowedAttributeMask: 0xfffc,
130 AttributeDefinitions: AttributeDefinitionMap{
131 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
132 1: ByteField("Vdsl2TransmissionSystemCapabilityXtuR", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
133 2: ByteField("Actsnrmodeus", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
134 3: Uint16Field("Upbokle", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
135 4: ByteField("Hlingus", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
136 5: ByteField("Hloggus", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
137 6: ByteField("Qlngus", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
138 7: ByteField("Snrgus", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
139 8: TableField("MrefpsdusTable", TableAttributeType, 0x0100, TableInfo{nil, 3}, mapset.NewSetWith(Read), false, false, false, 8),
140 9: ByteField("Trellisus", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
141 10: ByteField("Actualce", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
142 11: Uint16Field("UpbokleR", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, true, false, 11),
143 12: ByteField("ActualRateAdaptationModeUpstream", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, true, false, 12),
144 13: ByteField("ActualImpulseNoiseProtectionRocUpstream", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, true, false, 13),
145 14: Uint16Field("SnrMarginRocUpstream", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, true, false, 14),
146 },
147 Access: CreatedByOnu,
148 Support: UnknownSupport,
149 }
150}
151
152// NewVdsl2LineInventoryAndStatusDataPart2 (class ID 169) creates the basic
153// Managed Entity definition that is used to validate an ME of this type that
154// is received from or transmitted to the OMCC.
155func NewVdsl2LineInventoryAndStatusDataPart2(params ...ParamData) (*ManagedEntity, OmciErrors) {
156 return NewManagedEntity(*vdsl2lineinventoryandstatusdatapart2BME, params...)
157}