blob: b569180e2455780175fd5046b7451fcdf0196032 [file] [log] [blame]
Matteo Scandolof9d43412021-01-12 11:11:34 -08001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
3 * Copyright 2020-present Open Networking Foundation
4
5 * 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
8
9 * http://www.apache.org/licenses/LICENSE-2.0
10
11 * 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 */
17/*
18 * 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// EfmBondingGroupClassID is the 16-bit ID for the OMCI
29// Managed entity EFM bonding group
Andrea Campanella10426e22021-10-15 17:58:04 +020030const EfmBondingGroupClassID = ClassID(418) // 0x01a2
Matteo Scandolof9d43412021-01-12 11:11:34 -080031
32var efmbondinggroupBME *ManagedEntityDefinition
33
Andrea Campanella10426e22021-10-15 17:58:04 +020034// EfmBondingGroup (Class ID: #418 / 0x01a2)
Matteo Scandolof9d43412021-01-12 11:11:34 -080035// The EFM bonding group represents a group of links that are bonded. In [IEEE 802.3], a bonding
36// group is known as a PAF [physical medium entity (PME) aggregation function] and a link is known
37// as a PME instance of this ME are created and deleted by the OLT.
38//
39// Relationships
40// An instance of this ME may be associated with zero or more instances of an EFM bonding link.
41//
42// Attributes
43// Managed Entity Id
Andrea Campanella10426e22021-10-15 17:58:04 +020044// This attribute uniquely identifies each instance of this ME. The value 0 is reserved. (R,
45// setbycreate) (mandatory) (2-bytes)
Matteo Scandolof9d43412021-01-12 11:11:34 -080046//
47// Group Id
Andrea Campanella10426e22021-10-15 17:58:04 +020048// This attribute is the unique number representing this bonding group. See clause C.3.1.1 of
49// [ITU-T G.998.2]. (R,-W, setbycreate) (mandatory) (6-bytes)
Matteo Scandolof9d43412021-01-12 11:11:34 -080050//
51// Minimum Upstream Group Rate
Andrea Campanella10426e22021-10-15 17:58:04 +020052// This attribute sets the minimum upstream group rate, in bits per second, for this EFM Group.
53// This attribute is used to determine the group US rate low alarm status. The group US rate low
54// alarm means that the aggregate upstream rate of all active links associated with this group is
55// less than the minimum upstream group rate. The default value for this rate is zero. (R,-W)
56// (mandatory, setbycreate) (4-bytes)
Matteo Scandolof9d43412021-01-12 11:11:34 -080057//
58// Minimum Downstream Group Rate
Andrea Campanella10426e22021-10-15 17:58:04 +020059// This attribute sets the minimum downstream group rate, in bits per second, for this EFM Group.
60// This attribute is used to determine the group DS rate low alarm status. The group DS rate low
61// alarm means that the aggregate downstream rate of all active links associated with this group is
62// less than the minimum downstream group rate. The default value for this rate is zero. (R,-W)
63// (mandatory) (4-bytes, setbycreate)
Matteo Scandolof9d43412021-01-12 11:11:34 -080064//
65// Group Alarm Enable
Andrea Campanella10426e22021-10-15 17:58:04 +020066// This bit mapped attribute enables the various group alarms. A bit value of 1 means "enable".
67//
68// Bit Meaning
69//
70// 1 (LSB) Group down
71//
72// 2 Group partial
73//
74// 3 Group US rate low
75//
76// 4 Group DS rate low
77//
78// 5 4x rate ratio
79//
80// 6-8 Reserved
81//
Matteo Scandolof9d43412021-01-12 11:11:34 -080082// (R,-W, setbycreate) (mandatory) (1-byte)
83//
84type EfmBondingGroup struct {
85 ManagedEntityDefinition
86 Attributes AttributeValueMap
87}
88
89func init() {
90 efmbondinggroupBME = &ManagedEntityDefinition{
91 Name: "EfmBondingGroup",
Andrea Campanella10426e22021-10-15 17:58:04 +020092 ClassID: 418,
Matteo Scandolof9d43412021-01-12 11:11:34 -080093 MessageTypes: mapset.NewSetWith(
94 Create,
95 Delete,
96 Get,
97 Set,
98 ),
99 AllowedAttributeMask: 0xf000,
100 AttributeDefinitions: AttributeDefinitionMap{
101 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
102 1: MultiByteField("GroupId", OctetsAttributeType, 0x8000, 6, toOctets("AAAAAAAA"), mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1),
103 2: Uint32Field("MinimumUpstreamGroupRate", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, false, false, 2),
104 3: Uint32Field("MinimumDownstreamGroupRate", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), false, false, false, 3),
105 4: ByteField("GroupAlarmEnable", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 4),
106 },
107 Access: CreatedByOlt,
108 Support: UnknownSupport,
109 Alarms: AlarmMap{
110 0: "Group down",
111 1: "Group partial",
112 2: "Group US rate low",
113 3: "Group DS rate low",
114 4: "4x rate ratio",
115 },
116 }
117}
118
Andrea Campanella10426e22021-10-15 17:58:04 +0200119// NewEfmBondingGroup (class ID 418) creates the basic
Matteo Scandolof9d43412021-01-12 11:11:34 -0800120// Managed Entity definition that is used to validate an ME of this type that
121// is received from or transmitted to the OMCC.
122func NewEfmBondingGroup(params ...ParamData) (*ManagedEntity, OmciErrors) {
123 return NewManagedEntity(*efmbondinggroupBME, params...)
124}