blob: fc572473d475dfff1b7f15f491cd3af7330a1e4f [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001/*
2 * Copyright 2018-present Open Networking Foundation
3
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7
8 * http://www.apache.org/licenses/LICENSE-2.0
9
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package adapters
17
18import (
serkant.uluderyab38671c2019-11-01 09:35:38 -070019 ic "github.com/opencord/voltha-protos/v3/go/inter_container"
20 "github.com/opencord/voltha-protos/v3/go/openflow_13"
21 "github.com/opencord/voltha-protos/v3/go/voltha"
Scott Baker2c1c4822019-10-16 11:02:41 -070022)
23
24//IAdapter represents the set of APIs a voltha adapter has to support.
25type IAdapter interface {
26 Adapter_descriptor() error
27 Device_types() (*voltha.DeviceTypes, error)
28 Health() (*voltha.HealthStatus, error)
29 Adopt_device(device *voltha.Device) error
30 Reconcile_device(device *voltha.Device) error
31 Abandon_device(device *voltha.Device) error
32 Disable_device(device *voltha.Device) error
33 Reenable_device(device *voltha.Device) error
34 Reboot_device(device *voltha.Device) error
35 Self_test_device(device *voltha.Device) error
36 Delete_device(device *voltha.Device) error
37 Get_device_details(device *voltha.Device) error
38 Update_flows_bulk(device *voltha.Device, flows *voltha.Flows, groups *voltha.FlowGroups, flowMetadata *voltha.FlowMetadata) error
39 Update_flows_incrementally(device *voltha.Device, flows *openflow_13.FlowChanges, groups *openflow_13.FlowGroupChanges, flowMetadata *voltha.FlowMetadata) error
40 Update_pm_config(device *voltha.Device, pm_configs *voltha.PmConfigs) error
41 Receive_packet_out(deviceId string, egress_port_no int, msg *openflow_13.OfpPacketOut) error
Devmalya Paulf65a8ce2019-11-14 07:17:06 +000042 Suppress_event(filter *voltha.EventFilter) error
43 Unsuppress_event(filter *voltha.EventFilter) error
Scott Baker2c1c4822019-10-16 11:02:41 -070044 Get_ofp_device_info(device *voltha.Device) (*ic.SwitchCapability, error)
45 Get_ofp_port_info(device *voltha.Device, port_no int64) (*ic.PortCapability, error)
46 Process_inter_adapter_message(msg *ic.InterAdapterMessage) error
47 Download_image(device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error)
48 Get_image_download_status(device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error)
49 Cancel_image_download(device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error)
50 Activate_image_update(device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error)
51 Revert_image_update(device *voltha.Device, request *voltha.ImageDownload) (*voltha.ImageDownload, error)
kesavandf17f7922020-02-03 17:00:27 -050052 Enable_port(deviceId string, port *voltha.Port) error
53 Disable_port(deviceId string, port *voltha.Port) error
Chaitrashree G Sc4a5c072020-02-04 17:08:40 -050054 Child_device_lost(parentDeviceId string, parentPortNo uint32, onuID uint32) error
Scott Baker2c1c4822019-10-16 11:02:41 -070055}