eal: remove deprecated function
[dpdk.git] / lib / librte_eal / common / eal_common_pci.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
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 Intel Corporation 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 /*   BSD LICENSE
34  *
35  *   Copyright 2013-2014 6WIND S.A.
36  *
37  *   Redistribution and use in source and binary forms, with or without
38  *   modification, are permitted provided that the following conditions
39  *   are met:
40  *
41  *     * Redistributions of source code must retain the above copyright
42  *       notice, this list of conditions and the following disclaimer.
43  *     * Redistributions in binary form must reproduce the above copyright
44  *       notice, this list of conditions and the following disclaimer in
45  *       the documentation and/or other materials provided with the
46  *       distribution.
47  *     * Neither the name of 6WIND S.A. nor the names of its
48  *       contributors may be used to endorse or promote products derived
49  *       from this software without specific prior written permission.
50  *
51  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  */
63
64 #include <string.h>
65 #include <inttypes.h>
66 #include <stdint.h>
67 #include <stdlib.h>
68 #include <stdio.h>
69 #include <sys/queue.h>
70 #include <sys/mman.h>
71
72 #include <rte_interrupts.h>
73 #include <rte_log.h>
74 #include <rte_pci.h>
75 #include <rte_per_lcore.h>
76 #include <rte_memory.h>
77 #include <rte_memzone.h>
78 #include <rte_eal.h>
79 #include <rte_string_fns.h>
80 #include <rte_common.h>
81 #include <rte_devargs.h>
82
83 #include "eal_private.h"
84
85 struct pci_driver_list pci_driver_list;
86 struct pci_device_list pci_device_list;
87
88 static struct rte_devargs *pci_devargs_lookup(struct rte_pci_device *dev)
89 {
90         struct rte_devargs *devargs;
91
92         TAILQ_FOREACH(devargs, &devargs_list, next) {
93                 if (devargs->type != RTE_DEVTYPE_BLACKLISTED_PCI &&
94                         devargs->type != RTE_DEVTYPE_WHITELISTED_PCI)
95                         continue;
96                 if (!rte_eal_compare_pci_addr(&dev->addr, &devargs->pci.addr))
97                         return devargs;
98         }
99         return NULL;
100 }
101
102 /* map a particular resource from a file */
103 void *
104 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
105                  int additional_flags)
106 {
107         void *mapaddr;
108
109         /* Map the PCI memory resource of device */
110         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
111                         MAP_SHARED | additional_flags, fd, offset);
112         if (mapaddr == MAP_FAILED) {
113                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%d, %p, 0x%lx, 0x%lx): %s (%p)\n",
114                         __func__, fd, requested_addr,
115                         (unsigned long)size, (unsigned long)offset,
116                         strerror(errno), mapaddr);
117         } else
118                 RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
119
120         return mapaddr;
121 }
122
123 /* unmap a particular resource */
124 void
125 pci_unmap_resource(void *requested_addr, size_t size)
126 {
127         if (requested_addr == NULL)
128                 return;
129
130         /* Unmap the PCI memory resource of device */
131         if (munmap(requested_addr, size)) {
132                 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, 0x%lx): %s\n",
133                         __func__, requested_addr, (unsigned long)size,
134                         strerror(errno));
135         } else
136                 RTE_LOG(DEBUG, EAL, "  PCI memory unmapped at %p\n",
137                                 requested_addr);
138 }
139
140 /*
141  * If vendor/device ID match, call the devinit() function of the
142  * driver.
143  */
144 static int
145 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr, struct rte_pci_device *dev)
146 {
147         int ret;
148         const struct rte_pci_id *id_table;
149
150         for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
151
152                 /* check if device's identifiers match the driver's ones */
153                 if (id_table->vendor_id != dev->id.vendor_id &&
154                                 id_table->vendor_id != PCI_ANY_ID)
155                         continue;
156                 if (id_table->device_id != dev->id.device_id &&
157                                 id_table->device_id != PCI_ANY_ID)
158                         continue;
159                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
160                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
161                         continue;
162                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
163                                 id_table->subsystem_device_id != PCI_ANY_ID)
164                         continue;
165
166                 struct rte_pci_addr *loc = &dev->addr;
167
168                 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
169                                 loc->domain, loc->bus, loc->devid, loc->function,
170                                 dev->numa_node);
171
172                 RTE_LOG(DEBUG, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
173                                 dev->id.device_id, dr->name);
174
175                 /* no initialization when blacklisted, return without error */
176                 if (dev->devargs != NULL &&
177                         dev->devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
178                         RTE_LOG(DEBUG, EAL, "  Device is blacklisted, not initializing\n");
179                         return 1;
180                 }
181
182                 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING) {
183 #ifdef RTE_PCI_CONFIG
184                         /*
185                          * Set PCIe config space for high performance.
186                          * Return value can be ignored.
187                          */
188                         pci_config_space_set(dev);
189 #endif
190                         /* map resources for devices that use igb_uio */
191                         ret = pci_map_device(dev);
192                         if (ret != 0)
193                                 return ret;
194                 } else if (dr->drv_flags & RTE_PCI_DRV_FORCE_UNBIND &&
195                                 rte_eal_process_type() == RTE_PROC_PRIMARY) {
196                         /* unbind current driver */
197                         if (pci_unbind_kernel_driver(dev) < 0)
198                                 return -1;
199                 }
200
201                 /* reference driver structure */
202                 dev->driver = dr;
203
204                 /* call the driver devinit() function */
205                 return dr->devinit(dr, dev);
206         }
207         /* return positive value if driver is not found */
208         return 1;
209 }
210
211 /*
212  * If vendor/device ID match, call the devuninit() function of the
213  * driver.
214  */
215 static int
216 rte_eal_pci_detach_dev(struct rte_pci_driver *dr,
217                 struct rte_pci_device *dev)
218 {
219         const struct rte_pci_id *id_table;
220
221         if ((dr == NULL) || (dev == NULL))
222                 return -EINVAL;
223
224         for (id_table = dr->id_table; id_table->vendor_id != 0; id_table++) {
225
226                 /* check if device's identifiers match the driver's ones */
227                 if (id_table->vendor_id != dev->id.vendor_id &&
228                                 id_table->vendor_id != PCI_ANY_ID)
229                         continue;
230                 if (id_table->device_id != dev->id.device_id &&
231                                 id_table->device_id != PCI_ANY_ID)
232                         continue;
233                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
234                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
235                         continue;
236                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
237                                 id_table->subsystem_device_id != PCI_ANY_ID)
238                         continue;
239
240                 struct rte_pci_addr *loc = &dev->addr;
241
242                 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
243                                 loc->domain, loc->bus, loc->devid,
244                                 loc->function, dev->numa_node);
245
246                 RTE_LOG(DEBUG, EAL, "  remove driver: %x:%x %s\n", dev->id.vendor_id,
247                                 dev->id.device_id, dr->name);
248
249                 if (dr->devuninit && (dr->devuninit(dev) < 0))
250                         return -1;      /* negative value is an error */
251
252                 /* clear driver structure */
253                 dev->driver = NULL;
254
255                 if (dr->drv_flags & RTE_PCI_DRV_NEED_MAPPING)
256                         /* unmap resources for devices that use igb_uio */
257                         pci_unmap_device(dev);
258
259                 return 0;
260         }
261
262         /* return positive value if driver is not found */
263         return 1;
264 }
265
266 /*
267  * If vendor/device ID match, call the devinit() function of all
268  * registered driver for the given device. Return -1 if initialization
269  * failed, return 1 if no driver is found for this device.
270  */
271 static int
272 pci_probe_all_drivers(struct rte_pci_device *dev)
273 {
274         struct rte_pci_driver *dr = NULL;
275         int rc = 0;
276
277         if (dev == NULL)
278                 return -1;
279
280         TAILQ_FOREACH(dr, &pci_driver_list, next) {
281                 rc = rte_eal_pci_probe_one_driver(dr, dev);
282                 if (rc < 0)
283                         /* negative value is an error */
284                         return -1;
285                 if (rc > 0)
286                         /* positive value means driver not found */
287                         continue;
288                 return 0;
289         }
290         return 1;
291 }
292
293 /*
294  * If vendor/device ID match, call the devuninit() function of all
295  * registered driver for the given device. Return -1 if initialization
296  * failed, return 1 if no driver is found for this device.
297  */
298 static int
299 pci_detach_all_drivers(struct rte_pci_device *dev)
300 {
301         struct rte_pci_driver *dr = NULL;
302         int rc = 0;
303
304         if (dev == NULL)
305                 return -1;
306
307         TAILQ_FOREACH(dr, &pci_driver_list, next) {
308                 rc = rte_eal_pci_detach_dev(dr, dev);
309                 if (rc < 0)
310                         /* negative value is an error */
311                         return -1;
312                 if (rc > 0)
313                         /* positive value means driver not found */
314                         continue;
315                 return 0;
316         }
317         return 1;
318 }
319
320 /*
321  * Find the pci device specified by pci address, then invoke probe function of
322  * the driver of the devive.
323  */
324 int
325 rte_eal_pci_probe_one(const struct rte_pci_addr *addr)
326 {
327         struct rte_pci_device *dev = NULL;
328         int ret = 0;
329
330         if (addr == NULL)
331                 return -1;
332
333         TAILQ_FOREACH(dev, &pci_device_list, next) {
334                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
335                         continue;
336
337                 ret = pci_probe_all_drivers(dev);
338                 if (ret < 0)
339                         goto err_return;
340                 return 0;
341         }
342         return -1;
343
344 err_return:
345         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
346                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
347                         dev->addr.devid, dev->addr.function);
348         return -1;
349 }
350
351 /*
352  * Detach device specified by its pci address.
353  */
354 int
355 rte_eal_pci_detach(const struct rte_pci_addr *addr)
356 {
357         struct rte_pci_device *dev = NULL;
358         int ret = 0;
359
360         if (addr == NULL)
361                 return -1;
362
363         TAILQ_FOREACH(dev, &pci_device_list, next) {
364                 if (rte_eal_compare_pci_addr(&dev->addr, addr))
365                         continue;
366
367                 ret = pci_detach_all_drivers(dev);
368                 if (ret < 0)
369                         goto err_return;
370
371                 TAILQ_REMOVE(&pci_device_list, dev, next);
372                 return 0;
373         }
374         return -1;
375
376 err_return:
377         RTE_LOG(WARNING, EAL, "Requested device " PCI_PRI_FMT
378                         " cannot be used\n", dev->addr.domain, dev->addr.bus,
379                         dev->addr.devid, dev->addr.function);
380         return -1;
381 }
382
383 /*
384  * Scan the content of the PCI bus, and call the devinit() function for
385  * all registered drivers that have a matching entry in its id_table
386  * for discovered devices.
387  */
388 int
389 rte_eal_pci_probe(void)
390 {
391         struct rte_pci_device *dev = NULL;
392         struct rte_devargs *devargs;
393         int probe_all = 0;
394         int ret = 0;
395
396         if (rte_eal_devargs_type_count(RTE_DEVTYPE_WHITELISTED_PCI) == 0)
397                 probe_all = 1;
398
399         TAILQ_FOREACH(dev, &pci_device_list, next) {
400
401                 /* set devargs in PCI structure */
402                 devargs = pci_devargs_lookup(dev);
403                 if (devargs != NULL)
404                         dev->devargs = devargs;
405
406                 /* probe all or only whitelisted devices */
407                 if (probe_all)
408                         ret = pci_probe_all_drivers(dev);
409                 else if (devargs != NULL &&
410                         devargs->type == RTE_DEVTYPE_WHITELISTED_PCI)
411                         ret = pci_probe_all_drivers(dev);
412                 if (ret < 0)
413                         rte_exit(EXIT_FAILURE, "Requested device " PCI_PRI_FMT
414                                  " cannot be used\n", dev->addr.domain, dev->addr.bus,
415                                  dev->addr.devid, dev->addr.function);
416         }
417
418         return 0;
419 }
420
421 /* dump one device */
422 static int
423 pci_dump_one_device(FILE *f, struct rte_pci_device *dev)
424 {
425         int i;
426
427         fprintf(f, PCI_PRI_FMT, dev->addr.domain, dev->addr.bus,
428                dev->addr.devid, dev->addr.function);
429         fprintf(f, " - vendor:%x device:%x\n", dev->id.vendor_id,
430                dev->id.device_id);
431
432         for (i = 0; i != sizeof(dev->mem_resource) /
433                 sizeof(dev->mem_resource[0]); i++) {
434                 fprintf(f, "   %16.16"PRIx64" %16.16"PRIx64"\n",
435                         dev->mem_resource[i].phys_addr,
436                         dev->mem_resource[i].len);
437         }
438         return 0;
439 }
440
441 /* dump devices on the bus */
442 void
443 rte_eal_pci_dump(FILE *f)
444 {
445         struct rte_pci_device *dev = NULL;
446
447         TAILQ_FOREACH(dev, &pci_device_list, next) {
448                 pci_dump_one_device(f, dev);
449         }
450 }
451
452 /* register a driver */
453 void
454 rte_eal_pci_register(struct rte_pci_driver *driver)
455 {
456         TAILQ_INSERT_TAIL(&pci_driver_list, driver, next);
457 }
458
459 /* unregister a driver */
460 void
461 rte_eal_pci_unregister(struct rte_pci_driver *driver)
462 {
463         TAILQ_REMOVE(&pci_driver_list, driver, next);
464 }