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

doc: Add accel_fw section and RPCs to jsonrpc docs 



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


Community-CI: Mellanox Build Bot
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent 4ac5ca65

doc/jsonrpc.md

+68 −0
Original line number Diff line number Diff line
@@ -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}