4 * Copyright(c) 2017 Brocade Communications Systems, Inc.
5 * Author: Jan Blunck <jblunck@infradead.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _RTE_ETHDEV_PCI_H_
35 #define _RTE_ETHDEV_PCI_H_
37 #include <rte_malloc.h>
39 #include <rte_ethdev.h>
42 * Copy pci device info to the Ethernet device data.
45 * The *eth_dev* pointer is the address of the *rte_eth_dev* structure.
47 * The *pci_dev* pointer is the address of the *rte_pci_device* structure.
50 * - 0 on success, negative on error
53 rte_eth_copy_pci_info(struct rte_eth_dev
*eth_dev
,
54 struct rte_pci_device
*pci_dev
)
56 if ((eth_dev
== NULL
) || (pci_dev
== NULL
)) {
57 RTE_PMD_DEBUG_TRACE("NULL pointer eth_dev=%p pci_dev=%p\n",
62 eth_dev
->intr_handle
= &pci_dev
->intr_handle
;
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
;
72 eth_dev
->data
->drv_name
= pci_dev
->driver
->driver
.name
;
77 * Allocates a new ethdev slot for an ethernet device and returns the pointer
78 * to that slot for the driver to use.
81 * Pointer to the PCI device
83 * @param private_data_size
84 * Size of private data structure
87 * A pointer to a rte_eth_dev or NULL if allocation failed.
89 static inline struct rte_eth_dev
*
90 rte_eth_dev_pci_allocate(struct rte_pci_device
*dev
, size_t private_data_size
)
92 struct rte_eth_dev
*eth_dev
;
98 name
= dev
->device
.name
;
100 if (rte_eal_process_type() == RTE_PROC_PRIMARY
) {
101 eth_dev
= rte_eth_dev_allocate(name
);
105 if (private_data_size
) {
106 eth_dev
->data
->dev_private
= rte_zmalloc_socket(name
,
107 private_data_size
, RTE_CACHE_LINE_SIZE
,
108 dev
->device
.numa_node
);
109 if (!eth_dev
->data
->dev_private
) {
110 rte_eth_dev_release_port(eth_dev
);
115 eth_dev
= rte_eth_dev_attach_secondary(name
);
120 eth_dev
->device
= &dev
->device
;
121 eth_dev
->intr_handle
= &dev
->intr_handle
;
122 rte_eth_copy_pci_info(eth_dev
, dev
);
127 rte_eth_dev_pci_release(struct rte_eth_dev
*eth_dev
)
129 /* free ether device */
130 rte_eth_dev_release_port(eth_dev
);
132 if (rte_eal_process_type() == RTE_PROC_PRIMARY
)
133 rte_free(eth_dev
->data
->dev_private
);
135 eth_dev
->data
->dev_private
= NULL
;
137 eth_dev
->device
= NULL
;
138 eth_dev
->intr_handle
= NULL
;
141 typedef int (*eth_dev_pci_callback_t
)(struct rte_eth_dev
*eth_dev
);
145 * Wrapper for use by pci drivers in a .probe function to attach to a ethdev
149 rte_eth_dev_pci_generic_probe(struct rte_pci_device
*pci_dev
,
150 size_t private_data_size
, eth_dev_pci_callback_t dev_init
)
152 struct rte_eth_dev
*eth_dev
;
155 eth_dev
= rte_eth_dev_pci_allocate(pci_dev
, private_data_size
);
159 RTE_FUNC_PTR_OR_ERR_RET(*dev_init
, -EINVAL
);
160 ret
= dev_init(eth_dev
);
162 rte_eth_dev_pci_release(eth_dev
);
169 * Wrapper for use by pci drivers in a .remove function to detach a ethdev
173 rte_eth_dev_pci_generic_remove(struct rte_pci_device
*pci_dev
,
174 eth_dev_pci_callback_t dev_uninit
)
176 struct rte_eth_dev
*eth_dev
;
179 eth_dev
= rte_eth_dev_allocated(pci_dev
->device
.name
);
184 ret
= dev_uninit(eth_dev
);
189 rte_eth_dev_pci_release(eth_dev
);
193 #endif /* _RTE_ETHDEV_PCI_H_ */