samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
Fork 0
Koodi Ongelmat Pull-pyynnöt Actions Paketit Projektit Julkaisut Wiki Toiminta

qcacmn: Fix QDF documentation

Selaa lähdekoodia 
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
vanhempi de1279ed3f
commit 4042de592d
33 muutettua tiedostoa jossa 287 lisäystä ja 250 poistoa
Download Patch File Download Diff File Expand all files Collapse all files

33
qdf/inc/qdf_notifier.h
Näytä tiedosto

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2020, 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 above
@@ -15,7 +16,7 @@
*/
/**
* @file qdf_notifier.h
* DOC: qdf_notifier.h
* This file abstracts notifier chain call operations.
*/
@@ -25,9 +26,9 @@
#include <i_qdf_notifier.h>
#include <qdf_status.h>
/*
* qdf_notif_block - qdf notifier block
* @__qdf_notifier_block: OS specific notifier block
/**
* typedef qdf_notif_block - qdf notifier block
* @notif_block: OS specific notifier block
* @priv_data: private data of the notifier block
*/
typedef struct {
@@ -43,8 +44,8 @@ typedef __qdf_notifier_block qdf_notifier_block;
/**
* qdf_register_blocking_notifier_chain() - Register for blocking notifier chain
* @qdf_blocking_notif_head: Head of blocking notifier chain
* @qdf_notif_block: Notifier Block to be registered for this head chain
* @head: Head of blocking notifier chain
* @qnb: Notifier Block to be registered for this head chain
*
* This function is invoked to add a notifier block for the specific notifier
* head chain.
@@ -57,8 +58,8 @@ QDF_STATUS qdf_register_blocking_notifier_chain(qdf_blocking_notif_head *head,
/**
* qdf_unregister_blocking_notifier_chain() - Unregister for blocking notifier
* chain
* @qdf_blocking_notif_head: Head of blocking notifier chain
* @qdf_notif_block: Notifier Block to be registered for this head chain
* @head: Head of blocking notifier chain
* @qnb: Notifier Block to be unregistered from this head chain
*
* This function is invoked to remove a notifier block for the specific notifier
* head chain.
@@ -70,7 +71,7 @@ QDF_STATUS qdf_unregister_blocking_notifier_chain(qdf_blocking_notif_head *head,
qdf_notif_block *qnb);
/**
* qdf_blocking_notfier_call() - Invoke the function in the blocking chain
* @qdf_blocking_notif_head: Head of blocking notifier chain
* @head: Head of blocking notifier chain
* @state: state passed during the invoking of the notifier
* @data: Private data to be passed to all the notifier functions
*
@@ -86,8 +87,8 @@ QDF_STATUS qdf_blocking_notfier_call(qdf_blocking_notif_head *head,
/**
* qdf_register_atomic_notifier_chain() - Register for atomic notifier chain
* @qdf_blocking_notif_head: Head of atomic notifier chain
* @qdf_notif_block: Notifier Block to be registered for this head chain
* @head: Head of atomic notifier chain
* @qnb: Notifier Block to be registered for this head chain
*
* This function is invoked to add a notifier block for the specific atomic
* notifier head chain.
@@ -98,10 +99,10 @@ QDF_STATUS qdf_blocking_notfier_call(qdf_blocking_notif_head *head,
QDF_STATUS qdf_register_atomic_notifier_chain(qdf_atomic_notif_head *head,
qdf_notif_block *qnb);
/**
* qdf_unregister_atmoic_notifier_chain() - Unregister for atomic notifier
* qdf_unregister_atomic_notifier_chain() - Unregister for atomic notifier
* chain
* @qdf_blocking_notif_head: Head of blocking notifier chain
* @qdf_notif_block: Notifier Block to be registered for this head chain
* @head: Head of atomic notifier chain
* @qnb: Notifier Block to be unregistered from this head chain
*
* This function is invoked to remove a notifier block for the specific notifier
* head chain.
@@ -112,8 +113,8 @@ QDF_STATUS qdf_register_atomic_notifier_chain(qdf_atomic_notif_head *head,
QDF_STATUS qdf_unregister_atomic_notifier_chain(qdf_atomic_notif_head *head,
qdf_notif_block *qnb);
/**
* qdf_blocking_notfier_call() - Invoke the function in the blocking chain
* @qdf_blocking_notif_head: Head of blocking notifier chain
* qdf_atomic_notfier_call() - Invoke the function in the blocking chain
* @head: Head of atomic notifier chain
* @v: Generally state passed during the invoking of the notifier
* @data: Private data to be passed to all the notifier functions
*