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
This commit is contained in:
Jeff Johnson
2023-01-26 12:21:05 -08:00
committed by Madan Koyyalamudi
parent f68d690127
commit d93db0f70e
3 changed files with 7 additions and 5 deletions

View File

@@ -1,5 +1,6 @@
/* /*
* Copyright (c) 2018-2019 The Linux Foundation. All rights reserved. * 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 * Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the * 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 * 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 * @len: length of buffer requested
* @func_name: function from which buffer is requested * @func_name: function from which buffer is requested
* @line_num: line number in the file * @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 * wbuff_buff_put() - put the buffer back to wbuff pool
* @hdl: wbuff_handle corresponding to the module
* @buf: pointer to network buffer * @buf: pointer to network buffer
* *
* Return: NULL if success (buffer consumed) * Return: NULL if success (buffer consumed)

View File

@@ -1,5 +1,6 @@
/* /*
* Copyright (c) 2018 The Linux Foundation. All rights reserved. * 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 * Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the * 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 * @handle: wbuff handle for the registered module
* @reserve: nbuf headroom to start with * @reserve: nbuf headroom to start with
* @align: alignment for the nbuf * @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 { struct wbuff_module {
bool registered; bool registered;
@@ -95,6 +96,7 @@ struct wbuff_module {
/** /**
* struct wbuff_holder - allocation holder for wbuff * struct wbuff_holder - allocation holder for wbuff
* @initialized: to identified whether module is initialized * @initialized: to identified whether module is initialized
* @mod: list of modules
*/ */
struct wbuff_holder { struct wbuff_holder {
bool initialized; bool initialized;

View File

@@ -1,6 +1,6 @@
/* /*
* Copyright (c) 2018-2019 The Linux Foundation. All rights reserved. * 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 * Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the * any purpose with or without fee is hereby granted, provided that the
@@ -25,7 +25,7 @@
#include <wbuff.h> #include <wbuff.h>
#include "i_wbuff.h" #include "i_wbuff.h"
/** /*
* Allocation holder array for all wbuff registered modules * Allocation holder array for all wbuff registered modules
*/ */
struct wbuff_holder wbuff; struct wbuff_holder wbuff;