blob: f5406c9b37adc9518087bf40b9e60aa1d1531a3f [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// PseudowireTerminationPointClassID is the 16-bit ID for the OMCI
29// Managed entity Pseudowire termination point
30const PseudowireTerminationPointClassID ClassID = ClassID(282)
31
32var pseudowireterminationpointBME *ManagedEntityDefinition
33
34// PseudowireTerminationPoint (class ID #282)
35// The pseudowire TP supports packetized (rather than TDM) transport of TDM services, transported
36// either directly over Ethernet, over UDP/IP or over MPLS. Instances of this ME are created and
37// deleted by the OLT.
38//
39// Relationships
40// One pseudowire TP ME exists for each distinct TDM service that is mapped to a pseudowire.
41//
42// Attributes
43// Managed Entity Id
44// Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
45// (mandatory) (2-bytes)
46//
47// Underlying Transport
48// (R,-W, setbycreate) (mandatory) (1-byte)
49//
50// Service Type
51// (R,-W, setbycreate) (mandatory) (1-byte)
52//
53// Signalling
54// (R,-W, setbycreate) (mandatory for structured service type) (1-byte)
55//
56// Tdm Uni Pointer
57// TDM UNI pointer: If service type-= structured, this attribute points to a logical N-* 64-kbit/s
58// subport CTP. Otherwise, this attribute points to a PPTP CES UNI. (R,-W, setbycreate) (mandatory)
59// (2-bytes)
60//
61// North_Side Pointer
62// North-side pointer: When the pseudowire service is transported via IP, as indicated by the
63// underlying transport attribute, the northside pointer attribute points to an instance of the
64// TCP/UDP config data ME. When the pseudowire service is transported directly over Ethernet, the
65// north-side pointer attribute is not used - the linkage to the Ethernet flow TP is implicit in
66// the ME IDs. When the pseudowire service is transported over MPLS, the northside pointer
67// attribute points to an instance of the MPLS PW TP. (R, W, setbycreate) (mandatory) (2 bytes)
68//
69// Far_End Ip Info
70// A null pointer is appropriate if the pseudowire is not transported via IP. (R,-W, setbycreate)
71// (mandatory for IP transport) (2-bytes)
72//
73// Payload Size
74// (R,-W, setbycreate) (mandatory for unstructured service) (2-bytes)
75//
76// Payload Encapsulation Delay
77// (R,-W, setbycreate) (mandatory for structured service) (1-byte)
78//
79// Timing Mode
80// (R,-W) (mandatory) (1-byte)
81//
82// Transmit Circuit Id
83// (R,-W) (mandatory for MEF 8 transport) (8-bytes)
84//
85// Expected Circuit Id
86// (R,-W) (optional for MEF 8 transport) (8-bytes)
87//
88// Received Circuit Id
89// Received circuit ID: This attribute indicates the actual ECID(s) received on the payload and
90// signalling channels, respectively. It may be used for diagnostic purposes. (R) (optional for MEF
91// 8 transport) (8-bytes)
92//
93// Exception Policy
94// Exception policy: This attribute points to an instance of the pseudowire maintenance profile ME.
95// If the pointer has its default value 0, the ONU's internal defaults apply. (R,-W) (optional)
96// (2-bytes)
97//
98// Arc
99// ARC: See clause A.1.4.3. (R,-W) (optional) (1-byte)
100//
101// Arc Interval
102// ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)
103//
104type PseudowireTerminationPoint struct {
105 ManagedEntityDefinition
106 Attributes AttributeValueMap
107}
108
109func init() {
110 pseudowireterminationpointBME = &ManagedEntityDefinition{
111 Name: "PseudowireTerminationPoint",
112 ClassID: 282,
113 MessageTypes: mapset.NewSetWith(
114 Create,
115 Delete,
116 Get,
117 Set,
118 ),
119 AllowedAttributeMask: 0xfffe,
120 AttributeDefinitions: AttributeDefinitionMap{
121 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
122 1: ByteField("UnderlyingTransport", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
123 2: ByteField("ServiceType", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
124 3: ByteField("Signalling", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 3),
125 4: Uint16Field("TdmUniPointer", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 4),
126 5: Uint16Field("NorthSidePointer", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 5),
127 6: Uint16Field("FarEndIpInfo", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 6),
128 7: Uint16Field("PayloadSize", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 7),
129 8: ByteField("PayloadEncapsulationDelay", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 8),
130 9: ByteField("TimingMode", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, Write), false, false, false, 9),
131 10: Uint64Field("TransmitCircuitId", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, false, false, 10),
132 11: Uint64Field("ExpectedCircuitId", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, false, false, 11),
133 12: Uint64Field("ReceivedCircuitId", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
134 13: Uint16Field("ExceptionPolicy", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, Write), false, true, false, 13),
135 14: ByteField("Arc", UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read, Write), true, true, false, 14),
136 15: ByteField("ArcInterval", UnsignedIntegerAttributeType, 0x0002, 0, mapset.NewSetWith(Read, Write), false, true, false, 15),
137 },
138 Access: CreatedByOlt,
139 Support: UnknownSupport,
140 }
141}
142
143// NewPseudowireTerminationPoint (class ID 282) creates the basic
144// Managed Entity definition that is used to validate an ME of this type that
145// is received from or transmitted to the OMCC.
146func NewPseudowireTerminationPoint(params ...ParamData) (*ManagedEntity, OmciErrors) {
147 return NewManagedEntity(*pseudowireterminationpointBME, params...)
148}