blob: 0baf1bce7b4ce8ca7a7efdddb11a2499adcb9ce7 [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/voltha";
4option 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
104message ImageDownload {
Zack Williams52209662019-02-07 10:15:31 -0700105 enum ImageDownloadState {
106 DOWNLOAD_UNKNOWN = 0;
107 DOWNLOAD_SUCCEEDED = 1;
108 DOWNLOAD_REQUESTED = 2;
109 DOWNLOAD_STARTED = 3;
110 DOWNLOAD_FAILED = 4;
111 DOWNLOAD_UNSUPPORTED = 5;
112 DOWNLOAD_CANCELLED = 6;
113 }
114
115 enum ImageDownloadFailureReason {
116 NO_ERROR = 0;
117 INVALID_URL = 1;
118 DEVICE_BUSY = 2;
119 INSUFFICIENT_SPACE = 3;
120 UNKNOWN_ERROR = 4;
121 CANCELLED = 5;
122 }
123
124 enum ImageActivateState {
125 IMAGE_UNKNOWN = 0;
126 IMAGE_INACTIVE = 1;
William Kurkian6ea97f82019-03-13 15:51:55 -0400127 IMAGE_ACTIVATING = 2;
Zack Williams52209662019-02-07 10:15:31 -0700128 IMAGE_ACTIVE = 3;
William Kurkian6ea97f82019-03-13 15:51:55 -0400129 IMAGE_REVERTING = 4;
130 IMAGE_REVERTED = 5;
Zack Williams52209662019-02-07 10:15:31 -0700131 }
132
133 // Device Identifier
134 string id = 1;
135
136 // Image unique identifier
137 string name = 2;
138
139 // URL where the image is available
140 // should include username password
141 string url = 3;
142
143 // CRC of the image to be verified aginst
144 uint32 crc = 4;
145
146 // Download state
147 ImageDownloadState download_state = 5;
148
149 // Downloaded version
150 string image_version = 6;
151
152 // Bytes downloaded
153 uint32 downloaded_bytes = 7;
154
155 // Download failure reason
156 ImageDownloadFailureReason reason= 8;
157
158 // Additional info
159 string additional_info = 9;
160
161 // Save current configuration
162 bool save_config = 10;
163
164 // Image local location
165 string local_dir = 11;
166
167 // Image activation state
168 ImageActivateState image_state = 12;
169
170 // Image file size
171 uint32 file_size = 13;
172}
173
174message ImageDownloads {
175 repeated ImageDownload items = 2;
176}
177
178message Port {
Zack Williams52209662019-02-07 10:15:31 -0700179 enum PortType {
180 UNKNOWN = 0;
181 ETHERNET_NNI = 1;
182 ETHERNET_UNI = 2;
183 PON_OLT = 3;
184 PON_ONU = 4;
185 VENET_OLT = 5;
186 VENET_ONU = 6;
187 }
188
189 uint32 port_no = 1; // Device-unique port number
190
191 string label = 2; // Arbitrary port label
192
193 PortType type = 3; // Type of port
194
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300195 common.AdminState.Types admin_state = 5;
Zack Williams52209662019-02-07 10:15:31 -0700196
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300197 common.OperStatus.Types oper_status = 6;
Zack Williams52209662019-02-07 10:15:31 -0700198
199 string device_id = 7; // Unique .id of device that owns this port
200
201 message PeerPort {
202 string device_id = 1;
203 uint32 port_no = 2;
204 }
205 repeated PeerPort peers = 8;
206
207 fixed64 rx_packets = 9;
208 fixed64 rx_bytes = 10;
209 fixed64 rx_errors = 11;
210 fixed64 tx_packets = 12;
211 fixed64 tx_bytes = 13;
212 fixed64 tx_errors = 14;
213
khenaidooce41ea42020-06-09 18:10:16 -0400214 // ofp_port represents the characteristics of a port, e.g. hardware
215 // address and supported features. This field is relevant only for
216 // UNI and NNI ports. For PON ports, it can be left empty.
217 openflow_13.ofp_port ofp_port = 15;
Zack Williams52209662019-02-07 10:15:31 -0700218}
219
220message Ports {
221 repeated Port items = 1;
222}
223
224// A Physical Device instance
225message Device {
Zack Williams52209662019-02-07 10:15:31 -0700226 // Voltha's device identifier
227 string id = 1 [(access) = READ_ONLY];
228
229 // Device type, refers to one of the registered device types
230 string type = 2 [(access) = READ_ONLY];
231
232 // Is this device a root device. Each logical switch has one root
233 // device that is associated with the logical flow switch.
234 bool root = 3 [(access) = READ_ONLY];
235
236 // Parent device id, in the device tree (for a root device, the parent_id
237 // is the logical_device.id)
238 string parent_id = 4 [(access) = READ_ONLY];
239 uint32 parent_port_no = 20 [(access) = READ_ONLY];
240
241 // Vendor, version, serial number, etc.
242 string vendor = 5 [(access) = READ_ONLY];
243 string model = 6 [(access) = READ_ONLY];
244 string hardware_version = 7 [(access) = READ_ONLY];
245 string firmware_version = 8 [(access) = READ_ONLY];
246 // List of software on the device
247 Images images = 9 [(access) = READ_ONLY];
248 string serial_number = 10 [(access) = READ_ONLY];
249 string vendor_id = 24 [(access) = READ_ONLY];
250
251 // Addapter that takes care of device
252 string adapter = 11 [(access) = READ_ONLY];
253
254 // Device contact on vlan (if 0, no vlan)
255 uint32 vlan = 12;
256
257 message ProxyAddress {
258 string device_id = 1; // Which device to use as proxy to this device
259 string device_type = 2; // The device type of the proxy device to use as the adapter name
260 uint32 channel_id = 3; // Sub-address within proxy
261 uint32 channel_group_id = 4; // Channel Group index
262 string channel_termination = 5; // Channel Termination name
263 uint32 onu_id = 6; // onu identifier; optional
264 uint32 onu_session_id = 7; // session identifier for the ONU; optional
265 };
266
William Kurkian6ea97f82019-03-13 15:51:55 -0400267 // Device contact MAC address (format: "xx:xx:xx:xx:xx:xx")
268 string mac_address = 13;
269
Zack Williams52209662019-02-07 10:15:31 -0700270 oneof address {
Zack Williams52209662019-02-07 10:15:31 -0700271
272 // Device contact IPv4 address (format: "a.b.c.d" or can use hostname too)
273 string ipv4_address = 14;
274
275 // Device contact IPv6 address using the canonical string form
276 // ("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx")
277 string ipv6_address = 15;
278
279 string host_and_port = 21;
280
281 };
282 string extra_args = 23; // Used to pass additional device specific arguments
283
284 ProxyAddress proxy_address = 19;
285
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300286 common.AdminState.Types admin_state = 16;
Zack Williams52209662019-02-07 10:15:31 -0700287
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300288 common.OperStatus.Types oper_status = 17 [(access) = READ_ONLY];
Zack Williams52209662019-02-07 10:15:31 -0700289
290 string reason = 22 [(access) = READ_ONLY]; // Used in FAILED state
291
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300292 common.ConnectStatus.Types connect_status = 18 [(access) = READ_ONLY];
Zack Williams52209662019-02-07 10:15:31 -0700293
294 // TODO additional common attribute here
295
296 // Device type specific attributes
297 google.protobuf.Any custom = 64;
298
299 repeated Port ports = 128 [(child_node) = {key: "port_no"}];
300 openflow_13.Flows flows = 129 [(child_node) = {}];
301 openflow_13.FlowGroups flow_groups = 130 [(child_node) = {}];
302 // PmConfigs will eventually converted to a child node of the
303 // device to falicitata callbacks and to simplify manipulation.
304 PmConfigs pm_configs = 131 [(child_node) = {}];
305
306 repeated ImageDownload image_downloads = 133 [(child_node) = {key: "name"}];
307}
308
309message Devices {
310 repeated Device items = 1;
311}
312
313message SimulateAlarmRequest {
314 enum OperationType {
315 RAISE = 0;
316 CLEAR = 1;
317 }
318 // Device Identifier
319 string id = 1;
320 string indicator = 2;
321 string intf_id = 3;
322 string port_type_name = 4;
323 string onu_device_id = 5;
324 int32 inverse_bit_error_rate = 6;
325 int32 drift = 7;
326 int32 new_eqd = 8;
327 string onu_serial_number = 9;
328 OperationType operation = 10;
329}