Commit 86ef8f21 authored by Monica Kenguva's avatar Monica Kenguva Committed by Tomasz Zawadzki
Browse files

rpc: Document create and delete bdev uring 



Signed-off-by: default avatarMonica Kenguva <monica.kenguva@intel.com>
Change-Id: Id396872112e8fb89eadd8b72cc0f02c543153e7a
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7329


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent ec632be2

doc/jsonrpc.md

+76 −0
Original line number Diff line number Diff line
@@ -7593,6 +7593,82 @@ Example response: 
}

~~~



# Uring



## bdev_uring_create {#rpc_bdev_uring_create}



Create a bdev with io_uring backend.



### Parameters



Name                    | Optional | Type        | Description

----------------------- | -------- | ----------- | -----------

filename                | Required | string      | path to device or file (ex: /dev/nvme0n1)

name                    | Required | string      | name of bdev

block_size              | Optional | number      | block size of device (If omitted, get the block size from the file)



### Example



Example request:



~~~

{

  "jsonrpc": "2.0",

  "method": "bdev_uring_create",

  "id": 1,

  "params": {

    "name": "bdev_u0",

    "filename": "/dev/nvme0n1",

    "block_size": 512

  }

}

~~~



Example response:



~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": "bdev_u0"

}

~~~



## bdev_uring_delete {#rpc_bdev_uring_delete}



Remove a uring bdev.



### Parameters



Name                    | Optional | Type        | Description

----------------------- | -------- | ----------- | -----------

name                    | Required | string      | name of uring bdev to delete



### Example



Example request:



~~~

{

  "jsonrpc": "2.0",

  "method": "bdev_uring_delete",

  "id": 1,

  "params": {

    "name": "bdev_u0"

  }

}

~~~



Example response:



~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": true

}

~~~



# OPAL



## bdev_nvme_opal_init {#rpc_bdev_nvme_opal_init}