xref: /spdk/doc/idxd.md (revision cc6920a4763d4b9a43aa40583c8397d8f14fa100)
1# IDXD Driver {#idxd}
2
3## Public Interface {#idxd_interface}
4
5- spdk/idxd.h
6
7## Key Functions {#idxd_key_functions}
8
9Function                                | Description
10--------------------------------------- | -----------
11spdk_idxd_probe()                       | @copybrief spdk_idxd_probe()
12spdk_idxd_batch_get_max()               | @copybrief spdk_idxd_batch_get_max()
13spdk_idxd_batch_create()                | @copybrief spdk_idxd_batch_create()
14spdk_idxd_batch_prep_copy()             | @copybrief spdk_idxd_batch_prep_copy()
15spdk_idxd_batch_submit()                | @copybrief spdk_idxd_batch_submit()
16spdk_idxd_submit_copy()                 | @copybrief spdk_idxd_submit_copy()
17spdk_idxd_submit_compare()              | @copybrief spdk_idxd_submit_compare()
18spdk_idxd_submit_crc32c()               | @copybrief spdk_idxd_submit_crc32c()
19spdk_idxd_submit_dualcast               | @copybrief spdk_idxd_submit_dualcast()
20spdk_idxd_submit_fill()                 | @copybrief spdk_idxd_submit_fill()
21
22## Pre-defined configurations {#idxd_configs}
23
24The RPC `idxd_scan_accel_engine` is used to both enable IDXD and set it's
25configuration to one of two pre-defined configs:
26
27Config #0: 4 groups, 1 work queue per group, 1 engine per group.
28Config #1: 2 groups, 2 work queues per group, 2 engines per group.
29