Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net) |
| 3 | * Copyright 2020-present Open Networking Foundation |
Elia Battiston | 9bfe110 | 2022-02-03 10:38:03 +0100 | [diff] [blame] | 4 | * |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 5 | * 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 |
Elia Battiston | 9bfe110 | 2022-02-03 10:38:03 +0100 | [diff] [blame] | 8 | * |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
Elia Battiston | 9bfe110 | 2022-02-03 10:38:03 +0100 | [diff] [blame] | 10 | * |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 11 | * 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 | */ |
| 17 | /* |
| 18 | * 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 | |
| 24 | package generated |
| 25 | |
| 26 | import "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 |
| 30 | const PhysicalPathTerminationPointReUniClassID = ClassID(314) // 0x013a |
| 31 | |
| 32 | var physicalpathterminationpointreuniBME *ManagedEntityDefinition |
| 33 | |
| 34 | // PhysicalPathTerminationPointReUni (Class ID: #314 / 0x013a) |
| 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 | // This attribute uniquely identifies each instance of this ME. This 2-byte number indicates the |
| 75 | // physical position of the UNI. The first byte is the slot ID (defined in clause 9.1.5). The |
| 76 | // second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes) |
| 77 | // |
| 78 | // NOTE 1 - This ME ID may be identical to that of an RE upstream amplifier if it shares the same |
| 79 | // physical slot and port. |
| 80 | // |
| 81 | // Administrative State |
| 82 | // This attribute locks (1) and unlocks (0) the functions performed by this ME. Administrative |
| 83 | // state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte) |
| 84 | // |
| 85 | // NOTE 2 - Administrative lock of a PPTP RE UNI results in loss of signal to any downstream ONUs. |
| 86 | // |
| 87 | // Operational State |
| 88 | // This attribute indicates whether the ME is capable of performing its function. Valid values are |
| 89 | // enabled (0) and disabled (1). (R) (optional) (1-byte) |
| 90 | // |
| 91 | // Arc |
| 92 | // See clause A.1.4.3. (R,-W) (optional) (1-byte) |
| 93 | // |
| 94 | // Arc Interval |
| 95 | // See clause A.1.4.3. (R,-W) (optional) (1-byte) |
| 96 | // |
| 97 | // Re Ani_G Pointer |
| 98 | // RE ANI-G pointer: This attribute points to an RE ANI-G instance. (R,-W) (mandatory) (2-bytes) |
| 99 | // |
| 100 | // Total Optical Receive Signal Level Table |
| 101 | // This table attribute reports a series of measurements of time averaged received upstream optical |
| 102 | // signal power. The measurement circuit should have a temporal response similar to a simple 1-pole |
| 103 | // low pass filter, with an effective time constant of the order of a GTC frame time. Each table |
| 104 | // entry has a 2-byte frame counter field (most significant end), and a 2-byte power measurement |
| 105 | // field. The frame counter field contains the least significant 16-bits of the superframe counter |
| 106 | // received closest to the time of the measurement. The power measurement field is a 2s complement |
| 107 | // integer referred to 1-mW (i.e., dBm), with 0.002-dB granularity. (Coding -32768 to +32767, where |
| 108 | // 0x00 = 0-dBm, 0x03e8 = +2-dBm, etc.) The RE equipment should add entries to this table as |
| 109 | // frequently as is reasonable. The RE should clear the table once it is read by the OLT. (R) |
| 110 | // (optional) (4-* N-bytes, where N is the number of measurements present.) |
| 111 | // |
| 112 | // Per Burst Receive Signal Level Table |
| 113 | // This table attribute reports the most recent measurement of received burst upstream optical |
| 114 | // signal power. Each table entry has a 2-byte ONU-ID field (most significant end), and a 2-byte |
| 115 | // power measurement field. The power measurement field is a 2s complement integer referred to 1-mW |
| 116 | // (i.e.,-dBm), with 0.002-dB granularity. (Coding -32768 to +32767, where 0x00 = 0-dBm, 0x03e8 = |
| 117 | // +2-dBm, etc.) (R) (optional) (4-* N-bytes, where N is the number of distinct ONUs connected to |
| 118 | // the S'/R' interface.) |
| 119 | // |
| 120 | // Lower Receive Optical Threshold |
| 121 | // This attribute specifies the optical level that the RE uses to declare the burst mode low |
| 122 | // received optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm (coded as 0) in |
| 123 | // 0.5-dB increments. The default value 0xFF selects the RE's internal policy. (R,-W) (optional) |
| 124 | // (1-byte) |
| 125 | // |
| 126 | // Upper Receive Optical Threshold |
| 127 | // This attribute specifies the optical level that the RE uses to declare the burst mode high |
| 128 | // optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm (coded as 0) in 0.5-dB |
| 129 | // increments. The default value 0xFF selects the RE's internal policy. (R,-W) (optional) (1-byte) |
| 130 | // |
| 131 | // Transmit Optical Level |
| 132 | // This attribute reports the current measurement of the downstream mean optical launch power. Its |
| 133 | // value is a 2s complement integer referred to 1-mW (i.e., dBm), with 0.002-dB granularity. (R) |
| 134 | // (optional) (2-bytes) |
| 135 | // |
| 136 | // Lower Transmit Power Threshold |
| 137 | // This attribute specifies the downstream minimum mean optical launch power at the S'/R' interface |
| 138 | // that the RE uses to declare the low transmit optical power alarm. Its value is a 2s complement |
| 139 | // integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects |
| 140 | // the RE's internal policy. (R,-W) (optional) (1-byte) |
| 141 | // |
| 142 | // Upper Transmit Power Threshold |
| 143 | // This attribute specifies the downstream maximum mean optical launch power at the S'/R' interface |
| 144 | // that the RE uses to declare the high transmit optical power alarm. Its value is a 2s complement |
| 145 | // integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects |
| 146 | // the RE's internal policy. (R,-W) (optional) (1-byte) |
| 147 | // |
| 148 | // Additional Preamble |
| 149 | // This attribute indicates the number of bytes of PLOu preamble that are unavoidably consumed |
| 150 | // while passing the RE. (R) (mandatory) (1-byte) |
| 151 | // |
| 152 | // Additional Guard Time |
| 153 | // This attribute indicates the number of bytes of extra guard time that are needed to ensure |
| 154 | // correct operation with the RE. (R) (mandatory) (1-byte) |
| 155 | // |
| 156 | // Connected Onus Table |
| 157 | // s attribute is used to pass ONU ID information of the connected ONUs per RE UNI. The get, get |
| 158 | // next sequence must be used with this attribute since its size is unspecified. Upon ME |
| 159 | // instantiation, this attribute is an empty list. |
| 160 | // |
| 161 | // Each entry contains: |
| 162 | // |
| 163 | // - ONU ID (2-bytes) |
| 164 | // |
| 165 | // (R) (optional) (2N bytes, where N is the number of-ONUs) |
| 166 | // |
| 167 | // Clear Onu Table |
| 168 | // the attribute is used to notify RE to clear the entire Connected ONUs table by OLT. The OLT must |
| 169 | // insure that the ONU IDs have been retrieved before clearing the table, or loss of data may |
| 170 | // occur. |
| 171 | // |
| 172 | // When the value of the byte is set to 1, the RE clears the entire Connected ONUs table and resets |
| 173 | // the byte to 0. |
| 174 | // |
| 175 | // (W) (optional) (1 byte) |
| 176 | // |
| 177 | type PhysicalPathTerminationPointReUni struct { |
| 178 | ManagedEntityDefinition |
| 179 | Attributes AttributeValueMap |
| 180 | } |
| 181 | |
Elia Battiston | 9bfe110 | 2022-02-03 10:38:03 +0100 | [diff] [blame] | 182 | // Attribute name constants |
| 183 | |
| 184 | const PhysicalPathTerminationPointReUni_AdministrativeState = "AdministrativeState" |
| 185 | const PhysicalPathTerminationPointReUni_OperationalState = "OperationalState" |
| 186 | const PhysicalPathTerminationPointReUni_Arc = "Arc" |
| 187 | const PhysicalPathTerminationPointReUni_ArcInterval = "ArcInterval" |
| 188 | const PhysicalPathTerminationPointReUni_ReAniGPointer = "ReAniGPointer" |
| 189 | const PhysicalPathTerminationPointReUni_TotalOpticalReceiveSignalLevelTable = "TotalOpticalReceiveSignalLevelTable" |
| 190 | const PhysicalPathTerminationPointReUni_PerBurstReceiveSignalLevelTable = "PerBurstReceiveSignalLevelTable" |
| 191 | const PhysicalPathTerminationPointReUni_LowerReceiveOpticalThreshold = "LowerReceiveOpticalThreshold" |
| 192 | const PhysicalPathTerminationPointReUni_UpperReceiveOpticalThreshold = "UpperReceiveOpticalThreshold" |
| 193 | const PhysicalPathTerminationPointReUni_TransmitOpticalLevel = "TransmitOpticalLevel" |
| 194 | const PhysicalPathTerminationPointReUni_LowerTransmitPowerThreshold = "LowerTransmitPowerThreshold" |
| 195 | const PhysicalPathTerminationPointReUni_UpperTransmitPowerThreshold = "UpperTransmitPowerThreshold" |
| 196 | const PhysicalPathTerminationPointReUni_AdditionalPreamble = "AdditionalPreamble" |
| 197 | const PhysicalPathTerminationPointReUni_AdditionalGuardTime = "AdditionalGuardTime" |
| 198 | const PhysicalPathTerminationPointReUni_ConnectedOnusTable = "ConnectedOnusTable" |
| 199 | const PhysicalPathTerminationPointReUni_ClearOnuTable = "ClearOnuTable" |
| 200 | |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 201 | func init() { |
| 202 | physicalpathterminationpointreuniBME = &ManagedEntityDefinition{ |
| 203 | Name: "PhysicalPathTerminationPointReUni", |
Elia Battiston | 9bfe110 | 2022-02-03 10:38:03 +0100 | [diff] [blame] | 204 | ClassID: PhysicalPathTerminationPointReUniClassID, |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 205 | MessageTypes: mapset.NewSetWith( |
| 206 | Get, |
| 207 | GetNext, |
| 208 | Set, |
| 209 | ), |
| 210 | AllowedAttributeMask: 0xffff, |
| 211 | AttributeDefinitions: AttributeDefinitionMap{ |
Elia Battiston | 9bfe110 | 2022-02-03 10:38:03 +0100 | [diff] [blame] | 212 | 0: Uint16Field(ManagedEntityID, PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0), |
| 213 | 1: ByteField(PhysicalPathTerminationPointReUni_AdministrativeState, UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1), |
| 214 | 2: ByteField(PhysicalPathTerminationPointReUni_OperationalState, UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), true, true, false, 2), |
| 215 | 3: ByteField(PhysicalPathTerminationPointReUni_Arc, UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), true, true, false, 3), |
| 216 | 4: ByteField(PhysicalPathTerminationPointReUni_ArcInterval, UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4), |
| 217 | 5: Uint16Field(PhysicalPathTerminationPointReUni_ReAniGPointer, UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, false, false, 5), |
| 218 | 6: TableField(PhysicalPathTerminationPointReUni_TotalOpticalReceiveSignalLevelTable, TableAttributeType, 0x0400, TableInfo{nil, 4}, mapset.NewSetWith(Read), false, true, false, 6), |
| 219 | 7: TableField(PhysicalPathTerminationPointReUni_PerBurstReceiveSignalLevelTable, TableAttributeType, 0x0200, TableInfo{nil, 4}, mapset.NewSetWith(Read), false, true, false, 7), |
| 220 | 8: ByteField(PhysicalPathTerminationPointReUni_LowerReceiveOpticalThreshold, UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, true, false, 8), |
| 221 | 9: ByteField(PhysicalPathTerminationPointReUni_UpperReceiveOpticalThreshold, UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, true, false, 9), |
| 222 | 10: Uint16Field(PhysicalPathTerminationPointReUni_TransmitOpticalLevel, UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, true, false, 10), |
| 223 | 11: ByteField(PhysicalPathTerminationPointReUni_LowerTransmitPowerThreshold, UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11), |
| 224 | 12: ByteField(PhysicalPathTerminationPointReUni_UpperTransmitPowerThreshold, UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12), |
| 225 | 13: ByteField(PhysicalPathTerminationPointReUni_AdditionalPreamble, UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13), |
| 226 | 14: ByteField(PhysicalPathTerminationPointReUni_AdditionalGuardTime, UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14), |
| 227 | 15: TableField(PhysicalPathTerminationPointReUni_ConnectedOnusTable, TableAttributeType, 0x0002, TableInfo{nil, 2}, mapset.NewSetWith(Read), false, true, false, 15), |
| 228 | 16: TableField(PhysicalPathTerminationPointReUni_ClearOnuTable, TableAttributeType, 0x0001, TableInfo{nil, 1}, mapset.NewSetWith(Write), false, true, false, 16), |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 229 | }, |
| 230 | Access: CreatedByOnu, |
| 231 | Support: UnknownSupport, |
| 232 | Alarms: AlarmMap{ |
| 233 | 0: "Low received optical power", |
| 234 | 1: "High received optical power", |
| 235 | 2: "Low transmit optical power", |
| 236 | 3: "High transmit optical power", |
| 237 | 4: "High laser bias current", |
| 238 | 5: "S'/R' LOS", |
| 239 | }, |
| 240 | } |
| 241 | } |
| 242 | |
| 243 | // NewPhysicalPathTerminationPointReUni (class ID 314) creates the basic |
| 244 | // Managed Entity definition that is used to validate an ME of this type that |
| 245 | // is received from or transmitted to the OMCC. |
| 246 | func NewPhysicalPathTerminationPointReUni(params ...ParamData) (*ManagedEntity, OmciErrors) { |
| 247 | return NewManagedEntity(*physicalpathterminationpointreuniBME, params...) |
| 248 | } |