lib/librte_ether/rte_ethdev_pci.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Brocade Communications Systems, Inc.
   5  *   Author: Jan Blunck <jblunck@infradead.org>
   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 the copyright holder 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_ETHDEV_PCI_H_
  35 #define _RTE_ETHDEV_PCI_H_
  36
  37 #include <rte_malloc.h>
  38 #include <rte_pci.h>
  39 #include <rte_ethdev.h>
  40
  41 /**
  42  * Copy pci device info to the Ethernet device data.
  43  *
  44  * @param eth_dev
  45  * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
  46  * @param pci_dev
  47  * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
  48  *
  49  * @return
  50  *   - 0 on success, negative on error
  51  */
  52 static inline void
  53 rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
  54         struct rte_pci_device *pci_dev)
  55 {
  56         if ((eth_dev == NULL) || (pci_dev == NULL)) {
  57                 RTE_PMD_DEBUG_TRACE("NULL pointer eth_dev=%p pci_dev=%p\n",
  58                                 eth_dev, pci_dev);
  59                 return;
  60         }
  61
  62         eth_dev->intr_handle = &pci_dev->intr_handle;
  63
  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
  68         eth_dev->data->kdrv = pci_dev->kdrv;
  69         eth_dev->data->numa_node = pci_dev->device.numa_node;
  70         eth_dev->data->drv_name = pci_dev->driver->driver.name;
  71 }
  72
  73 /**
  74  * @internal
  75  * Allocates a new ethdev slot for an ethernet device and returns the pointer
  76  * to that slot for the driver to use.
  77  *
  78  * @param dev
  79  *      Pointer to the PCI device
  80  *
  81  * @param private_data_size
  82  *      Size of private data structure
  83  *
  84  * @return
  85  *      A pointer to a rte_eth_dev or NULL if allocation failed.
  86  */
  87 static inline struct rte_eth_dev *
  88 rte_eth_dev_pci_allocate(struct rte_pci_device *dev, size_t private_data_size)
  89 {
  90         struct rte_eth_dev *eth_dev;
  91         const char *name;
  92
  93         if (!dev)
  94                 return NULL;
  95
  96         name = dev->device.name;
  97
  98         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
  99                 eth_dev = rte_eth_dev_allocate(name);
 100                 if (!eth_dev)
 101                         return NULL;
 102
 103                 if (private_data_size) {
 104                         eth_dev->data->dev_private = rte_zmalloc_socket(name,
 105                                 private_data_size, RTE_CACHE_LINE_SIZE,
 106                                 dev->device.numa_node);
 107                         if (!eth_dev->data->dev_private) {
 108                                 rte_eth_dev_release_port(eth_dev);
 109                                 return NULL;
 110                         }
 111                 }
 112         } else {
 113                 eth_dev = rte_eth_dev_attach_secondary(name);
 114                 if (!eth_dev)
 115                         return NULL;
 116         }
 117
 118         eth_dev->device = &dev->device;
 119         eth_dev->intr_handle = &dev->intr_handle;
 120         rte_eth_copy_pci_info(eth_dev, dev);
 121         return eth_dev;
 122 }
 123
 124 static inline void
 125 rte_eth_dev_pci_release(struct rte_eth_dev *eth_dev)
 126 {
 127         /* free ether device */
 128         rte_eth_dev_release_port(eth_dev);
 129
 130         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 131                 rte_free(eth_dev->data->dev_private);
 132
 133         eth_dev->data->dev_private = NULL;
 134
 135         eth_dev->device = NULL;
 136         eth_dev->intr_handle = NULL;
 137 }
 138
 139 typedef int (*eth_dev_pci_callback_t)(struct rte_eth_dev *eth_dev);
 140
 141 /**
 142  * @internal
 143  * Wrapper for use by pci drivers in a .probe function to attach to a ethdev
 144  * interface.
 145  */
 146 static inline int
 147 rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
 148         size_t private_data_size, eth_dev_pci_callback_t dev_init)
 149 {
 150         struct rte_eth_dev *eth_dev;
 151         int ret;
 152
 153         eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
 154         if (!eth_dev)
 155                 return -ENOMEM;
 156
 157         RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);
 158         ret = dev_init(eth_dev);
 159         if (ret)
 160                 rte_eth_dev_pci_release(eth_dev);
 161
 162         return ret;
 163 }
 164
 165 /**
 166  * @internal
 167  * Wrapper for use by pci drivers in a .remove function to detach a ethdev
 168  * interface.
 169  */
 170 static inline int
 171 rte_eth_dev_pci_generic_remove(struct rte_pci_device *pci_dev,
 172         eth_dev_pci_callback_t dev_uninit)
 173 {
 174         struct rte_eth_dev *eth_dev;
 175         int ret;
 176
 177         eth_dev = rte_eth_dev_allocated(pci_dev->device.name);
 178         if (!eth_dev)
 179                 return -ENODEV;
 180
 181         if (dev_uninit) {
 182                 ret = dev_uninit(eth_dev);
 183                 if (ret)
 184                         return ret;
 185         }
 186
 187         rte_eth_dev_pci_release(eth_dev);
 188         return 0;
 189 }
 190
 191 #endif /* _RTE_ETHDEV_PCI_H_ */