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_virtio_net.h>
  45
  46 /**
  47  * Disable features in feature_mask.
  48  *
  49  * @param feature_mask
  50  *  Vhost features defined in "linux/virtio_net.h".
  51  * @return
  52  *  - On success, zero.
  53  *  - On failure, a negative value.
  54  */
  55 int rte_eth_vhost_feature_disable(uint64_t feature_mask);
  56
  57 /**
  58  * Enable features in feature_mask.
  59  *
  60  * @param feature_mask
  61  *  Vhost features defined in "linux/virtio_net.h".
  62  * @return
  63  *  - On success, zero.
  64  *  - On failure, a negative value.
  65  */
  66 int rte_eth_vhost_feature_enable(uint64_t feature_mask);
  67
  68 /**
  69  * Returns currently supported vhost features.
  70  *
  71  * @return
  72  *  Vhost features defined in "linux/virtio_net.h".
  73  */
  74 uint64_t rte_eth_vhost_feature_get(void);
  75
  76 /*
  77  * Event description.
  78  */
  79 struct rte_eth_vhost_queue_event {
  80         uint16_t queue_id;
  81         bool rx;
  82         bool enable;
  83 };
  84
  85 /**
  86  * Get queue events from specified port.
  87  * If a callback for below event is registered by
  88  * rte_eth_dev_callback_register(), this function will describe what was
  89  * changed.
  90  *  - RTE_ETH_EVENT_QUEUE_STATE
  91  * Multiple events may cause only one callback kicking, so call this function
  92  * while returning 0.
  93  *
  94  * @param port_id
  95  *  Port id.
  96  * @param event
  97  *  Pointer to a rte_eth_vhost_queue_event structure.
  98  * @return
  99  *  - On success, zero.
 100  *  - On failure, a negative value.
 101  */
 102 int rte_eth_vhost_get_queue_event(uint8_t port_id,
 103                 struct rte_eth_vhost_queue_event *event);
 104
 105 /**
 106  * Get the 'vid' value associated with the specified port.
 107  *
 108  * @return
 109  *  - On success, the 'vid' associated with 'port_id'.
 110  *  - On failure, a negative value.
 111  */
 112 int rte_eth_vhost_get_vid_from_port_id(uint8_t port_id);
 113
 114 #ifdef __cplusplus
 115 }
 116 #endif
 117
 118 #endif