blob: f480335a950256a95158efbdd344c6c91939af8c [file] [log] [blame]
Zack Williams52209662019-02-07 10:15:31 -07001// 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";
William Kurkian7c151592019-03-27 09:36:15 -040016
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +030017option go_package = "github.com/opencord/voltha-protos/v3/go/openolt";
18option java_package = "org.opencord.voltha.openolt";
19option java_outer_classname = "VolthaOpenOLT";
William Kurkian7c151592019-03-27 09:36:15 -040020
Zack Williams52209662019-02-07 10:15:31 -070021package openolt;
22import "google/api/annotations.proto";
Abhilash Laxmeshwardfbb74d2019-07-23 08:03:08 -040023import public "voltha_protos/tech_profile.proto";
Zack Williams52209662019-02-07 10:15:31 -070024
25service Openolt {
26
27 rpc DisableOlt(Empty) returns (Empty) {
28 option (google.api.http) = {
29 post: "/v1/Disable"
30 body: "*"
31 };
32 }
33
34 rpc ReenableOlt(Empty) returns (Empty) {
35 option (google.api.http) = {
36 post: "/v1/Reenable"
37 body: "*"
38 };
39 }
40
41 rpc ActivateOnu(Onu) returns (Empty) {
42 option (google.api.http) = {
43 post: "/v1/EnableOnu"
44 body: "*"
45 };
46 }
47
48 rpc DeactivateOnu(Onu) returns (Empty) {
49 option (google.api.http) = {
50 post: "/v1/DisableOnu"
51 body: "*"
52 };
53 }
54
55 rpc DeleteOnu(Onu) returns (Empty) {
56 option (google.api.http) = {
57 post: "/v1/DeleteOnu"
58 body: "*"
59 };
60 }
61
62 rpc OmciMsgOut(OmciMsg) returns (Empty) {
63 option (google.api.http) = {
64 post: "/v1/OmciMsgOut"
65 body: "*"
66 };
67 }
68
69 rpc OnuPacketOut(OnuPacket) returns (Empty) {
70 option (google.api.http) = {
71 post: "/v1/OnuPacketOut"
72 body: "*"
73 };
74 }
75
76 rpc UplinkPacketOut(UplinkPacket) returns (Empty) {
77 option (google.api.http) = {
78 post: "/v1/UplinkPacketOut"
79 body: "*"
80 };
81 }
82
83 rpc FlowAdd(Flow) returns (Empty) {
84 option (google.api.http) = {
85 post: "/v1/FlowAdd"
86 body: "*"
87 };
88 }
89
90 rpc FlowRemove(Flow) returns (Empty) {
91 option (google.api.http) = {
92 post: "/v1/FlowRemove"
93 body: "*"
94 };
95 }
96
97 rpc HeartbeatCheck(Empty) returns (Heartbeat) {
98 option (google.api.http) = {
99 post: "/v1/HeartbeatCheck"
100 body: "*"
101 };
102 }
103
104 rpc EnablePonIf(Interface) returns (Empty) {
105 option (google.api.http) = {
106 post: "/v1/EnablePonIf"
107 body: "*"
108 };
109 }
110
111 rpc DisablePonIf(Interface) returns (Empty) {
112 option (google.api.http) = {
113 post: "/v1/DisablePonIf"
114 body: "*"
115 };
116 }
117
118 rpc GetDeviceInfo(Empty) returns (DeviceInfo) {
119 option (google.api.http) = {
120 post: "/v1/GetDeviceInfo"
121 body: "*"
122 };
123 }
124
125 rpc Reboot(Empty) returns (Empty) {
126 option (google.api.http) = {
127 post: "/v1/Reboot"
128 body: "*"
129 };
130 }
131
132 rpc CollectStatistics(Empty) returns (Empty) {
133 option (google.api.http) = {
134 post: "/v1/CollectStatistics"
135 body: "*"
136 };
137 }
138
Abhilash Laxmeshwardfbb74d2019-07-23 08:03:08 -0400139 rpc CreateTrafficSchedulers(tech_profile.TrafficSchedulers) returns (Empty) {
Zack Williams52209662019-02-07 10:15:31 -0700140 option (google.api.http) = {
Abhilash Laxmeshwardfbb74d2019-07-23 08:03:08 -0400141 post: "/v1/CreateTrafficSchedulers"
Zack Williams52209662019-02-07 10:15:31 -0700142 body: "*"
143 };
144 }
145
Abhilash Laxmeshwardfbb74d2019-07-23 08:03:08 -0400146 rpc RemoveTrafficSchedulers(tech_profile.TrafficSchedulers) returns (Empty) {
Zack Williams52209662019-02-07 10:15:31 -0700147 option (google.api.http) = {
Abhilash Laxmeshwardfbb74d2019-07-23 08:03:08 -0400148 post: "/v1/RemoveTrafficSchedulers"
149 body: "*"
150 };
151 }
152
153 rpc CreateTrafficQueues(tech_profile.TrafficQueues) returns (Empty) {
154 option (google.api.http) = {
155 post: "/v1/CreateTrafficQueues"
156 body: "*"
157 };
158 }
159
160 rpc RemoveTrafficQueues(tech_profile.TrafficQueues) returns (Empty) {
161 option (google.api.http) = {
162 post: "/v1/RemoveTrafficQueues"
Zack Williams52209662019-02-07 10:15:31 -0700163 body: "*"
164 };
165 }
166
167 rpc EnableIndication(Empty) returns (stream Indication) {}
Burak Gurdag402dd952019-12-10 20:31:11 +0000168
169 rpc PerformGroupOperation(Group) returns (Empty) {
170 option (google.api.http) = {
171 post: "/v1/PerformGroupOperation"
172 body: "*"
173 };
174 }
Zack Williams52209662019-02-07 10:15:31 -0700175}
176
177message Indication {
178 oneof data {
179 OltIndication olt_ind = 1;
180 IntfIndication intf_ind = 2;
181 IntfOperIndication intf_oper_ind = 3;
182 OnuDiscIndication onu_disc_ind = 4;
183 OnuIndication onu_ind = 5;
184 OmciIndication omci_ind = 6;
185 PacketIndication pkt_ind = 7;
186 PortStatistics port_stats = 8;
187 FlowStatistics flow_stats = 9;
188 AlarmIndication alarm_ind= 10;
189 }
190}
191
192message AlarmIndication {
193 oneof data {
194 LosIndication los_ind = 1;
195 DyingGaspIndication dying_gasp_ind = 2;
196 OnuAlarmIndication onu_alarm_ind = 3;
197 OnuStartupFailureIndication onu_startup_fail_ind = 4;
198 OnuSignalDegradeIndication onu_signal_degrade_ind = 5;
199 OnuDriftOfWindowIndication onu_drift_of_window_ind = 6;
200 OnuLossOfOmciChannelIndication onu_loss_omci_ind = 7;
201 OnuSignalsFailureIndication onu_signals_fail_ind = 8;
202 OnuTransmissionInterferenceWarning onu_tiwi_ind = 9;
203 OnuActivationFailureIndication onu_activation_fail_ind = 10;
204 OnuProcessingErrorIndication onu_processing_error_ind = 11;
Naga Manjunath0a734252019-11-21 19:00:23 +0530205 OnuLossOfKeySyncFailureIndication onu_loss_of_sync_fail_ind = 12;
206 OnuItuPonStatsIndication onu_itu_pon_stats_ind = 13;
Zack Williams52209662019-02-07 10:15:31 -0700207 }
208}
209
210message OltIndication {
211 string oper_state = 1; // up, down
212}
213
214message IntfIndication {
215 fixed32 intf_id = 1;
216 string oper_state = 2; // up, down
217}
218
219message OnuDiscIndication {
220 fixed32 intf_id = 1;
221 SerialNumber serial_number = 2;
222}
223
224message OnuIndication {
225 fixed32 intf_id = 1;
226 fixed32 onu_id = 2;
227 string oper_state = 3; // up, down
228 string admin_state = 5; // up, down
229 SerialNumber serial_number = 4;
230}
231
232message IntfOperIndication {
233 string type = 1; // nni, pon
234 fixed32 intf_id = 2;
235 string oper_state = 3; // up, down
236}
237
238message OmciIndication {
239 fixed32 intf_id = 1;
240 fixed32 onu_id = 2;
241 bytes pkt = 3;
242}
243
244message PacketIndication {
245 string intf_type = 5; // nni, pon, unknown
246 fixed32 intf_id = 1;
247 fixed32 gemport_id = 2;
248 fixed32 flow_id = 3;
249 fixed32 port_no = 6;
250 fixed64 cookie = 7;
251 bytes pkt = 4;
252}
253
254message Interface {
255 fixed32 intf_id = 1;
256}
257
258message Heartbeat {
259 fixed32 heartbeat_signature = 1;
260}
261
262message Onu {
263 fixed32 intf_id = 1;
264 fixed32 onu_id = 2;
265 SerialNumber serial_number = 3;
266 fixed32 pir = 4; // peak information rate assigned to onu
267}
268
269message OmciMsg {
270 fixed32 intf_id = 1;
271 fixed32 onu_id = 2;
272 bytes pkt = 3;
273}
274
275message OnuPacket {
276 fixed32 intf_id = 1;
277 fixed32 onu_id = 2;
278 fixed32 port_no = 4;
Abhilash Laxmeshwardfbb74d2019-07-23 08:03:08 -0400279 fixed32 gemport_id = 5;
Zack Williams52209662019-02-07 10:15:31 -0700280 bytes pkt = 3;
281}
282
283message UplinkPacket {
284 fixed32 intf_id = 1;
285 bytes pkt = 2;
286}
287
288message DeviceInfo {
289 string vendor = 1;
290 string model = 2;
291 string hardware_version = 3;
292 string firmware_version = 4;
293 string device_id = 16;
294 string device_serial_number = 17;
295
296 // Total number of pon intf ports on the device
297 fixed32 pon_ports = 12;
298
299 // If using global per-device technology profile. To be deprecated
300 string technology = 5;
301 fixed32 onu_id_start = 6;
302 fixed32 onu_id_end = 7;
303 fixed32 alloc_id_start = 8;
304 fixed32 alloc_id_end = 9;
305 fixed32 gemport_id_start = 10;
306 fixed32 gemport_id_end = 11;
307 fixed32 flow_id_start = 13;
308 fixed32 flow_id_end = 14;
309
310 message DeviceResourceRanges {
311
312 // List of 0 or more intf_ids that use the same technology and pools.
313 // If 0 intf_ids supplied, it implies ALL interfaces
314 repeated fixed32 intf_ids = 1;
315
316 // Technology profile for this pool
317 string technology = 2;
318
319 message Pool {
320 enum PoolType {
321 ONU_ID = 0;
322 ALLOC_ID = 1;
323 GEMPORT_ID = 2;
324 FLOW_ID = 3;
325 }
326
327 enum SharingType {
328 DEDICATED_PER_INTF = 0;
329 SHARED_BY_ALL_INTF_ALL_TECH = 1; // Shared across all interfaces in all technologies in all ranges
330 SHARED_BY_ALL_INTF_SAME_TECH = 2; // Shared across all interfaces of the same technology used in this range
331 }
332
333 PoolType type = 1;
334 SharingType sharing = 2;
335 fixed32 start = 3; // lower bound on IDs allocated from this pool
336 fixed32 end = 4; // upper bound on IDs allocated from this pool
337 }
338 repeated Pool pools = 3;
339 }
340 repeated DeviceResourceRanges ranges = 15;
341}
342
343message Classifier {
344 fixed32 o_tpid = 1;
345 fixed32 o_vid = 2;
346 fixed32 i_tpid = 3;
347 fixed32 i_vid = 4;
348 fixed32 o_pbits = 5;
349 fixed32 i_pbits = 6;
350 fixed32 eth_type = 7;
351 bytes dst_mac = 8;
352 bytes src_mac = 9;
353 fixed32 ip_proto = 10;
354 fixed32 dst_ip = 11;
355 fixed32 src_ip = 12;
356 fixed32 src_port = 13;
357 fixed32 dst_port = 14;
358 string pkt_tag_type = 15; // untagged, single_tag, double_tag
359}
360
361message ActionCmd {
362 bool add_outer_tag = 1;
363 bool remove_outer_tag = 2;
364 bool trap_to_host = 3;
Burak Gurdag402dd952019-12-10 20:31:11 +0000365 bool remark_outer_pbits = 4;
366 bool remark_inner_pbits = 5;
367 bool add_inner_tag = 6;
368 bool remove_inner_tag = 7;
369 bool translate_inner_tag = 8;
370 bool translate_outer_tag = 9;
Zack Williams52209662019-02-07 10:15:31 -0700371}
372
373message Action {
374 ActionCmd cmd = 1;
375 fixed32 o_vid = 2;
376 fixed32 o_pbits = 3;
377 fixed32 o_tpid = 4;
378 fixed32 i_vid = 5;
379 fixed32 i_pbits = 6;
380 fixed32 i_tpid = 7;
381}
382
383message Flow {
384 sfixed32 access_intf_id = 1;
385 sfixed32 onu_id = 2;
386 sfixed32 uni_id = 11;
387 fixed32 flow_id = 3;
388 string flow_type = 4; // upstream, downstream, broadcast, multicast
389 sfixed32 alloc_id = 10;
390 sfixed32 network_intf_id = 5;
391 sfixed32 gemport_id = 6;
392 Classifier classifier = 7;
393 Action action = 8;
394 sfixed32 priority = 9;
395 fixed64 cookie = 12; // must be provided for any flow with trap_to_host action. Returned in PacketIndication
396 fixed32 port_no = 13; // must be provided for any flow with trap_to_host action. Returned in PacketIndication
Burak Gurdag402dd952019-12-10 20:31:11 +0000397 fixed32 group_id = 14;
Zack Williams52209662019-02-07 10:15:31 -0700398}
399
400message SerialNumber {
401 bytes vendor_id = 1;
402 bytes vendor_specific = 2;
403}
404
405message PortStatistics {
406 fixed32 intf_id = 1;
407 fixed64 rx_bytes = 2;
408 fixed64 rx_packets = 3;
409 fixed64 rx_ucast_packets = 4;
410 fixed64 rx_mcast_packets = 5;
411 fixed64 rx_bcast_packets = 6;
412 fixed64 rx_error_packets = 7;
413 fixed64 tx_bytes = 8;
414 fixed64 tx_packets = 9;
415 fixed64 tx_ucast_packets = 10;
416 fixed64 tx_mcast_packets = 11;
417 fixed64 tx_bcast_packets = 12;
418 fixed64 tx_error_packets = 13;
419 fixed64 rx_crc_errors = 14;
420 fixed64 bip_errors = 15;
421 fixed32 timestamp = 16;
422}
423
424message FlowStatistics {
425 fixed32 flow_id = 1;
426 fixed64 rx_bytes = 2;
427 fixed64 rx_packets = 3;
428 fixed64 tx_bytes = 8;
429 fixed64 tx_packets = 9;
430 fixed32 timestamp = 16;
431}
432
433message LosIndication {
434 fixed32 intf_id = 1;
435 string status = 2;
436}
437
438message DyingGaspIndication {
439 fixed32 intf_id = 1;
440 fixed32 onu_id = 2;
441 string status = 3;
442}
443
444message OnuAlarmIndication {
445 fixed32 intf_id = 1;
446 fixed32 onu_id = 2;
447 string los_status = 3;
448 string lob_status = 4;
449 string lopc_miss_status = 5;
450 string lopc_mic_error_status = 6;
Naga Manjunath0a734252019-11-21 19:00:23 +0530451 string lofi_status = 7;
452 string loami_status = 8;
Zack Williams52209662019-02-07 10:15:31 -0700453}
454
455message OnuStartupFailureIndication {
456 fixed32 intf_id = 1;
457 fixed32 onu_id = 2;
458 string status = 3;
459}
460
461message OnuSignalDegradeIndication {
462 fixed32 intf_id = 1;
463 fixed32 onu_id = 2;
464 string status = 3;
465 fixed32 inverse_bit_error_rate = 4;
466}
467
468message OnuDriftOfWindowIndication {
469 fixed32 intf_id = 1;
470 fixed32 onu_id = 2;
471 string status = 3;
472 fixed32 drift = 4;
473 fixed32 new_eqd = 5;
474}
475
476message OnuLossOfOmciChannelIndication {
477 fixed32 intf_id = 1;
478 fixed32 onu_id = 2;
479 string status = 3;
480}
481
482message OnuSignalsFailureIndication {
483 fixed32 intf_id = 1;
484 fixed32 onu_id = 2;
485 string status = 3;
486 fixed32 inverse_bit_error_rate = 4;
487}
488
489message OnuTransmissionInterferenceWarning {
490 fixed32 intf_id = 1;
491 fixed32 onu_id = 2;
492 string status = 3;
493 fixed32 drift = 4;
494}
495
496message OnuActivationFailureIndication {
497 fixed32 intf_id = 1;
498 fixed32 onu_id = 2;
Naga Manjunath0a734252019-11-21 19:00:23 +0530499 fixed32 fail_reason = 3;
500}
501
502message OnuLossOfKeySyncFailureIndication {
503 fixed32 intf_id = 1;
504 fixed32 onu_id = 2;
505 string status = 3;
506}
507
508message OnuItuPonStatsIndication{
509 fixed32 intf_id = 1;
510 fixed32 onu_id = 2;
511 fixed32 rdi_errors = 3;
Zack Williams52209662019-02-07 10:15:31 -0700512}
513
514message OnuProcessingErrorIndication {
515 fixed32 intf_id = 1;
516 fixed32 onu_id = 2;
517}
518
Burak Gurdag402dd952019-12-10 20:31:11 +0000519message GroupMember {
520 enum InterfaceType {
521 PON = 0;
522 EPON_1G_PATH = 1;
523 EPON_10G_PATH = 2;
524 }
525 uint32 interface_id = 1;
526 InterfaceType interface_type = 2;
527 uint32 gem_port_id = 3;
528 uint32 priority = 4; // Priority (and also the ID) of the default fixed queue for the multicast traffic.
529 // This queue is attached to the default PON port scheduler.
530}
531
532message Group {
533 enum GroupMembersCommand {
534 ADD_MEMBERS = 0;
535 REMOVE_MEMBERS = 1;
536 SET_MEMBERS = 2;
537 }
538
539 uint32 group_id = 1;
540 GroupMembersCommand command = 2;
541 repeated GroupMember members = 3;
542 Action action = 4;
543}
544
545
546
Zack Williams52209662019-02-07 10:15:31 -0700547message Empty {}
Burak Gurdag402dd952019-12-10 20:31:11 +0000548