qcacmn: Fix dp wifi3.0 documentation

The kernel-doc script identified a large number of kernel-doc issues
in the dp/wifi3.0 folder. A series of patches have addressed most of
the issues, so now fix the remaining issues. Just like in the previous
patches, there are a number of instances where public functions have
their implementation documented instead of having their interface
documented, so make sure that the interfaces are documented.

Change-Id: I4bc39b0e1a9d8c264b72ec6db76ff7e92d24f277
CRs-Fixed: 3373822
This commit is contained in:
Jeff Johnson
2023-01-06 15:48:53 -08:00
committed by Madan Koyyalamudi
szülő b2294c287e
commit 3cbfba9824
9 fájl változott, egészen pontosan 68 új sor hozzáadva és 336 régi sor törölve

Fájl megtekintése

@@ -27,7 +27,7 @@
#include <qdf_module.h>
#ifdef WDI_EVENT_ENABLE
/*
/**
* dp_wdi_event_next_sub() - Return handle for Next WDI event
* @wdi_sub: WDI Event handle
*
@@ -47,12 +47,13 @@ dp_wdi_event_next_sub(wdi_event_subscribe *wdi_sub)
}
/*
* dp_wdi_event_del_subs() -Delete Event subscription
/**
* dp_wdi_event_del_subs() - Delete Event subscription
* @wdi_sub: WDI Event handle
* @event_index: Event index from list
*
* This API will delete subscribed event from list
*
* Return: None
*/
static inline void
@@ -62,12 +63,12 @@ dp_wdi_event_del_subs(wdi_event_subscribe *wdi_sub, int event_index)
}
/*
/**
* dp_wdi_event_iter_sub() - Iterate through all WDI event in the list
* and pass WDI event to callback function
* @pdev: DP pdev handle
* @event_index: Event index in list
* @wdi_event: WDI event handle
* @wdi_sub: WDI event subscriber
* @data: pointer to data
* @peer_id: peer id number
* @status: HTT rx status
@@ -95,19 +96,6 @@ dp_wdi_event_iter_sub(
}
/*
* dp_wdi_event_handler() - Event handler for WDI event
* @event: wdi event number
* @soc: soc handle
* @data: pointer to data
* @peer_id: peer id number
* @status: HTT rx status
* @pdev_id: id of pdev
*
* It will be called to register WDI event
*
* Return: None
*/
void
dp_wdi_event_handler(
enum WDI_EVENT event,
@@ -149,15 +137,6 @@ dp_wdi_event_handler(
qdf_export_symbol(dp_wdi_event_handler);
/*
* dp_wdi_event_sub() - Subscribe WDI event
* @soc: soc handle
* @pdev_id: id of pdev
* @event_cb_sub_handle: subscribe event handle
* @event: Event to be subscribe
*
* Return: 0 for success. nonzero for failure.
*/
int
dp_wdi_event_sub(
struct cdp_soc_t *soc, uint8_t pdev_id,
@@ -222,16 +201,6 @@ dp_wdi_event_sub(
}
/*
* dp_wdi_event_unsub() - WDI event unsubscribe
* @soc: soc handle
* @pdev_id: id of pdev
* @event_cb_sub_handle: subscribed event handle
* @event: Event to be unsubscribe
*
*
* Return: 0 for success. nonzero for failure.
*/
int
dp_wdi_event_unsub(
struct cdp_soc_t *soc, uint8_t pdev_id,
@@ -270,12 +239,6 @@ dp_wdi_event_unsub(
}
/*
* dp_wdi_event_attach() - Attach wdi event
* @txrx_pdev: DP pdev handle
*
* Return: 0 for success. nonzero for failure.
*/
int
dp_wdi_event_attach(struct dp_pdev *txrx_pdev)
{
@@ -297,13 +260,6 @@ dp_wdi_event_attach(struct dp_pdev *txrx_pdev)
return 0;
}
/*
* dp_wdi_event_detach() - Detach WDI event
* @txrx_pdev: DP pdev handle
*
* Return: 0 for success. nonzero for failure.
*/
int
dp_wdi_event_detach(struct dp_pdev *txrx_pdev)
{