blob: ac53e6baeb6bb9ab9ca8728c35be4e011c0725c8 [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";
18
19service Openolt {
20
Nicolas Palpacuere3fc0d22018-08-02 16:51:05 -040021 rpc DisableOlt(Empty) returns (Empty) {
22 option (google.api.http) = {
23 post: "/v1/Disable"
24 body: "*"
25 };
26 }
27
28 rpc ReenableOlt(Empty) returns (Empty) {
29 option (google.api.http) = {
30 post: "/v1/Reenable"
31 body: "*"
32 };
33 }
34
Shad Ansari19249582018-04-30 04:31:00 +000035 rpc ActivateOnu(Onu) returns (Empty) {
36 option (google.api.http) = {
37 post: "/v1/EnableOnu"
38 body: "*"
39 };
40 }
41
Jonathan Davis70c21812018-07-19 15:32:10 -040042 rpc DeactivateOnu(Onu) returns (Empty) {
43 option (google.api.http) = {
44 post: "/v1/DisableOnu"
45 body: "*"
46 };
47 }
48
49 rpc DeleteOnu(Onu) returns (Empty) {
50 option (google.api.http) = {
51 post: "/v1/DeleteOnu"
52 body: "*"
53 };
54 }
55
Shad Ansari19249582018-04-30 04:31:00 +000056 rpc OmciMsgOut(OmciMsg) returns (Empty) {
57 option (google.api.http) = {
58 post: "/v1/OmciMsgOut"
59 body: "*"
60 };
61 }
62
63 rpc OnuPacketOut(OnuPacket) returns (Empty) {
64 option (google.api.http) = {
65 post: "/v1/OnuPacketOut"
66 body: "*"
67 };
68 }
69
Nicolas Palpacuerb78def42018-06-07 12:55:26 -040070 rpc UplinkPacketOut(UplinkPacket) returns (Empty) {
71 option (google.api.http) = {
72 post: "/v1/UplinkPacketOut"
73 body: "*"
74 };
75 }
76
Shad Ansari19249582018-04-30 04:31:00 +000077 rpc FlowAdd(Flow) returns (Empty) {
78 option (google.api.http) = {
79 post: "/v1/FlowAdd"
80 body: "*"
81 };
82 }
83
Nicolas Palpacueredfaa0c2018-07-05 15:05:27 -040084 rpc FlowRemove(Flow) returns (Empty) {
85 option (google.api.http) = {
86 post: "/v1/FlowRemove"
87 body: "*"
88 };
89 }
90
nick7be062f2018-05-25 17:52:56 -040091 rpc HeartbeatCheck(Empty) returns (Heartbeat) {
92 option (google.api.http) = {
93 post: "/v1/HeartbeatCheck"
94 body: "*"
95 };
96 }
97
Nicolas Palpacuer05ea0ea2018-07-06 11:47:21 -040098 rpc EnablePonIf(Interface) returns (Empty) {
99 option (google.api.http) = {
100 post: "/v1/EnablePonIf"
101 body: "*"
102 };
103 }
104
105 rpc DisablePonIf(Interface) returns (Empty) {
106 option (google.api.http) = {
107 post: "/v1/DisablePonIf"
108 body: "*"
109 };
110 }
Nicolas Palpacuer0f19b1a2018-06-07 17:29:31 -0400111
Nicolas Palpacuerdff96792018-09-06 14:59:32 -0400112 rpc GetDeviceInfo(Empty) returns (DeviceInfo) {
113 option (google.api.http) = {
114 post: "/v1/GetDeviceInfo"
115 body: "*"
116 };
117 }
118
Nicolas Palpacuer45180662018-08-02 14:01:51 -0400119 rpc Reboot(Empty) returns (Empty) {
120 option (google.api.http) = {
121 post: "/v1/Reboot"
122 body: "*"
123 };
124 }
125
Shad Ansari39739bc2018-09-13 21:38:37 +0000126 rpc CollectStatistics(Empty) returns (Empty) {
127 option (google.api.http) = {
128 post: "/v1/CollectStatistics"
129 body: "*"
130 };
131 }
132
Shad Ansari19249582018-04-30 04:31:00 +0000133 rpc EnableIndication(Empty) returns (stream Indication) {}
134}
135
136message Indication {
137 oneof data {
138 OltIndication olt_ind = 1;
139 IntfIndication intf_ind = 2;
140 IntfOperIndication intf_oper_ind = 3;
141 OnuDiscIndication onu_disc_ind = 4;
142 OnuIndication onu_ind = 5;
143 OmciIndication omci_ind = 6;
144 PacketIndication pkt_ind = 7;
Nicolas Palpacuer0f19b1a2018-06-07 17:29:31 -0400145 PortStatistics port_stats = 8;
146 FlowStatistics flow_stats = 9;
Nicolas Palpacuera32f4c32018-06-28 12:55:10 -0400147 AlarmIndication alarm_ind= 10;
148 }
149}
150
151message AlarmIndication {
152 oneof data {
153 LosIndication los_ind = 1;
154 DyingGaspIndication dying_gasp_ind = 2;
Nicolas Palpacuerde4325b2018-07-03 11:18:42 -0400155 OnuAlarmIndication onu_alarm_ind = 3;
156 OnuStartupFailureIndication onu_startup_fail_ind = 4;
157 OnuSignalDegradeIndication onu_signal_degrade_ind = 5;
158 OnuDriftOfWindowIndication onu_drift_of_window_ind = 6;
159 OnuLossOfOmciChannelIndication onu_loss_omci_ind = 7;
160 OnuSignalsFailureIndication onu_signals_fail_ind = 8;
161 OnuTransmissionInterferenceWarning onu_tiwi_ind = 9;
162 OnuActivationFailureIndication onu_activation_fail_ind = 10;
163 OnuProcessingErrorIndication onu_processing_error_ind = 11;
Shad Ansari19249582018-04-30 04:31:00 +0000164 }
165}
166
167message OltIndication {
168 string oper_state = 1; // up, down
Shad Ansari19249582018-04-30 04:31:00 +0000169}
170
171message IntfIndication {
172 fixed32 intf_id = 1;
173 string oper_state = 2; // up, down
174}
175
176message OnuDiscIndication {
177 fixed32 intf_id = 1;
178 SerialNumber serial_number = 2;
179}
180
181message OnuIndication {
182 fixed32 intf_id = 1;
183 fixed32 onu_id = 2;
184 string oper_state = 3; // up, down
Shad Ansarife9d9422018-05-22 23:25:02 +0000185 string admin_state = 5; // up, down
186 SerialNumber serial_number = 4;
Shad Ansari19249582018-04-30 04:31:00 +0000187}
188
189message IntfOperIndication {
190 string type = 1; // nni, pon
191 fixed32 intf_id = 2;
192 string oper_state = 3; // up, down
193}
194
195message OmciIndication {
196 fixed32 intf_id = 1;
197 fixed32 onu_id = 2;
198 bytes pkt = 3;
199}
200
201message PacketIndication {
202 fixed32 intf_id = 1;
203 fixed32 gemport_id = 2;
204 fixed32 flow_id = 3;
205 bytes pkt = 4;
206}
207
Nicolas Palpacuer05ea0ea2018-07-06 11:47:21 -0400208message Interface {
209 fixed32 intf_id = 1;
210}
211
nick7be062f2018-05-25 17:52:56 -0400212message Heartbeat {
213 fixed32 heartbeat_signature = 1;
214}
215
Shad Ansari19249582018-04-30 04:31:00 +0000216message Onu {
217 fixed32 intf_id = 1;
218 fixed32 onu_id = 2;
219 SerialNumber serial_number = 3;
Shad Ansari06101952018-07-25 00:22:09 +0000220 fixed32 pir = 4; // peak information rate assigned to onu
Girish Gowdru0ffa48b2018-09-26 01:55:29 -0700221 fixed32 alloc_id = 5;
Shad Ansari19249582018-04-30 04:31:00 +0000222}
223
224message OmciMsg {
225 fixed32 intf_id = 1;
226 fixed32 onu_id = 2;
227 bytes pkt = 3;
228}
229
230message OnuPacket {
231 fixed32 intf_id = 1;
232 fixed32 onu_id = 2;
233 bytes pkt = 3;
234}
235
Nicolas Palpacuerb78def42018-06-07 12:55:26 -0400236message UplinkPacket {
237 fixed32 intf_id = 1;
238 bytes pkt = 2;
239}
240
Nicolas Palpacuerdff96792018-09-06 14:59:32 -0400241message DeviceInfo {
242 string vendor = 1;
243 string model = 2;
244 string hardware_version = 3;
245 string firmware_version = 4;
246 string technology = 5;
247 fixed32 onu_id_start = 6;
248 fixed32 onu_id_end = 7;
249 fixed32 alloc_id_start = 8;
250 fixed32 alloc_id_end = 9;
251 fixed32 gemport_id_start = 10;
252 fixed32 gemport_id_end = 11;
253 fixed32 pon_ports = 12;
254}
255
Shad Ansari19249582018-04-30 04:31:00 +0000256message Classifier {
257 fixed32 o_tpid = 1;
258 fixed32 o_vid = 2;
259 fixed32 i_tpid = 3;
260 fixed32 i_vid = 4;
261 fixed32 o_pbits = 5;
262 fixed32 i_pbits = 6;
263 fixed32 eth_type = 7;
264 bytes dst_mac = 8;
265 bytes src_mac = 9;
266 fixed32 ip_proto = 10;
267 fixed32 dst_ip = 11;
268 fixed32 src_ip = 12;
269 fixed32 src_port = 13;
270 fixed32 dst_port = 14;
271 string pkt_tag_type = 15; // untagged, single_tag, double_tag
272}
273
274message ActionCmd {
275 bool add_outer_tag = 1;
276 bool remove_outer_tag = 2;
277 bool trap_to_host = 3;
278}
279
280message Action {
281 ActionCmd cmd = 1;
282 fixed32 o_vid = 2;
283 fixed32 o_pbits = 3;
284 fixed32 o_tpid = 4;
285 fixed32 i_vid = 5;
286 fixed32 i_pbits = 6;
287 fixed32 i_tpid = 7;
288}
289
290message Flow {
Shad Ansari39739bc2018-09-13 21:38:37 +0000291 sfixed32 access_intf_id = 1;
292 sfixed32 onu_id = 2;
Shad Ansari19249582018-04-30 04:31:00 +0000293 fixed32 flow_id = 3;
294 string flow_type = 4; // upstream, downstream, broadcast, multicast
Shad Ansari39739bc2018-09-13 21:38:37 +0000295 sfixed32 alloc_id = 10;
296 sfixed32 network_intf_id = 5;
297 sfixed32 gemport_id = 6;
Shad Ansari19249582018-04-30 04:31:00 +0000298 Classifier classifier = 7;
299 Action action = 8;
Shad Ansari39739bc2018-09-13 21:38:37 +0000300 sfixed32 priority = 9;
Shad Ansari19249582018-04-30 04:31:00 +0000301}
302
303message SerialNumber {
304 bytes vendor_id = 1;
305 bytes vendor_specific = 2;
306}
307
Nicolas Palpacuer0f19b1a2018-06-07 17:29:31 -0400308message PortStatistics {
309 fixed32 intf_id = 1;
310 fixed64 rx_bytes = 2;
311 fixed64 rx_packets = 3;
312 fixed64 rx_ucast_packets = 4;
313 fixed64 rx_mcast_packets = 5;
314 fixed64 rx_bcast_packets = 6;
315 fixed64 rx_error_packets = 7;
316 fixed64 tx_bytes = 8;
317 fixed64 tx_packets = 9;
318 fixed64 tx_ucast_packets = 10;
319 fixed64 tx_mcast_packets = 11;
320 fixed64 tx_bcast_packets = 12;
321 fixed64 tx_error_packets = 13;
322 fixed64 rx_crc_errors = 14;
323 fixed64 bip_errors = 15;
324 fixed32 timestamp = 16;
325}
326
327message FlowStatistics {
328 fixed32 flow_id = 1;
329 fixed64 rx_bytes = 2;
330 fixed64 rx_packets = 3;
331 fixed64 tx_bytes = 8;
332 fixed64 tx_packets = 9;
333 fixed32 timestamp = 16;
334}
335
Nicolas Palpacuera32f4c32018-06-28 12:55:10 -0400336message LosIndication {
337 fixed32 intf_id = 1;
338 string status = 2;
339}
340
341message DyingGaspIndication {
342 fixed32 intf_id = 1;
343 fixed32 onu_id = 2;
344 string status = 3;
345}
346
Nicolas Palpacuerde4325b2018-07-03 11:18:42 -0400347message OnuAlarmIndication {
348 fixed32 intf_id = 1;
349 fixed32 onu_id = 2;
350 string los_status = 3;
351 string lob_status = 4;
352 string lopc_miss_status = 5;
353 string lopc_mic_error_status = 6;
354}
355
356message OnuStartupFailureIndication {
357 fixed32 intf_id = 1;
358 fixed32 onu_id = 2;
359 string status = 3;
360}
361
362message OnuSignalDegradeIndication {
363 fixed32 intf_id = 1;
364 fixed32 onu_id = 2;
365 string status = 3;
366 fixed32 inverse_bit_error_rate = 4;
367}
368
369message OnuDriftOfWindowIndication {
370 fixed32 intf_id = 1;
371 fixed32 onu_id = 2;
372 string status = 3;
373 fixed32 drift = 4;
374 fixed32 new_eqd = 5;
375}
376
377message OnuLossOfOmciChannelIndication {
378 fixed32 intf_id = 1;
379 fixed32 onu_id = 2;
380 string status = 3;
381}
382
383message OnuSignalsFailureIndication {
384 fixed32 intf_id = 1;
385 fixed32 onu_id = 2;
386 string status = 3;
387 fixed32 inverse_bit_error_rate = 4;
388}
389
390message OnuTransmissionInterferenceWarning {
391 fixed32 intf_id = 1;
392 fixed32 onu_id = 2;
393 string status = 3;
394 fixed32 drift = 4;
395}
396
397message OnuActivationFailureIndication {
398 fixed32 intf_id = 1;
399 fixed32 onu_id = 2;
400}
401
402message OnuProcessingErrorIndication {
403 fixed32 intf_id = 1;
404 fixed32 onu_id = 2;
405}
406
407
Shad Ansari19249582018-04-30 04:31:00 +0000408message Empty {}