From 5968bd6242b73b9ce7902292094313cde46e7173 Mon Sep 17 00:00:00 2001 From: paul luse Date: Mon, 17 Sep 2018 17:39:10 -0400 Subject: [PATCH] doc: add rpc example to bdev doc for crypto Initial patch left out example rpc commands to create/delete Change-Id: I2e705b041bf7f6524625f88625234327a38bfc45 Signed-off-by: paul luse Reviewed-on: https://review.gerrithub.io/425872 Tested-by: SPDK CI Jenkins Reviewed-by: Ben Walker Reviewed-by: Jim Harris Chandler-Test-Pool: SPDK Automated Test System --- doc/bdev.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/bdev.md b/doc/bdev.md index 8efd4d114..b1bab6014 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -105,16 +105,6 @@ time the SPDK virtual bdev module supports cipher only as follows: (Note: QAT is functional however is marked as experimental until the hardware has been fully integrated with the SPDK CI system.) -Support for other DPDK drivers and capabilities may be added programmatically. Existing -functionality is configured through a .conf file as shown here: - -[crypto]
- \# CRY \ \ \ \
- \# key size depends on cipher
- \# supported PMD names: crypto_aesni_mb, crypto_qat
- \# Note: QAT is experimental while test HW is being setup
- CRY Malloc4 crypto_ram 0123456789123456 crypto_aesni_mb - In order to support using the bdev block offset (LBA) as the initialization vector (IV), the crypto module break up all I/O into crypto operations of a size equal to the block size of the underlying bdev. For example, a 4K I/O to a bdev with a 512B block size, @@ -126,6 +116,18 @@ destination buffer for encryption which is then passed on to the underlying bdev write buffer. This is done to avoid encrypting the data in the original source buffer which may cause problems in some use cases. +Example command + +`rpc.py construct_crypto_bdev -b NVMe1n1 -c CryNvmeA -d crypto_aesni_mb -k 0123456789123456` + +This command will create a crypto vbdev called 'CryNvmeA' on top of the NVMe bdev +'NVMe1n1' and will use the DPDK software driver 'crypto_aesni_mb' and the key +'0123456789123456'. + +To remove the vbdev use the delete_crypto_bdev command. + +`rpc.py delete_crypto_bdev CryNvmeA` + # GPT (GUID Partition Table) {#bdev_config_gpt} The GPT virtual bdev driver is enabled by default and does not require any configuration.