blob: 851b056b7e9ef85a56bdc138ea6c14ef5696bf42 [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// XdslChannelConfigurationProfilePart2ClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL channel configuration profile part 2
Chip Boling610117d2021-09-09 11:24:34 -050030const XdslChannelConfigurationProfilePart2ClassID = ClassID(412) // 0x019c
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var xdslchannelconfigurationprofilepart2BME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// XdslChannelConfigurationProfilePart2 (Class ID: #412 / 0x019c)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME contains the channel configuration profile for an xDSL UNI. An instance of this ME is
36// created and deleted by the OLT.
37//
38// NOTE - If [ITUT G.997.1] compatibility is required, bit rates should only be set to integer
39// multiples of 1000-bits/s. The ONU may reject attempts to set other values for bit rate
40// attributes.
41//
42// Relationships
43// An instance of this ME may be associated with zero or more instances of the PPTP xDSL UNI part
44// 1.
45//
46// Attributes
47// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050048// This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is
49// implicitly linked to an instance of the xDSL channel configuration profile. (R, setbycreate)
50// (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060051//
52// Minimum Expected Throughput For Retransmission Minetr_Rtx
53// Minimum expected throughput for retransmission (MINETR_RTX): If retransmission is used in a
54// given transmit direction, this attribute specifies the minimum expected throughput for the
55// bearer channel, in bits per second. See clause 7.3.2.1.8 of [ITU-T G.997.1]. (R,-W) (mandatory)
56// (4-bytes)
57//
58// Maximum Expected Throughput For Retransmission Maxetr_Rtx
59// Maximum expected throughput for retransmission (MAXETR_RTX): If retransmission is used in a
60// given transmit direction, this parameter specifies the maximum expected throughput for the
61// bearer channel, in bits per second. See clause 7.3.2.1.9 of [ITU-T G.997.1]. (R,-W) (mandatory)
62// (4-bytes)
63//
64// Maximum Net Data Rate For Retransmission Maxndr_Rtx
65// Maximum net data rate for retransmission (MAXNDR_RTX): If retransmission is used in a given
66// transmit direction, this parameter specifies the maximum net data rate for the bearer channel,
67// in bits per second. See clause 7.3.2.1.10 of [ITUT-G.997.1]. (R,-W) (mandatory) (4-bytes)
68//
69// Maximum Delay For Retransmission Delaymax_Rtx
70// Maximum delay for retransmission (DELAYMAX_RTX): If retransmission is used in a given transmit
71// direction, this parameter specifies the maximum for the instantaneous delay due to the effect of
72// retransmission only. This delay is defined as the integer value of this attribute multiplied by
73// 1-ms. The valid delay values are given in clause 7.3.2.11 of [ITU-T G.997.1]. (R,-W) (mandatory)
74// (1-bytes)
75//
76// Minimum Delay For Retransmission Delaymin_Rtx
77// Minimum delay for retransmission (DELAYMIN_RTX): If retransmission is used in a given transmit
78// direction, this parameter specifies the minimum for the instantaneous delay due to the effect of
79// retransmission only. This delay is defined as the integer value of this attribute multiplied by
80// 1 ms. The valid delay values are given in clause 7.3.2.12 of [ITU-T G.997.1]. (R,-W) (mandatory)
81// (1-bytes)
82//
83// Minimum Impulse Noise Protection Against Single High Impulse Noise Event Shine For Retransmission Inpmin_Shine_Rtx
84// Minimum impulse noise protection against single high impulse noise event (SHINE) for
85// retransmission (INPMIN_SHINE_RTX): If retransmission is used in a given transmit direction, this
86// parameter specifies the minimum INP against a SHINE for the bearer channel if it is transported
87// over DMT symbols with a subcarrier spacing of 4.3125-kHz. The valid range of values is given in
88// clause-7.3.2.13 of [ITU-T G.997.1]. (R,-W) (mandatory) (1-bytes)
89//
90// Minimum Impulse Noise Protection Against Shine For Retransmission For Systems Using 8.625 Khz Subcarrier Spacing Inpmin8_Shine_Rtx
91// Minimum impulse noise protection against SHINE for retransmission for systems using 8.625 kHz
92// subcarrier spacing (INPMIN8_SHINE_RTX): If retransmission is used in a given transmit direction,
93// this parameter specifies the minimum INP against SHINE for the bearer channel if it is
94// transported over DMT symbols with a subcarrier spacing of 8.625-kHz. The valid range of values
95// is given in clause 7.3.2.14 of [ITUT-G.997.1]. (R,-W) (mandatory) (1-bytes)
96//
97// Shineratio_Rtx
Chip Boling610117d2021-09-09 11:24:34 -050098// If retransmission is used in a given transmit direction, this parameter specifies the SHINE
99// ratio. This ratio is defined as the integer value of this attribute multiplied by 0.001. The
100// valid range of values is given in clause-7.3.2.15 of [ITU-T G.997.1]. (R,-W) (mandatory)
101// (1-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600102//
103// Minimum Impulse Noise Protection Against Rein For Retransmission Inpmin_Rein_Rtx
104// Minimum impulse noise protection against REIN for retransmission (INPMIN_REIN_RTX): If
105// retransmission is used in a given transmit direction, this parameter specifies the minimum INP
106// against REIN for the bearer channel if it is transported over DMT symbols with a subcarrier
107// spacing of 4.3125 kHz. The valid range of values is given in clause-7.3.2.16 of [ITU-T G.997.1].
108// (R,-W) (mandatory) (1-bytes)
109//
110// Minimum Impulse Noise Protection Against Rein For Retransmission For Systems Using 8.625_Khz Subcarrier Spacing Inpmin8_Rein_Rtx
111// Minimum impulse noise protection against REIN for retransmission for systems using 8.625-kHz
112// subcarrier spacing (INPMIN8_REIN_RTX): If retransmission is used in a given transmit direction,
113// this parameter specifies the minimum INP against REIN for the bearer channel if it is
114// transported over DMT symbols with a subcarrier spacing of 8.625 kHz. The valid range of values
115// is given in clause 7.3.2.17 of [ITU-T G.997.1]. (R,-W) (mandatory) (1-bytes)
116//
117// Rein Inter_Arrival Time For Retransmission Iat_Rein_Rtx
118// REIN inter-arrival time for retransmission (IAT_REIN_RTX): If retransmission is used in a given
119// transmit direction, this parameter specifies the IAT that shall be assumed for REIN protection.
120// The valid range of values is given in clause 7.3.2.18 of [ITU-T G.997.1]. (R,-W) (mandatory)
121// (1-bytes)
122//
123// Target Net Data Rate Target_Ndr
124// Target net data rate (TARGET_NDR): If retransmission is not used in a given transmit direction,
125// this parameter specifies the target net data of the bearer channel, in bits per second. See
126// clause 7.3.2.19.1 of [ITU-T G.997.1]. (R,-W) (mandatory) (4-bytes)
127//
128// Target Expected Throughput For Retransmission Target_Etr
129// Target expected throughput for retransmission (TARGET_ETR): If retransmission is used in a given
130// transmit direction, this parameter specifies the target expected throughput for the bearer
131// channel, in bits per second. See clause 7.3.2.19.2 of [ITUT-G.997.1]. (R,-W) (mandatory)
132// (4-bytes)
133//
134type XdslChannelConfigurationProfilePart2 struct {
135 ManagedEntityDefinition
136 Attributes AttributeValueMap
137}
138
139func init() {
140 xdslchannelconfigurationprofilepart2BME = &ManagedEntityDefinition{
141 Name: "XdslChannelConfigurationProfilePart2",
142 ClassID: 412,
143 MessageTypes: mapset.NewSetWith(
144 Create,
145 Delete,
146 Get,
147 Set,
148 ),
149 AllowedAttributeMask: 0xfff8,
150 AttributeDefinitions: AttributeDefinitionMap{
151 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
152 1: Uint32Field("MinimumExpectedThroughputForRetransmissionMinetrRtx", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
153 2: Uint32Field("MaximumExpectedThroughputForRetransmissionMaxetrRtx", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, false, false, 2),
154 3: Uint32Field("MaximumNetDataRateForRetransmissionMaxndrRtx", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), false, false, false, 3),
155 4: ByteField("MaximumDelayForRetransmissionDelaymaxRtx", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, false, false, 4),
156 5: ByteField("MinimumDelayForRetransmissionDelayminRtx", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, false, false, 5),
157 6: ByteField("MinimumImpulseNoiseProtectionAgainstSingleHighImpulseNoiseEventShineForRetransmissionInpminShineRtx", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, false, false, 6),
158 7: ByteField("MinimumImpulseNoiseProtectionAgainstShineForRetransmissionForSystemsUsing8625KhzSubcarrierSpacingInpmin8ShineRtx", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), false, false, false, 7),
159 8: ByteField("ShineratioRtx", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, false, false, 8),
160 9: ByteField("MinimumImpulseNoiseProtectionAgainstReinForRetransmissionInpminReinRtx", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, false, false, 9),
161 10: ByteField("MinimumImpulseNoiseProtectionAgainstReinForRetransmissionForSystemsUsing8625KhzSubcarrierSpacingInpmin8ReinRtx", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, false, false, 10),
162 11: ByteField("ReinInterArrivalTimeForRetransmissionIatReinRtx", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, false, false, 11),
163 12: Uint32Field("TargetNetDataRateTargetNdr", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, false, false, 12),
164 13: Uint32Field("TargetExpectedThroughputForRetransmissionTargetEtr", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, Write), false, false, false, 13),
165 },
166 Access: CreatedByOlt,
167 Support: UnknownSupport,
168 }
169}
170
171// NewXdslChannelConfigurationProfilePart2 (class ID 412) creates the basic
172// Managed Entity definition that is used to validate an ME of this type that
173// is received from or transmitted to the OMCC.
174func NewXdslChannelConfigurationProfilePart2(params ...ParamData) (*ManagedEntity, OmciErrors) {
175 return NewManagedEntity(*xdslchannelconfigurationprofilepart2BME, params...)
176}