qcacmn: Fix QDF documentation

The kernel-doc script identified a large number of documentation
issues in the QDF. A series of patches has already fixed many of the
issues, so fix most of the remaining ones.

Note that the QDF IPA abstraction still has issues, but it is under
rework, so not trying to clean it up until after the rework is
complete.

Change-Id: I10c33e341cb6b46e0f8ada99069616d450c07189
CRs-Fixed: 3406197
This commit is contained in:
Jeff Johnson
2023-02-13 20:15:22 -08:00
committad av Madan Koyyalamudi
förälder de1279ed3f
incheckning 4042de592d
33 ändrade filer med 287 tillägg och 250 borttagningar

Visa fil

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2017-2018, 2020 The Linux Foundation. All rights reserved.
* Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
@@ -121,19 +121,20 @@ qdf_default_hmac_sha256_kdf(uint8_t *secret, uint32_t secret_len,
/**
* qdf_get_keyed_hash: API to get hash using specific crypto and
* scatterlist elements.
* @type: crypto type
* @alg: crypto type
* @key: key needs to be used for hmac api
* @keylen: length of key
* @element_cnt: scatterlist element count
* @addr: scatterlist element array
* @addr_len: element length array
* @hash: new hash
* @key_len: length of key
* @src: scatterlist element array
* @src_len: scatterlist element length array
* @num_elements: scatterlist element count
* @out: calculated hash
*
* Return: 0 if success else error code
*/
int qdf_get_keyed_hash(const char *alg, const uint8_t *key,
unsigned int key_len, const uint8_t *src[],
size_t *src_len, size_t num_elements, uint8_t *out);
/**
* qdf_update_dbl: This API does the doubling operation as defined in RFC5297
* @d: input for doubling