blob: 6c946af2c3169a55eacab95c82b85d2caab5de6b [file] [log] [blame]
Zack Williams52209662019-02-07 10:15:31 -07001syntax = "proto3";
2
khenaidoo5fc5cea2021-08-11 17:39:16 -04003option go_package = "github.com/opencord/voltha-protos/v5/go/inter_container";
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +03004option java_package = "org.opencord.voltha";
William Kurkianad745652019-03-20 08:45:51 -04005
khenaidoo5fc5cea2021-08-11 17:39:16 -04006import "voltha_protos/common.proto";
7import "voltha_protos/voltha.proto";
Zack Williams52209662019-02-07 10:15:31 -07008import "voltha_protos/openflow_13.proto";
Girish Gowdra9c3e1c82021-06-01 14:29:34 -07009import "voltha_protos/tech_profile.proto";
khenaidoo5fc5cea2021-08-11 17:39:16 -040010import "voltha_protos/openolt.proto";
11import "voltha_protos/adapter.proto";
12import "voltha_protos/device.proto";
Zack Williams52209662019-02-07 10:15:31 -070013
Zack Williams52209662019-02-07 10:15:31 -070014package voltha;
15
khenaidoo5fc5cea2021-08-11 17:39:16 -040016//
17// Core-Adapter messages
18// ****
19// ****
20// ****
21message AdapterRegistration {
22 Adapter adapter = 1;
23 DeviceTypes dTypes = 2;
Zack Williams52209662019-02-07 10:15:31 -070024}
25
khenaidoo5fc5cea2021-08-11 17:39:16 -040026message ChildDeviceFilter {
27 string parent_id = 1;
28 string serial_number = 2;
29 uint32 onu_id = 3;
30 uint32 parent_port_no = 4;
Zack Williams52209662019-02-07 10:15:31 -070031}
32
khenaidoo5fc5cea2021-08-11 17:39:16 -040033message PortFilter {
34 string device_id = 1;
35 uint32 port = 2;
36 Port.PortType port_type = 3;
Zack Williams52209662019-02-07 10:15:31 -070037}
38
khenaidoo5fc5cea2021-08-11 17:39:16 -040039message DeviceDiscovery {
40 string parent_id = 1;
41 uint32 parent_port_no = 2;
42 string child_device_type = 3;
43 uint32 channel_id = 4;
44 string vendor_id = 5;
45 string serial_number = 6;
46 uint32 onu_id = 7;
Zack Williams52209662019-02-07 10:15:31 -070047}
48
khenaidoo5fc5cea2021-08-11 17:39:16 -040049message DeviceStateFilter {
50 string device_id = 1;
51 string parent_device_id = 2;
52 common.OperStatus.Types oper_status = 3;
53 common.ConnectStatus.Types conn_status = 4;
Zack Williams52209662019-02-07 10:15:31 -070054}
55
khenaidoo5fc5cea2021-08-11 17:39:16 -040056message PortState {
57 string device_id = 1;
58 Port.PortType port_type = 2;
59 uint32 port_no = 3;
60 common.OperStatus.Types oper_status = 4;
61}
62
63message PortStateFilter {
64 string device_id = 1;
65 uint32 port_type_filter = 2;
66 common.OperStatus.Types oper_status = 4;
67}
68
69message PacketIn {
70 string device_id = 1;
71 uint32 port = 2;
72 bytes packet = 3;
73}
74
75message PacketOut {
76 string device_id = 1;
77 uint32 egress_port_no = 2;
78 openflow_13.ofp_packet_out packet = 3;
79}
80
81message DeviceReason {
82 string device_id = 1;
Zack Williams52209662019-02-07 10:15:31 -070083 string reason = 2;
84}
85
khenaidoo5fc5cea2021-08-11 17:39:16 -040086message BulkFlows {
87 Device device = 1;
88 openflow_13.Flows flows = 2;
89 openflow_13.FlowGroups groups = 3;
90 voltha.FlowMetadata flow_metadata = 4;
Zack Williams52209662019-02-07 10:15:31 -070091}
92
khenaidoo5fc5cea2021-08-11 17:39:16 -040093message IncrementalFlows {
94 Device device = 1;
95 openflow_13.FlowChanges flows = 2;
96 openflow_13.FlowGroupChanges groups = 3;
97 voltha.FlowMetadata flow_metadata = 4;
Zack Williams52209662019-02-07 10:15:31 -070098}
99
khenaidoo5fc5cea2021-08-11 17:39:16 -0400100message PmConfigsInfo {
101 string device_id = 1;
102 PmConfigs pm_configs = 2;
Zack Williams52209662019-02-07 10:15:31 -0700103}
104
105message SwitchCapability {
106 openflow_13.ofp_desc desc = 1;
107 openflow_13.ofp_switch_features switch_features = 2;
108}
109
khenaidoo5fc5cea2021-08-11 17:39:16 -0400110message ImageDownloadMessage {
111 Device device = 1;
112 ImageDownload image = 2;
Zack Williams52209662019-02-07 10:15:31 -0700113}
114
khenaidoo5fc5cea2021-08-11 17:39:16 -0400115message OMCITest {
116 Device device = 1;
117 OmciTestRequest request = 2;
Zack Williams52209662019-02-07 10:15:31 -0700118}
119
khenaidoo5fc5cea2021-08-11 17:39:16 -0400120message SimulateAlarmMessage {
121 Device device = 1;
122 SimulateAlarmRequest request = 2;
Zack Williams52209662019-02-07 10:15:31 -0700123}
124
khenaidoo5fc5cea2021-08-11 17:39:16 -0400125message GetExtValueMessage {
126 Device parent_device = 1;
127 Device child_device = 2;
128 common.ValueType.Type value_type=3;
129}
130
131message SetExtValueMessage {
132 Device device = 1;
133 ValueSet value=3;
134}
135
136//
137// Inter-Adapter messages
138// ****
139// ****
140// ****
141
142message OmciMessage {
143 bytes message = 1;
Serkant Uluderyacbcfaa42019-10-18 13:25:08 +0300144 common.ConnectStatus.Types connect_status = 2;
Mahir Gunyel4b0dab22019-05-16 13:56:09 -0700145 voltha.Device.ProxyAddress proxy_address = 3;
khenaidoo5fc5cea2021-08-11 17:39:16 -0400146 string parent_device_id = 4;
147 string child_device_id = 5;
Zack Williams52209662019-02-07 10:15:31 -0700148}
149
khenaidoo5fc5cea2021-08-11 17:39:16 -0400150message TechProfileDownloadMessage {
151 string device_id = 1;
152 uint32 uni_id = 2;
153 string tp_instance_path = 3;
Girish Gowdra9c3e1c82021-06-01 14:29:34 -0700154 oneof tech_tp_instance {
khenaidoo5fc5cea2021-08-11 17:39:16 -0400155 tech_profile.TechProfileInstance tp_instance = 4; // relevant for GPON, XGPON and XGS-PON technologies
156 tech_profile.EponTechProfileInstance epon_tp_instance = 5; // relevant for EPON technology
Girish Gowdra9c3e1c82021-06-01 14:29:34 -0700157 }
Matt Jeanneret15249fa2019-04-12 20:25:31 -0400158}
159
khenaidoo5fc5cea2021-08-11 17:39:16 -0400160message DeleteGemPortMessage {
161 string device_id = 1;
162 uint32 uni_id = 2;
163 string tp_instance_path = 3;
164 uint32 gem_port_id = 4;
Girish Gowdra475e63e2019-11-20 16:42:59 +0530165}
166
khenaidoo5fc5cea2021-08-11 17:39:16 -0400167message DeleteTcontMessage {
168 string device_id = 1;
169 uint32 uni_id = 2;
170 string tp_instance_path = 3;
171 uint32 alloc_id = 4;
Girish Gowdra475e63e2019-11-20 16:42:59 +0530172}
173
khenaidoo5fc5cea2021-08-11 17:39:16 -0400174message OnuIndicationMessage {
175 string device_id = 1;
176 openolt.OnuIndication onu_indication = 2;
Zack Williams52209662019-02-07 10:15:31 -0700177}
178
khenaidoo5fc5cea2021-08-11 17:39:16 -0400179message TechProfileInstanceRequestMessage {
180 string device_id = 1;
181 string tp_instance_path = 2; // technology profile instance path
182 string parent_device_id = 3;
183 uint32 parent_pon_port = 4;
184 uint32 onu_id = 5;
185 uint32 uni_id = 6;
186}