blob: dcf75287054b6f1116953895dd1bf83645c2ff83 [file] [log] [blame]
Takahiro Suzuki241c10e2020-12-17 20:17:57 +09001/*
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// CircuitPackClassID is the 16-bit ID for the OMCI
29// Managed entity Circuit pack
30const CircuitPackClassID ClassID = ClassID(6)
31
32var circuitpackBME *ManagedEntityDefinition
33
34// CircuitPack (class ID #6)
35// This ME models a real or virtual circuit pack that is equipped in a real or virtual ONU slot.
36// For ONUs with integrated interfaces, this ME may be used to distinguish available types of
37// interfaces (the port-mapping package is another way).
38//
39// For ONUs with integrated interfaces, the ONU automatically creates an instance of this ME for
40// each instance of the virtual cardholder ME. The ONU also creates an instance of this ME when the
41// OLT provisions the cardholder to expect a circuit pack, i.e., when the OLT sets the expected
42// plug-in unit type or equipment ID of the cardholder to a circuit pack type, as defined in Table
43// 9.1.5-1. The ONU also creates an instance of this ME when a circuit pack is installed in a
44// cardholder whose expected plug-in unit type is 255-= plugandplay, and whose equipment ID is not
45// provisioned. Finally, when the cardholder is provisioned for plug-and-play, an instance of this
46// ME can be created at the request of the OLT.
47//
48// The ONU deletes an instance of this ME when the OLT de-provisions the circuit pack (i.e., when
49// the OLT sets the expected plug-in unit type or equipment ID of the cardholder to 0-= no LIM).
50// The ONU also deletes an instance of this ME on request of the OLT if the expected plug-in unit
51// type attribute of the corresponding cardholder is equal to 255, plug-and-play, and the expected
52// equipment ID is blank (a string of all spaces). ONUs with integrated interfaces do not delete
53// circuit pack instances.
54//
55// NOTE - Creation and deletion by the OLT is retained for backward compatibility.
56//
57// Relationships
58// An instance of this ME is contained by an instance of the cardholder ME.
59//
60// Attributes
61// Managed Entity Id
62// Managed entity ID: This attribute uniquely identifies each instance of this ME. Its value is the
63// same as that of the cardholder ME containing this circuit pack instance. (R, setbycreate if
64// applicable) (mandatory) (2-bytes)
65//
66// Type
67// Type: This attribute identifies the circuit pack type. This attribute is a code as defined in
68// Table 9.1.5-1. The value 255 means unknown or undefined, i.e., the inserted circuit pack is not
69// recognized by the ONU or is not mapped to an entry in Table 9.1.5-1. In the latter case, the
70// equipment ID attribute may contain inventory information. Upon autonomous ME instantiation, the
71// ONU sets this attribute to 0 or to the type of the circuit pack that is physically present. (R,
72// setbycreate if applicable) (mandatory) (1-byte)
73//
74// Number Of Ports
75// Number of ports: This attribute is the number of access ports on the circuit pack. If the port-
76// mapping package is supported for this circuit pack, this attribute should be set to the total
77// number of ports of all types. (R) (optional) (1-byte)
78//
79// Serial Number
80// Serial number: The serial number is expected to be unique for each circuit pack, at least within
81// the scope of the given vendor. Note that the serial number may contain the vendor ID or version
82// number. For integrated ONUs, this value is identical to the value of the serial number attribute
83// of the ONU-G ME. Upon creation in the absence of a physical circuit pack, this attribute
84// comprises all spaces. (R) (mandatory) (8-bytes)
85//
86// Version
87// Version: This attribute is a string that identifies the version of the circuit pack as defined
88// by the vendor. The value 0 indicates that version information is not available or applicable.
89// For integrated ONUs, this value is identical to the value of the version attribute of the ONU-G
90// ME. Upon creation in the absence of a physical circuit pack, this attribute comprises all
91// spaces. (R) (mandatory) (14-bytes)
92//
93// Vendor Id
94// Vendor ID: This attribute identifies the vendor of the circuit pack. For ONUs with integrated
95// interfaces, this value is identical to the value of the vendor ID attribute of the ONU-G ME.
96// Upon creation in the absence of a physical circuit pack, this attribute comprises all spaces.
97// (R) (optional) (4-bytes)
98//
99// Administrative State
100// Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
101// ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)
102//
103// Operational State
104// Operational state: This attribute indicates whether the circuit pack is capable of performing
105// its function. Valid values are enabled (0), disabled (1) and unknown (2). Pending completion of
106// initialization and self-test on an installed circuit pack, the ONU sets this attribute to 2. (R)
107// (optional) (1-byte)
108//
109// Bridged Or Ip Ind
110// (R,-W) (optional, only applicable for circuit packs with Ethernet interfaces) (1-byte)
111//
112// Equipment Id
113// Equipment ID: This attribute may be used to identify the vendor's specific type of circuit pack.
114// In some environments, this attribute may include the CLEI code. Upon ME instantiation, the ONU
115// sets this attribute to all spaces or to the equipment ID of the circuit pack that is physically
116// present. (R) (optional) (20-bytes)
117//
118// Card Configuration
119// Upon autonomous instantiation, this attribute is set to 0. (R,-W, setbycreate if applicable)
120// (mandatory for configurable circuit packs) (1-byte)
121//
122// Total T_Cont Buffer Number
123// Total T-CONT buffer number: This attribute reports the total number of T-CONT buffers associated
124// with the circuit pack. Upon ME instantiation, the ONU sets this attribute to 0 or to the value
125// supported by the physical circuit pack. (R) (mandatory for circuit packs that provide a traffic
126// scheduler function) (1-byte)
127//
128// Total Priority Queue Number
129// Total priority queue number: This value reports the total number of priority queues associated
130// with the circuit pack. Upon ME instantiation, the ONU sets the attribute to 0 or to the value
131// supported by the physical circuit pack. (R) (mandatory for circuit packs that provide a traffic
132// scheduler function) (1-byte)
133//
134// Total Traffic Scheduler Number
135// Total traffic scheduler number: This value reports the total number of traffic schedulers
136// associated with the circuit pack. The ONU supports null function, strict priority scheduling and
137// WRR from the priority control, and guarantee of minimum rate control points of view. If the
138// circuit pack has no traffic scheduler, this attribute should be absent or have the value 0. Upon
139// ME instantiation, the ONU sets the attribute to 0 or to the value supported by the physical
140// circuit pack. (R) (mandatory for circuit packs that provide a traffic scheduler function)
141// (1-byte)
142//
143// Power Shed Override
144// Power shed override: This attribute allows ports to be excluded from the power shed control
145// defined in clause 9.1.7. It is a bit mask that takes port 1 as the MSB; a bit value of 1 marks
146// the corresponding port to override the power shed timer. For hardware that cannot shed power per
147// port, this attribute is a slot override rather than a port override, with any non-zero port
148// value causing the entire circuit pack to override power shedding. (R,-W) (optional) (4-bytes)
149//
150type CircuitPack struct {
151 ManagedEntityDefinition
152 Attributes AttributeValueMap
153}
154
155func init() {
156 circuitpackBME = &ManagedEntityDefinition{
157 Name: "CircuitPack",
158 ClassID: 6,
159 MessageTypes: mapset.NewSetWith(
160 Create,
161 Get,
162 Set,
163 ),
164 AllowedAttributeMask: 0xfffc,
165 AttributeDefinitions: AttributeDefinitionMap{
166 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
167 1: ByteField("Type", EnumerationAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 1),
168 2: ByteField("NumberOfPorts", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read), false, true, false, 2),
169 3: MultiByteField("SerialNumber", OctetsAttributeType, 0x2000, 8, toOctets("ICAgICAgICA="), mapset.NewSetWith(Read), false, false, false, 3),
170 4: MultiByteField("Version", OctetsAttributeType, 0x1000, 14, toOctets("ICAgICAgICAgICAgICA="), mapset.NewSetWith(Read), false, false, false, 4),
171 5: MultiByteField("VendorId", StringAttributeType, 0x0800, 4, toOctets("ICAgIA=="), mapset.NewSetWith(Read), false, true, false, 5),
172 6: ByteField("AdministrativeState", EnumerationAttributeType, 0x0400, 0, mapset.NewSetWith(Read, Write), false, false, false, 6),
173 7: ByteField("OperationalState", EnumerationAttributeType, 0x0200, 2, mapset.NewSetWith(Read), true, true, false, 7),
174 8: ByteField("BridgedOrIpInd", EnumerationAttributeType, 0x0100, 0, mapset.NewSetWith(Read, Write), false, false, false, 8),
175 9: MultiByteField("EquipmentId", StringAttributeType, 0x0080, 20, toOctets("ICAgICAgICAgICAgICAgICAgICA="), mapset.NewSetWith(Read), false, true, false, 9),
176 10: ByteField("CardConfiguration", EnumerationAttributeType, 0x0040, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 10),
177 11: ByteField("TotalTContBufferNumber", UnsignedIntegerAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, false, false, 11),
178 12: ByteField("TotalPriorityQueueNumber", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, false, false, 12),
179 13: ByteField("TotalTrafficSchedulerNumber", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, false, false, 13),
180 14: Uint32Field("PowerShedOverride", BitFieldAttributeType, 0x0004, 0, mapset.NewSetWith(Read, Write), false, true, false, 14),
181 },
182 Access: CreatedByOlt,
183 Support: UnknownSupport,
184 }
185}
186
187// NewCircuitPack (class ID 6) creates the basic
188// Managed Entity definition that is used to validate an ME of this type that
189// is received from or transmitted to the OMCC.
190func NewCircuitPack(params ...ParamData) (*ManagedEntity, OmciErrors) {
191 return NewManagedEntity(*circuitpackBME, params...)
192}