qcacmn: Fix QDF nbuf documentation

The kernel-doc script identified a large number of documentation
issues in the QDF nbuf abstractions, so fix those issues. In addition,
there are a number of instances where public functions have their
implementation documented instead of having their interface
documented, so move that documentation.

Change-Id: I744e98469d0fd6d6a2c7c907b2f9af5307f84458
CRs-Fixed: 3398757
This commit is contained in:
Jeff Johnson
2023-02-06 22:35:11 -08:00
committed by Madan Koyyalamudi
parent 0571d2f7bf
commit a81eb57e42
9 changed files with 1293 additions and 1168 deletions

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 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
@@ -36,7 +36,7 @@
*/
typedef struct page_frag_cache __qdf_frag_cache_t;
/**
/*
* typedef __qdf_frag_t - Abstraction for void * for frag address
*/
typedef void *__qdf_frag_t;
@@ -103,7 +103,7 @@ static inline void __qdf_frag_mod_exit(void)
}
#endif /* QDF_NBUF_FRAG_GLOBAL_COUNT */
/**
/*
* Maximum number of frags an SKB can hold
*/
#define __QDF_NBUF_MAX_FRAGS MAX_SKB_FRAGS
@@ -124,7 +124,7 @@ void __qdf_mem_unmap_page(qdf_device_t osdev, qdf_dma_addr_t paddr,
* @buf: Vaddr to be mapped
* @dir: qdf_dma_dir_t
* @nbytes: Number of bytes to be mapped
* @paddr: Mapped physical address
* @phy_addr: Mapped physical address
*
* Return: QDF_STATUS
*/