From f4c4186d0dbe88a8f65f79ac396dbdbe2cdb633b Mon Sep 17 00:00:00 2001 From: Srinivas Pitla Date: Mon, 19 Jun 2017 17:17:27 +0530 Subject: [PATCH] qcacmn: Add notes on Ref count This change adds the notes in function headers for which ref count gets incremented internally Change-Id: Ide232bd7a7361b081edd08c8107451820c2736cc CRs-Fixed: 2063383 --- .../obj_mgr/inc/wlan_objmgr_pdev_obj.h | 16 +++++ .../obj_mgr/inc/wlan_objmgr_psoc_obj.h | 64 +++++++++++++++++++ 2 files changed, 80 insertions(+) diff --git a/umac/cmn_services/obj_mgr/inc/wlan_objmgr_pdev_obj.h b/umac/cmn_services/obj_mgr/inc/wlan_objmgr_pdev_obj.h index bdf031409d66..ec66efd96940 100644 --- a/umac/cmn_services/obj_mgr/inc/wlan_objmgr_pdev_obj.h +++ b/umac/cmn_services/obj_mgr/inc/wlan_objmgr_pdev_obj.h @@ -323,6 +323,10 @@ QDF_STATUS wlan_objmgr_trigger_pdev_comp_priv_object_deletion( * * API to find vdev object pointer by vdev id from pdev's vdev list * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ @@ -339,6 +343,10 @@ struct wlan_objmgr_vdev *wlan_objmgr_get_vdev_by_id_from_pdev( * * API to find vdev object pointer by vdev id from pdev's vdev list * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ @@ -354,6 +362,10 @@ struct wlan_objmgr_vdev *wlan_objmgr_get_vdev_by_id_from_pdev_no_state( * * API to find vdev object pointer by vdev mac addr from pdev's vdev list * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ @@ -370,6 +382,10 @@ struct wlan_objmgr_vdev *wlan_objmgr_get_vdev_by_macaddr_from_pdev( * * API to find vdev object pointer by vdev mac addr from pdev's vdev list * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ diff --git a/umac/cmn_services/obj_mgr/inc/wlan_objmgr_psoc_obj.h b/umac/cmn_services/obj_mgr/inc/wlan_objmgr_psoc_obj.h index 70f3f915fe43..e1c4f81090e8 100644 --- a/umac/cmn_services/obj_mgr/inc/wlan_objmgr_psoc_obj.h +++ b/umac/cmn_services/obj_mgr/inc/wlan_objmgr_psoc_obj.h @@ -476,6 +476,10 @@ QDF_STATUS wlan_objmgr_trigger_psoc_comp_priv_object_deletion( * * API to find peer object pointer by MAC addr * + * This API increments the ref count of the peer object internally, the + * caller has to invoke the wlan_objmgr_peer_release_ref() to decrement + * ref count + * * Return: peer pointer * NULL on FAILURE */ @@ -491,6 +495,10 @@ struct wlan_objmgr_peer *wlan_objmgr_get_peer( * * API to find peer object pointer by MAC addr * + * This API increments the ref count of the peer object internally, the + * caller has to invoke the wlan_objmgr_peer_release_ref() to decrement + * ref count + * * Return: peer pointer * NULL on FAILURE */ @@ -507,6 +515,10 @@ struct wlan_objmgr_peer *wlan_objmgr_get_peer_nolock( * * API to find peer object pointer of logically deleted peer * + * This API increments the ref count of the peer object internally, the + * caller has to invoke the wlan_objmgr_peer_release_ref() to decrement + * ref count + * * Return: peer pointer * NULL on FAILURE */ @@ -522,6 +534,10 @@ struct wlan_objmgr_peer *wlan_objmgr_get_peer_logically_deleted( * * API to find peer object pointer by MAC addr, ignores the state check * + * This API increments the ref count of the peer object internally, the + * caller has to invoke the wlan_objmgr_peer_release_ref() to decrement + * ref count + * * Return: peer pointer * NULL on FAILURE */ @@ -542,6 +558,10 @@ struct wlan_objmgr_peer *wlan_objmgr_get_peer_no_state( * API to find peer object pointer by MAC addr and vdev self mac * address for a node that is logically in deleted state * + * This API increments the ref count of the peer object internally, the + * caller has to invoke the wlan_objmgr_peer_release_ref() to decrement + * ref count + * * Return: List of peer pointers * NULL on FAILURE */ @@ -559,6 +579,10 @@ qdf_list_t *wlan_objmgr_populate_logically_deleted_peerlist_by_mac_n_vdev( * * API to find peer object pointer by MAC addr and vdev self mac address * + * This API increments the ref count of the peer object internally, the + * caller has to invoke the wlan_objmgr_peer_release_ref() to decrement + * ref count + * * Return: peer pointer * NULL on FAILURE */ @@ -577,6 +601,10 @@ struct wlan_objmgr_peer *wlan_objmgr_get_peer_by_mac_n_vdev( * API to find peer object pointer by MAC addr and vdev self mac address, * ignores the state * + * This API increments the ref count of the peer object internally, the + * caller has to invoke the wlan_objmgr_peer_release_ref() to decrement + * ref count + * * Return: peer pointer * NULL on FAILURE */ @@ -592,6 +620,10 @@ struct wlan_objmgr_peer *wlan_objmgr_get_peer_by_mac_n_vdev_no_state( * * API to find pdev object pointer by pdev id * + * This API increments the ref count of the pdev object internally, the + * caller has to invoke the wlan_objmgr_pdev_release_ref() to decrement + * ref count + * * Return: pdev pointer * NULL on FAILURE */ @@ -607,6 +639,10 @@ struct wlan_objmgr_pdev *wlan_objmgr_get_pdev_by_id( * * API to find pdev object pointer by pdev id, Ignores the state check * + * This API increments the ref count of the pdev object internally, the + * caller has to invoke the wlan_objmgr_pdev_release_ref() to decrement + * ref count + * * Return: pdev pointer * NULL on FAILURE */ @@ -622,6 +658,10 @@ struct wlan_objmgr_pdev *wlan_objmgr_get_pdev_by_id_no_state( * * API to find pdev object pointer by pdev macaddr * + * This API increments the ref count of the pdev object internally, the + * caller has to invoke the wlan_objmgr_pdev_release_ref() to decrement + * ref count + * * Return: pdev pointer * NULL on FAILURE */ @@ -637,6 +677,10 @@ struct wlan_objmgr_pdev *wlan_objmgr_get_pdev_by_macaddr( * * API to find pdev object pointer by pdev macaddr, ignores the state check * + * This API increments the ref count of the pdev object internally, the + * caller has to invoke the wlan_objmgr_pdev_release_ref() to decrement + * ref count + * * Return: pdev pointer * NULL on FAILURE */ @@ -652,6 +696,10 @@ struct wlan_objmgr_pdev *wlan_objmgr_get_pdev_by_macaddr_no_state( * * API to find vdev object pointer by vdev operating mode from psoc * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ @@ -668,6 +716,10 @@ struct wlan_objmgr_vdev *wlan_objmgr_get_vdev_by_opmode_from_psoc( * * API to find vdev object pointer by vdev id from psoc * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ @@ -684,6 +736,10 @@ struct wlan_objmgr_vdev *wlan_objmgr_get_vdev_by_id_from_psoc( * API to find vdev object pointer by vdev id from psoc, ignores the * state check * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ @@ -699,6 +755,10 @@ struct wlan_objmgr_vdev *wlan_objmgr_get_vdev_by_id_from_psoc_no_state( * * API to find vdev object pointer by vdev macaddr from psoc * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */ @@ -716,6 +776,10 @@ struct wlan_objmgr_vdev *wlan_objmgr_get_vdev_by_macaddr_from_psoc( * API to find vdev object pointer by vdev macaddr from psoc, ignores the state * check * + * This API increments the ref count of the vdev object internally, the + * caller has to invoke the wlan_objmgr_vdev_release_ref() to decrement + * ref count + * * Return: vdev pointer * NULL on FAILURE */