Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net) |
| 3 | * Copyright 2020-present Open Networking Foundation |
| 4 | |
| 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 |
| 8 | |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | |
| 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 | // EnhancedTcPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI |
| 29 | // Managed entity Enhanced TC performance monitoring history data |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 30 | const EnhancedTcPerformanceMonitoringHistoryDataClassID = ClassID(454) // 0x01c6 |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 31 | |
| 32 | var enhancedtcperformancemonitoringhistorydataBME *ManagedEntityDefinition |
| 33 | |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 34 | // EnhancedTcPerformanceMonitoringHistoryData (Class ID: #454 / 0x01c6) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 35 | // This ME collects PM data associated with the XGS-PON and subsequent ITU-T PON systems' TC layer. |
| 36 | // |
| 37 | // For a complete discussion of generic PM architecture, refer to clause I.4. |
| 38 | // |
| 39 | // Relationships |
| 40 | // An instance of this ME is associated with an ANI-G. |
| 41 | // |
| 42 | // Attributes |
| 43 | // Managed Entity Id |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 44 | // This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is |
| 45 | // implicitly linked to an instance of the ANI-G. (R, set-by-create) (mandatory) (2-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 46 | // |
| 47 | // Interval End Time |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 48 | // This attribute identifies the most recently finished 15-min interval. (R) (mandatory) (1-byte) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 49 | // |
| 50 | // Threshold Data 64 Bit Id |
| 51 | // Threshold data 64-bit ID: This attribute points to an instance of the threshold data 64-bit ME |
| 52 | // that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes) |
| 53 | // |
| 54 | // Psbd Hec Error Count |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 55 | // This attribute counts HEC errors in any of the fields of the downstream physical sync block. (R) |
| 56 | // (optional) (4-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 57 | // |
| 58 | // Xgtc Hec Error Count |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 59 | // This attribute counts HEC errors detected in the XGTC header. In [ITU-T G.9807.1], this |
| 60 | // attribute is used for FS HEC error count management. (R) (optional) (4-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 61 | // |
| 62 | // Unknown Profile Count |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 63 | // This attribute counts the number of grants received whose specified profile was not known to the |
| 64 | // ONU. (R) (optional) (4-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 65 | // |
| 66 | // Transmitted Xgem Frames |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 67 | // This attribute counts the number of non-idle XGEM frames transmitted. If an SDU is fragmented, |
| 68 | // each fragment is an XGEM frame and is counted as such. (R) (mandatory) (8 bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 69 | // |
| 70 | // Fragment Xgem Frames |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 71 | // This attribute counts the number of XGEM frames that represent fragmented SDUs, as indicated by |
| 72 | // the LF bit = 0. (R) (optional) (8-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 73 | // |
| 74 | // Xgem Hec Lost Words Count |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 75 | // This attribute counts the number of 4-byte words lost because of an XGEM frame HEC error. In |
| 76 | // general, all XGTC payload following the error is lost, until the next PSBd event. (R) (optional) |
| 77 | // (8 bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 78 | // |
| 79 | // Xgem Key Errors |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 80 | // This attribute counts the number of downstream XGEM frames received with an invalid key |
| 81 | // specification. The key may be invalid for several reasons, among which are: |
| 82 | // |
| 83 | // a) GEM port provisioned for clear text and key index not equal to 00; |
| 84 | // |
| 85 | // b) no multicast key of the specified key index has been provided via the OMCI for a multicast |
| 86 | // GEM port; |
| 87 | // |
| 88 | // c) no unicast key of the specified key index has been successfully negotiated (see clause 15.5 |
| 89 | // of [ITU-T G.987.3] or clause C.15.5 of [ITU-T G.9807.1] for key negotiation state machine); |
| 90 | // |
| 91 | // d) GEM port specified to be encrypted and key index = 00; |
| 92 | // |
| 93 | // e) key index = 11, a reserved value. |
| 94 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 95 | // (R) (mandatory) (8 bytes) |
| 96 | // |
| 97 | // Xgem Hec Error Count |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 98 | // This attribute counts the number of instances of an XGEM frame HEC error. (R) (mandatory) (8 |
| 99 | // bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 100 | // |
| 101 | // Transmitted Bytes In Non_Idle Xgem Frames |
| 102 | // Transmitted bytes in non-idle XGEM frames: This attribute counts the number of transmitted bytes |
| 103 | // in non-idle XGEM frames. (R) (mandatory) (8 bytes) |
| 104 | // |
| 105 | // Received Bytes In Non_Idle Xgem Frames |
| 106 | // Received bytes in non-idle XGEM frames: This attribute counts the number of received bytes in |
| 107 | // non-idle XGEM frames. (R) (optional) (8 bytes) |
| 108 | // |
| 109 | // Lods Event Count |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 110 | // This attribute counts the number of state transitions from O5.1 to O6. (R) (optional) (4-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 111 | // |
| 112 | // Lods Event Restored Count |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 113 | // This attribute counts the number of LODS cleared events. (R) (optional) (4-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 114 | // |
| 115 | // Onu Reactivation By Lods Events |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 116 | // This attribute counts the number of LODS events resulting in ONU reactivation without |
| 117 | // synchronization being reacquired. (R) (optional) (4-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 118 | // |
| 119 | type EnhancedTcPerformanceMonitoringHistoryData struct { |
| 120 | ManagedEntityDefinition |
| 121 | Attributes AttributeValueMap |
| 122 | } |
| 123 | |
| 124 | func init() { |
| 125 | enhancedtcperformancemonitoringhistorydataBME = &ManagedEntityDefinition{ |
| 126 | Name: "EnhancedTcPerformanceMonitoringHistoryData", |
| 127 | ClassID: 454, |
| 128 | MessageTypes: mapset.NewSetWith( |
| 129 | Create, |
| 130 | Delete, |
| 131 | Get, |
| 132 | Set, |
Girish Gowdra | e268310 | 2021-03-05 08:24:26 -0800 | [diff] [blame] | 133 | GetCurrentData, |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 134 | ), |
| 135 | AllowedAttributeMask: 0xfffe, |
| 136 | AttributeDefinitions: AttributeDefinitionMap{ |
| 137 | 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0), |
| 138 | 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1), |
| 139 | 2: Uint16Field("ThresholdData64BitId", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2), |
| 140 | 3: Uint32Field("PsbdHecErrorCount", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, true, false, 3), |
| 141 | 4: Uint32Field("XgtcHecErrorCount", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, true, false, 4), |
| 142 | 5: Uint32Field("UnknownProfileCount", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, true, false, 5), |
| 143 | 6: Uint64Field("TransmittedXgemFrames", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6), |
| 144 | 7: Uint64Field("FragmentXgemFrames", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, true, false, 7), |
| 145 | 8: Uint64Field("XgemHecLostWordsCount", CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, true, false, 8), |
| 146 | 9: Uint64Field("XgemKeyErrors", CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, false, false, 9), |
| 147 | 10: Uint64Field("XgemHecErrorCount", CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, false, false, 10), |
| 148 | 11: Uint64Field("TransmittedBytesInNonIdleXgemFrames", CounterAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11), |
| 149 | 12: Uint64Field("ReceivedBytesInNonIdleXgemFrames", CounterAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, true, false, 12), |
| 150 | 13: Uint32Field("LodsEventCount", CounterAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, true, false, 13), |
| 151 | 14: Uint32Field("LodsEventRestoredCount", CounterAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, true, false, 14), |
| 152 | 15: Uint32Field("OnuReactivationByLodsEvents", CounterAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, true, false, 15), |
| 153 | }, |
| 154 | Access: CreatedByOlt, |
| 155 | Support: UnknownSupport, |
| 156 | Alarms: AlarmMap{ |
| 157 | 1: "PSBd HEC error count", |
| 158 | 2: "XGTC HEC error count", |
| 159 | 3: "Unknown profile count", |
| 160 | 4: "XGEM HEC loss count", |
| 161 | 5: "XGEM key errors", |
| 162 | 6: "XGEM HEC error count", |
| 163 | }, |
| 164 | } |
| 165 | } |
| 166 | |
| 167 | // NewEnhancedTcPerformanceMonitoringHistoryData (class ID 454) creates the basic |
| 168 | // Managed Entity definition that is used to validate an ME of this type that |
| 169 | // is received from or transmitted to the OMCC. |
| 170 | func NewEnhancedTcPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) { |
| 171 | return NewManagedEntity(*enhancedtcperformancemonitoringhistorydataBME, params...) |
| 172 | } |