Commit 7229b8e1 authored Oct 29, 2020 by Jacek Kalwas Committed by Tomasz Zawadzki Nov 02, 2020

env: update description for enumerate function



During enumeration all registered pci devices with exposed access to
userspace are getting probed internally unless not explicitly specified
on denylist. Because of that it becomes not possible to either use such
devices with another application or unbind the driver (e.g. vfio).

Change-Id: I9e84ed1d5dc82db75adcb18936cb6d702ee74d78
Signed-off-by: Jacek Kalwas <jacek.kalwas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4962


Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>

parent 4192b16a

include/spdk/env.h

+5 −0

Original line number	Diff line number	Diff line
		@@ -759,6 +759,11 @@ struct spdk_pci_driver *spdk_pci_nvme_get_driver(void);
		* device is attached or not. Attached devices have to be manually detached
		* with spdk_pci_device_detach() to be attach-able again.
		*
		* During enumeration all registered pci devices with exposed access to
		* userspace are getting probed internally unless not explicitly specified
		* on denylist. Because of that it becomes not possible to either use such
		* devices with another application or unbind the driver (e.g. vfio).
		*
		* \param driver Driver for a specific device type.
		* \param enum_cb Callback to be called for each non-attached PCI device.
		* The return code can be as follows: