api: Add API support for marvell PP2 plugin

[vpp.git] / src / plugins / marvell / pp2 / pp2.api

diff --git a/src/plugins/marvell/pp2/pp2.api b/src/plugins/marvell/pp2/pp2.api
new file mode 100644 (file)
index 0000000..2925e69
--- /dev/null
+++ b/src/plugins/marvell/pp2/pp2.api
@@ -0,0 +1,72 @@
+/*
+ *------------------------------------------------------------------
+ * Copyright (c) 2019 Arm Limited.
+ * 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.
+ *------------------------------------------------------------------
+ */
+
+option version = "1.0.0";
+
+
+/** \brief
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param if_name - interface name
+    @param rx_q_sz - receive queue size
+    @param tx_q_sz - transmit queue size
+*/
+define mrvl_pp2_create
+{
+  u32 client_index;
+  u32 context;
+
+  u8 if_name[64];
+  u16 rx_q_sz;
+  u16 tx_q_sz;
+  option vat_help = "[name <ifname>] [rx-queue-size <size>] [tx-queue-size <size>]";
+};
+
+/** \brief
+    @param context - sender context, to match reply w/ request
+    @param retval - return value for request
+    @param sw_if_index - software index for the new pp2 interface
+*/
+
+define mrvl_pp2_create_reply
+{
+  u32 context;
+  i32 retval;
+  u32 sw_if_index;
+};
+
+
+/** \brief
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface index
+*/
+
+autoreply define mrvl_pp2_delete
+{
+  u32 client_index;
+  u32 context;
+
+  u32 sw_if_index;
+  option vat_help = "sw_if_index <sw_if_index>";
+};
+
+/*
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */