blob: 66fb1d3d12a46a55873be38e526d711ad538d1c2 [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// XdslLineConfigurationProfilePart3ClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL line configuration profile part 3
30const XdslLineConfigurationProfilePart3ClassID ClassID = ClassID(106)
31
32var xdsllineconfigurationprofilepart3BME *ManagedEntityDefinition
33
34// XdslLineConfigurationProfilePart3 (class ID #106)
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// Loop Diagnostics Mode Forced Ldsf
49// Only while the line power management state is L3 can the line be forced into loop diagnostic
50// mode. When loop diagnostic procedures complete successfully, the ONU resets this attribute to 0.
51// The line remains in the L3 idle state. The loop diagnostics data are available at least until
52// the line is forced to the L0 state. As long as loop diagnostic procedures have not completed
53// successfully, attempts are made to do so, until the loop diagnostic mode is no longer forced on
54// the line through this configuration parameter. If loop diagnostic procedures cannot be completed
55// successfully after a vendordiscretionary number of retries or within a vendor-discretionary
56// timeout, then an initialization failure occurs. (R,-W, setbycreate) (mandatory) (1-byte)
57//
58// Automode Cold Start Forced
59// Automode is defined as the case where multiple operation modes are enabled in xTSE (Table
60// 9.7.12-1) and where the selection of the operation mode to be used for transmission depends, not
61// only on the common capabilities of both xTUs (as exchanged in [ITU-T G.994.1]), but also on
62// achievable data rates under given loop conditions. (R,-W, setbycreate) (mandatory if automode is
63// supported) (1-byte)
64//
65// L2 Atpr
66// L2ATPR: This parameter specifies the maximum aggregate transmit power reduction that can be
67// performed in the L2 request (i.e., at the transition of L0 to L2 state) or through a single
68// power trim in the L2 state. It is only valid for [ITUT-G.992.3], [ITUT-G.992.4] and
69// [ITUT-G.992.5]. This attribute ranges from 0 (0-dB) dB to 31 (31-dB). (R, W, setbycreate)
70// (mandatory) (1 byte)
71//
72// L2 Atprt
73// L2ATPRT: This parameter specifies the total maximum aggregate transmit power reduction (in
74// decibels) that can be performed in an L2 state. This is the sum of all reductions of L2 requests
75// (i.e., at transitions from L0 to L2 state) and power trims. This attribute ranges from 0 (0 dB)
76// dB to 31 (31 dB). (R, W, setbycreate) (mandatory) (1 byte)
77//
78// Force Inp Downstream
79// Force INP downstream: When set to 1, the FORCEINPds attribute forces the framer settings of all
80// downstream bearer channels to be selected such that the impulse noise protection (INP) computed
81// according to the formula specified in the relevant Recommendation is greater than or equal to
82// the minimal INP requirement. The default value 0 disables this function. (R, W) (mandatory for
83// [ITU-T G.993.2], optional for other Recommendations that support it) (1 byte)
84//
85// Force Inp Upstream
86// Force INP upstream: When set to 1, the FORCEINPus attribute forces the framer settings of all
87// upstream bearer channels to be selected such that the INP computed according to the formula
88// specified in the relevant Recommendation is greater than or equal to the minimal INP
89// requirement. The default value 0 disables this function. (R, W) (mandatory for [ITU-T G.993.2],
90// optional for other Recommendations that support it) (1 byte)
91//
92// Update Request Flag For Near_End Test Parameters
93// Update request flag for near-end test parameters: The UPDATE-TEST-NE attribute forces an update
94// of all near-end test parameters that can be updated during showtime in [ITU-T G.993.2]. Update
95// is triggered by setting this attribute to 1, whereupon the near-end test parameters are expected
96// to be updated within 10-s, and the ONU should reset the attribute value to 0. The update request
97// flag is independent of any autonomous update process in the system. The update request attribute
98// must be prepared to accept another set after a period not to exceed 3-min, a period that starts
99// when the flag is set via the OMCI or by an autonomous process in the system. (R,-W) (optional)
100// (1-byte)
101//
102// Update Request Flag For Far_End Test Parameters
103// Update request flag for far-end test parameters: The UPDATE-TEST-FE attribute forces an update
104// of all far-end test parameters that can be updated during showtime in [ITU-T G.993.2]. Update is
105// triggered by setting this attribute to 1, whereupon the far-end test parameters are expected to
106// be updated within 10-s, and the ONU should reset the attribute value to 0. The update request
107// flag is independent of any autonomous update process in the system. The update request attribute
108// must be prepared to accept another set after a period not to exceed 3-min, a period that starts
109// when the flag is set via the OMCI or by an autonomous process in the system. (R,-W) (optional)
110// (1-byte)
111//
112// Inm Inter Arrival Time Offset Upstream
113// INM inter-arrival time offset upstream: INMIATOus is the inter-arrival time (IAT) offset that
114// the xTU-C receiver uses to determine in which bin of the IAT histogram the IAT is reported.
115// Valid values for INMIATO range from 3 to 511 discrete multi-tone (DMT) symbols in steps of 1 DMT
116// symbol. (R,-W) (optional) (2-bytes)
117//
118// Inm Inter_Arrival Time Step Upstream
119// INM inter-arrival time step upstream: INMIATSus is the IAT step that the xTU-C receiver uses to
120// determine in which bin of the IAT histogram the IAT is reported. Valid values for INMIATS range
121// from 0 to 7 in steps of 1. (R,-W) (optional) (1-byte)
122//
123// Inm Cluster Continuation Value Upstream
124// INM cluster continuation value upstream: INMCCus is the cluster continuation value that the
125// xTU-C receiver uses in the cluster indication process described in the applicable
126// Recommendation. Valid values for INMCC range from 0 to 64 DMT symbols in steps of 1 DMT symbol.
127// (R,-W) (optional) (1-byte)
128//
129// Inm Equivalent Inp Mode Upstream
130// INM equivalent INP mode upstream: INM_INPEQ_MODEus is the INM equivalent INP mode that the xTU-C
131// receiver uses in the computation of the equivalent INP, as defined in the applicable
132// Recommendation. Valid values for INM_INPEQ_MODE are 0..4. (R,-W) (optional) (1-byte)
133//
134// Inm Inter Arrival Time Offset Downstream
135// INM inter-arrival time offset downstream: INMIATOds is the IAT offset that the xTU-R receiver
136// uses to determine in which bin of the IAT histogram the IAT is reported. Valid values for
137// INMIATO range from 3 to 511 DMT symbols in steps of 1 DMT symbol. (R,-W) (optional) (2-bytes)
138//
139// Inm Inter_Arrival Time Step Downstream
140// INM inter-arrival time step downstream: INMIATSds is the IAT step that the xTU-R receiver uses
141// to determine in which bin of the IAT histogram the IAT is reported. Valid values for INMIATS
142// range from 0 to 7 in steps of 1. (R,-W) (optional) (1-byte)
143//
144// Inm Cluster Continuation Value Downstream
145// INM cluster continuation value downstream: INMCCds is the cluster continuation value that the
146// xTU-R receiver uses in the cluster indication process described in the applicable
147// Recommendation. Valid values for INMCC range from 0 to 64 DMT symbols in steps of 1 DMT symbol.
148// (R,-W) (optional) (1-byte)
149//
150// Inm Equivalent Inp Mode Downstream
151// INM equivalent INP mode downstream: INM_INPEQ_MODEds is the INM equivalent INP mode that the
152// xTU-R receiver uses in the computation of the equivalent INP, as defined in the applicable
153// Recommendation. Valid values for INM_INPEQ_MODE are 0..4. (R,-W) (optional) (1-byte)
154//
155type XdslLineConfigurationProfilePart3 struct {
156 ManagedEntityDefinition
157 Attributes AttributeValueMap
158}
159
160func init() {
161 xdsllineconfigurationprofilepart3BME = &ManagedEntityDefinition{
162 Name: "XdslLineConfigurationProfilePart3",
163 ClassID: 106,
164 MessageTypes: mapset.NewSetWith(
165 Create,
166 Delete,
167 Get,
168 Set,
169 ),
170 AllowedAttributeMask: 0xffff,
171 AttributeDefinitions: AttributeDefinitionMap{
172 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
173 1: ByteField("LoopDiagnosticsModeForcedLdsf", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
174 2: ByteField("AutomodeColdStartForced", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
175 3: ByteField("L2Atpr", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 3),
176 4: ByteField("L2Atprt", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 4),
177 5: ByteField("ForceInpDownstream", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, false, false, 5),
178 6: ByteField("ForceInpUpstream", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, false, false, 6),
179 7: ByteField("UpdateRequestFlagForNearEndTestParameters", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), true, true, false, 7),
180 8: ByteField("UpdateRequestFlagForFarEndTestParameters", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), true, true, false, 8),
181 9: Uint16Field("InmInterArrivalTimeOffsetUpstream", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, true, false, 9),
182 10: ByteField("InmInterArrivalTimeStepUpstream", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, true, false, 10),
183 11: ByteField("InmClusterContinuationValueUpstream", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11),
184 12: ByteField("InmEquivalentInpModeUpstream", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12),
185 13: Uint16Field("InmInterArrivalTimeOffsetDownstream", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, Write), false, true, false, 13),
186 14: ByteField("InmInterArrivalTimeStepDownstream", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read, Write), false, true, false, 14),
187 15: ByteField("InmClusterContinuationValueDownstream", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read, Write), false, true, false, 15),
188 16: ByteField("InmEquivalentInpModeDownstream", UnsignedIntegerAttributeType, 0x0001, 0, mapset.NewSetWith(Read, Write), false, true, false, 16),
189 },
190 Access: CreatedByOlt,
191 Support: UnknownSupport,
192 }
193}
194
195// NewXdslLineConfigurationProfilePart3 (class ID 106) creates the basic
196// Managed Entity definition that is used to validate an ME of this type that
197// is received from or transmitted to the OMCC.
198func NewXdslLineConfigurationProfilePart3(params ...ParamData) (*ManagedEntity, OmciErrors) {
199 return NewManagedEntity(*xdsllineconfigurationprofilepart3BME, params...)
200}