[VOL-4396] OMCI lib update to be incorporated into ONU adapter, make use of relaxed decoding
Signed-off-by: mpagenko <michael.pagenkopf@adtran.com>
Change-Id: Ic8bc15ae061af8e27d73879f27bb5b80637a8dea
diff --git a/vendor/github.com/opencord/omci-lib-go/v2/generated/multicastgeminterworkingterminationpoint.go b/vendor/github.com/opencord/omci-lib-go/v2/generated/multicastgeminterworkingterminationpoint.go
new file mode 100644
index 0000000..fd85a10
--- /dev/null
+++ b/vendor/github.com/opencord/omci-lib-go/v2/generated/multicastgeminterworkingterminationpoint.go
@@ -0,0 +1,229 @@
+/*
+ * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
+ * Copyright 2020-present Open Networking Foundation
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+
+ * http://www.apache.org/licenses/LICENSE-2.0
+
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * NOTE: This file was generated, manual edits will be overwritten!
+ *
+ * Generated by 'goCodeGenerator.py':
+ * https://github.com/cboling/OMCI-parser/README.md
+ */
+
+package generated
+
+import "github.com/deckarep/golang-set"
+
+// MulticastGemInterworkingTerminationPointClassID is the 16-bit ID for the OMCI
+// Managed entity Multicast GEM interworking termination point
+const MulticastGemInterworkingTerminationPointClassID = ClassID(281) // 0x0119
+
+var multicastgeminterworkingterminationpointBME *ManagedEntityDefinition
+
+// MulticastGemInterworkingTerminationPoint (Class ID: #281 / 0x0119)
+// An instance of this ME represents a point in a G-PON ONU where a multicast service interworks
+// with the GEM layer. At this point, a multicast bit stream is reconstructed from GEM packets.
+//
+// Instances of this ME are created and deleted by the OLT.
+//
+// Multicast interworking GEM modes of operation
+//
+// The default multicast operation of the PON is where all the multicast content streams are
+// carried in one PON layer connection (GEM port). This connection is then specified in the first
+// entry of the IPv4 or IPv6 multicast address table, as the case may be. This single entry also
+// specifies an all-inclusive IP multicast destination address (DA) range (e.g., 224.0.0.0 to
+// 239.255.255.255 in the case of IPv4). The ONU then filters the traffic based on either Ethernet
+// MAC addresses or IP addresses. The associated GEM port network CTP ME specifies the GEM port-ID
+// that supports all multicast connections.
+//
+// In the default multicast operation, all multicast content streams are placed in one PON layer
+// connection (GEM port). The OLT sets up a completely conventional model, a pointer from the
+// multicast GEM IW termination to a GEM port network CTP. The OLT configures the GEM port-ID of
+// the GEM port network CTP into the appropriate multicast address table attribute(s), along with
+// the other table fields that specify the range of IP multicast DAs. The ONU accepts the entire
+// multicast stream through the designated GEM port, then filters the traffic based on either the
+// Ethernet MAC address or IP DA.
+//
+// An optional multicast configuration supports separate multicast streams carried over separate
+// PON layer connections, i.e., on separate GEM ports. This permits the ONU to filter multicast
+// streams at the GEM level, which is efficient in hardware, while ignoring other multicast streams
+// that may be of interest to other ONUs on the PON.
+//
+// After configuring the explicit model for the first multicast GEM port, the OLT supports multiple
+// multicast GEM ports by then configuring additional entries into the multicast address table(s),
+// entries with different GEM port-IDs. The OMCI model is defined such that these ports are
+// implicitly grouped together and served by the single explicit GEM port network CTP. No
+// additional GEM network CTPs need be created or linked for the additional GEM ports.
+//
+// Several multicast GEM IW TPs can exist, each linked to separate bridge ports or mappers to serve
+// different communities of interest in a complex ONU.
+//
+// Discovery of multicast support
+//
+// The OLT uses the multicast GEM IW TP entity as the means to discover the ONU's multicast
+// capability. This entity is mandatory if multicast is supported by the ONU. If the OLT attempts
+// to create this entity on an ONU that does not support multicast, the create command fails. The
+// create or set command also fails if the OLT attempts to exploit optional features that the ONU
+// does not support, e.g., in attempting to write a multicast address table with more than a single
+// entry or to create multiple multicast GEM IW TPs.
+//
+// This ME is defined by a similarity to the unicast GEM IW TP, and a number of its attributes are
+// not meaningful in a multicast context. These attributes are set to 0 and not used, as indicated
+// in the following.
+//
+// Relationships
+// An instance of this ME exists for each occurrence of transformation of GEM packets into a
+// multicast data stream.
+//
+// Attributes
+// Managed Entity Id
+// This attribute uniquely identifies each instance of this ME. The value 0xFFFF is reserved. (R,
+// setbycreate) (mandatory) (2-bytes)
+//
+// Gem Port Network Ctp Connectivity Pointer
+// This attribute points to an instance of the GEM port network CTP that is associated with this
+// multicast GEM IW TP. (R,-W, setbycreate) (mandatory) (2-bytes)
+//
+// Interworking Option
+// 3 Reserved
+//
+// 5 IEEE 802.1p mapper
+//
+// (R,-W, setbycreate) (mandatory) (1-byte)
+//
+// This attribute identifies the type of non-GEM function that is being interworked. The option can
+// be as follows.
+//
+// 0 This value is a "no-op" or "don't care". It should be used when the multicast GEM IW TP is
+// associated with several functions of different types. It can optionally be used in all cases,
+// since the necessary information is available elsewhere. The previous code points are retained
+// for backward compatibility:
+//
+// 1 MAC bridged LAN
+//
+// Service Profile Pointer
+// This attribute is set to 0 and not used. For backward compatibility, it may also be set to point
+// to a MAC bridge service profile or IEEE 802.1p mapper service profile. (R,-W, setbycreate)
+// (mandatory) (2-bytes)
+//
+// Not Used 1
+// This attribute is set to 0 and not used. (R,-W, setbycreate) (mandatory) (2-bytes)
+//
+// Pptp Counter
+// This attribute represents the number of instances of PPTP MEs associated with this instance of
+// the multicast GEM IW TP. This attribute conveys no information that is not available elsewhere;
+// it may be set to 0xFF and not used. (R) (optional) (1-byte)
+//
+// Operational State
+// This attribute indicates whether the ME is capable of performing its function. Valid values are
+// enabled (0) and disabled (1). (R) (optional) (1-byte)
+//
+// Gal Profile Pointer
+// This attribute is set to 0 and not used. For backward compatibility, it may also be set to point
+// to a GAL Ethernet profile. (R,-W, setbycreate) (mandatory) (2-bytes)
+//
+// Not Used 2
+// This attribute is set to 0 and not used. (R,-W, setbycreate) (mandatory) (1-byte)
+//
+// Ipv4 Multicast Address Table
+// This attribute maps IP multicast addresses to PON layer addresses. Each entry contains the
+// following.
+//
+// GEM port-ID 2-bytes
+//
+// Secondary key 2-bytes
+//
+// IP multicast DA range start 4-bytes
+//
+// IP multicast DA range stop 4-bytes
+//
+// The first four bytes of each entry are treated as a key into the list. The secondary key allows
+// the table to contain more than a single range for a given GEM port.
+//
+// A set action to a particular value overwrites any existing entry with the same first four bytes.
+// If the last eight bytes of a set command are all zero, that entry is deleted from the list, as
+// the IP address 0.0.0.0 is not valid.
+//
+// (R,-W) (mandatory) (12N bytes, where N is the number of entries in the list.)
+//
+// Ipv6 Multicast Address Table
+// This attribute maps IPv6 multicast DAs to PON layer addresses. Each entry contains:
+//
+// GEM port-ID 2-bytes
+//
+// Secondary key 2-bytes
+//
+// Least significant bytes,
+//
+// IP multicast DA range start 4-bytes
+//
+// Least significant bytes,
+//
+// IP multicast DA range stop 4-bytes
+//
+// Most significant bytes, IP DA 12-bytes
+//
+// The first four bytes of each entry are treated as a key into the list. The secondary key allows
+// the table to contain more than a single range for a given GEM port.
+//
+// A set action to a particular value overwrites any existing entry with the same first four bytes.
+// If the last 20 bytes of a set command are all zero, that entry is deleted from the list.
+//
+// (R,-W) (optional) (24N bytes, where N is the number of entries in the list.)
+//
+type MulticastGemInterworkingTerminationPoint struct {
+ ManagedEntityDefinition
+ Attributes AttributeValueMap
+}
+
+func init() {
+ multicastgeminterworkingterminationpointBME = &ManagedEntityDefinition{
+ Name: "MulticastGemInterworkingTerminationPoint",
+ ClassID: 281,
+ MessageTypes: mapset.NewSetWith(
+ Create,
+ Delete,
+ Get,
+ GetNext,
+ Set,
+ SetTable,
+ ),
+ AllowedAttributeMask: 0xffc0,
+ AttributeDefinitions: AttributeDefinitionMap{
+ 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
+ 1: Uint16Field("GemPortNetworkCtpConnectivityPointer", PointerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
+ 2: ByteField("InterworkingOption", EnumerationAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
+ 3: Uint16Field("ServiceProfilePointer", PointerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 3),
+ 4: Uint16Field("NotUsed1", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 4),
+ 5: ByteField("PptpCounter", UnsignedIntegerAttributeType, 0x0800, 255, mapset.NewSetWith(Read), false, true, false, 5),
+ 6: ByteField("OperationalState", EnumerationAttributeType, 0x0400, 0, mapset.NewSetWith(Read), true, true, false, 6),
+ 7: Uint16Field("GalProfilePointer", PointerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 7),
+ 8: ByteField("NotUsed2", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 8),
+ 9: TableField("Ipv4MulticastAddressTable", TableAttributeType, 0x0080, TableInfo{nil, 12}, mapset.NewSetWith(Read, Write), false, false, false, 9),
+ 10: TableField("Ipv6MulticastAddressTable", TableAttributeType, 0x0040, TableInfo{nil, 24}, mapset.NewSetWith(Read, Write), false, true, false, 10),
+ },
+ Access: CreatedByOlt,
+ Support: UnknownSupport,
+ Alarms: AlarmMap{
+ 0: "Deprecated",
+ },
+ }
+}
+
+// NewMulticastGemInterworkingTerminationPoint (class ID 281) creates the basic
+// Managed Entity definition that is used to validate an ME of this type that
+// is received from or transmitted to the OMCC.
+func NewMulticastGemInterworkingTerminationPoint(params ...ParamData) (*ManagedEntity, OmciErrors) {
+ return NewManagedEntity(*multicastgeminterworkingterminationpointBME, params...)
+}