bus/auxiliary: introduce auxiliary bus
Subsystems (5)
RFC 1/1 bus/auxiliary: introduce auxiliary bus
Auxiliary [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/<name>
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 410 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 +++ drivers/bus/auxiliary/linux/auxiliary.c | 144 ++++++++ drivers/bus/auxiliary/meson.build | 17 + drivers/bus/auxiliary/private.h | 119 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 193 ++++++++++ drivers/bus/auxiliary/version.map | 11 + drivers/bus/meson.build | 2 +- 9 files changed, 958 insertions(+), 1 deletion(-) 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
MAINTAINERS +5 -0
@@ -514,6 +514,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
drivers/bus/auxiliary/auxiliary_common.c new file +410 -0
410 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +58 -0
58 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +144 -0
144 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +17 -0
@@ -0,0 +1,17 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2021 Mellanox Technologies, Ltd + +if is_linux + headers = files('rte_bus_auxiliary.h') + sources = files('auxiliary_common.c', + 'auxiliary_params.c', + 'linux/auxiliary.c') + includes += include_directories('linux') + deps += ['kvargs'] +endif +if not is_linux + build = false + reason = 'only supported on Linux' + subdir_done() +endif +
drivers/bus/auxiliary/private.h new file +119 -0
119 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +193 -0
193 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +11 -0
@@ -0,0 +1,11 @@ +DPDK_21 { + local: *; +}; + +EXPERIMENTAL { + global: + + rte_auxiliary_get_sysfs_path; + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -1
@@ -1,5 +1,5 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -drivers = ['dpaa', 'fslmc', 'ifpga', 'pci', 'vdev', 'vmbus'] +drivers = ['auxiliary', 'dpaa', 'fslmc', 'ifpga', 'pci', 'vdev', 'vmbus'] std_deps = ['eal']
Signature · 1 line
2.25.1
<snip>
drivers/bus/auxiliary/linux/auxiliary.c line 92
Quoted 11 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +11
-0+/* +* Test whether the auxiliary device exist */ bool +auxiliary_exists (const char *name) { +DIR *dir; +char dirname[PATH_MAX ]; + +snprintf (dirname,sizeof (dirname),"%s/%s" , +rte_auxiliary_get_sysfs_path (), name); + dir =opendir (rte_auxiliary_get_sysfs_path ()); +if (dir ==NULL ) +return true;
Should return false here.
drivers/bus/auxiliary/linux/auxiliary.c line 94
Quoted 2 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +2
-0+closedir (dir); +return false;
Return true, will fix in next version.
Quoted 1 line
+}
<snip>
PATCH 1/1 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary [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/<name>
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 391 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 17 + drivers/bus/auxiliary/private.h | 118 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 180 ++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 2 +- 9 files changed, 927 insertions(+), 1 deletion(-) 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
MAINTAINERS +5 -0
@@ -514,6 +514,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
drivers/bus/auxiliary/auxiliary_common.c new file +391 -0
391 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +58 -0
58 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +147 -0
147 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +17 -0
@@ -0,0 +1,17 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright 2021 Mellanox Technologies, Ltd + +if is_linux + headers = files('rte_bus_auxiliary.h') + sources = files('auxiliary_common.c', + 'auxiliary_params.c', + 'linux/auxiliary.c') + includes += include_directories('linux') + deps += ['kvargs'] +endif +if not is_linux + build = false + reason = 'only supported on Linux' + subdir_done() +endif +
drivers/bus/auxiliary/private.h new file +118 -0
118 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +180 -0
180 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +10 -0
@@ -0,0 +1,10 @@ +DPDK_21 { + local: *; +}; + +EXPERIMENTAL { + global: + + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -1
@@ -1,5 +1,5 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2017 Intel Corporation -drivers = ['dpaa', 'fslmc', 'ifpga', 'pci', 'vdev', 'vmbus'] +drivers = ['auxiliary', 'dpaa', 'fslmc', 'ifpga', 'pci', 'vdev', 'vmbus'] std_deps = ['eal']
Signature · 1 line
2.25.1
I would like to Cc those who are interested in the auxiliary bus, but it's difficult to know who will implement it.
Can we expect some reviews?
13/04/2021 05:23, Xueming Li:
Quoted 11 lines
Auxiliary [1] provides a way to split function into child-devices representing sub-domains of functionality. Each
auxiliary_devicerepresents a part of its parent functionality.Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>
Quoted 81 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Xueming Li
Sent: Tuesday, April 13, 2021 11:23
To: Thomas Monjalon <[email protected]>
Cc: [email protected]; [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busAuxiliary [1] provides a way to split function into child-devices representing sub-domains of functionality. Each
auxiliary_devicerepresents a part of its parent functionality.Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 391 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 17 + drivers/bus/auxiliary/private.h | 118 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 180 ++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 2 +- 9 files changed, 927 insertions(+), 1 deletion(-) 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.mapdrivers/bus/auxiliary/auxiliary_common.c new file +38
-0@@ -0,0 +1,391 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#include <string.h> +#include <inttypes.h> +#include <stdint.h> +#include <stdbool.h> +#include <stdlib.h> +#include <stdio.h> +#include <sys/queue.h> +#include <rte_errno.h> +#include <rte_interrupts.h> +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_per_lcore.h> +#include <rte_memory.h> +#include <rte_eal.h> +#include <rte_eal_paging.h> +#include <rte_string_fns.h> +#include <rte_common.h> +#include <rte_devargs.h> + +#include "private.h" +#include "rte_bus_auxiliary.h" + + +int auxiliary_bus_logtype; + +static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) +{ +struct rte_devargs *devargs; + + RTE_EAL_DEVARGS_FOREACH("auxiliary", devargs) { +if (strcmp (devargs->name, name) ==0 ) +return devargs; + }
drivers/bus/auxiliary/auxiliary_common.c line 48
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+return NULL ; +} + +void +auxiliary_on_scan (struct rte_auxiliary_device *dev) +{ +struct rte_devargs *devargs; + + devargs =auxiliary_devargs_lookup (dev->name); + dev->device.devargs = devargs;
Can be simple as:
dev->device.devargs = auxiliary_devargs_lookup(dev->name);
drivers/bus/auxiliary/auxiliary_common.c line 56
Quoted 8 lines
drivers/bus/auxiliary/auxiliary_common.c new file +8
-0+} + +/* +* Match the auxiliary Driver and Device using driver function. +*/ +bool +auxiliary_match (const struct rte_auxiliary_driver *auxiliary_drv, +const struct rte_auxiliary_device *auxiliary_dev)
How about these auxiliary variable name style ?
const struct rte_auxiliary_driver *aux_drv,
const struct rte_auxiliary_device *aux_dev
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+{ +if (auxiliary_drv->match ==NULL ) +return false; +return auxiliary_drv->match (auxiliary_dev->name); +} +
drivers/bus/auxiliary/auxiliary_common.c line 72
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+/* +* Call the probe() function of the driver. +*/ +static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *dr, +struct rte_auxiliary_device *dev) +{ +int ret; +enum rte_iova_mode iova_mode; +
RCT style ?
enum rte_iova_mode iova_mode; int ret;
Quoted 17 lines
drivers/bus/auxiliary/auxiliary_common.c new file +17
-0+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 ; + }
drivers/bus/auxiliary/auxiliary_common.c line 99
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+ +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) > 0 &&
'(dr->drv_flags & RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA)' should work, no need '> 0'
Quoted 51 lines
drivers/bus/auxiliary/auxiliary_common.c new file +51
-0+ 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 ; +} +
drivers/bus/auxiliary/auxiliary_common.c line 160
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-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 =NULL ; +int rc =0 ;
These two variables need no initialization.
Quoted 16 lines
drivers/bus/auxiliary/auxiliary_common.c new file +16
-0+ +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 ;
drivers/bus/auxiliary/auxiliary_common.c
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +8
-0+ } +return 1 ; +} + +static int +auxiliary_dma_map (struct rte_device *dev,void *addr,uint64_t iova,size_t len) +{ +struct rte_auxiliary_device *adev =RTE_DEV_TO_AUXILIARY (dev);
How about to use 'aux_dev', instead of 'adev' ?
drivers/bus/auxiliary/auxiliary_common.c
Quoted 2 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0+ +if (!adev || !adev->driver) {
' RTE_DEV_TO_AUXILIARY' is container of 'dev', so it should check 'dev != NULL', not '!adev'. ; -)
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+ rte_errno =EINVAL ; +return -1 ; + } +if (adev->driver->dma_map) +return adev->driver->dma_map (adev, addr, iova, len); + rte_errno =ENOTSUP ;
drivers/bus/auxiliary/auxiliary_common.c line 331
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+return -1 ; +} + +static int +auxiliary_dma_unmap (struct rte_device *dev,void *addr,uint64_t iova, +size_t len) +{ +struct rte_auxiliary_device *adev =RTE_DEV_TO_AUXILIARY (dev); + +if (!adev || !adev->driver) {
The same comment as 'auxiliary_dma_map'
Quoted 33 lines
drivers/bus/auxiliary/auxiliary_common.c new file +9
-0+ rte_errno =EINVAL ; +return -1 ; + } +if (adev->driver->dma_unmap) +return adev->driver->dma_unmap (adev, addr, iova, len); + rte_errno =ENOTSUP ; +return -1 ; +} +drivers/bus/auxiliary/auxiliary_params.c new file +19
-0@@ -0,0 +1,58 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#include <string.h> + +#include <rte_bus.h> +#include <rte_dev.h> +#include <rte_errno.h> +#include <rte_kvargs.h> + +#include "private.h" +#include "rte_bus_auxiliary.h" + +enum auxiliary_params { +RTE_AUXILIARY_PARAM_NAME , +}; + +static const char *const auxiliary_params_keys[] = {
drivers/bus/auxiliary/auxiliary_params.c line 29
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_params.c new file +10
-0+ [RTE_AUXILIARY_PARAM_NAME] = "name", +}; + +static int +auxiliary_dev_match (const struct rte_device *dev, +const void *_kvlist) +{ +int ret; +const struct rte_kvargs *kvlist = _kvlist; +
RCT.
drivers/bus/auxiliary/linux/auxiliary.c
Quoted 36 lines
drivers/bus/auxiliary/auxiliary_params.c new file +29
-0+ 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; +}drivers/bus/auxiliary/linux/auxiliary.c new file +0
-0
^
|Seems no need to add one more directory 'linux' layer, as the meson said "linux only".
Quoted 78 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +77
-0@@ -0,0 +1,147 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#include <string.h> +#include <dirent.h> + +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_malloc.h> +#include <rte_devargs.h> +#include <rte_memcpy.h> +#include <eal_filesystem.h> + +#include "../rte_bus_auxiliary.h" +#include "../private.h" + +#define AUXILIARY_SYSFS_PATH "/sys/bus/auxiliary/devices" + +/** +* @file +* Linux auxiliary probing. +*/ + +/* 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 ;
drivers/bus/auxiliary/linux/auxiliary.c line 87
Quoted 10 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +10
-0+ } +auxiliary_add_device (dev); +return 0 ; +} + +/* +* Test whether the auxiliary device exist +*/ +bool +auxiliary_exists (const char *name)
is_auxiliary_support() ?
drivers/bus/auxiliary/linux/auxiliary.c line 96
Quoted 9 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +9
-0+{ +DIR *dir; +char dirname[PATH_MAX ]; + +snprintf (dirname,sizeof (dirname),"%s/%s" , +AUXILIARY_SYSFS_PATH , name); + dir =opendir (AUXILIARY_SYSFS_PATH ); +if (dir ==NULL ) +return true;
false
drivers/bus/auxiliary/linux/auxiliary.c line 98
Quoted 2 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +2
-0+closedir (dir); +return false;
true
Quoted 2 lines
--
2.25.1
14/04/2021 04:59, Wang, Haiyue:
Quoted 1 line
From: Xueming Li
[...]
Quoted 23 lines
drivers/bus/auxiliary/auxiliary_common.c line 48
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c new file +7
-0+void +auxiliary_on_scan (struct rte_auxiliary_device *dev) +{ +struct rte_devargs *devargs; + + devargs =auxiliary_devargs_lookup (dev->name); + dev->device.devargs = devargs;Can be simple as:
dev->device.devargs=auxiliary_devargs_lookup(dev->name);drivers/bus/auxiliary/auxiliary_common.c line 56
Quoted 8 lines
drivers/bus/auxiliary/auxiliary_common.c new file +8
-0+} + +/* +* Match the auxiliary Driver and Device using driver function. +*/ +bool +auxiliary_match (const struct rte_auxiliary_driver *auxiliary_drv, +const struct rte_auxiliary_device *auxiliary_dev)How about these auxiliary variable name style ?
Quoted 2 lines
const struct
rte_auxiliary_driver*aux_drv,
const structrte_auxiliary_device*aux_dev
+1
[...]
Quoted 11 lines
drivers/bus/auxiliary/auxiliary_common.c line 72
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c new file +7
-0+static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *dr, +struct rte_auxiliary_device *dev) +{ +int ret; +enum rte_iova_mode iova_mode; +RCT style ?
enum rte_iova_mode iova_mode; int ret;
I don't see the benefit of reverse christmas tree.
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_common.c line 99
Quoted 1 line
drivers/bus/auxiliary/auxiliary_common.c new file +1
-0+ if ((dr->drv_flags & RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA) > 0 &&'(
dr->drv_flags&RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA)' should work, no need '> 0'
Yes it's acceptable to consider bit testing as a boolean.
[...]
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c line 313
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+static int +auxiliary_dma_map (struct rte_device *dev,void *addr,uint64_t iova,size_t len) +{ +struct rte_auxiliary_device *adev =RTE_DEV_TO_AUXILIARY (dev);How about to use '
aux_dev', instead of 'adev' ?
Quoted 5 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ + if (!adev || !adev->driver) {'
RTE_DEV_TO_AUXILIARY' is container of 'dev', so it should check 'dev != NULL', not '!adev'. ; -)
Yes and should be explicit NULL comparison.
[...]
Quoted 5 lines
drivers/bus/auxiliary/linux/auxiliary.c
Quoted 2 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +0
-0^ |Seems no need to add one more directory 'linux' layer, as the meson said "linux only".
I disagree.
Linux sub-directory is more explicit.
And who knows? There could be an implementation on other OSes in future.
Quoted 26 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Wednesday, April 14, 2021 16:18
To: Xueming Li <[email protected]>; Wang, Haiyue <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary bus14/04/2021 04:59, Wang, Haiyue:
Quoted 1 line
From: Xueming Li
[...]
Quoted 11 lines
drivers/bus/auxiliary/auxiliary_common.c line 72
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c new file +7
-0+static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *dr, +struct rte_auxiliary_device *dev) +{ +int ret; +enum rte_iova_mode iova_mode; +RCT style ?
enum rte_iova_mode iova_mode; int ret;
Quoted 2 lines
I don't see the benefit of reverse christmas tree.
I'm impacted by kernel code style ;-)
Quoted 11 lines
Quoted 1 line
Quoted 1 line
drivers/bus/auxiliary/auxiliary_common.c new file +1
-0+ if ((dr->drv_flags & RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA) > 0 &&[...]
Quoted 5 lines
drivers/bus/auxiliary/linux/auxiliary.c
Quoted 2 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +0
-0^ |Seems no need to add one more directory 'linux' layer, as the meson said "linux only".
I disagree.
Linux sub-directory is more explicit.
And who knows? There could be an implementation on other OSes in future.
Make sense.
Quoted 2 lines
Quoted 82 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Wednesday, April 14, 2021 4:18 PM
To: Xueming(Steven) Li <[email protected]>; Wang, Haiyue <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary bus14/04/2021 04:59, Wang, Haiyue:
Quoted 1 line
From: Xueming Li
[...]
Quoted 22 lines
drivers/bus/auxiliary/auxiliary_common.c line 48
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+void +auxiliary_on_scan (struct rte_auxiliary_device *dev) { +struct rte_devargs *devargs; + + devargs =auxiliary_devargs_lookup (dev->name); + dev->device.devargs = devargs;Can be simple as:
dev->device.devargs=auxiliary_devargs_lookup(dev->name);drivers/bus/auxiliary/auxiliary_common.c line 56
Quoted 8 lines
drivers/bus/auxiliary/auxiliary_common.c new file +8
-0+} + +/* +* Match the auxiliary Driver and Device using driver function. +*/ +bool +auxiliary_match (const struct rte_auxiliary_driver *auxiliary_drv, +const struct rte_auxiliary_device *auxiliary_dev)How about these auxiliary variable name style ?
Quoted 2 lines
const struct
rte_auxiliary_driver*aux_drv, const structrte_auxiliary_device*aux_dev+1
[...]
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c line 72
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *dr, +struct rte_auxiliary_device *dev) { +int ret; +enum rte_iova_mode iova_mode; +RCT style ?
enum rte_iova_mode iova_mode; int ret;I don't see the benefit of reverse christmas tree.
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_common.c line 99
Quoted 1 line
drivers/bus/auxiliary/auxiliary_common.c new file +1
-0+ if ((dr->drv_flags & RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA) > 0 &&'(
dr->drv_flags&RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA)' should work, no need '> 0'Yes it's acceptable to consider bit testing as a boolean.
[...]
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c line 313
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+static int +auxiliary_dma_map (struct rte_device *dev,void *addr,uint64_t +iova,size_t len) { +struct rte_auxiliary_device *adev =RTE_DEV_TO_AUXILIARY (dev);How about to use '
aux_dev', instead of 'adev' ?Quoted 5 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ + if (!adev || !adev->driver) {'
RTE_DEV_TO_AUXILIARY' is container of 'dev', so it should check 'dev != NULL', not '!adev'. ; -)Yes and should be explicit NULL comparison.
[...]
Quoted 5 lines
drivers/bus/auxiliary/linux/auxiliary.c
Quoted 2 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +0
-0^ |Seems no need to add one more directory 'linux' layer, as the meson said "linux only".
Quoted 3 lines
I disagree.
Linux sub-directory is more explicit.
And who knows? There could be an implementation on other OSes in future.
This reminds me to change meson, allows bus always available to avoid compilation error, also need to add stubs with __rte_weak for all functions in common file.
Quoted 2 lines
Hi Haiyue,
Quoted 6 lines
drivers/bus/auxiliary/linux/auxiliary.c line 87
Quoted 4 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +4
-0+ +/* +* Test whether the auxiliary device exist */ bool +auxiliary_exists (const char *name)
is_auxiliary_support()?
This function test whether an auxiliary device exists, name parameter is device name. I think auxiliary_dev_exists(name) make more sense.
Agree with other comments, thanks!
Quoted 17 lines
-----Original Message-----
From: Xueming(Steven) Li <[email protected]>
Sent: Wednesday, April 14, 2021 23:39
To: Wang, Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: RE: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busHi Haiyue,
Quoted 6 lines
drivers/bus/auxiliary/linux/auxiliary.c line 87
Quoted 4 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +4
-0+ +/* +* Test whether the auxiliary device exist */ bool +auxiliary_exists (const char *name)
is_auxiliary_support()?
Quoted 2 lines
This function test whether an auxiliary device exists, name parameter is device name. I think
auxiliary_dev_exists(name)make more sense.
More clear now. ;-)
Quoted 2 lines
Agree with other comments, thanks!
Quoted 160 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Xueming Li
Sent: Tuesday, April 13, 2021 11:23
To: Thomas Monjalon <[email protected]>
Cc: [email protected]; [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busAuxiliary [1] provides a way to split function into child-devices representing sub-domains of functionality. Each
auxiliary_devicerepresents a part of its parent functionality.Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 391 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 17 + drivers/bus/auxiliary/private.h | 118 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 180 ++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 2 +- 9 files changed, 927 insertions(+), 1 deletion(-) 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.mapdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +117
-0@@ -0,0 +1,180 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#ifndef _RTE_BUS_AUXILIARY_H_ +#define _RTE_BUS_AUXILIARY_H_ + +/** + * @file + * + * RTE Auxiliary Bus Interface. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +/* 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. + */ +typedef bool(auxiliary_match_t) (const char *); + +/** + * Initialization function for the driver called during auxiliary probing. + */ +typedef int(auxiliary_probe_t) (struct rte_auxiliary_driver*, + struct rte_auxiliary_device*); + +/** + * Uninitialization function for the driver called during hotplugging. + */ +typedef int (auxiliary_remove_t)(struct rte_auxiliary_device *); + +/** + * 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 (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 (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.
drivers/bus/auxiliary/rte_bus_auxiliary.h line 127
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+*/ +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. */ +auxiliary_match_t *match;/**< Device match function. */ +auxiliary_probe_t *probe;/**< Device Probe function. */ +auxiliary_remove_t *remove;/**< Device Remove function. */ +auxiliary_dma_map_t *dma_map;/**< Device dma map function. */ +auxiliary_dma_unmap_t *dma_unmap;/**< Device dma unmap function. */
These API type can be pointer type defined, then no need "*":
typedef int (*auxiliary_dma_unmap_t)(struct rte_auxiliary_device *dev,
void *addr, uint64_t iova, size_t len);
auxiliary_dma_unmap_t dma_unmap;
Like:
https://patchwork.dpdk.org/project/dpdk/patch/[email protected]/
typedef int (*rte_dev_dma_map_t)(struct rte_device *dev,
void *addr, uint64_t iova, size_t len);
Quoted 2 lines
--
2.25.1
Quoted 184 lines
-----Original Message-----
From: Wang, Haiyue <[email protected]>
Sent: Thursday, April 15, 2021 3:36 PM
To: Xueming(Steven) Li <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: RE: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busQuoted 159 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Xueming Li
Sent: Tuesday, April 13, 2021 11:23
To: Thomas Monjalon <[email protected]>
Cc: [email protected]; [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busAuxiliary [1] provides a way to split function into child-devices representing sub-domains of functionality. Each
auxiliary_devicerepresents a part of its parent functionality.Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 391 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 17 + drivers/bus/auxiliary/private.h | 118 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 180 ++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 2 +- 9 files changed, 927 insertions(+), 1 deletion(-) 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.mapdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +115
-0@@ -0,0 +1,180 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd */ + +#ifndef _RTE_BUS_AUXILIARY_H_ +#define _RTE_BUS_AUXILIARY_H_ + +/** + * @file + * + * RTE Auxiliary Bus Interface. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +/* 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. + */ +typedef bool(auxiliary_match_t) (const char *); + +/** + * Initialization function for the driver called during auxiliary probing. + */ +typedef int(auxiliary_probe_t) (struct rte_auxiliary_driver*, + struct rte_auxiliary_device*); + +/** + * Uninitialization function for the driver called during hotplugging. + */ +typedef int (auxiliary_remove_t)(struct rte_auxiliary_device *); + +/** + * 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 (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 (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.drivers/bus/auxiliary/rte_bus_auxiliary.h line 125
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+*/ +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. */ +auxiliary_match_t *match;/**< Device match function. */ +auxiliary_probe_t *probe;/**< Device Probe function. */ +auxiliary_remove_t *remove;/**< Device Remove function. */ +auxiliary_dma_map_t *dma_map;/**< Device dma map function. */ +auxiliary_dma_unmap_t *dma_unmap;/**< Device dma unmap function. */ These API type can be pointer type defined, then no need "*":
typedef int (*auxiliary_dma_unmap_t)(struct
rte_auxiliary_device*dev,void *addr, uint64_t iova, size_t len);
Quoted 7 lines
auxiliary_dma_unmap_tdma_unmap;Like:
https://patchwork.dpdk.org/project/dpdk/patch/[email protected]/typedef int (*rte_dev_dma_map_t)(struct
rte_device*dev,void *addr, uint64_t iova, size_t len);
Thanks, is there a reason to prefer pointer type?
Thoma's patch looks good, will rebase on it once accepted.
Quoted 3 lines
Quoted 3 lines
--
2.25.1
Quoted 195 lines
-----Original Message-----
From: Xueming(Steven) Li <[email protected]>
Sent: Thursday, April 15, 2021 15:46
To: Wang, Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: RE: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busQuoted 5 lines
-----Original Message-----
From: Wang, Haiyue <[email protected]>
Sent: Thursday, April 15, 2021 3:36 PM
To: Xueming(Steven) Li <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella<[email protected]>; Neil Horman
Quoted 180 lines
<[email protected]>
Subject: RE: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busQuoted 159 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Xueming Li
Sent: Tuesday, April 13, 2021 11:23
To: Thomas Monjalon <[email protected]>
Cc: [email protected]; [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busAuxiliary [1] provides a way to split function into child-devices representing sub-domains of functionality. Each
auxiliary_devicerepresents a part of its parent functionality.Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 391 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 17 + drivers/bus/auxiliary/private.h | 118 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 180 ++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 2 +- 9 files changed, 927 insertions(+), 1 deletion(-) 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.mapdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +115
-0@@ -0,0 +1,180 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd */ + +#ifndef _RTE_BUS_AUXILIARY_H_ +#define _RTE_BUS_AUXILIARY_H_ + +/** + * @file + * + * RTE Auxiliary Bus Interface. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +/* 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. + */ +typedef bool(auxiliary_match_t) (const char *); + +/** + * Initialization function for the driver called during auxiliary probing. + */ +typedef int(auxiliary_probe_t) (struct rte_auxiliary_driver*, + struct rte_auxiliary_device*); + +/** + * Uninitialization function for the driver called during hotplugging. + */ +typedef int (auxiliary_remove_t)(struct rte_auxiliary_device *); + +/** + * 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 (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 (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.drivers/bus/auxiliary/rte_bus_auxiliary.h line 125
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+*/ +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. */ +auxiliary_match_t *match;/**< Device match function. */ +auxiliary_probe_t *probe;/**< Device Probe function. */ +auxiliary_remove_t *remove;/**< Device Remove function. */ +auxiliary_dma_map_t *dma_map;/**< Device dma map function. */ +auxiliary_dma_unmap_t *dma_unmap;/**< Device dma unmap function. */ These API type can be pointer type defined, then no need "*":
typedef int (*auxiliary_dma_unmap_t)(struct
rte_auxiliary_device*dev,void *addr, uint64_t iova, size_t len);
auxiliary_dma_unmap_tdma_unmap;
Quoted 7 lines
Quoted 5 lines
Like:
https://patchwork.dpdk.org/project/dpdk/patch/[email protected]/typedef int (*rte_dev_dma_map_t)(struct
rte_device*dev,void *addr, uint64_t iova, size_t len);Thanks, is there a reason to prefer pointer type?
Good practice to make code beautiful ? ;-)
Quoted 2 lines
Thoma's patch looks good, will rebase on it once accepted.
I mean the function type is defined as pointer type.
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
--
2.25.1
Quoted 222 lines
-----Original Message-----
From: Wang, Haiyue <[email protected]>
Sent: Thursday, April 15, 2021 3:52 PM
To: Xueming(Steven) Li <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: RE: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busQuoted 213 lines
-----Original Message-----
From: Xueming(Steven) Li <[email protected]>
Sent: Thursday, April 15, 2021 15:46
To: Wang, Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: RE: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busQuoted 7 lines
-----Original Message-----
From: Wang, Haiyue <[email protected]>
Sent: Thursday, April 15, 2021 3:36 PM
To: Xueming(Steven) Li <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella<[email protected]>; Neil Horman
Quoted 192 lines
<[email protected]>
Subject: RE: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busQuoted 164 lines
-----Original Message-----
From: dev <[email protected]> On Behalf Of Xueming Li
Sent: Tuesday, April 13, 2021 11:23
To: Thomas Monjalon <[email protected]>
Cc: [email protected]; [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary busAuxiliary [1] provides a way to split function into child-devices representing sub-domains of functionality. Each
auxiliary_devicerepresents a part of its parent functionality.Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.ht
mlSigned-off-by Xueming Li <[email protected]>--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 391 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c ++++++++++++++++++++++ | 58 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 17 + drivers/bus/auxiliary/private.h | 118 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 180 ++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 2 +- 9 files changed, 927 insertions(+), 1 deletion(-) 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.mapdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +117
-0@@ -0,0 +1,180 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd */ + +#ifndef _RTE_BUS_AUXILIARY_H_ +#define _RTE_BUS_AUXILIARY_H_ + +/** + * @file + * + * RTE Auxiliary Bus Interface. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +/* 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. + */ +typedef bool(auxiliary_match_t) (const char *); + +/** + * Initialization function for the driver called during auxiliary probing. + */ +typedef int(auxiliary_probe_t) (struct rte_auxiliary_driver*, + struct rte_auxiliary_device*); + +/** + * Uninitialization function for the driver called during hotplugging. + */ +typedef int (auxiliary_remove_t)(struct rte_auxiliary_device *); + +/** + * 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 (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 (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.drivers/bus/auxiliary/rte_bus_auxiliary.h line 127
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+*/ +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. */ +auxiliary_match_t *match;/**< Device match function. */ +auxiliary_probe_t *probe;/**< Device Probe function. */ +auxiliary_remove_t *remove;/**< Device Remove function. */ +auxiliary_dma_map_t *dma_map;/**< Device dma map function. */ +auxiliary_dma_unmap_t *dma_unmap;/**< Device dma unmap function. */ These API type can be pointer type defined, then no need "*":
typedef int (*auxiliary_dma_unmap_t)(struct
rte_auxiliary_device*dev,void *addr, uint64_t iova, size_t len);
auxiliary_dma_unmap_tdma_unmap;Like:
https://patchwork.dpdk.org/project/dpdk/patch/20210331224547.2217759
[email protected]/typedef int (*rte_dev_dma_map_t)(struct
rte_device*dev,void *addr, uint64_t iova, size_t len);
Quoted 8 lines
Quoted 1 line
Thanks, is there a reason to prefer pointer type?
Good practice to make code beautiful ? ;-)
Quoted 2 lines
Thoma's patch looks good, will rebase on it once accepted.
I mean the function type is defined as pointer type.
Yes, I'm talking another topic :)
His patch makes dma map/unmap higher level to rte_bus, so that no need to define the api again here.
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
--
2.25.1
15/04/2021 09:55, Xueming(Steven) Li:
Quoted 34 lines
From: Wang, Haiyue <[email protected]>
Quoted 33 lines
From: Xueming(Steven) Li <[email protected]>
Quoted 22 lines
From: Wang, Haiyue <[email protected]>
Quoted 21 lines
From: dev <[email protected]> On Behalf Of Xueming Li
drivers/bus/auxiliary/rte_bus_auxiliary.h line 127
Quoted 12 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +12
-0+/** +* 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. */ +auxiliary_match_t *match;/**< Device match function. */ +auxiliary_probe_t *probe;/**< Device Probe function. */ +auxiliary_remove_t *remove;/**< Device Remove function. */ +auxiliary_dma_map_t *dma_map;/**< Device dma map function. */ +auxiliary_dma_unmap_t *dma_unmap;/**< Device dma unmap function. */ These API type can be pointer type defined, then no need "*":
typedef int (*auxiliary_dma_unmap_t)(struct
rte_auxiliary_device*dev,void *addr, uint64_t iova, size_t len);
auxiliary_dma_unmap_tdma_unmap;Quoted 8 lines
Quoted 6 lines
Like:
https://patchwork.dpdk.org/project/dpdk/patch/20210331224547.2217759
[email protected]/typedef int (*rte_dev_dma_map_t)(struct
rte_device*dev,void *addr, uint64_t iova, size_t len);Thanks, is there a reason to prefer pointer type?
Good practice to make code beautiful ? ;-)
Honestly, I am not sure which one is better, having the pointer type hidden in the typedef or explicit?
Quoted 5 lines
Quoted 3 lines
Quoted 1 line
Thoma's patch looks good, will rebase on it once accepted.
I mean the function type is defined as pointer type.
Yes, I'm talking another topic :)
His patch makes dma map/unmap higher level torte_bus, so that no need to define the api again here.
I think my patch will be abandoned.
Quoted 41 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Thursday, April 15, 2021 15:59
To: Wang, Haiyue <[email protected]>; Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Asaf Penso <[email protected]>; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; [email protected]; Yigit, Ferruh <[email protected]>; [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH v1] bus/auxiliary: introduce auxiliary bus15/04/2021 09:55, Xueming(Steven) Li:
Quoted 31 lines
From: Wang, Haiyue <[email protected]>
Quoted 30 lines
From: Xueming(Steven) Li <[email protected]>
Quoted 29 lines
From: Wang, Haiyue <[email protected]>
Quoted 27 lines
From: dev <[email protected]> On Behalf Of Xueming Li
drivers/bus/auxiliary/rte_bus_auxiliary.h line 127
Quoted 12 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +12
-0+/** +* 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. */ +auxiliary_match_t *match;/**< Device match function. */ +auxiliary_probe_t *probe;/**< Device Probe function. */ +auxiliary_remove_t *remove;/**< Device Remove function. */ +auxiliary_dma_map_t *dma_map;/**< Device dma map function. */ +auxiliary_dma_unmap_t *dma_unmap;/**< Device dma unmap function. */ These API type can be pointer type defined, then no need "*":
typedef int (*auxiliary_dma_unmap_t)(struct
rte_auxiliary_device*dev,void *addr, uint64_t iova, size_t len);
auxiliary_dma_unmap_tdma_unmap;Like:
https://patchwork.dpdk.org/project/dpdk/patch/20210331224547.2217759
[email protected]/typedef int (*rte_dev_dma_map_t)(struct
rte_device*dev,void *addr, uint64_t iova, size_t len);
Quoted 6 lines
Quoted 3 lines
Quoted 3 lines
Quoted 1 line
Thanks, is there a reason to prefer pointer type?
Good practice to make code beautiful ? ;-)
Honestly, I am not sure which one is better, having the pointer type hidden in the typedef or explicit?
I got this style from 'struct eth_dev_ops', Steven can make the final decision, just a suggestion.
Quoted 9 lines
Quoted 6 lines
Quoted 4 lines
Quoted 2 lines
Thoma's patch looks good, will rebase on it once accepted.
I mean the function type is defined as pointer type.
Yes, I'm talking another topic :)
His patch makes dma map/unmap higher level torte_bus, so that no need to define the api again here.I think my patch will be abandoned.
RFC v2 1/1 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary [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/<name>
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 408 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 +++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 11 + drivers/bus/auxiliary/private.h | 120 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 199 +++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 1 + 9 files changed, 959 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
MAINTAINERS +5 -0
@@ -522,6 +522,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
drivers/bus/auxiliary/auxiliary_common.c new file +408 -0
408 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +58 -0
58 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +147 -0
147 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +11 -0
@@ -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'] +
drivers/bus/auxiliary/private.h new file +120 -0
120 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +199 -0
199 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +10 -0
@@ -0,0 +1,10 @@ +DPDK_21 { + local: *; +}; + +EXPERIMENTAL { + global: + + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -0
@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Signature · 1 line
2.25.1
Quoted 1,032 lines · Xueming Li
Auxiliary [1] provides a way to split function into child-devices representing sub-domains of functionality. Each
auxiliary_devicerepresents a part of its parent functionality.Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>--- MAINTAINERS | 5 + drivers/bus/auxiliary/auxiliary_common.c | 408 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 +++ drivers/bus/auxiliary/linux/auxiliary.c | 147 ++++++++ drivers/bus/auxiliary/meson.build | 11 + drivers/bus/auxiliary/private.h | 120 +++++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 199 +++++++++++ drivers/bus/auxiliary/version.map | 10 + drivers/bus/meson.build | 1 + 9 files changed, 959 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.mapMAINTAINERS +5
-0@@ -522,6 +522,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/drivers/bus/auxiliary/auxiliary_common.c new file +408
-0@@ -0,0 +1,408 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#include <string.h> +#include <inttypes.h> +#include <stdint.h> +#include <stdbool.h> +#include <stdlib.h> +#include <stdio.h> +#include <sys/queue.h> +#include <rte_errno.h> +#include <rte_interrupts.h> +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_per_lcore.h> +#include <rte_memory.h> +#include <rte_eal.h> +#include <rte_eal_paging.h> +#include <rte_string_fns.h> +#include <rte_common.h> +#include <rte_devargs.h> + +#include "private.h" +#include "rte_bus_auxiliary.h" + + +int auxiliary_bus_logtype; + +static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) +{ +struct rte_devargs *devargs; + + RTE_EAL_DEVARGS_FOREACH("auxiliary", devargs) { +if (strcmp (devargs->name, name) ==0 ) +return devargs; + } +return NULL ; +} + +/* +* Test whether the auxiliary device exist +*/ +__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 +*/ +__rte_weak int +auxiliary_scan (void ) +{ +return 0 ; +} + +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; + +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 (auxiliary_bus_logtype, bus.auxiliary,NOTICE );drivers/bus/auxiliary/auxiliary_params.c new file +58
-0@@ -0,0 +1,58 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#include <string.h> + +#include <rte_bus.h> +#include <rte_dev.h> +#include <rte_errno.h> +#include <rte_kvargs.h> + +#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; +}drivers/bus/auxiliary/linux/auxiliary.c new file +147
-0@@ -0,0 +1,147 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#include <string.h> +#include <dirent.h> + +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_malloc.h> +#include <rte_devargs.h> +#include <rte_memcpy.h> +#include <eal_filesystem.h> + +#include "../rte_bus_auxiliary.h" +#include "../private.h" + +#define AUXILIARY_SYSFS_PATH "/sys/bus/auxiliary/devices" + +/** +* @file +* Linux auxiliary probing. +*/ + +/* 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 ; +}drivers/bus/auxiliary/meson.build new file +11
-0@@ -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'] +drivers/bus/auxiliary/private.h new file +120
-0@@ -0,0 +1,120 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#ifndef _AUXILIARY_PRIVATE_H_ +#define _AUXILIARY_PRIVATE_H_ + +#include <stdbool.h> +#include <stdio.h> +#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) + +/** +* Test whether the auxiliary device exist +* +* @param name +* Auxiliary device name +* @return +* true on exists, false otherwise +*/ +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 ); + +/** +* Setup or update device when 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_ */ drivers/bus/auxiliary/rte_bus_auxiliary.h new file +199
-0@@ -0,0 +1,199 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#ifndef _RTE_BUS_AUXILIARY_H_ +#define _RTE_BUS_AUXILIARY_H_ + +/** +* @file +* +* RTE Auxiliary Bus Interface. +*/ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +/* 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_ */ drivers/bus/auxiliary/version.map new file +0
-0
drivers/bus/auxiliary/version.map line 7
Quoted 7 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,10 @@ +DPDK_21 { + local: *; +}; + +EXPERIMENTAL { + global: +
Add a comment here to indicate the release in which the expiermental symbols where added.
Quoted 16 lines
drivers/bus/auxiliary/version.map new file +3
-0+ rte_auxiliary_register; + rte_auxiliary_unregister; +};drivers/bus/meson.build +1
-0@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Quoted 10 lines
-----Original Message-----
From: Kinsella, Ray <[email protected]>
Sent: Tuesday, May 11, 2021 5:48 PM
To: Xueming(Steven) Li <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Neil Horman <[email protected]>; Wang Haiyue <[email protected]>
Subject: Re: [RFC v2] bus/auxiliary: introduce auxiliary bus
// snip //
Quoted 7 lines
Quoted 7 lines
drivers/bus/auxiliary/version.map new file +1
-0@@ -0,0 +1,10 @@ +DPDK_21 {
Quoted 8 lines
drivers/bus/auxiliary/version.map line 7
Quoted 6 lines
drivers/bus/auxiliary/version.map new file +6
-0+ local: *; +}; + +EXPERIMENTAL { + global: +Add a comment here to indicate the release in which the expiermental symbols where added.
Good suggestion, thanks!
Quoted 4 lines
drivers/bus/auxiliary/version.map line 10
Quoted 4 lines
drivers/bus/auxiliary/version.map new file +3
-0+ rte_auxiliary_register; + rte_auxiliary_unregister; +};
// snip //
10/05/2021 15:47, Xueming Li:
Quoted 1 line
Auxiliary [1] provides a way to split function into child-devices
Auxiliary -> Auxiliary bus
Quoted 1 line
representing sub-domains of functionality. Each
auxiliary_device
auxiliary_device -> auxiliary device
Quoted 9 lines
represents a part of its parent functionality.
Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>
[...]
Quoted 1 line
+++
b/drivers/bus/auxiliary/auxiliary_common.c
[...]
Quoted 1 line
+int
auxiliary_bus_logtype;
You don't need to declare this variable, it is done in a macro.
drivers/bus/auxiliary/auxiliary_common.c line 35
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c new file +7
-0+ +static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) +{ +struct rte_devargs *devargs; + + RTE_EAL_DEVARGS_FOREACH("auxiliary", devargs) {
"auxiliary" should be defined as a macro.
[...]
drivers/bus/auxiliary/auxiliary_common.c line 45
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+/* +* Test whether the auxiliary device exist +*/ +__rte_weak bool
The comment should explain it is a stub for OS
not supporting auxiliary bus.
drivers/bus/auxiliary/auxiliary_common.c line 55
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+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 +*/
Same here about the stub comment.
drivers/bus/auxiliary/auxiliary_common.c line 61
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+__rte_weak int +auxiliary_scan (void ) +{ +return 0 ; +} +
Please insert a comment here.
drivers/bus/auxiliary/auxiliary_common.c line 69
Quoted 8 lines
drivers/bus/auxiliary/auxiliary_common.c new file +8
-0+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.
driver and device do not need capital letters
Quoted 14 lines
+ */
drivers/bus/auxiliary/auxiliary_common.c new file +13
-0+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
drivers/bus/auxiliary/auxiliary_common.c line 93
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+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 */
Please keep all the comments more uniform by starting with a capital and ends with a point.
[...]
drivers/bus/auxiliary/auxiliary_common.c line 408
Quoted 2 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0+RTE_REGISTER_BUS (auxiliary, auxiliary_bus.bus); +RTE_LOG_REGISTER (auxiliary_bus_logtype, bus.auxiliary,NOTICE );
Please replace with RTE_LOG_REGISTER_DEFAULT.
[...]
Quoted 1 line
+++
b/drivers/bus/auxiliary/linux/auxiliary.c
[...]
Quoted 4 lines
+/**
+ * @file
+ * Linux auxiliary probing.
+ */
No need of doxygen comment in a .c file.
[...]
drivers/bus/auxiliary/meson.build line 10
Quoted 12 lines
+++ b/drivers/bus/auxiliary/meson.build
drivers/bus/auxiliary/meson.build new file +10
-0@@ -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']
Please change the indent with spaces
and check with devtools/check-meson.py
[...]
Quoted 1 line
(quoted diff) +1
-0+++ b/drivers/bus/auxiliary/private.h
[...]
drivers/bus/auxiliary/private.h line 20
Quoted 2 lines
drivers/bus/auxiliary/private.h new file +2
-0+/* Auxiliary bus iterators */ +#define FOREACH_DEVICE_ON_AUXILIARYBUS (p) \
Please avoid tabs at the end of the line.
A space is enough before the backslash.
Quoted 4 lines
drivers/bus/auxiliary/private.h new file +4
-0+ TAILQ_FOREACH(p, &(auxiliary_bus.device_list), next) + +#define FOREACH_DRIVER_ON_AUXILIARYBUS (p) \ + TAILQ_FOREACH(p, &(auxiliary_bus.driver_list), next)
drivers/bus/auxiliary/private.h line 34
Quoted 10 lines
drivers/bus/auxiliary/private.h new file +10
-0+ +/** +* Test whether the auxiliary device exist +* +* @param name +* Auxiliary device name +* @return +* true on exists, false otherwise +*/ +bool auxiliary_dev_exists (const char *name);
Given it is not an API, no need of doxygen.
And the function is so simple that no need of comment at all.
[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 6
Quoted 3 lines
+++
b/drivers/bus/auxiliary/rte_bus_auxiliary.hdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +2
-0+#ifndef _RTE_BUS_AUXILIARY_H_ +#define _RTE_BUS_AUXILIARY_H_
No need of underscores before and after.
(yes I know a lot of DPDK files use such scheme)
drivers/bus/auxiliary/rte_bus_auxiliary.h line 11
Quoted 5 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +5
-0+ +/** +* @file +* +* RTE Auxiliary Bus Interface.
No need of RTE, it has no meaning here.
Quoted 24 lines
+ */
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +23
-0+ +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +/* Forward declarations */ +struct rte_auxiliary_driver ; +struct rte_auxiliary_bus ; +struct rte_auxiliary_device ;
drivers/bus/auxiliary/rte_bus_auxiliary.h line 45
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+ +/** +* 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);
I disagree with the earlier comment asking for typedef pointer (based on one of my patches).
Actually Andrew's suggestion makes sense:
http://mails.dpdk.org/archives/dev/2021-June/210665.html
[...]
drivers/bus/auxiliary/version.map line 3
Quoted 4 lines
+++ b/drivers/bus/auxiliary/version.map
drivers/bus/auxiliary/version.map new file +3
-0+DPDK_21 { + local: *; +};
We don't need this empty section.
drivers/bus/auxiliary/version.map line 7
Quoted 4 lines
drivers/bus/auxiliary/version.map new file +4
-0+ +EXPERIMENTAL { + global: +
As asked by Ray, we should add this line:
# added in 21.08
drivers/bus/auxiliary/version.map line 10
Quoted 3 lines
drivers/bus/auxiliary/version.map new file +3
-0+ rte_auxiliary_register; + rte_auxiliary_unregister; +};
Release notes are missing.
Hi Andrew,
Quoted 24 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, June 8, 2021 15:53
To: Xueming Li <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Wang, Haiyue <[email protected]>; [email protected]
Subject: Re: [dpdk-dev] [RFC v2] bus/auxiliary: introduce auxiliary busdrivers/bus/auxiliary/rte_bus_auxiliary.h line 45
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+ +/** +* 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);I disagree with the earlier comment asking for typedef pointer (based on one of my patches).
Actually Andrew's suggestion makes sense:
Quoted 2 lines
http://mails.dpdk.org/archives/dev/2021-June/210665.html
I didn't get the error, but the same warning, I missed something ? ;-)
1. w/o pointer
#include <stdio.h>
typedef int (gpu_malloc_t)(void *dev, size_t size, void **ptr);
static gpu_malloc_t *mlx5_gpu_malloc_fn;
static intmlx5_gpu_malloc(size_t size, void **ptr)
{
return 0;
}int main()
{
mlx5_gpu_malloc_fn = mlx5_gpu_malloc;
mlx5_gpu_malloc_fn(NULL, 0, NULL);
return 0;
}gcc -Wall fun.cfun.c: In function 'main':
fun.c:15:21: warning: assignment to 'int (*)(void *, size_t, void **)' {aka 'int (*)(void *, long unsigned int, void **)'} from incompatible pointer type 'int (*)(size_t, void **)' {aka 'int (*)(long unsigned int, void **)'} [-Wincompatible-pointer-types]
15 | mlx5_gpu_malloc_fn = mlx5_gpu_malloc;
| ^
2. w pointer
#include <stdio.h>
typedef int (*gpu_malloc_t)(void *dev, size_t size, void **ptr);
static gpu_malloc_t mlx5_gpu_malloc_fn;
static intmlx5_gpu_malloc(size_t size, void **ptr)
{
return 0;
}int main()
{
mlx5_gpu_malloc_fn = mlx5_gpu_malloc;
mlx5_gpu_malloc_fn(NULL, 0, NULL);
return 0;
}gcc -Wall fun.cfun.c: In function 'main':
fun.c:15:21: warning: assignment to 'gpu_malloc_t' {aka 'int (*)(void *, long unsigned int, void **)'} from incompatible pointer type 'int (*)(size_t, void **)' {aka 'int (*)(long unsigned int, void **)'} [-Wincompatible-pointer-types]
15 | mlx5_gpu_malloc_fn = mlx5_gpu_malloc;
| ^
Quoted 1 line
Quoted 96 lines
-----Original Message-----
From: Wang, Haiyue <[email protected]>
Sent: Tuesday, June 8, 2021 4:41 PM
To: NBU-Contact-Thomas Monjalon <[email protected]>; Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; [email protected]
Subject: RE: [dpdk-dev] [RFC v2] bus/auxiliary: introduce auxiliary busHi Andrew,
Quoted 26 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, June 8, 2021 15:53
To: Xueming Li <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Wang, Haiyue <[email protected]>; [email protected]
Subject: Re: [dpdk-dev] [RFC v2] bus/auxiliary: introduce auxiliary busdrivers/bus/auxiliary/rte_bus_auxiliary.h line 45
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+ +/** +* 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);I disagree with the earlier comment asking for typedef pointer (based on one of my patches).
Actually Andrew's suggestion makes sense:Quoted 2 lines
http://mails.dpdk.org/archives/dev/2021-June/210665.htmlI didn't get the error, but the same warning, I missed something ? ;-)
1. w/o pointer
#include <
stdio.h>typedef int (gpu_malloc_t)(void *dev,
size_tsize, void **ptr);static
gpu_malloc_t*mlx5_gpu_malloc_fn;static int
mlx5_gpu_malloc(size_t size, void **ptr) { return 0; }int
main(){ mlx5_gpu_malloc_fn = mlx5_gpu_malloc; mlx5_gpu_malloc_fn(NULL, 0, NULL); return 0; }gcc -Wall
fun.cfun.c: In function 'main':
fun.c:15:21: warning: assignment to 'int (*)(void *,size_t, void **)' {aka 'int (*)(void *, long unsigned int, void **)'} from incompatible pointer type 'int (*)(size_t, void **)' {aka 'int (*)(long unsigned int, void **)'} [-Wincompatible-pointer-types]
15 |mlx5_gpu_malloc_fn=mlx5_gpu_malloc;
| ^2. w pointer
#include <
stdio.h>typedef int (*gpu_malloc_t)(void *dev,
size_tsize, void **ptr);static
gpu_malloc_tmlx5_gpu_malloc_fn;static int
mlx5_gpu_malloc(size_t size, void **ptr) { return 0; }int
main(){ mlx5_gpu_malloc_fn = mlx5_gpu_malloc; mlx5_gpu_malloc_fn(NULL, 0, NULL); return 0; }
Quoted 8 lines
gcc -Wall
fun.cfun.c: In function 'main':
fun.c:15:21: warning: assignment to 'gpu_malloc_t' {aka 'int (*)(void *, long unsigned int, void **)'} from incompatible pointer type 'int (*)(size_t, void **)' {aka 'int (*)(long unsigned int, void **)'} [-Wincompatible-pointer-types]
15 |mlx5_gpu_malloc_fn=mlx5_gpu_malloc;
| ^Quoted 1 line
I don't mind as both suggestion works.
From usage perspective, it's straightforward for anybody to see an pointer field and know "that's a pointer to a something".
Quoted 111 lines
-----Original Message-----
From: Xueming(Steven) Li <[email protected]>
Sent: Thursday, June 10, 2021 14:30
To: Wang, Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; [email protected]
Subject: RE: [dpdk-dev] [RFC v2] bus/auxiliary: introduce auxiliary busQuoted 5 lines
-----Original Message-----
From: Wang, Haiyue <[email protected]>
Sent: Tuesday, June 8, 2021 4:41 PM
To: NBU-Contact-Thomas Monjalon <[email protected]>; Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>;Quoted 58 lines
Subject: RE: [dpdk-dev] [RFC v2] bus/auxiliary: introduce auxiliary bus
Hi Andrew,
Quoted 26 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, June 8, 2021 15:53
To: Xueming Li <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Wang, Haiyue <[email protected]>; [email protected]
Subject: Re: [dpdk-dev] [RFC v2] bus/auxiliary: introduce auxiliary busdrivers/bus/auxiliary/rte_bus_auxiliary.h line 45
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+ +/** +* 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);I disagree with the earlier comment asking for typedef pointer (based on one of my patches).
Actually Andrew's suggestion makes sense:Quoted 2 lines
http://mails.dpdk.org/archives/dev/2021-June/210665.htmlI didn't get the error, but the same warning, I missed something ? ;-)
1. w/o pointer
#include <
stdio.h>typedef int (gpu_malloc_t)(void *dev,
size_tsize, void **ptr);static
gpu_malloc_t*mlx5_gpu_malloc_fn;static int
mlx5_gpu_malloc(size_t size, void **ptr) { return 0; }int
main(){ mlx5_gpu_malloc_fn = mlx5_gpu_malloc; mlx5_gpu_malloc_fn(NULL, 0, NULL); return 0; }Quoted 3 lines
gcc -Wall
fun.cfun.c: In function 'main':
fun.c:15:21: warning: assignment to 'int (*)(void *,size_t, void **)' {aka 'int (*)(void *, longunsigned int, void **)'} from incompatible
Quoted 1 line
pointer type 'int (*)(size_t, void **)' {aka 'int (*)(long unsigned int, void **)'} [-
Wincompatible-pointer-types]
Quoted 27 lines
15 | mlx5_gpu_malloc_fn = mlx5_gpu_malloc; | ^2. w pointer
#include <
stdio.h>typedef int (*gpu_malloc_t)(void *dev,
size_tsize, void **ptr);static
gpu_malloc_tmlx5_gpu_malloc_fn;static int
mlx5_gpu_malloc(size_t size, void **ptr) { return 0; }int
main(){ mlx5_gpu_malloc_fn = mlx5_gpu_malloc; mlx5_gpu_malloc_fn(NULL, 0, NULL); return 0; }Quoted 3 lines
gcc -Wall
fun.cfun.c: In function 'main':
fun.c:15:21: warning: assignment to 'gpu_malloc_t' {aka 'int (*)(void *, long unsigned int, void**)'} from incompatible pointer type
Quoted 8 lines
Quoted 1 line
'int (*)(size_t, void **)' {aka 'int (*)(long unsigned int, void **)'} [-Wincompatible-pointer-
types]
Quoted 4 lines
15 | mlx5_gpu_malloc_fn = mlx5_gpu_malloc; | ^Quoted 1 line
I don't mind as both suggestion works.
I just want to understand what kind of error the compiler will complain about. ;-)
Quoted 4 lines
From usage perspective, it's straightforward for anybody to see an pointer field and know "that's a pointer to a something".
Quoted 237 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, June 8, 2021 3:53 PM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Wang Haiyue <[email protected]>; [email protected]
Subject: Re: [dpdk-dev] [RFC v2] bus/auxiliary: introduce auxiliary bus10/05/2021 15:47, Xueming Li:
Quoted 1 line
Auxiliary [1] provides a way to split function into child-devices
Auxiliary -> Auxiliary bus
Quoted 1 line
representing sub-domains of functionality. Each
auxiliary_device
auxiliary_device-> auxiliary deviceQuoted 9 lines
represents a part of its parent functionality.
Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>[...]
Quoted 1 line
+++
b/drivers/bus/auxiliary/auxiliary_common.c[...]
Quoted 1 line
+int
auxiliary_bus_logtype;You don't need to declare this variable, it is done in a macro.
drivers/bus/auxiliary/auxiliary_common.c line 35
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+ +static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) { +struct rte_devargs *devargs; + + RTE_EAL_DEVARGS_FOREACH("auxiliary", devargs) {"auxiliary" should be defined as a macro.
[...]
Quoted 2 lines
+/*
+ * Test whether the auxiliary device exist */__rte_weakboolThe comment should explain it is a stub for OS not supporting auxiliary bus.
drivers/bus/auxiliary/auxiliary_common.c line 55
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+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 +*/ Same here about the stub comment.
drivers/bus/auxiliary/auxiliary_common.c line 61
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+__rte_weak int +auxiliary_scan (void ) +{ +return 0 ; +} +Please insert a comment here.
drivers/bus/auxiliary/auxiliary_common.c line 69
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c new file +7
-0+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. driver and device do not need capital letters
Quoted 12 lines
+ */
drivers/bus/auxiliary/auxiliary_common.c new file +11
-0+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 intdrivers/bus/auxiliary/auxiliary_common.c line 93
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+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 */ Please keep all the comments more uniform by starting with a capital and ends with a point.
[...]
drivers/bus/auxiliary/auxiliary_common.c line 408
Quoted 2 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0+RTE_REGISTER_BUS (auxiliary, auxiliary_bus.bus); +RTE_LOG_REGISTER (auxiliary_bus_logtype, bus.auxiliary,NOTICE );Please replace with
RTE_LOG_REGISTER_DEFAULT.[...]
Quoted 1 line
+++
b/drivers/bus/auxiliary/linux/auxiliary.c[...]
Quoted 4 lines
+/**
+ * @file
+ * Linux auxiliary probing.
+ */No need of doxygen comment in a .c file.
[...]
drivers/bus/auxiliary/meson.build line 10
Quoted 12 lines
+++ b/drivers/bus/auxiliary/meson.build
drivers/bus/auxiliary/meson.build new file +10
-0@@ -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']Please change the indent with spaces
and check withdevtools/check-meson.py[...]
Quoted 1 line
(quoted diff) +1
-0+++ b/drivers/bus/auxiliary/private.h[...]
drivers/bus/auxiliary/private.h line 20
Quoted 2 lines
drivers/bus/auxiliary/private.h new file +2
-0+/* Auxiliary bus iterators */ +#define FOREACH_DEVICE_ON_AUXILIARYBUS (p) \Please avoid tabs at the end of the line.
A space is enough before the backslash.Quoted 4 lines
drivers/bus/auxiliary/private.h new file +4
-0+ TAILQ_FOREACH(p, &(auxiliary_bus.device_list), next) + +#define FOREACH_DRIVER_ON_AUXILIARYBUS (p) \ + TAILQ_FOREACH(p, &(auxiliary_bus.driver_list), next)drivers/bus/auxiliary/private.h line 34
Quoted 10 lines
drivers/bus/auxiliary/private.h new file +10
-0+ +/** +* Test whether the auxiliary device exist +* +* @param name +* Auxiliary device name +* @return +* true on exists, false otherwise +*/ +bool auxiliary_dev_exists (const char *name);Given it is not an API, no need of doxygen.
And the function is so simple that no need of comment at all.[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 6
Quoted 3 lines
+++
b/drivers/bus/auxiliary/rte_bus_auxiliary.hdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +2
-0+#ifndef _RTE_BUS_AUXILIARY_H_ +#define _RTE_BUS_AUXILIARY_H_No need of underscores before and after.
(yes I know a lot of DPDK files use such scheme)drivers/bus/auxiliary/rte_bus_auxiliary.h line 11
Quoted 5 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +5
-0+ +/** +* @file +* +* RTE Auxiliary Bus Interface. No need of RTE, it has no meaning here.
Quoted 24 lines
+ */
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +23
-0+ +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +/* Forward declarations */ +struct rte_auxiliary_driver ; +struct rte_auxiliary_bus ; +struct rte_auxiliary_device ;drivers/bus/auxiliary/rte_bus_auxiliary.h line 45
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+ +/** +* 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);I disagree with the earlier comment asking for typedef pointer (based on one of my patches).
Actually Andrew's suggestion makes sense:http://mails.dpdk.org/archives/dev/2021-June/210665.html[...]
drivers/bus/auxiliary/version.map line 3
Quoted 4 lines
+++ b/drivers/bus/auxiliary/version.map
drivers/bus/auxiliary/version.map new file +3
-0+DPDK_21 { + local: *; +};We don't need this empty section.
drivers/bus/auxiliary/version.map line 7
Quoted 4 lines
drivers/bus/auxiliary/version.map new file +4
-0+ +EXPERIMENTAL { + global: +As asked by Ray, we should add this line:
Quoted 8 lines
# added in 21.08drivers/bus/auxiliary/version.map line 10
Quoted 3 lines
drivers/bus/auxiliary/version.map new file +3
-0+ rte_auxiliary_register; + rte_auxiliary_unregister; +};Release notes are missing.
Thanks for all the good catches, will update and reflect in next version.
PATCH v3 1/2 devargs: add common key definition
In reply to Xueming LiAdds common devargs key definition for "bus", "class" and "driver".
--- drivers/common/mlx5/mlx5_common.h | 2 -- drivers/common/mlx5/mlx5_common_pci.c | 2 +- drivers/common/sfc_efx/sfc_efx.h | 2 -- drivers/net/bonding/rte_eth_bond_args.c | 2 +- drivers/net/i40e/i40e_ethdev_vf.c | 5 ++--- drivers/net/iavf/iavf_ethdev.c | 5 ++--- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/sfc/sfc_kvargs.c | 2 +- drivers/vdpa/mlx5/mlx5_vdpa.c | 2 +- lib/eal/common/eal_common_devargs.c | 12 ++++++------ lib/eal/include/rte_devargs.h | 4 ++++ 11 files changed, 20 insertions(+), 22 deletions(-)
drivers/common/mlx5/mlx5_common.h +0 -2
@@ -208,8 +208,6 @@ __rte_internalint mlx5_get_ifname_sysfs (const char *ibdev_path,char *ifname); -#define MLX5_CLASS_ARG_NAME "class" -enum mlx5_class {MLX5_CLASS_INVALID ,MLX5_CLASS_NET =RTE_BIT64 (0 ),
drivers/common/mlx5/mlx5_common_pci.c +1 -1
@@ -118,7 +118,7 @@ bus_cmdline_options_handler(__rte_unused const char *key,static int parse_class_options (const struct rte_devargs *devargs) { -const char *key =MLX5_CLASS_ARG_NAME ; +const char *key =RTE_DEVARGS_KEY_CLASS ;struct rte_kvargs *kvlist;int ret =0 ;
drivers/common/sfc_efx/sfc_efx.h +0 -2
@@ -19,8 +19,6 @@extern "C" {#endif -#define SFC_EFX_KVARG_DEV_CLASS "class" -enum sfc_efx_dev_class {SFC_EFX_DEV_CLASS_INVALID =0 ,SFC_EFX_DEV_CLASS_NET ,
drivers/net/bonding/rte_eth_bond_args.c +1 -1
@@ -18,7 +18,7 @@ const char *pmd_bond_init_valid_arguments[] = {PMD_BOND_SOCKET_ID_KVARG ,PMD_BOND_MAC_ADDR_KVARG ,PMD_BOND_AGG_MODE_KVARG , -"driver" , +RTE_DEVARGS_KEY_DRIVER , NULL };
drivers/net/i40e/i40e_ethdev_vf.c +2 -3
@@ -1660,7 +1660,6 @@ static int i40evf_driver_selected(struct rte_devargs *devargs) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ;if (devargs ==NULL )
@@ -1670,13 +1669,13 @@ i40evf_driver_selected(struct rte_devargs *devargs)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , i40evf_check_driver_handler,NULL ) <0 ) goto exit;
drivers/net/iavf/iavf_ethdev.c +2 -3
@@ -2440,7 +2440,6 @@ static int iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ; if (device_id != IAVF_DEV_ID_VF &&
@@ -2456,13 +2455,13 @@ iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , iavf_drv_i40evf_check_handler,NULL ) <0 ) goto exit;
drivers/net/mlx5/mlx5.c +2 -2
@@ -1931,7 +1931,7 @@ mlx5_args_check(const char *key, const char *val, void *opaque) config->max_dump_files_num = tmp; }else if (strcmp (MLX5_LRO_TIMEOUT_USEC , key) ==0 ) { config->lro.timeout = tmp; - }else if (strcmp (MLX5_CLASS_ARG_NAME , key) ==0 ) { + }else if (strcmp (RTE_DEVARGS_KEY_CLASS , key) ==0 ) {DRV_LOG (DEBUG ,"class argument is %s." , val); }else if (strcmp (MLX5_HP_BUF_SIZE , key) ==0 ) { config->log_hp_size = tmp;
@@ -2002,7 +2002,7 @@ mlx5_args(struct mlx5_dev_config *config, struct rte_devargs *devargs)MLX5_REPRESENTOR ,MLX5_MAX_DUMP_FILES_NUM ,MLX5_LRO_TIMEOUT_USEC , -MLX5_CLASS_ARG_NAME , +RTE_DEVARGS_KEY_CLASS ,MLX5_HP_BUF_SIZE ,MLX5_RECLAIM_MEM , MLX5_SYS_MEM_EN,
drivers/net/sfc/sfc_kvargs.c +1 -1
@@ -28,7 +28,7 @@ sfc_kvargs_parse(struct sfc_adapter *sa)SFC_KVARG_TX_DATAPATH ,SFC_KVARG_FW_VARIANT ,SFC_KVARG_RXD_WAIT_TIMEOUT_NS , -SFC_EFX_KVARG_DEV_CLASS , +RTE_DEVARGS_KEY_CLASS , NULL, };
drivers/vdpa/mlx5/mlx5_vdpa.c +1 -1
@@ -588,7 +588,7 @@ mlx5_vdpa_args_check_handler(const char *key, const char *val, void *opaque)unsigned long tmp;int n_cores =sysconf (_SC_NPROCESSORS_ONLN); -if (strcmp (key,"class" ) ==0 ) +if (strcmp (key,RTE_DEVARGS_KEY_CLASS ) ==0 )return 0 ; errno =0 ; tmp =strtoul (val,NULL ,0 );
lib/eal/common/eal_common_devargs.c +6 -6
@@ -49,9 +49,9 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,const char *str;struct rte_kvargs *kvlist; } layers[] = { - { "bus=", NULL, NULL, }, - { "class=", NULL, NULL, }, - { "driver=", NULL, NULL, }, + { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, }, }; struct rte_kvargs_pair *kv = NULL; struct rte_class *cls = NULL;
@@ -118,7 +118,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,if (layers[i].kvlist ==NULL )continue ; kv = &layers[i].kvlist->pairs[0 ]; -if (strcmp (kv->key,"bus" ) ==0 ) { +if (strcmp (kv->key,RTE_DEVARGS_KEY_BUS ) ==0 ) { bus =rte_bus_find_by_name (kv->value);if (bus ==NULL ) { RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
@@ -126,7 +126,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"class" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_CLASS ) ==0 ) { cls =rte_class_find_by_name (kv->value);if (cls ==NULL ) { RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
@@ -134,7 +134,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"driver" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_DRIVER ) ==0 ) {/* Ignore */ continue ; }
lib/eal/include/rte_devargs.h +4 -0
@@ -25,6 +25,10 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +#define RTE_DEVARGS_KEY_BUS "bus" +#define RTE_DEVARGS_KEY_CLASS "class" +#define RTE_DEVARGS_KEY_DRIVER "driver" +/** * Type of generic device */
Signature · 1 line
2.25.1
PATCH v3 2/2 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary 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/<name>
Devargs syntax of auxiliary device:
-a auxiliary:<name>[,args...]
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- 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
MAINTAINERS +5 -0
@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
doc/guides/rel_notes/release_21_08.rst +7 -0
@@ -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:<name>[,args...] + Removed Items -------------
drivers/bus/auxiliary/auxiliary_common.c new file +419 -0
419 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +58 -0
58 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +142 -0
142 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +11 -0
@@ -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'] +
drivers/bus/auxiliary/private.h new file +112 -0
112 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +201 -0
201 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +7 -0
@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -0
@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Signature · 1 line
2.25.1
PATCH v4 1/2 devargs: add common key definition
In reply to Xueming LiAdds common devargs key definition for "bus", "class" and "driver".
--- drivers/common/mlx5/mlx5_common.h | 2 -- drivers/common/mlx5/mlx5_common_pci.c | 2 +- drivers/common/sfc_efx/sfc_efx.c | 7 +++---- drivers/common/sfc_efx/sfc_efx.h | 2 -- drivers/net/bonding/rte_eth_bond_args.c | 2 +- drivers/net/i40e/i40e_ethdev_vf.c | 5 ++--- drivers/net/iavf/iavf_ethdev.c | 5 ++--- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/sfc/sfc_kvargs.c | 2 +- drivers/vdpa/mlx5/mlx5_vdpa.c | 2 +- lib/eal/common/eal_common_devargs.c | 12 ++++++------ lib/eal/include/rte_devargs.h | 4 ++++ 12 files changed, 23 insertions(+), 26 deletions(-)
drivers/common/mlx5/mlx5_common.h +0 -2
@@ -208,8 +208,6 @@ __rte_internalint mlx5_get_ifname_sysfs (const char *ibdev_path,char *ifname); -#define MLX5_CLASS_ARG_NAME "class" -enum mlx5_class {MLX5_CLASS_INVALID ,MLX5_CLASS_NET =RTE_BIT64 (0 ),
drivers/common/mlx5/mlx5_common_pci.c +1 -1
@@ -118,7 +118,7 @@ bus_cmdline_options_handler(__rte_unused const char *key,static int parse_class_options (const struct rte_devargs *devargs) { -const char *key =MLX5_CLASS_ARG_NAME ; +const char *key =RTE_DEVARGS_KEY_CLASS ;struct rte_kvargs *kvlist;int ret =0 ;
drivers/common/sfc_efx/sfc_efx.c +3 -4
@@ -42,7 +42,6 @@ enum sfc_efx_dev_class sfc_efx_dev_class_get(struct rte_devargs *devargs) {struct rte_kvargs *kvargs; -const char *key =SFC_EFX_KVARG_DEV_CLASS ;enum sfc_efx_dev_class dev_class =SFC_EFX_DEV_CLASS_NET ;if (devargs ==NULL )
@@ -52,9 +51,9 @@ sfc_efx_dev_class_get(struct rte_devargs *devargs)if (kvargs ==NULL )return dev_class; -if (rte_kvargs_count (kvargs, key) !=0 ) { -rte_kvargs_process (kvargs, key, sfc_efx_kvarg_dev_class_handler, - &dev_class); +if (rte_kvargs_count (kvargs,RTE_DEVARGS_KEY_CLASS ) !=0 ) { +rte_kvargs_process (kvargs,RTE_DEVARGS_KEY_CLASS , + sfc_efx_kvarg_dev_class_handler, &dev_class); }rte_kvargs_free (kvargs);
drivers/common/sfc_efx/sfc_efx.h +0 -2
@@ -19,8 +19,6 @@extern "C" {#endif -#define SFC_EFX_KVARG_DEV_CLASS "class" -enum sfc_efx_dev_class {SFC_EFX_DEV_CLASS_INVALID =0 ,SFC_EFX_DEV_CLASS_NET ,
drivers/net/bonding/rte_eth_bond_args.c +1 -1
@@ -18,7 +18,7 @@ const char *pmd_bond_init_valid_arguments[] = {PMD_BOND_SOCKET_ID_KVARG ,PMD_BOND_MAC_ADDR_KVARG ,PMD_BOND_AGG_MODE_KVARG , -"driver" , +RTE_DEVARGS_KEY_DRIVER , NULL };
drivers/net/i40e/i40e_ethdev_vf.c +2 -3
@@ -1660,7 +1660,6 @@ static int i40evf_driver_selected(struct rte_devargs *devargs) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ;if (devargs ==NULL )
@@ -1670,13 +1669,13 @@ i40evf_driver_selected(struct rte_devargs *devargs)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , i40evf_check_driver_handler,NULL ) <0 ) goto exit;
drivers/net/iavf/iavf_ethdev.c +2 -3
@@ -2440,7 +2440,6 @@ static int iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ; if (device_id != IAVF_DEV_ID_VF &&
@@ -2456,13 +2455,13 @@ iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , iavf_drv_i40evf_check_handler,NULL ) <0 ) goto exit;
drivers/net/mlx5/mlx5.c +2 -2
@@ -1931,7 +1931,7 @@ mlx5_args_check(const char *key, const char *val, void *opaque) config->max_dump_files_num = tmp; }else if (strcmp (MLX5_LRO_TIMEOUT_USEC , key) ==0 ) { config->lro.timeout = tmp; - }else if (strcmp (MLX5_CLASS_ARG_NAME , key) ==0 ) { + }else if (strcmp (RTE_DEVARGS_KEY_CLASS , key) ==0 ) {DRV_LOG (DEBUG ,"class argument is %s." , val); }else if (strcmp (MLX5_HP_BUF_SIZE , key) ==0 ) { config->log_hp_size = tmp;
@@ -2002,7 +2002,7 @@ mlx5_args(struct mlx5_dev_config *config, struct rte_devargs *devargs)MLX5_REPRESENTOR ,MLX5_MAX_DUMP_FILES_NUM ,MLX5_LRO_TIMEOUT_USEC , -MLX5_CLASS_ARG_NAME , +RTE_DEVARGS_KEY_CLASS ,MLX5_HP_BUF_SIZE ,MLX5_RECLAIM_MEM , MLX5_SYS_MEM_EN,
drivers/net/sfc/sfc_kvargs.c +1 -1
@@ -28,7 +28,7 @@ sfc_kvargs_parse(struct sfc_adapter *sa)SFC_KVARG_TX_DATAPATH ,SFC_KVARG_FW_VARIANT ,SFC_KVARG_RXD_WAIT_TIMEOUT_NS , -SFC_EFX_KVARG_DEV_CLASS , +RTE_DEVARGS_KEY_CLASS , NULL, };
drivers/vdpa/mlx5/mlx5_vdpa.c +1 -1
@@ -588,7 +588,7 @@ mlx5_vdpa_args_check_handler(const char *key, const char *val, void *opaque)unsigned long tmp;int n_cores =sysconf (_SC_NPROCESSORS_ONLN); -if (strcmp (key,"class" ) ==0 ) +if (strcmp (key,RTE_DEVARGS_KEY_CLASS ) ==0 )return 0 ; errno =0 ; tmp =strtoul (val,NULL ,0 );
lib/eal/common/eal_common_devargs.c +6 -6
@@ -49,9 +49,9 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,const char *str;struct rte_kvargs *kvlist; } layers[] = { - { "bus=", NULL, NULL, }, - { "class=", NULL, NULL, }, - { "driver=", NULL, NULL, }, + { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, }, }; struct rte_kvargs_pair *kv = NULL; struct rte_class *cls = NULL;
@@ -118,7 +118,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,if (layers[i].kvlist ==NULL )continue ; kv = &layers[i].kvlist->pairs[0 ]; -if (strcmp (kv->key,"bus" ) ==0 ) { +if (strcmp (kv->key,RTE_DEVARGS_KEY_BUS ) ==0 ) { bus =rte_bus_find_by_name (kv->value);if (bus ==NULL ) { RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
@@ -126,7 +126,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"class" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_CLASS ) ==0 ) { cls =rte_class_find_by_name (kv->value);if (cls ==NULL ) { RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
@@ -134,7 +134,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"driver" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_DRIVER ) ==0 ) {/* Ignore */ continue ; }
lib/eal/include/rte_devargs.h +4 -0
@@ -25,6 +25,10 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +#define RTE_DEVARGS_KEY_BUS "bus" +#define RTE_DEVARGS_KEY_CLASS "class" +#define RTE_DEVARGS_KEY_DRIVER "driver" +/** * Type of generic device */
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH v4 1/2] devargs: add common key definition
13/06/2021 14:58, Xueming Li:
lib/eal/include/rte_devargs.h extern "C" { · line 30
Quoted 9 lines
lib/eal/include/rte_devargs.h +3
-0@@ -25,6 +25,10 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +#define RTE_DEVARGS_KEY_BUS "bus" +#define RTE_DEVARGS_KEY_CLASS "class" +#define RTE_DEVARGS_KEY_DRIVER "driver"
These macros must be documented as part of the API. It must be said how it is used.
PATCH v5 1/2 devargs: add common key definition
In reply to Xueming LiAdds common devargs key definition for "bus", "class" and "driver".
--- drivers/common/mlx5/mlx5_common.h | 2 -- drivers/common/mlx5/mlx5_common_pci.c | 2 +- drivers/common/sfc_efx/sfc_efx.c | 7 +++---- drivers/common/sfc_efx/sfc_efx.h | 2 -- drivers/net/bonding/rte_eth_bond_args.c | 2 +- drivers/net/i40e/i40e_ethdev_vf.c | 5 ++--- drivers/net/iavf/iavf_ethdev.c | 5 ++--- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/sfc/sfc_kvargs.c | 2 +- drivers/vdpa/mlx5/mlx5_vdpa.c | 2 +- lib/eal/common/eal_common_devargs.c | 12 ++++++------ lib/eal/include/rte_devargs.h | 24 ++++++++++++++++++++++++ 12 files changed, 43 insertions(+), 26 deletions(-)
drivers/common/mlx5/mlx5_common.h +0 -2
@@ -208,8 +208,6 @@ __rte_internalint mlx5_get_ifname_sysfs (const char *ibdev_path,char *ifname); -#define MLX5_CLASS_ARG_NAME "class" -enum mlx5_class {MLX5_CLASS_INVALID ,MLX5_CLASS_NET =RTE_BIT64 (0 ),
drivers/common/mlx5/mlx5_common_pci.c +1 -1
@@ -118,7 +118,7 @@ bus_cmdline_options_handler(__rte_unused const char *key,static int parse_class_options (const struct rte_devargs *devargs) { -const char *key =MLX5_CLASS_ARG_NAME ; +const char *key =RTE_DEVARGS_KEY_CLASS ;struct rte_kvargs *kvlist;int ret =0 ;
drivers/common/sfc_efx/sfc_efx.c +3 -4
@@ -42,7 +42,6 @@ enum sfc_efx_dev_class sfc_efx_dev_class_get(struct rte_devargs *devargs) {struct rte_kvargs *kvargs; -const char *key =SFC_EFX_KVARG_DEV_CLASS ;enum sfc_efx_dev_class dev_class =SFC_EFX_DEV_CLASS_NET ;if (devargs ==NULL )
@@ -52,9 +51,9 @@ sfc_efx_dev_class_get(struct rte_devargs *devargs)if (kvargs ==NULL )return dev_class; -if (rte_kvargs_count (kvargs, key) !=0 ) { -rte_kvargs_process (kvargs, key, sfc_efx_kvarg_dev_class_handler, - &dev_class); +if (rte_kvargs_count (kvargs,RTE_DEVARGS_KEY_CLASS ) !=0 ) { +rte_kvargs_process (kvargs,RTE_DEVARGS_KEY_CLASS , + sfc_efx_kvarg_dev_class_handler, &dev_class); }rte_kvargs_free (kvargs);
drivers/common/sfc_efx/sfc_efx.h +0 -2
@@ -19,8 +19,6 @@extern "C" {#endif -#define SFC_EFX_KVARG_DEV_CLASS "class" -enum sfc_efx_dev_class {SFC_EFX_DEV_CLASS_INVALID =0 ,SFC_EFX_DEV_CLASS_NET ,
drivers/net/bonding/rte_eth_bond_args.c +1 -1
@@ -18,7 +18,7 @@ const char *pmd_bond_init_valid_arguments[] = {PMD_BOND_SOCKET_ID_KVARG ,PMD_BOND_MAC_ADDR_KVARG ,PMD_BOND_AGG_MODE_KVARG , -"driver" , +RTE_DEVARGS_KEY_DRIVER , NULL };
drivers/net/i40e/i40e_ethdev_vf.c +2 -3
@@ -1660,7 +1660,6 @@ static int i40evf_driver_selected(struct rte_devargs *devargs) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ;if (devargs ==NULL )
@@ -1670,13 +1669,13 @@ i40evf_driver_selected(struct rte_devargs *devargs)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , i40evf_check_driver_handler,NULL ) <0 ) goto exit;
drivers/net/iavf/iavf_ethdev.c +2 -3
@@ -2448,7 +2448,6 @@ static int iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ; if (device_id != IAVF_DEV_ID_VF &&
@@ -2464,13 +2463,13 @@ iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , iavf_drv_i40evf_check_handler,NULL ) <0 ) goto exit;
drivers/net/mlx5/mlx5.c +2 -2
@@ -1931,7 +1931,7 @@ mlx5_args_check(const char *key, const char *val, void *opaque) config->max_dump_files_num = tmp; }else if (strcmp (MLX5_LRO_TIMEOUT_USEC , key) ==0 ) { config->lro.timeout = tmp; - }else if (strcmp (MLX5_CLASS_ARG_NAME , key) ==0 ) { + }else if (strcmp (RTE_DEVARGS_KEY_CLASS , key) ==0 ) {DRV_LOG (DEBUG ,"class argument is %s." , val); }else if (strcmp (MLX5_HP_BUF_SIZE , key) ==0 ) { config->log_hp_size = tmp;
@@ -2002,7 +2002,7 @@ mlx5_args(struct mlx5_dev_config *config, struct rte_devargs *devargs)MLX5_REPRESENTOR ,MLX5_MAX_DUMP_FILES_NUM ,MLX5_LRO_TIMEOUT_USEC , -MLX5_CLASS_ARG_NAME , +RTE_DEVARGS_KEY_CLASS ,MLX5_HP_BUF_SIZE ,MLX5_RECLAIM_MEM , MLX5_SYS_MEM_EN,
drivers/net/sfc/sfc_kvargs.c +1 -1
@@ -28,7 +28,7 @@ sfc_kvargs_parse(struct sfc_adapter *sa)SFC_KVARG_TX_DATAPATH ,SFC_KVARG_FW_VARIANT ,SFC_KVARG_RXD_WAIT_TIMEOUT_NS , -SFC_EFX_KVARG_DEV_CLASS , +RTE_DEVARGS_KEY_CLASS , NULL, };
drivers/vdpa/mlx5/mlx5_vdpa.c +1 -1
@@ -588,7 +588,7 @@ mlx5_vdpa_args_check_handler(const char *key, const char *val, void *opaque)unsigned long tmp;int n_cores =sysconf (_SC_NPROCESSORS_ONLN); -if (strcmp (key,"class" ) ==0 ) +if (strcmp (key,RTE_DEVARGS_KEY_CLASS ) ==0 )return 0 ; errno =0 ; tmp =strtoul (val,NULL ,0 );
lib/eal/common/eal_common_devargs.c +6 -6
@@ -49,9 +49,9 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,const char *str;struct rte_kvargs *kvlist; } layers[] = { - { "bus=", NULL, NULL, }, - { "class=", NULL, NULL, }, - { "driver=", NULL, NULL, }, + { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, }, }; struct rte_kvargs_pair *kv = NULL; struct rte_class *cls = NULL;
@@ -118,7 +118,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,if (layers[i].kvlist ==NULL )continue ; kv = &layers[i].kvlist->pairs[0 ]; -if (strcmp (kv->key,"bus" ) ==0 ) { +if (strcmp (kv->key,RTE_DEVARGS_KEY_BUS ) ==0 ) { bus =rte_bus_find_by_name (kv->value);if (bus ==NULL ) { RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
@@ -126,7 +126,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"class" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_CLASS ) ==0 ) { cls =rte_class_find_by_name (kv->value);if (cls ==NULL ) { RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
@@ -134,7 +134,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"driver" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_DRIVER ) ==0 ) {/* Ignore */ continue ; }
lib/eal/include/rte_devargs.h +24 -0
@@ -25,6 +25,30 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +/** +* Bus type key in global devargs syntax. +* +* Legacy devargs parser doesn't use this key as bus type +* is resolved as first optional value separated by ":". +*/ +#define RTE_DEVARGS_KEY_BUS "bus" + +/** +* Class type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse class type. PMD driver is +* encouraged to use this key to resolve class type. +*/ +#define RTE_DEVARGS_KEY_CLASS "class" + +/** +* Driver type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse driver type. PMD driver is +* encouraged to use this key to resolve driver type. +*/ +#define RTE_DEVARGS_KEY_DRIVER "driver" +/** * Type of generic device */
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH v5 1/2] devargs: add common key definition
23/06/2021 02:03, Xueming Li:
Quoted 4 lines
Adds common devargs key definition for "bus", "class" and "driver".
Cc Thomas Monjalon <[email protected]>Signed-off-by Xueming Li <[email protected]>
PATCH v5 2/2 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary 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/<name>
Devargs legacy syntax ofauxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 418 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 58 +++ drivers/bus/auxiliary/linux/auxiliary.c | 142 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 75 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 199 ++++++++++ drivers/bus/auxiliary/version.map | 3 + drivers/bus/meson.build | 1 + 10 files changed, 923 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
MAINTAINERS +5 -0
@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
doc/guides/rel_notes/release_21_08.rst +6 -0
@@ -55,6 +55,12 @@ 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. + Removed Items -------------
drivers/bus/auxiliary/auxiliary_common.c new file +418 -0
418 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +58 -0
58 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +142 -0
142 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +16 -0
@@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2021 NVIDIA Corporation & Affiliates + +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']
drivers/bus/auxiliary/private.h new file +75 -0
75 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +199 -0
199 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +3 -0
@@ -0,0 +1,3 @@ +EXPERIMENTAL { + # added in 21.08 +};
drivers/bus/meson.build +1 -0
@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Signature · 1 line
2.25.1
23/06/2021 02:03, Xueming Li:
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_common.c new file +3
-0+static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *drv, +struct rte_auxiliary_device *dev)
[...]
drivers/bus/auxiliary/auxiliary_common.c line 119
Quoted 1 line
drivers/bus/auxiliary/auxiliary_common.c new file +1
-0+AUXILIARY_LOG (DEBUG ,"Probe driver: %s" , drv->driver.name);
I think the debug log above is useless given the ones below.
drivers/bus/auxiliary/auxiliary_common.c line 124
Quoted 5 lines
drivers/bus/auxiliary/auxiliary_common.c new file +5
-0+ + iova_mode =rte_eal_iova_mode (); +if ((drv->drv_flags &RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA ) >0 && + iova_mode !=RTE_IOVA_VA ) { +AUXILIARY_LOG (ERR ,"Expecting VA IOVA mode but current mode is PA, not initializing" );
The error log should mention which driver is requesting VA and not initializing.
Quoted 25 lines
drivers/bus/auxiliary/auxiliary_common.c new file +25
-0+return -EINVAL ; + } + + dev->driver = drv; + +AUXILIARY_LOG (INFO ,"Probe auxiliary driver: %s device: %s (socket %i)" , + drv->driver.name, dev->name, dev->device.numa_node); + ret = drv->probe (drv, dev); +if (ret !=0 ) + dev->driver =NULL ; +else + dev->device.driver = &drv->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 *drv; +int ret =0 ; +
drivers/bus/auxiliary/auxiliary_common.c line 159
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+if (dev ==NULL ) +return -EINVAL ; + + drv = dev->driver; + +AUXILIARY_LOG (DEBUG ,"Auxiliary device %s on NUMA socket %i" , + dev->name, dev->device.numa_node); + +AUXILIARY_LOG (DEBUG ,"remove driver: %s %s" , + dev->name, drv->driver.name);
Better to merge both logs together.
Quoted 13 lines
drivers/bus/auxiliary/auxiliary_common.c new file +13
-0+ +if (drv->remove !=NULL ) { + ret = drv->remove (dev); +if (ret <0 ) +return ret; + } + +/* clear driver structure */ + dev->driver =NULL ; + dev->device.driver =NULL ; + +return 0 ; +}
[...]
drivers/bus/auxiliary/auxiliary_common.c line 241
Quoted 9 lines
drivers/bus/auxiliary/auxiliary_common.c new file +9
-0+static int +auxiliary_parse (const char *name,void *addr) +{ +struct rte_auxiliary_driver *drv =NULL ; +const char **out = addr; + +/* Allow dummy name to prevent bus scan. */ +if (strlen (name) ==0 ) +return 0 ;
Which syntax is it?
[...]
drivers/bus/auxiliary/auxiliary_params.c line 49
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_params.c new file +3
-0+ kvargs =rte_kvargs_parse (str, auxiliary_params_keys); +if (kvargs ==NULL ) { +RTE_LOG (ERR ,EAL ,"cannot parse argument list\n" );
Should use AUXILIARY_LOG.
[...]
drivers/bus/auxiliary/linux/auxiliary.c line 42
Quoted 2 lines
+++
b/drivers/bus/auxiliary/linux/auxiliary.cdrivers/bus/auxiliary/linux/auxiliary.c new file +1
-0+/* Get numa node, default to 0 if not present */
s/numa/NUMA/
[...]
Quoted 4 lines
+/*
+ * Scan the content of the auxiliary bus, and the devices in the devices
+ * list
+ */
Simpler: Scan the devices in the auxiliary bus.
Quoted 3 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +3
-0+int +auxiliary_scan (void ) +{
[...]
drivers/bus/auxiliary/private.h line 6
Quoted 8 lines
+++
b/drivers/bus/auxiliary/private.hdrivers/bus/auxiliary/private.h new file +6
-0@@ -0,0 +1,75 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#ifndef _AUXILIARY_PRIVATE_H_ +#define _AUXILIARY_PRIVATE_H_
nit: we can avoid the first and final underscores
[...]
drivers/bus/auxiliary/private.h line 45
Quoted 5 lines
drivers/bus/auxiliary/private.h new file +5
-0+/* +* Validate whether a device with given auxiliary device should be ignored +* or not. +*/ +bool auxiliary_ignore_device (const char *name);
Suggestion: auxiliary_is_ignored_device() ?
Review line 13
Quoted 2 lines
(quoted diff) +2
-0+/* + * Add an auxiliary device to the auxiliary bus (append to auxiliary Device
s/Device/device/
drivers/bus/auxiliary/private.h line 50
Quoted 2 lines
drivers/bus/auxiliary/private.h new file +2
-0+* list). This function also updates the bus references of the auxiliary +* Device (and the generic device object embedded within.
s/(and/and/
drivers/bus/auxiliary/private.h line 63
Quoted 13 lines
drivers/bus/auxiliary/private.h new file +13
-0+*/ +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. +*/ +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
no need of capital letters in driver and device.
drivers/bus/auxiliary/private.h line 69
Quoted 6 lines
drivers/bus/auxiliary/private.h new file +6
-0+*/ +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
What do you mean by "internal"?
Quoted 5 lines
drivers/bus/auxiliary/private.h new file +5
-0+* string. +*/ +void *auxiliary_dev_iterate (const void *start,const char *str, +const struct rte_dev_iterator *it); +
[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 146
Quoted 8 lines
+++
b/drivers/bus/auxiliary/rte_bus_auxiliary.hdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +7
-0+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. */
No capital in Probe and Remove
drivers/bus/auxiliary/rte_bus_auxiliary.h line 148
Quoted 2 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +2
-0+rte_auxiliary_dma_map_t *dma_map;/**< Device dma map function. */ +rte_auxiliary_dma_unmap_t *dma_unmap;/**< Device dma unmap function. */
s/dma/DMA/
There may be other occurences to check.
drivers/bus/auxiliary/rte_bus_auxiliary.h line 150
Quoted 2 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +2
-0+uint32_t drv_flags;/**< Flags RTE_AUXILIARY_DRV_*. */ +};
The alignment of some comments above can be improved by one space.
[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 184
Quoted 8 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +8
-0+/** 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__)
I think it is better not trying to align backslashes in such macro, but leave only a single space.
[...]
drivers/bus/auxiliary/version.map line 3
Quoted 5 lines
+++ b/drivers/bus/auxiliary/version.map
drivers/bus/auxiliary/version.map new file +3
-0@@ -0,0 +1,3 @@ +EXPERIMENTAL { + # added in 21.08 +};
Looks like you need to bring the symbols back :)
Looks good overrall, thanks.
Quoted 79 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Friday, June 25, 2021 12:19 AM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; Kinsella Ray <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v5 2/2] bus/auxiliary: introduce auxiliary bus23/06/2021 02:03, Xueming Li:
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_common.c new file +3
-0+static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *drv, +struct rte_auxiliary_device *dev)[...]
drivers/bus/auxiliary/auxiliary_common.c line 119
Quoted 1 line
drivers/bus/auxiliary/auxiliary_common.c new file +1
-0+AUXILIARY_LOG (DEBUG ,"Probe driver: %s" , drv->driver.name);I think the debug log above is useless given the ones below.
drivers/bus/auxiliary/auxiliary_common.c
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+ + iova_mode =rte_eal_iova_mode (); + if ((drv->drv_flags & RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA) > 0 && + iova_mode != RTE_IOVA_VA) { + AUXILIARY_LOG(ERR, "Expecting VA IOVA mode but current mode is PA, +not initializing");The error log should mention which driver is requesting VA and not initializing.
Quoted 24 lines
drivers/bus/auxiliary/auxiliary_common.c new file +24
-0+return -EINVAL ; + } + + dev->driver = drv; + +AUXILIARY_LOG (INFO ,"Probe auxiliary driver: %s device: %s (socket %i)" , + drv->driver.name, dev->name, dev->device.numa_node); + ret = drv->probe (drv, dev); +if (ret !=0 ) + dev->driver =NULL ; +else + dev->device.driver = &drv->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 *drv; +int ret =0 ; +drivers/bus/auxiliary/auxiliary_common.c line 159
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+if (dev ==NULL ) +return -EINVAL ; + + drv = dev->driver; + +AUXILIARY_LOG (DEBUG ,"Auxiliary device %s on NUMA socket %i" , + dev->name, dev->device.numa_node); + +AUXILIARY_LOG (DEBUG ,"remove driver: %s %s" , + dev->name, drv->driver.name);Better to merge both logs together.
Quoted 13 lines
drivers/bus/auxiliary/auxiliary_common.c new file +13
-0+ +if (drv->remove !=NULL ) { + ret = drv->remove (dev); +if (ret <0 ) +return ret; + } + +/* clear driver structure */ + dev->driver =NULL ; + dev->device.driver =NULL ; + +return 0 ; +}[...]
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c line 241
Quoted 8 lines
drivers/bus/auxiliary/auxiliary_common.c new file +8
-0+static int +auxiliary_parse (const char *name,void *addr) { +struct rte_auxiliary_driver *drv =NULL ; +const char **out = addr; + +/* Allow dummy name to prevent bus scan. */ +if (strlen (name) ==0 ) +return 0 ;Which syntax is it?
Allow empty device name "auxiliary:" to bypass entire auxiliary bus scan.
Quoted 141 lines
[...]
drivers/bus/auxiliary/auxiliary_params.c line 49
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_params.c new file +3
-0+ kvargs =rte_kvargs_parse (str, auxiliary_params_keys); +if (kvargs ==NULL ) { +RTE_LOG (ERR ,EAL ,"cannot parse argument list\n" );Should use
AUXILIARY_LOG.[...]
drivers/bus/auxiliary/linux/auxiliary.c line 42
Quoted 2 lines
+++
b/drivers/bus/auxiliary/linux/auxiliary.cdrivers/bus/auxiliary/linux/auxiliary.c new file +1
-0+/* Get numa node, default to 0 if not present */ s/numa/NUMA/
[...]
drivers/bus/auxiliary/linux/auxiliary.c line 99
Quoted 5 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +5
-0+/* +* Scan the content of the auxiliary bus, and the devices in the +devices +* list +*/ Simpler: Scan the devices in the auxiliary bus.
Quoted 3 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +3
-0+int +auxiliary_scan (void ) +{[...]
drivers/bus/auxiliary/private.h line 5
Quoted 7 lines
+++
b/drivers/bus/auxiliary/private.hdrivers/bus/auxiliary/private.h new file +5
-0@@ -0,0 +1,75 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates */ + +#ifndef _AUXILIARY_PRIVATE_H_ +#define _AUXILIARY_PRIVATE_H_nit: we can avoid the first and final underscores
[...]
drivers/bus/auxiliary/private.h line 45
Quoted 6 lines
drivers/bus/auxiliary/private.h new file +6
-0+/* +* Validate whether a device with given auxiliary device should be +ignored +* or not. +*/ +bool auxiliary_ignore_device (const char *name);Suggestion:
auxiliary_is_ignored_device()?Review line 14
Quoted 3 lines
(quoted diff) +3
-0+/* + * Add an auxiliary device to the auxiliary bus (append to auxiliary +Devices/Device/device/
Review line 17
Quoted 3 lines
(quoted diff) +3
-0+ * list). This function also updates the bus references of the + auxiliary + * Device (and the generic device object embedded within.s/(and/and/
Quoted 5 lines
drivers/bus/auxiliary/private.h new file +5
-0+*/ +void auxiliary_add_device (struct rte_auxiliary_device *aux_dev); + +/* +* Insert an auxiliary device in the auxiliary bus at a particular drivers/bus/auxiliary/private.h line 63
Quoted 10 lines
drivers/bus/auxiliary/private.h new file +10
-0+location +* in the device list. It also updates the auxiliary bus reference of +the +* new devices to be inserted. +*/ +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 no need of capital letters in driver and device.
drivers/bus/auxiliary/private.h
Quoted 7 lines
drivers/bus/auxiliary/private.h new file +7
-0+*/ +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 What do you mean by "internal"?
Quoted 5 lines
drivers/bus/auxiliary/private.h new file +5
-0+* string. +*/ +void *auxiliary_dev_iterate (const void *start,const char *str, +const struct rte_dev_iterator *it); +[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 146
Quoted 8 lines
+++
b/drivers/bus/auxiliary/rte_bus_auxiliary.hdrivers/bus/auxiliary/rte_bus_auxiliary.h new file +7
-0+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. */ No capital in Probe and Remove
Review
Quoted 3 lines
(quoted diff) +3
-0+ rte_auxiliary_dma_map_t *dma_map; /**< Device dma map function. */ + rte_auxiliary_dma_unmap_t *dma_unmap; /**< Device dma unmap +function. */s/dma/DMA/
There may be other occurences to check.drivers/bus/auxiliary/rte_bus_auxiliary.h line 150
Quoted 2 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +2
-0+uint32_t drv_flags;/**< Flags RTE_AUXILIARY_DRV_*. */ +};The alignment of some comments above can be improved by one space.
[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 184
Quoted 8 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +8
-0+/** 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__)I think it is better not trying to align backslashes in such macro, but leave only a single space.
[...]
drivers/bus/auxiliary/version.map line 3
Quoted 5 lines
+++ b/drivers/bus/auxiliary/version.map
drivers/bus/auxiliary/version.map new file +3
-0@@ -0,0 +1,3 @@ +EXPERIMENTAL { + # added in 21.08 +};Looks like you need to bring the symbols back :)
Looks good overrall, thanks.
25/06/2021 05:26, Xueming(Steven) Li:
Quoted 13 lines
From: Thomas Monjalon <[email protected]>
Quoted 11 lines
23/06/2021 02:03, Xueming Li:
drivers/bus/auxiliary/auxiliary_common.c line 241
Quoted 8 lines
drivers/bus/auxiliary/auxiliary_common.c new file +8
-0+static int +auxiliary_parse (const char *name,void *addr) { +struct rte_auxiliary_driver *drv =NULL ; +const char **out = addr; + +/* Allow dummy name to prevent bus scan. */ +if (strlen (name) ==0 ) +return 0 ;Which syntax is it?
Quoted 1 line
Allow empty device name "auxiliary:" to bypass entire auxiliary bus scan.
Ah OK
A suggestion of comment:
/* Skip auxiliary bus scan if name is empty. */
PATCH v6 1/2 devargs: add common key definition
In reply to Xueming LiAdds common devargs key definition for "bus", "class" and "driver".
--- drivers/common/mlx5/mlx5_common.h | 2 -- drivers/common/mlx5/mlx5_common_pci.c | 2 +- drivers/common/sfc_efx/sfc_efx.c | 7 +++---- drivers/common/sfc_efx/sfc_efx.h | 2 -- drivers/net/bonding/rte_eth_bond_args.c | 2 +- drivers/net/i40e/i40e_ethdev_vf.c | 5 ++--- drivers/net/iavf/iavf_ethdev.c | 5 ++--- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/sfc/sfc_kvargs.c | 2 +- drivers/vdpa/mlx5/mlx5_vdpa.c | 2 +- lib/eal/common/eal_common_devargs.c | 12 ++++++------ lib/eal/include/rte_devargs.h | 24 ++++++++++++++++++++++++ 12 files changed, 43 insertions(+), 26 deletions(-)
drivers/common/mlx5/mlx5_common.h +0 -2
@@ -208,8 +208,6 @@ __rte_internalint mlx5_get_ifname_sysfs (const char *ibdev_path,char *ifname); -#define MLX5_CLASS_ARG_NAME "class" -enum mlx5_class {MLX5_CLASS_INVALID ,MLX5_CLASS_NET =RTE_BIT64 (0 ),
drivers/common/mlx5/mlx5_common_pci.c +1 -1
@@ -118,7 +118,7 @@ bus_cmdline_options_handler(__rte_unused const char *key,static int parse_class_options (const struct rte_devargs *devargs) { -const char *key =MLX5_CLASS_ARG_NAME ; +const char *key =RTE_DEVARGS_KEY_CLASS ;struct rte_kvargs *kvlist;int ret =0 ;
drivers/common/sfc_efx/sfc_efx.c +3 -4
@@ -42,7 +42,6 @@ enum sfc_efx_dev_class sfc_efx_dev_class_get(struct rte_devargs *devargs) {struct rte_kvargs *kvargs; -const char *key =SFC_EFX_KVARG_DEV_CLASS ;enum sfc_efx_dev_class dev_class =SFC_EFX_DEV_CLASS_NET ;if (devargs ==NULL )
@@ -52,9 +51,9 @@ sfc_efx_dev_class_get(struct rte_devargs *devargs)if (kvargs ==NULL )return dev_class; -if (rte_kvargs_count (kvargs, key) !=0 ) { -rte_kvargs_process (kvargs, key, sfc_efx_kvarg_dev_class_handler, - &dev_class); +if (rte_kvargs_count (kvargs,RTE_DEVARGS_KEY_CLASS ) !=0 ) { +rte_kvargs_process (kvargs,RTE_DEVARGS_KEY_CLASS , + sfc_efx_kvarg_dev_class_handler, &dev_class); }rte_kvargs_free (kvargs);
drivers/common/sfc_efx/sfc_efx.h +0 -2
@@ -19,8 +19,6 @@extern "C" {#endif -#define SFC_EFX_KVARG_DEV_CLASS "class" -enum sfc_efx_dev_class {SFC_EFX_DEV_CLASS_INVALID =0 ,SFC_EFX_DEV_CLASS_NET ,
drivers/net/bonding/rte_eth_bond_args.c +1 -1
@@ -18,7 +18,7 @@ const char *pmd_bond_init_valid_arguments[] = {PMD_BOND_SOCKET_ID_KVARG ,PMD_BOND_MAC_ADDR_KVARG ,PMD_BOND_AGG_MODE_KVARG , -"driver" , +RTE_DEVARGS_KEY_DRIVER , NULL };
drivers/net/i40e/i40e_ethdev_vf.c +2 -3
@@ -1660,7 +1660,6 @@ static int i40evf_driver_selected(struct rte_devargs *devargs) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ;if (devargs ==NULL )
@@ -1670,13 +1669,13 @@ i40evf_driver_selected(struct rte_devargs *devargs)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , i40evf_check_driver_handler,NULL ) <0 ) goto exit;
drivers/net/iavf/iavf_ethdev.c +2 -3
@@ -2448,7 +2448,6 @@ static int iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ; if (device_id != IAVF_DEV_ID_VF &&
@@ -2464,13 +2463,13 @@ iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , iavf_drv_i40evf_check_handler,NULL ) <0 ) goto exit;
drivers/net/mlx5/mlx5.c +2 -2
@@ -1931,7 +1931,7 @@ mlx5_args_check(const char *key, const char *val, void *opaque) config->max_dump_files_num = tmp; }else if (strcmp (MLX5_LRO_TIMEOUT_USEC , key) ==0 ) { config->lro.timeout = tmp; - }else if (strcmp (MLX5_CLASS_ARG_NAME , key) ==0 ) { + }else if (strcmp (RTE_DEVARGS_KEY_CLASS , key) ==0 ) {DRV_LOG (DEBUG ,"class argument is %s." , val); }else if (strcmp (MLX5_HP_BUF_SIZE , key) ==0 ) { config->log_hp_size = tmp;
@@ -2002,7 +2002,7 @@ mlx5_args(struct mlx5_dev_config *config, struct rte_devargs *devargs)MLX5_REPRESENTOR ,MLX5_MAX_DUMP_FILES_NUM ,MLX5_LRO_TIMEOUT_USEC , -MLX5_CLASS_ARG_NAME , +RTE_DEVARGS_KEY_CLASS ,MLX5_HP_BUF_SIZE ,MLX5_RECLAIM_MEM , MLX5_SYS_MEM_EN,
drivers/net/sfc/sfc_kvargs.c +1 -1
@@ -28,7 +28,7 @@ sfc_kvargs_parse(struct sfc_adapter *sa)SFC_KVARG_TX_DATAPATH ,SFC_KVARG_FW_VARIANT ,SFC_KVARG_RXD_WAIT_TIMEOUT_NS , -SFC_EFX_KVARG_DEV_CLASS , +RTE_DEVARGS_KEY_CLASS , NULL, };
drivers/vdpa/mlx5/mlx5_vdpa.c +1 -1
@@ -588,7 +588,7 @@ mlx5_vdpa_args_check_handler(const char *key, const char *val, void *opaque)unsigned long tmp;int n_cores =sysconf (_SC_NPROCESSORS_ONLN); -if (strcmp (key,"class" ) ==0 ) +if (strcmp (key,RTE_DEVARGS_KEY_CLASS ) ==0 )return 0 ; errno =0 ; tmp =strtoul (val,NULL ,0 );
lib/eal/common/eal_common_devargs.c +6 -6
@@ -49,9 +49,9 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,const char *str;struct rte_kvargs *kvlist; } layers[] = { - { "bus=", NULL, NULL, }, - { "class=", NULL, NULL, }, - { "driver=", NULL, NULL, }, + { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, }, }; struct rte_kvargs_pair *kv = NULL; struct rte_class *cls = NULL;
@@ -118,7 +118,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,if (layers[i].kvlist ==NULL )continue ; kv = &layers[i].kvlist->pairs[0 ]; -if (strcmp (kv->key,"bus" ) ==0 ) { +if (strcmp (kv->key,RTE_DEVARGS_KEY_BUS ) ==0 ) { bus =rte_bus_find_by_name (kv->value);if (bus ==NULL ) { RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
@@ -126,7 +126,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"class" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_CLASS ) ==0 ) { cls =rte_class_find_by_name (kv->value);if (cls ==NULL ) { RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
@@ -134,7 +134,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"driver" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_DRIVER ) ==0 ) {/* Ignore */ continue ; }
lib/eal/include/rte_devargs.h +24 -0
@@ -25,6 +25,30 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +/** +* Bus type key in global devargs syntax. +* +* Legacy devargs parser doesn't use this key as bus type +* is resolved as first optional value separated by ":". +*/ +#define RTE_DEVARGS_KEY_BUS "bus" + +/** +* Class type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse class type. PMD driver is +* encouraged to use this key to resolve class type. +*/ +#define RTE_DEVARGS_KEY_CLASS "class" + +/** +* Driver type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse driver type. PMD driver is +* encouraged to use this key to resolve driver type. +*/ +#define RTE_DEVARGS_KEY_DRIVER "driver" +/** * Type of generic device */
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH v6 1/2] devargs: add common key definition
Quoted 4 lines · Xueming Li
Adds common devargs key definition for "bus", "class" and "driver".
Acked-by Thomas Monjalon <[email protected]>Signed-off-by Xueming Li <[email protected]>
PATCH v7 1/2 devargs: add common key definition
In reply to Xueming LiAdds common devargs key definition for "bus", "class" and "driver".
--- drivers/common/mlx5/mlx5_common.h | 2 -- drivers/common/mlx5/mlx5_common_pci.c | 2 +- drivers/common/sfc_efx/sfc_efx.c | 7 +++---- drivers/common/sfc_efx/sfc_efx.h | 2 -- drivers/net/bonding/rte_eth_bond_args.c | 2 +- drivers/net/i40e/i40e_ethdev_vf.c | 5 ++--- drivers/net/iavf/iavf_ethdev.c | 5 ++--- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/sfc/sfc_kvargs.c | 2 +- drivers/vdpa/mlx5/mlx5_vdpa.c | 2 +- lib/eal/common/eal_common_devargs.c | 12 ++++++------ lib/eal/include/rte_devargs.h | 24 ++++++++++++++++++++++++ 12 files changed, 43 insertions(+), 26 deletions(-)
drivers/common/mlx5/mlx5_common.h +0 -2
@@ -208,8 +208,6 @@ __rte_internalint mlx5_get_ifname_sysfs (const char *ibdev_path,char *ifname); -#define MLX5_CLASS_ARG_NAME "class" -enum mlx5_class {MLX5_CLASS_INVALID ,MLX5_CLASS_NET =RTE_BIT64 (0 ),
drivers/common/mlx5/mlx5_common_pci.c +1 -1
@@ -118,7 +118,7 @@ bus_cmdline_options_handler(__rte_unused const char *key,static int parse_class_options (const struct rte_devargs *devargs) { -const char *key =MLX5_CLASS_ARG_NAME ; +const char *key =RTE_DEVARGS_KEY_CLASS ;struct rte_kvargs *kvlist;int ret =0 ;
drivers/common/sfc_efx/sfc_efx.c +3 -4
@@ -42,7 +42,6 @@ enum sfc_efx_dev_class sfc_efx_dev_class_get(struct rte_devargs *devargs) {struct rte_kvargs *kvargs; -const char *key =SFC_EFX_KVARG_DEV_CLASS ;enum sfc_efx_dev_class dev_class =SFC_EFX_DEV_CLASS_NET ;if (devargs ==NULL )
@@ -52,9 +51,9 @@ sfc_efx_dev_class_get(struct rte_devargs *devargs)if (kvargs ==NULL )return dev_class; -if (rte_kvargs_count (kvargs, key) !=0 ) { -rte_kvargs_process (kvargs, key, sfc_efx_kvarg_dev_class_handler, - &dev_class); +if (rte_kvargs_count (kvargs,RTE_DEVARGS_KEY_CLASS ) !=0 ) { +rte_kvargs_process (kvargs,RTE_DEVARGS_KEY_CLASS , + sfc_efx_kvarg_dev_class_handler, &dev_class); }rte_kvargs_free (kvargs);
drivers/common/sfc_efx/sfc_efx.h +0 -2
@@ -19,8 +19,6 @@extern "C" {#endif -#define SFC_EFX_KVARG_DEV_CLASS "class" -enum sfc_efx_dev_class {SFC_EFX_DEV_CLASS_INVALID =0 ,SFC_EFX_DEV_CLASS_NET ,
drivers/net/bonding/rte_eth_bond_args.c +1 -1
@@ -18,7 +18,7 @@ const char *pmd_bond_init_valid_arguments[] = {PMD_BOND_SOCKET_ID_KVARG ,PMD_BOND_MAC_ADDR_KVARG ,PMD_BOND_AGG_MODE_KVARG , -"driver" , +RTE_DEVARGS_KEY_DRIVER , NULL };
drivers/net/i40e/i40e_ethdev_vf.c +2 -3
@@ -1660,7 +1660,6 @@ static int i40evf_driver_selected(struct rte_devargs *devargs) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ;if (devargs ==NULL )
@@ -1670,13 +1669,13 @@ i40evf_driver_selected(struct rte_devargs *devargs)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , i40evf_check_driver_handler,NULL ) <0 ) goto exit;
drivers/net/iavf/iavf_ethdev.c +2 -3
@@ -2448,7 +2448,6 @@ static int iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ; if (device_id != IAVF_DEV_ID_VF &&
@@ -2464,13 +2463,13 @@ iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , iavf_drv_i40evf_check_handler,NULL ) <0 ) goto exit;
drivers/net/mlx5/mlx5.c +2 -2
@@ -1931,7 +1931,7 @@ mlx5_args_check(const char *key, const char *val, void *opaque) config->max_dump_files_num = tmp; }else if (strcmp (MLX5_LRO_TIMEOUT_USEC , key) ==0 ) { config->lro.timeout = tmp; - }else if (strcmp (MLX5_CLASS_ARG_NAME , key) ==0 ) { + }else if (strcmp (RTE_DEVARGS_KEY_CLASS , key) ==0 ) {DRV_LOG (DEBUG ,"class argument is %s." , val); }else if (strcmp (MLX5_HP_BUF_SIZE , key) ==0 ) { config->log_hp_size = tmp;
@@ -2002,7 +2002,7 @@ mlx5_args(struct mlx5_dev_config *config, struct rte_devargs *devargs)MLX5_REPRESENTOR ,MLX5_MAX_DUMP_FILES_NUM ,MLX5_LRO_TIMEOUT_USEC , -MLX5_CLASS_ARG_NAME , +RTE_DEVARGS_KEY_CLASS ,MLX5_HP_BUF_SIZE ,MLX5_RECLAIM_MEM , MLX5_SYS_MEM_EN,
drivers/net/sfc/sfc_kvargs.c +1 -1
@@ -28,7 +28,7 @@ sfc_kvargs_parse(struct sfc_adapter *sa)SFC_KVARG_TX_DATAPATH ,SFC_KVARG_FW_VARIANT ,SFC_KVARG_RXD_WAIT_TIMEOUT_NS , -SFC_EFX_KVARG_DEV_CLASS , +RTE_DEVARGS_KEY_CLASS , NULL, };
drivers/vdpa/mlx5/mlx5_vdpa.c +1 -1
@@ -588,7 +588,7 @@ mlx5_vdpa_args_check_handler(const char *key, const char *val, void *opaque)unsigned long tmp;int n_cores =sysconf (_SC_NPROCESSORS_ONLN); -if (strcmp (key,"class" ) ==0 ) +if (strcmp (key,RTE_DEVARGS_KEY_CLASS ) ==0 )return 0 ; errno =0 ; tmp =strtoul (val,NULL ,0 );
lib/eal/common/eal_common_devargs.c +6 -6
@@ -49,9 +49,9 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,const char *str;struct rte_kvargs *kvlist; } layers[] = { - { "bus=", NULL, NULL, }, - { "class=", NULL, NULL, }, - { "driver=", NULL, NULL, }, + { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, }, }; struct rte_kvargs_pair *kv = NULL; struct rte_class *cls = NULL;
@@ -118,7 +118,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,if (layers[i].kvlist ==NULL )continue ; kv = &layers[i].kvlist->pairs[0 ]; -if (strcmp (kv->key,"bus" ) ==0 ) { +if (strcmp (kv->key,RTE_DEVARGS_KEY_BUS ) ==0 ) { bus =rte_bus_find_by_name (kv->value);if (bus ==NULL ) { RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
@@ -126,7 +126,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"class" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_CLASS ) ==0 ) { cls =rte_class_find_by_name (kv->value);if (cls ==NULL ) { RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
@@ -134,7 +134,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"driver" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_DRIVER ) ==0 ) {/* Ignore */ continue ; }
lib/eal/include/rte_devargs.h +24 -0
@@ -25,6 +25,30 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +/** +* Bus type key in global devargs syntax. +* +* Legacy devargs parser doesn't use this key as bus type +* is resolved as first optional value separated by ":". +*/ +#define RTE_DEVARGS_KEY_BUS "bus" + +/** +* Class type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse class type. PMD driver is +* encouraged to use this key to resolve class type. +*/ +#define RTE_DEVARGS_KEY_CLASS "class" + +/** +* Driver type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse driver type. PMD driver is +* encouraged to use this key to resolve driver type. +*/ +#define RTE_DEVARGS_KEY_DRIVER "driver" +/** * Type of generic device */
Signature · 1 line
2.25.1
PATCH v7 2/2 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary 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/<name>
Devargs legacy syntax of auxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...]
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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
MAINTAINERS +5 -0
@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver - EXPERIMENTAL +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
doc/guides/rel_notes/release_21_08.rst +6 -0
@@ -55,6 +55,12 @@ 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. + Removed Items -------------
drivers/bus/auxiliary/auxiliary_common.c new file +411 -0
411 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +59 -0
59 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +141 -0
141 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +16 -0
@@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2021 NVIDIA Corporation & Affiliates + +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']
drivers/bus/auxiliary/private.h new file +74 -0
74 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +201 -0
201 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +7 -0
@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -0
@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Signature · 1 line
2.25.1
Made changes and forgot to commit :( please ignore and refer to new v8.
Quoted 1,011 lines
-----Original Message-----
From: Xueming(Steven) Li <[email protected]>
Sent: Monday, July 5, 2021 1:37 PM
Cc: [email protected]; Xueming(Steven) Li <[email protected]>; Wang Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Kinsella Ray <[email protected]>; Andrew Rybchenko <[email protected]>; Parav Pandit <[email protected]>; Neil Horman <[email protected]>
Subject: [PATCH v7 2/2] bus/auxiliary: introduce auxiliary busAuxiliary 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/<name>Devargs legacy syntax of auxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...][1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>Acked-by Andrew Rybchenko <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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.mapMAINTAINERS +5
-0@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver - EXPERIMENTAL +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/doc/guides/rel_notes/release_21_08.rst +6
-0@@ -55,6 +55,12 @@ 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. + Removed Items -------------drivers/bus/auxiliary/auxiliary_common.c new file +390
-0@@ -0,0 +1,411 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates */ + +#include <string.h> +#include <inttypes.h> +#include <stdint.h> +#include <stdbool.h> +#include <stdlib.h> +#include <stdio.h> +#include <sys/queue.h> +#include <rte_errno.h> +#include <rte_interrupts.h> +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_per_lcore.h> +#include <rte_memory.h> +#include <rte_eal.h> +#include <rte_eal_paging.h> +#include <rte_string_fns.h> +#include <rte_common.h> +#include <rte_devargs.h> + +#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_AUXILIARY_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 devices in the auxiliary bus. +* +* Stub for OS not supporting auxiliary bus. +*/ +__rte_weak int +auxiliary_scan (void ) +{ +return 0 ; +} + +/* +* Update a device's devargs 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 *drv, +struct rte_auxiliary_device *dev) { +enum rte_iova_mode iova_mode; +int ret; + +if ((drv ==NULL ) || (dev ==NULL )) +return -EINVAL ; + +/* Check if driver supports it. */ +if (!auxiliary_match (drv, dev)) +/* Match of device and driver failed */ +return 1 ; + +/* 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" ); +return -1 ; + } + +if (dev->device.numa_node <0 ) { +AUXILIARY_LOG (INFO ,"Device is not NUMA-aware, defaulting socket to 0" ); + dev->device.numa_node =0 ; + } + + iova_mode =rte_eal_iova_mode (); +if ((drv->drv_flags &RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA ) >0 && + iova_mode !=RTE_IOVA_VA ) { +AUXILIARY_LOG (ERR ,"Driver %s expecting VA IOVA mode but current mode is PA, not initializing" , + drv->driver.name); +return -EINVAL ; + } + + dev->driver = drv; + +AUXILIARY_LOG (INFO ,"Probe auxiliary driver: %s device: %s (socket %i)" , + drv->driver.name, dev->name, dev->device.numa_node); + ret = drv->probe (drv, dev); +if (ret !=0 ) + dev->driver =NULL ; +else + dev->device.driver = &drv->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 *drv; +int ret =0 ; + +if (dev ==NULL ) +return -EINVAL ; + + drv = dev->driver; + +AUXILIARY_LOG (DEBUG ,"Driver %s remove auxiliary device %s on NUMA socket %i" , + drv->driver.name, dev->name, dev->device.numa_node); + +if (drv->remove !=NULL ) { + ret = drv->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 *drv; +int rc; + +if (dev ==NULL ) +return -EINVAL ; + +FOREACH_DRIVER_ON_AUXILIARY_BUS (drv) { +if (!drv->match (dev->name)) +continue ; + + rc =rte_auxiliary_probe_one_driver (drv, 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 to try to probe 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_AUXILIARY_BUS (dev) { + probed++; + + ret =auxiliary_probe_all_drivers (dev); +if (ret <0 ) { +if (ret != -EEXIST ) { +AUXILIARY_LOG (ERR ,"Requested device %s cannot be used" , + 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 *drv =NULL ; +const char **out = addr; + +/* Allow empty device name "auxiliary:" to bypass entire bus scan. */ +if (strlen (name) ==0 ) +return 0 ; + +FOREACH_DRIVER_ON_AUXILIARY_BUS (drv) { +if (drv->match (name)) +break ; + } +if (drv !=NULL && addr !=NULL ) + *out = name; +return drv !=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 ==NULL ) { + rte_errno =EINVAL ; +return -1 ; + } +if (aux_dev->driver->dma_map ==NULL ) { + rte_errno =ENOTSUP ; +return -1 ; + } +return aux_dev->driver->dma_map (aux_dev, addr, iova, len); } + +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 ==NULL ) { + rte_errno =EINVAL ; +return -1 ; + } +if (aux_dev->driver->dma_unmap ==NULL ) { + rte_errno =ENOTSUP ; +return -1 ; + } +return aux_dev->driver->dma_unmap (aux_dev, addr, iova, len); } + +bool +auxiliary_is_ignored_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_AUXILIARY_BUS (drv) { +if ((drv->drv_flags &RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA ) >0 ) +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 );drivers/bus/auxiliary/auxiliary_params.c new file +57
-0@@ -0,0 +1,59 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates */ + +#include <string.h> + +#include <rte_bus.h> +#include <rte_dev.h> +#include <rte_errno.h> +#include <rte_kvargs.h> + +#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 ) { +AUXILIARY_LOG (ERR ,"cannot parse argument list %s" , + str); + 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; +}drivers/bus/auxiliary/linux/auxiliary.c new file +134
-0@@ -0,0 +1,141 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates */ + +#include <string.h> +#include <dirent.h> + +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_malloc.h> +#include <rte_devargs.h> +#include <rte_memcpy.h> +#include <eal_filesystem.h> + +#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 devices in the auxiliary bus */ 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?" , +AUXILIARY_SYSFS_PATH ); +return 0 ; + } + +while ((e =readdir (dir)) !=NULL ) { +if (e->d_name[0 ] =='.' ) +continue ; + +if (auxiliary_is_ignored_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_AUXILIARY_BUS (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 ; +}drivers/bus/auxiliary/meson.build new file +16
-0@@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause # Copyright (c) 2021 NVIDIA +Corporation & Affiliates + +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']drivers/bus/auxiliary/private.h new file +78
-0@@ -0,0 +1,74 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates */ + +#ifndef AUXILIARY_PRIVATE_H +#define AUXILIARY_PRIVATE_H + +#include <stdbool.h> +#include <stdio.h> + +#include "rte_bus_auxiliary.h" + +extern struct rte_auxiliary_bus auxiliary_bus;extern int +auxiliary_bus_logtype; + +#define AUXILIARY_LOG (level, ...) \ + rte_log(RTE_LOG_ ## level, auxiliary_bus_logtype, \ + RTE_FMT("auxiliary bus: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \ + RTE_FMT_TAIL(__VA_ARGS__,))) + +/* Auxiliary bus iterators */ +#define FOREACH_DEVICE_ON_AUXILIARY_BUS (p) \ + TAILQ_FOREACH(p, &(auxiliary_bus.device_list), next) + +#define FOREACH_DRIVER_ON_AUXILIARY_BUS (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. +*/ +int auxiliary_scan (void ); + +/* +* Update a device being scanned. +*/ +void auxiliary_on_scan (struct rte_auxiliary_device *aux_dev); + +/* +* Validate whether a device with given auxiliary device should be +ignored +* or not. +*/ +bool auxiliary_is_ignored_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. +*/ +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. +*/ +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 */ bool +auxiliary_match (const struct rte_auxiliary_driver *aux_drv, +const struct rte_auxiliary_device *aux_dev); + +/* +* Iterate over devices, matching any device against the provided +string */ void *auxiliary_dev_iterate (const void *start,const char +*str, +const struct rte_dev_iterator *it); + +#endif /* AUXILIARY_PRIVATE_H */ drivers/bus/auxiliary/rte_bus_auxiliary.h new file +199
-0@@ -0,0 +1,201 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates */ + +#ifndef RTE_BUS_AUXILIARY_H +#define RTE_BUS_AUXILIARY_H + +/** +* @file +* +* Auxiliary Bus Interface. +*/ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +#define RTE_BUS_AUXILIARY_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. */ +struct rte_device device;/**< Inherit core device */ +char name[RTE_DEV_NAME_MAX_LEN +1 ];/**< ASCII device name */ +struct rte_intr_handle intr_handle;/**< Interrupt handle */ +struct rte_auxiliary_driver *driver;/**< Device driver */ +}; + +/** 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 */ drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};drivers/bus/meson.build +1
-1@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga', --2.25.1
PATCH v8 1/2 devargs: add common key definition
In reply to Xueming LiAdds common devargs key definition for "bus", "class" and "driver".
--- drivers/common/mlx5/mlx5_common.h | 2 -- drivers/common/mlx5/mlx5_common_pci.c | 2 +- drivers/common/sfc_efx/sfc_efx.c | 7 +++---- drivers/common/sfc_efx/sfc_efx.h | 2 -- drivers/net/bonding/rte_eth_bond_args.c | 2 +- drivers/net/i40e/i40e_ethdev_vf.c | 5 ++--- drivers/net/iavf/iavf_ethdev.c | 5 ++--- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/sfc/sfc_kvargs.c | 2 +- drivers/vdpa/mlx5/mlx5_vdpa.c | 2 +- lib/eal/common/eal_common_devargs.c | 12 ++++++------ lib/eal/include/rte_devargs.h | 24 ++++++++++++++++++++++++ 12 files changed, 43 insertions(+), 26 deletions(-)
drivers/common/mlx5/mlx5_common.h +0 -2
@@ -208,8 +208,6 @@ __rte_internalint mlx5_get_ifname_sysfs (const char *ibdev_path,char *ifname); -#define MLX5_CLASS_ARG_NAME "class" -enum mlx5_class {MLX5_CLASS_INVALID ,MLX5_CLASS_NET =RTE_BIT64 (0 ),
drivers/common/mlx5/mlx5_common_pci.c +1 -1
@@ -118,7 +118,7 @@ bus_cmdline_options_handler(__rte_unused const char *key,static int parse_class_options (const struct rte_devargs *devargs) { -const char *key =MLX5_CLASS_ARG_NAME ; +const char *key =RTE_DEVARGS_KEY_CLASS ;struct rte_kvargs *kvlist;int ret =0 ;
drivers/common/sfc_efx/sfc_efx.c +3 -4
@@ -42,7 +42,6 @@ enum sfc_efx_dev_class sfc_efx_dev_class_get(struct rte_devargs *devargs) {struct rte_kvargs *kvargs; -const char *key =SFC_EFX_KVARG_DEV_CLASS ;enum sfc_efx_dev_class dev_class =SFC_EFX_DEV_CLASS_NET ;if (devargs ==NULL )
@@ -52,9 +51,9 @@ sfc_efx_dev_class_get(struct rte_devargs *devargs)if (kvargs ==NULL )return dev_class; -if (rte_kvargs_count (kvargs, key) !=0 ) { -rte_kvargs_process (kvargs, key, sfc_efx_kvarg_dev_class_handler, - &dev_class); +if (rte_kvargs_count (kvargs,RTE_DEVARGS_KEY_CLASS ) !=0 ) { +rte_kvargs_process (kvargs,RTE_DEVARGS_KEY_CLASS , + sfc_efx_kvarg_dev_class_handler, &dev_class); }rte_kvargs_free (kvargs);
drivers/common/sfc_efx/sfc_efx.h +0 -2
@@ -19,8 +19,6 @@extern "C" {#endif -#define SFC_EFX_KVARG_DEV_CLASS "class" -enum sfc_efx_dev_class {SFC_EFX_DEV_CLASS_INVALID =0 ,SFC_EFX_DEV_CLASS_NET ,
drivers/net/bonding/rte_eth_bond_args.c +1 -1
@@ -18,7 +18,7 @@ const char *pmd_bond_init_valid_arguments[] = {PMD_BOND_SOCKET_ID_KVARG ,PMD_BOND_MAC_ADDR_KVARG ,PMD_BOND_AGG_MODE_KVARG , -"driver" , +RTE_DEVARGS_KEY_DRIVER , NULL };
drivers/net/i40e/i40e_ethdev_vf.c +2 -3
@@ -1660,7 +1660,6 @@ static int i40evf_driver_selected(struct rte_devargs *devargs) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ;if (devargs ==NULL )
@@ -1670,13 +1669,13 @@ i40evf_driver_selected(struct rte_devargs *devargs)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , i40evf_check_driver_handler,NULL ) <0 ) goto exit;
drivers/net/iavf/iavf_ethdev.c +2 -3
@@ -2448,7 +2448,6 @@ static int iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ; if (device_id != IAVF_DEV_ID_VF &&
@@ -2464,13 +2463,13 @@ iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , iavf_drv_i40evf_check_handler,NULL ) <0 ) goto exit;
drivers/net/mlx5/mlx5.c +2 -2
@@ -1931,7 +1931,7 @@ mlx5_args_check(const char *key, const char *val, void *opaque) config->max_dump_files_num = tmp; }else if (strcmp (MLX5_LRO_TIMEOUT_USEC , key) ==0 ) { config->lro.timeout = tmp; - }else if (strcmp (MLX5_CLASS_ARG_NAME , key) ==0 ) { + }else if (strcmp (RTE_DEVARGS_KEY_CLASS , key) ==0 ) {DRV_LOG (DEBUG ,"class argument is %s." , val); }else if (strcmp (MLX5_HP_BUF_SIZE , key) ==0 ) { config->log_hp_size = tmp;
@@ -2002,7 +2002,7 @@ mlx5_args(struct mlx5_dev_config *config, struct rte_devargs *devargs)MLX5_REPRESENTOR ,MLX5_MAX_DUMP_FILES_NUM ,MLX5_LRO_TIMEOUT_USEC , -MLX5_CLASS_ARG_NAME , +RTE_DEVARGS_KEY_CLASS ,MLX5_HP_BUF_SIZE ,MLX5_RECLAIM_MEM , MLX5_SYS_MEM_EN,
drivers/net/sfc/sfc_kvargs.c +1 -1
@@ -28,7 +28,7 @@ sfc_kvargs_parse(struct sfc_adapter *sa)SFC_KVARG_TX_DATAPATH ,SFC_KVARG_FW_VARIANT ,SFC_KVARG_RXD_WAIT_TIMEOUT_NS , -SFC_EFX_KVARG_DEV_CLASS , +RTE_DEVARGS_KEY_CLASS , NULL, };
drivers/vdpa/mlx5/mlx5_vdpa.c +1 -1
@@ -588,7 +588,7 @@ mlx5_vdpa_args_check_handler(const char *key, const char *val, void *opaque)unsigned long tmp;int n_cores =sysconf (_SC_NPROCESSORS_ONLN); -if (strcmp (key,"class" ) ==0 ) +if (strcmp (key,RTE_DEVARGS_KEY_CLASS ) ==0 )return 0 ; errno =0 ; tmp =strtoul (val,NULL ,0 );
lib/eal/common/eal_common_devargs.c +6 -6
@@ -49,9 +49,9 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,const char *str;struct rte_kvargs *kvlist; } layers[] = { - { "bus=", NULL, NULL, }, - { "class=", NULL, NULL, }, - { "driver=", NULL, NULL, }, + { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, }, }; struct rte_kvargs_pair *kv = NULL; struct rte_class *cls = NULL;
@@ -118,7 +118,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,if (layers[i].kvlist ==NULL )continue ; kv = &layers[i].kvlist->pairs[0 ]; -if (strcmp (kv->key,"bus" ) ==0 ) { +if (strcmp (kv->key,RTE_DEVARGS_KEY_BUS ) ==0 ) { bus =rte_bus_find_by_name (kv->value);if (bus ==NULL ) { RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n",
@@ -126,7 +126,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"class" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_CLASS ) ==0 ) { cls =rte_class_find_by_name (kv->value);if (cls ==NULL ) { RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n",
@@ -134,7 +134,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs, ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"driver" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_DRIVER ) ==0 ) {/* Ignore */ continue ; }
lib/eal/include/rte_devargs.h +24 -0
@@ -25,6 +25,30 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +/** +* Bus type key in global devargs syntax. +* +* Legacy devargs parser doesn't use this key as bus type +* is resolved as first optional value separated by ":". +*/ +#define RTE_DEVARGS_KEY_BUS "bus" + +/** +* Class type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse class type. PMD driver is +* encouraged to use this key to resolve class type. +*/ +#define RTE_DEVARGS_KEY_CLASS "class" + +/** +* Driver type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse driver type. PMD driver is +* encouraged to use this key to resolve driver type. +*/ +#define RTE_DEVARGS_KEY_DRIVER "driver" +/** * Type of generic device */
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH v8 1/2] devargs: add common key definition
Sorry, this patch missed the ack line from Andrew:
Quoted 279 lines
-----Original Message-----
From: Xueming(Steven) Li <[email protected]>
Sent: Monday, July 5, 2021 2:45 PM
Cc: [email protected]; Xueming(Steven) Li <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Matan Azrad <[email protected]>; Shahaf Shuler <[email protected]>; Slava Ovsiienko <[email protected]>; Andrew Rybchenko <[email protected]>; Chas Williams <[email protected]>; Min Hu (Connor) <[email protected]>; Beilei Xing <[email protected]>; Jingjing Wu <[email protected]>
Subject: [PATCH v8 1/2] devargs: add common key definitionAdds common devargs key definition for "bus", "class" and "driver".
Acked-by Thomas Monjalon <[email protected]>Signed-off-by Xueming Li <[email protected]>--- drivers/common/mlx5/mlx5_common.h | 2 -- drivers/common/mlx5/mlx5_common_pci.c | 2 +- drivers/common/sfc_efx/sfc_efx.c | 7 +++---- drivers/common/sfc_efx/sfc_efx.h | 2 -- drivers/net/bonding/rte_eth_bond_args.c | 2 +- drivers/net/i40e/i40e_ethdev_vf.c | 5 ++--- drivers/net/iavf/iavf_ethdev.c | 5 ++--- drivers/net/mlx5/mlx5.c | 4 ++-- drivers/net/sfc/sfc_kvargs.c | 2 +- drivers/vdpa/mlx5/mlx5_vdpa.c | 2 +- lib/eal/common/eal_common_devargs.c | 12 ++++++------ lib/eal/include/rte_devargs.h | 24 ++++++++++++++++++++++++ 12 files changed, 43 insertions(+), 26 deletions(-)drivers/common/mlx5/mlx5_common.h +0
-2@@ -208,8 +208,6 @@ __rte_internalint mlx5_get_ifname_sysfs (const char *ibdev_path,char *ifname); -#define MLX5_CLASS_ARG_NAME "class" -enum mlx5_class {MLX5_CLASS_INVALID ,MLX5_CLASS_NET =RTE_BIT64 (0 ),drivers/common/mlx5/mlx5_common_pci.c +1
-1@@ -118,7 +118,7 @@ bus_cmdline_options_handler(__rte_unused const char *key, static int parse_class_options(const struct rte_devargs *devargs) { -const char *key =MLX5_CLASS_ARG_NAME ; +const char *key =RTE_DEVARGS_KEY_CLASS ;struct rte_kvargs *kvlist;int ret =0 ;drivers/common/sfc_efx/sfc_efx.c +3
-4@@ -42,7 +42,6 @@ enum sfc_efx_dev_class sfc_efx_dev_class_get(struct rte_devargs *devargs) {struct rte_kvargs *kvargs; -const char *key =SFC_EFX_KVARG_DEV_CLASS ;enum sfc_efx_dev_class dev_class =SFC_EFX_DEV_CLASS_NET ;if (devargs ==NULL )@@ -52,9 +51,9 @@ sfc_efx_dev_class_get(struct rte_devargs *devargs)if (kvargs ==NULL )return dev_class; -if (rte_kvargs_count (kvargs, key) !=0 ) { -rte_kvargs_process (kvargs, key, sfc_efx_kvarg_dev_class_handler, - &dev_class); +if (rte_kvargs_count (kvargs,RTE_DEVARGS_KEY_CLASS ) !=0 ) { +rte_kvargs_process (kvargs,RTE_DEVARGS_KEY_CLASS , + sfc_efx_kvarg_dev_class_handler, &dev_class); }rte_kvargs_free (kvargs);drivers/common/sfc_efx/sfc_efx.h +0
-2@@ -19,8 +19,6 @@extern "C" {#endif -#define SFC_EFX_KVARG_DEV_CLASS "class" -enum sfc_efx_dev_class {SFC_EFX_DEV_CLASS_INVALID =0 ,SFC_EFX_DEV_CLASS_NET ,drivers/net/bonding/rte_eth_bond_args.c +1
-1@@ -18,7 +18,7 @@ const char *pmd_bond_init_valid_arguments[] = {PMD_BOND_SOCKET_ID_KVARG ,PMD_BOND_MAC_ADDR_KVARG ,PMD_BOND_AGG_MODE_KVARG , -"driver" , +RTE_DEVARGS_KEY_DRIVER , NULL };drivers/net/i40e/i40e_ethdev_vf.c +2
-3@@ -1660,7 +1660,6 @@ static int i40evf_driver_selected(struct rte_devargs *devargs) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ;if (devargs ==NULL )@@ -1670,13 +1669,13 @@ i40evf_driver_selected(struct rte_devargs *devargs)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , i40evf_check_driver_handler,NULL ) <0 ) goto exit;drivers/net/iavf/iavf_ethdev.c +2
-3@@ -2448,7 +2448,6 @@ static int iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id) {struct rte_kvargs *kvlist; -const char *key ="driver" ;int ret =0 ; if (device_id != IAVF_DEV_ID_VF &&@@ -2464,13 +2463,13 @@ iavf_drv_i40evf_selected(struct rte_devargs *devargs, uint16_t device_id)if (kvlist ==NULL )return 0 ; -if (!rte_kvargs_count (kvlist, key)) +if (!rte_kvargs_count (kvlist,RTE_DEVARGS_KEY_DRIVER )) goto exit;/* i40evf driver selected when there's a key-value pair: * driver=i40evf */ -if (rte_kvargs_process (kvlist, key, +if (rte_kvargs_process (kvlist,RTE_DEVARGS_KEY_DRIVER , iavf_drv_i40evf_check_handler,NULL ) <0 ) goto exit;drivers/net/mlx5/mlx5.c +2
-2@@ -1931,7 +1931,7 @@ mlx5_args_check(const char *key, const char *val, void *opaque) config->max_dump_files_num = tmp; }else if (strcmp (MLX5_LRO_TIMEOUT_USEC , key) ==0 ) { config->lro.timeout = tmp; - }else if (strcmp (MLX5_CLASS_ARG_NAME , key) ==0 ) { + }else if (strcmp (RTE_DEVARGS_KEY_CLASS , key) ==0 ) {DRV_LOG (DEBUG ,"class argument is %s." , val); }else if (strcmp (MLX5_HP_BUF_SIZE , key) ==0 ) { config->log_hp_size = tmp;@@ -2002,7 +2002,7 @@ mlx5_args(struct mlx5_dev_config *config, struct rte_devargs *devargs)MLX5_REPRESENTOR ,MLX5_MAX_DUMP_FILES_NUM ,MLX5_LRO_TIMEOUT_USEC , -MLX5_CLASS_ARG_NAME , +RTE_DEVARGS_KEY_CLASS ,MLX5_HP_BUF_SIZE ,MLX5_RECLAIM_MEM , MLX5_SYS_MEM_EN,drivers/net/sfc/sfc_kvargs.c +1
-1@@ -28,7 +28,7 @@ sfc_kvargs_parse(struct sfc_adapter *sa)SFC_KVARG_TX_DATAPATH ,SFC_KVARG_FW_VARIANT ,SFC_KVARG_RXD_WAIT_TIMEOUT_NS , -SFC_EFX_KVARG_DEV_CLASS , +RTE_DEVARGS_KEY_CLASS , NULL, };drivers/vdpa/mlx5/mlx5_vdpa.c +1
-1@@ -588,7 +588,7 @@ mlx5_vdpa_args_check_handler(const char *key, const char *val, void *opaque)unsigned long tmp;int n_cores =sysconf (_SC_NPROCESSORS_ONLN); -if (strcmp (key,"class" ) ==0 ) +if (strcmp (key,RTE_DEVARGS_KEY_CLASS ) ==0 )return 0 ; errno =0 ; tmp =strtoul (val,NULL ,0 );lib/eal/common/eal_common_devargs.c +4
-4@@ -49,9 +49,9 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,const char *str;struct rte_kvargs *kvlist; } layers[] = { - { "bus=", NULL, NULL, }, - { "class=", NULL, NULL, }, - { "driver=", NULL, NULL, }, + { RTE_DEVARGS_KEY_BUS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_CLASS "=", NULL, NULL, }, + { RTE_DEVARGS_KEY_DRIVER "=", NULL, NULL, }, }; struct rte_kvargs_pair *kv = NULL; struct rte_class *cls = NULL;@@ -118,7 +118,7 @@ rte_devargs_layers_parse(struct rte_devargs *devargs,if (layers[i].kvlist ==NULL )continue ; kv = &layers[i].kvlist->pairs[0 ]; -if (strcmp (kv->key,"bus" ) ==0 ) { +if (strcmp (kv->key,RTE_DEVARGS_KEY_BUS ) ==0 ) { bus =rte_bus_find_by_name (kv->value);if (bus ==NULL ) { RTE_LOG(ERR, EAL, "Could not find bus \"%s\"\n", @@ -126,7 +126,7 @@rte_devargs_layers_parse(struct
rte_devargs*devargs,lib/eal/common/eal_common_devargs.c +1
-1ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"class" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_CLASS ) ==0 ) { cls =rte_class_find_by_name (kv->value);if (cls ==NULL ) { RTE_LOG(ERR, EAL, "Could not find class \"%s\"\n", @@ -134,7 +134,7 @@rte_devargs_layers_parse(struct
rte_devargs*devargs,lib/eal/common/eal_common_devargs.c +1
-1ret = -EFAULT ; goto get_out; } - }else if (strcmp (kv->key,"driver" ) ==0 ) { + }else if (strcmp (kv->key,RTE_DEVARGS_KEY_DRIVER ) ==0 ) {/* Ignore */ continue ; }lib/eal/include/rte_devargs.h +24
-1@@ -25,6 +25,30 @@ extern "C" {#include <rte_compat.h> #include <rte_bus.h> +/** +* Bus type key in global devargs syntax. +* +* Legacy devargs parser doesn't use this key as bus type +* is resolved as first optional value separated by ":". +*/ +#define RTE_DEVARGS_KEY_BUS "bus" + +/** +* Class type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse class type. PMD driver is +* encouraged to use this key to resolve class type. +*/ +#define RTE_DEVARGS_KEY_CLASS "class" + +/** +* Driver type key in global devargs syntax. +* +* Legacy devargs parser doesn't parse driver type. PMD driver is +* encouraged to use this key to resolve driver type. +*/ +#define RTE_DEVARGS_KEY_DRIVER "driver" +/** * Type of generic device */ --2.25.1
PATCH v8 2/2 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary 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/<name>
Devargs legacy syntax of auxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...]
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 91 +++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 193 ++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 930 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
MAINTAINERS +5 -0
@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver - EXPERIMENTAL +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
doc/guides/rel_notes/release_21_08.rst +6 -0
@@ -55,6 +55,12 @@ 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. + Removed Items -------------
drivers/bus/auxiliary/auxiliary_common.c new file +411 -0
411 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +59 -0
59 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +141 -0
141 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +16 -0
@@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2021 NVIDIA Corporation & Affiliates + +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']
drivers/bus/auxiliary/private.h new file +91 -0
91 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +193 -0
193 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +7 -0
@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -0
@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Signature · 1 line
2.25.1
Quoted 12 lines · Xueming Li
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/<name>Devargs legacy syntax of auxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...]
Quoted 8 lines
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>Acked-by Andrew Rybchenko <[email protected]>
I still don't understand if we really need to make the API a part of stable API/ABI in the future. Can it be internal?
Hi Andrew,
Quoted 24 lines
-----Original Message-----
From: Andrew Rybchenko <[email protected]>
Sent: Monday, July 5, 2021 5:19 PM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Kinsella Ray <[email protected]>; Parav Pandit <[email protected]>; Neil Horman <[email protected]>
Subject: Re: [PATCH v8 2/2] bus/auxiliary: introduce auxiliary busQuoted 15 lines · Xueming Li
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/<name>Devargs legacy syntax of auxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...][1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
Quoted 7 lines
Quoted 5 lines
Signed-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>Acked-by Andrew Rybchenko <[email protected]>I still don't understand if we really need to make the API a part of stable API/ABI in the future. Can it be internal?
There was some discussion on this with Thomas in earlier version. Users might want to register/unregister their own PMD driver, Is this a valid scenario?
Quoted 32 lines · Xueming(Steven) Li
Hi Andrew,
Quoted 30 lines
-----Original Message-----
From: Andrew Rybchenko <[email protected]>
Sent: Monday, July 5, 2021 5:19 PM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Kinsella Ray <[email protected]>; Parav Pandit <[email protected]>; Neil Horman <[email protected]>
Subject: Re: [PATCH v8 2/2] bus/auxiliary: introduce auxiliary busQuoted 20 lines · Xueming Li
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/<name>Devargs legacy syntax of auxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...][1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>Acked-by Andrew Rybchenko <[email protected]>
Quoted 5 lines
Quoted 1 line
I still don't understand if we really need to make the API a part of stable API/ABI in the future. Can it be internal?
There was some discussion on this with Thomas in earlier version. Users might want to register/unregister their own PMD driver, Is this a valid scenario?
Yes, it is true, but should DPDK care that much about out-of-tree drivers. I'm just asking since don't know techboard position on it.
05/07/2021 11:35, Andrew Rybchenko:
Quoted 11 lines · Xueming(Steven) Li
Quoted 6 lines
From: Andrew Rybchenko <[email protected]>
Quoted 1 line
I still don't understand if we really need to make the API a part of stable API/ABI in the future. Can it be internal?
There was some discussion on this with Thomas in earlier version. Users might want to register/unregister their own PMD driver, Is this a valid scenario?
Yes, it is true, but should DPDK care that much about out-of-tree drivers. I'm just asking since don't know techboard position on it.
I think there is a consensus to allow out-of-tree drivers without any compatibility commitment.
Some other bus drivers are exporting some API like in this patch. We could discuss again in techboard what to make internal. If it is decided to hide buses API, we could change all bus drivers later in DPDK 21.11.
Quoted 13 lines · Thomas Monjalon
05/07/2021 11:35, Andrew Rybchenko:
Quoted 11 lines · Xueming(Steven) Li
Quoted 6 lines
From: Andrew Rybchenko <[email protected]>
Quoted 1 line
I still don't understand if we really need to make the API a part of stable API/ABI in the future. Can it be internal?
There was some discussion on this with Thomas in earlier version. Users might want to register/unregister their own PMD driver, Is this a valid scenario?
Yes, it is true, but should DPDK care that much about out-of-tree drivers. I'm just asking since don't know techboard position on it.
Quoted 7 lines
I think there is a consensus to allow out-of-tree drivers without any compatibility commitment.
Some other bus drivers are exporting some API like in this patch. We could discuss again in techboard what to make internal. If it is decided to hide buses API, we could change all bus drivers later in DPDK 21.11.
OK, thanks.
05/07/2021 08:45, Xueming Li:
Quoted 12 lines
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/<name>Devargs legacy syntax of auxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>/class=<class>/driver=<driver>[,args...]
Quoted 8 lines
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>Acked-by Andrew Rybchenko <[email protected]>
Applied, thanks
PATCH v6 2/2 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary 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/<name>
Devargs legacy syntax ofauxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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
MAINTAINERS +5 -0
@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
doc/guides/rel_notes/release_21_08.rst +6 -0
@@ -55,6 +55,12 @@ 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. + Removed Items -------------
drivers/bus/auxiliary/auxiliary_common.c new file +411 -0
411 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +59 -0
59 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +141 -0
141 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +16 -0
@@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2021 NVIDIA Corporation & Affiliates + +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']
drivers/bus/auxiliary/private.h new file +74 -0
74 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +201 -0
201 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +7 -0
@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -0
@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Signature · 1 line
2.25.1
Quoted 8 lines · Xueming Li
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/<name>Devargs legacy syntax ofauxiliary device:
Missing space after 'of'
Quoted 3 lines
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,
Are two commas above intentionall? What for?
Quoted 5 lines
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>
With my below notes fixed:
Quoted 28 lines
Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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.mapMAINTAINERS +0
-0
MAINTAINERS F: doc/guides/mempool/octeontx2.rst · line 528
Quoted 4 lines
MAINTAINERS +1
-0@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver
Shouldn't it be EXPERIMENTAL?
Quoted 60 lines
MAINTAINERS +4
-0+M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/doc/guides/rel_notes/release_21_08.rst +6
-0@@ -55,6 +55,12 @@ 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. + Removed Items -------------drivers/bus/auxiliary/auxiliary_common.c new file +30
-0@@ -0,0 +1,411 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#include <string.h> +#include <inttypes.h> +#include <stdint.h> +#include <stdbool.h> +#include <stdlib.h> +#include <stdio.h> +#include <sys/queue.h> +#include <rte_errno.h> +#include <rte_interrupts.h> +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_per_lcore.h> +#include <rte_memory.h> +#include <rte_eal.h> +#include <rte_eal_paging.h> +#include <rte_string_fns.h> +#include <rte_common.h> +#include <rte_devargs.h> + +#include "private.h" +#include "rte_bus_auxiliary.h" + +static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) +{ +struct rte_devargs *devargs;
drivers/bus/auxiliary/auxiliary_common.c line 40
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+ + RTE_EAL_DEVARGS_FOREACH(RTE_BUS_AUXILIARY_NAME, devargs) { +if (strcmp (devargs->name, name) ==0 ) +return devargs; + } +return NULL ; +} + +/* +* Test whether the auxiliary device exist
Missing full stop above.
Quoted 46 lines
drivers/bus/auxiliary/auxiliary_common.c new file +46
-0+* +* Stub for OS not supporting auxiliary bus. +*/ +__rte_weak bool +auxiliary_dev_exists (const char *name) +{ +RTE_SET_USED (name); +return false; +} + +/* +* Scan the devices in the auxiliary bus. +* +* Stub for OS not supporting auxiliary bus. +*/ +__rte_weak int +auxiliary_scan (void ) +{ +return 0 ; +} + +/* +* Update a device's devargs 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); +} + +/*
drivers/bus/auxiliary/auxiliary_common.c line 96
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+* Call the probe() function of the driver. +*/ +static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *drv, +struct rte_auxiliary_device *dev) +{ +enum rte_iova_mode iova_mode; +int ret; + +if ((drv ==NULL ) || (dev ==NULL ))
Unnecessary internal parenthesis.
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+return -EINVAL ; + +/* Check if driver supports it. */ +if (!auxiliary_match (drv, dev)) +/* Match of device and driver failed */ +return 1 ;
drivers/bus/auxiliary/auxiliary_common.c line 112
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+ +/* 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" ); +return -1 ; + } + +if (dev->device.numa_node <0 ) { +AUXILIARY_LOG (INFO ,"Device is not NUMA-aware, defaulting socket to 0" );
socket -> NUMA node
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+ dev->device.numa_node =0 ; + } + + iova_mode =rte_eal_iova_mode ();
drivers/bus/auxiliary/auxiliary_common.c line 126
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+if ((drv->drv_flags &RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA ) >0 && + iova_mode !=RTE_IOVA_VA ) { +AUXILIARY_LOG (ERR ,"Driver %s expecting VA IOVA mode but current mode is PA, not initializing" , + drv->driver.name); +return -EINVAL ; + } + + dev->driver = drv; + + AUXILIARY_LOG(INFO, "Probe auxiliary driver: %s device: %s (socket %i)",
socket -> NUMA node
Quoted 15 lines
drivers/bus/auxiliary/auxiliary_common.c new file +15
-0+ drv->driver.name, dev->name, dev->device.numa_node); + ret = drv->probe (drv, dev); +if (ret !=0 ) + dev->driver =NULL ; +else + dev->device.driver = &drv->driver; + +return ret; +} + +/* +* Call the remove() function of the driver. +*/ +static int +rte_auxiliary_driver_remove_dev (struct rte_auxiliary_device *dev)
drivers/bus/auxiliary/auxiliary_common.c line 151
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+{ +struct rte_auxiliary_driver *drv; +int ret =0 ; + +if (dev ==NULL ) +return -EINVAL ; + + drv = dev->driver; + + AUXILIARY_LOG(DEBUG, "Driver %s remove auxiliary device %s on NUMA socket %i",
socket -> node
Quoted 400 lines
drivers/bus/auxiliary/auxiliary_common.c new file +260
-0+ drv->driver.name, dev->name, dev->device.numa_node); + +if (drv->remove !=NULL ) { + ret = drv->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 *drv; +int rc; + +if (dev ==NULL ) +return -EINVAL ; + +FOREACH_DRIVER_ON_AUXILIARY_BUS (drv) { +if (!drv->match (dev->name)) +continue ; + + rc =rte_auxiliary_probe_one_driver (drv, 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 to try to probe 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_AUXILIARY_BUS (dev) { + probed++; + + ret =auxiliary_probe_all_drivers (dev); +if (ret <0 ) { +if (ret != -EEXIST ) { +AUXILIARY_LOG (ERR ,"Requested device %s cannot be used" , + 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 *drv =NULL ; +const char **out = addr; + +/* Allow empty device name "auxiliary:" to bypass entire bus scan. */ +if (strlen (name) ==0 ) +return 0 ; + +FOREACH_DRIVER_ON_AUXILIARY_BUS (drv) { +if (drv->match (name)) +break ; + } +if (drv !=NULL && addr !=NULL ) + *out = name; +return drv !=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 ==NULL ) { + rte_errno =EINVAL ; +return -1 ; + } +if (aux_dev->driver->dma_map ==NULL ) { + rte_errno =ENOTSUP ; +return -1 ; + } +return aux_dev->driver->dma_map (aux_dev, addr, iova, len); +} + +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 ==NULL ) { + rte_errno =EINVAL ; +return -1 ; + } +if (aux_dev->driver->dma_unmap ==NULL ) { + rte_errno =ENOTSUP ; +return -1 ; + } +return aux_dev->driver->dma_unmap (aux_dev, addr, iova, len); +} + +bool +auxiliary_is_ignored_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_AUXILIARY_BUS (drv) { +if ((drv->drv_flags &RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA ) >0 ) +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 );drivers/bus/auxiliary/auxiliary_params.c new file +59
-0@@ -0,0 +1,59 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#include <string.h> + +#include <rte_bus.h> +#include <rte_dev.h> +#include <rte_errno.h> +#include <rte_kvargs.h> + +#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 ) { +AUXILIARY_LOG (ERR ,"cannot parse argument list %s" , + str); + 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; +}drivers/bus/auxiliary/linux/auxiliary.c new file +69
-0@@ -0,0 +1,141 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#include <string.h> +#include <dirent.h> + +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_malloc.h> +#include <rte_devargs.h> +#include <rte_memcpy.h> +#include <eal_filesystem.h> + +#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); + }
drivers/bus/auxiliary/linux/auxiliary.c line 79
Quoted 10 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +10
-0+free (dev); + } +return 0 ; + } +auxiliary_add_device (dev); +return 0 ; +} + +/* +* Test whether the auxiliary device exist
Missing full stop above.
Quoted 8 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +8
-0+*/ +bool +auxiliary_dev_exists (const char *name) +{ +DIR *dir; +char dirname[PATH_MAX ]; + + snprintf(dirname, sizeof(dirname), "%s/%s",
drivers/bus/auxiliary/linux/auxiliary.c line 97
Quoted 10 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +10
-0+ AUXILIARY_SYSFS_PATH, name); + dir =opendir (dirname); +if (dir ==NULL ) +return false; +closedir (dir); +return true; +} + +/* +* Scan the devices in the auxiliary bus
Missing full stop above.
Quoted 72 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +44
-0+*/ +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?" , +AUXILIARY_SYSFS_PATH ); +return 0 ; + } + +while ((e =readdir (dir)) !=NULL ) { +if (e->d_name[0 ] =='.' ) +continue ; + +if (auxiliary_is_ignored_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_AUXILIARY_BUS (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 ; +}drivers/bus/auxiliary/meson.build new file +16
-0@@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2021 NVIDIA Corporation & Affiliates + +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']drivers/bus/auxiliary/private.h new file +0
-0
drivers/bus/auxiliary/private.h line 5
Quoted 5 lines
drivers/bus/auxiliary/private.h new file +5
-0@@ -0,0 +1,74 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#ifndef AUXILIARY_PRIVATE_H
May be add BUS_ prefix at leaat?
Quoted 48 lines
drivers/bus/auxiliary/private.h new file +48
-0+#define AUXILIARY_PRIVATE_H + +#include <stdbool.h> +#include <stdio.h> + +#include "rte_bus_auxiliary.h" + +extern struct rte_auxiliary_bus auxiliary_bus; +extern int auxiliary_bus_logtype; + +#define AUXILIARY_LOG (level, ...) \ + rte_log(RTE_LOG_ ## level, auxiliary_bus_logtype, \ + RTE_FMT("auxiliary bus: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \ + RTE_FMT_TAIL(__VA_ARGS__,))) + +/* Auxiliary bus iterators */ +#define FOREACH_DEVICE_ON_AUXILIARY_BUS (p) \ + TAILQ_FOREACH(p, &(auxiliary_bus.device_list), next) + +#define FOREACH_DRIVER_ON_AUXILIARY_BUS (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. +*/ +int auxiliary_scan (void ); + +/* +* Update a device being scanned. +*/ +void auxiliary_on_scan (struct rte_auxiliary_device *aux_dev); + +/* +* Validate whether a device with given auxiliary device should be ignored +* or not. +*/ +bool auxiliary_is_ignored_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. +*/ +void auxiliary_add_device (struct rte_auxiliary_device *aux_dev); +
drivers/bus/auxiliary/private.h line 63
Quoted 10 lines
drivers/bus/auxiliary/private.h new file +10
-0+/* +* 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. +*/ +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
Missing full stop.
drivers/bus/auxiliary/private.h line 69
Quoted 6 lines
drivers/bus/auxiliary/private.h new file +6
-0+*/ +bool auxiliary_match (const struct rte_auxiliary_driver *aux_drv, +const struct rte_auxiliary_device *aux_dev); + +/* +* Iterate over devices, matching any device against the provided string
Missing full stop.
Quoted 127 lines
drivers/bus/auxiliary/private.h new file +5
-0+*/ +void *auxiliary_dev_iterate (const void *start,const char *str, +const struct rte_dev_iterator *it); + +#endif /* AUXILIARY_PRIVATE_H */ drivers/bus/auxiliary/rte_bus_auxiliary.h new file +116
-0@@ -0,0 +1,201 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#ifndef RTE_BUS_AUXILIARY_H +#define RTE_BUS_AUXILIARY_H + +/** + * @file + * + * Auxiliary Bus Interface. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +#define RTE_BUS_AUXILIARY_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. */
drivers/bus/auxiliary/rte_bus_auxiliary.h line 126
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+struct rte_device device;/**< Inherit core device */ +char name[RTE_DEV_NAME_MAX_LEN +1 ];/**< ASCII device name */ +struct rte_intr_handle intr_handle;/**< Interrupt handle */ +struct rte_auxiliary_driver *driver;/**< Device driver */ +}; + +/** 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);
Shouldn't we hide rte_auxiliary_device inside the library take API/ABI stability into account? Or will be it DPDK internal anyway? If so, it should be done INTERNAL from the very
beginning.
drivers/bus/auxiliary/rte_bus_auxiliary.h line 135
Quoted 9 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +9
-0+ +/** +* 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 */ +};
It looks internal. The following forward declaration should be sufficient to build.
struct rte_auxiliary_bus;
Quoted 23 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +23
-0+ +/** +* 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) +
drivers/bus/auxiliary/rte_bus_auxiliary.h line 168
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+#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 + +/**
Don't we need EXPERIMENTAL notice here?
Quoted 9 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +9
-0+* 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); +
drivers/bus/auxiliary/rte_bus_auxiliary.h line 187
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+/** 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__) + +/**
Don't we need EXPERIMENTAL notice here?
Quoted 40 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +14
-0+* 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 */ drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};drivers/bus/meson.build +1
-0@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Hi Andrew,
Thanks very much all the good suggestions, v7 posted.
Best Regards,
Xueming
Quoted 1,103 lines
-----Original Message-----
From: Andrew Rybchenko <[email protected]>
Sent: Monday, July 5, 2021 12:13 AM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Kinsella Ray <[email protected]>; Neil Horman <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v6 2/2] bus/auxiliary: introduce auxiliary busQuoted 8 lines · Xueming Li
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/<name>Devargs legacy syntax ofauxiliary device:
Missing space after 'of'
Quoted 3 lines
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,Are two commas above intentionall? What for?
Quoted 5 lines
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>With my below notes fixed:
Acked-by Andrew Rybchenko <[email protected]>Quoted 28 lines
Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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.mapMAINTAINERS index 5877a16971..eaf691ca6a renamed from MAINTAINERS +0
-0100644
MAINTAINERS F: doc/guides/mempool/octeontx2.rst Bus Drivers · line 527
Quoted 3 lines
MAINTAINERS +1
-0@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driverShouldn't it be EXPERIMENTAL?
Quoted 60 lines
MAINTAINERS +4
-0+M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/doc/guides/rel_notes/release_21_08.rst +6
-0@@ -55,6 +55,12 @@ 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. + Removed Items -------------drivers/bus/auxiliary/auxiliary_common.c new file +28
-0@@ -0,0 +1,411 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates */ + +#include <string.h> +#include <inttypes.h> +#include <stdint.h> +#include <stdbool.h> +#include <stdlib.h> +#include <stdio.h> +#include <sys/queue.h> +#include <rte_errno.h> +#include <rte_interrupts.h> +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_per_lcore.h> +#include <rte_memory.h> +#include <rte_eal.h> +#include <rte_eal_paging.h> +#include <rte_string_fns.h> +#include <rte_common.h> +#include <rte_devargs.h> + +#include "private.h" +#include "rte_bus_auxiliary.h" + +static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) { +struct rte_devargs *devargs;drivers/bus/auxiliary/auxiliary_common.c line 38
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+ + RTE_EAL_DEVARGS_FOREACH(RTE_BUS_AUXILIARY_NAME, devargs) { +if (strcmp (devargs->name, name) ==0 ) +return devargs; + } +return NULL ; +} + +/* +* Test whether the auxiliary device exist Missing full stop above.
Quoted 42 lines
drivers/bus/auxiliary/auxiliary_common.c new file +42
-0+* +* Stub for OS not supporting auxiliary bus. +*/ +__rte_weak bool +auxiliary_dev_exists (const char *name) { +RTE_SET_USED (name); +return false; +} + +/* +* Scan the devices in the auxiliary bus. +* +* Stub for OS not supporting auxiliary bus. +*/ +__rte_weak int +auxiliary_scan (void ) +{ +return 0 ; +} + +/* +* Update a device's devargs 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); } + +/* drivers/bus/auxiliary/auxiliary_common.c line 96
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+* Call the probe() function of the driver. +*/ +static int +rte_auxiliary_probe_one_driver (struct rte_auxiliary_driver *drv, +struct rte_auxiliary_device *dev) +{ +enum rte_iova_mode iova_mode; +int ret; + +if ((drv ==NULL ) || (dev ==NULL ))Unnecessary internal parenthesis.
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+return -EINVAL ; + +/* Check if driver supports it. */ +if (!auxiliary_match (drv, dev)) +/* Match of device and driver failed */ +return 1 ;drivers/bus/auxiliary/auxiliary_common.c line 112
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+ +/* 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" ); +return -1 ; + } + +if (dev->device.numa_node <0 ) { +AUXILIARY_LOG (INFO ,"Device is not NUMA-aware, defaulting socket to 0" );socket -> NUMA node
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+ dev->device.numa_node =0 ; + } + + iova_mode =rte_eal_iova_mode ();drivers/bus/auxiliary/auxiliary_common.c line 126
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+if ((drv->drv_flags &RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA ) >0 && + iova_mode !=RTE_IOVA_VA ) { +AUXILIARY_LOG (ERR ,"Driver %s expecting VA IOVA mode but current mode is PA, not initializing" , + drv->driver.name); +return -EINVAL ; + } + + dev->driver = drv; + + AUXILIARY_LOG(INFO, "Probe auxiliary driver: %s device: %s (socket %i)",socket -> NUMA node
Quoted 15 lines
drivers/bus/auxiliary/auxiliary_common.c new file +15
-0+ drv->driver.name, dev->name, dev->device.numa_node); + ret = drv->probe (drv, dev); +if (ret !=0 ) + dev->driver =NULL ; +else + dev->device.driver = &drv->driver; + +return ret; +} + +/* +* Call the remove() function of the driver. +*/ +static int +rte_auxiliary_driver_remove_dev (struct rte_auxiliary_device *dev)drivers/bus/auxiliary/auxiliary_common.c line 151
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+{ +struct rte_auxiliary_driver *drv; +int ret =0 ; + +if (dev ==NULL ) +return -EINVAL ; + + drv = dev->driver; + + AUXILIARY_LOG(DEBUG, "Driver %s remove auxiliary device %s on NUMA socket %i",socket -> node
Quoted 400 lines
drivers/bus/auxiliary/auxiliary_common.c new file +260
-0+ drv->driver.name, dev->name, dev->device.numa_node); + +if (drv->remove !=NULL ) { + ret = drv->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 *drv; +int rc; + +if (dev ==NULL ) +return -EINVAL ; + +FOREACH_DRIVER_ON_AUXILIARY_BUS (drv) { +if (!drv->match (dev->name)) +continue ; + + rc =rte_auxiliary_probe_one_driver (drv, 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 to try to probe 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_AUXILIARY_BUS (dev) { + probed++; + + ret =auxiliary_probe_all_drivers (dev); +if (ret <0 ) { +if (ret != -EEXIST ) { +AUXILIARY_LOG (ERR ,"Requested device %s cannot be used" , + 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 *drv =NULL ; +const char **out = addr; + +/* Allow empty device name "auxiliary:" to bypass entire bus scan. */ +if (strlen (name) ==0 ) +return 0 ; + +FOREACH_DRIVER_ON_AUXILIARY_BUS (drv) { +if (drv->match (name)) +break ; + } +if (drv !=NULL && addr !=NULL ) + *out = name; +return drv !=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 ==NULL ) { + rte_errno =EINVAL ; +return -1 ; + } +if (aux_dev->driver->dma_map ==NULL ) { + rte_errno =ENOTSUP ; +return -1 ; + } +return aux_dev->driver->dma_map (aux_dev, addr, iova, len); +} + +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 ==NULL ) { + rte_errno =EINVAL ; +return -1 ; + } +if (aux_dev->driver->dma_unmap ==NULL ) { + rte_errno =ENOTSUP ; +return -1 ; + } +return aux_dev->driver->dma_unmap (aux_dev, addr, iova, len); +} + +bool +auxiliary_is_ignored_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_AUXILIARY_BUS (drv) { +if ((drv->drv_flags &RTE_AUXILIARY_DRV_NEED_IOVA_AS_VA ) >0 ) +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 );drivers/bus/auxiliary/auxiliary_params.c new file +59
-0@@ -0,0 +1,59 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#include <string.h> + +#include <rte_bus.h> +#include <rte_dev.h> +#include <rte_errno.h> +#include <rte_kvargs.h> + +#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 ) { +AUXILIARY_LOG (ERR ,"cannot parse argument list %s" , + str); + 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; +}drivers/bus/auxiliary/linux/auxiliary.c new file +69
-0@@ -0,0 +1,141 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#include <string.h> +#include <dirent.h> + +#include <rte_log.h> +#include <rte_bus.h> +#include <rte_malloc.h> +#include <rte_devargs.h> +#include <rte_memcpy.h> +#include <eal_filesystem.h> + +#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); + }drivers/bus/auxiliary/linux/auxiliary.c line 79
Quoted 10 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +10
-0+free (dev); + } +return 0 ; + } +auxiliary_add_device (dev); +return 0 ; +} + +/* +* Test whether the auxiliary device exist Missing full stop above.
Quoted 8 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +8
-0+*/ +bool +auxiliary_dev_exists (const char *name) +{ +DIR *dir; +char dirname[PATH_MAX ]; + + snprintf(dirname, sizeof(dirname), "%s/%s",drivers/bus/auxiliary/linux/auxiliary.c line 97
Quoted 10 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +10
-0+ AUXILIARY_SYSFS_PATH, name); + dir =opendir (dirname); +if (dir ==NULL ) +return false; +closedir (dir); +return true; +} + +/* +* Scan the devices in the auxiliary bus Missing full stop above.
Quoted 72 lines
drivers/bus/auxiliary/linux/auxiliary.c new file +44
-0+*/ +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?" , +AUXILIARY_SYSFS_PATH ); +return 0 ; + } + +while ((e =readdir (dir)) !=NULL ) { +if (e->d_name[0 ] =='.' ) +continue ; + +if (auxiliary_is_ignored_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_AUXILIARY_BUS (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 ; +}drivers/bus/auxiliary/meson.build new file +16
-0@@ -0,0 +1,16 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2021 NVIDIA Corporation & Affiliates + +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']drivers/bus/auxiliary/private.h new file +0
-0drivers/bus/auxiliary/private.h line 5
Quoted 5 lines
drivers/bus/auxiliary/private.h new file +5
-0@@ -0,0 +1,74 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#ifndef AUXILIARY_PRIVATE_H May be add
BUS_prefix at leaat?Quoted 48 lines
drivers/bus/auxiliary/private.h new file +48
-0+#define AUXILIARY_PRIVATE_H + +#include <stdbool.h> +#include <stdio.h> + +#include "rte_bus_auxiliary.h" + +extern struct rte_auxiliary_bus auxiliary_bus; +extern int auxiliary_bus_logtype; + +#define AUXILIARY_LOG (level, ...) \ + rte_log(RTE_LOG_ ## level, auxiliary_bus_logtype, \ + RTE_FMT("auxiliary bus: " RTE_FMT_HEAD(__VA_ARGS__,) "\n", \ + RTE_FMT_TAIL(__VA_ARGS__,))) + +/* Auxiliary bus iterators */ +#define FOREACH_DEVICE_ON_AUXILIARY_BUS (p) \ + TAILQ_FOREACH(p, &(auxiliary_bus.device_list), next) + +#define FOREACH_DRIVER_ON_AUXILIARY_BUS (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. +*/ +int auxiliary_scan (void ); + +/* +* Update a device being scanned. +*/ +void auxiliary_on_scan (struct rte_auxiliary_device *aux_dev); + +/* +* Validate whether a device with given auxiliary device should be ignored +* or not. +*/ +bool auxiliary_is_ignored_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. +*/ +void auxiliary_add_device (struct rte_auxiliary_device *aux_dev); +drivers/bus/auxiliary/private.h line 63
Quoted 10 lines
drivers/bus/auxiliary/private.h new file +10
-0+/* +* 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. +*/ +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 Missing full stop.
drivers/bus/auxiliary/private.h line 69
Quoted 6 lines
drivers/bus/auxiliary/private.h new file +6
-0+*/ +bool auxiliary_match (const struct rte_auxiliary_driver *aux_drv, +const struct rte_auxiliary_device *aux_dev); + +/* +* Iterate over devices, matching any device against the provided string Missing full stop.
Quoted 127 lines
drivers/bus/auxiliary/private.h new file +5
-0+*/ +void *auxiliary_dev_iterate (const void *start,const char *str, +const struct rte_dev_iterator *it); + +#endif /* AUXILIARY_PRIVATE_H */ drivers/bus/auxiliary/rte_bus_auxiliary.h new file +116
-0@@ -0,0 +1,201 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright (c) 2021 NVIDIA Corporation & Affiliates +*/ + +#ifndef RTE_BUS_AUXILIARY_H +#define RTE_BUS_AUXILIARY_H + +/** + * @file + * + * Auxiliary Bus Interface. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdio.h> +#include <stdlib.h> +#include <limits.h> +#include <errno.h> +#include <sys/queue.h> +#include <stdint.h> +#include <inttypes.h> + +#include <rte_debug.h> +#include <rte_interrupts.h> +#include <rte_dev.h> +#include <rte_bus.h> +#include <rte_kvargs.h> + +#define RTE_BUS_AUXILIARY_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. */drivers/bus/auxiliary/rte_bus_auxiliary.h line 126
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+struct rte_device device;/**< Inherit core device */ +char name[RTE_DEV_NAME_MAX_LEN +1 ];/**< ASCII device name */ +struct rte_intr_handle intr_handle;/**< Interrupt handle */ +struct rte_auxiliary_driver *driver;/**< Device driver */ +}; + +/** 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);Shouldn't we hide
rte_auxiliary_deviceinside the library take API/ABI stability into account? Or will be it DPDK internal anyway? If so, it should be done INTERNAL from the very
beginning.drivers/bus/auxiliary/rte_bus_auxiliary.h line 135
Quoted 9 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +9
-0+ +/** +* 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 */ +};It looks internal. The following forward declaration should be sufficient to build.
struct
rte_auxiliary_bus;Quoted 23 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +23
-0+ +/** +* 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) +drivers/bus/auxiliary/rte_bus_auxiliary.h line 168
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+#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 + +/** Don't we need EXPERIMENTAL notice here?
Quoted 9 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +9
-0+* 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); +drivers/bus/auxiliary/rte_bus_auxiliary.h line 187
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+/** 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__) + +/** Don't we need EXPERIMENTAL notice here?
Quoted 40 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +14
-0+* 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 */ drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};drivers/bus/meson.build +1
-0@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Quoted 39 lines · Xueming Li
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/<name>Devargs legacy syntax ofauxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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
[SNIP]
drivers/bus/auxiliary/version.map line 7
Quoted 13 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};
Aren't these really internal?
Quoted 13 lines
drivers/bus/meson.build +1
-0@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Quoted 55 lines
-----Original Message-----
From: Kinsella, Ray <[email protected]>
Sent: Wednesday, August 4, 2021 5:50 PM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Neil Horman <[email protected]>
Subject: Re: [PATCH v6 2/2] bus/auxiliary: introduce auxiliary busQuoted 39 lines · Xueming Li
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/<name>Devargs legacy syntax ofauxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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[SNIP]
Quoted 16 lines
Quoted 7 lines
drivers/bus/auxiliary/version.map new file +0
-0drivers/bus/auxiliary/version.map line 7
Quoted 7 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};Aren't these really internal?
Hi Kinsella,
Application might implement driver, so keep it public, same as rte_pci_register.
Quoted 14 lines
Quoted 14 lines
drivers/bus/meson.build index renamed from drivers/bus/meson.build +0
-0
410058de3a..45eab5233d100644drivers/bus/meson.build +1
-0@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Quoted 30 lines · Xueming Li
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/<name>Devargs legacy syntax ofauxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 +
Quoted 9 lines
10 files changed, 921 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
A message that is not in the archive (sent off-list or not yet received): DM4PR12MB5373DBD9E73E5E0E8505C129A1F19@DM4PR12MB5373.namprd12.prod.outlook.com
A message that is not in the archive (sent off-list or not yet received): [email protected]
A message that is not in the archive (sent off-list or not yet received): DM4PR12MB53736410D2C07101F872363EA1F19@DM4PR12MB5373.namprd12.prod.outlook.com
Quoted 77 lines · Xueming(Steven) Li
Quoted 77 lines
-----Original Message-----
From: Kinsella, Ray <[email protected]>
Sent: Wednesday, August 4, 2021 7:46 PM
To: Xueming(Steven) Li <[email protected]>
Subject: Re: [PATCH v6 2/2] bus/auxiliary: introduce auxiliary busQuoted 55 lines · Xueming(Steven) Li
Quoted 55 lines
-----Original Message-----
From: Kinsella, Ray <[email protected]>
Sent: Wednesday, August 4, 2021 6:00 PM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Neil Horman <[email protected]>
Subject: Re: [PATCH v6 2/2] bus/auxiliary: introduce auxiliary busQuoted 40 lines · Xueming Li
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/<name>Devargs legacy syntax ofauxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c | ++++++++++++++++++++++ 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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.mapQuoted 3 lines
Quoted 1 line
Acked-by Ray Kinsella <[email protected]>Thanks, but this patch already integrated :)
It appears in the order in which I am going through my email is incorrect. :-)
Quoted 4 lines
Would you like to have a look at another deprecation notice? Andrew reviewed RFC:
https://mails.dpdk.org/archives/dev/2021-August/216007.html
Quoted 8 lines
Quoted 4 lines
Its not strictly a depreciation notice though, you are not breaking anything right. Since you are not breaking anything, don't think the notice is required in the 21.11 timeframe.
Now if you where doing it in 21.08, it would be an ABI change and that would be a different story.
Thanks for looking at this!
Yes, it targets to 21.11. The offloading flag is fine, but theshared_groupdoes break ABI, detail:https://mails.dpdk.org/archives/dev/2021-July/215575.html
Right ... its a new field, not a depreciation as such. What I mean by this is that no existing code is broken.
21.11 is a new ABI in any case and you are not depreciating anything, so no notice is required.
Quoted 97 lines
-----Original Message-----
From: Kinsella, Ray <[email protected]>
Sent: Wednesday, August 4, 2021 8:14 PM
To: Xueming(Steven) Li <[email protected]>; dpdk-dev <[email protected]>
Subject: Re: [PATCH v6 2/2] bus/auxiliary: introduce auxiliary busQuoted 86 lines · Xueming(Steven) Li
Quoted 85 lines
-----Original Message-----
From: Kinsella, Ray <[email protected]>
Sent: Wednesday, August 4, 2021 7:46 PM
To: Xueming(Steven) Li <[email protected]>
Subject: Re: [PATCH v6 2/2] bus/auxiliary: introduce auxiliary busQuoted 58 lines · Xueming(Steven) Li
Quoted 58 lines
-----Original Message-----
From: Kinsella, Ray <[email protected]>
Sent: Wednesday, August 4, 2021 6:00 PM
To: Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; NBU-Contact-Thomas Monjalon <[email protected]>; Neil Horman <[email protected]>
Subject: Re: [PATCH v6 2/2] bus/auxiliary: introduce auxiliary busQuoted 43 lines · Xueming Li
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/<name>Devargs legacy syntax ofauxiliary device:
-a auxiliary:<name>[,args...]
Devargs generic syntax of auxiliary device:
-a
bus=auxiliary,name=<name>,,/class=<classs>,,/driver=<driver>,,[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.ht
mlSigned-off-by Xueming Li <[email protected]>Cc Wang Haiyue <[email protected]>Cc Thomas Monjalon <[email protected]>Cc Kinsella Ray <[email protected]>--- MAINTAINERS | 5 + doc/guides/rel_notes/release_21_08.rst | 6 + drivers/bus/auxiliary/auxiliary_common.c | 411 ++++++++++++++++++++++ drivers/bus/auxiliary/auxiliary_params.c ++++++++++++++++++++++ | ++++++++++++++++++++++ 59 ++++ drivers/bus/auxiliary/linux/auxiliary.c | 141 ++++++++ drivers/bus/auxiliary/meson.build | 16 + drivers/bus/auxiliary/private.h | 74 ++++ drivers/bus/auxiliary/rte_bus_auxiliary.h | 201 +++++++++++ drivers/bus/auxiliary/version.map | 7 + drivers/bus/meson.build | 1 + 10 files changed, 921 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.mapQuoted 3 lines
Quoted 1 line
Acked-by Ray Kinsella <[email protected]>Thanks, but this patch already integrated :)
It appears in the order in which I am going through my email is incorrect. :-)
Quoted 4 lines
Would you like to have a look at another deprecation notice? Andrew reviewed RFC:
https://mails.dpdk.org/archives/dev/2021-August/216007.htmlIts not strictly a depreciation notice though, you are not breaking anything right. Since you are not breaking anything, don't think the notice is required in the 21.11 timeframe.
Now if you where doing it in 21.08, it would be an ABI change and that would be a different story.
Quoted 8 lines
Quoted 3 lines
Thanks for looking at this!
Yes, it targets to 21.11. The offloading flag is fine, but theshared_groupdoes break ABI, detail:https://mails.dpdk.org/archives/dev/2021-July/215575.htmlRight ... its a new field, not a depreciation as such. What I mean by this is that no existing code is broken.
21.11 is a new ABI in any case and you are not depreciating anything, so no notice is required.
Maybe it a new process, confirmed with Thomas, it's expected:
https://doc.dpdk.org/guides/contributing/abi_policy.html#abi-changes
04/08/2021 15:00, Xueming(Steven) Li:
Quoted 12 lines
From: Kinsella, Ray <[email protected]>
Quoted 11 lines · Xueming(Steven) Li
Quoted 9 lines
From: Kinsella, Ray <[email protected]>
Quoted 4 lines
Its not strictly a depreciation notice though, you are not breaking anything right. Since you are not breaking anything, don't think the notice is required in the 21.11 timeframe.
Now if you where doing it in 21.08, it would be an ABI change and that would be a different story.
Thanks for looking at this!
Yes, it targets to 21.11. The offloading flag is fine, but theshared_groupdoes break ABI, detail:https://mails.dpdk.org/archives/dev/2021-July/215575.html
Quoted 7 lines
Quoted 4 lines
Right ... its a new field, not a depreciation as such. What I mean by this is that no existing code is broken.
21.11 is a new ABI in any case and you are not depreciating anything, so no notice is required.
Maybe it a new process, confirmed with Thomas, it's expected:
https://doc.dpdk.org/guides/contributing/abi_policy.html#abi-changes
I think what Ray means is that it breaks ABI but not API,
so he doesn't consider a notice is required.
My understanding of the policy is that *any* ABI change requires a notice. But if you want to make it lighter and allow any non-announced ABI change in an ABI-breaking release, I think I would vote for.
Quoted 21 lines · Thomas Monjalon
04/08/2021 15:00, Xueming(Steven) Li:
Quoted 12 lines
From: Kinsella, Ray <[email protected]>
Quoted 11 lines · Xueming(Steven) Li
Quoted 9 lines
From: Kinsella, Ray <[email protected]>
Quoted 4 lines
Its not strictly a depreciation notice though, you are not breaking anything right. Since you are not breaking anything, don't think the notice is required in the 21.11 timeframe.
Now if you where doing it in 21.08, it would be an ABI change and that would be a different story.
Thanks for looking at this!
Yes, it targets to 21.11. The offloading flag is fine, but theshared_groupdoes break ABI, detail:https://mails.dpdk.org/archives/dev/2021-July/215575.htmlQuoted 7 lines
Quoted 4 lines
Right ... its a new field, not a depreciation as such. What I mean by this is that no existing code is broken.
21.11 is a new ABI in any case and you are not depreciating anything, so no notice is required.
Maybe it a new process, confirmed with Thomas, it's expected:
https://doc.dpdk.org/guides/contributing/abi_policy.html#abi-changes
Quoted 6 lines
I think what Ray means is that it breaks ABI but not API, so he doesn't consider a notice is required.
My understanding of the policy is that *any* ABI change requires a notice. But if you want to make it lighter and allow any non-announced ABI change in an ABI-breaking release, I think I would vote for.
Thanks for clarifying Thomas ... you are correct.
Quoted 3 lines
04/08/2021 15:53, Kinsella, Ray:
Quoted 22 lines · Thomas Monjalon
Quoted 21 lines
04/08/2021 15:00, Xueming(Steven) Li:
Quoted 19 lines
From: Kinsella, Ray <[email protected]>
Quoted 7 lines · Xueming(Steven) Li
Quoted 6 lines
From: Kinsella, Ray <[email protected]>
Quoted 4 lines
Its not strictly a depreciation notice though, you are not breaking anything right. Since you are not breaking anything, don't think the notice is required in the 21.11 timeframe.
Now if you where doing it in 21.08, it would be an ABI change and that would be a different story.
Quoted 8 lines
Quoted 3 lines
Thanks for looking at this!
Yes, it targets to 21.11. The offloading flag is fine, but theshared_groupdoes break ABI, detail:https://mails.dpdk.org/archives/dev/2021-July/215575.htmlRight ... its a new field, not a depreciation as such. What I mean by this is that no existing code is broken.
21.11 is a new ABI in any case and you are not depreciating anything, so no notice is required.
Maybe it a new process, confirmed with Thomas, it's expected:
https://doc.dpdk.org/guides/contributing/abi_policy.html#abi-changes
Quoted 8 lines
Quoted 6 lines
I think what Ray means is that it breaks ABI but not API, so he doesn't consider a notice is required.
My understanding of the policy is that *any* ABI change requires a notice. But if you want to make it lighter and allow any non-announced ABI change in an ABI-breaking release, I think I would vote for.
Thanks for clarifying Thomas ... you are correct.
In the meantime, let's review and ack notices, even if ABI-only change:
https://patches.dpdk.org/bundle/tmonjalo/deprecation-notices/
We'll discuss later if we can accept more ABI change,
but we should try to be on the safe side for those already announced.
PATCH v4 2/2 bus/auxiliary: introduce auxiliary bus
In reply to Xueming LiAuxiliary 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/<name>
Devargs syntax of auxiliary device:
-a auxiliary:<name>[,args...]
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.html
--- 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
MAINTAINERS +5 -0
@@ -525,6 +525,11 @@ F: doc/guides/mempool/octeontx2.rst Bus Drivers ----------- +Auxiliary bus driver +M: Parav Pandit <[email protected]> +M: Xueming Li <[email protected]> +F: drivers/bus/auxiliary/ + Intel FPGA bus M: Rosen Xu <[email protected]> F: drivers/bus/ifpga/
doc/guides/rel_notes/release_21_08.rst +7 -0
@@ -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:<name>[,args...] + Removed Items -------------
drivers/bus/auxiliary/auxiliary_common.c new file +419 -0
419 lines not on this page · raw message
drivers/bus/auxiliary/auxiliary_params.c new file +58 -0
58 lines not on this page · raw message
drivers/bus/auxiliary/linux/auxiliary.c new file +142 -0
142 lines not on this page · raw message
drivers/bus/auxiliary/meson.build new file +11 -0
@@ -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'] +
drivers/bus/auxiliary/private.h new file +112 -0
112 lines not on this page · raw message
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +201 -0
201 lines not on this page · raw message
drivers/bus/auxiliary/version.map new file +7 -0
@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};
drivers/bus/meson.build +1 -0
@@ -2,6 +2,7 @@ # Copyright(c) 2017 Intel Corporation drivers = [ + 'auxiliary', 'dpaa', 'fslmc', 'ifpga',
Signature · 1 line
2.25.1
13/06/2021 14:58, Xueming Li:
Quoted 9 lines
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/<name>Devargs syntax of auxiliary device:
-a auxiliary:<name>[,args...]
What about suggesting the new generic syntax?
Quoted 4 lines
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>
[...]
doc/guides/rel_notes/release_21_08.rst New Features · line 63
Quoted 12 lines
doc/guides/rel_notes/release_21_08.rst +6
-0@@ -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:<name>[,args...]
I am not sure the release notes are the right place to provide a guide of the syntax, and this syntax is not the new generice one with "bus=" that we want to promote.
I would just remove this last line from the release notes.
drivers/bus/auxiliary/auxiliary_common.c line 2
Quoted 5 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0@@ -0,0 +1,419 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd
I think we should use the NVIDIA copyright now.
drivers/bus/auxiliary/auxiliary_common.c line 32
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) +{ +struct rte_devargs *devargs; + + RTE_EAL_DEVARGS_FOREACH(RTE_BUS_AXILIARY_NAME, devargs) {
Missing an "U" in RTE_BUS_AXILIARY_NAME
[...]
drivers/bus/auxiliary/auxiliary_common.c line 53
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_common.c new file +3
-0+/* +* Scan the content of the auxiliary bus, and the devices in the devices +* list
Simpler: Scan the devices in the auxiliary bus.
[...]
drivers/bus/auxiliary/auxiliary_common.c line 13
Quoted 2 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0+/** +* Update a device being scanned.
Not clear what is updated.
It seems to be just the devargs part?
drivers/bus/auxiliary/auxiliary_common.c line 68
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+* +* @param aux_dev +* AUXILIARY device. +*/
Should not be a doxygen comment.
Quoted 5 lines
drivers/bus/auxiliary/auxiliary_common.c new file +5
-0+void +auxiliary_on_scan (struct rte_auxiliary_device *aux_dev) +{ + aux_dev->device.devargs =auxiliary_devargs_lookup (aux_dev->name); +}
[...]
drivers/bus/auxiliary/auxiliary_common.c line 100
Quoted 11 lines
drivers/bus/auxiliary/auxiliary_common.c new file +11
-0+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. */
I don't understand why the comment about "not blocked" here. The policy check is below.
drivers/bus/auxiliary/auxiliary_common.c line 111
Quoted 11 lines
drivers/bus/auxiliary/auxiliary_common.c new file +11
-0+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" );
Please no indent inside logs.
And no \n as it is already in the macro.
Quoted 2 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0+return -1 ; + }
[...]
drivers/bus/auxiliary/auxiliary_common.c line 148
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+static int +rte_auxiliary_driver_remove_dev (struct rte_auxiliary_device *dev) +{ +struct rte_auxiliary_driver *dr;
Not sure this variable is needed.
If you keep it, please "drv" is better.
Quoted 18 lines
drivers/bus/auxiliary/auxiliary_common.c new file +18
-0+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; + }
[...]
Quoted 5 lines
+/*
+ * Scan the content of the auxiliary bus, and call theprobe()function for
+ *
+ * all registered drivers that have a matching entry in itsid_table
+ * for discovered devices.
Please elaborate what is the id_table.
[...]
drivers/bus/auxiliary/auxiliary_common.c line 343
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+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) {
For all pointers, please compare with NULL, they are not booleans.
drivers/bus/auxiliary/auxiliary_common.c line 350
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c new file +7
-0+ 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 ;
I would prever the reverse logic: error first
and callback return at last.
[...]
Some code is not reviewed here to not make this mail too long. [...]
drivers/bus/auxiliary/meson.build line 6
Quoted 9 lines
drivers/bus/auxiliary/meson.build new file +6
-0@@ -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')
I think it should with a comma and the parenthesis on next line. Please check style of other meson files which were re-styled recently.
drivers/bus/auxiliary/meson.build line 11
Quoted 5 lines
drivers/bus/auxiliary/meson.build new file +5
-0+if is_linux + sources += files('linux/auxiliary.c') +endif +deps += ['kvargs'] +
Empty line at EOF
drivers/bus/auxiliary/private.h line 9
Quoted 12 lines
drivers/bus/auxiliary/private.h new file +9
-0@@ -0,0 +1,112 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd +*/ + +#ifndef _AUXILIARY_PRIVATE_H_ +#define _AUXILIARY_PRIVATE_H_ + +#include <stdbool.h> +#include <stdio.h>
An empty line is missing here.
drivers/bus/auxiliary/private.h line 17
Quoted 8 lines
drivers/bus/auxiliary/private.h new file +8
-0+#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)
I suggest this better (pedantic-compliant) format:
#define AUXILIARY_LOG(level, ...) \
rte_log(RTE_LOG_ ## level, auxiliary_bus_logtype, RTE_FMT("auxiliary bus: " \
RTE_FMT_HEAD(__VA_ARGS__,) "\n", RTE_FMT_TAIL(__VA_ARGS__,)))I think the __func__ should not be needed if log is well written.
drivers/bus/auxiliary/private.h line 24
Quoted 7 lines
drivers/bus/auxiliary/private.h new file +7
-0+ +/* 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)
An underscore is missing between AUXILIARY and BUS.
drivers/bus/auxiliary/private.h line 34
Quoted 10 lines
drivers/bus/auxiliary/private.h new file +10
-0+ +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 +*/
You can make the comments shorter as it is private (no doxygen).
Quoted 1 line
drivers/bus/auxiliary/private.h new file +1
-0+int auxiliary_scan (void );
[...]
Quoted 1 line
+ * @return void
Especially this comment is useless :)
[...]
Quoted 2 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +0
-0
[...]
Quoted 1 line
+typedef
bool(rte_auxiliary_match_t)(const char *name);
I think checkpatch will complain about the space between parens.
[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 118
Quoted 4 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +4
-0+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 */
core device should be before the name.
drivers/bus/auxiliary/rte_bus_auxiliary.h line 120
Quoted 2 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +2
-0+struct rte_intr_handle intr_handle;/**< Interrupt handle */ +struct rte_auxiliary_driver *driver;/**< driver used in probing */
Why in probing?
I suggest "Device driver"
Quoted 19 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +19
-0+}; + +/** 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. +*/
drivers/bus/auxiliary/rte_bus_auxiliary.h line 149
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+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_*. */
Wrong search/replace missing capital letters.
[...]
drivers/bus/auxiliary/version.map line 7
Quoted 10 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};
After more thoughts, shouldn't it be an internal symbol? It is used only by DPDK drivers.
Quoted 15 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, June 22, 2021 12:11 AM
To: Parav Pandit <[email protected]>; Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; Kinsella Ray <[email protected]>; [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH v4 2/2] bus/auxiliary: introduce auxiliary bus13/06/2021 14:58, Xueming Li:
Quoted 4 lines
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.
Quoted 7 lines
Quoted 5 lines
Auxiliary device is identified by unique device name, sysfs path:
/sys/bus/auxiliary/devices/<name>Devargs syntax of auxiliary device:
-a auxiliary:<name>[,args...]What about suggesting the new generic syntax?
I'll list both.
Quoted 23 lines
Quoted 5 lines
[1] kernel auxiliary bus document:
https://www.kernel.org/doc/html/latest/driver-api/auxiliary_bus.htmlSigned-off-by Xueming Li <[email protected]>[...]
doc/guides/rel_notes/release_21_08.rst New Features · line 63
Quoted 12 lines
doc/guides/rel_notes/release_21_08.rst +6
-0@@ -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:<name>[,args...]I am not sure the release notes are the right place to provide a guide of the syntax, and this syntax is not the new generice one with "bus=" that we want to promote.
I would just remove this last line from the release notes
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c line 2
Quoted 5 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0@@ -0,0 +1,419 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd I think we should use the NVIDIA copyright now.
Good catch!
Quoted 97 lines
drivers/bus/auxiliary/auxiliary_common.c line 32
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +5
-0+static struct rte_devargs * +auxiliary_devargs_lookup (const char *name) { +struct rte_devargs *devargs; + + RTE_EAL_DEVARGS_FOREACH(RTE_BUS_AXILIARY_NAME, devargs) {Missing an "U" in
RTE_BUS_AXILIARY_NAME[...]
drivers/bus/auxiliary/auxiliary_common.c line 53
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+/* +* Scan the content of the auxiliary bus, and the devices in the +devices +* list Simpler: Scan the devices in the auxiliary bus.
[...]
drivers/bus/auxiliary/auxiliary_common.c line 13
Quoted 2 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0+/** +* Update a device being scanned. Not clear what is updated.
It seems to be just the devargs part?drivers/bus/auxiliary/auxiliary_common.c line 68
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+* +* @param aux_dev +* AUXILIARY device. +*/ Should not be a doxygen comment.
Quoted 4 lines
drivers/bus/auxiliary/auxiliary_common.c new file +4
-0+void +auxiliary_on_scan (struct rte_auxiliary_device *aux_dev) { + aux_dev->device.devargs =auxiliary_devargs_lookup (aux_dev->name); +}[...]
drivers/bus/auxiliary/auxiliary_common.c line 100
Quoted 10 lines
drivers/bus/auxiliary/auxiliary_common.c new file +10
-0+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. */ I don't understand why the comment about "not blocked" here. The policy check is below.
drivers/bus/auxiliary/auxiliary_common.c line 111
Quoted 11 lines
drivers/bus/auxiliary/auxiliary_common.c new file +11
-0+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" );Please no indent inside logs.
And no \n as it is already in the macro.Quoted 2 lines
drivers/bus/auxiliary/auxiliary_common.c new file +2
-0+return -1 ; + }[...]
drivers/bus/auxiliary/auxiliary_common.c line 148
Quoted 3 lines
drivers/bus/auxiliary/auxiliary_common.c new file +3
-0+static int +rte_auxiliary_driver_remove_dev (struct rte_auxiliary_device *dev) { +struct rte_auxiliary_driver *dr;Not sure this variable is needed.
If you keep it, please "drv" is better.Quoted 18 lines
drivers/bus/auxiliary/auxiliary_common.c new file +18
-0+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; + }[...]
Quoted 8 lines
drivers/bus/auxiliary/auxiliary_common.c line 209
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+/* +* 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. Please elaborate what is the
id_table.
Hmm, legacy code form pci bus, remove it.
Quoted 68 lines
[...]
drivers/bus/auxiliary/auxiliary_common.c line 343
Quoted 6 lines
drivers/bus/auxiliary/auxiliary_common.c new file +6
-0+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) {For all pointers, please compare with NULL, they are not booleans.
drivers/bus/auxiliary/auxiliary_common.c line 350
Quoted 7 lines
drivers/bus/auxiliary/auxiliary_common.c new file +7
-0+ 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 ;I would prever the reverse logic: error first and callback return at last.
[...]
Some code is not reviewed here to not make this mail too long. [...]drivers/bus/auxiliary/meson.build line 6
Quoted 9 lines
drivers/bus/auxiliary/meson.build new file +6
-0@@ -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')I think it should with a comma and the parenthesis on next line. Please check style of other meson files which were re-styled recently.
drivers/bus/auxiliary/meson.build line 11
Quoted 3 lines
drivers/bus/auxiliary/meson.build new file +3
-0+if is_linux + sources += files('linux/auxiliary.c') endif deps += ['kvargs'] +Empty line at EOF
drivers/bus/auxiliary/private.h line 8
Quoted 11 lines
drivers/bus/auxiliary/private.h new file +8
-0@@ -0,0 +1,112 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright 2021 Mellanox Technologies, Ltd */ + +#ifndef _AUXILIARY_PRIVATE_H_ +#define _AUXILIARY_PRIVATE_H_ + +#include <stdbool.h> +#include <stdio.h> An empty line is missing here.
drivers/bus/auxiliary/private.h line 17
Quoted 8 lines
drivers/bus/auxiliary/private.h new file +8
-0+#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)I suggest this better (pedantic-compliant) format:
Quoted 5 lines
#define AUXILIARY_LOG(level, ...) \ rte_log(RTE_LOG_ ## level, auxiliary_bus_logtype, RTE_FMT("auxiliary bus: " \ RTE_FMT_HEAD(__VA_ARGS__,) "\n", RTE_FMT_TAIL(__VA_ARGS__,)))I think the
__func__should not be needed if log is well written.
Thanks!
Quoted 48 lines
drivers/bus/auxiliary/private.h line 24
Quoted 8 lines
drivers/bus/auxiliary/private.h new file +7
-0+ +/* 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)An underscore is missing between AUXILIARY and BUS.
drivers/bus/auxiliary/private.h line 34
Quoted 11 lines
drivers/bus/auxiliary/private.h new file +11
-0+ +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 +*/ You can make the comments shorter as it is private (no doxygen).
Quoted 1 line
drivers/bus/auxiliary/private.h new file +1
-0+int auxiliary_scan (void );[...]
Quoted 1 line
+ * @return void
Especially this comment is useless :)
[...]
Quoted 2 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +0
-0[...]
Quoted 1 line
+typedef
bool(rte_auxiliary_match_t)(const char *name);I think checkpatch will complain about the space between parens.
[...]
drivers/bus/auxiliary/rte_bus_auxiliary.h line 118
Quoted 4 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +4
-0+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 */ core device should be before the name.
Quoted 5 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h line 120
Quoted 2 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +2
-0+struct rte_intr_handle intr_handle;/**< Interrupt handle */ +struct rte_auxiliary_driver *driver;/**< driver used in probing */ Why in probing?
I suggest "Device driver"
A SF device could be probed by a class driver t then another class driver, the driver field will be overridden by later probe. Will change to "last device driver"
Quoted 33 lines
Quoted 19 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +18
-0+}; + +/** 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. +*/ drivers/bus/auxiliary/rte_bus_auxiliary.h line 149
Quoted 10 lines
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +10
-0+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_*. */ Wrong search/replace missing capital letters.
[...]
Quoted 14 lines
drivers/bus/auxiliary/version.map line 7
Quoted 10 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};After more thoughts, shouldn't it be an internal symbol? It is used only by DPDK drivers.
So users will not be able to compose their own driver and register with auxiliary bus?z
Agree with all other great comments, thanks!
23/06/2021 01:50, Xueming(Steven) Li:
Quoted 16 lines
From: Thomas Monjalon <[email protected]>
Quoted 14 lines
13/06/2021 14:58, Xueming Li:
drivers/bus/auxiliary/version.map line 7
Quoted 10 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};After more thoughts, shouldn't it be an internal symbol? It is used only by DPDK drivers.
Quoted 1 line
So users will not be able to compose their own driver and register with auxiliary bus?z
Yes, that's an interesting question actually.
We can continue with experimental/stable status of driver ABI, but we should invent a new ABI flag like DRIVER,
so there is no stability policy on such symbol.
Quoted 27 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Wednesday, June 23, 2021 4:15 PM
To: Xueming(Steven) Li <[email protected]>
Cc: Parav Pandit <[email protected]>; [email protected]; Wang Haiyue <[email protected]>; Kinsella Ray <[email protected]>; [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH v4 2/2] bus/auxiliary: introduce auxiliary bus23/06/2021 01:50, Xueming(Steven) Li:
Quoted 16 lines
From: Thomas Monjalon <[email protected]>
Quoted 14 lines
13/06/2021 14:58, Xueming Li:
drivers/bus/auxiliary/version.map line 7
Quoted 10 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};After more thoughts, shouldn't it be an internal symbol? It is used only by DPDK drivers.
Quoted 6 lines
Quoted 2 lines
So users will not be able to compose their own driver and register with auxiliary bus?z
Yes, that's an interesting question actually.
We can continue with experimental/stable status of driver ABI, but we should invent a new ABI flag like DRIVER, so there is no stability policy on such symbol.
Not quite understand here, why we want to export the function but no ABI guarantee? the api shouldn't change frequently IMHO.
23/06/2021 16:52, Xueming(Steven) Li:
Quoted 18 lines
From: Thomas Monjalon <[email protected]>
Quoted 17 lines
23/06/2021 01:50, Xueming(Steven) Li:
Quoted 16 lines
From: Thomas Monjalon <[email protected]>
Quoted 14 lines
13/06/2021 14:58, Xueming Li:
drivers/bus/auxiliary/version.map line 7
Quoted 10 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};After more thoughts, shouldn't it be an internal symbol? It is used only by DPDK drivers.
Quoted 8 lines
Quoted 6 lines
Quoted 2 lines
So users will not be able to compose their own driver and register with auxiliary bus?z
Yes, that's an interesting question actually.
We can continue with experimental/stable status of driver ABI, but we should invent a new ABI flag like DRIVER, so there is no stability policy on such symbol.Not quite understand here, why we want to export the function but no ABI guarantee? the api shouldn't change frequently IMHO.
Sorry my message was not clear.
I am OK to keep "EXPERIMENTAL" in this patch.
But in future, we don't want to make driver interface as part of the stable ABI because it makes evolution harder for no good reason:
nobody is asking for a stable interface with drivers.
Thanks for clarification, will update in next version.
________________________________
From: Thomas Monjalon <[email protected]>
Sent: Thursday, June 24, 2021 2:37:19 PM
To: Xueming(Steven) Li <[email protected]>
Cc: Parav Pandit <[email protected]>; [email protected] <[email protected]>; Wang Haiyue <[email protected]>; Kinsella Ray <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v4 2/2] bus/auxiliary: introduce auxiliary bus
23/06/2021 16:52, Xueming(Steven) Li:
Quoted 18 lines
From: Thomas Monjalon <[email protected]>
Quoted 17 lines
23/06/2021 01:50, Xueming(Steven) Li:
Quoted 16 lines
From: Thomas Monjalon <[email protected]>
Quoted 14 lines
13/06/2021 14:58, Xueming Li:
drivers/bus/auxiliary/version.map line 7
Quoted 10 lines
drivers/bus/auxiliary/version.map new file +7
-0@@ -0,0 +1,7 @@ +EXPERIMENTAL { + global: + + # added in 21.08 + rte_auxiliary_register; + rte_auxiliary_unregister; +};After more thoughts, shouldn't it be an internal symbol? It is used only by DPDK drivers.
Quoted 8 lines
Quoted 6 lines
Quoted 2 lines
So users will not be able to compose their own driver and register with auxiliary bus?z
Yes, that's an interesting question actually.
We can continue with experimental/stable status of driver ABI, but we should invent a new ABI flag like DRIVER, so there is no stability policy on such symbol.Not quite understand here, why we want to export the function but no ABI guarantee? the api shouldn't change frequently IMHO.
Sorry my message was not clear.
I am OK to keep "EXPERIMENTAL" in this patch.
But in future, we don't want to make driver interface as part of the stable ABI because it makes evolution harder for no good reason:
nobody is asking for a stable interface with drivers.
23/06/2021 01:50, Xueming(Steven) Li:
Quoted 9 lines
From: Thomas Monjalon <[email protected]>
Quoted 5 lines
13/06/2021 14:58, Xueming Li:
drivers/bus/auxiliary/rte_bus_auxiliary.h line 120
Quoted 1 line
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +1
-0+struct rte_auxiliary_driver *driver;/**< driver used in probing */ Why in probing?
I suggest "Device driver"A SF device could be probed by a class driver t then another class driver, the driver field will be overridden by later probe. Will change to "last device driver"
"Last" is a bit confusing.
Any field can be potentially overwritten, i.e. change its value, and we don't comment "last value" ;)
Quoted 18 lines
-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Wednesday, June 23, 2021 4:22 PM
To: Parav Pandit <[email protected]>; Xueming(Steven) Li <[email protected]>
Cc: [email protected]; Wang Haiyue <[email protected]>; Kinsella Ray <[email protected]>; [email protected]; [email protected]
Subject: Re: [dpdk-dev] [PATCH v4 2/2] bus/auxiliary: introduce auxiliary bus23/06/2021 01:50, Xueming(Steven) Li:
Quoted 7 lines
From: Thomas Monjalon <[email protected]>
Quoted 5 lines
13/06/2021 14:58, Xueming Li:
drivers/bus/auxiliary/rte_bus_auxiliary.h line 120
Quoted 1 line
drivers/bus/auxiliary/rte_bus_auxiliary.h new file +1
-0+struct rte_auxiliary_driver *driver;/**< driver used in probing */ Why in probing?
I suggest "Device driver"
Quoted 5 lines
Quoted 2 lines
A SF device could be probed by a class driver t then another class driver, the driver field will be overridden by later probe. Will change to "last device driver"
"Last" is a bit confusing.
Any field can be potentially overwritten, i.e. change its value, and we don't comment "last value" ;)
OK, will reflect in v6.
Review
Quoted 2 lines · On Thu, 11 Mar 2021 21:01:13 +0800 Xueming Li <[email protected]> wrote:
(quoted diff) +2
-0+ AUXILIAR_LOG(DEBUG, "Auxiliary device %s on NUMA socket %i\n", + dev->name, dev->device.numa_node);
Your log messages will be double spaced.
The macro is already adding a new line.
Quoted 4 lines
drivers/bus/auxiliary/private.h new file +4
-0+ +#define AUXILIAR_LOG(level, fmt, args...) \ + rte_log(RTE_LOG_ ## level, auxiliary_logtype_bus, "%s(): " fmt "\n", \ + __func__, ##args)
Quoted 10 lines
-----Original Message-----
From: Stephen Hemminger <[email protected]>
Sent: Friday, June 25, 2021 12:34 PM
To: Xueming(Steven) Li <[email protected]>
Cc: NBU-Contact-Thomas Monjalon <[email protected]>; [email protected]; Parav Pandit <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>
Subject: Re: [dpdk-dev] [RFC] bus/auxiliary: introduce auxiliary bus
Quoted 8 lines
Review
Quoted 2 lines · On Thu, 11 Mar 2021 21:01:13 +0800 Xueming Li <[email protected]> wrote:
(quoted diff) +2
-0+ AUXILIAR_LOG(DEBUG, "Auxiliary device %s on NUMA socket %i\n", + dev->name, dev->device.numa_node);Your log messages will be double spaced.
The macro is already adding a new line.
Thanks, update in next version.
Quoted 5 lines
Quoted 5 lines
drivers/bus/auxiliary/private.h new file +4
-0+ +#define AUXILIAR_LOG(level, fmt, args...) \ + rte_log(RTE_LOG_ ## level, auxiliary_logtype_bus, "%s(): " fmt "\n", \ + __func__, ##args)