blob: ccc2d05a8d88f12b73b2cb421cd70b999258eed6 [file] [log] [blame]
Shad Ansari19249582018-04-30 04:31:00 +00001// Copyright (c) 2018 Open Networking Foundation
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at:
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16package openolt;
17import "google/api/annotations.proto";
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -080018import "tech_profile.proto";
Shad Ansari19249582018-04-30 04:31:00 +000019
20service Openolt {
21
Nicolas Palpacuere3fc0d22018-08-02 16:51:05 -040022 rpc DisableOlt(Empty) returns (Empty) {
23 option (google.api.http) = {
24 post: "/v1/Disable"
25 body: "*"
26 };
27 }
28
29 rpc ReenableOlt(Empty) returns (Empty) {
30 option (google.api.http) = {
31 post: "/v1/Reenable"
32 body: "*"
33 };
34 }
35
Shad Ansari19249582018-04-30 04:31:00 +000036 rpc ActivateOnu(Onu) returns (Empty) {
37 option (google.api.http) = {
38 post: "/v1/EnableOnu"
39 body: "*"
40 };
41 }
42
Jonathan Davis70c21812018-07-19 15:32:10 -040043 rpc DeactivateOnu(Onu) returns (Empty) {
44 option (google.api.http) = {
45 post: "/v1/DisableOnu"
46 body: "*"
47 };
48 }
49
50 rpc DeleteOnu(Onu) returns (Empty) {
51 option (google.api.http) = {
52 post: "/v1/DeleteOnu"
53 body: "*"
54 };
55 }
56
Shad Ansari19249582018-04-30 04:31:00 +000057 rpc OmciMsgOut(OmciMsg) returns (Empty) {
58 option (google.api.http) = {
59 post: "/v1/OmciMsgOut"
60 body: "*"
61 };
62 }
63
64 rpc OnuPacketOut(OnuPacket) returns (Empty) {
65 option (google.api.http) = {
66 post: "/v1/OnuPacketOut"
67 body: "*"
68 };
69 }
70
Nicolas Palpacuerb78def42018-06-07 12:55:26 -040071 rpc UplinkPacketOut(UplinkPacket) returns (Empty) {
72 option (google.api.http) = {
73 post: "/v1/UplinkPacketOut"
74 body: "*"
75 };
76 }
77
Shad Ansari19249582018-04-30 04:31:00 +000078 rpc FlowAdd(Flow) returns (Empty) {
79 option (google.api.http) = {
80 post: "/v1/FlowAdd"
81 body: "*"
82 };
83 }
84
Nicolas Palpacueredfaa0c2018-07-05 15:05:27 -040085 rpc FlowRemove(Flow) returns (Empty) {
86 option (google.api.http) = {
87 post: "/v1/FlowRemove"
88 body: "*"
89 };
90 }
91
nick7be062f2018-05-25 17:52:56 -040092 rpc HeartbeatCheck(Empty) returns (Heartbeat) {
93 option (google.api.http) = {
94 post: "/v1/HeartbeatCheck"
95 body: "*"
96 };
97 }
98
Nicolas Palpacuer05ea0ea2018-07-06 11:47:21 -040099 rpc EnablePonIf(Interface) returns (Empty) {
100 option (google.api.http) = {
101 post: "/v1/EnablePonIf"
102 body: "*"
103 };
104 }
105
Shad Ansaricb208782019-07-02 20:53:40 +0000106 rpc GetPonIf(Interface) returns (IntfIndication) {
107 option (google.api.http) = {
108 post: "/v1/GetPonIf"
109 body: "*"
110 };
111 }
112
Nicolas Palpacuer05ea0ea2018-07-06 11:47:21 -0400113 rpc DisablePonIf(Interface) returns (Empty) {
114 option (google.api.http) = {
115 post: "/v1/DisablePonIf"
116 body: "*"
117 };
118 }
Nicolas Palpacuer0f19b1a2018-06-07 17:29:31 -0400119
Nicolas Palpacuerdff96792018-09-06 14:59:32 -0400120 rpc GetDeviceInfo(Empty) returns (DeviceInfo) {
121 option (google.api.http) = {
122 post: "/v1/GetDeviceInfo"
123 body: "*"
124 };
125 }
126
Nicolas Palpacuer45180662018-08-02 14:01:51 -0400127 rpc Reboot(Empty) returns (Empty) {
128 option (google.api.http) = {
129 post: "/v1/Reboot"
130 body: "*"
131 };
132 }
133
Shad Ansari39739bc2018-09-13 21:38:37 +0000134 rpc CollectStatistics(Empty) returns (Empty) {
135 option (google.api.http) = {
136 post: "/v1/CollectStatistics"
137 body: "*"
138 };
139 }
140
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800141 rpc CreateTrafficSchedulers(tech_profile.TrafficSchedulers) returns (Empty) {
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700142 option (google.api.http) = {
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800143 post: "/v1/CreateTrafficSchedulers"
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700144 body: "*"
145 };
146 }
147
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800148 rpc RemoveTrafficSchedulers(tech_profile.TrafficSchedulers) returns (Empty) {
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700149 option (google.api.http) = {
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800150 post: "/v1/RemoveTrafficSchedulers"
151 body: "*"
152 };
153 }
154
155 rpc CreateTrafficQueues(tech_profile.TrafficQueues) returns (Empty) {
156 option (google.api.http) = {
157 post: "/v1/CreateTrafficQueues"
158 body: "*"
159 };
160 }
161
162 rpc RemoveTrafficQueues(tech_profile.TrafficQueues) returns (Empty) {
163 option (google.api.http) = {
164 post: "/v1/RemoveTrafficQueues"
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700165 body: "*"
166 };
167 }
168
Shad Ansari19249582018-04-30 04:31:00 +0000169 rpc EnableIndication(Empty) returns (stream Indication) {}
170}
171
172message Indication {
173 oneof data {
174 OltIndication olt_ind = 1;
175 IntfIndication intf_ind = 2;
176 IntfOperIndication intf_oper_ind = 3;
177 OnuDiscIndication onu_disc_ind = 4;
178 OnuIndication onu_ind = 5;
179 OmciIndication omci_ind = 6;
180 PacketIndication pkt_ind = 7;
Nicolas Palpacuer0f19b1a2018-06-07 17:29:31 -0400181 PortStatistics port_stats = 8;
182 FlowStatistics flow_stats = 9;
Nicolas Palpacuera32f4c32018-06-28 12:55:10 -0400183 AlarmIndication alarm_ind= 10;
184 }
185}
186
187message AlarmIndication {
188 oneof data {
189 LosIndication los_ind = 1;
190 DyingGaspIndication dying_gasp_ind = 2;
Nicolas Palpacuerde4325b2018-07-03 11:18:42 -0400191 OnuAlarmIndication onu_alarm_ind = 3;
192 OnuStartupFailureIndication onu_startup_fail_ind = 4;
193 OnuSignalDegradeIndication onu_signal_degrade_ind = 5;
194 OnuDriftOfWindowIndication onu_drift_of_window_ind = 6;
195 OnuLossOfOmciChannelIndication onu_loss_omci_ind = 7;
196 OnuSignalsFailureIndication onu_signals_fail_ind = 8;
197 OnuTransmissionInterferenceWarning onu_tiwi_ind = 9;
198 OnuActivationFailureIndication onu_activation_fail_ind = 10;
199 OnuProcessingErrorIndication onu_processing_error_ind = 11;
Shad Ansari19249582018-04-30 04:31:00 +0000200 }
201}
202
203message OltIndication {
204 string oper_state = 1; // up, down
Shad Ansari19249582018-04-30 04:31:00 +0000205}
206
207message IntfIndication {
208 fixed32 intf_id = 1;
209 string oper_state = 2; // up, down
210}
211
212message OnuDiscIndication {
213 fixed32 intf_id = 1;
214 SerialNumber serial_number = 2;
215}
216
217message OnuIndication {
218 fixed32 intf_id = 1;
219 fixed32 onu_id = 2;
220 string oper_state = 3; // up, down
Shad Ansarife9d9422018-05-22 23:25:02 +0000221 string admin_state = 5; // up, down
222 SerialNumber serial_number = 4;
Girish Gowdru376b33c2019-05-06 21:46:31 -0700223 bytes registration_id = 6; // reg_id of onu
Shad Ansari19249582018-04-30 04:31:00 +0000224}
225
226message IntfOperIndication {
227 string type = 1; // nni, pon
228 fixed32 intf_id = 2;
229 string oper_state = 3; // up, down
230}
231
232message OmciIndication {
233 fixed32 intf_id = 1;
234 fixed32 onu_id = 2;
235 bytes pkt = 3;
236}
237
238message PacketIndication {
Shad Ansariebc80362018-09-30 09:33:35 +0000239 string intf_type = 5; // nni, pon, unknown
Shad Ansari19249582018-04-30 04:31:00 +0000240 fixed32 intf_id = 1;
241 fixed32 gemport_id = 2;
242 fixed32 flow_id = 3;
Craig Lutgen967a1d02018-11-27 10:41:51 -0600243 fixed32 port_no = 6;
244 fixed64 cookie = 7;
Shad Ansari19249582018-04-30 04:31:00 +0000245 bytes pkt = 4;
246}
247
Nicolas Palpacuer05ea0ea2018-07-06 11:47:21 -0400248message Interface {
249 fixed32 intf_id = 1;
250}
251
nick7be062f2018-05-25 17:52:56 -0400252message Heartbeat {
253 fixed32 heartbeat_signature = 1;
254}
255
Shad Ansari19249582018-04-30 04:31:00 +0000256message Onu {
257 fixed32 intf_id = 1;
258 fixed32 onu_id = 2;
259 SerialNumber serial_number = 3;
Shad Ansari06101952018-07-25 00:22:09 +0000260 fixed32 pir = 4; // peak information rate assigned to onu
Shad Ansari19249582018-04-30 04:31:00 +0000261}
262
263message OmciMsg {
264 fixed32 intf_id = 1;
265 fixed32 onu_id = 2;
266 bytes pkt = 3;
267}
268
269message OnuPacket {
270 fixed32 intf_id = 1;
271 fixed32 onu_id = 2;
Craig Lutgenecd353a2018-12-12 22:33:17 -0600272 fixed32 port_no = 4;
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800273 fixed32 gemport_id = 5;
Shad Ansari19249582018-04-30 04:31:00 +0000274 bytes pkt = 3;
275}
276
Nicolas Palpacuerb78def42018-06-07 12:55:26 -0400277message UplinkPacket {
278 fixed32 intf_id = 1;
279 bytes pkt = 2;
280}
281
Nicolas Palpacuerdff96792018-09-06 14:59:32 -0400282message DeviceInfo {
283 string vendor = 1;
284 string model = 2;
285 string hardware_version = 3;
286 string firmware_version = 4;
Craig Lutgen967a1d02018-11-27 10:41:51 -0600287 string device_id = 16;
288 string device_serial_number = 17;
Craig Lutgene4a202f2018-10-16 17:19:30 -0500289
290 // Total number of pon intf ports on the device
291 fixed32 pon_ports = 12;
292
293 // If using global per-device technology profile. To be deprecated
Nicolas Palpacuerdff96792018-09-06 14:59:32 -0400294 string technology = 5;
295 fixed32 onu_id_start = 6;
296 fixed32 onu_id_end = 7;
297 fixed32 alloc_id_start = 8;
298 fixed32 alloc_id_end = 9;
299 fixed32 gemport_id_start = 10;
300 fixed32 gemport_id_end = 11;
Craig Lutgene4a202f2018-10-16 17:19:30 -0500301 fixed32 flow_id_start = 13;
302 fixed32 flow_id_end = 14;
303
304 message DeviceResourceRanges {
305
306 // List of 0 or more intf_ids that use the same technology and pools.
307 // If 0 intf_ids supplied, it implies ALL interfaces
308 repeated fixed32 intf_ids = 1;
309
310 // Technology profile for this pool
311 string technology = 2;
312
313 message Pool {
314 enum PoolType {
315 ONU_ID = 0;
316 ALLOC_ID = 1;
317 GEMPORT_ID = 2;
318 FLOW_ID = 3;
319 }
320
321 enum SharingType {
322 DEDICATED_PER_INTF = 0;
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700323 SHARED_BY_ALL_INTF_ALL_TECH = 1; // Shared across all interfaces in all technologies in all ranges
Craig Lutgenb2601f02018-10-23 13:04:31 -0500324 SHARED_BY_ALL_INTF_SAME_TECH = 2; // Shared across all interfaces of the same technology used in this range
Craig Lutgene4a202f2018-10-16 17:19:30 -0500325 }
326
327 PoolType type = 1;
328 SharingType sharing = 2;
329 fixed32 start = 3; // lower bound on IDs allocated from this pool
330 fixed32 end = 4; // upper bound on IDs allocated from this pool
331 }
Craig Lutgenb2601f02018-10-23 13:04:31 -0500332 repeated Pool pools = 3;
Craig Lutgene4a202f2018-10-16 17:19:30 -0500333 }
334 repeated DeviceResourceRanges ranges = 15;
Nicolas Palpacuerdff96792018-09-06 14:59:32 -0400335}
336
Shad Ansari19249582018-04-30 04:31:00 +0000337message Classifier {
338 fixed32 o_tpid = 1;
339 fixed32 o_vid = 2;
340 fixed32 i_tpid = 3;
341 fixed32 i_vid = 4;
342 fixed32 o_pbits = 5;
343 fixed32 i_pbits = 6;
344 fixed32 eth_type = 7;
345 bytes dst_mac = 8;
346 bytes src_mac = 9;
347 fixed32 ip_proto = 10;
348 fixed32 dst_ip = 11;
349 fixed32 src_ip = 12;
350 fixed32 src_port = 13;
351 fixed32 dst_port = 14;
352 string pkt_tag_type = 15; // untagged, single_tag, double_tag
353}
354
355message ActionCmd {
356 bool add_outer_tag = 1;
357 bool remove_outer_tag = 2;
358 bool trap_to_host = 3;
359}
360
361message Action {
362 ActionCmd cmd = 1;
363 fixed32 o_vid = 2;
364 fixed32 o_pbits = 3;
365 fixed32 o_tpid = 4;
366 fixed32 i_vid = 5;
367 fixed32 i_pbits = 6;
368 fixed32 i_tpid = 7;
369}
370
371message Flow {
Shad Ansari39739bc2018-09-13 21:38:37 +0000372 sfixed32 access_intf_id = 1;
373 sfixed32 onu_id = 2;
Craig Lutgen967a1d02018-11-27 10:41:51 -0600374 sfixed32 uni_id = 11;
Shad Ansari19249582018-04-30 04:31:00 +0000375 fixed32 flow_id = 3;
376 string flow_type = 4; // upstream, downstream, broadcast, multicast
Shad Ansari39739bc2018-09-13 21:38:37 +0000377 sfixed32 alloc_id = 10;
378 sfixed32 network_intf_id = 5;
379 sfixed32 gemport_id = 6;
Shad Ansari19249582018-04-30 04:31:00 +0000380 Classifier classifier = 7;
381 Action action = 8;
Shad Ansari39739bc2018-09-13 21:38:37 +0000382 sfixed32 priority = 9;
Craig Lutgen967a1d02018-11-27 10:41:51 -0600383 fixed64 cookie = 12; // must be provided for any flow with trap_to_host action. Returned in PacketIndication
384 fixed32 port_no = 13; // must be provided for any flow with trap_to_host action. Returned in PacketIndication
Shad Ansari19249582018-04-30 04:31:00 +0000385}
386
387message SerialNumber {
388 bytes vendor_id = 1;
389 bytes vendor_specific = 2;
390}
391
Nicolas Palpacuer0f19b1a2018-06-07 17:29:31 -0400392message PortStatistics {
393 fixed32 intf_id = 1;
394 fixed64 rx_bytes = 2;
395 fixed64 rx_packets = 3;
396 fixed64 rx_ucast_packets = 4;
397 fixed64 rx_mcast_packets = 5;
398 fixed64 rx_bcast_packets = 6;
399 fixed64 rx_error_packets = 7;
400 fixed64 tx_bytes = 8;
401 fixed64 tx_packets = 9;
402 fixed64 tx_ucast_packets = 10;
403 fixed64 tx_mcast_packets = 11;
404 fixed64 tx_bcast_packets = 12;
405 fixed64 tx_error_packets = 13;
406 fixed64 rx_crc_errors = 14;
407 fixed64 bip_errors = 15;
408 fixed32 timestamp = 16;
409}
410
411message FlowStatistics {
412 fixed32 flow_id = 1;
413 fixed64 rx_bytes = 2;
414 fixed64 rx_packets = 3;
415 fixed64 tx_bytes = 8;
416 fixed64 tx_packets = 9;
417 fixed32 timestamp = 16;
418}
419
Nicolas Palpacuera32f4c32018-06-28 12:55:10 -0400420message LosIndication {
421 fixed32 intf_id = 1;
422 string status = 2;
423}
424
425message DyingGaspIndication {
426 fixed32 intf_id = 1;
427 fixed32 onu_id = 2;
428 string status = 3;
429}
430
Nicolas Palpacuerde4325b2018-07-03 11:18:42 -0400431message OnuAlarmIndication {
432 fixed32 intf_id = 1;
433 fixed32 onu_id = 2;
434 string los_status = 3;
435 string lob_status = 4;
436 string lopc_miss_status = 5;
437 string lopc_mic_error_status = 6;
438}
439
440message OnuStartupFailureIndication {
441 fixed32 intf_id = 1;
442 fixed32 onu_id = 2;
443 string status = 3;
444}
445
446message OnuSignalDegradeIndication {
447 fixed32 intf_id = 1;
448 fixed32 onu_id = 2;
449 string status = 3;
450 fixed32 inverse_bit_error_rate = 4;
451}
452
453message OnuDriftOfWindowIndication {
454 fixed32 intf_id = 1;
455 fixed32 onu_id = 2;
456 string status = 3;
457 fixed32 drift = 4;
458 fixed32 new_eqd = 5;
459}
460
461message OnuLossOfOmciChannelIndication {
462 fixed32 intf_id = 1;
463 fixed32 onu_id = 2;
464 string status = 3;
465}
466
467message OnuSignalsFailureIndication {
468 fixed32 intf_id = 1;
469 fixed32 onu_id = 2;
470 string status = 3;
471 fixed32 inverse_bit_error_rate = 4;
472}
473
474message OnuTransmissionInterferenceWarning {
475 fixed32 intf_id = 1;
476 fixed32 onu_id = 2;
477 string status = 3;
478 fixed32 drift = 4;
479}
480
481message OnuActivationFailureIndication {
482 fixed32 intf_id = 1;
483 fixed32 onu_id = 2;
484}
485
486message OnuProcessingErrorIndication {
487 fixed32 intf_id = 1;
488 fixed32 onu_id = 2;
489}
490
Shad Ansari19249582018-04-30 04:31:00 +0000491message Empty {}
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800492