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