src/vnet/devices/pipe/pipe.api

   1 /*
   2  * Copyright (c) 2018 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 /** \file
  17
  18     This file defines vpe control-plane API messages for
  19     the Linux kernel PIPE device driver
  20 */
  21
  22 option version = "1.0.1";
  23
  24 import "vnet/interface_types.api";
  25
  26 /** \brief Initialize a new pipe interface with the given parameters
  27     @param client_index - opaque cookie to identify the sender
  28     @param context - sender context, to match reply w/ request
  29     @param is_specified - if non-0, a specific user_instance is being requested
  30     @param user_instance - requested instance, ~0 => dynamically allocate
  31 */
  32 define pipe_create
  33 {
  34   u32 client_index;
  35   u32 context;
  36   bool is_specified;
  37   u32 user_instance;
  38 };
  39
  40 /** \brief Reply for pipe create reply
  41     @param context - returned sender context, to match reply w/ request
  42     @param retval - return code
  43     @param sw_if_index - software index allocated for the new pipe parent interface
  44                          Use the parent interface for link up/down and to delete
  45     @param pipe_sw_if_index - the two SW indicies that form the ends of the pipe.
  46 */
  47 define pipe_create_reply
  48 {
  49   u32 context;
  50   i32 retval;
  51   vl_api_interface_index_t sw_if_index;
  52   vl_api_interface_index_t pipe_sw_if_index[2];
  53 };
  54
  55 /** \brief Delete pipe interface
  56     @param client_index - opaque cookie to identify the sender
  57     @param context - sender context, to match reply w/ request
  58     @param sw_if_index - interface index of existing parent pipe interface
  59 */
  60 autoreply define pipe_delete
  61 {
  62   u32 client_index;
  63   u32 context;
  64   vl_api_interface_index_t sw_if_index;
  65 };
  66
  67 /** \brief Dump pipe interfaces request */
  68 define pipe_dump
  69 {
  70   u32 client_index;
  71   u32 context;
  72 };
  73
  74 /** \brief Reply for pipe dump request
  75     @param sw_if_index - software index of pipe interface
  76     @param sw_if_index - software index allocated for the pipe parent interface
  77     @param pipe_sw_if_index - the two SW indicies that form the ends of the pipe.
  78     @param instance - instance allocated
  79 */
  80 define pipe_details
  81 {
  82   u32 context;
  83   vl_api_interface_index_t sw_if_index;
  84   vl_api_interface_index_t pipe_sw_if_index[2];
  85   u32 instance;
  86 };
  87
  88 /*
  89  * Local Variables:
  90  * eval: (c-set-style "gnu")
  91  * End:
  92  */