From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 39CD2A0A0C; Sun, 13 Jun 2021 10:20:09 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5C39040DF4; Sun, 13 Jun 2021 10:20:07 +0200 (CEST) Received: from NAM11-CO1-obe.outbound.protection.outlook.com (mail-co1nam11on2080.outbound.protection.outlook.com [40.107.220.80]) by mails.dpdk.org (Postfix) with ESMTP id 9071C4068C for ; Sun, 13 Jun 2021 10:20:06 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=GJEDznrxcg1r9hcOfRRFhKyoRlYqrObYhsHFu25VcV4bQILBGlthlRkDMyzH+Mm0VRHAchxcr0/YoNR35Sgxny9LDqfF1k3lY/0KUKuXDp8BAAMqSK6oQ+08ysbuhCOHE1OqkMSlcGAWI4gL4aRXF8zMdpP12ln/AdmmC6NwrkBKmyIeOAHh3+zN1GYC7fM3TehSoBf8cxr9EcO8S6C2Y+gVYQ+GJl72Cyl7hS4/zsR4DDbJ12m2vRqUa3N8azlx0DG6v9XBlisM/v/K9UXLvMuns2GoNtsmI+qaYO2OIcU9BzM30GggnRhVkc7WwnqfSDiYEOFNkW4gyCvsqoWyjQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=/Ru8U87RuKynba3lGtNtD9kgkJCbWlX11ZO0VAmLJyA=; b=gB9cr0ISKGk47J3uCKSV3pMuVt2DPySSiY9MMdhrxJXQ7dH7jUDg7k9oPN9TclzR4Ntv4L0rIepHUa4w2TmEXbQnywpiieANnp78b2LICA8h7ADSoyz0nfKJKGubX8JsEXix+8Z4JOf1p308sfd820Ki8m0ZULNQVGQ+j06dyAutYs5bFKREXjKW7QLWUccy1/EDfDWvEecI8KVxhtjY6gASSQNBypsTIgI23f8+RW0pYQ6BJ21zLQsa7soSfYvuxLLFNdvtWTFslagZ9SDHsjCSZDV5/Ihvkun7rI/3P7CK/Og2mIqrw+kKBm2jq+iA+LesHDQXkp2yM9aLpxFQSg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.112.34) smtp.rcpttodomain=ashroe.eu smtp.mailfrom=nvidia.com; dmarc=pass (p=none sp=none pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=/Ru8U87RuKynba3lGtNtD9kgkJCbWlX11ZO0VAmLJyA=; b=oBL9rs/HLsBLDfZa3c4a5C2J8JZiEHsoUhVJwwsmnom+ap+yxBO2tfUNPjYJTMyNumf/J9MVYVB6NWnmbrtZYYq30DiHE1iAYmlIWLoqg2OnlhK5AEEPHj1VqpC5nQh0SSjHct0pndmrt+uuHhUIGhrxV8LDai3fCH8T3LOS8GB/CfIEru6NYYJFQuqqEWw2z2tXQzxSE44BN3ZAG9DPQ7cXZIz/riSuwbUvDI4P6sjsydRjNzYjaCCPfg9os4hjrfsUK3+D+XAr/r247XE4u/28yvI7wSc42U3kCssCcrLV6CtwoJqwEjTI6CqmdWHs6UBdBAC7oAgQ4DWkrYz2Og== Received: from BN6PR1701CA0006.namprd17.prod.outlook.com (2603:10b6:405:15::16) by BN6PR1201MB2467.namprd12.prod.outlook.com (2603:10b6:404:a7::8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4219.23; Sun, 13 Jun 2021 08:20:02 +0000 Received: from BN8NAM11FT013.eop-nam11.prod.protection.outlook.com (2603:10b6:405:15:cafe::44) by BN6PR1701CA0006.outlook.office365.com (2603:10b6:405:15::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4150.26 via Frontend Transport; Sun, 13 Jun 2021 08:20:02 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.112.34) smtp.mailfrom=nvidia.com; ashroe.eu; dkim=none (message not signed) header.d=none;ashroe.eu; dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.112.34 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.112.34; helo=mail.nvidia.com; Received: from mail.nvidia.com (216.228.112.34) by BN8NAM11FT013.mail.protection.outlook.com (10.13.176.182) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.4219.21 via Frontend Transport; Sun, 13 Jun 2021 08:20:01 +0000 Received: from nvidia.com (172.20.187.5) by HQMAIL107.nvidia.com (172.20.187.13) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Sun, 13 Jun 2021 08:19:59 +0000 From: Xueming Li To: CC: , , Wang Haiyue , Thomas Monjalon , Kinsella Ray , Parav Pandit , Neil Horman Date: Sun, 13 Jun 2021 16:19:17 +0800 Message-ID: <20210613081917.24306-2-xuemingl@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210510134732.2174-1-xuemingl@nvidia.com> References: <20210510134732.2174-1-xuemingl@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [172.20.187.5] X-ClientProxiedBy: HQMAIL105.nvidia.com (172.20.187.12) To HQMAIL107.nvidia.com (172.20.187.13) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: cccad192-50f8-4441-a4ef-08d92e440a8a X-MS-TrafficTypeDiagnostic: BN6PR1201MB2467: X-LD-Processed: 43083d15-7273-40c1-b7db-39efd9ccc17a,ExtAddr X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:5797; X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: x1AQrNZl10TBExvdrLtXp9lnsLBu6DlrFSzKbRGa6gUlQljrdofkio1mWVBuotlzZ5LH0n2+LKrMNWKt+k19WUKLaDtAAkrLpiBss4sg/QY88T1G80iOJCEIY6TjBPK+2cQ9KW6SYjQo5dAwW9KvUB0ZqRsB6BrHCerYbfYyj6Eu6maRSOg6GPMqWAMLTSI/8V+jU8Jp5LqtJUDDfx2yPZYoBgv9UzFAlh0Et1okfFhcoMba9qbJSH9Cj7aWoX+O+WAy6AxPMIqjrSXwY0fkbS00Wx/wy/OkfGnUaREuV7wEA/q7JE80u/VrmJbQlG89Ztiqxu1ovRkt2ODViH2W+LD8ccXBfZwb4VFecrL9r00aCANRWgVzUj+tziW95deqSxXL/VXvhKzRjaM16FTJSoyxERAoNqrMvlHyzWojVZFWxvdYG1mDW/6ALd/osF974fZp+J/eEo026Qa/GwWCN7vyB2d1I4HLwWGFYhfWmZgYCCSEurjS4Eve8qk5EfKh3Srj8cKLcaN6JhcaeXsZjf+xgOlQzo7ZCGnoD+vsN3/rga0myNiVxmFIM7Q15aX9boApaeMrYmMYKgoXsScha0cECaDxxVXks/2xNcwvL0KAq8V9BddH1luNu9WLp8ZH035UUP5Acm2wmF8e5qMSPx/fX+XwZotXfaPH9DOvAahBBnl0t7Jl55guLxiM0Uqkmrv1zoT2N3LwUP+qx5bdOEkzbLzE2gqExzO5p88zQrss/nnkUQ7/R/dCY6fqe3kv6+iKEHPKDohm++edSNOsKXSdykVSY7nKv30KzHnWYFo= X-Forefront-Antispam-Report: CIP:216.228.112.34; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:schybrid03.nvidia.com; CAT:NONE; SFS:(4636009)(136003)(39860400002)(376002)(396003)(346002)(36840700001)(46966006)(8936002)(4326008)(2906002)(186003)(966005)(26005)(109986005)(1076003)(36906005)(36860700001)(8676002)(7696005)(478600001)(54906003)(316002)(16526019)(6286002)(83380400001)(82310400003)(5660300002)(30864003)(426003)(7636003)(356005)(70206006)(86362001)(36756003)(82740400003)(6666004)(2616005)(55016002)(70586007)(47076005)(336012)(266003); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Jun 2021 08:20:01.5899 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: cccad192-50f8-4441-a4ef-08d92e440a8a X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.112.34]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: BN8NAM11FT013.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR1201MB2467 Subject: [dpdk-dev] [PATCH v3 2/2] bus/auxiliary: introduce auxiliary bus X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Auxiliary bus [1] provides a way to split function into child-devices representing sub-domains of functionality. Each auxiliary device represents a part of its parent functionality. Auxiliary device is identified by unique device name, sysfs path: /sys/bus/auxiliary/devices/ Devargs syntax of auxiliary device: -a auxiliary:[,args...] [1] kernel auxiliary bus document: https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html Signed-off-by: Xueming Li Cc: Wang Haiyue Cc: Thomas Monjalon Cc: Kinsella Ray --- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 7 + drivers/bus/auxiliary/auxiliary_common.c | 419 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 +++ drivers/bus/auxiliary/linux/auxiliary.c | 142 ++++++++ drivers/bus/auxiliary/meson.build | 11 + drivers/bus/auxiliary/private.h | 112 ++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 963 insertions(+) create mode 100644 drivers/bus/auxiliary/auxiliary_common.c create mode 100644 drivers/bus/auxiliary/auxiliary_params.c create mode 100644 drivers/bus/auxiliary/linux/auxiliary.c create mode 100644 drivers/bus/auxiliary/meson.build create mode 100644 drivers/bus/auxiliary/private.h create mode 100644 drivers/bus/auxiliary/rte_bus_auxiliary.h create mode 100644 drivers/bus/auxiliary/version.map diff --git a/MAINTAINERS b/MAINTAINERS index 5877a16971..eaf691ca6a 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit +M: Xueming Li +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu F: drivers/bus/ifpga/ diff --git a/doc/guides/rel_notes/release_21_08.rst b/doc/guides/rel_notes/release_21_08.rst index a6ecfdf3ce..b335064963 100644 --- a/doc/guides/rel_notes/release_21_08.rst +++ b/doc/guides/rel_notes/release_21_08.rst @@ -55,6 +55,13 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added auxiliary bus support.** + + * Auxiliary bus provides a way to split function into child-devices + representing sub-domains of functionality. Each auxiliary device + represents a part of its parent functionality. + * Devargs syntax of auxiliary device: -a auxiliary:[,args...] + Removed Items ------------- diff --git a/drivers/bus/auxiliary/auxiliary_common.c b/drivers/bus/auxiliary/auxiliary_common.c new file mode 100644 index 0000000000..91008bdc80 --- /dev/null +++ b/drivers/bus/auxiliary/auxiliary_common.c @@ -0,0 +1,419 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright 2021 Mellanox Technologies, Ltd + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "private.h" +#include "rte_bus_auxiliary.h" + +static struct rte_devargs * +auxiliary_devargs_lookup(const char *name) +{ + struct rte_devargs *devargs; + + RTE_EAL_DEVARGS_FOREACH(RTE_BUS_AXILIARY_NAME, devargs) { + if (strcmp(devargs->name, name) == 0) + return devargs; + } + return NULL; +} + +/* + * Test whether the auxiliary device exist + * + * Stub for OS not supporting auxiliary bus. + */ +__rte_weak bool +auxiliary_dev_exists(const char *name) +{ + RTE_SET_USED(name); + return false; +} + +/* + * Scan the content of the auxiliary bus, and the devices in the devices + * list + * + * Stub for OS not supporting auxiliary bus. + */ +__rte_weak int +auxiliary_scan(void) +{ + return 0; +} + +/** + * Update a device being scanned. + * + * @param aux_dev + * AUXILIARY device. + */ +void +auxiliary_on_scan(struct rte_auxiliary_device *aux_dev) +{ + aux_dev->device.devargs = auxiliary_devargs_lookup(aux_dev->name); +} + +/* + * Match the auxiliary driver and device using driver function. + */ +bool +auxiliary_match(const struct rte_auxiliary_driver *aux_drv, + const struct rte_auxiliary_device *aux_dev) +{ + if (aux_drv->match == NULL) + return false; + return aux_drv->match(aux_dev->name); +} + +/* + * Call the probe() function of the driver. + */ +static int +rte_auxiliary_probe_one_driver(struct rte_auxiliary_driver *dr, + struct rte_auxiliary_device *dev) +{ + enum rte_iova_mode iova_mode; + int ret; + + if ((dr == NULL) || (dev == NULL)) + return -EINVAL; + + /* The device is not blocked; Check if driver supports it. */ + if (!auxiliary_match(dr, dev)) + /* Match of device and driver failed */ + return 1; + + AUXILIARY_LOG(DEBUG, "Auxiliary device %s on NUMA socket %i\n", + dev->name, dev->device.numa_node); + + /* No initialization when marked as blocked, return without error. */ + if (dev->device.devargs != NULL && + dev->device.devargs->policy == RTE_DEV_BLOCKED) { + AUXILIARY_LOG(INFO, " Device is blocked, not initializing\n"); + return -1; + } + + if (dev->device.numa_node < 0) { + AUXILIARY_LOG(WARNING, " Invalid NUMA socket, default to 0\n"); + dev->device.numa_node = 0; + } + + AUXILIARY_LOG(DEBUG, " Probe driver: %s\n", dr->driver.name); + + iova_mode = rte_eal_iova_mode(); + if ((dr->drv_flags & RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA) && + iova_mode != RTE_IOVA_VA) { + AUXILIARY_LOG(ERR, " Expecting VA IOVA mode but current mode is PA, not initializing\n"); + return -EINVAL; + } + + dev->driver = dr; + + AUXILIARY_LOG(INFO, "Probe auxiliary driver: %s device: %s (socket %i)\n", + dr->driver.name, dev->name, dev->device.numa_node); + ret = dr->probe(dr, dev); + if (ret) + dev->driver = NULL; + else + dev->device.driver = &dr->driver; + + return ret; +} + +/* + * Call the remove() function of the driver. + */ +static int +rte_auxiliary_driver_remove_dev(struct rte_auxiliary_device *dev) +{ + struct rte_auxiliary_driver *dr; + int ret = 0; + + if (dev == NULL) + return -EINVAL; + + dr = dev->driver; + + AUXILIARY_LOG(DEBUG, "Auxiliary device %s on NUMA socket %i\n", + dev->name, dev->device.numa_node); + + AUXILIARY_LOG(DEBUG, " remove driver: %s %s\n", + dev->name, dr->driver.name); + + if (dr->remove) { + ret = dr->remove(dev); + if (ret < 0) + return ret; + } + + /* clear driver structure */ + dev->driver = NULL; + dev->device.driver = NULL; + + return 0; +} + +/* + * Call the probe() function of all registered driver for the given device. + * Return < 0 if initialization failed. + * Return 1 if no driver is found for this device. + */ +static int +auxiliary_probe_all_drivers(struct rte_auxiliary_device *dev) +{ + struct rte_auxiliary_driver *dr; + int rc; + + if (dev == NULL) + return -EINVAL; + + FOREACH_DRIVER_ON_AUXILIARYBUS(dr) { + if (!dr->match(dev->name)) + continue; + + rc = rte_auxiliary_probe_one_driver(dr, dev); + if (rc < 0) + /* negative value is an error */ + return rc; + if (rc > 0) + /* positive value means driver doesn't support it */ + continue; + return 0; + } + return 1; +} + +/* + * Scan the content of the auxiliary bus, and call the probe() function for + * + * all registered drivers that have a matching entry in its id_table + * for discovered devices. + */ +static int +auxiliary_probe(void) +{ + struct rte_auxiliary_device *dev = NULL; + size_t probed = 0, failed = 0; + int ret = 0; + + FOREACH_DEVICE_ON_AUXILIARYBUS(dev) { + probed++; + + ret = auxiliary_probe_all_drivers(dev); + if (ret < 0) { + if (ret != -EEXIST) { + AUXILIARY_LOG(ERR, "Requested device %s cannot be used\n", + dev->name); + rte_errno = errno; + failed++; + } + ret = 0; + } + } + + return (probed && probed == failed) ? -1 : 0; +} + +static int +auxiliary_parse(const char *name, void *addr) +{ + struct rte_auxiliary_driver *dr = NULL; + const char **out = addr; + + /* Allow dummy name to prevent bus scan. */ + if (strlen(name) == 0) + return 0; + + FOREACH_DRIVER_ON_AUXILIARYBUS(dr) { + if (dr->match(name)) + break; + } + if (dr != NULL && addr != NULL) + *out = name; + return dr != NULL ? 0 : -1; +} + +/* register a driver */ +void +rte_auxiliary_register(struct rte_auxiliary_driver *driver) +{ + TAILQ_INSERT_TAIL(&auxiliary_bus.driver_list, driver, next); + driver->bus = &auxiliary_bus; +} + +/* unregister a driver */ +void +rte_auxiliary_unregister(struct rte_auxiliary_driver *driver) +{ + TAILQ_REMOVE(&auxiliary_bus.driver_list, driver, next); + driver->bus = NULL; +} + +/* Add a device to auxiliary bus */ +void +auxiliary_add_device(struct rte_auxiliary_device *aux_dev) +{ + TAILQ_INSERT_TAIL(&auxiliary_bus.device_list, aux_dev, next); +} + +/* Insert a device into a predefined position in auxiliary bus */ +void +auxiliary_insert_device(struct rte_auxiliary_device *exist_aux_dev, + struct rte_auxiliary_device *new_aux_dev) +{ + TAILQ_INSERT_BEFORE(exist_aux_dev, new_aux_dev, next); +} + +/* Remove a device from auxiliary bus */ +static void +rte_auxiliary_remove_device(struct rte_auxiliary_device *auxiliary_dev) +{ + TAILQ_REMOVE(&auxiliary_bus.device_list, auxiliary_dev, next); +} + +static struct rte_device * +auxiliary_find_device(const struct rte_device *start, rte_dev_cmp_t cmp, + const void *data) +{ + const struct rte_auxiliary_device *pstart; + struct rte_auxiliary_device *adev; + + if (start != NULL) { + pstart = RTE_DEV_TO_AUXILIARY_CONST(start); + adev = TAILQ_NEXT(pstart, next); + } else { + adev = TAILQ_FIRST(&auxiliary_bus.device_list); + } + while (adev != NULL) { + if (cmp(&adev->device, data) == 0) + return &adev->device; + adev = TAILQ_NEXT(adev, next); + } + return NULL; +} + +static int +auxiliary_plug(struct rte_device *dev) +{ + if (!auxiliary_dev_exists(dev->name)) + return -ENOENT; + return auxiliary_probe_all_drivers(RTE_DEV_TO_AUXILIARY(dev)); +} + +static int +auxiliary_unplug(struct rte_device *dev) +{ + struct rte_auxiliary_device *adev; + int ret; + + adev = RTE_DEV_TO_AUXILIARY(dev); + ret = rte_auxiliary_driver_remove_dev(adev); + if (ret == 0) { + rte_auxiliary_remove_device(adev); + rte_devargs_remove(dev->devargs); + free(adev); + } + return ret; +} + +static int +auxiliary_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len) +{ + struct rte_auxiliary_device *aux_dev = RTE_DEV_TO_AUXILIARY(dev); + + if (dev == NULL || !aux_dev->driver) { + rte_errno = EINVAL; + return -1; + } + if (aux_dev->driver->dma_map) + return aux_dev->driver->dma_map(aux_dev, addr, iova, len); + rte_errno = ENOTSUP; + return -1; +} + +static int +auxiliary_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova, + size_t len) +{ + struct rte_auxiliary_device *aux_dev = RTE_DEV_TO_AUXILIARY(dev); + + if (dev == NULL || !aux_dev->driver) { + rte_errno = EINVAL; + return -1; + } + if (aux_dev->driver->dma_unmap) + return aux_dev->driver->dma_unmap(aux_dev, addr, iova, len); + rte_errno = ENOTSUP; + return -1; +} + +bool +auxiliary_ignore_device(const char *name) +{ + struct rte_devargs *devargs = auxiliary_devargs_lookup(name); + + switch (auxiliary_bus.bus.conf.scan_mode) { + case RTE_BUS_SCAN_ALLOWLIST: + if (devargs && devargs->policy == RTE_DEV_ALLOWED) + return false; + break; + case RTE_BUS_SCAN_UNDEFINED: + case RTE_BUS_SCAN_BLOCKLIST: + if (devargs == NULL || devargs->policy != RTE_DEV_BLOCKED) + return false; + break; + } + return true; +} + +static enum rte_iova_mode +auxiliary_get_iommu_class(void) +{ + const struct rte_auxiliary_driver *drv; + + FOREACH_DRIVER_ON_AUXILIARYBUS(drv) { + if (drv->drv_flags & RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA) + return RTE_IOVA_VA; + } + + return RTE_IOVA_DC; +} + +struct rte_auxiliary_bus auxiliary_bus = { + .bus = { + .scan = auxiliary_scan, + .probe = auxiliary_probe, + .find_device = auxiliary_find_device, + .plug = auxiliary_plug, + .unplug = auxiliary_unplug, + .parse = auxiliary_parse, + .dma_map = auxiliary_dma_map, + .dma_unmap = auxiliary_dma_unmap, + .get_iommu_class = auxiliary_get_iommu_class, + .dev_iterate = auxiliary_dev_iterate, + }, + .device_list = TAILQ_HEAD_INITIALIZER(auxiliary_bus.device_list), + .driver_list = TAILQ_HEAD_INITIALIZER(auxiliary_bus.driver_list), +}; + +RTE_REGISTER_BUS(auxiliary, auxiliary_bus.bus); +RTE_LOG_REGISTER_DEFAULT(auxiliary_bus_logtype, NOTICE); diff --git a/drivers/bus/auxiliary/auxiliary_params.c b/drivers/bus/auxiliary/auxiliary_params.c new file mode 100644 index 0000000000..5a1b029839 --- /dev/null +++ b/drivers/bus/auxiliary/auxiliary_params.c @@ -0,0 +1,58 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright 2021 Mellanox Technologies, Ltd + */ + +#include + +#include +#include +#include +#include + +#include "private.h" +#include "rte_bus_auxiliary.h" + +enum auxiliary_params { + RTE_AUXILIARY_PARAM_NAME, +}; + +static const char * const auxiliary_params_keys[] = { + [RTE_AUXILIARY_PARAM_NAME] = "name", +}; + +static int +auxiliary_dev_match(const struct rte_device *dev, + const void *_kvlist) +{ + const struct rte_kvargs *kvlist = _kvlist; + int ret; + + ret = rte_kvargs_process(kvlist, + auxiliary_params_keys[RTE_AUXILIARY_PARAM_NAME], + rte_kvargs_strcmp, (void *)(uintptr_t)dev->name); + + return ret != 0 ? -1 : 0; +} + +void * +auxiliary_dev_iterate(const void *start, + const char *str, + const struct rte_dev_iterator *it __rte_unused) +{ + rte_bus_find_device_t find_device; + struct rte_kvargs *kvargs = NULL; + struct rte_device *dev; + + if (str != NULL) { + kvargs = rte_kvargs_parse(str, auxiliary_params_keys); + if (kvargs == NULL) { + RTE_LOG(ERR, EAL, "cannot parse argument list\n"); + rte_errno = EINVAL; + return NULL; + } + } + find_device = auxiliary_bus.bus.find_device; + dev = find_device(start, auxiliary_dev_match, kvargs); + rte_kvargs_free(kvargs); + return dev; +} diff --git a/drivers/bus/auxiliary/linux/auxiliary.c b/drivers/bus/auxiliary/linux/auxiliary.c new file mode 100644 index 0000000000..22e0e20493 --- /dev/null +++ b/drivers/bus/auxiliary/linux/auxiliary.c @@ -0,0 +1,142 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright 2021 Mellanox Technologies, Ltd + */ + +#include +#include + +#include +#include +#include +#include +#include +#include + +#include "../rte_bus_auxiliary.h" +#include "../private.h" + +#define AUXILIARY_SYSFS_PATH "/sys/bus/auxiliary/devices" + +/* Scan one auxiliary sysfs entry, and fill the devices list from it. */ +static int +auxiliary_scan_one(const char *dirname, const char *name) +{ + struct rte_auxiliary_device *dev; + struct rte_auxiliary_device *dev2; + char filename[PATH_MAX]; + unsigned long tmp; + int ret; + + dev = malloc(sizeof(*dev)); + if (dev == NULL) + return -1; + + memset(dev, 0, sizeof(*dev)); + if (rte_strscpy(dev->name, name, sizeof(dev->name)) < 0) { + free(dev); + return -1; + } + dev->device.name = dev->name; + dev->device.bus = &auxiliary_bus.bus; + + /* Get numa node, default to 0 if not present */ + snprintf(filename, sizeof(filename), "%s/%s/numa_node", + dirname, name); + if (access(filename, F_OK) != -1) { + if (eal_parse_sysfs_value(filename, &tmp) == 0) + dev->device.numa_node = tmp; + else + dev->device.numa_node = -1; + } else { + dev->device.numa_node = 0; + } + + auxiliary_on_scan(dev); + + /* Device is valid, add in list (sorted) */ + TAILQ_FOREACH(dev2, &auxiliary_bus.device_list, next) { + ret = strcmp(dev->name, dev2->name); + if (ret > 0) + continue; + if (ret < 0) { + auxiliary_insert_device(dev2, dev); + } else { /* already registered */ + if (rte_dev_is_probed(&dev2->device) && + dev2->device.devargs != dev->device.devargs) { + /* To probe device with new devargs. */ + rte_devargs_remove(dev2->device.devargs); + auxiliary_on_scan(dev2); + } + free(dev); + } + return 0; + } + auxiliary_add_device(dev); + return 0; +} + +/* + * Test whether the auxiliary device exist + */ +bool +auxiliary_dev_exists(const char *name) +{ + DIR *dir; + char dirname[PATH_MAX]; + + snprintf(dirname, sizeof(dirname), "%s/%s", + AUXILIARY_SYSFS_PATH, name); + dir = opendir(dirname); + if (dir == NULL) + return false; + closedir(dir); + return true; +} + +/* + * Scan the content of the auxiliary bus, and the devices in the devices + * list + */ +int +auxiliary_scan(void) +{ + struct dirent *e; + DIR *dir; + char dirname[PATH_MAX]; + struct rte_auxiliary_driver *drv; + + dir = opendir(AUXILIARY_SYSFS_PATH); + if (dir == NULL) { + AUXILIARY_LOG(INFO, "%s not found, is auxiliary module loaded?\n", + AUXILIARY_SYSFS_PATH); + return 0; + } + + while ((e = readdir(dir)) != NULL) { + if (e->d_name[0] == '.') + continue; + + if (auxiliary_ignore_device(e->d_name)) + continue; + + snprintf(dirname, sizeof(dirname), "%s/%s", + AUXILIARY_SYSFS_PATH, e->d_name); + + /* Ignore if no driver can handle. */ + FOREACH_DRIVER_ON_AUXILIARYBUS(drv) { + if (drv->match(e->d_name)) + break; + } + if (drv == NULL) + continue; + + if (auxiliary_scan_one(dirname, e->d_name) < 0) + goto error; + } + closedir(dir); + return 0; + +error: + closedir(dir); + return -1; +} diff --git a/drivers/bus/auxiliary/meson.build b/drivers/bus/auxiliary/meson.build new file mode 100644 index 0000000000..3d5c7b0d4a --- /dev/null +++ b/drivers/bus/auxiliary/meson.build @@ -0,0 +1,11 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright 2021 Mellanox Technologies, Ltd + +headers = files('rte_bus_auxiliary.h') +sources = files('auxiliary_common.c', + 'auxiliary_params.c') +if is_linux + sources += files('linux/auxiliary.c') +endif +deps += ['kvargs'] + diff --git a/drivers/bus/auxiliary/private.h b/drivers/bus/auxiliary/private.h new file mode 100644 index 0000000000..3146fcd5d3 --- /dev/null +++ b/drivers/bus/auxiliary/private.h @@ -0,0 +1,112 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright 2021 Mellanox Technologies, Ltd + */ + +#ifndef _AUXILIARY_PRIVATE_H_ +#define _AUXILIARY_PRIVATE_H_ + +#include +#include +#include "rte_bus_auxiliary.h" + +extern struct rte_auxiliary_bus auxiliary_bus; +extern int auxiliary_bus_logtype; + +#define AUXILIARY_LOG(level, fmt, args...) \ + rte_log(RTE_LOG_ ## level, auxiliary_bus_logtype, "%s(): " fmt "\n", \ + __func__, ##args) + +/* Auxiliary bus iterators */ +#define FOREACH_DEVICE_ON_AUXILIARYBUS(p) \ + TAILQ_FOREACH(p, &(auxiliary_bus.device_list), next) + +#define FOREACH_DRIVER_ON_AUXILIARYBUS(p) \ + TAILQ_FOREACH(p, &(auxiliary_bus.driver_list), next) + +bool auxiliary_dev_exists(const char *name); + +/** + * Scan the content of the auxiliary bus, and the devices in the devices + * list + * + * @return + * 0 on success, negative on error + */ +int auxiliary_scan(void); + +/** + * Update a device being scanned. + * + * @param aux_dev + * AUXILIARY device. + */ +void auxiliary_on_scan(struct rte_auxiliary_device *aux_dev); + +/** + * Validate whether a device with given auxiliary device should be ignored + * or not. + * + * @param name + * Auxiliary name of device to be validated + * @return + * true: if device is to be ignored, + * false: if device is to be scanned, + */ +bool auxiliary_ignore_device(const char *name); + +/** + * Add an auxiliary device to the auxiliary bus (append to auxiliary Device + * list). This function also updates the bus references of the auxiliary + * Device (and the generic device object embedded within. + * + * @param aux_dev + * AUXILIARY device to add + * @return void + */ +void auxiliary_add_device(struct rte_auxiliary_device *aux_dev); + +/** + * Insert an auxiliary device in the auxiliary bus at a particular location + * in the device list. It also updates the auxiliary bus reference of the + * new devices to be inserted. + * + * @param exist_aux_dev + * Existing auxiliary device in auxiliary bus + * @param new_aux_dev + * AUXILIARY device to be added before exist_aux_dev + * @return void + */ +void auxiliary_insert_device(struct rte_auxiliary_device *exist_aux_dev, + struct rte_auxiliary_device *new_aux_dev); + +/** + * Match the auxiliary Driver and Device by driver function + * + * @param aux_drv + * auxiliary driver + * @param aux_dev + * auxiliary device to match against the driver + * @return + * the driver can handle the device + */ +bool auxiliary_match(const struct rte_auxiliary_driver *aux_drv, + const struct rte_auxiliary_device *aux_dev); + +/** + * Iterate over internal devices, matching any device against the provided + * string. + * + * @param start + * Iteration starting point. + * @param str + * Device string to match against. + * @param it + * (unused) iterator structure. + * @return + * A pointer to the next matching device if any. + * NULL otherwise. + */ +void *auxiliary_dev_iterate(const void *start, const char *str, + const struct rte_dev_iterator *it); + +#endif /* _AUXILIARY_PRIVATE_H_ */ diff --git a/drivers/bus/auxiliary/rte_bus_auxiliary.h b/drivers/bus/auxiliary/rte_bus_auxiliary.h new file mode 100644 index 0000000000..94f0790ba0 --- /dev/null +++ b/drivers/bus/auxiliary/rte_bus_auxiliary.h @@ -0,0 +1,201 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright 2021 Mellanox Technologies, Ltd + */ + +#ifndef RTE_BUS_AUXILIARY_H +#define RTE_BUS_AUXILIARY_H + +/** + * @file + * + * Auxiliary Bus Interface. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#define RTE_BUS_AXILIARY_NAME "auxiliary" + +/* Forward declarations */ +struct rte_auxiliary_driver; +struct rte_auxiliary_bus; +struct rte_auxiliary_device; + +/** + * Match function for the driver to decide if device can be handled. + * + * @param name + * Pointer to the auxiliary device name. + * @return + * Whether the driver can handle the auxiliary device. + */ +typedef bool(rte_auxiliary_match_t) (const char *name); + +/** + * Initialization function for the driver called during auxiliary probing. + * + * @param drv + * Pointer to the auxiliary driver. + * @param dev + * Pointer to the auxiliary device. + * @return + * - 0 On success. + * - Negative value and rte_errno is set otherwise. + */ +typedef int(rte_auxiliary_probe_t) (struct rte_auxiliary_driver *drv, + struct rte_auxiliary_device *dev); + +/** + * Uninitialization function for the driver called during hotplugging. + * + * @param dev + * Pointer to the auxiliary device. + * @return + * - 0 On success. + * - Negative value and rte_errno is set otherwise. + */ +typedef int (rte_auxiliary_remove_t)(struct rte_auxiliary_device *dev); + +/** + * Driver-specific DMA mapping. After a successful call the device + * will be able to read/write from/to this segment. + * + * @param dev + * Pointer to the auxiliary device. + * @param addr + * Starting virtual address of memory to be mapped. + * @param iova + * Starting IOVA address of memory to be mapped. + * @param len + * Length of memory segment being mapped. + * @return + * - 0 On success. + * - Negative value and rte_errno is set otherwise. + */ +typedef int (rte_auxiliary_dma_map_t)(struct rte_auxiliary_device *dev, + void *addr, uint64_t iova, size_t len); + +/** + * Driver-specific DMA un-mapping. After a successful call the device + * will not be able to read/write from/to this segment. + * + * @param dev + * Pointer to the auxiliary device. + * @param addr + * Starting virtual address of memory to be unmapped. + * @param iova + * Starting IOVA address of memory to be unmapped. + * @param len + * Length of memory segment being unmapped. + * @return + * - 0 On success. + * - Negative value and rte_errno is set otherwise. + */ +typedef int (rte_auxiliary_dma_unmap_t)(struct rte_auxiliary_device *dev, + void *addr, uint64_t iova, size_t len); + +/** + * A structure describing an auxiliary device. + */ +struct rte_auxiliary_device { + TAILQ_ENTRY(rte_auxiliary_device) next; /**< Next probed device. */ + char name[RTE_DEV_NAME_MAX_LEN + 1]; /**< ASCII device name */ + struct rte_device device; /**< Inherit core device */ + struct rte_intr_handle intr_handle; /**< Interrupt handle */ + struct rte_auxiliary_driver *driver; /**< driver used in probing */ +}; + +/** List of auxiliary devices */ +TAILQ_HEAD(rte_auxiliary_device_list, rte_auxiliary_device); +/** List of auxiliary drivers */ +TAILQ_HEAD(rte_auxiliary_driver_list, rte_auxiliary_driver); + +/** + * Structure describing the auxiliary bus + */ +struct rte_auxiliary_bus { + struct rte_bus bus; /**< Inherit the generic class */ + struct rte_auxiliary_device_list device_list; /**< List of devices */ + struct rte_auxiliary_driver_list driver_list; /**< List of drivers */ +}; + +/** + * A structure describing an auxiliary driver. + */ +struct rte_auxiliary_driver { + TAILQ_ENTRY(rte_auxiliary_driver) next; /**< Next in list. */ + struct rte_driver driver; /**< Inherit core driver. */ + struct rte_auxiliary_bus *bus; /**< Auxiliary bus reference. */ + rte_auxiliary_match_t *match; /**< Device match function. */ + rte_auxiliary_probe_t *probe; /**< Device Probe function. */ + rte_auxiliary_remove_t *remove; /**< Device Remove function. */ + rte_auxiliary_dma_map_t *dma_map; /**< Device dma map function. */ + rte_auxiliary_dma_unmap_t *dma_unmap; /**< Device dma unmap function. */ + uint32_t drv_flags; /**< Flags RTE_auxiliary_DRV_*. */ +}; + +/** + * @internal + * Helper macro for drivers that need to convert to struct rte_auxiliary_device. + */ +#define RTE_DEV_TO_AUXILIARY(ptr) \ + container_of(ptr, struct rte_auxiliary_device, device) + +#define RTE_DEV_TO_AUXILIARY_CONST(ptr) \ + container_of(ptr, const struct rte_auxiliary_device, device) + +#define RTE_ETH_DEV_TO_AUXILIARY(eth_dev) \ + RTE_DEV_TO_AUXILIARY((eth_dev)->device) + +/** Device driver needs IOVA as VA and cannot work with IOVA as PA */ +#define RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA 0x002 + +/** + * Register an auxiliary driver. + * + * @param driver + * A pointer to a rte_auxiliary_driver structure describing the driver + * to be registered. + */ +__rte_experimental +void rte_auxiliary_register(struct rte_auxiliary_driver *driver); + +/** Helper for auxiliary device registration from driver instance */ +#define RTE_PMD_REGISTER_AUXILIARY(nm, auxiliary_drv) \ + RTE_INIT(auxiliaryinitfn_ ##nm) \ + { \ + (auxiliary_drv).driver.name = RTE_STR(nm); \ + rte_auxiliary_register(&(auxiliary_drv)); \ + } \ + RTE_PMD_EXPORT_NAME(nm, __COUNTER__) + +/** + * Unregister an auxiliary driver. + * + * @param driver + * A pointer to a rte_auxiliary_driver structure describing the driver + * to be unregistered. + */ +__rte_experimental +void rte_auxiliary_unregister(struct rte_auxiliary_driver *driver); + +#ifdef __cplusplus +} +#endif + +#endif /* RTE_BUS_AUXILIARY_H */ diff --git a/drivers/bus/auxiliary/version.map b/drivers/bus/auxiliary/version.map new file mode 100644 index 0000000000..a52260657c --- /dev/null +++ b/drivers/bus/auxiliary/version.map @@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +}; diff --git a/drivers/bus/meson.build b/drivers/bus/meson.build index 410058de3a..45eab5233d 100644 --- a/drivers/bus/meson.build +++ b/drivers/bus/meson.build @@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga', -- 2.25.1