vnet/vnet/devices/netmap/netmap.api

   1 /*
   2  * Copyright (c) 2015-2016 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 /** \brief Create netmap
  17     @param client_index - opaque cookie to identify the sender
  18     @param context - sender context, to match reply w/ request
  19     @param netmap_if_name - interface name
  20     @param hw_addr - interface MAC
  21     @param use_random_hw_addr - use random generated MAC
  22     @param is_pipe - is pipe
  23     @param is_master - 0=slave, 1=master
  24 */
  25 define netmap_create
  26 {
  27   u32 client_index;
  28   u32 context;
  29
  30   u8 netmap_if_name[64];
  31   u8 hw_addr[6];
  32   u8 use_random_hw_addr;
  33   u8 is_pipe;
  34   u8 is_master;
  35 };
  36
  37 /** \brief Create netmap response
  38     @param context - sender context, to match reply w/ request
  39     @param retval - return value for request
  40 */
  41 define netmap_create_reply
  42 {
  43   u32 context;
  44   i32 retval;
  45 };
  46
  47 /** \brief Delete netmap
  48     @param client_index - opaque cookie to identify the sender
  49     @param context - sender context, to match reply w/ request
  50     @param netmap_if_name - interface name
  51 */
  52 define netmap_delete
  53 {
  54   u32 client_index;
  55   u32 context;
  56
  57   u8 netmap_if_name[64];
  58 };
  59
  60 /** \brief Delete netmap response
  61     @param context - sender context, to match reply w/ request
  62     @param retval - return value for request
  63 */
  64 define netmap_delete_reply
  65 {
  66   u32 context;
  67   i32 retval;
  68 };
  69
  70 /*
  71  * Local Variables:
  72  * eval: (c-set-style "gnu")
  73  * End:
  74  */