lib/librte_ethdev/rte_ethdev_vdev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017 Brocade Communications Systems, Inc.
   3  *   Author: Jan Blunck <jblunck@infradead.org>
   4  *
   5  *   Redistribution and use in source and binary forms, with or without
   6  *   modification, are permitted provided that the following conditions
   7  *   are met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  *       notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above copyright
  12  *       notice, this list of conditions and the following disclaimer in
  13  *       the documentation and/or other materials provided with the
  14  *       distribution.
  15  *     * Neither the name of the copyright holder nor the names of its
  16  *       contributors may be used to endorse or promote products derived
  17  *       from this software without specific prior written permission.
  18  *
  19  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _RTE_ETHDEV_VDEV_H_
  33 #define _RTE_ETHDEV_VDEV_H_
  34
  35 #include <rte_config.h>
  36 #include <rte_malloc.h>
  37 #include <rte_bus_vdev.h>
  38 #include <rte_ethdev_driver.h>
  39
  40 /**
  41  * @internal
  42  * Allocates a new ethdev slot for an ethernet device and returns the pointer
  43  * to that slot for the driver to use.
  44  *
  45  * @param dev
  46  *      Pointer to virtual device
  47  *
  48  * @param private_data_size
  49  *      Size of private data structure
  50  *
  51  * @return
  52  *      A pointer to a rte_eth_dev or NULL if allocation failed.
  53  */
  54 static inline struct rte_eth_dev *
  55 rte_eth_vdev_allocate(struct rte_vdev_device *dev, size_t private_data_size)
  56 {
  57         struct rte_eth_dev *eth_dev;
  58         const char *name = rte_vdev_device_name(dev);
  59
  60         eth_dev = rte_eth_dev_allocate(name);
  61         if (!eth_dev)
  62                 return NULL;
  63
  64         if (private_data_size) {
  65                 eth_dev->data->dev_private = rte_zmalloc_socket(name,
  66                         private_data_size, RTE_CACHE_LINE_SIZE,
  67                         dev->device.numa_node);
  68                 if (!eth_dev->data->dev_private) {
  69                         rte_eth_dev_release_port(eth_dev);
  70                         return NULL;
  71                 }
  72         }
  73
  74         eth_dev->device = &dev->device;
  75         eth_dev->intr_handle = NULL;
  76
  77         eth_dev->data->kdrv = RTE_KDRV_NONE;
  78         eth_dev->data->numa_node = dev->device.numa_node;
  79         return eth_dev;
  80 }
  81
  82 #endif /* _RTE_ETHDEV_VDEV_H_ */