docs: devices-- add FEATURES.yaml
[vpp.git] / src / vnet / devices / pipe / pipe.api
index d3dfd16..457bc74 100644 (file)
     the Linux kernel PIPE device driver
 */
 
-option version = "1.0.0";
+option version = "1.0.1";
 
-/** \brief Initialize a new pipe interface with the given paramters
+import "vnet/interface_types.api";
+
+/** \brief Initialize a new pipe interface with the given parameters
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param is_specified - if non-0, a specific user_instance is being requested
@@ -31,35 +33,35 @@ define pipe_create
 {
   u32 client_index;
   u32 context;
-  u8 is_specified;
+  bool is_specified;
   u32 user_instance;
 };
 
 /** \brief Reply for pipe create reply
     @param context - returned sender context, to match reply w/ request
     @param retval - return code
-    @param parent_sw_if_index - software index allocated for the new pipe parent interface
-                                Use the parent interface for link up/down and to delete
+    @param sw_if_index - software index allocated for the new pipe parent interface
+                         Use the parent interface for link up/down and to delete
     @param pipe_sw_if_index - the two SW indicies that form the ends of the pipe.
 */
 define pipe_create_reply
 {
   u32 context;
   i32 retval;
-  u32 parent_sw_if_index;
-  u32 pipe_sw_if_index[2];
+  vl_api_interface_index_t sw_if_index;
+  vl_api_interface_index_t pipe_sw_if_index[2];
 };
 
 /** \brief Delete pipe interface
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param parnet_sw_if_index - interface index of existing pipe interface
+    @param sw_if_index - interface index of existing parent pipe interface
 */
 autoreply define pipe_delete
 {
   u32 client_index;
   u32 context;
-  u32 parent_sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Dump pipe interfaces request */
@@ -71,15 +73,15 @@ define pipe_dump
 
 /** \brief Reply for pipe dump request
     @param sw_if_index - software index of pipe interface
-    @param parent_sw_if_index - software index allocated for the pipe parent interface
+    @param sw_if_index - software index allocated for the pipe parent interface
     @param pipe_sw_if_index - the two SW indicies that form the ends of the pipe.
     @param instance - instance allocated
 */
 define pipe_details
 {
   u32 context;
-  u32 parent_sw_if_index;
-  u32 pipe_sw_if_index[2];
+  vl_api_interface_index_t sw_if_index;
+  vl_api_interface_index_t pipe_sw_if_index[2];
   u32 instance;
 };