ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc/idxd: update idxd docs regarding configs

Browse Source 
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>
This commit is contained in:
paul luse 2022-05-20 08:33:50 -07:00 committed by Tomasz Zawadzki
parent d780d23532
commit e65ab145ec
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/idxd.md
View File

@ -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.