src/plugins/memif/memif.api

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "1.0.0";
  17
  18 /** \brief Create memory interface
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param role - role of the interface in the connection (master/slave)
  22     @param mode - interface mode
  23     @param rx_queues - number of rx queues (only valid for slave)
  24     #param tx_queues - number of tx queues (only valid for slave)
  25     @param id - 32bit integer used to authenticate and match opposite sides
  26            of the connection
  27     @param socket_filename - filename of the socket to be used for connection
  28            establishment
  29     @param ring_size - the number of entries of RX/TX rings
  30     @param buffer_size - size of the buffer allocated for each ring entry
  31     @param hw_addr - interface MAC address
  32 */
  33 define memif_create
  34 {
  35   u32 client_index;
  36   u32 context;
  37
  38   u8 role; /* 0 = master, 1 = slave */
  39   u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
  40   u8 rx_queues; /* optional, default is 1 */
  41   u8 tx_queues; /* optional, default is 1 */
  42   u32 id; /* optional, default is 0 */
  43   u8 socket_filename[128]; /* optional, default is "/var/vpp/memif.sock" */
  44   u8 secret[24]; /* optional, default is "" */
  45   u32 ring_size; /* optional, default is 1024 entries, must be power of 2 */
  46   u16 buffer_size; /* optional, default is 2048 bytes */
  47   u8 hw_addr[6]; /* optional, randomly generated if not defined */
  48 };
  49
  50 /** \brief Create memory interface response
  51     @param context - sender context, to match reply w/ request
  52     @param retval - return value for request
  53     @param sw_if_index - software index of the newly created interface
  54 */
  55 define memif_create_reply
  56 {
  57   u32 context;
  58   i32 retval;
  59   u32 sw_if_index;
  60 };
  61
  62 /** \brief Delete memory interface
  63     @param client_index - opaque cookie to identify the sender
  64     @param context - sender context, to match reply w/ request
  65     @param sw_if_index - software index of the interface to delete
  66 */
  67 autoreply define memif_delete
  68 {
  69   u32 client_index;
  70   u32 context;
  71
  72   u32 sw_if_index;
  73 };
  74
  75 /** \brief Memory interface details structure
  76     @param context - sender context, to match reply w/ request (memif_dump)
  77     @param sw_if_index - index of the interface
  78     @param if_name - name of the interface
  79     @param hw_addr - interface MAC address
  80     @param id - id associated with the interface
  81     @param role - role of the interface in the connection (master/slave)
  82     @param mode - interface mode
  83     @param socket_filename - name of the socket used by this interface
  84            to establish new connections
  85     @param ring_size - the number of entries of RX/TX rings
  86     @param buffer_size - size of the buffer allocated for each ring entry
  87     @param admin_up_down - interface administrative status
  88     @param link_up_down - interface link status
  89
  90 */
  91 define memif_details
  92 {
  93   u32 context;
  94
  95   u32 sw_if_index;
  96   u8 if_name[64];
  97   u8 hw_addr[6];
  98
  99   /* memif specific parameters */
 100   u32 id;
 101   u8 role; /* 0 = master, 1 = slave */
 102   u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
 103   u8 socket_filename[128];
 104   u32 ring_size;
 105   u16 buffer_size; /* optional, default is 2048 bytes */
 106
 107   /* 1 = up, 0 = down */
 108   u8 admin_up_down;
 109   u8 link_up_down;
 110 };
 111
 112 /** \brief Dump all memory interfaces
 113     @param client_index - opaque cookie to identify the sender
 114     @param context - sender context, to match reply w/ request
 115 */
 116 define memif_dump
 117 {
 118   u32 client_index;
 119   u32 context;
 120 };
 121
 122 /*
 123  * Local Variables:
 124  * eval: (c-set-style "gnu")
 125  * End:
 126  */