blob: 91e1fb18703ef81099a79be536d8ff72cfc33169 [file] [log] [blame]
Zack Williams52209662019-02-07 10:15:31 -07001syntax = "proto3";
2
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +03003option go_package = "github.com/opencord/voltha-protos/v3/go/common";
Zack Williams52209662019-02-07 10:15:31 -07004
William Kurkian12fc0af2019-04-18 14:27:45 -04005package common;
Zack Williams52209662019-02-07 10:15:31 -07006
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +03007option java_package = "org.opencord.voltha";
Zack Williams52209662019-02-07 10:15:31 -07008
9// Convey a resource identifier
10message ID {
11 string id = 1;
12}
13
14// Represents a list of IDs
15message IDs {
16 repeated ID items = 1;
17}
18
19enum TestModeKeys {
20 api_test=0;
21}
22
Zack Williams52209662019-02-07 10:15:31 -070023message AdminState {
Zack Williams52209662019-02-07 10:15:31 -070024 // Administrative State
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +030025 enum Types {
Zack Williams52209662019-02-07 10:15:31 -070026
27 // The administrative state of the device is unknown
28 UNKNOWN = 0;
29
30 // The device is pre-provisioned into Voltha, but not contacted by it
31 PREPROVISIONED = 1;
32
33 // The device is enabled for activation and operation
34 ENABLED = 2;
35
36 // The device is disabled and shall not perform its intended forwarding
37 // functions other than being available for re-activation.
38 DISABLED = 3;
39
40 // The device is in the state of image download
41 DOWNLOADING_IMAGE = 4;
42
43 // The device is marked to be deleted
44 DELETED = 5;
45 }
46}
47
48message OperStatus {
Zack Williams52209662019-02-07 10:15:31 -070049 // Operational Status
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +030050 enum Types {
Zack Williams52209662019-02-07 10:15:31 -070051
52 // The status of the device is unknown at this point
53 UNKNOWN = 0;
54
55 // The device has been discovered, but not yet activated
56 DISCOVERED = 1;
57
58 // The device is being activated (booted, rebooted, upgraded, etc.)
59 ACTIVATING = 2;
60
61 // Service impacting tests are being conducted
62 TESTING = 3;
63
64 // The device is up and active
65 ACTIVE = 4;
66
67 // The device has failed and cannot fulfill its intended role
68 FAILED = 5;
69 }
70}
71
72message ConnectStatus {
Zack Williams52209662019-02-07 10:15:31 -070073 // Connectivity Status
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +030074 enum Types {
Zack Williams52209662019-02-07 10:15:31 -070075
76 // The device connectivity status is unknown
77 UNKNOWN = 0;
78
79 // The device cannot be reached by Voltha
80 UNREACHABLE = 1;
81
82 // There is live communication between device and Voltha
83 REACHABLE = 2;
84 }
85}
86
87message OperationResp {
Zack Williams52209662019-02-07 10:15:31 -070088 enum OperationReturnCode {
89 OPERATION_SUCCESS = 0;
90 OPERATION_FAILURE = 1;
91 OPERATION_UNSUPPORTED = 2;
92 }
93 // Return code
94 OperationReturnCode code = 1;
95
96 // Additional Info
97 string additional_info = 2;
divyadesaid11cf312020-02-26 12:23:31 +000098}
Dinesh Belwalkared6da5e2020-02-25 11:23:57 -080099message ValueType {
100 enum Type {
101 EMPTY = 0;
102 DISTANCE = 1;
103 }
104}
105message ValueSpecifier {
106 string id = 1;
107 ValueType.Type value = 2;
108}
109
110message ReturnValues {
111 uint32 Set = 1; // Specifies what values are
112 // set/valid in return
113
114 uint32 Unsupported = 2; // Specifies requested values not
115 // supported by the device
116
117 uint32 Error = 3; // Specifies requested values not
118 // fetched because of error
119
120 uint32 Distance = 4; // Value of distance Set includes
121 // DISTANCE
122
123}