Commit e65ab145 authored by paul luse's avatar paul luse Committed by Tomasz Zawadzki
Browse files

doc/idxd: update idxd docs regarding configs 



A while back config changes were made and the doc wasn't updated.

Signed-off-by: default avatarpaul luse <paul.e.luse@intel.com>
Change-Id: Id6046a97dc623a9af00de115995c928fc9fbe240
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12759


Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent d780d235

doc/idxd.md

+5 −7
Original line number Diff line number Diff line
@@ -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.