blob: fd642d226e401b3b016b23f6cb1caa82a00c755e [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// Vdsl2LineConfigurationExtensions3ClassID is the 16-bit ID for the OMCI
29// Managed entity VDSL2 line configuration extensions 3
Chip Boling610117d2021-09-09 11:24:34 -050030const Vdsl2LineConfigurationExtensions3ClassID = ClassID(410) // 0x019a
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var vdsl2lineconfigurationextensions3BME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// Vdsl2LineConfigurationExtensions3 (Class ID: #410 / 0x019a)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME extends the xDSL line configuration MEs.
36//
37// An instance of this ME is created and deleted by the OLT.
38//
39// Relationships
40// An instance of this ME may be associated with zero or more instances of an xDSL UNI.//// The overall xDSL line configuration profile is modelled in several parts, all of which are
41// associated together through a common ME ID (the client PPTP xDSL UNI part 1 has a single
42// pointer, which refers to the entire set of line configuration parts).
43//
44// Attributes
45// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050046// This attribute uniquely identifies each instance of this ME. All xDSL and VDSL2 line
47// configuration profiles and extensions that pertain to a given PPTP xDSL UNI must share a common
48// ME ID. (R, setbycreate) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060049//
50// Ripolicyds
Chip Boling610117d2021-09-09 11:24:34 -050051// This attribute indicates which policy shall be applied to determine the triggers for re-
52// initialization in the downstream direction. A valid range of values is given in clause
Chip Boling6e27b352020-02-14 09:10:01 -060053// 7.3.1.1.12.1 of [ITU-T G.997.1]. (R,-W) (optional) (1-byte)
54//
55// Ripolicyus
Chip Boling610117d2021-09-09 11:24:34 -050056// This attribute indicates which policy shall be applied to determine the triggers for re-
57// initialization in the upstream direction. A valid range of values is given in clause
Chip Boling6e27b352020-02-14 09:10:01 -060058// 7.3.1.1.12.2 of [ITU-T G.997.1]. (R,-W) (optional) (1-byte)
59//
60// Reinit_Time_Thresholdds
Chip Boling610117d2021-09-09 11:24:34 -050061// This attribute indicates defines the downstream threshold for re-initialization based on SES, to
62// be used by the VTU receiver when re-initialization policy 1 is used in downstream. A valid range
63// of values is given in clause 7.3.1.1.13.1 of [ITU-T G.997.1]. (R,-W) (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060064//
65// Reinit_Time_Thresholdus
Chip Boling610117d2021-09-09 11:24:34 -050066// This attribute indicates defines the upstream threshold for re-initialization based on SES, to
67// be used by the VTU receiver when reinitialization policy 1 is used in upstream. A valid range of
68// values is given in clause 7.3.1.1.13.2 of [ITU-T G.997.1]. (R,-W) (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060069//
70// Rxrefvnsfus
Chip Boling610117d2021-09-09 11:24:34 -050071// If SNRM_MODE = 4, this attribute defines the upstream receiver-referred virtual noise scaling
72// factor. The attribute value ranges from 0 (-64.0-dBm) to 255 (+63.5-dBm) - see clause 7.3.1.7.5
73// of [ITU-T G.997.1]. (R,-W) (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060074//
75// Txrefvnsfds
Chip Boling610117d2021-09-09 11:24:34 -050076// If SNRM_MODE = 4, this attribute defines the downstream transmitter referred virtual noise
77// scaling factor. The attribute value ranges from 0 (-64.0-dBm) to 255 (+63.5-dBm) - see clause
78// 7.3.1.7.6 of [ITU-T G.997.1]. (R,-W) (optional) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060079//
80// Rtx_Modeds
Chip Boling610117d2021-09-09 11:24:34 -050081// This attribute controls the mode of operation of [ITU-T G.998.4] retransmission in the
82// downstream direction. A valid range of values is given in clause 7.3.1.11 of [ITU-T G.997.1].
Chip Boling6e27b352020-02-14 09:10:01 -060083// (R,-W) (mandatory) (1-byte)
84//
Chip Boling610117d2021-09-09 11:24:34 -050085// Rtx_Modeus
86// This attribute controls the mode of operation of [ITU-T G.998.4] retransmission in the upstream
87// direction. A valid range of values is given in clause 7.3.1.11 of [ITU-T G.997.1]. (R,-W)
88// (mandatory) (1-byte)
89//
Chip Boling6e27b352020-02-14 09:10:01 -060090// Leftr_Thresh
Chip Boling610117d2021-09-09 11:24:34 -050091// If retransmission is used in a given transmit direction, LEFTR_THRESH specifies the threshold
92// for declaring a near-end ''leftr'' defect. LEFTR_THRESH is equal to the integer value of this
93// attribute multiplied by 0.01. Valid values and usage are given in clause 7.3.1.12 of [ITU-T
94// G.997.1]. (R,-W) (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060095//
96// Maxdelayoctet_Split Parameter Mdosplit
97// MAXDELAYOCTET-split parameter (MDOSPLIT): This attribute defines the percentage of the
98// MAXDELAYOCTET_ext if operating in [ITU-T G.998.4] or MAXDELAYOCTET in other cases allocated to
99// the downstream direction. MDOSPLIT is equal to the integer value of this attribute multiplied by
100// 1%. Valid values and usage are given in clause 7.3.1.14 of [ITUT-G.997.1]. (R,-W) (optional)
101// (1-byte)
102//
103// Attndr Method Attndr_Method
104// ATTNDR Method (ATTNDR_METHOD): This attribute specifies the method to be used for the
105// calculation of the ATTNDR in the downstream and upstream direction. Valid values are given in
106// clause 7.3.1.15.1 of [ITU-T G.997.1]. (R,-W) (optional) (1-byte)
107//
108// Attndr Maxdelayoctet_Split Parameter Attndr_Mdosplit
109// ATTNDR MAXDELAYOCTET-split parameter (ATTNDR_MDOSPLIT): This attribute defines the percentage of
110// the MAXDELAYOCTET_ext if operating in [ITU-T G.998.4] or MAXDELAYOCTET in other cases allocated
111// to the downstream direction to be used in the improved method for calculation of the ATTNDR. The
112// valid values are identical to the values of the line configuration parameter MDOSPLIT. See
113// clause 7.3.1.15.2 of [ITUT-G.997.1]. (R,-W) (optional) (1-byte)
114//
115type Vdsl2LineConfigurationExtensions3 struct {
116 ManagedEntityDefinition
117 Attributes AttributeValueMap
118}
119
120func init() {
121 vdsl2lineconfigurationextensions3BME = &ManagedEntityDefinition{
122 Name: "Vdsl2LineConfigurationExtensions3",
123 ClassID: 410,
124 MessageTypes: mapset.NewSetWith(
125 Create,
126 Delete,
127 Get,
128 Set,
129 ),
130 AllowedAttributeMask: 0xfff0,
131 AttributeDefinitions: AttributeDefinitionMap{
132 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
133 1: ByteField("Ripolicyds", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, true, false, 1),
134 2: ByteField("Ripolicyus", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, true, false, 2),
135 3: ByteField("ReinitTimeThresholdds", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), false, true, false, 3),
136 4: ByteField("ReinitTimeThresholdus", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4),
137 5: ByteField("Rxrefvnsfus", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, true, false, 5),
138 6: ByteField("Txrefvnsfds", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, true, false, 6),
139 7: ByteField("RtxModeds", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), false, false, false, 7),
140 8: ByteField("RtxModeus", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, false, false, 8),
141 9: ByteField("LeftrThresh", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, false, false, 9),
142 10: ByteField("MaxdelayoctetSplitParameterMdosplit", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, true, false, 10),
143 11: ByteField("AttndrMethodAttndrMethod", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11),
144 12: ByteField("AttndrMaxdelayoctetSplitParameterAttndrMdosplit", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12),
145 },
146 Access: CreatedByOlt,
147 Support: UnknownSupport,
148 }
149}
150
151// NewVdsl2LineConfigurationExtensions3 (class ID 410) creates the basic
152// Managed Entity definition that is used to validate an ME of this type that
153// is received from or transmitted to the OMCC.
154func NewVdsl2LineConfigurationExtensions3(params ...ParamData) (*ManagedEntity, OmciErrors) {
155 return NewManagedEntity(*vdsl2lineconfigurationextensions3BME, params...)
156}