vppapigen: support per-file (major,minor,patch) version stamps
[vpp.git] / src / plugins / memif / memif.api
index b0a351a..08d056f 100644 (file)
  * limitations under the License.
  */
 
+vl_api_version 1.0.0
+
 /** \brief Create memory interface
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param role - role of the interface in the connection (master/slave)
+    @param mode - interface mode
     @param rx_queues - number of rx queues (only valid for slave)
     #param tx_queues - number of tx queues (only valid for slave)
-    @param key - 64bit integer used to authenticate and match opposite sides
+    @param id - 32bit integer used to authenticate and match opposite sides
            of the connection
     @param socket_filename - filename of the socket to be used for connection
            establishment
@@ -33,12 +36,12 @@ define memif_create
   u32 context;
 
   u8 role; /* 0 = master, 1 = slave */
+  u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
   u8 rx_queues; /* optional, default is 1 */
   u8 tx_queues; /* optional, default is 1 */
-  u64 key; /* optional, default is 0 */
-  u8 socket_filename[128]; /* optional, default is "/var/vpp/memif.sock"
-                              and can be changed in VPP startup config */
-
+  u32 id; /* optional, default is 0 */
+  u8 socket_filename[128]; /* optional, default is "/var/vpp/memif.sock" */
+  u8 secret[24]; /* optional, default is "" */
   u32 ring_size; /* optional, default is 1024 entries, must be power of 2 */
   u16 buffer_size; /* optional, default is 2048 bytes */
   u8 hw_addr[6]; /* optional, randomly generated if not defined */
@@ -74,8 +77,9 @@ autoreply define memif_delete
     @param sw_if_index - index of the interface
     @param if_name - name of the interface
     @param hw_addr - interface MAC address
-    @param key - key associated with the interface
+    @param id - id associated with the interface
     @param role - role of the interface in the connection (master/slave)
+    @param mode - interface mode
     @param socket_filename - name of the socket used by this interface
            to establish new connections
     @param ring_size - the number of entries of RX/TX rings
@@ -93,8 +97,9 @@ define memif_details
   u8 hw_addr[6];
 
   /* memif specific parameters */
-  u64 key;
+  u32 id;
   u8 role; /* 0 = master, 1 = slave */
+  u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
   u8 socket_filename[128];
   u32 ring_size;
   u16 buffer_size; /* optional, default is 2048 bytes */