blob: e50cc4f01bb9a8454951eea8c5aa0100503c43c5 [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// PhysicalPathTerminationPointLctUniClassID is the 16-bit ID for the OMCI
29// Managed entity Physical path termination point LCT UNI
30const PhysicalPathTerminationPointLctUniClassID ClassID = ClassID(83)
31
32var physicalpathterminationpointlctuniBME *ManagedEntityDefinition
33
34// PhysicalPathTerminationPointLctUni (class ID #83)
35// This ME models debug access to the ONU from any physical or logical port, for example, via a
36// dedicated LCT UNI, via ordinary subscriber UNIs, or via the IP host config ME.
37//
38// The ONU automatically creates an instance of this ME per port:
39//
40// o when the ONU has an LCT port built into its factory configuration;
41//
42// o when a cardholder is provisioned to expect a circuit pack of the LCT type;
43//
44// o when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the LCT
45// type;
46//
47// NOTE - The installation of a plug-and-play card may indicate the presence of LCT ports via
48// equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-mapping
49// package that specifies LCT ports.
50//
51// o when the ONU supports debug access through some other physical or logical means.
52//
53// The ONU automatically deletes an instance of this ME when a cardholder is neither provisioned to
54// expect an LCT circuit pack, nor is it equipped with an LCT circuit pack, or if the ONU is
55// reconfigured in such a way that it no longer supports debug access.
56//
57// LCT instances are not reported during an MIB upload.
58//
59// Relationships
60// An instance of this ME is associated with an instance of a real or virtual circuit pack ME
61// classified as an LCT type. An instance of this ME may also be associated with the ONU as a
62// whole, if the ONU supports debug access through means other than a dedicated physical LCT port.
63//
64// Attributes
65// Managed Entity Id
66// Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
67// number indicates the physical position of the UNI. The first byte is the slot ID (defined in
68// clause 9.1.5). The second byte is the port ID, with the range 1..255. If the LCT UNI is
69// associated with the ONU as a whole, its ME ID should be 0. (R) (mandatory) (2 bytes)
70//
71// Administrative State
72// Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
73// ME. Administrative state is described generically in clause-A.1.6. The LCT has additional
74// administrative state behaviour. When the administrative state is set to lock, debug access
75// through all physical or logical means is blocked, except that the operation of a possible ONU
76// remote debug ME is not affected. Administrative lock of ME instance 0 overrides administrative
77// lock of any other PPTP LCT UNIs that may exist. (R, W) (mandatory) (1-byte)
78//
79type PhysicalPathTerminationPointLctUni struct {
80 ManagedEntityDefinition
81 Attributes AttributeValueMap
82}
83
84func init() {
85 physicalpathterminationpointlctuniBME = &ManagedEntityDefinition{
86 Name: "PhysicalPathTerminationPointLctUni",
87 ClassID: 83,
88 MessageTypes: mapset.NewSetWith(
89 Get,
90 Set,
91 ),
92 AllowedAttributeMask: 0x8000,
93 AttributeDefinitions: AttributeDefinitionMap{
94 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
95 1: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
96 },
97 Access: CreatedByOnu,
98 Support: UnknownSupport,
99 }
100}
101
102// NewPhysicalPathTerminationPointLctUni (class ID 83) creates the basic
103// Managed Entity definition that is used to validate an ME of this type that
104// is received from or transmitted to the OMCC.
105func NewPhysicalPathTerminationPointLctUni(params ...ParamData) (*ManagedEntity, OmciErrors) {
106 return NewManagedEntity(*physicalpathterminationpointlctuniBME, params...)
107}