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 | // CircuitPackClassID is the 16-bit ID for the OMCI |
| 29 | // Managed entity Circuit pack |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 30 | const CircuitPackClassID = ClassID(6) // 0x0006 |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 31 | |
| 32 | var circuitpackBME *ManagedEntityDefinition |
| 33 | |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 34 | // CircuitPack (Class ID: #6 / 0x0006) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 35 | // This ME models a real or virtual circuit pack that is equipped in a real or virtual ONU slot. |
| 36 | // For ONUs with integrated interfaces, this ME may be used to distinguish available types of |
| 37 | // interfaces (the port-mapping package is another way). |
| 38 | // |
| 39 | // For ONUs with integrated interfaces, the ONU automatically creates an instance of this ME for |
| 40 | // each instance of the virtual cardholder ME. The ONU also creates an instance of this ME when the |
| 41 | // OLT provisions the cardholder to expect a circuit pack, i.e., when the OLT sets the expected |
| 42 | // plug-in unit type or equipment ID of the cardholder to a circuit pack type, as defined in Table |
| 43 | // 9.1.5-1. The ONU also creates an instance of this ME when a circuit pack is installed in a |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 44 | // cardholder whose expected plug-in unit type is 255-= plugandplay, and whose equipment ID is not |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 45 | // provisioned. Finally, when the cardholder is provisioned for plug-and-play, an instance of this |
| 46 | // ME can be created at the request of the OLT. |
| 47 | // |
| 48 | // The ONU deletes an instance of this ME when the OLT de-provisions the circuit pack (i.e., when |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 49 | // the OLT sets the expected plug-in unit type or equipment ID of the cardholder to 0-= no LIM). |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 50 | // The ONU also deletes an instance of this ME on request of the OLT if the expected plug-in unit |
| 51 | // type attribute of the corresponding cardholder is equal to 255, plug-and-play, and the expected |
| 52 | // equipment ID is blank (a string of all spaces). ONUs with integrated interfaces do not delete |
| 53 | // circuit pack instances. |
| 54 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 55 | // NOTE - Creation and deletion by the OLT is retained for backward compatibility. |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 56 | // |
| 57 | // Relationships |
| 58 | // An instance of this ME is contained by an instance of the cardholder ME. |
| 59 | // |
| 60 | // Attributes |
| 61 | // Managed Entity Id |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 62 | // This attribute uniquely identifies each instance of this ME. Its value is the same as that of |
| 63 | // the cardholder ME containing this circuit pack instance. (R, setbycreate if applicable) |
| 64 | // (mandatory) (2-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 65 | // |
| 66 | // Type |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 67 | // This attribute identifies the circuit pack type. This attribute is a code as defined in Table |
| 68 | // 9.1.5-1. The value 255 means unknown or undefined, i.e., the inserted circuit pack is not |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 69 | // recognized by the ONU or is not mapped to an entry in Table 9.1.5-1. In the latter case, the |
| 70 | // equipment ID attribute may contain inventory information. Upon autonomous ME instantiation, the |
| 71 | // ONU sets this attribute to 0 or to the type of the circuit pack that is physically present. (R, |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 72 | // setbycreate if applicable) (mandatory) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 73 | // |
| 74 | // Number Of Ports |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 75 | // This attribute is the number of access ports on the circuit pack. If the port-mapping package is |
| 76 | // supported for this circuit pack, this attribute should be set to the total number of ports of |
| 77 | // all types. (R) (optional) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 78 | // |
| 79 | // Serial Number |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 80 | // The serial number is expected to be unique for each circuit pack, at least within the scope of |
| 81 | // the given vendor. Note that the serial number may contain the vendor ID or version number. For |
| 82 | // integrated ONUs, this value is identical to the value of the serial number attribute of the |
| 83 | // ONU-G ME. Upon creation in the absence of a physical circuit pack, this attribute comprises all |
| 84 | // spaces. (R) (mandatory) (8-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 85 | // |
| 86 | // Version |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 87 | // This attribute is a string that identifies the version of the circuit pack as defined by the |
| 88 | // vendor. The value 0 indicates that version information is not available or applicable. For |
| 89 | // integrated ONUs, this value is identical to the value of the version attribute of the ONU-G ME. |
| 90 | // Upon creation in the absence of a physical circuit pack, this attribute comprises all spaces. |
| 91 | // (R) (mandatory) (14-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 92 | // |
| 93 | // Vendor Id |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 94 | // This attribute identifies the vendor of the circuit pack. For ONUs with integrated interfaces, |
| 95 | // this value is identical to the value of the vendor ID attribute of the ONU-G ME. Upon creation |
| 96 | // in the absence of a physical circuit pack, this attribute comprises all spaces. (R) (optional) |
| 97 | // (4-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 98 | // |
| 99 | // Administrative State |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 100 | // This attribute locks (1) and unlocks (0) the functions performed by this ME. Administrative |
| 101 | // state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 102 | // |
| 103 | // Operational State |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 104 | // This attribute indicates whether the circuit pack is capable of performing its function. Valid |
| 105 | // values are enabled (0), disabled (1) and unknown (2). Pending completion of initialization and |
| 106 | // self-test on an installed circuit pack, the ONU sets this attribute to 2. (R) (optional) |
| 107 | // (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 108 | // |
| 109 | // Bridged Or Ip Ind |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 110 | // This attribute specifies whether an Ethernet interface is bridged or derived from an IP router |
| 111 | // function. |
| 112 | // |
| 113 | // 0 Bridged |
| 114 | // |
| 115 | // 1 IP router |
| 116 | // |
| 117 | // 2 Both bridged and IP router functions |
| 118 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 119 | // (R,-W) (optional, only applicable for circuit packs with Ethernet interfaces) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 120 | // |
| 121 | // Equipment Id |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 122 | // This attribute may be used to identify the vendor's specific type of circuit pack. In some |
| 123 | // environments, this attribute may include the CLEI code. Upon ME instantiation, the ONU sets this |
| 124 | // attribute to all spaces or to the equipment ID of the circuit pack that is physically present. |
| 125 | // (R) (optional) (20-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 126 | // |
| 127 | // Card Configuration |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 128 | // This attribute selects the appropriate configuration of configurable circuit packs. Table |
| 129 | // 9.1.5-1 specifies two configurable card types: C-DS1/E1 (code 16), and C-DS1/E1/J1 (code 17). |
| 130 | // Values are indicated below for the allowed card types and configurations. |
| 131 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 132 | // Upon autonomous instantiation, this attribute is set to 0. (R,-W, setbycreate if applicable) |
| 133 | // (mandatory for configurable circuit packs) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 134 | // |
| 135 | // Total T_Cont Buffer Number |
| 136 | // Total T-CONT buffer number: This attribute reports the total number of T-CONT buffers associated |
| 137 | // with the circuit pack. Upon ME instantiation, the ONU sets this attribute to 0 or to the value |
| 138 | // supported by the physical circuit pack. (R) (mandatory for circuit packs that provide a traffic |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 139 | // scheduler function) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 140 | // |
| 141 | // Total Priority Queue Number |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 142 | // This value reports the total number of priority queues associated with the circuit pack. Upon ME |
| 143 | // instantiation, the ONU sets the attribute to 0 or to the value supported by the physical circuit |
| 144 | // pack. (R) (mandatory for circuit packs that provide a traffic scheduler function) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 145 | // |
| 146 | // Total Traffic Scheduler Number |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 147 | // This value reports the total number of traffic schedulers associated with the circuit pack. The |
| 148 | // ONU supports null function, strict priority scheduling and WRR from the priority control, and |
| 149 | // guarantee of minimum rate control points of view. If the circuit pack has no traffic scheduler, |
| 150 | // this attribute should be absent or have the value 0. Upon ME instantiation, the ONU sets the |
| 151 | // attribute to 0 or to the value supported by the physical circuit pack. (R) (mandatory for |
| 152 | // circuit packs that provide a traffic scheduler function) (1-byte) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 153 | // |
| 154 | // Power Shed Override |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 155 | // This attribute allows ports to be excluded from the power shed control defined in clause 9.1.7. |
| 156 | // It is a bit mask that takes port 1 as the MSB; a bit value of 1 marks the corresponding port to |
| 157 | // override the power shed timer. For hardware that cannot shed power per port, this attribute is a |
| 158 | // slot override rather than a port override, with any non-zero port value causing the entire |
| 159 | // circuit pack to override power shedding. (R,-W) (optional) (4-bytes) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 160 | // |
| 161 | type CircuitPack struct { |
| 162 | ManagedEntityDefinition |
| 163 | Attributes AttributeValueMap |
| 164 | } |
| 165 | |
| 166 | func init() { |
| 167 | circuitpackBME = &ManagedEntityDefinition{ |
| 168 | Name: "CircuitPack", |
| 169 | ClassID: 6, |
| 170 | MessageTypes: mapset.NewSetWith( |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 171 | Get, |
| 172 | Set, |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 173 | Create, |
| 174 | Delete, |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 175 | ), |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 176 | AllowedAttributeMask: 0xfffc, |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 177 | AttributeDefinitions: AttributeDefinitionMap{ |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 178 | 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0), |
| 179 | 1: ByteField("Type", EnumerationAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 1), |
| 180 | 2: ByteField("NumberOfPorts", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, true, false, 2), |
| 181 | 3: MultiByteField("SerialNumber", OctetsAttributeType, 0x2000, 8, toOctets("ICAgICAgICA="), mapset.NewSetWith(Read), false, false, false, 3), |
| 182 | 4: MultiByteField("Version", OctetsAttributeType, 0x1000, 14, toOctets("ICAgICAgICAgICAgICA="), mapset.NewSetWith(Read), false, false, false, 4), |
| 183 | 5: MultiByteField("VendorId", StringAttributeType, 0x0800, 4, toOctets("ICAgIA=="), mapset.NewSetWith(Read), false, true, false, 5), |
| 184 | 6: ByteField("AdministrativeState", EnumerationAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, false, false, 6), |
| 185 | 7: ByteField("OperationalState", EnumerationAttributeType, 0x0200, 2, mapset.NewSetWith(Read), true, true, false, 7), |
| 186 | 8: ByteField("BridgedOrIpInd", EnumerationAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, false, false, 8), |
| 187 | 9: MultiByteField("EquipmentId", StringAttributeType, 0x0080, 20, toOctets("ICAgICAgICAgICAgICAgICAgICA="), mapset.NewSetWith(Read), false, true, false, 9), |
| 188 | 10: ByteField("CardConfiguration", EnumerationAttributeType, 0x0040, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 10), |
| 189 | 11: ByteField("TotalTContBufferNumber", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11), |
| 190 | 12: ByteField("TotalPriorityQueueNumber", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12), |
| 191 | 13: ByteField("TotalTrafficSchedulerNumber", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13), |
| 192 | 14: Uint32Field("PowerShedOverride", BitFieldAttributeType, 0x0004, 0, mapset.NewSetWith(Read, Write), false, true, false, 14), |
| 193 | }, |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 194 | Access: CreatedByOnu, |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 195 | Support: UnknownSupport, |
| 196 | Alarms: AlarmMap{ |
| 197 | 0: "Equipment alarm", |
| 198 | 1: "Powering alarm", |
| 199 | 2: "Self-test failure", |
| 200 | 3: "Laser end of life", |
| 201 | 4: "Temperature yellow", |
| 202 | 5: "Temperature red", |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 203 | }, |
| 204 | } |
| 205 | } |
| 206 | |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 207 | // NewCircuitPack (class ID 6) creates the basic |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 208 | // 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] | 209 | // is received from or transmitted to the OMCC. |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 210 | func NewCircuitPack(params ...ParamData) (*ManagedEntity, OmciErrors) { |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 211 | return NewManagedEntity(*circuitpackBME, params...) |
Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame] | 212 | } |