qcacld-3.0: Rename pMac within documentation

A recent set of changes renamed all instances of the identifier "pMac"
in the driver. However some instances inside documentation comments
were missed, so rename those as well.

Change-Id: Ib06da00102c1e37ed9a058ab8d90646586b1f487
CRs-Fixed: 2357850

core/mac/src/cfg/cfg_api.c

@@ -617,7 +617,7 @@ error:
 
    \brief  Gets regulatory tx power on the current channel.
 
-   \param  pMac
+   \param  mac
    \param  channel
    \param  rfBand
    -----------------------------------------------------------------------*/

core/mac/src/dph/dph_hash_table.c

@@ -218,7 +218,7 @@ tpDphHashNode dph_lookup_assoc_id(tpAniSirGlobal mac, uint16_t staIdx,
    \fn dph_init_sta_state
    \brief Initialize STA state. this function saves the staId from the current entry in the DPH table with given assocId
  \ if validStaIdx flag is set. Otherwise it sets the staId to invalid.
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  tSirMacAddr staAddr
    \param  uint16_t assocId
    \param  uint8_t validStaIdx -   true ==> the staId in the DPH entry with given assocId is valid and restore it back.

core/mac/src/pe/include/lim_api.h

@@ -323,7 +323,7 @@ QDF_STATUS pe_mc_process_handler(struct scheduler_msg *msg);
  \      to free a given PE message on the TX and MC thread.
  \      This happens when there are messages pending in the PE
  \      queue when system is being stopped and reset.
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param   struct scheduler_msg       pMsg
    \return none
    -----------------------------------------------------------------*/

core/mac/src/pe/lim/lim_admit_control.c

@@ -80,7 +80,7 @@ static QDF_STATUS lim_validate_access_policy(tpAniSirGlobal, uint8_t, uint16_t,
 /** -------------------------------------------------------------
    \fn lim_calculate_svc_int
    \brief TSPEC validation and servcie interval determination
-   \param     tpAniSirGlobal    pMac
+   \param     tpAniSirGlobal    mac
    \param         tSirMacTspecIE *pTspec
    \param         uint32_t            *pSvcInt
    \return QDF_STATUS - status of the comparison
@@ -174,7 +174,7 @@ lim_validate_tspec_edca(tpAniSirGlobal mac_ctx,
 /** -------------------------------------------------------------
    \fn lim_validate_tspec
    \brief validate the offered tspec
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param         tSirMacTspecIE *pTspec
    \return QDF_STATUS - status
    -------------------------------------------------------------*/
@@ -210,7 +210,7 @@ lim_validate_tspec(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_compute_mean_bw_used
    \brief determime the used/allocated bandwidth
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param       uint32_t              *pBw
    \param       uint32_t               phyMode
    \param       tpLimTspecInfo    pTspecInfo
@@ -245,7 +245,7 @@ lim_compute_mean_bw_used(tpAniSirGlobal mac,
    \fn lim_get_available_bw
    \brief based on the phy mode and the bw_factor, determine the total bandwidth that
        can be supported
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param       uint32_t              *pMaxBw
    \param       uint32_t              *pMinBw
    \param       uint32_t               phyMode
@@ -328,7 +328,7 @@ lim_admit_policy_oversubscription(tpAniSirGlobal mac_ctx,
 /** -------------------------------------------------------------
    \fn lim_admit_policy
    \brief determine the current admit control policy and apply it for the offered tspec
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param         tSirMacTspecIE   *pTspec
    \return QDF_STATUS - status
    -------------------------------------------------------------*/
@@ -371,7 +371,7 @@ static QDF_STATUS lim_admit_policy(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_tspec_delete
    \brief delete the specified tspec
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param     tpLimTspecInfo pInfo
    \return void
    -------------------------------------------------------------*/
@@ -392,7 +392,7 @@ static void lim_tspec_delete(tpAniSirGlobal mac, tpLimTspecInfo pInfo)
 /** -------------------------------------------------------------
    \fn lim_tspec_find_by_sta_addr
    \brief Send halMsg_AddTs to HAL
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param   \param       uint8_t               *pAddr
    \param       tSirMacTspecIE    *pTspecIE
    \param       tpLimTspecInfo    pTspecList
@@ -430,7 +430,7 @@ lim_tspec_find_by_sta_addr(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_tspec_find_by_assoc_id
    \brief find tspec with matchin staid and Tspec
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param       uint32_t               staid
    \param       tSirMacTspecIE    *pTspecIE
    \param       tpLimTspecInfo    pTspecList
@@ -470,7 +470,7 @@ lim_tspec_find_by_assoc_id(tpAniSirGlobal mac,
    \fn lim_find_tspec
    \brief finding a TSPEC entry with assocId, tsinfo.direction and tsinfo.tsid
    \param    uint16_t               assocId
-   \param     tpAniSirGlobal    pMac
+   \param     tpAniSirGlobal    mac
    \param     tSirMacTSInfo   *pTsInfo
    \param         tpLimTspecInfo    pTspecList
    \param         tpLimTspecInfo   *ppInfo
@@ -507,7 +507,7 @@ lim_find_tspec(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_tspec_add
    \brief add or update the specified tspec to the tspec list
-   \param tpAniSirGlobal    pMac
+   \param tpAniSirGlobal    mac
    \param uint8_t               *pAddr
    \param uint16_t               assocId
    \param tSirMacTspecIE   *pTspec
@@ -596,7 +596,7 @@ QDF_STATUS lim_tspec_add(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_validate_access_policy
    \brief Validates Access policy
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param       uint8_t              accessPolicy
    \param       uint16_t             assocId
    \return QDF_STATUS - status
@@ -744,7 +744,7 @@ QDF_STATUS lim_admit_control_add_ts(tpAniSirGlobal mac, uint8_t *pAddr,
 /** -------------------------------------------------------------
    \fn lim_admit_control_delete_ts
    \brief Delete the specified Tspec for the specified STA
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param       uint16_t               assocId
    \param       tSirMacTSInfo    *pTsInfo
    \param       uint8_t               *pTsStatus
@@ -780,7 +780,7 @@ lim_admit_control_delete_ts(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_admit_control_delete_sta
    \brief Delete all TSPEC for the specified STA
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param     uint16_t assocId
    \return QDF_STATUS - status
    -------------------------------------------------------------*/
@@ -805,7 +805,7 @@ QDF_STATUS lim_admit_control_delete_sta(tpAniSirGlobal mac, uint16_t assocId)
 /** -------------------------------------------------------------
    \fn lim_admit_control_init
    \brief init tspec table
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \return QDF_STATUS - status
    -------------------------------------------------------------*/
 QDF_STATUS lim_admit_control_init(tpAniSirGlobal mac)
@@ -818,7 +818,7 @@ QDF_STATUS lim_admit_control_init(tpAniSirGlobal mac)
 /** -------------------------------------------------------------
    \fn lim_send_hal_msg_add_ts
    \brief Send halMsg_AddTs to HAL
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param     uint16_t        staIdx
    \param     uint8_t         tspecIdx
    \param       tSirMacTspecIE tspecIE
@@ -893,7 +893,7 @@ lim_send_hal_msg_add_ts(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_send_hal_msg_del_ts
    \brief Send halMsg_AddTs to HAL
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param     uint16_t        staIdx
    \param     uint8_t         tspecIdx
    \param     tSirAddtsReqInfo addts
@@ -962,7 +962,7 @@ err:
  \       Otherwise, send DELTS action frame to peer and then
  \       then send back SME_ADDTS_RSP.
  \
-   \param  tpAniSirGlobal  pMac
+   \param  tpAniSirGlobal  mac
    \param  struct scheduler_msg *limMsg
    -------------------------------------------------------------*/
 void lim_process_hal_add_ts_rsp(tpAniSirGlobal mac,

core/mac/src/pe/lim/lim_api.c

@@ -781,7 +781,7 @@ static QDF_STATUS lim_unregister_sap_bcn_callback(tpAniSirGlobal mac_ctx)
 /** -------------------------------------------------------------
    \fn pe_open
    \brief will be called in Open sequence from mac_open
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param   tHalOpenParameters *pHalOpenParam
    \return  QDF_STATUS
    -------------------------------------------------------------*/
@@ -863,7 +863,7 @@ pe_open_timer_fail:
 /** -------------------------------------------------------------
    \fn pe_close
    \brief will be called in close sequence from mac_close
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \return  QDF_STATUS
    -------------------------------------------------------------*/
 
@@ -905,7 +905,7 @@ QDF_STATUS pe_close(tpAniSirGlobal mac)
 /** -------------------------------------------------------------
    \fn pe_start
    \brief will be called in start sequence from mac_start
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \return QDF_STATUS_SUCCESS on success, other QDF_STATUS on error
    -------------------------------------------------------------*/
 
@@ -931,7 +931,7 @@ QDF_STATUS pe_start(tpAniSirGlobal mac)
 /** -------------------------------------------------------------
    \fn pe_stop
    \brief will be called in stop sequence from mac_stop
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \return none
    -------------------------------------------------------------*/
 
@@ -961,7 +961,7 @@ static void pe_free_nested_messages(struct scheduler_msg *msg)
  \      to free a given PE message on the TX and MC thread.
  \      This happens when there are messages pending in the PE
  \      queue when system is being stopped and reset.
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param   struct scheduler_msg       pMsg
    \return none
    -----------------------------------------------------------------*/
@@ -1444,7 +1444,7 @@ lim_received_hb_handler(tpAniSirGlobal mac, uint8_t channelId,
 /** -------------------------------------------------------------
    \fn lim_update_overlap_sta_param
    \brief Updates overlap cache and param data structure
-   \param      tpAniSirGlobal    pMac
+   \param      tpAniSirGlobal    mac
    \param      tSirMacAddr bssId
    \param      tpLimProtStaParams pStaParams
    \return      None

core/mac/src/pe/lim/lim_assoc_utils.c

@@ -4631,7 +4631,7 @@ lim_prepare_and_send_del_sta_cnf(tpAniSirGlobal mac, tpDphHashNode pStaDs,
    \fn lim_init_pre_auth_timer_table
    \brief Initialize the Pre Auth Tanle and creates the timer for
        each node for the timeout value got from cfg.
-   \param     tpAniSirGlobal    pMac
+   \param     tpAniSirGlobal    mac
    \param     tpLimPreAuthTable pPreAuthTimerTable
    \return none
    -------------------------------------------------------------*/
@@ -4663,7 +4663,7 @@ void lim_init_pre_auth_timer_table(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_acquire_free_pre_auth_node
    \brief Retrives a free Pre Auth node from Pre Auth Table.
-   \param     tpAniSirGlobal    pMac
+   \param     tpAniSirGlobal    mac
    \param     tpLimPreAuthTable pPreAuthTimerTable
    \return none
    -------------------------------------------------------------*/
@@ -4686,7 +4686,7 @@ tLimPreAuthNode *lim_acquire_free_pre_auth_node(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn lim_get_pre_auth_node_from_index
    \brief Depending on the Index this retrieves the pre auth node.
-   \param     tpAniSirGlobal    pMac
+   \param     tpAniSirGlobal    mac
    \param     tpLimPreAuthTable pAuthTable
    \param     uint32_t authNodeIdx
    \return none
@@ -4756,7 +4756,7 @@ QDF_STATUS lim_is_dot11h_power_capabilities_in_range(tpAniSirGlobal mac,
    \fn     lim_fill_rx_highest_supported_rate
    \brief  Fills in the Rx Highest Supported Data Rate field from
  \       the 'supported MCS set' field in HT capability element.
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  tpSirSupportedRates  pRates
    \param  uint8_t*  pSupportedMCSSet
    \return none
@@ -4782,7 +4782,7 @@ void lim_fill_rx_highest_supported_rate(tpAniSirGlobal mac,
 /** -------------------------------------------------------------
    \fn     lim_send_sme_unprotected_mgmt_frame_ind
    \brief  Forwards the unprotected management frame to SME.
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  frameType - 802.11 frame type
    \param  frame - frame buffer
    \param  sessionId - id for the current session
@@ -4823,7 +4823,7 @@ void lim_send_sme_unprotected_mgmt_frame_ind(tpAniSirGlobal mac, uint8_t frameTy
 /** -------------------------------------------------------------
    \fn     lim_send_sme_tsm_ie_ind
    \brief  Forwards the TSM IE information to SME.
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  psessionEntry - PE session context
    \param  tid - traffic id
    \param  state - tsm state (enabled/disabled)

core/mac/src/pe/lim/lim_ibss_peer_mgmt.c

@@ -741,7 +741,7 @@ void lim_ibss_delete(tpAniSirGlobal mac, tpPESession psessionEntry)
    \fn lim_ibss_set_protection
    \brief Decides all the protection related information.
  \
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  tSirMacAddr peerMacAddr
    \param  tpUpdateBeaconParams pBeaconParams
    \return None
@@ -784,7 +784,7 @@ lim_ibss_set_protection(tpAniSirGlobal mac, uint8_t enable,
    \fn lim_ibss_update_protection_params
    \brief Decides all the protection related information.
  \
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  tSirMacAddr peerMacAddr
    \param  tpUpdateBeaconParams pBeaconParams
    \return None
@@ -842,7 +842,7 @@ lim_ibss_update_protection_params(tpAniSirGlobal mac,
    \fn lim_ibss_decide_protection
    \brief Decides all the protection related information.
  \
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  tSirMacAddr peerMacAddr
    \param  tpUpdateBeaconParams pBeaconParams
    \return None
@@ -1748,7 +1748,7 @@ void lim_ibss_decide_protection_on_delete(tpAniSirGlobal mac_ctx,
    \fn __lim_ibss_peer_inactivity_handler
    \brief Internal function. Deletes FW indicated peer which is inactive
  \
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  tpPESession       psessionEntry
    \param  tpSirIbssPeerInactivityInd peerInactivityInd
    \return None
@@ -1771,7 +1771,7 @@ __lim_ibss_peer_inactivity_handler(tpAniSirGlobal mac,
    \fn lim_process_ibss_peer_inactivity
    \brief Peer inactivity message handler
  \
-   \param  tpAniSirGlobal    pMac
+   \param  tpAniSirGlobal    mac
    \param  void*             buf
    \return None
    -------------------------------------------------------------*/

core/mac/src/pe/lim/lim_process_action_frame.c

@@ -66,7 +66,7 @@ static last_processed_msg rrm_link_action_frm;
    \brief  Stops the transmission if channel switch mode is silent and
    starts the channel switch timer.
 
-   \param  pMac
+   \param  mac
    \return NONE
    -----------------------------------------------------------------*/
 void lim_stop_tx_and_switch_channel(tpAniSirGlobal mac, uint8_t sessionId)
@@ -113,7 +113,7 @@ void lim_stop_tx_and_switch_channel(tpAniSirGlobal mac, uint8_t sessionId)
    starts the timer for channel switch and stops BG scan
    and heartbeat timer tempororily.
 
-   \param  pMac
+   \param  mac
    \param  psessionEntry
    \return NONE
    ------------------------------------------------------------*/

core/mac/src/pe/lim/lim_process_message_queue.c

@@ -403,7 +403,7 @@ static void lim_process_hw_mode_trans_ind(tpAniSirGlobal mac, void *body)
 /** -------------------------------------------------------------
    \fn def_msg_decision
    \brief The function decides whether to defer a message or not in limProcessMessage function
-   \param   tpAniSirGlobal pMac
+   \param   tpAniSirGlobal mac
    \param       struct scheduler_msg  limMsg
    \param       tSirMacTspecIE   *ppInfo
    \return none

core/mac/src/pe/lim/lim_send_messages.c

@@ -426,7 +426,7 @@ void lim_set_active_edca_params(tpAniSirGlobal mac_ctx,
 /** ---------------------------------------------------------
    \fn      lim_set_link_state
    \brief   LIM sends a message to WMA to set the link state
-   \param   tpAniSirGlobal  pMac
+   \param   tpAniSirGlobal  mac
    \param   tSirLinkState      state
    \return  None
    -----------------------------------------------------------*/

core/mac/src/pe/lim/lim_utils.c

@@ -76,7 +76,7 @@
 /** -------------------------------------------------------------
    \fn lim_delete_dialogue_token_list
    \brief deletes the complete lim dialogue token linked list.
-   \param     tpAniSirGlobal    pMac
+   \param     tpAniSirGlobal    mac
    \return     None
    -------------------------------------------------------------*/
 void lim_delete_dialogue_token_list(tpAniSirGlobal mac)
@@ -1132,7 +1132,7 @@ uint8_t lim_is_null_ssid(tSirMacSSid *ssid)
 /** -------------------------------------------------------------
    \fn lim_update_prot_sta_params
    \brief updates protection related counters.
-   \param      tpAniSirGlobal    pMac
+   \param      tpAniSirGlobal    mac
    \param      tSirMacAddr peerMacAddr
    \param      tLimProtStaCacheType protStaCacheType
    \param      tHalBitVal gfSupported
@@ -1209,7 +1209,7 @@ lim_update_prot_sta_params(tpAniSirGlobal mac,
    \brief Decides all the protection related staiton coexistence and also sets
  \        short preamble and short slot appropriately. This function will be called
  \        when AP is ready to send assocRsp tp the station joining right now.
-   \param      tpAniSirGlobal    pMac
+   \param      tpAniSirGlobal    mac
    \param      tSirMacAddr peerMacAddr
    \return      None
    -------------------------------------------------------------*/
@@ -1327,7 +1327,7 @@ lim_decide_ap_protection(tpAniSirGlobal mac, tSirMacAddr peerMacAddr,
 /** -------------------------------------------------------------
    \fn lim_enable_overlap11g_protection
    \brief wrapper function for setting overlap 11g protection.
-   \param      tpAniSirGlobal    pMac
+   \param      tpAniSirGlobal    mac
    \param      tpUpdateBeaconParams pBeaconParams
    \param      tpSirMacMgmtHdr         pMh
    \return      None
@@ -1594,7 +1594,7 @@ lim_update_short_slot_time(tpAniSirGlobal mac_ctx, tSirMacAddr peer_mac_addr,
 /** -------------------------------------------------------------
    \fn lim_decide_sta_protection_on_assoc
    \brief Decide protection related settings on Sta while association.
-   \param      tpAniSirGlobal    pMac
+   \param      tpAniSirGlobal    mac
    \param      tpSchBeaconStruct pBeaconStruct
    \return      None
    -------------------------------------------------------------*/
@@ -4563,7 +4563,7 @@ lim_prepare_for11h_channel_switch(tpAniSirGlobal mac, tpPESession psessionEntry)
    \fn        lim_get_nw_type
 
    \brief    Get type of the network from data packet or beacon
-   \param pMac
+   \param mac
    \param channelNum - Channel number
    \param type - Type of packet.
    \param pBeacon - Pointer to beacon or probe response
@@ -4612,7 +4612,7 @@ tSirNwType lim_get_nw_type(tpAniSirGlobal mac, uint8_t channelNum, uint32_t type
    \fn        lim_get_channel_from_beacon
    \brief    To extract channel number from beacon
 
-   \param pMac
+   \param mac
    \param pBeacon - Pointer to beacon or probe rsp
    \return channel number
    -----------------------------------------------------------*/
@@ -4925,7 +4925,7 @@ tpPESession lim_is_ap_session_active(tpAniSirGlobal mac)
 /**---------------------------------------------------------
    \fn        lim_handle_defer_msg_error
    \brief    handles error scenario, when the msg can not be deferred.
-   \param pMac
+   \param mac
    \param pLimMsg LIM msg, which could not be deferred.
    \return void
    -----------------------------------------------------------*/
@@ -4948,7 +4948,7 @@ void lim_handle_defer_msg_error(tpAniSirGlobal mac,
 /**---------------------------------------------------------
    \fn    lim_diag_event_report
    \brief This function reports Diag event
-   \param pMac
+   \param mac
    \param eventType
    \param bssid
    \param status

core/mac/src/pe/sch/sch_message.c

@@ -485,7 +485,7 @@ set_sch_edca_params(tpAniSirGlobal mac,
 
 /**
  * get_wmm_local_params() - This function gets the WMM local edca parameters.
- * @pMac
+ * @mac
  * @params[][WNI_CFG_EDCA_ANI_ACBK_LOCAL_LEN]
  *
  * Return  none