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