blob: 728b80e7aeba2627f5dab0da9037d183c9d2c5f6 [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// Vdsl2LineInventoryAndStatusDataPart1ClassID is the 16-bit ID for the OMCI
29// Managed entity VDSL2 line inventory and status data part 1
30const Vdsl2LineInventoryAndStatusDataPart1ClassID ClassID = ClassID(168)
31
32var vdsl2lineinventoryandstatusdatapart1BME *ManagedEntityDefinition
33
34// Vdsl2LineInventoryAndStatusDataPart1 (class ID #168)
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 general and downstream 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 C
55// VDSL2 transmission system capability xTUC: This attribute extends the xTU-C transmission system
56// capability attribute of the xDSL line inventory and status data part 1 to include xTU-C VDSL2
57// capabilities. It is defined by bits 57..64 of Table 9.7.12-1. (R) (mandatory) (1-byte)
58//
59// Vdsl2 Transmission System
60// VDSL2 transmission system: This attribute reports the transmission system in use. It extends the
61// xDSL transmission system attribute of the xDSL line inventory and status data part 2 ME with a
62// byte that includes VDSL2 capabilities currently in use. It is defined by bits 57..64 of Table
63// 9.7.12-1. (R) (mandatory) (1-byte)
64//
65// Vdsl2 Profile
66// (R) (mandatory) (1-byte)
67//
68// Vdsl2 Limit Psd Mask And Bandplan
69// VDSL2 limit PSD mask and bandplan: This attribute defines the limit PSD mask and band plan in
70// use. It is a bit map as defined by Table 9.7.6-1. (R) (mandatory) (8-bytes)
71//
72// Vdsl2 Us0 Psd Mask
73// VDSL2 US0 PSD mask: This attribute defines the US0 PSD mask in use. It is a bit map as defined
74// by Table 9.7.62. (R) (mandatory) (4-bytes)
75//
76// Actsnrmodeds
77// (R) (mandatory) (1-byte)
78//
79// Hlingds
80// HLINGds: This attribute contains the number of subcarriers per group used to report HLINpsds.
81// (R) (mandatory) (1-byte)
82//
83// Hloggds
84// HLOGGds: This attribute contains the number of subcarriers per group used to report HLOGpsds.
85// (R) (mandatory) (1-byte)
86//
87// Qlngds
88// QLNGds: This attribute contains the number of subcarriers per group used to report QLNpsds. (R)
89// (mandatory) (1-byte)
90//
91// Snrgds
92// SNRGds: This attribute contains the number of subcarriers per group used to report SNRpsds. (R)
93// (mandatory) (1-byte)
94//
95// Mrefpsdds Table
96// (R) (mandatory) (3 * N bytes, where N is the number of breakpoints)
97//
98// Trellisds
99// (R) (mandatory for ITU-T G.993.2 VDSL2, optional for others) (1-byte)
100//
101// Actual Rate Adaptation Mode Downstream
102// (R) (optional) (1-byte)
103//
104// Actual Impulse Noise Protection Robust Operations Channel Roc Downstream
105// Actual impulse noise protection robust operations channel (ROC) downstream: The ACTINP-ROC-ds
106// attribute reports the actual INP of the ROC in the downstream direction expressed in multiples
107// of T4k. The INP of this attribute is equal to the integer value multiplied by 0.1 symbols. Valid
108// values and usage are given in clause 7.5.1.34.1 of [ITUT-G.997.1]. (R) (optional) (1-byte)
109//
110// Snr Margin Roc Downstream
111// SNR margin ROC downstream: The SNRM-ROC-ds attribute reports the actual signal-to-noise margin
112// of the ROC in the downstream direction. Its value ranges from 0 (-64.0-dB) to 1270 (+63.0-dB).
113// The special value 0xFFFF indicates that the attribute is out of range. (R) (optional) (2-bytes)
114//
115type Vdsl2LineInventoryAndStatusDataPart1 struct {
116 ManagedEntityDefinition
117 Attributes AttributeValueMap
118}
119
120func init() {
121 vdsl2lineinventoryandstatusdatapart1BME = &ManagedEntityDefinition{
122 Name: "Vdsl2LineInventoryAndStatusDataPart1",
123 ClassID: 168,
124 MessageTypes: mapset.NewSetWith(
125 Get,
126 GetNext,
127 ),
128 AllowedAttributeMask: 0xfffe,
129 AttributeDefinitions: AttributeDefinitionMap{
130 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
131 1: ByteField("Vdsl2TransmissionSystemCapabilityXtuC", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
132 2: ByteField("Vdsl2TransmissionSystem", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
133 3: ByteField("Vdsl2Profile", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
134 4: Uint64Field("Vdsl2LimitPsdMaskAndBandplan", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
135 5: Uint32Field("Vdsl2Us0PsdMask", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
136 6: ByteField("Actsnrmodeds", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
137 7: ByteField("Hlingds", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
138 8: ByteField("Hloggds", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
139 9: ByteField("Qlngds", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
140 10: ByteField("Snrgds", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
141 11: TableField("MrefpsddsTable", TableAttributeType, 0x0020, TableInfo{nil, 3}, mapset.NewSetWith(Read), false, false, false, 11),
142 12: ByteField("Trellisds", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
143 13: ByteField("ActualRateAdaptationModeDownstream", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, true, false, 13),
144 14: ByteField("ActualImpulseNoiseProtectionRobustOperationsChannelRocDownstream", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, true, false, 14),
145 15: Uint16Field("SnrMarginRocDownstream", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, true, false, 15),
146 },
147 Access: CreatedByOnu,
148 Support: UnknownSupport,
149 }
150}
151
152// NewVdsl2LineInventoryAndStatusDataPart1 (class ID 168) 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 NewVdsl2LineInventoryAndStatusDataPart1(params ...ParamData) (*ManagedEntity, OmciErrors) {
156 return NewManagedEntity(*vdsl2lineinventoryandstatusdatapart1BME, params...)
157}