From 346c43edd320425649a8a8a37fa0465d1006df47 Mon Sep 17 00:00:00 2001 From: paul luse Date: Fri, 11 Sep 2020 13:08:01 -0400 Subject: [PATCH] doc: Add accel_fw section and RPCs to jsonrpc docs Signed-off-by: paul luse Change-Id: I4f680c5fe72312224ce6722197a70a49886c9db1 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4187 Community-CI: Mellanox Build Bot Reviewed-by: Shuhei Matsumoto Reviewed-by: Jim Harris Tested-by: SPDK CI Jenkins --- doc/jsonrpc.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index fa5409024f..df7d9ce803 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -1268,6 +1268,74 @@ Example response: } ~~~ +# Acceleration Framework Layer {#jsonrpc_components_accel_fw} + +## idxd_scan_accel_engine {#rpc_idxd_scan_accel_engine} + +Set config and enable idxd accel engine offload. +This feature is considered as experimental. + +### Parameters + +Name | Optional | Type | Description +----------------------- | -------- | ----------- | ----------- +config_number | Required | number | Pre-defined config # to use (ie 0, 1). See [docs.](https://spdk.io/doc/idxd.html) + +### Example + +Example request: + +~~~ +{ + "params": { + "config_number": 0 + }, + "jsonrpc": "2.0", + "method": "idxd_scan_accel_engine", + "id": 1 +} +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + +## ioat_scan_accel_engine {#rpc_ioat_scan_accel_engine} + +Enable ioat accel engine offload. + +### Parameters + +None + +### Example + +Example request: + +~~~ +{ + "jsonrpc": "2.0", + "method": "ioat_scan_accel_engine", + "id": 1 +} +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + # Block Device Abstraction Layer {#jsonrpc_components_bdev} ## bdev_set_options {#rpc_bdev_set_options}