Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [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 | */ |
Himani Chawla | ac1f5ad | 2021-02-04 21:21:54 +0530 | [diff] [blame] | 17 | /* |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 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 | // PhysicalPathTerminationPointXdslUniPart1ClassID is the 16-bit ID for the OMCI |
| 29 | // Managed entity Physical path termination point xDSL UNI part 1 |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 30 | const PhysicalPathTerminationPointXdslUniPart1ClassID = ClassID(98) // 0x0062 |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 31 | |
| 32 | var physicalpathterminationpointxdslunipart1BME *ManagedEntityDefinition |
| 33 | |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 34 | // PhysicalPathTerminationPointXdslUniPart1 (Class ID: #98 / 0x0062) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 35 | // This ME represents the point where physical paths terminate on an xDSL CO modem (xTU-C). The |
| 36 | // xDSL ME family is used for ADSL VDSL2 and FAST services. A legacy family of VDSL MEs remains |
| 37 | // valid for ITUT G.993.1 VDSL, if needed. It is documented in [ITUT G.983.2]. |
| 38 | // |
| 39 | // The ONU automatically creates an instance of this ME per port: |
| 40 | // |
| 41 | // o when the ONU has xDSL ports built into its factory configuration; |
| 42 | // |
| 43 | // o when a cardholder is provisioned to expect a circuit pack of the xDSL type; |
| 44 | // |
| 45 | // o when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the xDSL |
| 46 | // type. Note that the installation of a plug-and-play card may indicate the presence of xDSL ports |
| 47 | // via equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-mapping |
| 48 | // package that specifies xDSL ports. |
| 49 | // |
| 50 | // The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to |
| 51 | // expect an xDSL circuit pack, nor is it equipped with an xDSL circuit pack. |
| 52 | // |
| 53 | // Relationships |
| 54 | // An instance of this ME is associated with each instance of a real or pre-provisioned xDSL port. |
| 55 | // |
| 56 | // Attributes |
| 57 | // Managed Entity Id |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 58 | // This attribute uniquely identifies each instance of this ME. This 2 byte number indicates the |
| 59 | // physical position of the UNI. The six LSBs of the first byte are the slot ID, defined in clause |
| 60 | // 9.1.5. The two MSBs indicate the channel number in some of the implicitly linked MEs, and must |
| 61 | // be 0 in the PPTP itself. This reduces the possible number of physical slots to 64. The second |
| 62 | // byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 63 | // |
| 64 | // Loopback Configuration |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 65 | // This attribute represents the loopback configuration of this physical interface. |
| 66 | // |
| 67 | // 0 No loopback |
| 68 | // |
| 69 | // 1 Loopback2 - a loopback at the ONU towards the OLT. The OLT can execute a physical level |
| 70 | // loopback test after loopback2 is set. |
| 71 | // |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 72 | // Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte) |
| 73 | // |
| 74 | // Administrative State |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 75 | // This attribute locks (1) and unlocks (0) the functions performed by this ME. Administrative |
| 76 | // state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 77 | // |
| 78 | // Operational State |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 79 | // This attribute indicates whether the ME is capable of performing its function. Valid values are |
| 80 | // enabled (0) and disabled (1). (R) (optional) (1-byte) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 81 | // |
| 82 | // Xdsl Line Configuration Profile |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 83 | // This attribute points to an instance of the xDSL line configuration profiles (part 1, 2 and 3) |
| 84 | // MEs, and if necessary, also to VDSL2 line configuration extensions (1 and 2) MEs, also to |
| 85 | // vectoring line configuration extension MEs. Upon ME instantiation, the ONU sets this attribute |
| 86 | // to 0, a null pointer. (R,-W) (mandatory) (2-bytes) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 87 | // |
| 88 | // Xdsl Subcarrier Masking Downstream Profile |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 89 | // This attribute points to an instance of the xDSL subcarrier masking downstream profile ME. Upon |
| 90 | // ME instantiation, the ONU sets this attribute to 0, a null pointer. (R,-W) (mandatory) (2-bytes) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 91 | // |
| 92 | // Xdsl Subcarrier Masking Upstream Profile |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 93 | // This attribute points to an instance of the xDSL subcarrier masking upstream profile ME. Upon ME |
| 94 | // instantiation, the ONU sets this attribute to 0, a null pointer. (R,-W) (mandatory) (2-bytes) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 95 | // |
| 96 | // Xdsl Downstream Power Spectral Density Psd Mask Profile |
| 97 | // xDSL downstream power spectral density (PSD) mask profile: This attribute points to an instance |
| 98 | // of the xDSL PSD mask profile ME that defines downstream parameters. Upon ME instantiation, the |
| 99 | // ONU sets this attribute to 0, a null pointer. (R,-W) (mandatory) (2-bytes) |
| 100 | // |
| 101 | // Xdsl Downstream Rfi Bands Profile |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 102 | // This attribute points to an instance of the xDSL downstream RFI bands profile ME. Upon ME |
| 103 | // instantiation, the ONU sets this attribute to 0, a null pointer. (R,-W) (mandatory) (2-bytes) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 104 | // |
| 105 | // Arc |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 106 | // See clause A.1.4.3. (R,-W) (optional) (1-byte) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 107 | // |
| 108 | // Arc Interval |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 109 | // See clause A.1.4.3. (R,-W) (optional) (1-byte) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 110 | // |
| 111 | // Modem Type |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 112 | // This attribute specifies the modem type. If the hardware cannot support the requested modem |
| 113 | // type, the ONU should deny the provisioning command. For backward compatibility, the attribute is |
| 114 | // optional, with a default of ATM. |
| 115 | // |
| 116 | // 0 undefined |
| 117 | // |
| 118 | // 1 ATM (default) |
| 119 | // |
| 120 | // 2 PTM (Ethernet) |
| 121 | // |
| 122 | // (R,-W) (optional) (1-byte) |
| 123 | // |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 124 | // NOTE - Many newer VDSL2 chip sets support only PTM. The ATM default is retained for backward |
| 125 | // compatibility, but implementers should be aware that the default may need to be overridden by |
| 126 | // provisioning before the xDSL UNI can be brought into service. |
| 127 | // |
| 128 | // Upstream Psd Mask Profile |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 129 | // This attribute points to an instance of the xDSL PSD mask profile that defines upstream |
| 130 | // parameters. Upon ME instantiation, the ONU sets this attribute to 0, a null pointer. (R,-W) |
| 131 | // (optional) (2-bytes) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 132 | // |
| 133 | // Network Specific Extensions Pointer |
mpagenko | 836a1fd | 2021-11-01 16:12:42 +0000 | [diff] [blame^] | 134 | // This attribute points to a network address ME that contains the path and name of a file |
| 135 | // containing network specific parameters for the associated UNI. Upon ME instantiation, the ONU |
| 136 | // sets this attribute to 0xFFFF, a null pointer. (R,-W) (optional) (2-bytes) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 137 | // |
| 138 | type PhysicalPathTerminationPointXdslUniPart1 struct { |
| 139 | ManagedEntityDefinition |
| 140 | Attributes AttributeValueMap |
| 141 | } |
| 142 | |
| 143 | func init() { |
| 144 | physicalpathterminationpointxdslunipart1BME = &ManagedEntityDefinition{ |
| 145 | Name: "PhysicalPathTerminationPointXdslUniPart1", |
| 146 | ClassID: 98, |
| 147 | MessageTypes: mapset.NewSetWith( |
| 148 | Get, |
| 149 | Set, |
| 150 | ), |
| 151 | AllowedAttributeMask: 0xfff8, |
| 152 | AttributeDefinitions: AttributeDefinitionMap{ |
| 153 | 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0), |
| 154 | 1: ByteField("LoopbackConfiguration", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1), |
| 155 | 2: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, false, false, 2), |
| 156 | 3: ByteField("OperationalState", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), true, true, false, 3), |
| 157 | 4: Uint16Field("XdslLineConfigurationProfile", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, false, false, 4), |
| 158 | 5: Uint16Field("XdslSubcarrierMaskingDownstreamProfile", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, false, false, 5), |
| 159 | 6: Uint16Field("XdslSubcarrierMaskingUpstreamProfile", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, false, false, 6), |
| 160 | 7: Uint16Field("XdslDownstreamPowerSpectralDensityPsdMaskProfile", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), false, false, false, 7), |
| 161 | 8: Uint16Field("XdslDownstreamRfiBandsProfile", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, false, false, 8), |
| 162 | 9: ByteField("Arc", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), true, true, false, 9), |
| 163 | 10: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, true, false, 10), |
| 164 | 11: ByteField("ModemType", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11), |
| 165 | 12: Uint16Field("UpstreamPsdMaskProfile", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12), |
| 166 | 13: Uint16Field("NetworkSpecificExtensionsPointer", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, Write), false, true, false, 13), |
| 167 | }, |
| 168 | Access: CreatedByOnu, |
| 169 | Support: UnknownSupport, |
Himani Chawla | ac1f5ad | 2021-02-04 21:21:54 +0530 | [diff] [blame] | 170 | Alarms: AlarmMap{ |
| 171 | 0: "NE LOF", |
| 172 | 1: "NE LOS", |
| 173 | 2: "NE LOL", |
| 174 | 3: "NE LPR", |
| 175 | 4: "Card alm", |
| 176 | 5: "FE LOF", |
| 177 | 6: "FE LOS", |
| 178 | 7: "FE LOL", |
| 179 | 8: "FE LPR", |
| 180 | 9: "DRT up", |
| 181 | 10: "DRT down", |
| 182 | 11: "LINIT", |
| 183 | 12: "LCD", |
| 184 | 13: "NCD", |
| 185 | 14: "LCD-FE", |
| 186 | 15: "NCD-FE", |
| 187 | 16: "File not found", |
| 188 | 17: "OOS", |
| 189 | 18: "OOS-FE", |
| 190 | 19: "LOR", |
| 191 | 20: "LOM", |
| 192 | 21: "LOR-FE", |
| 193 | 22: "LOM-FE", |
| 194 | }, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 195 | } |
| 196 | } |
| 197 | |
| 198 | // NewPhysicalPathTerminationPointXdslUniPart1 (class ID 98) creates the basic |
| 199 | // Managed Entity definition that is used to validate an ME of this type that |
| 200 | // is received from or transmitted to the OMCC. |
| 201 | func NewPhysicalPathTerminationPointXdslUniPart1(params ...ParamData) (*ManagedEntity, OmciErrors) { |
| 202 | return NewManagedEntity(*physicalpathterminationpointxdslunipart1BME, params...) |
| 203 | } |