blob: 58970a72a26bc54b17a62d789cd1c3c2d48a9dd2 [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// XdslChannelUpstreamStatusDataClassID is the 16-bit ID for the OMCI
29// Managed entity xDSL channel upstream status data
Chip Boling610117d2021-09-09 11:24:34 -050030const XdslChannelUpstreamStatusDataClassID = ClassID(103) // 0x0067
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var xdslchannelupstreamstatusdataBME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// XdslChannelUpstreamStatusData (Class ID: #103 / 0x0067)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME contains upstream channel status data for an xDSL UNI. The ONU automatically creates or
36// deletes instances of this ME upon the creation or deletion of a PPTP xDSL UNI part 1.
37//
38// Relationships
39// One or more instances of this ME are associated with an instance of an xDSL UNI.
40//
41// Attributes
42// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050043// This attribute uniquely identifies each instance of this ME. The two MSBs of the first byte are
44// the bearer channel ID. Excluding the first 2-bits of the first byte, the remaining part of the
45// ME ID is identical to that of this ME's parent PPTP xDSL UNI part 1. (R) (mandatory) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060046//
47// Actual Interleaving Delay
Chip Boling610117d2021-09-09 11:24:34 -050048// This attribute is the actual one-way interleaving delay introduced by the PMS-TC between the
49// alpha and beta reference points, excluding the L1 and L2 states. In the L1 and L2 states, this
50// attribute contains the interleaving delay in the previous L0 state. For ADSL, this attribute is
51// derived from the S and D attributes as cap(S*D)/4-ms, where S is the number of symbols per
52// codeword, D is the interleaving depth and cap() denotes rounding to the next higher integer. For
53// [ITU-T G.993.2], this attribute is computed according to the formula in clause 9.7 of [ITUT
54// G.993.2]. The actual interleaving delay is coded in milliseconds, rounded to the nearest
55// millisecond. (R) (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060056//
57// Actual Data Rate
Chip Boling610117d2021-09-09 11:24:34 -050058// This parameter reports the actual net data rate of the bearer channel, excluding the L1 and L2
59// states. In the L1 or L2 state, the parameter contains the net data rate in the previous L0
60// state. The data rate is coded in bits per second. (R) (mandatory) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060061//
62// Previous Data Rate
Chip Boling610117d2021-09-09 11:24:34 -050063// This parameter reports the previous net data rate of the bearer channel just before the latest
64// rate change event occurred, excluding transitions between the L0 state and the L1 or L2 state. A
65// rate change can occur at a power management state transition, e.g., at full or short
66// initialization, fast retrain or power down, or at a dynamic rate adaptation. The rate is coded
67// in bits per second. (R) (mandatory) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060068//
69// Actual Impulse Noise Protection
Chip Boling610117d2021-09-09 11:24:34 -050070// The ACTINP attribute reports the actual INP on the bearer channel in the L0 state. In the L1 or
71// L2 state, the attribute contains the INP in the previous L0 state. The value is coded in
72// fractions of DMT symbols with a granularity of 0.1 symbols. The range is from 0 (0.0 symbols) to
73// 254 (25.4 symbols). The special value 255 indicates an ACTINP higher than 25.4. (R) (mandatory
74// for ITU-T G.993.2 VDSL2, optional for other xDSL Recommendations that support it) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060075//
76// Impulse Noise Protection Reporting Mode
Chip Boling610117d2021-09-09 11:24:34 -050077// The INPREPORT attribute reports the method used to compute the ACTINP. If set to 0, the ACTINP
78// is computed according to the INP_no_erasure formula (clause 9.6 of [ITUT G.993.2]). If set to 1,
79// ACTINP is the value estimated by the xTU receiver. (R) (mandatory for ITU-T G.993.2 VDSL2)
80// (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060081//
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. Its value is
85// coded in bytes in the range 0..255. (R) (mandatory for ITU-T G.993.2 VDSL2, optional for others)
86// (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. Its value is coded in bytes in the range 0..16. The value 0 indicates no Reed-
92// Solomon coding. (R) (mandatory for ITUT-G.993.2 VDSL2, optional for others) (1-byte)
93//
94// Actual Number Of Bits Per Symbol
Chip Boling610117d2021-09-09 11:24:34 -050095// The LSYMB attribute reports the actual number of bits per symbol assigned to the latency path in
96// which the bearer channel is transported, excluding trellis overhead. Its value is coded in bits
97// in the range 0..65535. (R) (mandatory for ITUT-G.993.2 VDSL2, optional for others) (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060098//
99// Actual Interleaving Depth
Chip Boling610117d2021-09-09 11:24:34 -0500100// The INTLVDEPTH attribute reports the actual depth of the interleaver used in the latency path in
101// which the bearer channel is transported. Its value ranges from 1..4096 in steps of 1. The value
102// 1 indicates no interleaving. (R) (mandatory for ITU-T G.993.2 VDSL2, optional for others)
103// (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600104//
105// Actual Interleaving Block Length
Chip Boling610117d2021-09-09 11:24:34 -0500106// The INTLVBLOCK attribute reports the actual block length of the interleaver used in the latency
107// part in which the bearer channel is transported. Its value ranges from 4..255 in steps of 1. (R)
108// (mandatory forITU-T G.993.2 VDSL2, optional for others) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600109//
110// Actual Latency Path
Chip Boling610117d2021-09-09 11:24:34 -0500111// The LPATH attribute reports the index of the actual latency path in which the bearer channel is
112// transported. Valid values are 0..3. In [ITUT-G.992.1], the fast path is mapped to latency index
113// 0; the interleaved path to index 1. (R) (mandatory for ITU-T G.993.2 VDSL2, optional for others)
114// (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -0600115//
116type XdslChannelUpstreamStatusData struct {
117 ManagedEntityDefinition
118 Attributes AttributeValueMap
119}
120
121func init() {
122 xdslchannelupstreamstatusdataBME = &ManagedEntityDefinition{
123 Name: "XdslChannelUpstreamStatusData",
124 ClassID: 103,
125 MessageTypes: mapset.NewSetWith(
126 Get,
127 ),
128 AllowedAttributeMask: 0xffe0,
129 AttributeDefinitions: AttributeDefinitionMap{
130 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
131 1: ByteField("ActualInterleavingDelay", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
132 2: Uint32Field("ActualDataRate", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, false, false, 2),
133 3: Uint32Field("PreviousDataRate", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
134 4: ByteField("ActualImpulseNoiseProtection", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
135 5: ByteField("ImpulseNoiseProtectionReportingMode", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
136 6: ByteField("ActualSizeOfReedSolomonCodeword", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
137 7: ByteField("ActualNumberOfReedSolomonRedundancyBytes", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
138 8: Uint16Field("ActualNumberOfBitsPerSymbol", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
139 9: Uint16Field("ActualInterleavingDepth", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9),
140 10: ByteField("ActualInterleavingBlockLength", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10),
141 11: ByteField("ActualLatencyPath", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11),
142 },
143 Access: CreatedByOnu,
144 Support: UnknownSupport,
145 }
146}
147
148// NewXdslChannelUpstreamStatusData (class ID 103) creates the basic
149// Managed Entity definition that is used to validate an ME of this type that
150// is received from or transmitted to the OMCC.
151func NewXdslChannelUpstreamStatusData(params ...ParamData) (*ManagedEntity, OmciErrors) {
152 return NewManagedEntity(*xdslchannelupstreamstatusdataBME, params...)
153}