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_bus_pci.h>
  40 #include <rte_config.h>
  41 #include <rte_ethdev.h>
  42
  43 /**
  44  * Copy pci device info to the Ethernet device data.
  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_PMD_DEBUG_TRACE("NULL pointer eth_dev=%p pci_dev=%p\n",
  57                                 eth_dev, pci_dev);
  58                 return;
  59         }
  60
  61         eth_dev->intr_handle = &pci_dev->intr_handle;
  62
  63         eth_dev->data->dev_flags = 0;
  64         if (pci_dev->driver->drv_flags & RTE_PCI_DRV_INTR_LSC)
  65                 eth_dev->data->dev_flags |= RTE_ETH_DEV_INTR_LSC;
  66         if (pci_dev->driver->drv_flags & RTE_PCI_DRV_INTR_RMV)
  67                 eth_dev->data->dev_flags |= RTE_ETH_DEV_INTR_RMV;
  68
  69         eth_dev->data->kdrv = pci_dev->kdrv;
  70         eth_dev->data->numa_node = pci_dev->device.numa_node;
  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         rte_eth_copy_pci_info(eth_dev, dev);
 120         return eth_dev;
 121 }
 122
 123 static inline void
 124 rte_eth_dev_pci_release(struct rte_eth_dev *eth_dev)
 125 {
 126         /* free ether device */
 127         rte_eth_dev_release_port(eth_dev);
 128
 129         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 130                 rte_free(eth_dev->data->dev_private);
 131
 132         eth_dev->data->dev_private = NULL;
 133
 134         /*
 135          * Secondary process will check the name to attach.
 136          * Clear this field to avoid attaching a released ports.
 137          */
 138         eth_dev->data->name[0] = '\0';
 139
 140         eth_dev->device = NULL;
 141         eth_dev->intr_handle = NULL;
 142 }
 143
 144 typedef int (*eth_dev_pci_callback_t)(struct rte_eth_dev *eth_dev);
 145
 146 /**
 147  * @internal
 148  * Wrapper for use by pci drivers in a .probe function to attach to a ethdev
 149  * interface.
 150  */
 151 static inline int
 152 rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
 153         size_t private_data_size, eth_dev_pci_callback_t dev_init)
 154 {
 155         struct rte_eth_dev *eth_dev;
 156         int ret;
 157
 158         eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
 159         if (!eth_dev)
 160                 return -ENOMEM;
 161
 162         RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);
 163         ret = dev_init(eth_dev);
 164         if (ret)
 165                 rte_eth_dev_pci_release(eth_dev);
 166
 167         return ret;
 168 }
 169
 170 /**
 171  * @internal
 172  * Wrapper for use by pci drivers in a .remove function to detach a ethdev
 173  * interface.
 174  */
 175 static inline int
 176 rte_eth_dev_pci_generic_remove(struct rte_pci_device *pci_dev,
 177         eth_dev_pci_callback_t dev_uninit)
 178 {
 179         struct rte_eth_dev *eth_dev;
 180         int ret;
 181
 182         eth_dev = rte_eth_dev_allocated(pci_dev->device.name);
 183         if (!eth_dev)
 184                 return -ENODEV;
 185
 186         if (dev_uninit) {
 187                 ret = dev_uninit(eth_dev);
 188                 if (ret)
 189                         return ret;
 190         }
 191
 192         rte_eth_dev_pci_release(eth_dev);
 193         return 0;
 194 }
 195
 196 #endif /* _RTE_ETHDEV_PCI_H_ */