blob: f2a62a7d67688e0392f8215cd5fb3f93a53da45d [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// XdslLineConfigurationProfilePart2ClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL line configuration profile part 2
30const XdslLineConfigurationProfilePart2ClassID ClassID = ClassID(105)
31
32var xdsllineconfigurationprofilepart2BME *ManagedEntityDefinition
33
34// XdslLineConfigurationProfilePart2 (class ID #105)
35// The overall xDSL line configuration profile is modelled in several parts, all of which are
36// associated together through a common ME ID (the client PPTP xDSL UNI part 1 has a single
37// pointer, which refers to the entire set of line configuration profile parts).
38//
39// Relationships
40// An instance of this ME may be associated with zero or more instances of an xDSL UNI.
41//
42// Attributes
43// Managed Entity Id
44// Managed entity ID: This attribute uniquely identifies each instance of this ME. All xDSL and
45// VDSL2 line configuration profiles and extensions that pertain to a given PPTP xDSL UNI must
46// share a common ME ID. (R, setbycreate) (mandatory) (2-bytes)
47//
48// Downstream Minimum Time Interval For Upshift Rate Adaptation
49// Downstream minimum time interval for upshift rate adaptation: This parameter defines the
50// interval during which the downstream noise margin must remain above the downstream upshift noise
51// margin before the xTU-R attempts to increase the downstream net data rate. Its value ranges from
52// 0 to 16383-s. (R,-W, setbycreate) (optional) (2-bytes)
53//
54// Upstream Minimum Time Interval For Upshift Rate Adaptation
55// Upstream minimum time interval for upshift rate adaptation: This parameter defines the interval
56// during which the upstream noise margin must remain above the upstream upshift noise margin
57// before the xTU-C attempts to increase the upstream net data rate. Its value ranges from 0 to
58// 16383-s. (R,-W, setbycreate) (optional) (2-bytes)
59//
60// Downstream Downshift Noise Margin
61// Downstream downshift noise margin: If the downstream noise margin is below the downstream
62// downshift noise margin and remains there for more than the downstream minimum time interval for
63// downshift rate adaptation, the xTU-R attempts to decrease the downstream net data rate. This
64// attribute's value ranges from 0 (0.0 dB) to 310 (31.0 dB). (R,-W, setbycreate) (optional)
65// (2-bytes)
66//
67// Upstream Downshift Noise Margin
68// Upstream downshift noise margin: If the upstream noise margin is below the upstream downshift
69// noise margin and remains there for more than the upstream minimum time interval for downshift
70// rate adaptation, the xTUC attempts to decrease the upstream net data rate. This attribute's
71// value ranges from 0 (0.0 dB) to 310 (31.0 dB). (R,-W, setbycreate) (optional) (2-bytes)
72//
73// Downstream Minimum Time Interval For Downshift Rate Adaptation
74// Downstream minimum time interval for downshift rate adaptation: This parameter defines the
75// interval during which the downstream noise margin must remain below the downstream downshift
76// noise margin before the xTU-R attempts to decrease the downstream net data rate. Its value
77// ranges from 0 to 16383-s. (R,-W, setbycreate) (optional) (2-bytes)
78//
79// Upstream Minimum Time Interval For Downshift Rate Adaptation
80// Upstream minimum time interval for downshift rate adaptation: This parameter defines the
81// interval during which the upstream noise margin must remain below the upstream downshift noise
82// margin before the xTU-C attempts to decrease the upstream net data rate. Its value ranges from 0
83// to 16383-s. (R,-W, setbycreate) (optional) (2-bytes)
84//
85// Xtu Impedance State Forced
86// (R,-W, setbycreate) (optional) (1-byte)
87//
88// L0_Time
89// L0-time: This parameter specifies the minimum time between an exit from the L2 state and the
90// next entry into the L2 state. It is only valid for [ITUT-G.992.3], [ITUT-G.992.4] and
91// [ITUT-G.992.5]. It ranges from 0 to 255-s. (R,-W, setbycreate) (mandatory) (1 byte)
92//
93// L2_Time
94// L2-time: This parameter specifies the minimum time between an entry into the L2 state and the
95// first power trim in the L2 state, or between two consecutive power trims in the L2 state. It is
96// only valid for [ITUT-G.992.3], [ITUT-G.992.4] and [ITUT-G.992.5]. It ranges from 0 to 255-s. (R,
97// W, setbycreate) (mandatory) (1 byte)
98//
99// Downstream Maximum Nominal Power Spectral Density
100// Downstream maximum nominal power spectral density: This attribute specifies the maximum nominal
101// transmit PSD in the downstream direction during initialization and showtime. A single
102// MAXNOMPSDds attribute is defined per mode enabled in the xTSE line configuration attribute. It
103// is only valid for [ITUT-G.992.3], [ITUT-G.992.4] and [ITUT-G.992.5]. Its value ranges from 0
104// (60.0-dBm/Hz) to 300 (-30-dBm/Hz). (R, W, setbycreate) (mandatory) (2 bytes)
105//
106// Upstream Maximum Nominal Power Spectral Density
107// Upstream maximum nominal power spectral density: This attribute specifies the maximum nominal
108// transmit PSD in the upstream direction during initialization and showtime. A single MAXNOMPSDus
109// attribute is defined per mode enabled in the xTSE line configuration attribute. It is only valid
110// for [ITUT-G.992.3], [ITUT-G.992.4] and [ITUT-G.993.2]. Its value ranges from 0 (-60.0-dBm/Hz) to
111// 300 (-30-dBm/Hz). (R, W, setbycreate) (mandatory) (2 bytes)
112//
113// Downstream Maximum Nominal Aggregate Transmit Power
114// Downstream maximum nominal aggregate transmit power: This attribute specifies the maximum
115// nominal aggregate transmit power in the downstream direction during initialization and showtime.
116// It is only valid for [ITUT-G.992.3], [ITUT-G.992.4], [ITUT-G.992.5] and [ITUT-G.993.2]. Its
117// value ranges from 0 (0.0-dBm) to 255 (25.5-dBm). (R, W, setbycreate) (mandatory) (1-byte)
118//
119// Upstream Maximum Nominal Aggregate Transmit Power
120// Upstream maximum nominal aggregate transmit power: This parameter specifies the maximum nominal
121// aggregate transmit power in the upstream direction during initialization and showtime. It is
122// only valid for [ITUT-G.992.3], [ITUT-G.992.4] and [ITUT-G.992.5]. Its value ranges from 0
123// (0.0-dBm) to 255 (25.5-dBm). (R, W, setbycreate) (mandatory) (1 byte)
124//
125// Upstream Maximum Aggregate_Receive Power
126// Upstream maximum aggregate-receive power: This parameter specifies the maximum upstream
127// aggregate receive power over a set of subcarriers, as defined in the relevant Recommendation.
128// The xTU-C requests an upstream power cutback such that the upstream aggregate receive power over
129// that set of subcarriers is at or below the configured maximum value. It is only valid for
130// [ITUT-G.992.3], [ITUT-G.992.4] and [ITUT-G.992.5]. This attribute ranges from 0 (25.5-dBm) to
131// 510 (+25.5-dBm). The special value 0xFFFF indicates that no upstream maximum aggregate receive
132// power limit is to be applied. (R, W setbycreate) (mandatory) (2 bytes)
133//
134// Vdsl2 Transmission System Enabling
135// VDSL2 transmission system enabling: This configuration attribute extends the transmission system
136// coding types to be allowed by the xTU-C. It is a bit map, defined as octet 8 (bits 57..64) in
137// Table-9.7.12-1. (R, W, setbycreate) (optional) (1 byte)
138//
139type XdslLineConfigurationProfilePart2 struct {
140 ManagedEntityDefinition
141 Attributes AttributeValueMap
142}
143
144func init() {
145 xdsllineconfigurationprofilepart2BME = &ManagedEntityDefinition{
146 Name: "XdslLineConfigurationProfilePart2",
147 ClassID: 105,
148 MessageTypes: mapset.NewSetWith(
149 Create,
150 Delete,
151 Get,
152 Set,
153 ),
154 AllowedAttributeMask: 0xfffe,
155 AttributeDefinitions: AttributeDefinitionMap{
156 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
157 1: Uint16Field("DownstreamMinimumTimeIntervalForUpshiftRateAdaptation", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 1),
158 2: Uint16Field("UpstreamMinimumTimeIntervalForUpshiftRateAdaptation", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 2),
159 3: Uint16Field("DownstreamDownshiftNoiseMargin", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 3),
160 4: Uint16Field("UpstreamDownshiftNoiseMargin", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 4),
161 5: Uint16Field("DownstreamMinimumTimeIntervalForDownshiftRateAdaptation", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 5),
162 6: Uint16Field("UpstreamMinimumTimeIntervalForDownshiftRateAdaptation", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 6),
163 7: ByteField("XtuImpedanceStateForced", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 7),
164 8: ByteField("L0Time", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 8),
165 9: ByteField("L2Time", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 9),
166 10: Uint16Field("DownstreamMaximumNominalPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 10),
167 11: Uint16Field("UpstreamMaximumNominalPowerSpectralDensity", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 11),
168 12: ByteField("DownstreamMaximumNominalAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 12),
169 13: ByteField("UpstreamMaximumNominalAggregateTransmitPower", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 13),
170 14: Uint16Field("UpstreamMaximumAggregateReceivePower", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
171 15: ByteField("Vdsl2TransmissionSystemEnabling", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 15),
172 },
173 Access: CreatedByOlt,
174 Support: UnknownSupport,
175 }
176}
177
178// NewXdslLineConfigurationProfilePart2 (class ID 105) creates the basic
179// Managed Entity definition that is used to validate an ME of this type that
180// is received from or transmitted to the OMCC.
181func NewXdslLineConfigurationProfilePart2(params ...ParamData) (*ManagedEntity, OmciErrors) {
182 return NewManagedEntity(*xdsllineconfigurationprofilepart2BME, params...)
183}