blob: 142f8e96190ba536fcd605bab10c62453b5b803a [file] [log] [blame]
Zack Williams52209662019-02-07 10:15:31 -07001syntax = "proto3";
2
Matteo Scandolob3c08ae2020-10-14 13:15:43 -07003option go_package = "github.com/opencord/voltha-protos/v4/go/voltha";
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +03004option java_package = "org.opencord.voltha";
5option java_outer_classname = "VolthaDevice";
Zack Williams52209662019-02-07 10:15:31 -07006
7package voltha;
8
9import "google/protobuf/any.proto";
10import "voltha_protos/common.proto";
11import "voltha_protos/meta.proto";
12import "voltha_protos/openflow_13.proto";
Zack Williams52209662019-02-07 10:15:31 -070013
14// A Device Type
15message DeviceType {
16
17 // Unique name for the device type
18 string id = 1;
19
William Kurkian6ea97f82019-03-13 15:51:55 -040020 // Unique vendor id for the device type applicable to ONU
Zack Williams52209662019-02-07 10:15:31 -070021 // 4 bytes of vendor id from ONU serial number
22 string vendor_id = 5;
23
24 repeated string vendor_ids = 6;
25
26 // Name of the adapter that handles device type
27 string adapter = 2;
28
William Kurkian6ea97f82019-03-13 15:51:55 -040029 // Capabilities
Zack Williams52209662019-02-07 10:15:31 -070030 bool accepts_bulk_flow_update = 3;
31 bool accepts_add_remove_flow_updates = 4;
32 bool accepts_direct_logical_flows_update = 7;
33
34}
35
36// A plurality of device types
37message DeviceTypes {
38 repeated DeviceType items = 1;
39}
40
41message PmConfig {
42 enum PmType {
43 COUNTER = 0;
44 GAUGE = 1;
45 STATE = 2;
46 CONTEXT = 3;
47 }
48 string name = 1;
49 PmType type = 2;
50 bool enabled = 3; // Whether or not this metric makes it to Kafka
51 uint32 sample_freq = 4; // Sample rate in 10ths of a second
52}
53
54message PmGroupConfig {
55 string group_name = 1;
56 uint32 group_freq = 2; // Frequency applicable to the grop
57 bool enabled = 3; // Enable/disable group level only
58 repeated PmConfig metrics = 4;
59}
60
61message PmConfigs {
62 string id = 1; // To work around a chameleon POST bug
63 uint32 default_freq = 2; // Default sample rate
64 // Forces group names and group semantics
65 bool grouped = 3 [(access) = READ_ONLY];
66 // Allows Pm to set an individual sample frequency
67 bool freq_override = 4 [(access) = READ_ONLY];
68 repeated PmGroupConfig groups = 5; // The groups if grouped is true
69 repeated PmConfig metrics = 6; // The metrics themselves if grouped is false.
Rohan Agrawal065c8182020-06-29 11:05:32 +000070 uint32 max_skew = 7; //Default value is set to 5 seconds
Zack Williams52209662019-02-07 10:15:31 -070071}
72
73// Describes instance of software image on the device
74message Image {
75 string name = 1; // software patch name
76 string version = 2; // version of software
77 string hash = 3; // md5 hash
78 string install_datetime = 4; // combined date and time expressed in UTC.
79 // use ISO 8601 format for date and time
80
81 // The active software image is one that is currently loaded and executing
82 // in the ONU or circuit pack. Under normal operation, one software image
83 // is always active while the other is inactive. Under no circumstances are
84 // both software images allowed to be active at the same time
85 bool is_active = 5; // True if the image is active
86
87 // The committed software image is loaded and executed upon reboot of the
88 // ONU and/or circuit pack. During normal operation, one software image is
89 // always committed, while the other is uncommitted.
90 bool is_committed = 6; // True if the image is committed
91
92 // A software image is valid if it has been verified to be an executable
93 // code image. The verification mechanism is not subject to standardization;
94 // however, it should include at least a data integrity (e.g., CRC) check of
95 // the entire code image.
96 bool is_valid = 7; // True if the image is valid
97}
98
99// List of software on the device
100message Images {
101 repeated Image image = 1;
102}
103
Kent Hagerman66e56b42020-07-09 14:30:23 -0400104//TODO: ImageDownload is not actively used (05/19/2020). When this is tackled, can remove extra/unnecessary fields.
Zack Williams52209662019-02-07 10:15:31 -0700105message ImageDownload {
Zack Williams52209662019-02-07 10:15:31 -0700106 enum ImageDownloadState {
107 DOWNLOAD_UNKNOWN = 0;
108 DOWNLOAD_SUCCEEDED = 1;
109 DOWNLOAD_REQUESTED = 2;
110 DOWNLOAD_STARTED = 3;
111 DOWNLOAD_FAILED = 4;
112 DOWNLOAD_UNSUPPORTED = 5;
113 DOWNLOAD_CANCELLED = 6;
114 }
115
116 enum ImageDownloadFailureReason {
117 NO_ERROR = 0;
118 INVALID_URL = 1;
119 DEVICE_BUSY = 2;
120 INSUFFICIENT_SPACE = 3;
121 UNKNOWN_ERROR = 4;
122 CANCELLED = 5;
123 }
124
125 enum ImageActivateState {
126 IMAGE_UNKNOWN = 0;
127 IMAGE_INACTIVE = 1;
William Kurkian6ea97f82019-03-13 15:51:55 -0400128 IMAGE_ACTIVATING = 2;
Zack Williams52209662019-02-07 10:15:31 -0700129 IMAGE_ACTIVE = 3;
William Kurkian6ea97f82019-03-13 15:51:55 -0400130 IMAGE_REVERTING = 4;
131 IMAGE_REVERTED = 5;
Zack Williams52209662019-02-07 10:15:31 -0700132 }
133
134 // Device Identifier
135 string id = 1;
136
137 // Image unique identifier
138 string name = 2;
139
140 // URL where the image is available
141 // should include username password
142 string url = 3;
143
144 // CRC of the image to be verified aginst
145 uint32 crc = 4;
146
147 // Download state
148 ImageDownloadState download_state = 5;
149
150 // Downloaded version
151 string image_version = 6;
152
153 // Bytes downloaded
154 uint32 downloaded_bytes = 7;
155
156 // Download failure reason
157 ImageDownloadFailureReason reason= 8;
158
159 // Additional info
160 string additional_info = 9;
161
162 // Save current configuration
163 bool save_config = 10;
164
165 // Image local location
166 string local_dir = 11;
167
168 // Image activation state
169 ImageActivateState image_state = 12;
Kent Hagerman66e56b42020-07-09 14:30:23 -0400170
Zack Williams52209662019-02-07 10:15:31 -0700171 // Image file size
172 uint32 file_size = 13;
173}
174
175message ImageDownloads {
176 repeated ImageDownload items = 2;
177}
178
179message Port {
Zack Williams52209662019-02-07 10:15:31 -0700180 enum PortType {
181 UNKNOWN = 0;
182 ETHERNET_NNI = 1;
183 ETHERNET_UNI = 2;
184 PON_OLT = 3;
185 PON_ONU = 4;
186 VENET_OLT = 5;
187 VENET_ONU = 6;
188 }
189
190 uint32 port_no = 1; // Device-unique port number
191
192 string label = 2; // Arbitrary port label
193
194 PortType type = 3; // Type of port
195
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300196 common.AdminState.Types admin_state = 5;
Zack Williams52209662019-02-07 10:15:31 -0700197
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300198 common.OperStatus.Types oper_status = 6;
Zack Williams52209662019-02-07 10:15:31 -0700199
200 string device_id = 7; // Unique .id of device that owns this port
201
202 message PeerPort {
203 string device_id = 1;
204 uint32 port_no = 2;
205 }
206 repeated PeerPort peers = 8;
207
208 fixed64 rx_packets = 9;
209 fixed64 rx_bytes = 10;
210 fixed64 rx_errors = 11;
211 fixed64 tx_packets = 12;
212 fixed64 tx_bytes = 13;
213 fixed64 tx_errors = 14;
214
khenaidooce41ea42020-06-09 18:10:16 -0400215 // ofp_port represents the characteristics of a port, e.g. hardware
216 // address and supported features. This field is relevant only for
217 // UNI and NNI ports. For PON ports, it can be left empty.
218 openflow_13.ofp_port ofp_port = 15;
Zack Williams52209662019-02-07 10:15:31 -0700219}
220
221message Ports {
222 repeated Port items = 1;
223}
224
225// A Physical Device instance
226message Device {
Zack Williams52209662019-02-07 10:15:31 -0700227 // Voltha's device identifier
228 string id = 1 [(access) = READ_ONLY];
229
230 // Device type, refers to one of the registered device types
231 string type = 2 [(access) = READ_ONLY];
232
233 // Is this device a root device. Each logical switch has one root
234 // device that is associated with the logical flow switch.
235 bool root = 3 [(access) = READ_ONLY];
236
237 // Parent device id, in the device tree (for a root device, the parent_id
238 // is the logical_device.id)
239 string parent_id = 4 [(access) = READ_ONLY];
240 uint32 parent_port_no = 20 [(access) = READ_ONLY];
241
242 // Vendor, version, serial number, etc.
243 string vendor = 5 [(access) = READ_ONLY];
244 string model = 6 [(access) = READ_ONLY];
245 string hardware_version = 7 [(access) = READ_ONLY];
246 string firmware_version = 8 [(access) = READ_ONLY];
247 // List of software on the device
248 Images images = 9 [(access) = READ_ONLY];
249 string serial_number = 10 [(access) = READ_ONLY];
250 string vendor_id = 24 [(access) = READ_ONLY];
251
252 // Addapter that takes care of device
253 string adapter = 11 [(access) = READ_ONLY];
254
255 // Device contact on vlan (if 0, no vlan)
256 uint32 vlan = 12;
257
258 message ProxyAddress {
259 string device_id = 1; // Which device to use as proxy to this device
260 string device_type = 2; // The device type of the proxy device to use as the adapter name
261 uint32 channel_id = 3; // Sub-address within proxy
262 uint32 channel_group_id = 4; // Channel Group index
263 string channel_termination = 5; // Channel Termination name
264 uint32 onu_id = 6; // onu identifier; optional
265 uint32 onu_session_id = 7; // session identifier for the ONU; optional
266 };
267
William Kurkian6ea97f82019-03-13 15:51:55 -0400268 // Device contact MAC address (format: "xx:xx:xx:xx:xx:xx")
269 string mac_address = 13;
270
Zack Williams52209662019-02-07 10:15:31 -0700271 oneof address {
Zack Williams52209662019-02-07 10:15:31 -0700272
273 // Device contact IPv4 address (format: "a.b.c.d" or can use hostname too)
274 string ipv4_address = 14;
275
276 // Device contact IPv6 address using the canonical string form
277 // ("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx")
278 string ipv6_address = 15;
279
280 string host_and_port = 21;
281
282 };
283 string extra_args = 23; // Used to pass additional device specific arguments
284
285 ProxyAddress proxy_address = 19;
286
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300287 common.AdminState.Types admin_state = 16;
Zack Williams52209662019-02-07 10:15:31 -0700288
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300289 common.OperStatus.Types oper_status = 17 [(access) = READ_ONLY];
Zack Williams52209662019-02-07 10:15:31 -0700290
291 string reason = 22 [(access) = READ_ONLY]; // Used in FAILED state
292
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300293 common.ConnectStatus.Types connect_status = 18 [(access) = READ_ONLY];
Zack Williams52209662019-02-07 10:15:31 -0700294
295 // TODO additional common attribute here
296
297 // Device type specific attributes
298 google.protobuf.Any custom = 64;
299
Zack Williams52209662019-02-07 10:15:31 -0700300 // PmConfigs will eventually converted to a child node of the
301 // device to falicitata callbacks and to simplify manipulation.
302 PmConfigs pm_configs = 131 [(child_node) = {}];
303
304 repeated ImageDownload image_downloads = 133 [(child_node) = {key: "name"}];
305}
306
307message Devices {
308 repeated Device items = 1;
309}
310
311message SimulateAlarmRequest {
312 enum OperationType {
313 RAISE = 0;
314 CLEAR = 1;
315 }
316 // Device Identifier
317 string id = 1;
318 string indicator = 2;
319 string intf_id = 3;
320 string port_type_name = 4;
321 string onu_device_id = 5;
322 int32 inverse_bit_error_rate = 6;
323 int32 drift = 7;
324 int32 new_eqd = 8;
325 string onu_serial_number = 9;
326 OperationType operation = 10;
327}