drivers/net/vhost/rte_eth_vhost.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 IGEL Co., Ltd.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of IGEL Co., Ltd. nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_ETH_VHOST_H_
  35 #define _RTE_ETH_VHOST_H_
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #include <stdint.h>
  42 #include <stdbool.h>
  43
  44 #include <rte_vhost.h>
  45
  46 /*
  47  * Event description.
  48  */
  49 struct rte_eth_vhost_queue_event {
  50         uint16_t queue_id;
  51         bool rx;
  52         bool enable;
  53 };
  54
  55 /**
  56  * Get queue events from specified port.
  57  * If a callback for below event is registered by
  58  * rte_eth_dev_callback_register(), this function will describe what was
  59  * changed.
  60  *  - RTE_ETH_EVENT_QUEUE_STATE
  61  * Multiple events may cause only one callback kicking, so call this function
  62  * while returning 0.
  63  *
  64  * @param port_id
  65  *  Port id.
  66  * @param event
  67  *  Pointer to a rte_eth_vhost_queue_event structure.
  68  * @return
  69  *  - On success, zero.
  70  *  - On failure, a negative value.
  71  */
  72 int rte_eth_vhost_get_queue_event(uint16_t port_id,
  73                 struct rte_eth_vhost_queue_event *event);
  74
  75 /**
  76  * Get the 'vid' value associated with the specified port.
  77  *
  78  * @return
  79  *  - On success, the 'vid' associated with 'port_id'.
  80  *  - On failure, a negative value.
  81  */
  82 int rte_eth_vhost_get_vid_from_port_id(uint16_t port_id);
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif