From d93db0f70eb35f5bb04948516ece4686b81fc044 Mon Sep 17 00:00:00 2001 From: Jeff Johnson Date: Thu, 26 Jan 2023 12:21:05 -0800 Subject: [PATCH] qcacmn: Fix wbuff documentation The kernel-doc script identified some documentation errors in the wbuff folder, so fix them. Change-Id: Ie3ab3bafda78a1b7207391b0accd4286e6ae5de3 CRs-Fixed: 3389343 --- wbuff/inc/wbuff.h | 4 ++-- wbuff/src/i_wbuff.h | 4 +++- wbuff/src/wbuff.c | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/wbuff/inc/wbuff.h b/wbuff/inc/wbuff.h index 5afe0d1952..272d8886c4 100644 --- a/wbuff/inc/wbuff.h +++ b/wbuff/inc/wbuff.h @@ -1,5 +1,6 @@ /* * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved. + * Copyright (c) 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 @@ -93,7 +94,7 @@ QDF_STATUS wbuff_module_deregister(struct wbuff_mod_handle *hdl); /** * wbuff_buff_get() - return buffer to the requester - * @handle: wbuff_handle corresponding to the module + * @hdl: wbuff_handle corresponding to the module * @len: length of buffer requested * @func_name: function from which buffer is requested * @line_num: line number in the file @@ -106,7 +107,6 @@ qdf_nbuf_t wbuff_buff_get(struct wbuff_mod_handle *hdl, uint32_t len, /** * wbuff_buff_put() - put the buffer back to wbuff pool - * @hdl: wbuff_handle corresponding to the module * @buf: pointer to network buffer * * Return: NULL if success (buffer consumed) diff --git a/wbuff/src/i_wbuff.h b/wbuff/src/i_wbuff.h index ce7b69ec71..10dfaf4ae7 100644 --- a/wbuff/src/i_wbuff.h +++ b/wbuff/src/i_wbuff.h @@ -1,5 +1,6 @@ /* * Copyright (c) 2018 The Linux Foundation. All rights reserved. + * Copyright (c) 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 @@ -80,7 +81,7 @@ struct wbuff_handle { * @handle: wbuff handle for the registered module * @reserve: nbuf headroom to start with * @align: alignment for the nbuf - * @pool[]: pools for all available buffers for the module + * @pool: pools for all available buffers for the module */ struct wbuff_module { bool registered; @@ -95,6 +96,7 @@ struct wbuff_module { /** * struct wbuff_holder - allocation holder for wbuff * @initialized: to identified whether module is initialized + * @mod: list of modules */ struct wbuff_holder { bool initialized; diff --git a/wbuff/src/wbuff.c b/wbuff/src/wbuff.c index 4b964d161a..dda73f481d 100644 --- a/wbuff/src/wbuff.c +++ b/wbuff/src/wbuff.c @@ -1,6 +1,6 @@ /* * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved. - * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved. + * Copyright (c) 2021, 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 @@ -25,7 +25,7 @@ #include #include "i_wbuff.h" -/** +/* * Allocation holder array for all wbuff registered modules */ struct wbuff_holder wbuff;