Spdk/doc/idxd.md
paul luse e65ab145ec doc/idxd: update idxd docs regarding configs
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>
2022-05-23 19:51:23 +00:00

24 lines
1.0 KiB
Markdown

# IDXD Driver {#idxd}
## Public Interface {#idxd_interface}
- spdk/idxd.h
## Key Functions {#idxd_key_functions}
Function | Description
--------------------------------------- | -----------
spdk_idxd_probe() | @copybrief spdk_idxd_probe()
spdk_idxd_submit_copy() | @copybrief spdk_idxd_submit_copy()
spdk_idxd_submit_compare() | @copybrief spdk_idxd_submit_compare()
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()
## Kernel vs User {#idxd_configs}
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.