Update docs conf.yaml version to Sulfur
[transportpce.git] / ordmodels / common / src / main / yang / org-openroadm-common-phy-codes@2021-05-28.yang
1 module org-openroadm-common-phy-codes {
2   namespace "http://org/openroadm/common-phy-codes";
3   prefix org-openroadm-common-phy-codes;
4
5   organization
6     "Open ROADM MSA";
7   contact
8     "OpenROADM.org";
9   description
10     "YANG definitions of common types.
11
12       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
13       All other rights reserved.
14
15       Redistribution and use in source and binary forms, with or without modification,
16       are permitted provided that the following conditions are met:
17
18       * Redistributions of source code must retain the above copyright notice, this
19         list of conditions and the following disclaimer.
20       * Redistributions in binary form must reproduce the above copyright notice,
21         this list of conditions and the following disclaimer in the documentation and/or
22         other materials provided with the distribution.
23       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
24         contributors may be used to endorse or promote products derived from this software
25         without specific prior written permission.
26
27       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
28       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
31       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
33       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
34       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36       POSSIBILITY OF SUCH DAMAGE";
37
38   revision 2021-05-28 {
39     description
40         "Version 9.1";
41     }
42
43   identity compliance-code-identity {
44     description
45       "Base identity for reporting pluggable compliance codes per port.";
46   }
47
48   identity phy-code-none {
49     base compliance-code-identity;
50     description
51       "Used to report that no OpenROADM codes are supported.";
52   }
53
54   // BEGIN section for client phy code entities
55   
56   // Parent identity
57   identity client-phy-code-identity {
58     description
59       "base identity for client phy code.";
60   }
61
62   // IEEE 802.3 - 2018 PHY/PMD Names (subset)
63   identity ethernet-1000BASE-SX {
64     base client-phy-code-identity;
65   }
66   identity ethernet-1000BASE-LX {
67     base client-phy-code-identity;
68   }
69   identity ethernet-10GBASE-SR {
70     base client-phy-code-identity;
71   }
72   identity ethernet-10GBASE-LR {
73     base client-phy-code-identity;
74   }
75   identity ethernet-10GBASE-ER {
76     base client-phy-code-identity;
77   }
78   identity ethernet-10GBASE-SW {
79     base client-phy-code-identity;
80   }
81   identity ethernet-10GBASE-LW {
82     base client-phy-code-identity;
83   }
84   identity ethernet-10GBASE-EW {
85     base client-phy-code-identity;
86   }
87   identity ethernet-25GBASE-SR {
88     base client-phy-code-identity;
89   }
90   identity ethernet-25GBASE-LR {
91     base client-phy-code-identity;
92   }
93   identity ethernet-25GBASE-ER {
94     base client-phy-code-identity;
95   }
96   identity ethernet-25GBASE-CR {
97     base client-phy-code-identity;
98   }
99   identity ethernet-25GBASE-CR-S {
100     base client-phy-code-identity;
101   }
102   identity ethernet-25GBASE-KR {
103     base client-phy-code-identity;
104   }
105   identity ethernet-25GBASE-KR-S {
106     base client-phy-code-identity;
107   }
108   identity ethernet-40GBASE-SR4 {
109     base client-phy-code-identity;
110   }
111   identity ethernet-40GBASE-LR4 {
112     base client-phy-code-identity;
113   }
114   identity ethernet-40GBASE-ER4 {
115     base client-phy-code-identity;
116   }
117   identity ethernet-40GBASE-FR {
118     base client-phy-code-identity;
119   }
120   identity ethernet-40GBASE-T {
121     base client-phy-code-identity;
122   }  
123   identity ethernet-40GBASE-KR4 {
124     base client-phy-code-identity;
125   }
126   identity ethernet-50GBASE-SR {
127     base client-phy-code-identity;
128   }
129   identity ethernet-50GBASE-FR {
130     base client-phy-code-identity;
131   }
132   identity ethernet-50GBASE-LR {
133     base client-phy-code-identity;
134   }
135   identity ethernet-50GBASE-KR {
136     base client-phy-code-identity;
137   }
138   identity ethernet-50GBASE-CR {
139     base client-phy-code-identity;
140   }
141   identity ethernet-100GBASE-CR2 {
142     base client-phy-code-identity;
143   }
144   identity ethernet-100GBASE-KR2 {
145     base client-phy-code-identity;
146   }
147   identity ethernet-100GBASE-SR10 {
148     base client-phy-code-identity;
149   }
150   identity ethernet-100GBASE-SR4 {
151     base client-phy-code-identity;
152   }
153   identity ethernet-100GBASE-LR4 {
154     base client-phy-code-identity;
155   }
156   identity ethernet-100GBASE-ER4 {
157     base client-phy-code-identity;
158   }
159   identity ethernet-100GBASE-SR2 {
160     base client-phy-code-identity;
161   }
162   identity ethernet-100GBASE-DR {
163     base client-phy-code-identity;
164   }  
165   identity ethernet-100GBASE-CR4 {
166     base client-phy-code-identity;
167   }
168   identity ethernet-100GBASE-KP4 {
169     base client-phy-code-identity;
170   }
171   identity ethernet-100GBASE-KR4 {
172     base client-phy-code-identity;
173   }
174   identity ethernet-200GBASE-SR4 {
175     base client-phy-code-identity;
176   }
177   identity ethernet-200GBASE-DR4 {
178     base client-phy-code-identity;
179   }
180   identity ethernet-200GBASE-FR4 {
181     base client-phy-code-identity;
182   }
183   identity ethernet-200GBASE-LR4 {
184     base client-phy-code-identity;
185   }
186   identity ethernet-400GBASE-SR16 {
187     base client-phy-code-identity;
188   }
189   identity ethernet-400GBASE-DR4 {
190     base client-phy-code-identity;
191   }
192   identity ethernet-400GBASE-FR8 {
193     base client-phy-code-identity;
194   }
195   identity ethernet-400GBASE-LR8 {
196     base client-phy-code-identity;
197   }
198
199
200   // Common names not defined in IEEE 802.3
201   identity ethernet-1000BASE-EX {
202     base client-phy-code-identity;
203   }
204   identity ethernet-1000BASE-ZX {
205     base client-phy-code-identity;
206   }
207   identity ethernet-10GBASE-ZR {
208     base client-phy-code-identity;
209   }
210   identity ethernet-10GBASE-ZW {
211     base client-phy-code-identity;
212   }
213   identity ethernet-40GQSFP-PSM4 {
214     base client-phy-code-identity;
215   }
216
217
218   // http://psm4.org 
219   identity ethernet-100G-PSM4 {
220     base client-phy-code-identity;
221   }
222
223
224   // http://www.cwdm4-msa.org/
225   identity ethernet-100GE-CWDM4 {
226     base client-phy-code-identity;
227   }
228   identity ethernet-100GE-4WDM-10 {
229     base client-phy-code-identity;
230   }
231
232
233
234   // http://100glambda.com/
235   identity ethernet-100G-FR {
236     base client-phy-code-identity;
237   }
238   identity ethernet-100G-LR {
239     base client-phy-code-identity;
240   }
241   identity ethernet-400G-FR4 {
242     base client-phy-code-identity;
243   }
244
245
246   // ITU-T G.959.1 - 2018 */
247   identity otn-P1I1-1D1 {
248     base client-phy-code-identity;
249   }
250   identity otn-P1S1-1D1 {
251     base client-phy-code-identity;
252   }
253   identity otn-P1L1-1D1 {
254     base client-phy-code-identity;
255   }
256   identity otn-P1L1-1D2 {
257     base client-phy-code-identity;
258   }
259   identity otn-P1I1-2D1 {
260     base client-phy-code-identity;
261   }
262   identity otn-P1I1-2D2 {
263     base client-phy-code-identity;
264   }
265   identity otn-P1S1-2D1 {
266     base client-phy-code-identity;
267   }
268   identity otn-P1S1-2D2a {
269     base client-phy-code-identity;
270   }
271   identity otn-P1S1-2D2b {
272     base client-phy-code-identity;
273   }
274   identity otn-1S1-2D2bF {
275     base client-phy-code-identity;
276   }
277   identity otn-P1L1-2D1 {
278     base client-phy-code-identity;
279   }
280   identity otn-P1L1-2D2 {
281     base client-phy-code-identity;
282   }
283   identity otn-1L1-2D2F {
284     base client-phy-code-identity;
285   }
286   identity otn-P1L1-2D2E {
287     base client-phy-code-identity;
288   }
289   identity otn-1L1-2D2FE {
290     base client-phy-code-identity;
291   }
292   identity otn-C4S1-2D1 {
293     base client-phy-code-identity;
294   }
295   identity otn-1I1-3D1F {
296     base client-phy-code-identity;
297   }
298   identity otn-8R1-4D1F {
299     base client-phy-code-identity;
300   }
301   identity otn-4I1-9D1F {
302     base client-phy-code-identity;
303   }
304   identity otn-4L1-9C1F {
305     base client-phy-code-identity;
306   }
307   identity otn-4L1-9D1F {
308     base client-phy-code-identity;
309   }
310   identity otn-4I1-4D1F {
311     base client-phy-code-identity;
312   }
313   identity otn-8I1-4D1F {
314     base client-phy-code-identity;
315   }
316
317   typedef compliance-codes-union {
318     type union {
319       type identityref { base client-phy-code-identity; }
320       type identityref { base compliance-code-identity; }
321     }
322     default "org-openroadm-common-phy-codes:phy-code-none";
323     description
324       "Compliance codes supported in OpenROADM.";
325   }
326   // END section for client phy code entities
327 }