summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpaul luse <paul.e.luse@intel.com>2022-05-20 08:33:50 -0700
committerTomasz Zawadzki <tomasz.zawadzki@intel.com>2022-05-23 19:51:23 +0000
commite65ab145ec80ddb64ec9e715ad2002c82085016d (patch)
tree36a4086197b3730cd3fdfe5ec2625bd13244dce2
parentd780d23532faaeadcdd63047a78fc3a0d6ed470f (diff)
doc/idxd: update idxd docs regarding configsv22.05-rc1
A while back config changes were made and the doc wasn't updated. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: Id6046a97dc623a9af00de115995c928fc9fbe240 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12759 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
-rw-r--r--doc/idxd.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/idxd.md b/doc/idxd.md
index 1f38a4eae..ea9951e58 100644
--- a/doc/idxd.md
+++ b/doc/idxd.md
@@ -15,11 +15,9 @@ spdk_idxd_submit_crc32c() | @copybrief spdk_idxd_submit_crc32c()
spdk_idxd_submit_dualcast | @copybrief spdk_idxd_submit_dualcast()
spdk_idxd_submit_fill() | @copybrief spdk_idxd_submit_fill()
-## Pre-defined configuration {#idxd_configs}
+## Kernel vs User {#idxd_configs}
-The low level library can be initialized either directly via `spdk_idxd_set_config` or
-through an RPC via one of the accelerator framework modules that rely on the low level
-IDXD library. Either way, the underlying hardware will be set to the pre-defined
-hardware configuration below:
-
-Config: 1 group, 1 work queue, 4 engines in the group.
+The low level library can be initialized either directly via `spdk_idxd_set_config`,
+passing in a value of `true` indicates that the IDXD kernel driver is loaded and
+that SPDK will use work queue(s) surfaced by the driver. Passing in `false` means
+that the SPDK user space driver will be used to initialize the hardware.