blob: 0eea20bd4ffb783e092987dc3af16491a4527d07 [file] [log] [blame]
amit.ghosh9f6af0e2020-11-04 14:09:25 +01001// 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";
16
khenaidoo5fc5cea2021-08-11 17:39:16 -040017option go_package = "github.com/opencord/voltha-protos/v5/go/extension";
amit.ghosh9f6af0e2020-11-04 14:09:25 +010018option java_package = "org.opencord.voltha.extension";
19
20package extension;
21
khenaidoo4c6543e2021-10-19 17:25:58 -040022import "voltha_protos/ext_config.proto";
kesavand763d8002021-01-04 16:24:42 +053023import "google/protobuf/empty.proto";
amit.ghosh9f6af0e2020-11-04 14:09:25 +010024
khenaidoo4c6543e2021-10-19 17:25:58 -040025message ValueSet {
26 string id = 1;
27 oneof value{
28 config.AlarmConfig alarm_config = 2;
29 }
30}
31
32message ValueType {
33 enum Type {
34 EMPTY = 0;
35 DISTANCE = 1;
36 }
37}
38
39message ValueSpecifier {
40 string id = 1;
41 ValueType.Type value = 2;
42}
43
44message ReturnValues {
45 uint32 Set = 1; // Specifies what values are
46 // set/valid in return
47
48 uint32 Unsupported = 2; // Specifies requested values not
49 // supported by the device
50
51 uint32 Error = 3; // Specifies requested values not
52 // fetched because of error
53
54 uint32 Distance = 4; // Value of distance Set includes
55 // DISTANCE
56
57}
58
amit.ghosh9f6af0e2020-11-04 14:09:25 +010059message GetDistanceRequest {
60 string onuDeviceId = 1;
61}
62
63message GetDistanceResponse {
64 uint32 distance = 1; // distance in meters
65}
66
67message GetOnuUniInfoRequest {
68 uint32 uniIndex = 1; // Index of the uni starting from 0
69}
70
71message GetOnuUniInfoResponse {
72 enum ConfigurationInd {
73 UNKOWN = 0;
74 TEN_BASE_T_FDX = 1;
75 HUNDRED_BASE_T_FDX = 2;
76 GIGABIT_ETHERNET_FDX = 3;
77 TEN_G_ETHERNET_FDX = 4;
78 TEN_BASE_T_HDX = 5;
79 HUNDRED_BASE_T_HDX = 6;
80 GIGABIT_ETHERNET_HDX = 7;
81 }
82
83 enum AdministrativeState {
84 ADMSTATE_UNDEFINED = 0;
85 LOCKED = 1;
86 UNLOCKED = 2;
87 }
88
89 enum OperationalState {
90 OPERSTATE_UNDEFINED = 0;
91 ENABLED = 1;
92 DISABLED = 2;
93 }
94
95 AdministrativeState admState = 1;
96 OperationalState operState = 2;
97 ConfigurationInd configInd = 3;
98}
99
kesavand763d8002021-01-04 16:24:42 +0530100message GetOltPortCounters {
101 enum PortType {
102 Port_UNKNOWN = 0;
103 Port_ETHERNET_NNI = 1;
104 Port_PON_OLT = 2;
105 }
106 uint32 portNo = 1; // Device-unique port number
107 PortType portType = 2;
108}
109
110message GetOltPortCountersResponse {
111 uint64 txBytes = 1;
112 uint64 rxBytes = 2;
113 uint64 txPackets = 3;
114 uint64 rxPackets = 4;
115 uint64 txErrorPackets = 5;
116 uint64 rxErrorPackets = 6;
117 uint64 txBcastPackets = 7;
118 uint64 rxBcastPackets = 8;
119 uint64 txUcastPackets = 9;
120 uint64 rxUcastPackets = 10;
121 uint64 txMcastPackets = 11;
122 uint64 rxMcastPackets = 12;
123}
124
125message GetOnuPonOpticalInfo {
126 google.protobuf.Empty empty = 1;
127}
128
Girish Gowdrab1d742d2021-05-01 15:34:32 -0700129// These values correspond to the Optical Line Supervision Test results
130// described in section A3.39.5 of ITU-T G.988 (11/2017) specification.
kesavand763d8002021-01-04 16:24:42 +0530131message GetOnuPonOpticalInfoResponse{
Girish Gowdrab1d742d2021-05-01 15:34:32 -0700132 float powerFeedVoltage = 1; // unit of value is voltage
133 float receivedOpticalPower = 2; // unit of value is dBm
134 float meanOpticalLaunchPower = 3; // unit of value is dBm
Girish Gowdrabce9ea72021-05-05 08:47:49 -0700135 float laserBiasCurrent = 4; // unit of value is milli-amphere (mA)
Girish Gowdrab1d742d2021-05-01 15:34:32 -0700136 float temperature = 5; // unit of value is degree celsius
kesavand763d8002021-01-04 16:24:42 +0530137}
138
139message GetOnuEthernetBridgePortHistory {
140 enum Direction {
141 UNDEFINED = 0;
142 UPSTREAM = 1;
143 DOWNSTREAM = 2;
144 }
145 Direction direction = 1;
146}
147
148message GetOnuEthernetBridgePortHistoryResponse {
149 uint32 dropEvents = 1;
150 uint32 octets = 2;
151 uint32 packets= 3;
152 uint32 broadcastPackets = 4;
153 uint32 multicastPackets = 5;
154 uint32 crcErroredPackets = 6;
155 uint32 undersizePackets = 7;
156 uint32 oversizePackets = 8;
157 uint32 packets64octets = 9;
158 uint32 packets65To127octets = 10;
159 uint32 packets128To255Octets = 11;
160 uint32 packets256To511octets = 12;
161 uint32 packets512To1023octets = 13;
162 uint32 packets1024To1518octets = 14;
163}
164
165message GetOnuFecHistory {
166 google.protobuf.Empty empty = 1;
167}
168
169message GetOnuFecHistoryResponse {
170 uint32 correctedBytes = 1;
171 uint32 correctedCodeWords = 2;
172 uint32 fecSeconds = 3;
173 uint32 totalCodeWords = 4;
174 uint32 uncorrectableCodeWords = 5;
175}
176
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530177message GetOnuCountersRequest {
178 fixed32 intf_id = 1;
179 fixed32 onu_id = 2;
180}
181
Himani Chawla9a497392021-05-28 13:04:42 +0530182message GetOmciEthernetFrameExtendedPmRequest {
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530183 string onuDeviceId = 1;
Himani Chawla393605c2021-08-30 13:44:13 +0530184 oneof is_uni_index {
185 uint32 uniIndex = 2; // Index of the uni starting from 0
186 }
187 bool reset = 3;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530188}
189
amit.ghosh8490b122022-11-28 15:45:04 +0100190// DEPRECATED
Gamze Abaka08683072021-05-26 13:38:02 +0000191message GetRxPowerRequest {
192 fixed32 intf_id = 1;
193 fixed32 onu_id = 2;
194}
195
amit.ghosh8490b122022-11-28 15:45:04 +0100196message GetOltRxPowerRequest {
197 string port_label = 1;
198 // onu_sn is optional and if onu_sn is an empty string and the label is
199 // of a PON port then it means that the Rx Power corresponding to all
200 // the ONUs on that PON port is requested. In case the port_label is not
201 // of a PON port, the onu_sn does not have any significance
202 string onu_sn = 2;
203}
204
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530205message GetOnuCountersResponse {
206 oneof is_intf_id {
207 fixed32 intf_id = 1;
208 }
209 oneof is_onu_id {
210 fixed32 onu_id = 2;
211 }
212 oneof is_positive_drift {
213 fixed64 positive_drift = 3;
214 }
215 oneof is_negative_drift {
216 fixed64 negative_drift = 4;
217 }
218 oneof is_delimiter_miss_detection {
219 fixed64 delimiter_miss_detection = 5;
220 }
221 oneof is_bip_errors {
222 fixed64 bip_errors = 6;
223 }
224 oneof is_bip_units {
225 fixed64 bip_units = 7;
226 }
227 oneof is_fec_corrected_symbols {
228 fixed64 fec_corrected_symbols = 8;
229 }
230 oneof is_fec_codewords_corrected {
231 fixed64 fec_codewords_corrected = 9;
232 }
233 oneof is_fec_codewords_uncorrectable {
234 fixed64 fec_codewords_uncorrectable = 10;
235 }
236 oneof is_fec_codewords {
237 fixed64 fec_codewords = 11;
238 }
239 oneof is_fec_corrected_units {
240 fixed64 fec_corrected_units = 12;
241 }
242 oneof is_xgem_key_errors {
243 fixed64 xgem_key_errors = 13;
244 }
245 oneof is_xgem_loss {
246 fixed64 xgem_loss = 14;
247 }
248 oneof is_rx_ploams_error {
249 fixed64 rx_ploams_error = 15;
250 }
251 oneof is_rx_ploams_non_idle {
252 fixed64 rx_ploams_non_idle = 16;
253 }
254 oneof is_rx_omci {
255 fixed64 rx_omci = 17;
256 }
257 oneof is_tx_omci {
258 fixed64 tx_omci = 18;
259 }
260 oneof is_rx_omci_packets_crc_error {
261 fixed64 rx_omci_packets_crc_error = 19;
262 }
263 oneof is_rx_bytes {
264 fixed64 rx_bytes = 20;
265 }
266 oneof is_rx_packets {
267 fixed64 rx_packets = 21;
268 }
269 oneof is_tx_bytes {
270 fixed64 tx_bytes = 22;
271 }
272 oneof is_tx_packets {
273 fixed64 tx_packets = 23;
274 }
275 oneof is_ber_reported {
276 fixed64 ber_reported = 24;
277 }
278 oneof is_lcdg_errors {
279 fixed64 lcdg_errors = 25;
280 }
281 oneof is_rdi_errors {
282 fixed64 rdi_errors = 26;
283 }
284 oneof is_timestamp {
285 // reported timestamp in seconds since epoch
286 fixed32 timestamp = 27;
287 }
288}
289
Himani Chawla9a497392021-05-28 13:04:42 +0530290message OmciEthernetFrameExtendedPm {
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530291 fixed64 drop_events = 1;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530292 fixed64 octets = 2;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530293 fixed64 frames = 3;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530294 fixed64 broadcast_frames = 4;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530295 fixed64 multicast_frames = 5;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530296 fixed64 crc_errored_frames = 6;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530297 fixed64 undersize_frames = 7;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530298 fixed64 oversize_frames = 8;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530299 fixed64 frames_64_octets = 9;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530300 fixed64 frames_65_to_127_octets = 10;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530301 fixed64 frames_128_to_255_octets = 11;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530302 fixed64 frames_256_to_511_octets = 12;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530303 fixed64 frames_512_to_1023_octets = 13;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530304 fixed64 frames_1024_to_1518_octets = 14;
Himani Chawla9a497392021-05-28 13:04:42 +0530305}
306
307message GetOmciEthernetFrameExtendedPmResponse {
Himani Chawla654f7f32021-08-25 16:31:24 +0530308 enum Format {
309 THIRTY_TWO_BIT = 0;
310 SIXTY_FOUR_BIT = 1;
311 }
Himani Chawla9a497392021-05-28 13:04:42 +0530312 OmciEthernetFrameExtendedPm upstream = 1;
313 OmciEthernetFrameExtendedPm downstream = 2;
Himani Chawla654f7f32021-08-25 16:31:24 +0530314 Format omci_ethernet_frame_extended_pm_format= 3;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530315}
316
amit.ghosh8490b122022-11-28 15:45:04 +0100317message RxPower {
318 string onu_sn = 1; // if the port on which RxPower is measured is not a PON port this will be empty ("") string
319 string status = 2;
320 string fail_reason = 3;
321 double rx_power = 4;
322}
323
324message GetOltRxPowerResponse {
325 string port_label= 1;
326 repeated RxPower rx_power = 2;
327}
328
329// DEPRECATED
Gamze Abaka08683072021-05-26 13:38:02 +0000330message GetRxPowerResponse {
331 fixed32 intf_id= 1;
332 fixed32 onu_id = 2;
333 string status = 3;
334 string fail_reason = 4;
335 double rx_power = 5;
336}
337
Holger Hildebrandt3374b882022-09-06 11:40:16 +0000338message GetOnuOmciTxRxStatsRequest{
339 google.protobuf.Empty empty = 1;
340}
341
342// see ITU-T G.988 clause 11.2.2
343message GetOnuOmciTxRxStatsResponse {
344 // OMCI baseline Tx frames with AR bit set
345 uint32 base_tx_ar_frames = 1;
346 // OMCI baseline Rx frames with AK bit set
347 uint32 base_rx_ak_frames = 2;
348 // OMCI baseline Tx frames with AR bit unset
349 uint32 base_tx_no_ar_frames = 3;
350 // OMCI baseline Rx frames with AK bit unset
351 uint32 base_rx_no_ak_frames = 4;
352 // OMCI extended Tx frames with AR bit set
353 uint32 ext_tx_ar_frames = 5;
354 // OMCI extended Rx frames with AK bit set
355 uint32 ext_rx_ak_frames = 6;
356 // OMCI extended Tx frames with AR bit unset
357 uint32 ext_tx_no_ar_frames = 7;
358 // OMCI extended Rx frames with AK bit unset
359 uint32 ext_rx_no_ak_frames = 8;
360 // Number of retries of requests (tx) due to not received responses (Rx)
361 uint32 tx_omci_counter_retries = 9;
362 // Number of timeouts of requests (tx) due to not received responses (Rx) after configured number of retries
363 uint32 tx_omci_counter_timeouts = 10;
364}
365
amit.ghosh9f6af0e2020-11-04 14:09:25 +0100366message GetValueRequest {
367 oneof request {
368 GetDistanceRequest distance = 1;
369 GetOnuUniInfoRequest uniInfo = 2;
kesavand763d8002021-01-04 16:24:42 +0530370 // Corresponds to PmMetricId.PON_PORT_COUNTERS, PmMetricId.NNI_PORT_COUNTERS
371 GetOltPortCounters oltPortInfo = 3;
372 // Corresponds to PmMetricId.PON_OPTICAL
373 GetOnuPonOpticalInfo onuOpticalInfo = 4;
374 // Corresponds to PmMetricId.ETHERNET_BRIDGE_PORT_HISTORY
375 GetOnuEthernetBridgePortHistory ethBridgePort = 5;
376 // Corresponds to PmMetricId.FEC_HISTORY
Gamze Abaka08683072021-05-26 13:38:02 +0000377 GetOnuFecHistory fecHistory = 6;
378 GetOnuCountersRequest onuPonInfo = 7;
Himani Chawla9a497392021-05-28 13:04:42 +0530379 GetOmciEthernetFrameExtendedPmRequest onuInfo = 8;
amit.ghosh8490b122022-11-28 15:45:04 +0100380 GetRxPowerRequest rxPower = 9; // This is deprecated
Holger Hildebrandt3374b882022-09-06 11:40:16 +0000381 GetOnuOmciTxRxStatsRequest onuOmciStats = 10;
amit.ghosh8490b122022-11-28 15:45:04 +0100382 GetOltRxPowerRequest oltRxPower = 11;
amit.ghosh9f6af0e2020-11-04 14:09:25 +0100383 }
384}
385
386message GetValueResponse {
387 enum Status {
388 STATUS_UNDEFINED = 0;
389 OK = 1;
390 ERROR = 2;
391 }
392
393 enum ErrorReason {
394 REASON_UNDEFINED = 0;
395 UNSUPPORTED = 1;
kesavand763d8002021-01-04 16:24:42 +0530396 INVALID_DEVICE_ID = 2;
397 INVALID_PORT_TYPE = 3;
398 TIMEOUT = 4;
399 INVALID_REQ_TYPE = 5;
Himani Chawlae5bb7ca2021-05-17 15:48:32 +0530400 INTERNAL_ERROR = 6;
401 INVALID_DEVICE = 7;
amit.ghosh9f6af0e2020-11-04 14:09:25 +0100402 }
403 Status status = 1;
404 ErrorReason errReason = 2;
405
406 oneof response {
407 GetDistanceResponse distance = 3;
408 GetOnuUniInfoResponse uniInfo = 4;
kesavand763d8002021-01-04 16:24:42 +0530409 GetOltPortCountersResponse portCoutners = 5;
410 GetOnuPonOpticalInfoResponse onuOpticalInfo = 6;
411 GetOnuEthernetBridgePortHistoryResponse ethBridgePortInfo = 7;
412 GetOnuFecHistoryResponse fecHistory = 8;
Gamze Abaka08683072021-05-26 13:38:02 +0000413 GetOnuCountersResponse onuPonCounters = 9;
Himani Chawla9a497392021-05-28 13:04:42 +0530414 GetOmciEthernetFrameExtendedPmResponse onuCounters = 10;
amit.ghosh8490b122022-11-28 15:45:04 +0100415 GetRxPowerResponse rxPower = 11; // This is DEPRECATED
Holger Hildebrandt3374b882022-09-06 11:40:16 +0000416 GetOnuOmciTxRxStatsResponse onuOmciStats = 12;
amit.ghosh8490b122022-11-28 15:45:04 +0100417 GetOltRxPowerResponse oltRxPower = 13;
amit.ghosh9f6af0e2020-11-04 14:09:25 +0100418 }
419}
420
421message SetValueRequest {
422 oneof request {
423 config.AlarmConfig alarm_config = 1;
424 }
425}
426
427message SetValueResponse {
428 enum Status {
429 STATUS_UNDEFINED = 0;
430 OK = 1;
431 ERROR = 2;
432 }
433
434 enum ErrorReason {
435 REASON_UNDEFINED = 0;
436 UNSUPPORTED = 1;
437 }
438 Status status = 1;
439 ErrorReason errReason = 2;
440
441 // As of now we don't have any explicit response for the supported SetValueRequests
442 // to be used later
443 //oneof response {
444 //
445 //}
446}
447
448message SingleGetValueRequest {
449 string targetId = 1;
450 GetValueRequest request = 2;
451}
452
453message SingleGetValueResponse{
454 GetValueResponse response = 1;
455}
456
457message SingleSetValueRequest {
458 string targetId = 1;
459 SetValueRequest request = 2;
460}
461message SingleSetValueResponse {
462 SetValueResponse response = 1;
463}
464
465// Extension is a service to get and set specific attributes
466service Extension {
467 // Get a single attribute
468 rpc GetExtValue(SingleGetValueRequest) returns (SingleGetValueResponse);
469 // Set a single attribute
470 rpc SetExtValue(SingleSetValueRequest) returns (SingleSetValueResponse);
471}