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 static inline void
  50 rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
  51         struct rte_pci_device *pci_dev)
  52 {
  53         if ((eth_dev == NULL) || (pci_dev == NULL)) {
  54                 RTE_PMD_DEBUG_TRACE("NULL pointer eth_dev=%p pci_dev=%p\n",
  55                                 eth_dev, pci_dev);
  56                 return;
  57         }
  58
  59         eth_dev->intr_handle = &pci_dev->intr_handle;
  60
  61         eth_dev->data->dev_flags = 0;
  62         if (pci_dev->driver->drv_flags & RTE_PCI_DRV_INTR_LSC)
  63                 eth_dev->data->dev_flags |= RTE_ETH_DEV_INTR_LSC;
  64         if (pci_dev->driver->drv_flags & RTE_PCI_DRV_INTR_RMV)
  65                 eth_dev->data->dev_flags |= RTE_ETH_DEV_INTR_RMV;
  66
  67         eth_dev->data->kdrv = pci_dev->kdrv;
  68         eth_dev->data->numa_node = pci_dev->device.numa_node;
  69 }
  70
  71 /**
  72  * @internal
  73  * Allocates a new ethdev slot for an ethernet device and returns the pointer
  74  * to that slot for the driver to use.
  75  *
  76  * @param dev
  77  *      Pointer to the PCI device
  78  *
  79  * @param private_data_size
  80  *      Size of private data structure
  81  *
  82  * @return
  83  *      A pointer to a rte_eth_dev or NULL if allocation failed.
  84  */
  85 static inline struct rte_eth_dev *
  86 rte_eth_dev_pci_allocate(struct rte_pci_device *dev, size_t private_data_size)
  87 {
  88         struct rte_eth_dev *eth_dev;
  89         const char *name;
  90
  91         if (!dev)
  92                 return NULL;
  93
  94         name = dev->device.name;
  95
  96         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
  97                 eth_dev = rte_eth_dev_allocate(name);
  98                 if (!eth_dev)
  99                         return NULL;
 100
 101                 if (private_data_size) {
 102                         eth_dev->data->dev_private = rte_zmalloc_socket(name,
 103                                 private_data_size, RTE_CACHE_LINE_SIZE,
 104                                 dev->device.numa_node);
 105                         if (!eth_dev->data->dev_private) {
 106                                 rte_eth_dev_release_port(eth_dev);
 107                                 return NULL;
 108                         }
 109                 }
 110         } else {
 111                 eth_dev = rte_eth_dev_attach_secondary(name);
 112                 if (!eth_dev)
 113                         return NULL;
 114         }
 115
 116         eth_dev->device = &dev->device;
 117         rte_eth_copy_pci_info(eth_dev, dev);
 118         return eth_dev;
 119 }
 120
 121 static inline void
 122 rte_eth_dev_pci_release(struct rte_eth_dev *eth_dev)
 123 {
 124         /* free ether device */
 125         rte_eth_dev_release_port(eth_dev);
 126
 127         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 128                 rte_free(eth_dev->data->dev_private);
 129
 130         eth_dev->data->dev_private = NULL;
 131
 132         /*
 133          * Secondary process will check the name to attach.
 134          * Clear this field to avoid attaching a released ports.
 135          */
 136         eth_dev->data->name[0] = '\0';
 137
 138         eth_dev->device = NULL;
 139         eth_dev->intr_handle = NULL;
 140 }
 141
 142 typedef int (*eth_dev_pci_callback_t)(struct rte_eth_dev *eth_dev);
 143
 144 /**
 145  * @internal
 146  * Wrapper for use by pci drivers in a .probe function to attach to a ethdev
 147  * interface.
 148  */
 149 static inline int
 150 rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
 151         size_t private_data_size, eth_dev_pci_callback_t dev_init)
 152 {
 153         struct rte_eth_dev *eth_dev;
 154         int ret;
 155
 156         eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
 157         if (!eth_dev)
 158                 return -ENOMEM;
 159
 160         RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);
 161         ret = dev_init(eth_dev);
 162         if (ret)
 163                 rte_eth_dev_pci_release(eth_dev);
 164
 165         return ret;
 166 }
 167
 168 /**
 169  * @internal
 170  * Wrapper for use by pci drivers in a .remove function to detach a ethdev
 171  * interface.
 172  */
 173 static inline int
 174 rte_eth_dev_pci_generic_remove(struct rte_pci_device *pci_dev,
 175         eth_dev_pci_callback_t dev_uninit)
 176 {
 177         struct rte_eth_dev *eth_dev;
 178         int ret;
 179
 180         eth_dev = rte_eth_dev_allocated(pci_dev->device.name);
 181         if (!eth_dev)
 182                 return -ENODEV;
 183
 184         if (dev_uninit) {
 185                 ret = dev_uninit(eth_dev);
 186                 if (ret)
 187                         return ret;
 188         }
 189
 190         rte_eth_dev_pci_release(eth_dev);
 191         return 0;
 192 }
 193
 194 #endif /* _RTE_ETHDEV_PCI_H_ */