Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 3 | * Copyright 2020-present Open Networking Foundation |
| 4 | |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [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 |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 8 | |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 10 | |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [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 | */ |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 23 | |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 24 | package generated |
| 25 | |
| 26 | import "github.com/deckarep/golang-set" |
| 27 | |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 28 | // ReAniGClassID is the 16-bit ID for the OMCI |
| 29 | // Managed entity RE ANI-G |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 30 | const ReAniGClassID = ClassID(313) // 0x0139 |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 31 | |
| 32 | var reanigBME *ManagedEntityDefinition |
| 33 | |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 34 | // ReAniG (Class ID: #313 / 0x0139) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 35 | // This ME organizes data associated with each R'/S' physical interface of an RE if the RE supports |
| 36 | // OEO regeneration in either direction. The management ONU automatically creates one instance of |
| 37 | // this ME for each R'/S' physical port (uni- or bidirectional) as follows. |
| 38 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 39 | // o When the RE has mid-span PON RE ANI interface ports built into its factory configuration. |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 40 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 41 | // o When a cardholder is provisioned to expect a circuit pack of the mid-span PON RE ANI type. |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 42 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 43 | // o When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the midspan |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 44 | // PON RE ANI type. Note that the installation of a plug-and-play card may indicate the presence of |
| 45 | // a mid-span PON RE ANI port via equipment ID as well as its type attribute, and indeed may cause |
| 46 | // the management ONU to instantiate a port-mapping package to specify the ports precisely. |
| 47 | // |
| 48 | // The management ONU automatically deletes instances of this ME when a cardholder is neither |
| 49 | // provisioned to expect a mid-span PON RE ANI circuit pack, nor is it equipped with a mid-span PON |
| 50 | // RE ANI circuit pack. |
| 51 | // |
| 52 | // As illustrated in Figure 8.2.10-4, an RE ANI-G may share the physical port with an RE downstream |
| 53 | // amplifier. The ONU declares a shared configuration through the port-mapping package combined |
| 54 | // port table, whose structure defines one ME as the master. It is recommended that the RE ANI-G be |
| 55 | // the master, with the RE downstream amplifier as a secondary ME. |
| 56 | // |
| 57 | // The administrative state, operational state and ARC attributes of the master ME override similar |
| 58 | // attributes in secondary MEs associated with the same port. In the secondary ME, these attributes |
| 59 | // are present, but cause no action when written and have undefined values when read. The RE |
| 60 | // downstream amplifier should use its provisionable downstream alarm thresholds and should declare |
| 61 | // downstream alarms as necessary; other isomorphic alarms should be declared by the RE ANI-G. The |
| 62 | // test action should be addressed to the master ME. |
| 63 | // |
| 64 | // Relationships |
| 65 | // An instance of this ME is associated with each R'/S' physical interface of an RE that includes |
| 66 | // OEO regeneration in either direction, and with one or more instances of the PPTP RE UNI. It may |
| 67 | // also be associated with an RE downstream amplifier. |
| 68 | // |
| 69 | // Attributes |
| 70 | // Managed Entity Id |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 71 | // This attribute uniquely identifies each instance of this ME. Its value indicates the physical |
| 72 | // position of the R'/S' interface. The first byte is the slot ID (defined in clause 9.1.5). The |
| 73 | // second byte is the port ID. (R) (mandatory) (2-bytes) |
| 74 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 75 | // NOTE 1 - This ME ID may be identical to that of an RE downstream amplifier if it shares the same |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 76 | // physical slot and port. |
| 77 | // |
| 78 | // Administrative State |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 79 | // This attribute locks (1) and unlocks (0) the functions performed by this ME. Administrative |
| 80 | // state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte) |
| 81 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 82 | // NOTE 2 - When an RE supports multiple PONs, or protected access to a single PON, its primary |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 83 | // ANI-G cannot be completely shut down, due to a loss of the management communications capability. |
| 84 | // Complete blocking of service and removal of power may nevertheless be appropriate for secondary |
| 85 | // RE ANI-Gs. Administrative lock suppresses alarms and notifications for an RE ANI-G, be it either |
| 86 | // primary or secondary. |
| 87 | // |
| 88 | // Operational State |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 89 | // This attribute indicates whether the ME is capable of performing its function. Valid values are |
| 90 | // enabled (0) and disabled (1). (R) (optional) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 91 | // |
| 92 | // Arc |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 93 | // See clause A.1.4.3. (R,-W) (optional) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 94 | // |
| 95 | // Arc Interval |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 96 | // See clause A.1.4.3. (R,-W) (optional) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 97 | // |
| 98 | // Optical Signal Level |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 99 | // This attribute reports the current measurement of total downstream optical power. Its value is a |
| 100 | // 2s complement integer referred to 1-mW (i.e., dBm), with 0.002-dB granularity. (Coding -32768 to |
| 101 | // +32767, where 0x00 = 0-dBm, 0x03e8 = +2-dBm, etc.) (R) (optional) (2-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 102 | // |
| 103 | // Lower Optical Threshold |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 104 | // This attribute specifies the optical level that the RE uses to declare the downstream low |
| 105 | // received optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm (coded as 0) in |
| 106 | // 0.5-dB increments. The default value 0xFF selects the RE's internal policy. (R,-W) (optional) |
| 107 | // (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 108 | // |
| 109 | // Upper Optical Threshold |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 110 | // This attribute specifies the optical level that the RE uses to declare the downstream high |
| 111 | // received optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm (coded as 0) in |
| 112 | // 0.5 dB increments. The default value 0xFF selects the RE's internal policy. (R,-W) (optional) |
| 113 | // (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 114 | // |
| 115 | // Transmit Optical Level |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 116 | // This attribute reports the current measurement of mean optical launch power. Its value is a 2s |
| 117 | // complement integer referred to 1-mW (i.e., dBm), with 0.002-dB granularity. (Coding -32768 to |
| 118 | // +32767, where 0x00 = 0-dBm, 0x03e8 = +2-dBm, etc.) (R) (optional) (2-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 119 | // |
| 120 | // Lower Transmit Power Threshold |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 121 | // This attribute specifies the minimum mean optical launch power that the RE uses to declare the |
| 122 | // low transmit optical power alarm. Its value is a 2s-complement integer referred to 1-mW (i.e., |
| 123 | // dBm), with 0.5-dB granularity. The default value 0x7F selects the RE's internal policy. (R,-W) |
| 124 | // (optional) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 125 | // |
| 126 | // Upper Transmit Power Threshold |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 127 | // This attribute specifies the maximum mean optical launch power that the RE uses to declare the |
| 128 | // high transmit optical power alarm. Its value is a 2s-complement integer referred to 1-mW (i.e., |
| 129 | // dBm), with 0.5-dB granularity. The default value 0x7F selects the RE's internal policy. (R,-W) |
| 130 | // (optional) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 131 | // |
| 132 | // Usage Mode |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 133 | // In a mid-span PON RE, an R'/S' interface may be used as the PON interface for the embedded |
| 134 | // management ONU or the uplink interface for an S'/R' interface. This attribute specifies the |
| 135 | // usage of the R'/S' interface. (R,-W) (mandatory) (1-byte) |
| 136 | // |
| 137 | // 0 Disable |
| 138 | // |
| 139 | // 1 This R'/S' interface is used as the uplink for the embedded management ONU |
| 140 | // |
| 141 | // 2 This R'/S' interface is used as the uplink for one or more PPTP RE UNI(s) |
| 142 | // |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 143 | // 3 This R'/S' interface is used as the uplink for both the embedded management ONU and one or |
| 144 | // more PPTP RE UNI(s) (in a time division fashion). |
| 145 | // |
| 146 | // Target Upstream Frequency |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 147 | // This attribute specifies the frequency of the converted upstream signal on the optical trunk |
| 148 | // line (OTL), in gigahertz. The converted frequency must conform to the frequency plan specified |
| 149 | // in [ITUT G.984.6]. The value 0 means that the upstream signal frequency remains the same as the |
| 150 | // original frequency; no frequency conversion is done. If the RE does not support provisionable |
| 151 | // upstream frequency (wavelength), this attribute should take the fixed value representing the |
| 152 | // RE's capability and the RE should deny attempts to set the value of the attribute. If the RE |
| 153 | // does support provisionable upstream frequency conversion, the default value of this attribute is |
| 154 | // 0. (R, W) (optional) (4 bytes). |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 155 | // |
| 156 | // Target Downstream Frequency |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 157 | // This attribute specifies the frequency of the downstream signal received by the RE on the OTL, |
| 158 | // in gigahertz. The incoming frequency must conform to the frequency plan specified in [ITUT |
| 159 | // G.984.6]. The default value 0 means that the downstream frequency remains the same as its |
| 160 | // original frequency; no frequency conversion is done. If the RE does not support provisionable |
| 161 | // downstream frequency selectivity, this attribute should take the fixed value representing the |
| 162 | // RE's capability, and the RE should deny attempts to set the value of the attribute. If the RE |
| 163 | // does support provisionable downstream frequency selectivity, the default value of this attribute |
| 164 | // is 0. (R, W) (optional) (4 bytes). |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 165 | // |
| 166 | // Upstream Signal Transmission Mode |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 167 | // When true, this Boolean attribute enables conversion from burst mode to continuous mode. The |
| 168 | // default value false specifies burst mode upstream transmission. If the RE does not have the |
| 169 | // ability to convert from burst to continuous mode transmission, it should deny attempts to set |
| 170 | // this attribute to true. (R, W) (optional) (1 byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 171 | // |
| 172 | type ReAniG struct { |
| 173 | ManagedEntityDefinition |
| 174 | Attributes AttributeValueMap |
| 175 | } |
| 176 | |
| 177 | func init() { |
| 178 | reanigBME = &ManagedEntityDefinition{ |
| 179 | Name: "ReAniG", |
| 180 | ClassID: 313, |
| 181 | MessageTypes: mapset.NewSetWith( |
| 182 | Get, |
| 183 | Set, |
| 184 | ), |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 185 | AllowedAttributeMask: 0xfffc, |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 186 | AttributeDefinitions: AttributeDefinitionMap{ |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 187 | 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0), |
| 188 | 1: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1), |
| 189 | 2: ByteField("OperationalState", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), true, true, false, 2), |
| 190 | 3: ByteField("Arc", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), true, true, false, 3), |
| 191 | 4: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4), |
| 192 | 5: Uint16Field("OpticalSignalLevel", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, true, false, 5), |
| 193 | 6: ByteField("LowerOpticalThreshold", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, true, false, 6), |
| 194 | 7: ByteField("UpperOpticalThreshold", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), false, true, false, 7), |
| 195 | 8: Uint16Field("TransmitOpticalLevel", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, true, false, 8), |
| 196 | 9: ByteField("LowerTransmitPowerThreshold", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, true, false, 9), |
| 197 | 10: ByteField("UpperTransmitPowerThreshold", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, true, false, 10), |
| 198 | 11: ByteField("UsageMode", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, false, false, 11), |
| 199 | 12: Uint32Field("TargetUpstreamFrequency", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12), |
| 200 | 13: Uint32Field("TargetDownstreamFrequency", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, Write), false, true, false, 13), |
| 201 | 14: ByteField("UpstreamSignalTransmissionMode", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read, Write), false, true, false, 14), |
| 202 | }, |
| 203 | Access: CreatedByOnu, |
| 204 | Support: UnknownSupport, |
| 205 | Alarms: AlarmMap{ |
| 206 | 0: "Low received optical power", |
| 207 | 1: "High received optical power", |
| 208 | 2: "Low transmit optical power", |
| 209 | 3: "High transmit optical power", |
| 210 | 4: "High laser bias current", |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 211 | }, |
| 212 | } |
| 213 | } |
| 214 | |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 215 | // NewReAniG (class ID 313) creates the basic |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 216 | // Managed Entity definition that is used to validate an ME of this type that |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 217 | // is received from or transmitted to the OMCC. |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 218 | func NewReAniG(params ...ParamData) (*ManagedEntity, OmciErrors) { |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 219 | return NewManagedEntity(*reanigBME, params...) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 220 | } |