Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 1 | /* |
| 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 | */ |
Girish Gowdra | 161d27a | 2021-05-05 12:01:44 -0700 | [diff] [blame] | 17 | /* |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 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 | |
| 24 | package generated |
| 25 | |
| 26 | import "github.com/deckarep/golang-set" |
| 27 | |
| 28 | // Ieee8021PMapperServiceProfileClassID is the 16-bit ID for the OMCI |
| 29 | // Managed entity IEEE 802.1p mapper service profile |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 30 | const Ieee8021PMapperServiceProfileClassID = ClassID(130) // 0x0082 |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 31 | |
| 32 | var ieee8021pmapperserviceprofileBME *ManagedEntityDefinition |
| 33 | |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 34 | // Ieee8021PMapperServiceProfile (Class ID: #130 / 0x0082) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 35 | // This ME associates the priorities of IEEE 802.1p [IEEE 802.1D] priority tagged frames with |
| 36 | // specific connections. This ME directs upstream traffic to the designated GEM ports. Downstream |
| 37 | // traffic arriving on any of the IEEE 802.1p mapper's GEM ports is directed to the mapper's root |
| 38 | // TP. Other mechanisms exist to direct downstream traffic, specifically a direct pointer to a |
| 39 | // downstream queue from the GEM port network CTP. If such an alternative is used, it should be |
| 40 | // provisioned to be consistent with the flow model of the mapper. |
| 41 | // |
| 42 | // Instances of this ME are created and deleted by the OLT. |
| 43 | // |
| 44 | // Relationships |
| 45 | // At its root, an instance of this ME may be associated with zero or one instance of a PPTP UNI, |
| 46 | // MAC bridge port configuration data, or any type of IW TP ME that carries IEEE 802 traffic. Each |
| 47 | // of its eight branches is associated with zero or one GEM IW TP. |
| 48 | // |
| 49 | // Attributes |
| 50 | // Managed Entity Id |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 51 | // This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory) |
| 52 | // (2-bytes) |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 53 | // |
| 54 | // Tp Pointer |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 55 | // This attribute points to an instance of the associated TP. |
| 56 | // |
| 57 | // If the optional TP type attribute is not supported, the TP pointer indicates bridging mapping |
| 58 | // with the value 0xFFFF; the TP pointer may also point to a PPTP Ethernet UNI. |
| 59 | // |
| 60 | // The TP type value 0 also indicates bridging mapping, and the TP pointer should be set to 0xFFFF. |
| 61 | // |
| 62 | // In all other cases, the TP type is determined by the TP type attribute. |
| 63 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 64 | // (R,-W, setbycreate) (mandatory) (2-bytes) |
| 65 | // |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 66 | // Each of the following eight attributes points to the GEM IW TP associated with the stated P-bit |
| 67 | // value. The null pointer 0xFFFF specifies that frames with the associated priority are to be |
| 68 | // discarded. |
| 69 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 70 | // Interwork Tp Pointer For P_Bit Priority 0 |
| 71 | // Interwork TP pointer for P-bit priority 0: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 72 | // |
| 73 | // Interwork Tp Pointer For P_Bit Priority 1 |
| 74 | // Interwork TP pointer for P-bit priority 1: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 75 | // |
| 76 | // Interwork Tp Pointer For P_Bit Priority 2 |
| 77 | // Interwork TP pointer for P-bit priority 2: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 78 | // |
| 79 | // Interwork Tp Pointer For P_Bit Priority 3 |
| 80 | // Interwork TP pointer for P-bit priority 3: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 81 | // |
| 82 | // Interwork Tp Pointer For P_Bit Priority 4 |
| 83 | // Interwork TP pointer for P-bit priority 4: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 84 | // |
| 85 | // Interwork Tp Pointer For P_Bit Priority 5 |
| 86 | // Interwork TP pointer for P-bit priority 5: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 87 | // |
| 88 | // Interwork Tp Pointer For P_Bit Priority 6 |
| 89 | // Interwork TP pointer for P-bit priority 6: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 90 | // |
| 91 | // Interwork Tp Pointer For P_Bit Priority 7 |
| 92 | // Interwork TP pointer for P-bit priority 7: (R,-W, setbycreate) (mandatory) (2-bytes) |
| 93 | // |
| 94 | // Unmarked Frame Option |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 95 | // This attribute specifies how the ONU should handle untagged Ethernet frames received across the |
| 96 | // associated interface. Although it does not alter the frame in any way, the ONU routes the frame |
| 97 | // as if it were tagged with P bits (PCP field) according to the following code points. |
| 98 | // |
| 99 | // 0 Derive implied PCP field from DSCP bits of received frame |
| 100 | // |
| 101 | // 1 Set implied PCP field to a fixed value specified by the default P-bit assumption attribute |
| 102 | // |
| 103 | // (R,-W, setbycreate) (mandatory) (1-byte) |
| 104 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 105 | // Untagged downstream frames are passed through the mapper transparently. |
| 106 | // |
| 107 | // Dscp To P Bit Mapping |
| 108 | // NOTE - If certain bits in the DSCP field are to be ignored in the mapping process, the attribute |
| 109 | // should be provisioned such that all possible values of those bits produce the same P-bit |
| 110 | // mapping. This can be applied to the case where instead of full DSCP, the operator wishes to |
| 111 | // adopt the priority mechanism based on IP precedence, which needs only the three MSBs of the DSCP |
| 112 | // field. |
| 113 | // |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 114 | // DSCP to P-bit mapping: This attribute is valid when the unmarked frame option attribute is set |
| 115 | // to 0. The DSCP to P-bit attribute can be considered a bit string sequence of 64 3-bit groupings. |
| 116 | // The 64 sequence entries represent the possible values of the 6-bit DSCP field. Each 3-bit |
| 117 | // grouping specifies the P-bit value to which the associated DSCP value should be mapped. The |
| 118 | // unmarked frame is then directed to the GEM IW TP indicated by the interwork TP pointer mappings. |
| 119 | // (R,-W) (mandatory) (24-bytes) |
| 120 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 121 | // Default P Bit Assumption |
| 122 | // Default P-bit assumption: This attribute is valid when the unmarked frame option attribute is |
| 123 | // set to 1. In its LSBs, the default Pbit assumption attribute contains the default PCP field to |
| 124 | // be assumed. The unmodified frame is then directed to the GEM IW TP indicated by the interwork TP |
| 125 | // pointer mappings. (R,-W, setbycreate) (mandatory) (1-byte) |
| 126 | // |
| 127 | // Tp Type |
Andrea Campanella | 10426e2 | 2021-10-15 17:58:04 +0200 | [diff] [blame] | 128 | // This attribute identifies the type of TP associated with the mapper. |
| 129 | // |
| 130 | // 0 Mapper used for bridging-mapping |
| 131 | // |
| 132 | // 1 Mapper directly associated with a PPTP Ethernet UNI |
| 133 | // |
| 134 | // 2 Mapper directly associated with an IP host config data or IPv6 host config data ME |
| 135 | // |
| 136 | // 3 Mapper directly associated with an Ethernet flow termination point |
| 137 | // |
| 138 | // 4 Mapper directly associated with a PPTP xDSL UNI |
| 139 | // |
| 140 | // 5 Reserved |
| 141 | // |
| 142 | // 6 Mapper directly associated with a PPTP MoCA UNI |
| 143 | // |
| 144 | // 7 Mapper directly associated with a virtual Ethernet interface point |
| 145 | // |
| 146 | // 8 Mapper directly associated with an IW VCC termination point |
| 147 | // |
| 148 | // 9 Mapper directly associated with an EFM bonding group |
| 149 | // |
Matteo Scandolo | f9d4341 | 2021-01-12 11:11:34 -0800 | [diff] [blame] | 150 | // (R,-W, setbycreate) (optional) (1-byte) |
| 151 | // |
| 152 | type Ieee8021PMapperServiceProfile struct { |
| 153 | ManagedEntityDefinition |
| 154 | Attributes AttributeValueMap |
| 155 | } |
| 156 | |
| 157 | func init() { |
| 158 | ieee8021pmapperserviceprofileBME = &ManagedEntityDefinition{ |
| 159 | Name: "Ieee8021PMapperServiceProfile", |
| 160 | ClassID: 130, |
| 161 | MessageTypes: mapset.NewSetWith( |
| 162 | Create, |
| 163 | Delete, |
| 164 | Get, |
| 165 | Set, |
| 166 | ), |
| 167 | AllowedAttributeMask: 0xfff8, |
| 168 | AttributeDefinitions: AttributeDefinitionMap{ |
| 169 | 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0), |
| 170 | 1: Uint16Field("TpPointer", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 1), |
| 171 | 2: Uint16Field("InterworkTpPointerForPBitPriority0", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2), |
| 172 | 3: Uint16Field("InterworkTpPointerForPBitPriority1", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 3), |
| 173 | 4: Uint16Field("InterworkTpPointerForPBitPriority2", UnsignedIntegerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 4), |
| 174 | 5: Uint16Field("InterworkTpPointerForPBitPriority3", UnsignedIntegerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 5), |
| 175 | 6: Uint16Field("InterworkTpPointerForPBitPriority4", UnsignedIntegerAttributeType, 0x0400, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 6), |
| 176 | 7: Uint16Field("InterworkTpPointerForPBitPriority5", UnsignedIntegerAttributeType, 0x0200, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 7), |
| 177 | 8: Uint16Field("InterworkTpPointerForPBitPriority6", UnsignedIntegerAttributeType, 0x0100, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 8), |
| 178 | 9: Uint16Field("InterworkTpPointerForPBitPriority7", UnsignedIntegerAttributeType, 0x0080, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 9), |
| 179 | 10: ByteField("UnmarkedFrameOption", UnsignedIntegerAttributeType, 0x0040, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 10), |
| 180 | 11: MultiByteField("DscpToPBitMapping", OctetsAttributeType, 0x0020, 24, toOctets("AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"), mapset.NewSetWith(Read, Write), false, false, false, 11), |
| 181 | 12: ByteField("DefaultPBitAssumption", UnsignedIntegerAttributeType, 0x0010, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 12), |
| 182 | 13: ByteField("TpType", UnsignedIntegerAttributeType, 0x0008, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, true, false, 13), |
| 183 | }, |
| 184 | Access: CreatedByOlt, |
| 185 | Support: UnknownSupport, |
| 186 | } |
| 187 | } |
| 188 | |
| 189 | // NewIeee8021PMapperServiceProfile (class ID 130) creates the basic |
| 190 | // Managed Entity definition that is used to validate an ME of this type that |
| 191 | // is received from or transmitted to the OMCC. |
| 192 | func NewIeee8021PMapperServiceProfile(params ...ParamData) (*ManagedEntity, OmciErrors) { |
| 193 | return NewManagedEntity(*ieee8021pmapperserviceprofileBME, params...) |
| 194 | } |