blob: cc66a165c35334d42bee68220c5736eb6e8600ae [file] [log] [blame]
Chip Boling6e27b352020-02-14 09:10:01 -06001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
Andrea Campanella7167ebb2020-02-24 09:56:38 +01003 * Copyright 2020-present Open Networking Foundation
4
Chip Boling6e27b352020-02-14 09:10:01 -06005 * 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
Andrea Campanella7167ebb2020-02-24 09:56:38 +01008
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Andrea Campanella7167ebb2020-02-24 09:56:38 +010010
Chip Boling6e27b352020-02-14 09:10:01 -060011 * 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 */
Chip Boling34ebcb62021-02-02 12:13:58 -060017/*
Chip Boling6e27b352020-02-14 09:10:01 -060018 * 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
24package generated
25
26import "github.com/deckarep/golang-set"
27
28// PhysicalPathTerminationPointCesUniClassID is the 16-bit ID for the OMCI
29// Managed entity Physical path termination point CES UNI
30const PhysicalPathTerminationPointCesUniClassID ClassID = ClassID(12)
31
32var physicalpathterminationpointcesuniBME *ManagedEntityDefinition
33
34// PhysicalPathTerminationPointCesUni (class ID #12)
35// This ME represents the point at a CES UNI in the ONU where the physical path terminates and
36// physical level functions are performed.
37//
38// The ONU automatically creates an instance of this ME per port:
39//
40// o when the ONU has CES ports built into its factory configuration;
41//
42// o when a cardholder is provisioned to expect a circuit pack of a CES type;
43//
44// o when a cardholder provisioned for plug-and-play is equipped with a circuit pack of a CES type.
45// Note that the installation of a plug-and-play card may indicate the presence of CES ports via
46// equipment ID as well as its type and indeed may cause the ONU to instantiate a port-mapping
47// package that specifies CES ports.
48//
49// The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
50// expect a CES circuit pack, nor is it equipped with a CES circuit pack.
51//
52// Relationships
53// An instance of this ME is associated with each real or pre-provisioned CES port. It can be
54// linked from a GEM IW TP, a pseudowire TP or a logical N * 64 kbit/s CTP.
55//
56// Attributes
57// Managed Entity Id
58// Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2 byte
59// number indicates the physical position of the UNI. The first byte is the slot ID (defined in
60// clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)
61//
62// Expected Type
63// Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)
64//
65// Sensed Type
66// Sensed type: If the value of expected type is not 0, then the value of sensed type equals the
67// value of expected type. If expected type-= 0, then the value of sensed type is one of the
68// compatible values from Table-9.1.5-1. Upon ME instantiation, the ONU sets this attribute to 0 or
69// to the value that reflects the physically present equipment. (R) (mandatory if the ONU supports
70// circuit packs with configurable interface types, e.g., C1.5/2/6.3) (1-byte)
71//
72// Ces Loopback Configuration
73// Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)
74//
75// Administrative State
76// Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
77// ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)
78//
79// Operational State
80// Operational state: This attribute indicates whether the ME is capable of performing its
81// function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)
82//
83// Framing
84// Upon ME instantiation, the ONU sets this attribute to a value that reflects the vendor's
85// default. (R,-W) (optional) (1-byte)
86//
87// Encoding
88// Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory for DS1 and DS3
89// interfaces) (1-byte)
90//
91// Line Length
92// Line length: This attribute specifies the length of the twisted pair cable from a DS1 physical
93// UNI to the DSX-1 cross-connect point or the length of coaxial cable from a DS3 physical UNI to
94// the DSX-3 cross-connect point. Valid values are given in Table 9.8.1-1. Upon ME instantiation
95// for a DS1 interface, the ONU assigns the value 0 for non-power feed type DS1 and the value 6 for
96// power feed type DS1. Upon ME instantiation for a DS3 interface, the ONU sets this attribute to
97// 0x0F. (R,-W) (optional) (1-byte)
98//
99// Ds1 Mode
100// In the event of conflicting values between this attribute and the (also optional) line length
101// attribute, the line length attribute is taken to be valid. This permits the separation of line
102// build-out (LBO) and power settings from smart jack and FDL behaviour. Upon ME instantiation, the
103// ONU sets this attribute to 0. (R,-W) (optional) (1-byte)
104//
105// Arc
106// ARC: See clause A.1.4.3. (R,-W) (optional) (1-byte)
107//
108// Arc Interval
109// ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)
110//
111// Line Type
112// (R,-W) (mandatory for DS3, E3 and multi-configuration interfaces, not applicable to other
113// interfaces) (1-byte)
114//
115type PhysicalPathTerminationPointCesUni struct {
116 ManagedEntityDefinition
117 Attributes AttributeValueMap
118}
119
120func init() {
121 physicalpathterminationpointcesuniBME = &ManagedEntityDefinition{
122 Name: "PhysicalPathTerminationPointCesUni",
123 ClassID: 12,
124 MessageTypes: mapset.NewSetWith(
125 Get,
126 Set,
127 ),
128 AllowedAttributeMask: 0xfff0,
129 AttributeDefinitions: AttributeDefinitionMap{
130 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
131 1: ByteField("ExpectedType", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
132 2: ByteField("SensedType", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), true, false, false, 2),
133 3: ByteField("CesLoopbackConfiguration", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), true, false, false, 3),
134 4: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, false, false, 4),
135 5: ByteField("OperationalState", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read), true, true, false, 5),
136 6: ByteField("Framing", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, true, false, 6),
137 7: ByteField("Encoding", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), false, false, false, 7),
138 8: ByteField("LineLength", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, true, false, 8),
139 9: ByteField("Ds1Mode", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, true, false, 9),
140 10: ByteField("Arc", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), true, true, false, 10),
141 11: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11),
142 12: ByteField("LineType", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, false, false, 12),
143 },
144 Access: CreatedByOnu,
145 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600146 Alarms: AlarmMap{
147 0: "TF",
148 1: "LOS",
149 2: "LOF",
150 3: "OOF",
151 4: "RAI",
152 5: "1.5 M BAIS",
153 6: "R-INH",
154 7: "6M REC",
155 8: "6M SEND",
156 9: "6M ERR",
157 10: "6M BERR",
158 11: "34M REC",
159 12: "34M AIS",
160 13: "2M REC",
161 14: "2M AIS",
162 15: "1.5M REC",
163 16: "1.5 AIS",
164 17: "INFO0",
165 18: "45M RDI",
166 19: "45M AIS",
167 20: "AIS-CI",
168 21: "DS1 idle",
169 22: "RAI-CI",
170 },
Chip Boling6e27b352020-02-14 09:10:01 -0600171 }
172}
173
174// NewPhysicalPathTerminationPointCesUni (class ID 12) creates the basic
175// Managed Entity definition that is used to validate an ME of this type that
176// is received from or transmitted to the OMCC.
177func NewPhysicalPathTerminationPointCesUni(params ...ParamData) (*ManagedEntity, OmciErrors) {
178 return NewManagedEntity(*physicalpathterminationpointcesuniBME, params...)
179}