Elia Battiston | 4750d3c | 2022-07-14 13:24:56 +0000 | [diff] [blame] | 1 | submodule bbf-xpon-channel-partition-body { |
| 2 | yang-version 1.1; |
| 3 | belongs-to bbf-xpon { |
| 4 | prefix bbf-xpon; |
| 5 | } |
| 6 | |
| 7 | import ietf-interfaces { |
| 8 | prefix if; |
| 9 | } |
| 10 | import bbf-xpon-if-type { |
| 11 | prefix bbf-xponift; |
| 12 | } |
| 13 | import bbf-xpon-types { |
| 14 | prefix bbf-xpon-types; |
| 15 | } |
| 16 | include bbf-xpon-base; |
| 17 | |
| 18 | organization |
| 19 | "Broadband Forum <https://www.broadband-forum.org> |
| 20 | Fiber Access Networks Work Area"; |
| 21 | contact |
| 22 | "Comments or questions about this Broadband Forum YANG module |
| 23 | should be directed to <mailto:help@broadband-forum.org>. |
| 24 | |
| 25 | Editor: Joey Boyd, ADTRAN |
| 26 | |
| 27 | Editor: Samuel Chen, Broadcom |
| 28 | |
| 29 | Editor: Robert Peschi, Nokia |
| 30 | |
| 31 | WA Director: Marta Seda, Calix |
| 32 | |
| 33 | WA Director: Lin Wei, Huawei"; |
| 34 | description |
| 35 | "This submodule contains a collection of YANG definitions for |
| 36 | managing channel partitions. |
| 37 | |
| 38 | Copyright (c) 2018, Broadband Forum |
| 39 | |
| 40 | Redistribution and use in source and binary forms, with or |
| 41 | without modification, are permitted provided that the following |
| 42 | conditions are met: |
| 43 | |
| 44 | 1. Redistributions of source code must retain the above copyright |
| 45 | notice, this list of conditions and the following disclaimer. |
| 46 | |
| 47 | 2. Redistributions in binary form must reproduce the above |
| 48 | copyright notice, this list of conditions and the following |
| 49 | disclaimer in the documentation and/or other materials |
| 50 | provided with the distribution. |
| 51 | |
| 52 | 3. Neither the name of the copyright holder nor the names of its |
| 53 | contributors may be used to endorse or promote products |
| 54 | derived from this software without specific prior written |
| 55 | permission. |
| 56 | |
| 57 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
| 58 | CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
| 59 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| 60 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 61 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR |
| 62 | CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 63 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 64 | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| 65 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| 66 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| 67 | STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 68 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
| 69 | ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 70 | |
| 71 | The above license is used as a license under copyright only. |
| 72 | Please reference the Forum IPR Policy for patent licensing terms |
| 73 | <https://www.broadband-forum.org/ipr-policy>. |
| 74 | |
| 75 | Any moral rights which are necessary to exercise under the above |
| 76 | license grant are also deemed granted under this license. |
| 77 | |
| 78 | This version of this YANG module is part of TR-385; see |
| 79 | the TR itself for full legal notices."; |
| 80 | |
| 81 | revision 2019-02-25 { |
| 82 | description |
| 83 | "Initial revision. |
| 84 | * Approval Date: 2019-02-25. |
| 85 | * Publication Date: 2019-02-25."; |
| 86 | reference |
| 87 | "TR-385: ITU-T PON YANG Modules |
| 88 | <https://www.broadband-forum.org/technical/download/ |
| 89 | TR-385.pdf>"; |
| 90 | } |
| 91 | |
| 92 | grouping channel-partition-config-data { |
| 93 | description |
| 94 | "All config data for a channel partition"; |
| 95 | leaf channel-group-ref { |
| 96 | type if:interface-ref; |
| 97 | must "derived-from-or-self(/if:interfaces" |
| 98 | + "/if:interface[if:name=current()]/if:type," |
| 99 | + "'bbf-xponift:channel-group')" { |
| 100 | error-message |
| 101 | "Must reference a channel group."; |
| 102 | } |
| 103 | mandatory true; |
| 104 | description |
| 105 | "Reference to a channel group."; |
| 106 | } |
| 107 | leaf channel-partition-index { |
| 108 | type uint8 { |
| 109 | range "0..15"; |
| 110 | } |
| 111 | description |
| 112 | "This attribute identifies the partition inside the |
| 113 | channel group."; |
| 114 | reference |
| 115 | "ITU-T G.989.3 clause 6.1.5.9 and clause 11.3.3.14."; |
| 116 | } |
| 117 | leaf downstream-fec { |
| 118 | type boolean; |
| 119 | default "true"; |
| 120 | description |
| 121 | "Enable/Disable downstream FEC. |
| 122 | Note that downstream FEC is always enabled for XG-PON and |
| 123 | XGS-PON and thus a value of 'false' is ignored."; |
| 124 | reference |
| 125 | "ITU-T G.984.3 clause 13.1.2.1 |
| 126 | ITU-T G.987.3 clause 10.1 |
| 127 | ITU-T G.9807.1 clause C.10.1.1.1.3 |
| 128 | ITU-T G.989.3 clause 10.1.1.1.3"; |
| 129 | } |
| 130 | leaf closest-onu-distance { |
| 131 | type uint16 { |
| 132 | range "0..40"; |
| 133 | } |
| 134 | units "km"; |
| 135 | default "0"; |
| 136 | description |
| 137 | "Establishes the distance of the closest ONU. |
| 138 | Used to determine how to equalize delay |
| 139 | between the ONUs."; |
| 140 | } |
| 141 | leaf maximum-differential-xpon-distance { |
| 142 | type uint16 { |
| 143 | range "20 | 40"; |
| 144 | } |
| 145 | units "km"; |
| 146 | default "20"; |
| 147 | description |
| 148 | "This attribute provides the ability to set the maximum |
| 149 | differential logical reach for a channel partition."; |
| 150 | reference |
| 151 | "ITU-T G.989.1 clause 8.2 |
| 152 | ITU-T G.989.3 clause 13.1."; |
| 153 | } |
| 154 | leaf authentication-method { |
| 155 | type bbf-xpon-types:auth-method-type; |
| 156 | default "serial-number"; |
| 157 | description |
| 158 | "ONU Authentication mode option for this |
| 159 | channel partition."; |
| 160 | reference |
| 161 | "ITU-T G.984.3, section VI.1."; |
| 162 | } |
| 163 | leaf multicast-aes-indicator { |
| 164 | type boolean; |
| 165 | default "false"; |
| 166 | description |
| 167 | "Used to designate whether AES should be |
| 168 | enabled/disabled for multicast GEM ports."; |
| 169 | reference |
| 170 | "ITU-T G.984.3, section 12.2. and 9.2.3.8 |
| 171 | ITU-T G.987.3, section 15.5.1 and 15.5.4 |
| 172 | ITU-T G.9807.1, section C.15.5.1 and C.15.5.4 |
| 173 | ITU-T G.989.3, section 15.5.1 and 5.5.4."; |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | augment '/if:interfaces/if:interface/bbf-xpon:channel-partition' { |
| 178 | description |
| 179 | "Configuration of an xPON channel partition."; |
| 180 | uses channel-partition-config-data; |
| 181 | } |
| 182 | } |