lib/librte_ethdev/rte_ethdev_pci.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_PCI_H_
  33 #define _RTE_ETHDEV_PCI_H_
  34
  35 #include <rte_malloc.h>
  36 #include <rte_pci.h>
  37 #include <rte_bus_pci.h>
  38 #include <rte_config.h>
  39 #include <rte_ethdev_driver.h>
  40
  41 /**
  42  * Copy pci device info to the Ethernet device data.
  43  * Shared memory (eth_dev->data) only updated by primary process, so it is safe
  44  * to call this function from both primary and secondary processes.
  45  *
  46  * @param eth_dev
  47  * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
  48  * @param pci_dev
  49  * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
  50  */
  51 static inline void
  52 rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
  53         struct rte_pci_device *pci_dev)
  54 {
  55         if ((eth_dev == NULL) || (pci_dev == NULL)) {
  56                 RTE_ETHDEV_LOG(ERR, "NULL pointer eth_dev=%p pci_dev=%p",
  57                         (void *)eth_dev, (void *)pci_dev);
  58                 return;
  59         }
  60
  61         eth_dev->intr_handle = &pci_dev->intr_handle;
  62
  63         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
  64                 eth_dev->data->dev_flags = 0;
  65                 if (pci_dev->driver->drv_flags & RTE_PCI_DRV_INTR_LSC)
  66                         eth_dev->data->dev_flags |= RTE_ETH_DEV_INTR_LSC;
  67                 if (pci_dev->driver->drv_flags & RTE_PCI_DRV_INTR_RMV)
  68                         eth_dev->data->dev_flags |= RTE_ETH_DEV_INTR_RMV;
  69
  70                 eth_dev->data->numa_node = pci_dev->device.numa_node;
  71         }
  72 }
  73
  74 static inline int
  75 eth_dev_pci_specific_init(struct rte_eth_dev *eth_dev, void *bus_device) {
  76         struct rte_pci_device *pci_dev = bus_device;
  77
  78         if (!pci_dev)
  79                 return -ENODEV;
  80
  81         rte_eth_copy_pci_info(eth_dev, pci_dev);
  82
  83         return 0;
  84 }
  85
  86 /**
  87  * @internal
  88  * Allocates a new ethdev slot for an ethernet device and returns the pointer
  89  * to that slot for the driver to use.
  90  *
  91  * @param dev
  92  *      Pointer to the PCI device
  93  *
  94  * @param private_data_size
  95  *      Size of private data structure
  96  *
  97  * @return
  98  *      A pointer to a rte_eth_dev or NULL if allocation failed.
  99  */
 100 static inline struct rte_eth_dev *
 101 rte_eth_dev_pci_allocate(struct rte_pci_device *dev, size_t private_data_size)
 102 {
 103         struct rte_eth_dev *eth_dev;
 104         const char *name;
 105
 106         if (!dev)
 107                 return NULL;
 108
 109         name = dev->device.name;
 110
 111         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 112                 eth_dev = rte_eth_dev_allocate(name);
 113                 if (!eth_dev)
 114                         return NULL;
 115
 116                 if (private_data_size) {
 117                         eth_dev->data->dev_private = rte_zmalloc_socket(name,
 118                                 private_data_size, RTE_CACHE_LINE_SIZE,
 119                                 dev->device.numa_node);
 120                         if (!eth_dev->data->dev_private) {
 121                                 rte_eth_dev_release_port(eth_dev);
 122                                 return NULL;
 123                         }
 124                 }
 125         } else {
 126                 eth_dev = rte_eth_dev_attach_secondary(name);
 127                 if (!eth_dev)
 128                         return NULL;
 129         }
 130
 131         eth_dev->device = &dev->device;
 132         rte_eth_copy_pci_info(eth_dev, dev);
 133         return eth_dev;
 134 }
 135
 136 static inline void
 137 rte_eth_dev_pci_release(struct rte_eth_dev *eth_dev)
 138 {
 139         eth_dev->device = NULL;
 140         eth_dev->intr_handle = NULL;
 141
 142         /* free ether device */
 143         rte_eth_dev_release_port(eth_dev);
 144 }
 145
 146 typedef int (*eth_dev_pci_callback_t)(struct rte_eth_dev *eth_dev);
 147
 148 /**
 149  * @internal
 150  * Wrapper for use by pci drivers in a .probe function to attach to a ethdev
 151  * interface.
 152  */
 153 static inline int
 154 rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
 155         size_t private_data_size, eth_dev_pci_callback_t dev_init)
 156 {
 157         struct rte_eth_dev *eth_dev;
 158         int ret;
 159
 160         eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
 161         if (!eth_dev)
 162                 return -ENOMEM;
 163
 164         RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);
 165         ret = dev_init(eth_dev);
 166         if (ret)
 167                 rte_eth_dev_pci_release(eth_dev);
 168         else
 169                 rte_eth_dev_probing_finish(eth_dev);
 170
 171         return ret;
 172 }
 173
 174 /**
 175  * @internal
 176  * Wrapper for use by pci drivers in a .remove function to detach a ethdev
 177  * interface.
 178  */
 179 static inline int
 180 rte_eth_dev_pci_generic_remove(struct rte_pci_device *pci_dev,
 181         eth_dev_pci_callback_t dev_uninit)
 182 {
 183         struct rte_eth_dev *eth_dev;
 184         int ret;
 185
 186         eth_dev = rte_eth_dev_allocated(pci_dev->device.name);
 187         if (!eth_dev)
 188                 return 0;
 189
 190         if (dev_uninit) {
 191                 ret = dev_uninit(eth_dev);
 192                 if (ret)
 193                         return ret;
 194         }
 195
 196         rte_eth_dev_pci_release(eth_dev);
 197         return 0;
 198 }
 199
 200 #endif /* _RTE_ETHDEV_PCI_H_ */