blob: 00a042adeccae12d67ef18351d17bffd10308062 [file] [log] [blame]
Elia Battiston4750d3c2022-07-14 13:24:56 +00001module bbf-xpon-onu-types {
2 yang-version 1.1;
3 namespace "urn:bbf:yang:bbf-xpon-more-types";
4 prefix bbf-xpon-onu-types;
5
6 organization
7 "Broadband Forum <https://www.broadband-forum.org>
8 Fiber Access Networks Work Area";
9 contact
10 "Comments or questions about this Broadband Forum YANG module
11 should be directed to <mailto:help@broadband-forum.org>.
12
13 Editor: Joey Boyd, ADTRAN
14
15 Editor: Samuel Chen, Broadcom
16
17 Editor: Robert Peschi, Nokia
18
19 WA Director: Marta Seda, Calix
20
21 WA Director: Lin Wei, Huawei";
22 description
23 "This module contains a collection of YANG definitions which
24 defines common types used in the xPON YANG models.
25
26 Copyright (c) 2018, Broadband Forum
27
28 Redistribution and use in source and binary forms, with or
29 without modification, are permitted provided that the following
30 conditions are met:
31
32 1. Redistributions of source code must retain the above copyright
33 notice, this list of conditions and the following disclaimer.
34
35 2. Redistributions in binary form must reproduce the above
36 copyright notice, this list of conditions and the following
37 disclaimer in the documentation and/or other materials
38 provided with the distribution.
39
40 3. Neither the name of the copyright holder nor the names of its
41 contributors may be used to endorse or promote products
42 derived from this software without specific prior written
43 permission.
44
45 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
46 CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES,
47 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
48 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
49 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
50 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
51 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
53 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
54 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
55 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
56 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
57 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58
59 The above license is used as a license under copyright only.
60 Please reference the Forum IPR Policy for patent licensing terms
61 <https://www.broadband-forum.org/ipr-policy>.
62
63 Any moral rights which are necessary to exercise under the above
64 license grant are also deemed granted under this license.
65
66 This version of this YANG module is part of TR-385; see
67 the TR itself for full legal notices.";
68
69 revision 2019-02-25 {
70 description
71 "Initial revision.
72 * Approval Date: 2019-02-25.
73 * Publication Date: 2019-02-25.";
74 reference
75 "TR-385: ITU-T PON YANG Modules
76 <https://www.broadband-forum.org/technical/download/
77 TR-385.pdf>";
78 }
79
80 identity onu-state-base {
81 description
82 "This identity is used to qualify the state of an ONU.";
83 }
84
85 identity onu-present {
86 base onu-state-base;
87 description
88 "This identity is used to denote that an ONU is currently
89 using the optical signal of one of the channel terminations
90 local to this OLT (Refer to 'inside-olt'). An OLT considers
91 that an ONU is using the optical signal of one of its
92 local channel terminations as early as it receives from
93 the ONU a PLOAM Serial_Number_ONU message or as early as
94 it receives a PLOAM Tuning_Resp(Complete_u) message and as
95 long as the channel termination is not in LOBi state for
96 this ONU (i.e in practice the ONU keeps responding to
97 downstream OLT bandwidth map messages).";
98 }
99
100 identity onu-present-and-on-intended-channel-termination {
101 base onu-present;
102 description
103 "This identity is used to denote that an ONU is currently
104 using the optical signal of a channel termination which
105 is local to this OLT (Refer to 'inside-olt') and which
106 is intended for the ONU.
107 In case of G-PON, XG-PON and XGS-PON, this means that the
108 ONU is using a channel-termination belonging to the
109 channel partition where the virtual ANI is configured.
110 In case of NG-PON2 this means that the ONU is using
111 the desired channel-termination which is based on the
112 configured preferred and/or protection channel pair
113 or resulted from executing an 'in-service-onu-tune-request'
114 YANG action.";
115 }
116
117 identity onu-present-and-in-discovery {
118 base onu-present;
119 description
120 "This identity is used to denote that an NG-PON2 ONU, has
121 just been detected present on a channel termination which
122 is local to this OLT (Refer to 'inside-olt') but from which
123 the ONU potentially still needs to tune away while the OLT
124 is assessing the intended channel termination of the ONU.";
125 }
126
127 identity onu-present-and-discovery-tune-fail {
128 base onu-present;
129 description
130 "This identity is used to denote that an NG-PON2 ONU has just
131 been detected present on a channel termination which is local
132 to this OLT (Refer to 'inside-olt') but is not its intended
133 one and from which the ONU could not be tuned away towards
134 an identified intended channel termination.";
135 }
136
137 identity onu-present-and-unexpected {
138 base onu-present;
139 description
140 "This identity is used to denote that a G-PON, XG-PON or
141 XGS-PON ONU is present on a channel termination which is
142 local to this OLT (Refer to 'inside-olt') but for which
143 the OLT has no configured virtual ANI. This identity is
144 also used to denote that an NG-PON2 ONU has just been
145 detected present on a channel termination which is local
146 to this OLT (Refer to 'inside-olt') but is not its intended
147 one and for which no intended channel termination could be
148 identified (for instance because the NGPON2 ONU is not
149 configured on any OLT on the channel group).";
150 }
151
152 identity onu-present-and-emergency-stopped {
153 base onu-present;
154 description
155 "This identity is used to denote that a G-PON, XG-PON,
156 XGS-PON or NG-PON2 ONU is present on a channel termination
157 which is local to this OLT (Refer to 'inside-olt') and to
158 which the OLT has sent a 'Disable_Serial_Number' DS PLOAM
159 message, bringing the ONU in ITU-T 'Emergency Stop state'.";
160 reference
161 "ITU-T G.984.3 Section 9.2.1
162 ITU-T G.987.3 Table 11.2
163 ITU-T G.9807.3 Table C.11.2
164 ITU-T G.989.3 Table 11.2";
165 }
166
167 identity onu-not-present {
168 base onu-state-base;
169 description
170 "This identity is used to denote that the ONU is not present
171 on the OLT, i.e. that the ONU is not using the optical
172 signal of any channel termination local to this OLT; this
173 could mean that the ONU is using the optical signal of a
174 channel termination belonging to another OLT, or that the
175 ONU is not connected at all to the channel group.";
176 }
177
178 identity onu-not-present-with-v-ani {
179 base onu-not-present;
180 description
181 "This identity is used to denote that an ONU, for which a
182 virtual ANI is configured on the OLT, is not using the
183 optical signal of any channel termination local to this
184 OLT; this could mean that the ONU is using the optical
185 signal of a channel termination belonging to another OLT,
186 or that the ONU is not connected at all to the channel
187 group.";
188 }
189
190 identity onu-not-present-without-v-ani {
191 base onu-not-present;
192 description
193 "This identity is used to denote that an ONU, for which
194 no virtual ANI is configured on the OLT, is not using
195 any longer the optical signal of any channel termination
196 local to this OLT. This could mean that the ONU is
197 disconnected from the channel group; in case of NG-PON2
198 it could also mean that the ONU is tuned away to a
199 channel termination belonging to another OLT.";
200 }
201}
202