blob: ae562a02a17ad93f95ac557f5c939f5f1ce03653 [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 */
Andrea Campanella7167ebb2020-02-24 09:56:38 +010017 /*
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// PhysicalPathTerminationPointEthernetUniClassID is the 16-bit ID for the OMCI
29// Managed entity Physical path termination point Ethernet UNI
30const PhysicalPathTerminationPointEthernetUniClassID ClassID = ClassID(11)
31
32var physicalpathterminationpointethernetuniBME *ManagedEntityDefinition
33
34// PhysicalPathTerminationPointEthernetUni (class ID #11)
35// This ME represents the point at an Ethernet UNI where the physical path terminates and Ethernet
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 Ethernet ports built into its factory configuration;
41//
42// o when a cardholder is provisioned to expect a circuit pack of the Ethernet type;
43//
44// o when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the
45// Ethernet type. Note that the installation of a plug-and-play card may indicate the presence of
46// Ethernet ports via equipment ID as well as its type, and indeed may cause the ONU to instantiate
47// a port-mapping package that specifies Ethernet ports.
48//
49// The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
50// expect an Ethernet circuit pack, nor is it equipped with an Ethernet circuit pack.
51//
52// Relationships
53// An instance of this ME is associated with each instance of a pre-provisioned or real Ethernet
54// port.
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// (R) (mandatory if the ONU supports circuit packs with configurable interface types, e.g., 10/100
67// BASE-T card) (1-byte)
68//
69// Auto Detection Configuration
70// Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory for interfaces with
71// autodetection options) (1-byte)
72//
73// Ethernet Loopback Configuration
74// Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)
75//
76// Administrative State
77// Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
78// ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)
79//
80// Operational State
81// Operational state: This attribute indicates whether the ME is capable of performing its
82// function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)
83//
84// Configuration Ind
85// The value 0 indicates that the configuration status is unknown (e.g., Ethernet link is not
86// established or the circuit pack is not yet installed). Upon ME instantiation, the ONU sets this
87// attribute to 0. (R) (mandatory) (1-byte)
88//
89// Max Frame Size
90// Max frame size: This attribute denotes the maximum frame size allowed across this interface.
91// Upon ME instantiation, the ONU sets the attribute to 1518. (R,-W) (mandatory for G-PON, optional
92// for ITU-T G.986 systems) (2 bytes)
93//
94// Dte Or Dce Ind
95// (R,-W) (mandatory) (1-byte)
96//
97// Pause Time
98// Pause time: This attribute allows the PPTP to ask the subscriber terminal to temporarily suspend
99// sending data. Units are in pause quanta (1 pause quantum is 512 bit times of the particular
100// implementation). Values: 0..0xFFFF. Upon ME instantiation, the ONU sets this attribute to 0.
101// (R,-W) (optional) (2-bytes)
102//
103// Bridged Or Ip Ind
104// Upon ME instantiation, the ONU sets this attribute to 2. (R,-W) (optional) (1-byte)
105//
106// Arc
107// ARC: See clause A.1.4.3. (R,-W) (optional) (1-byte)
108//
109// Arc Interval
110// ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)
111//
112// Pppoe Filter
113// PPPoE filter: This attribute controls filtering of PPPoE packets on this Ethernet port. The
114// value 0 allows packets of all types. The value 1 discards everything but PPPoE packets. The
115// default value is 0. (R,-W) (optional) (1-byte)
116//
117// Power Control
118// NOTE - This attribute is the equivalent of the acPSEAdminControl variable defined in clause
119// 30.9.1.2.1 of [IEEE 802.3]. Other variables related to PoE appear in the PoE control ME.
120//
121type PhysicalPathTerminationPointEthernetUni struct {
122 ManagedEntityDefinition
123 Attributes AttributeValueMap
124}
125
126func init() {
127 physicalpathterminationpointethernetuniBME = &ManagedEntityDefinition{
128 Name: "PhysicalPathTerminationPointEthernetUni",
129 ClassID: 11,
130 MessageTypes: mapset.NewSetWith(
131 Get,
132 Set,
133 ),
134 AllowedAttributeMask: 0xfffe,
135 AttributeDefinitions: AttributeDefinitionMap{
136 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
137 1: ByteField("ExpectedType", EnumerationAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
138 2: ByteField("SensedType", EnumerationAttributeType, 0x4000, 0, mapset.NewSetWith(Read), true, false, false, 2),
139 3: ByteField("AutoDetectionConfiguration", EnumerationAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), false, false, false, 3),
140 4: ByteField("EthernetLoopbackConfiguration", EnumerationAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, false, false, 4),
141 5: ByteField("AdministrativeState", EnumerationAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, false, false, 5),
142 6: ByteField("OperationalState", EnumerationAttributeType, 0x0400, 0, mapset.NewSetWith(Read), true, true, false, 6),
143 7: ByteField("ConfigurationInd", EnumerationAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
144 8: Uint16Field("MaxFrameSize", UnsignedIntegerAttributeType, 0x0100, 1518, mapset.NewSetWith(Read, Write), false, false, false, 8),
145 9: ByteField("DteOrDceInd", EnumerationAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, false, false, 9),
146 10: Uint16Field("PauseTime", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, true, false, 10),
147 11: ByteField("BridgedOrIpInd", EnumerationAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11),
148 12: ByteField("Arc", EnumerationAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), true, true, false, 12),
149 13: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, Write), false, true, false, 13),
150 14: ByteField("PppoeFilter", EnumerationAttributeType, 0x0004, 0, mapset.NewSetWith(Read, Write), false, true, false, 14),
151 15: ByteField("PowerControl", EnumerationAttributeType, 0x0002, 0, mapset.NewSetWith(Read, Write), false, true, false, 15),
152 },
153 Access: CreatedByOnu,
154 Support: UnknownSupport,
155 }
156}
157
158// NewPhysicalPathTerminationPointEthernetUni (class ID 11) creates the basic
159// Managed Entity definition that is used to validate an ME of this type that
160// is received from or transmitted to the OMCC.
161func NewPhysicalPathTerminationPointEthernetUni(params ...ParamData) (*ManagedEntity, OmciErrors) {
162 return NewManagedEntity(*physicalpathterminationpointethernetuniBME, params...)
163}