1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Brocade Communications Systems, Inc.
3 * Author: Jan Blunck <jblunck@infradead.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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
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.
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.
32 #ifndef _RTE_ETHDEV_PCI_H_
33 #define _RTE_ETHDEV_PCI_H_
35 #include <rte_malloc.h>
37 #include <rte_bus_pci.h>
38 #include <rte_config.h>
39 #include <rte_ethdev_driver.h>
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.
47 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
49 * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
52 rte_eth_copy_pci_info(struct rte_eth_dev *eth_dev,
53 struct rte_pci_device *pci_dev)
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);
61 eth_dev->intr_handle = &pci_dev->intr_handle;
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;
70 eth_dev->data->kdrv = pci_dev->kdrv;
71 eth_dev->data->numa_node = pci_dev->device.numa_node;
76 eth_dev_pci_specific_init(struct rte_eth_dev *eth_dev, void *bus_device) {
77 struct rte_pci_device *pci_dev = bus_device;
82 rte_eth_copy_pci_info(eth_dev, pci_dev);
89 * Allocates a new ethdev slot for an ethernet device and returns the pointer
90 * to that slot for the driver to use.
93 * Pointer to the PCI device
95 * @param private_data_size
96 * Size of private data structure
99 * A pointer to a rte_eth_dev or NULL if allocation failed.
101 static inline struct rte_eth_dev *
102 rte_eth_dev_pci_allocate(struct rte_pci_device *dev, size_t private_data_size)
104 struct rte_eth_dev *eth_dev;
110 name = dev->device.name;
112 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
113 eth_dev = rte_eth_dev_allocate(name);
117 if (private_data_size) {
118 eth_dev->data->dev_private = rte_zmalloc_socket(name,
119 private_data_size, RTE_CACHE_LINE_SIZE,
120 dev->device.numa_node);
121 if (!eth_dev->data->dev_private) {
122 rte_eth_dev_release_port(eth_dev);
127 eth_dev = rte_eth_dev_attach_secondary(name);
132 eth_dev->device = &dev->device;
133 rte_eth_copy_pci_info(eth_dev, dev);
138 rte_eth_dev_pci_release(struct rte_eth_dev *eth_dev)
140 eth_dev->device = NULL;
141 eth_dev->intr_handle = NULL;
143 /* free ether device */
144 rte_eth_dev_release_port(eth_dev);
147 typedef int (*eth_dev_pci_callback_t)(struct rte_eth_dev *eth_dev);
151 * Wrapper for use by pci drivers in a .probe function to attach to a ethdev
155 rte_eth_dev_pci_generic_probe(struct rte_pci_device *pci_dev,
156 size_t private_data_size, eth_dev_pci_callback_t dev_init)
158 struct rte_eth_dev *eth_dev;
161 eth_dev = rte_eth_dev_pci_allocate(pci_dev, private_data_size);
165 RTE_FUNC_PTR_OR_ERR_RET(*dev_init, -EINVAL);
166 ret = dev_init(eth_dev);
168 rte_eth_dev_pci_release(eth_dev);
170 rte_eth_dev_probing_finish(eth_dev);
177 * Wrapper for use by pci drivers in a .remove function to detach a ethdev
181 rte_eth_dev_pci_generic_remove(struct rte_pci_device *pci_dev,
182 eth_dev_pci_callback_t dev_uninit)
184 struct rte_eth_dev *eth_dev;
187 eth_dev = rte_eth_dev_allocated(pci_dev->device.name);
192 ret = dev_uninit(eth_dev);
197 rte_eth_dev_pci_release(eth_dev);
201 #endif /* _RTE_ETHDEV_PCI_H_ */