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  * @internal
  43  * Allocates a new ethdev slot for an ethernet device and returns the pointer
  44  * to that slot for the driver to use.
  45  *
  46  * @param dev
  47  *      Pointer to the PCI device
  48  *
  49  * @param private_data_size
  50  *      Size of private data structure
  51  *
  52  * @return
  53  *      A pointer to a rte_eth_dev or NULL if allocation failed.
  54  */
  55 static inline struct rte_eth_dev *
  56 rte_eth_dev_pci_allocate(struct rte_pci_device *dev, size_t private_data_size)
  57 {
  58         struct rte_eth_dev *eth_dev;
  59         const char *name;
  60
  61         if (!dev)
  62                 return NULL;
  63
  64         name = dev->device.name;
  65
  66         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
  67                 eth_dev = rte_eth_dev_allocate(name);
  68                 if (!eth_dev)
  69                         return NULL;
  70
  71                 if (private_data_size) {
  72                         eth_dev->data->dev_private = rte_zmalloc_socket(name,
  73                                 private_data_size, RTE_CACHE_LINE_SIZE,
  74                                 dev->device.numa_node);
  75                         if (!eth_dev->data->dev_private) {
  76                                 rte_eth_dev_release_port(eth_dev);
  77                                 return NULL;
  78                         }
  79                 }
  80         } else {
  81                 eth_dev = rte_eth_dev_attach_secondary(name);
  82                 if (!eth_dev)
  83                         return NULL;
  84         }
  85
  86         eth_dev->device = &dev->device;
  87         eth_dev->intr_handle = &dev->intr_handle;
  88         rte_eth_copy_pci_info(eth_dev, dev);
  89         return eth_dev;
  90 }
  91
  92 static inline void
  93 rte_eth_dev_pci_release(struct rte_eth_dev *eth_dev)
  94 {
  95         /* free ether device */
  96         rte_eth_dev_release_port(eth_dev);
  97
  98         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
  99                 rte_free(eth_dev->data->dev_private);
 100
 101         eth_dev->data->dev_private = NULL;
 102
 103         eth_dev->device = NULL;
 104         eth_dev->intr_handle = NULL;
 105 }
 106
 107 typedef int (*eth_dev_pci_callback_t)(struct rte_eth_dev *eth_dev);
 108
 109 /**
 110  * @internal
 111  * Wrapper for use by pci drivers in a .probe function to attach to a ethdev
 112  * interface.
 113  */
 114 static inline int
 115 rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
 116         size_t private_data_size, eth_dev_pci_callback_t dev_init)
 117 {
 118         struct rte_eth_dev *eth_dev;
 119         int ret;
 120
 121         eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
 122         if (!eth_dev)
 123                 return -ENOMEM;
 124
 125         RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);
 126         ret = dev_init(eth_dev);
 127         if (ret)
 128                 rte_eth_dev_pci_release(eth_dev);
 129
 130         return ret;
 131 }
 132
 133 /**
 134  * @internal
 135  * Wrapper for use by pci drivers in a .remove function to detach a ethdev
 136  * interface.
 137  */
 138 static inline int
 139 rte_eth_dev_pci_generic_remove(struct rte_pci_device *pci_dev,
 140         eth_dev_pci_callback_t dev_uninit)
 141 {
 142         struct rte_eth_dev *eth_dev;
 143         int ret;
 144
 145         eth_dev = rte_eth_dev_allocated(pci_dev->device.name);
 146         if (!eth_dev)
 147                 return -ENODEV;
 148
 149         if (dev_uninit) {
 150                 ret = dev_uninit(eth_dev);
 151                 if (ret)
 152                         return ret;
 153         }
 154
 155         rte_eth_dev_pci_release(eth_dev);
 156         return 0;
 157 }
 158
 159 #endif /* _RTE_ETHDEV_PCI_H_ */