doc: add Meson coding style to contributors guide
[dpdk.git] / lib / librte_eal / common / eal_common_bus.c
index ef10390..baa5b53 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2016 NXP
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of NXP nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2016 NXP
  */
 
 #include <stdio.h>
 #include <sys/queue.h>
 
 #include <rte_bus.h>
+#include <rte_debug.h>
+#include <rte_string_fns.h>
+#include <rte_errno.h>
 
 #include "eal_private.h"
 
-struct rte_bus_list rte_bus_list =
+static struct rte_bus_list rte_bus_list =
        TAILQ_HEAD_INITIALIZER(rte_bus_list);
 
 void
@@ -49,6 +23,10 @@ rte_bus_register(struct rte_bus *bus)
        RTE_VERIFY(bus->name && strlen(bus->name));
        /* A bus should mandatorily have the scan implemented */
        RTE_VERIFY(bus->scan);
+       RTE_VERIFY(bus->probe);
+       RTE_VERIFY(bus->find_device);
+       /* Buses supporting driver plug also require unplug. */
+       RTE_VERIFY(!bus->plug || bus->unplug);
 
        TAILQ_INSERT_TAIL(&rte_bus_list, bus, next);
        RTE_LOG(DEBUG, EAL, "Registered [%s] bus.\n", bus->name);
@@ -70,11 +48,38 @@ rte_bus_scan(void)
 
        TAILQ_FOREACH(bus, &rte_bus_list, next) {
                ret = bus->scan();
-               if (ret) {
+               if (ret)
                        RTE_LOG(ERR, EAL, "Scan for (%s) bus failed.\n",
                                bus->name);
-                       return ret;
+       }
+
+       return 0;
+}
+
+/* Probe all devices of all buses */
+int
+rte_bus_probe(void)
+{
+       int ret;
+       struct rte_bus *bus, *vbus = NULL;
+
+       TAILQ_FOREACH(bus, &rte_bus_list, next) {
+               if (!strcmp(bus->name, "vdev")) {
+                       vbus = bus;
+                       continue;
                }
+
+               ret = bus->probe();
+               if (ret)
+                       RTE_LOG(ERR, EAL, "Bus (%s) probe failed.\n",
+                               bus->name);
+       }
+
+       if (vbus) {
+               ret = vbus->probe();
+               if (ret)
+                       RTE_LOG(ERR, EAL, "Bus (%s) probe failed.\n",
+                               vbus->name);
        }
 
        return 0;
@@ -111,3 +116,164 @@ rte_bus_dump(FILE *f)
                }
        }
 }
+
+struct rte_bus *
+rte_bus_find(const struct rte_bus *start, rte_bus_cmp_t cmp,
+            const void *data)
+{
+       struct rte_bus *bus;
+
+       if (start != NULL)
+               bus = TAILQ_NEXT(start, next);
+       else
+               bus = TAILQ_FIRST(&rte_bus_list);
+       while (bus != NULL) {
+               if (cmp(bus, data) == 0)
+                       break;
+               bus = TAILQ_NEXT(bus, next);
+       }
+       return bus;
+}
+
+static int
+cmp_rte_device(const struct rte_device *dev1, const void *_dev2)
+{
+       const struct rte_device *dev2 = _dev2;
+
+       return dev1 != dev2;
+}
+
+static int
+bus_find_device(const struct rte_bus *bus, const void *_dev)
+{
+       struct rte_device *dev;
+
+       dev = bus->find_device(NULL, cmp_rte_device, _dev);
+       return dev == NULL;
+}
+
+struct rte_bus *
+rte_bus_find_by_device(const struct rte_device *dev)
+{
+       return rte_bus_find(NULL, bus_find_device, (const void *)dev);
+}
+
+static int
+cmp_bus_name(const struct rte_bus *bus, const void *_name)
+{
+       const char *name = _name;
+
+       return strcmp(bus->name, name);
+}
+
+struct rte_bus *
+rte_bus_find_by_name(const char *busname)
+{
+       return rte_bus_find(NULL, cmp_bus_name, (const void *)busname);
+}
+
+static int
+bus_can_parse(const struct rte_bus *bus, const void *_name)
+{
+       const char *name = _name;
+
+       return !(bus->parse && bus->parse(name, NULL) == 0);
+}
+
+struct rte_bus *
+rte_bus_find_by_device_name(const char *str)
+{
+       char name[RTE_DEV_NAME_MAX_LEN];
+       char *c;
+
+       strlcpy(name, str, sizeof(name));
+       c = strchr(name, ',');
+       if (c != NULL)
+               c[0] = '\0';
+       return rte_bus_find(NULL, bus_can_parse, name);
+}
+
+
+/*
+ * Get iommu class of devices on the bus.
+ */
+enum rte_iova_mode
+rte_bus_get_iommu_class(void)
+{
+       enum rte_iova_mode mode = RTE_IOVA_DC;
+       bool buses_want_va = false;
+       bool buses_want_pa = false;
+       struct rte_bus *bus;
+
+       TAILQ_FOREACH(bus, &rte_bus_list, next) {
+               enum rte_iova_mode bus_iova_mode;
+
+               if (bus->get_iommu_class == NULL)
+                       continue;
+
+               bus_iova_mode = bus->get_iommu_class();
+               RTE_LOG(DEBUG, EAL, "Bus %s wants IOVA as '%s'\n",
+                       bus->name,
+                       bus_iova_mode == RTE_IOVA_DC ? "DC" :
+                       (bus_iova_mode == RTE_IOVA_PA ? "PA" : "VA"));
+               if (bus_iova_mode == RTE_IOVA_PA)
+                       buses_want_pa = true;
+               else if (bus_iova_mode == RTE_IOVA_VA)
+                       buses_want_va = true;
+       }
+       if (buses_want_va && !buses_want_pa) {
+               mode = RTE_IOVA_VA;
+       } else if (buses_want_pa && !buses_want_va) {
+               mode = RTE_IOVA_PA;
+       } else {
+               mode = RTE_IOVA_DC;
+               if (buses_want_va) {
+                       RTE_LOG(WARNING, EAL, "Some buses want 'VA' but forcing 'DC' because other buses want 'PA'.\n");
+                       RTE_LOG(WARNING, EAL, "Depending on the final decision by the EAL, not all buses may be able to initialize.\n");
+               }
+       }
+
+       return mode;
+}
+
+static int
+bus_handle_sigbus(const struct rte_bus *bus,
+                       const void *failure_addr)
+{
+       int ret;
+
+       if (!bus->sigbus_handler)
+               return -1;
+
+       ret = bus->sigbus_handler(failure_addr);
+
+       /* find bus but handle failed, keep the errno be set. */
+       if (ret < 0 && rte_errno == 0)
+               rte_errno = ENOTSUP;
+
+       return ret > 0;
+}
+
+int
+rte_bus_sigbus_handler(const void *failure_addr)
+{
+       struct rte_bus *bus;
+
+       int ret = 0;
+       int old_errno = rte_errno;
+
+       rte_errno = 0;
+
+       bus = rte_bus_find(NULL, bus_handle_sigbus, failure_addr);
+       /* can not find bus. */
+       if (!bus)
+               return 1;
+       /* find bus but handle failed, pass on the new errno. */
+       else if (rte_errno != 0)
+               return -1;
+
+       /* restore the old errno. */
+       rte_errno = old_errno;
+
+       return ret;
+}