Matteo Scandolo | a6a3aee | 2019-11-26 13:30:14 -0700 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net) |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * Unless required by applicable law or agreed to in writing, software |
| 9 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | * See the License for the specific language governing permissions and |
| 12 | * limitations under the License. |
| 13 | */ |
| 14 | /* |
| 15 | * NOTE: This file was generated, manual edits will be overwritten! |
| 16 | * |
| 17 | * Generated by 'goCodeGenerator.py': |
| 18 | * https://github.com/cboling/OMCI-parser/README.md |
| 19 | */ |
| 20 | package generated |
| 21 | |
| 22 | import "github.com/deckarep/golang-set" |
| 23 | |
| 24 | const XdslChannelConfigurationProfileClassId ClassID = ClassID(107) |
| 25 | |
| 26 | var xdslchannelconfigurationprofileBME *ManagedEntityDefinition |
| 27 | |
| 28 | // XdslChannelConfigurationProfile (class ID #107) |
| 29 | // This ME contains the channel configuration profile for an xDSL UNI. An instance of this ME is |
| 30 | // created and deleted by the OLT. |
| 31 | // |
| 32 | // NOTE – If [ITUT G.997.1] compatibility is required, bit rates should only be set to integer |
| 33 | // multiples of 1000 bits/s. The ONU may reject attempts to set other values for bit rate |
| 34 | // attributes. |
| 35 | // |
| 36 | // Relationships |
| 37 | // An instance of this ME may be associated with zero or more instances of the PPTP xDSL UNI part |
| 38 | // 1. |
| 39 | // |
| 40 | // Attributes |
| 41 | // Managed Entity Id |
| 42 | // Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0 is |
| 43 | // reserved. (R, setbycreate) (mandatory) (2 bytes) |
| 44 | // |
| 45 | // Minimum Data Rate |
| 46 | // Minimum data rate: This parameter specifies the minimum desired net data rate for the bearer |
| 47 | // channel. It is coded in bits per second. (R, W, setbycreate) (mandatory) (4 bytes) |
| 48 | // |
| 49 | // Maximum Data Rate |
| 50 | // Maximum data rate: This parameter specifies the maximum desired net data rate for the bearer |
| 51 | // channel. It is coded in bits per second. (R, W, setbycreate) (mandatory) (4 bytes) |
| 52 | // |
| 53 | // Rate Adaptation Ratio |
| 54 | // Rate adaptation ratio: This attribute specifies the weight that should be taken into account |
| 55 | // when performing rate adaptation in the direction of the bearer channel. The attribute is defined |
| 56 | // as a percentage. The value 20, for example, means that 20% of the available data rate (in excess |
| 57 | // of the minimum data rate summed over all bearer channels) is assigned to this bearer channel and |
| 58 | // 80% to the other bearer channels. The OLT must ensure that the sum of rate adaptation ratios |
| 59 | // over all bearers in one direction is 100%. (R, W, setbycreate) (optional) (1 byte) |
| 60 | // |
| 61 | // Maximum Interleaving Delay |
| 62 | // The delay is coded in milliseconds, varying from 2 to 63, with special meaning assigned to |
| 63 | // values 0, 1 and 255. The value 0 indicates that no delay bound is imposed. The value 1 indicates |
| 64 | // the fast latency path is to be used in the ITUT G.992.1 operating mode and S and D are to be |
| 65 | // selected such that S 1 and D = 1 in ITU-T G.992.2, ITUT G.992.3, ITUT G.992.4, ITUT G.992.5 and |
| 66 | // ITUT G.993.2 operating modes. The value 255 indicates a delay bound of 1 ms in ITUT G.993.2 |
| 67 | // operation. (R, W, setbycreate) (mandatory) (1 byte) |
| 68 | // |
| 69 | // Data Rate Threshold Upshift |
| 70 | // Data rate threshold upshift: This attribute is a threshold on the cumulative data rate upshift |
| 71 | // achieved over one or more bearer channel data rate adaptations. An upshift rate change (DRT up) |
| 72 | // notification is issued by the PPTP xDSL UNI part 1 when the actual data rate exceeds the data |
| 73 | // rate at the last entry into showtime by more than the threshold. The data rate threshold is |
| 74 | // coded in bits per second. (R, W, setbycreate) (mandatory for xDSL standards that use this |
| 75 | // attribute) (4 bytes) |
| 76 | // |
| 77 | // Data Rate Threshold Downshift |
| 78 | // Data rate threshold downshift: This attribute is a threshold on the cumulative data rate |
| 79 | // downshift achieved over one or more bearer channel data rate adaptations. A downshift rate |
| 80 | // change (DRT down) notification is issued by the PPTP xDSL UNI part 1 when the actual data rate |
| 81 | // is below the data rate at the last entry into showtime by more than the threshold. The data rate |
| 82 | // threshold is coded in bits per second. (R, W, setbycreate) (mandatory for xDSL standards that |
| 83 | // use this attribute) (4 bytes) |
| 84 | // |
| 85 | // Minimum Reserved Data Rate |
| 86 | // Minimum reserved data rate: This attribute specifies the desired minimum reserved net data rate |
| 87 | // for the bearer channel. The rate is coded in bits per second. This attribute is needed only if |
| 88 | // the rate adaptation mode is set to dynamic in the xDSL line configuration profile part 1. (R, W, |
| 89 | // setbycreate) (optional) (4 bytes) |
| 90 | // |
| 91 | // Minimum Data Rate In Low _ Power State |
| 92 | // Minimum data rate in low-power state: This parameter specifies the minimum desired net data rate |
| 93 | // for the bearer channel during the low-power state (L1/L2). The power management low-power states |
| 94 | // L1 and L2 are defined in [ITUT G.992.2] and [ITUT G.992.3], respectively. The data rate is coded |
| 95 | // in bits per second. (R, W, setbycreate) (mandatory) (4 byte) |
| 96 | // |
| 97 | // Minimum Impulse Noise Protection |
| 98 | // (R, W, setbycreate) (optional for [ITU-T G.992.1], mandatory for other xDSL standards that use |
| 99 | // this attribute) (1 byte) |
| 100 | // |
| 101 | // Maximum Bit Error Ratio |
| 102 | // (R, W, setbycreate) (mandatory for standards that use this attribute) (1 byte) |
| 103 | // |
| 104 | // Minimum Impulse Noise Protection 8_Khz |
| 105 | // Minimum impulse noise protection 8 kHz: The INPmin8 attribute specifies the minimum INP for the |
| 106 | // bearer channel if it is transported over DMT symbols with a subcarrier spacing of 8.625 kHz. It |
| 107 | // is only valid for [ITUT G.993.2]. INP is expressed in DMT symbols with a subcarrier spacing of |
| 108 | // 8.625 kHz. It can take any integer value from 0 (default) to 16, inclusive. (R, W) (mandatory |
| 109 | // for [ITUT G.993.2]) (1 byte) |
| 110 | // |
| 111 | // Maximum Delay Variation |
| 112 | // Maximum delay variation: The DVMAX attribute specifies the maximum value for delay variation |
| 113 | // allowed in an OLR procedure. Its value ranges from 1 (0.1 ms) to 254 (25.4 ms). The special |
| 114 | // value 255 specifies that no delay variation bound is imposed. (R, W) (optional: used by |
| 115 | // [ITUT G.993.2]) (1 byte) |
| 116 | // |
| 117 | // Channel Initialization Policy Selection |
| 118 | // Channel initialization policy selection: The CIPOLICY attribute specifies the policy to |
| 119 | // determine transceiver configuration at initialization. Valid values are 0..1, as defined in the |
| 120 | // Recommendations that use this attribute. (R, W) (optional) (1 byte) |
| 121 | // |
| 122 | // Minimum Sos Bit Rate Downstream |
| 123 | // Minimum SOS bit rate downstream: The MIN-SOS-BR-ds attribute specifies the minimum net data rate |
| 124 | // required for a valid SOS request in the downstream direction. The value is coded as an unsigned |
| 125 | // integer representing the data rate as a multiple of 8 kbit/s. (R, W) (optional) (4 bytes) |
| 126 | // |
| 127 | // Minimum Sos Bit Rate Upstream |
| 128 | // Minimum SOS bit rate upstream: The MIN-SOS-BR-us attribute specifies the minimum net data rate |
| 129 | // required for a valid SOS request in the upstream direction. The value is coded as an unsigned |
| 130 | // integer representing the data rate as a multiple of 8 kbit/s. (R, W) (optional) (4 bytes) |
| 131 | // |
| 132 | type XdslChannelConfigurationProfile struct { |
| 133 | ManagedEntityDefinition |
| 134 | Attributes AttributeValueMap |
| 135 | } |
| 136 | |
| 137 | func init() { |
| 138 | xdslchannelconfigurationprofileBME = &ManagedEntityDefinition{ |
| 139 | Name: "XdslChannelConfigurationProfile", |
| 140 | ClassID: 107, |
| 141 | MessageTypes: mapset.NewSetWith( |
| 142 | Create, |
| 143 | Delete, |
| 144 | Get, |
| 145 | Set, |
| 146 | ), |
| 147 | AllowedAttributeMask: 0XFFFE, |
| 148 | AttributeDefinitions: AttributeDefinitionMap{ |
| 149 | 0: Uint16Field("ManagedEntityId", 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, false, 0), |
| 150 | 1: Uint32Field("MinimumDataRate", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 1), |
| 151 | 2: Uint32Field("MaximumDataRate", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 2), |
| 152 | 3: ByteField("RateAdaptationRatio", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, true, false, 3), |
| 153 | 4: ByteField("MaximumInterleavingDelay", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 4), |
| 154 | 5: Uint32Field("DataRateThresholdUpshift", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 5), |
| 155 | 6: Uint32Field("DataRateThresholdDownshift", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 6), |
| 156 | 7: Uint32Field("MinimumReservedDataRate", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, true, false, 7), |
| 157 | 8: Uint32Field("MinimumDataRateInLowPowerState", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 8), |
| 158 | 9: ByteField("MinimumImpulseNoiseProtection", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 9), |
| 159 | 10: ByteField("MaximumBitErrorRatio", 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, false, 10), |
| 160 | 11: ByteField("MinimumImpulseNoiseProtection8Khz", 0, mapset.NewSetWith(Read, Write), false, false, false, false, 11), |
| 161 | 12: ByteField("MaximumDelayVariation", 0, mapset.NewSetWith(Read, Write), false, false, false, false, 12), |
| 162 | 13: ByteField("ChannelInitializationPolicySelection", 0, mapset.NewSetWith(Read, Write), false, false, true, false, 13), |
| 163 | 14: Uint32Field("MinimumSosBitRateDownstream", 0, mapset.NewSetWith(Read, Write), false, false, true, false, 14), |
| 164 | 15: Uint32Field("MinimumSosBitRateUpstream", 0, mapset.NewSetWith(Read, Write), false, false, true, false, 15), |
| 165 | }, |
| 166 | } |
| 167 | } |
| 168 | |
| 169 | // NewXdslChannelConfigurationProfile (class ID 107 creates the basic |
| 170 | // Managed Entity definition that is used to validate an ME of this type that |
| 171 | // is received from the wire, about to be sent on the wire. |
| 172 | func NewXdslChannelConfigurationProfile(params ...ParamData) (*ManagedEntity, OmciErrors) { |
| 173 | return NewManagedEntity(xdslchannelconfigurationprofileBME, params...) |
| 174 | } |