vendor/github.com/opencord/omci-lib-go/v2/generated/physicalpathterminationpointmocauni.go

/*
 * 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"

// PhysicalPathTerminationPointMocaUniClassID is the 16-bit ID for the OMCI
// Managed entity Physical path termination point MoCA UNI
const PhysicalPathTerminationPointMocaUniClassID = ClassID(162) // 0x00a2

var physicalpathterminationpointmocauniBME *ManagedEntityDefinition

// PhysicalPathTerminationPointMocaUni (Class ID: #162 / 0x00a2)
//	This ME represents an MoCA UNI, where physical paths terminate and physical path level functions
//	are performed.
//
//	The ONU automatically creates an instance of this ME per port as follows.
//
//	o	When the ONU has MoCA ports built into its factory configuration.
//
//	o	When a cardholder is provisioned to expect a circuit pack of the MoCA type.
//
//	o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the MoCA
//	type. Note that the installation of a plug-and-play card may indicate the presence of MoCA ports
//	via equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-mapping
//	package that specifies MoCA ports.
//
//	The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
//	expect an MoCA circuit pack, nor is it equipped with an MoCA circuit pack.
//
//	Relationships
//		An instance of this ME is associated with each real or pre-provisioned MoCA port.
//
//	Attributes
//		Managed Entity Id
//			This attribute uniquely identifies each instance of this ME. This 2-byte number is directly
//			associated with the physical position of the UNI. The first byte is the slot ID (defined in
//			clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)
//
//		Loopback Configuration
//			0	No loopback
//
//			3	Loopback3, loopback of downstream traffic after PHY transceiver, depicted in Figure 9.10.1-1.
//
//			Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (optional) (1-byte)
//
//			This attribute sets the MoCA loopback configuration. Note that normal bridge behaviour may
//			defeat the loopback signal unless broadcast MAC addresses are used.
//
//		Administrative State
//			This attribute locks (1) and unlocks (0) the functions performed by this ME. Administrative
//			state is further described in clause A.1.6. (R,-W) (mandatory) (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)
//
//		Max Frame Size
//			This attribute denotes the maximum frame size allowed across this interface. Upon ME
//			instantiation, the ONU sets this attribute to 1518. (R,-W) (mandatory) (2-bytes)
//
//		Arc
//			See clause A.1.4.3. (R,-W) (optional) (1-byte)
//
//		Arc Interval
//			See clause A.1.4.3. (R,-W) (optional) (1-byte)
//
//		Pppoe Filter
//			This attribute controls filtering of PPPoE packets on this MoCA port. When its value is 1, all
//			packets other than PPPoE packets are discarded. The default 0 accepts packets of all types.
//			(R,-W) (optional) (1-byte)
//
//		Network Status
//			This attribute indicates the networking state of the MoCA interface as follows.
//
//			0	The interface has not joined an MoCA network.
//
//			1	The interface has joined an MoCA network.
//
//			2	The interface has joined an MoCA network and is currently the network coordinator.
//
//			(R) (mandatory) (1-byte)
//
//		Password
//			This attribute specifies the MoCA encryption key. It is an ASCII string of 17 decimal digits.
//			Upon ME instantiation, the ONU sets this attribute to 17 null bytes. (R,-W) (mandatory)
//			(17-bytes)
//
//		Privacy Enabled
//			This attribute activates (1) link-layer security. The default value 0 deactivates it. (R,-W)
//			(mandatory) (1-byte)
//
//		Minimum Bandwidth Alarm Threshold
//			This attribute specifies the minimum desired PHY link bandwidth between two nodes. If the actual
//			bandwidth is lower, an LL alarm is declared. Valid values are 0 to 0x0410 (260-Mbit/s) in
//			0.25-Mbit/s increments. The default value is 0x02D0 (180-Mbit/s). The value 0 disables the
//			threshold. (R,-W) (optional) (2-bytes)
//
//		Frequency Mask
//			This attribute is a bit map of the centre frequencies that the interface is permitted to use,
//			where each bit represents a centre frequency. The LSB (b[1]) corresponds to centre frequency
//			800-MHz. The next significant bit (b[2]) corresponds to centre frequency 825-MHz. The 28th bit
//			(b[28]) corresponds to centre frequency 1500-MHz. The four MSBs are not used. (R,-W) (optional)
//			(4-bytes)
//
//		Rf Channel
//			This attribute reports the frequency to which the MoCA interface is currently tuned, in
//			megahertz. (R) (mandatory) (2-bytes)
//
//		Last Operational Frequency
//			This attribute reports the frequency to which the MoCA interface was tuned when last
//			operational, in megahertz. (R) (mandatory) (2-bytes)
//
type PhysicalPathTerminationPointMocaUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

// Attribute name constants

const PhysicalPathTerminationPointMocaUni_LoopbackConfiguration = "LoopbackConfiguration"
const PhysicalPathTerminationPointMocaUni_AdministrativeState = "AdministrativeState"
const PhysicalPathTerminationPointMocaUni_OperationalState = "OperationalState"
const PhysicalPathTerminationPointMocaUni_MaxFrameSize = "MaxFrameSize"
const PhysicalPathTerminationPointMocaUni_Arc = "Arc"
const PhysicalPathTerminationPointMocaUni_ArcInterval = "ArcInterval"
const PhysicalPathTerminationPointMocaUni_PppoeFilter = "PppoeFilter"
const PhysicalPathTerminationPointMocaUni_NetworkStatus = "NetworkStatus"
const PhysicalPathTerminationPointMocaUni_Password = "Password"
const PhysicalPathTerminationPointMocaUni_PrivacyEnabled = "PrivacyEnabled"
const PhysicalPathTerminationPointMocaUni_MinimumBandwidthAlarmThreshold = "MinimumBandwidthAlarmThreshold"
const PhysicalPathTerminationPointMocaUni_FrequencyMask = "FrequencyMask"
const PhysicalPathTerminationPointMocaUni_RfChannel = "RfChannel"
const PhysicalPathTerminationPointMocaUni_LastOperationalFrequency = "LastOperationalFrequency"

func init() {
	physicalpathterminationpointmocauniBME = &ManagedEntityDefinition{
		Name:    "PhysicalPathTerminationPointMocaUni",
		ClassID: PhysicalPathTerminationPointMocaUniClassID,
		MessageTypes: mapset.NewSetWith(
			Get,
			Set,
		),
		AllowedAttributeMask: 0xfffc,
		AttributeDefinitions: AttributeDefinitionMap{
			0:  Uint16Field(ManagedEntityID, PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
			1:  ByteField(PhysicalPathTerminationPointMocaUni_LoopbackConfiguration, UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, true, false, 1),
			2:  ByteField(PhysicalPathTerminationPointMocaUni_AdministrativeState, UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, false, false, 2),
			3:  ByteField(PhysicalPathTerminationPointMocaUni_OperationalState, UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read), true, true, false, 3),
			4:  Uint16Field(PhysicalPathTerminationPointMocaUni_MaxFrameSize, UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, false, false, 4),
			5:  ByteField(PhysicalPathTerminationPointMocaUni_Arc, UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), true, true, false, 5),
			6:  ByteField(PhysicalPathTerminationPointMocaUni_ArcInterval, UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, true, false, 6),
			7:  ByteField(PhysicalPathTerminationPointMocaUni_PppoeFilter, UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, Write), false, true, false, 7),
			8:  ByteField(PhysicalPathTerminationPointMocaUni_NetworkStatus, UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, false, false, 8),
			9:  MultiByteField(PhysicalPathTerminationPointMocaUni_Password, OctetsAttributeType, 0x0080, 17, toOctets("AAAAAAAAAAAAAAAAAAAAAAA="), mapset.NewSetWith(Read, Write), false, false, false, 9),
			10: ByteField(PhysicalPathTerminationPointMocaUni_PrivacyEnabled, UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, Write), false, false, false, 10),
			11: Uint16Field(PhysicalPathTerminationPointMocaUni_MinimumBandwidthAlarmThreshold, UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read, Write), false, true, false, 11),
			12: Uint32Field(PhysicalPathTerminationPointMocaUni_FrequencyMask, UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, Write), false, true, false, 12),
			13: Uint16Field(PhysicalPathTerminationPointMocaUni_RfChannel, UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
			14: Uint16Field(PhysicalPathTerminationPointMocaUni_LastOperationalFrequency, UnsignedIntegerAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, false, false, 14),
		},
		Access:  CreatedByOnu,
		Support: UnknownSupport,
		Alarms: AlarmMap{
			0: "MoCA LOL",
			1: "MoCA limited link (LL)",
		},
	}
}

// NewPhysicalPathTerminationPointMocaUni (class ID 162) 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 NewPhysicalPathTerminationPointMocaUni(params ...ParamData) (*ManagedEntity, OmciErrors) {
	return NewManagedEntity(*physicalpathterminationpointmocauniBME, params...)
}