bond: Add bonding driver and LACP protocol
[vpp.git] / src / plugins / lacp / lacp.api
diff --git a/src/plugins/lacp/lacp.api b/src/plugins/lacp/lacp.api
new file mode 100644 (file)
index 0000000..9eb5c7e
--- /dev/null
@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** \file
+
+    This file defines vpe control-plane API messages for
+    the bonding device driver
+*/
+
+option version = "1.0.0";
+
+/** \brief Dump lacp interfaces request */
+define sw_interface_lacp_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Reply for lacp dump request
+    @param sw_if_index - software index of slave interface
+    @param interface_name - name of slave interface
+    @param rx_state - rx machine state
+    @param tx_state - tx machine state
+    @param mux_state - mux machine state
+    @param ptx_state - ptx machine state
+    @param bond_interface_name - name of bond interface
+    @param actor_system_priority - actor system priority
+    @param actor_system - actor system
+    @param actor_key - actor key
+    @param actor_port_priority - actor port priority
+    @param actor_port_number - actor port number
+    @param actor_state - actor state
+    @param partner_system_priority - partner system priority
+    @param partner_system - partner system
+    @param partner_key - partner key
+    @param partner_port_priority - partner port priority
+    @param partner_port_number - partner port number
+    @param partner_state - partner state
+*/
+define sw_interface_lacp_details
+{
+  u32 context;
+  u32 sw_if_index;
+  u8 interface_name[64];
+  u32 rx_state;
+  u32 tx_state;
+  u32 mux_state;
+  u32 ptx_state;
+  u8 bond_interface_name[64];
+  u16 actor_system_priority;
+  u8 actor_system[6];
+  u16 actor_key;
+  u16 actor_port_priority;
+  u16 actor_port_number;
+  u8 actor_state;
+  u16 partner_system_priority;
+  u8 partner_system[6];
+  u16 partner_key;
+  u16 partner_port_priority;
+  u16 partner_port_number;
+  u8 partner_state;
+};
+
+/*
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */