kevin/linux
1
Fork 0
Code

docs: crypto: async-tx-api: fix broken code example

Browse Source 
The code example fails to compile:

  1) addr_conv is defined twice, once as a VLA, which have been phased out

  2) submit is not a pointer, but is still dereferenced with ->

  3) The first call to async_xor() lacked the trailing semicolon

Fix these issues and while at it, fix some code style nitpicks as well:

  1) make the functions static as users are unlikely to export them

  2) include the relevant header

  3) Shorten the example a bit by removing a redundant variable
     definition

Fixes: 04ce9ab385 ("async_xor: permit callers to pass in a 'dma/page scribble' region")
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
Reviewed-by: Andre Noll <maan@tuebingen.mpg.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240529-async-dma-docs-v2-1-8faf87e72e6d@pengutronix.de
This commit is contained in:
Ahmad Fatoum 2024-05-29 10:08:29 +02:00 committed by Jonathan Corbet
parent 99a021edde
commit e8496ad6d8
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/crypto/async-tx-api.rst
View File

@ -150,38 +150,38 @@ of an operation.
Perform a xor->copy->xor operation where each operation depends on the Perform a xor->copy->xor operation where each operation depends on the
result from the previous operation:: result from the previous operation::
void callback(void *param) #include <linux/async_tx.h>
{
struct completion *cmp = param;
complete(cmp); static void callback(void *param)
{
complete(param);
} }
void run_xor_copy_xor(struct page **xor_srcs, #define NDISKS 2
int xor_src_cnt,
struct page *xor_dest, static void run_xor_copy_xor(struct page **xor_srcs,
size_t xor_len, struct page *xor_dest,
struct page *copy_src, size_t xor_len,
struct page *copy_dest, struct page *copy_src,
size_t copy_len) struct page *copy_dest,
size_t copy_len)
{ {
struct dma_async_tx_descriptor *tx; struct dma_async_tx_descriptor *tx;
addr_conv_t addr_conv[xor_src_cnt];
struct async_submit_ctl submit; struct async_submit_ctl submit;
addr_conv_t addr_conv[NDISKS]; addr_conv_t addr_conv[NDISKS];
struct completion cmp; struct completion cmp;
init_async_submit(&submit, ASYNC_TX_XOR_DROP_DST, NULL, NULL, NULL, init_async_submit(&submit, ASYNC_TX_XOR_DROP_DST, NULL, NULL, NULL,
addr_conv); addr_conv);
tx = async_xor(xor_dest, xor_srcs, 0, xor_src_cnt, xor_len, &submit) tx = async_xor(xor_dest, xor_srcs, 0, NDISKS, xor_len, &submit);
submit->depend_tx = tx; submit.depend_tx = tx;
tx = async_memcpy(copy_dest, copy_src, 0, 0, copy_len, &submit); tx = async_memcpy(copy_dest, copy_src, 0, 0, copy_len, &submit);
init_completion(&cmp); init_completion(&cmp);
init_async_submit(&submit, ASYNC_TX_XOR_DROP_DST | ASYNC_TX_ACK, tx, init_async_submit(&submit, ASYNC_TX_XOR_DROP_DST | ASYNC_TX_ACK, tx,
callback, &cmp, addr_conv); callback, &cmp, addr_conv);
tx = async_xor(xor_dest, xor_srcs, 0, xor_src_cnt, xor_len, &submit); tx = async_xor(xor_dest, xor_srcs, 0, NDISKS, xor_len, &submit);
async_tx_issue_pending_all(); async_tx_issue_pending_all();