qcacld-3.0: Fix checkpatch error in wlan_qct_sys.c

This patch is to fix the check-patch errors in wlan_qct_sys.c

CRs-Fixed: 824222
Change-Id: I99f5c2daad9d14fcc6a7ab24dee95810829eeaf4

core/mac/src/sys/common/src/wlan_qct_sys.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2015 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2012-2016 The Linux Foundation. All rights reserved.
  *
  * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
  *
@@ -36,7 +36,8 @@
 #include "sme_api.h"
 #include "mac_init_api.h"
 
-/* Cookie for SYS messages.  Note that anyone posting a SYS Message
+/*
+ * Cookie for SYS messages.  Note that anyone posting a SYS Message
  * has to write the COOKIE in the reserved field of the message.  The
  * SYS Module relies on this COOKIE
  */
@@ -44,27 +45,50 @@
 
 /* SYS stop timeout 30 seconds */
 #define SYS_STOP_TIMEOUT (30000)
-
 static cdf_event_t g_stop_evt;
 
+/**
+ * sys_build_message_header() - to build the sys message header
+ * @sysMsgId: message id
+ * @pMsg: pointer to message context
+ *
+ * This API is used to build the sys message header.
+ *
+ * Return: CDF_STATUS
+ */
 CDF_STATUS sys_build_message_header(SYS_MSG_ID sysMsgId, cds_msg_t *pMsg)
 {
 	pMsg->type = sysMsgId;
 	pMsg->reserved = SYS_MSG_COOKIE;
 
-	return (CDF_STATUS_SUCCESS);
+	return CDF_STATUS_SUCCESS;
 }
 
-void sys_stop_complete_cb(void *pUserData) {
+/**
+ * sys_stop_complete_cb() - a callback when system stop completes
+ * @pUserData: pointer to user provided data context
+ *
+ * this callback is used once system stop is completed.
+ *
+ * Return: none
+ */
+void sys_stop_complete_cb(void *pUserData)
+{
 	cdf_event_t *pStopEvt = (cdf_event_t *) pUserData;
-	CDF_STATUS cdf_status;
-/*-------------------------------------------------------------------------*/
+	CDF_STATUS cdf_status = cdf_event_set(pStopEvt);
 
-	cdf_status = cdf_event_set(pStopEvt);
 	CDF_ASSERT(CDF_IS_STATUS_SUCCESS(cdf_status));
 
-} /* cds_sys_stop_complete_cback() */
+}
 
+/**
+ * sys_stop() - To post stop message to system module
+ * @p_cds_context:  pointer to cds context
+ *
+ * This API is used post a stop message to system module
+ *
+ * Return: CDF_STATUS
+ */
 CDF_STATUS sys_stop(v_CONTEXT_t p_cds_context)
 {
 	CDF_STATUS cdf_status = CDF_STATUS_SUCCESS;
@@ -73,23 +97,20 @@ CDF_STATUS sys_stop(v_CONTEXT_t p_cds_context)
 	/* Initialize the stop event */
 	cdf_status = cdf_event_init(&g_stop_evt);
 
-	if (!CDF_IS_STATUS_SUCCESS(cdf_status)) {
+	if (!CDF_IS_STATUS_SUCCESS(cdf_status))
 		return cdf_status;
-	}
 
 	/* post a message to SYS module in MC to stop SME and MAC */
 	sys_build_message_header(SYS_MSG_ID_MC_STOP, &sysMsg);
 
 	/* Save the user callback and user data */
-	/* finished. */
 	sysMsg.callback = sys_stop_complete_cb;
 	sysMsg.bodyptr = (void *)&g_stop_evt;
 
 	/* post the message.. */
 	cdf_status = cds_mq_post_message(CDS_MQ_ID_SYS, &sysMsg);
-	if (!CDF_IS_STATUS_SUCCESS(cdf_status)) {
+	if (!CDF_IS_STATUS_SUCCESS(cdf_status))
 		cdf_status = CDF_STATUS_E_BADMSG;
-	}
 
 	cdf_status = cdf_wait_single_event(&g_stop_evt, SYS_STOP_TIMEOUT);
 	CDF_ASSERT(CDF_IS_STATUS_SUCCESS(cdf_status));
@@ -97,22 +118,34 @@ CDF_STATUS sys_stop(v_CONTEXT_t p_cds_context)
 	cdf_status = cdf_event_destroy(&g_stop_evt);
 	CDF_ASSERT(CDF_IS_STATUS_SUCCESS(cdf_status));
 
-	return (cdf_status);
+	return cdf_status;
 }
 
+/**
+ * sys_mc_process_msg() - to process system mc thread messages
+ * @p_cds_context: pointer to cds context
+ * @pMsg: message pointer
+ *
+ * This API is used to process the message
+ *
+ * Return: CDF_STATUS
+ */
 CDF_STATUS sys_mc_process_msg(v_CONTEXT_t p_cds_context, cds_msg_t *pMsg)
 {
 	CDF_STATUS cdf_status = CDF_STATUS_SUCCESS;
+	cdf_mc_timer_callback_t timerCB;
+	tpAniSirGlobal mac_ctx;
 	void *hHal;
 
 	if (NULL == pMsg) {
-		CDF_ASSERT(0);
 		CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
 			  "%s: NULL pointer to cds_msg_t", __func__);
+		CDF_ASSERT(0);
 		return CDF_STATUS_E_INVAL;
 	}
 
-	/* All 'new' SYS messages are identified by a cookie in the reserved
+	/*
+	 * All 'new' SYS messages are identified by a cookie in the reserved
 	 * field of the message as well as the message type.  This prevents
 	 * the possibility of overlap in the message types defined for new
 	 * SYS messages with the 'legacy' message types.  The legacy messages
@@ -122,241 +155,208 @@ CDF_STATUS sys_mc_process_msg(v_CONTEXT_t p_cds_context, cds_msg_t *pMsg)
 		/* Process all the new SYS messages.. */
 		switch (pMsg->type) {
 		case SYS_MSG_ID_MC_START:
-		{
-			/* Handling for this message is not needed now so adding
-			 *debug print and CDF_ASSERT*/
-			CDF_TRACE(CDF_MODULE_ID_SYS,
-				  CDF_TRACE_LEVEL_ERROR,
-				  " Received SYS_MSG_ID_MC_START message msgType= %d [0x%08x]",
-				  pMsg->type, pMsg->type);
+			/*
+			 * Handling for this message is not needed now so adding
+			 * debug print and CDF_ASSERT
+			 */
+			CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
+				"Rx SYS_MSG_ID_MC_START msgType= %d [0x%08x]",
+				pMsg->type, pMsg->type);
 			CDF_ASSERT(0);
 			break;
-		}
 
 		case SYS_MSG_ID_MC_STOP:
-		{
-			CDF_TRACE(CDF_MODULE_ID_SYS,
-				  CDF_TRACE_LEVEL_INFO,
-				  "Processing SYS MC STOP");
+			CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_INFO,
+				"Processing SYS MC STOP");
 
 			/* get the HAL context... */
 			hHal = cds_get_context(CDF_MODULE_ID_PE);
 			if (NULL == hHal) {
 				CDF_TRACE(CDF_MODULE_ID_SYS,
-					  CDF_TRACE_LEVEL_ERROR,
-					  "%s: Invalid hHal", __func__);
+					CDF_TRACE_LEVEL_ERROR,
+					"%s: Invalid hHal", __func__);
 			} else {
-				cdf_status =
-					sme_stop(hHal,
-						 HAL_STOP_TYPE_SYS_DEEP_SLEEP);
-				CDF_ASSERT(CDF_IS_STATUS_SUCCESS
-						   (cdf_status));
-
-				cdf_status =
-					mac_stop(hHal,
-						 HAL_STOP_TYPE_SYS_DEEP_SLEEP);
-				CDF_ASSERT(CDF_IS_STATUS_SUCCESS
-						   (cdf_status));
+				cdf_status = sme_stop(hHal,
+						HAL_STOP_TYPE_SYS_DEEP_SLEEP);
+				CDF_ASSERT(CDF_IS_STATUS_SUCCESS(cdf_status));
+				cdf_status = mac_stop(hHal,
+						HAL_STOP_TYPE_SYS_DEEP_SLEEP);
+				CDF_ASSERT(CDF_IS_STATUS_SUCCESS(cdf_status));
 
-				((sysResponseCback) pMsg->
-				 callback)((void *)pMsg->bodyptr);
+				((sysResponseCback) pMsg->callback)(
+						(void *)pMsg->bodyptr);
 
 				cdf_status = CDF_STATUS_SUCCESS;
 			}
 			break;
-		}
 
-		/* Process MC thread probe.  Just callback to the */
-		/* function that is in the message. */
 		case SYS_MSG_ID_MC_THR_PROBE:
-		{
-			CDF_TRACE(CDF_MODULE_ID_SYS,
-				  CDF_TRACE_LEVEL_ERROR,
-				  " Received SYS_MSG_ID_MC_THR_PROBE message msgType = %d [0x%08x]",
-				  pMsg->type, pMsg->type);
+			/*
+			 * Process MC thread probe.  Just callback to the
+			 * function that is in the message.
+			 */
+			CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
+				"Rx SYS_MSG_ID_MC_THR_PROBE msgType=%d[0x%08x]",
+				pMsg->type, pMsg->type);
 			break;
-		}
 
 		case SYS_MSG_ID_MC_TIMER:
-		{
-			cdf_mc_timer_callback_t timerCB =
-				pMsg->callback;
-
-			if (NULL != timerCB) {
+			timerCB = pMsg->callback;
+			if (NULL != timerCB)
 				timerCB(pMsg->bodyptr);
-			}
 			break;
-		}
+
 		case SYS_MSG_ID_FTM_RSP:
-		{
-			tpAniSirGlobal mac_ctx = NULL;
 			hHal = cds_get_context(CDF_MODULE_ID_PE);
 			if (NULL == hHal) {
 				CDF_TRACE(CDF_MODULE_ID_SYS,
-					  CDF_TRACE_LEVEL_ERROR,
-					  FL("Invalid hal"));
+						CDF_TRACE_LEVEL_ERROR,
+						FL("Invalid hal"));
 				cdf_mem_free(pMsg->bodyptr);
 				break;
 			}
 			mac_ctx = PMAC_STRUCT(hHal);
 			if (NULL == mac_ctx) {
 				CDF_TRACE(CDF_MODULE_ID_SYS,
-					  CDF_TRACE_LEVEL_ERROR,
-					  FL("Invalid mac context"));
+						CDF_TRACE_LEVEL_ERROR,
+						FL("Invalid mac context"));
 				cdf_mem_free(pMsg->bodyptr);
 				break;
 			}
 			if (NULL == mac_ctx->ftm_msg_processor_callback) {
 				CDF_TRACE(CDF_MODULE_ID_SYS,
-					  CDF_TRACE_LEVEL_ERROR,
-					  FL("callback pointer is NULL"));
+						CDF_TRACE_LEVEL_ERROR,
+						FL("callback pointer is NULL"));
 				cdf_mem_free(pMsg->bodyptr);
 				break;
 			}
 			mac_ctx->ftm_msg_processor_callback(
-							(void *)pMsg->bodyptr);
+					(void *)pMsg->bodyptr);
 			cdf_mem_free(pMsg->bodyptr);
 			break;
-		}
 
 		default:
-		{
-			CDF_TRACE(CDF_MODULE_ID_SYS,
-				  CDF_TRACE_LEVEL_ERROR,
-				  "Unknown message type in sys_mc_process_msg() msgType= %d [0x%08x]",
-				  pMsg->type, pMsg->type);
+			CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
+				"Unknown message type msgType= %d [0x%08x]",
+				pMsg->type, pMsg->type);
 			break;
-		}
-
-		} /* end switch on message type */
-
-	} /* end if cookie set */
-	else {
-		/* Process all 'legacy' messages */
-		switch (pMsg->type) {
-
-		default:
-		{
-			CDF_ASSERT(0);
-
-			CDF_TRACE(CDF_MODULE_ID_SYS,
-				  CDF_TRACE_LEVEL_ERROR,
-				  "Received SYS message cookie with unidentified "
-				  "MC message type= %d [0x%08X]",
-				  pMsg->type, pMsg->type);
 
-			cdf_status = CDF_STATUS_E_BADMSG;
-			if (pMsg->bodyptr)
-				cdf_mem_free(pMsg->bodyptr);
-			break;
 		}
-		} /* end switch on pMsg->type */
-	} /* end else */
+	} else {
+		CDF_TRACE(CDF_MODULE_ID_SYS,
+				CDF_TRACE_LEVEL_ERROR,
+				"Rx SYS unknown MC msgtype= %d [0x%08X]",
+				pMsg->type, pMsg->type);
+		CDF_ASSERT(0);
+		cdf_status = CDF_STATUS_E_BADMSG;
 
+		if (pMsg->bodyptr)
+			cdf_mem_free(pMsg->bodyptr);
+	}
 	return (cdf_status);
 }
 
-
-void sys_process_mmh_msg(tpAniSirGlobal pMac, tSirMsgQ *pMsg) {
+/**
+ * sys_process_mmh_msg() - this api to process mmh message
+ * @pMac: pointer to mac context
+ * @pMsg: pointer to message
+ *
+ * This API is used to process mmh message
+ *
+ * Return: none
+ */
+void sys_process_mmh_msg(tpAniSirGlobal pMac, tSirMsgQ *pMsg)
+{
 	CDS_MQ_ID targetMQ = CDS_MQ_ID_SYS;
-/*-------------------------------------------------------------------------*/
-	/*
-	** The body of this pMsg is a tSirMbMsg
-	** Contrary to Gen4, we cannot free it here!
-	** It is up to the callee to free it
-	*/
 
+	/*
+	 * The body of this pMsg is a tSirMbMsg
+	 * Contrary to previous generation, we cannot free it here!
+	 * It is up to the callee to free it
+	 */
 	if (NULL == pMsg) {
 		CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
-			  "NULL Message Pointer");
+				"NULL Message Pointer");
 		CDF_ASSERT(0);
 		return;
 	}
 
 	switch (pMsg->type) {
 	/*
-	** Following messages are routed to SYS
-	*/
+	 * Following messages are routed to SYS
+	 */
 	case WNI_CFG_DNLD_REQ:
 	case WNI_CFG_DNLD_CNF:
-	{
 		/* Forward this message to the SYS module */
 		targetMQ = CDS_MQ_ID_SYS;
-
 		CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
-			  "Handling for the Message ID %d is removed in SYS\r\n",
-			  pMsg->type);
-
+			"Handling for the Message ID %d is removed in SYS",
+			pMsg->type);
 		CDF_ASSERT(0);
 		break;
-	}
 
-	/*
-	** Following messages are routed to HAL
-	*/
+		/*
+		 * Following messages are routed to HAL
+		 */
 	case WNI_CFG_DNLD_RSP:
-	{
 		/* Forward this message to the HAL module */
 		targetMQ = CDS_MQ_ID_WMA;
-
 		CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
-			  "Handling for the Message ID %d is removed as there is no HAL \r\n",
-			  pMsg->type);
+			"Handling for the Message ID %d is removed as no HAL",
+			pMsg->type);
 
 		CDF_ASSERT(0);
 		break;
-	}
 
 	case WNI_CFG_GET_REQ:
 	case WNI_CFG_SET_REQ:
 	case WNI_CFG_SET_REQ_NO_RSP:
 	case eWNI_SME_SYS_READY_IND:
-	{
 		/* Forward this message to the PE module */
 		targetMQ = CDS_MQ_ID_PE;
 		break;
-	}
 
 	case WNI_CFG_GET_RSP:
 	case WNI_CFG_SET_CNF:
-	{
 		/* Forward this message to the SME module */
 		targetMQ = CDS_MQ_ID_SME;
 		break;
-	}
 
 	default:
-	{
-
 		if ((pMsg->type >= eWNI_SME_MSG_TYPES_BEGIN)
-		    && (pMsg->type <= eWNI_SME_MSG_TYPES_END)) {
+				&& (pMsg->type <= eWNI_SME_MSG_TYPES_END)) {
 			targetMQ = CDS_MQ_ID_SME;
 			break;
 		}
 
 		CDF_TRACE(CDF_MODULE_ID_SYS, CDF_TRACE_LEVEL_ERROR,
-			  "Message of ID %d is not yet handled by SYS\r\n",
-			  pMsg->type);
-
+			"Message of ID %d is not yet handled by SYS",
+			pMsg->type);
 		CDF_ASSERT(0);
 	}
 
-	}
-
 	/*
-	** Post now the message to the appropriate module for handling
-	*/
-	if (CDF_STATUS_SUCCESS !=
-	    cds_mq_post_message(targetMQ, (cds_msg_t *) pMsg)) {
-		/* Caller doesn't allocate memory for the pMsg. It allocate memory for bodyptr */
-		/* free the mem and return */
-		if (pMsg->bodyptr) {
+	 * Post now the message to the appropriate module for handling
+	 */
+	if (CDF_STATUS_SUCCESS != cds_mq_post_message(targetMQ,
+					(cds_msg_t *) pMsg)) {
+		/*
+		 * Caller doesn't allocate memory for the pMsg.
+		 * It allocate memory for bodyptr free the mem and return
+		 */
+		if (pMsg->bodyptr)
 			cdf_mem_free(pMsg->bodyptr);
-		}
 	}
 
-} /* sys_process_mmh_msg() */
+}
 
+/**
+ * wlan_sys_probe() - API to post MC thread probe
+ *
+ * This API will be used send probe message
+ *
+ * Return: none
+ */
 void wlan_sys_probe(void)
 {
 	cds_msg_t cds_message;
@@ -364,8 +364,5 @@ void wlan_sys_probe(void)
 	cds_message.reserved = SYS_MSG_COOKIE;
 	cds_message.type = SYS_MSG_ID_MC_THR_PROBE;
 	cds_message.bodyptr = NULL;
-
 	cds_mq_post_message(CDS_MQ_ID_SYS, &cds_message);
-
-	return;
 }