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
committed by Madan Koyyalamudi
parent de1279ed3f
commit 4042de592d
33 changed files with 287 additions and 250 deletions

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2015-2017 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
@@ -28,12 +28,12 @@
#include <i_qdf_lro.h>
/**
* @qdf_nbuf_t - Platform independent LRO context abstraction
* typedef qdf_lro_ctx_t - Platform independent LRO context abstraction
*/
typedef __qdf_lro_ctx_t qdf_lro_ctx_t;
/**
* qdf_lro_info_s - LRO information
* struct qdf_lro_info - LRO information
* @iph: IP header
* @tcph: TCP header
*/
@@ -88,7 +88,7 @@ bool qdf_lro_get_info(qdf_lro_ctx_t lro_ctx, qdf_nbuf_t nbuf,
* Return: none
*/
void qdf_lro_flush_pkt(qdf_lro_ctx_t lro_ctx,
struct qdf_lro_info *info);
struct qdf_lro_info *info);
/**
* qdf_lro_flush() - LRO flush API
@@ -103,14 +103,14 @@ void qdf_lro_flush(qdf_lro_ctx_t lro_ctx);
/**
* qdf_lro_desc_free() - Free the LRO descriptor
* @desc: LRO descriptor
* @lro_ctx: LRO context
* @data: LRO descriptor
*
* Return the LRO descriptor to the free pool
*
* Return: none
*/
void qdf_lro_desc_free(qdf_lro_ctx_t lro_ctx, void *desc);
void qdf_lro_desc_free(qdf_lro_ctx_t lro_ctx, void *data);
#else