blob: 08adc36cd22ac4debf162988af15cffb8d5380ee [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// XdslChannelDownstreamStatusDataClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL channel downstream status data
30const XdslChannelDownstreamStatusDataClassID ClassID = ClassID(102)
31
32var xdslchanneldownstreamstatusdataBME *ManagedEntityDefinition
33
34// XdslChannelDownstreamStatusData (class ID #102)
35// This ME contains downstream channel status data for an xDSL UNI. The ONU automatically creates
36// or deletes instances of this ME upon the creation or deletion of a PPTP xDSL UNI part 1.
37//
38// NOTE - [ITU-T G.997.1] specifies that bit rate attributes have a granularity of 1000-bit/s. If
39// ITU-T G.997.1 compliance is required, the ONU should only report values with this granularity.
40//
41// Relationships
42// One or more instances of this ME are associated with an instance of an xDSL UNI.
43//
44// Attributes
45// Managed Entity Id
46// Managed entity ID: This attribute uniquely identifies each instance of this ME. The two MSBs of
47// the first byte are the bearer channel ID. Excluding the first 2-bits of the first byte, the
48// remaining part of the ME ID is identical to that of this ME's parent PPTP xDSL UNI part 1. (R)
49// (mandatory) (2-bytes)
50//
51// Actual Interleaving Delay
52// Actual interleaving delay: This attribute is the actual one-way interleaving delay introduced by
53// the PMS-TC between the alpha and beta reference points, excluding delay in the L1 and L2 states.
54// In the L1 and L2 states, the attribute contains the interleaving delay in the previous L0 state.
55// For ADSL, this attribute is derived from the S and D attributes as cap(S*D)/4 ms, where S is the
56// number of symbols per codeword, D is the interleaving depth and cap() denotes rounding to the
57// next higher integer. For [ITU-T G.993.2], this attribute is computed according to the formula in
58// clause 9.7 of [ITUT-G.993.2]. The actual interleaving delay is coded in milliseconds, rounded to
59// the nearest millisecond. (R) (mandatory) (1-byte)
60//
61// Actual Data Rate
62// Actual data rate: This parameter reports the actual net data rate of the bearer channel,
63// excluding the rate in the L1 and L2 states. In the L1 or L2 state, the parameter contains the
64// net data rate in the previous L0 state. The data rate is coded in bits per second. (R)
65// (mandatory) (4-bytes)
66//
67// Previous Data Rate
68// Previous data rate: This parameter reports the previous net data rate of the bearer channel just
69// before the latest rate change event occurred, excluding transitions between the L0 state and the
70// L1 or L2 states. A rate change can occur at a power management state transition, e.g., at full
71// or short initialization, fast retrain or power down, or at a dynamic rate adaptation. The rate
72// is coded in bits per second (R) (mandatory) (4-bytes)
73//
74// Actual Impulse Noise Protection
75// Actual impulse noise protection: The ACTINP attribute reports the actual INP on the bearer
76// channel in the L0 state. In the L1 or L2 state, the attribute contains the INP in the previous
77// L0 state. The value of this attribute is a number of DMT symbols, with a granularity of 0.1
78// symbols. Its range is from 0 (0.0 symbols) to 254 (25.4 symbols). The special value 255
79// indicates an ACTINP higher than 25.4. (R) (optional for [ITU-T G.992.1], mandatory for other
80// xDSL Recommendations that support this attribute) (1-byte)
81//
82// Actual Size Of Reed_Solomon Codeword
83// Actual size of Reed-Solomon codeword: The NFEC attribute reports the actual Reed-Solomon
84// codeword size used in the latency path in which the bearer channel is transported. The value is
85// coded in bytes, and ranges from 0..255. (R) (mandatory for ITUT-G.993.2 VDSL2, optional for
86// others) (1-byte)
87//
88// Actual Number Of Reed_Solomon Redundancy Bytes
89// Actual number of Reed-Solomon redundancy bytes: The RFEC attribute reports the actual number of
90// Reed-Solomon redundancy bytes per codeword used in the latency path in which the bearer channel
91// is transported. The value is coded in bytes, and ranges from 0..16. The value 0 indicates no
92// Reed-Solomon coding. (R) (mandatory for ITUT-G.993.2 VDSL2, optional for others) (1-byte)
93//
94// Actual Number Of Bits Per Symbol
95// Actual number of bits per symbol: The LSYMB attribute reports the actual number of bits per
96// symbol assigned to the latency path in which the bearer channel is transported, excluding
97// trellis overhead. The value is coded in bits, and ranges from 0..65535. (R) (mandatory for [TU-T
98// G.993.2 VDSL2, optional for others) (2-bytes)
99//
100// Actual Interleaving Depth
101// Actual interleaving depth: The INTLVDEPTH attribute reports the actual depth of the interleaver
102// used in the latency path in which the bearer channel is transported. The value ranges from
103// 1..4096 in steps of 1. The value 1 indicates no interleaving. (R) (mandatory for ITU-T G.993.2
104// VDSL2, optional for others) (2-bytes)
105//
106// Actual Interleaving Block Length
107// Actual interleaving block length: The INTLVBLOCK attribute reports the actual block length of
108// the interleaver used in the latency path in which the bearer channel is transported. The value
109// ranges from 4..255 in steps of 1. (R) (mandatory for ITU-T G.993.2 VDSL2, undefined for others)
110// (1-byte)
111//
112// Actual Latency Path
113// Actual latency path: The LPATH attribute reports the index of the actual latency path in which
114// the bearer channel is transported. Valid values are 0..3. In [ITUT-G.992.1], the fast path is
115// mapped to latency index 0; the interleaved path to index 1. (R) (mandatory for ITU-T G.993.2
116// VDSL2, optional for others) (1-byte)
117//
118// Actual Impulse Noise Protection Against R Epetitive E Lectrical I Mpulse N Oise Actinp_Rein
119// Actual impulse noise protection against repetitive electrical impulse noise (ACTINP_REIN): If
120// retransmission is used in a given transmit direction, this parameter reports the actual INP
121// against REIN on the bearer channel. The INP of this attribute is equal to the integer value
122// multiplied by 0.1 symbols. Valid values and usage are given in clause 7.5.2.9 of [ITU-T G.997.1]
123// (R) (optional) (1-byte)
124//
125type XdslChannelDownstreamStatusData struct {
126 ManagedEntityDefinition
127 Attributes AttributeValueMap
128}
129
130func init() {
131 xdslchanneldownstreamstatusdataBME = &ManagedEntityDefinition{
132 Name: "XdslChannelDownstreamStatusData",
133 ClassID: 102,
134 MessageTypes: mapset.NewSetWith(
135 Get,
136 ),
137 AllowedAttributeMask: 0xffe0,
138 AttributeDefinitions: AttributeDefinitionMap{
139 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
140 1: ByteField("ActualInterleavingDelay", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
141 2: Uint32Field("ActualDataRate", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
142 3: Uint32Field("PreviousDataRate", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
143 4: ByteField("ActualImpulseNoiseProtection", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
144 5: ByteField("ActualSizeOfReedSolomonCodeword", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
145 6: ByteField("ActualNumberOfReedSolomonRedundancyBytes", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
146 7: Uint16Field("ActualNumberOfBitsPerSymbol", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
147 8: Uint16Field("ActualInterleavingDepth", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
148 9: ByteField("ActualInterleavingBlockLength", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
149 10: ByteField("ActualLatencyPath", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
150 11: ByteField("ActualImpulseNoiseProtectionAgainstREpetitiveELectricalIMpulseNOiseActinpRein", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, true, false, 11),
151 },
152 Access: CreatedByOnu,
153 Support: UnknownSupport,
154 }
155}
156
157// NewXdslChannelDownstreamStatusData (class ID 102) creates the basic
158// Managed Entity definition that is used to validate an ME of this type that
159// is received from or transmitted to the OMCC.
160func NewXdslChannelDownstreamStatusData(params ...ParamData) (*ManagedEntity, OmciErrors) {
161 return NewManagedEntity(*xdslchanneldownstreamstatusdataBME, params...)
162}