blob: 462fad6150c8242ca1c5f9152b64f24ef9d9a68f [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 */
Chip Boling34ebcb62021-02-02 12:13:58 -060017/*
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// PhysicalPathTerminationPointReUniClassID is the 16-bit ID for the OMCI
29// Managed entity Physical path termination point RE UNI
30const PhysicalPathTerminationPointReUniClassID ClassID = ClassID(314)
31
32var physicalpathterminationpointreuniBME *ManagedEntityDefinition
33
34// PhysicalPathTerminationPointReUni (class ID #314)
35// This ME represents an S'/R' interface in a mid-span PON RE that supports OEO regeneration in at
36// least one direction, where physical paths terminate and physical path level functions are
37// performed (transmit or receive).
38//
39// Such an RE automatically creates an instance of this ME for each S'/R' interface port as
40// follows.
41//
42// o When the RE has mid-span PON RE UNI interface ports built into its factory configuration.
43//
44// o When a cardholder is provisioned to expect a circuit pack of the mid-span PON RE UNI type.
45//
46// o When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the midspan
47// PON RE UNI type. Note that the installation of a plug-and-play card may indicate the presence of
48// a mid-span PON RE UNI port via equipment ID as well as its type attribute, and indeed may cause
49// the management ONU to instantiate a port-mapping package to specify the ports precisely.
50//
51// The management ONU automatically deletes instances of this ME when a cardholder is neither
52// provisioned to expect a mid-span PON RE UNI circuit pack, nor is it equipped with a mid-span PON
53// RE UNI circuit pack.
54//
55// As illustrated in Figure 8.2.10-3, a PPTP RE UNI may share the physical port with an RE upstream
56// amplifier. The ONU declares a shared configuration through the port-mapping package combined
57// port table, whose structure defines one ME as the master. It is recommended that the PPTP RE UNI
58// be the master, with the RE upstream amplifier as a secondary ME.
59//
60// The administrative state, operational state and ARC attributes of the master ME override similar
61// attributes in secondary MEs associated with the same port. In the secondary ME, these attributes
62// are present, but cause no action when written and have undefined values when read. The RE
63// upstream amplifier should use its provisionable upstream alarm thresholds and should declare
64// upstream alarms as necessary; other isomorphic alarms should be declared by the PPTP RE UNI. The
65// test action should be addressed to the master ME.
66//
67// Relationships
68// An instance of this ME is associated with each instance of a mid-span PON RE S'/R' physical
69// interface of an RE that includes OEO regeneration in either direction, and it may also be
70// associated with an RE upstream amplifier.
71//
72// Attributes
73// Managed Entity Id
74// NOTE 1 - This ME ID may be identical to that of an RE upstream amplifier if it shares the same
75// physical slot and port.
76//
77// Administrative State
78// NOTE 2 - Administrative lock of a PPTP RE UNI results in loss of signal to any downstream ONUs.
79//
80// Operational State
81// Operational state: This attribute indicates whether the ME is capable of performing its
82// function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)
83//
84// Arc
85// ARC: See clause A.1.4.3. (R,-W) (optional) (1-byte)
86//
87// Arc Interval
88// ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)
89//
90// Re Ani_G Pointer
91// RE ANI-G pointer: This attribute points to an RE ANI-G instance. (R,-W) (mandatory) (2-bytes)
92//
93// Total Optical Receive Signal Level Table
94// Total optical receive signal level table: This table attribute reports a series of measurements
95// of time averaged received upstream optical signal power. The measurement circuit should have a
96// temporal response similar to a simple 1-pole low pass filter, with an effective time constant of
97// the order of a GTC frame time. Each table entry has a 2-byte frame counter field (most
98// significant end), and a 2-byte power measurement field. The frame counter field contains the
99// least significant 16-bits of the superframe counter received closest to the time of the
100// measurement. The power measurement field is a 2s complement integer referred to 1-mW (i.e.,
101// dBm), with 0.002-dB granularity. The RE equipment should add entries to this table as frequently
102// as is reasonable. The RE should clear the table once it is read by the OLT. (R) (optional) (4-*
103// N-bytes, where N is the number of measurements present.)
104//
105// Per Burst Receive Signal Level Table
106// Per burst receive signal level table: This table attribute reports the most recent measurement
107// of received burst upstream optical signal power. Each table entry has a 2-byte ONU-ID field
108// (most significant end), and a 2-byte power measurement field. The power measurement field is a
109// 2s complement integer referred to 1-mW (i.e.,-dBm), with 0.002-dB granularity. (R) (optional)
110// (4-* N-bytes, where N is the number of distinct ONUs connected to the S'/R' interface.)
111//
112// Lower Receive Optical Threshold
113// Lower receive optical threshold: This attribute specifies the optical level that the RE uses to
114// declare the burst mode low received optical power alarm. Valid values are -127-dBm (coded as
115// 254) to 0-dBm (coded as 0) in 0.5-dB increments. The default value 0xFF selects the RE's
116// internal policy. (R,-W) (optional) (1-byte)
117//
118// Upper Receive Optical Threshold
119// Upper receive optical threshold: This attribute specifies the optical level that the RE uses to
120// declare the burst mode high optical power alarm. Valid values are -127-dBm (coded as 254) to
121// 0-dBm (coded as 0) in 0.5-dB increments. The default value 0xFF selects the RE's internal
122// policy. (R,-W) (optional) (1-byte)
123//
124// Transmit Optical Level
125// Transmit optical level: This attribute reports the current measurement of the downstream mean
126// optical launch power. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with
127// 0.002-dB granularity. (R) (optional) (2-bytes)
128//
129// Lower Transmit Power Threshold
130// Lower transmit power threshold: This attribute specifies the downstream minimum mean optical
131// launch power at the S'/R' interface that the RE uses to declare the low transmit optical power
132// alarm. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with 0.5-dB
133// granularity. The default value 0x7F selects the RE's internal policy. (R,-W) (optional) (1-byte)
134//
135// Upper Transmit Power Threshold
136// Upper transmit power threshold: This attribute specifies the downstream maximum mean optical
137// launch power at the S'/R' interface that the RE uses to declare the high transmit optical power
138// alarm. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with 0.5-dB
139// granularity. The default value 0x7F selects the RE's internal policy. (R,-W) (optional) (1-byte)
140//
141// A Dditional Preamble
142// Additional preamble: This attribute indicates the number of bytes of PLOu preamble that are
143// unavoidably consumed while passing the RE. (R) (mandatory) (1-byte)
144//
145// A Dditional Guard Time
146// Additional guard time: This attribute indicates the number of bytes of extra guard time that are
147// needed to ensure correct operation with the RE. (R) (mandatory) (1-byte)
148//
149type PhysicalPathTerminationPointReUni struct {
150 ManagedEntityDefinition
151 Attributes AttributeValueMap
152}
153
154func init() {
155 physicalpathterminationpointreuniBME = &ManagedEntityDefinition{
156 Name: "PhysicalPathTerminationPointReUni",
157 ClassID: 314,
158 MessageTypes: mapset.NewSetWith(
159 Get,
160 GetNext,
161 Set,
162 ),
163 AllowedAttributeMask: 0xfffc,
164 AttributeDefinitions: AttributeDefinitionMap{
165 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
166 1: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
167 2: ByteField("OperationalState", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), true, true, false, 2),
168 3: ByteField("Arc", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), true, true, false, 3),
169 4: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4),
170 5: Uint16Field("ReAniGPointer", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, false, false, 5),
171 6: TableField("TotalOpticalReceiveSignalLevelTable", TableAttributeType, 0x0400, TableInfo{nil, 4}, mapset.NewSetWith(Read), false, true, false, 6),
172 7: TableField("PerBurstReceiveSignalLevelTable", TableAttributeType, 0x0200, TableInfo{nil, 4}, mapset.NewSetWith(Read), false, true, false, 7),
173 8: ByteField("LowerReceiveOpticalThreshold", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, true, false, 8),
174 9: ByteField("UpperReceiveOpticalThreshold", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, true, false, 9),
175 10: Uint16Field("TransmitOpticalLevel", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, true, false, 10),
176 11: ByteField("LowerTransmitPowerThreshold", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11),
177 12: ByteField("UpperTransmitPowerThreshold", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12),
178 13: ByteField("ADditionalPreamble", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
179 14: ByteField("ADditionalGuardTime", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
180 },
181 Access: CreatedByOnu,
182 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600183 Alarms: AlarmMap{
184 0: "Low received optical power",
185 1: "High received optical power",
186 2: "Low transmit optical power",
187 3: "High transmit optical power",
188 4: "High laser bias current",
189 5: "S'/R' LOS",
190 },
Chip Boling6e27b352020-02-14 09:10:01 -0600191 }
192}
193
194// NewPhysicalPathTerminationPointReUni (class ID 314) creates the basic
195// Managed Entity definition that is used to validate an ME of this type that
196// is received from or transmitted to the OMCC.
197func NewPhysicalPathTerminationPointReUni(params ...ParamData) (*ManagedEntity, OmciErrors) {
198 return NewManagedEntity(*physicalpathterminationpointreuniBME, params...)
199}