--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/TWD/MacServices/ScanSrvSM.c Tue Jun 29 12:34:26 2010 +0100
@@ -0,0 +1,588 @@
+/*
+ * ScanSrvSM.c
+ *
+ * Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.
+ * All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 or BSD License which accompanies
+ * this distribution. The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ * * Neither the name Texas Instruments nor the names of its
+ * contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/** \file ScanSrvSM.c
+ * \brief This file include the scan SRV Sm implementation
+ * \author Ronen Kalish
+ * \date 10-Jan-2005
+ */
+
+#define __FILE_ID__ FILE_ID_116
+#include "ScanSrvSM.h"
+#include "ScanSrv.h"
+#include "report.h"
+#include "timer.h"
+#include "MacServices_api.h"
+#include "PowerSrv_API.h"
+#include "CmdBld.h"
+
+
+/********************************************************************************/
+/* Internal functions prototypes. */
+/********************************************************************************/
+
+static TI_STATUS scanSRVSM_PsFailWhileScanning( TI_HANDLE hScanSrv );
+static TI_STATUS actionNop( TI_HANDLE hScanSrv );
+static TI_STATUS actionUnexpected( TI_HANDLE hScanSrv );
+
+
+/********************************************************************************/
+/* Interface functions Implementation. */
+/********************************************************************************/
+
+
+/**
+ * \author Ronen Kalish\n
+ * \date 10-Jan-2005\n
+ * \brief Initialize the scan SRV SM.
+ *
+ * Function Scope \e Public.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+TI_STATUS scanSRVSM_init( TI_HANDLE hScanSrv )
+{
+ scanSRV_t* pScanSRV = (scanSRV_t*)hScanSrv;
+
+ fsm_actionCell_t smMatrix[ SCAN_SRV_NUM_OF_STATES ][ SCAN_SRV_NUM_OF_EVENTS ] =
+ {
+ /* next state and actions for IDLE state */
+ {
+ {SCAN_SRV_STATE_PS_WAIT, scanSRVSM_requestPS}, /*"REQUEST_PS",*/
+ {SCAN_SRV_STATE_IDLE, actionUnexpected}, /*"PS_FAIL",*/
+ {SCAN_SRV_STATE_SCANNING, scanSRVSM_startActualScan}, /*"PS_SUCCESS", */
+ {SCAN_SRV_STATE_IDLE, actionUnexpected}, /*"PS_PEND",*/
+ {SCAN_SRV_STATE_IDLE, actionUnexpected}, /*"STOP_SCAN"*/
+ {SCAN_SRV_STATE_IDLE, actionNop}, /*"FW_RESET"*/
+ {SCAN_SRV_STATE_IDLE, actionUnexpected}, /*"TIMER_EXPIRED"*/
+ {SCAN_SRV_STATE_IDLE, actionUnexpected}, /*"SCAN_COMPLETE"*/
+ },
+
+
+ /* next state and actions for PS_WAIT state */
+ {
+ {SCAN_SRV_STATE_PS_WAIT, actionUnexpected}, /*"REQUEST_PS",*/
+ {SCAN_SRV_STATE_PS_EXIT, scanSRVSM_releasePS}, /*"PS_FAIL",*/
+ {SCAN_SRV_STATE_SCANNING, scanSRVSM_startActualScan}, /*"PS_SUCCESS", */
+ {SCAN_SRV_STATE_PS_WAIT, actionNop}, /*"PS_PEND",*/
+ {SCAN_SRV_STATE_STOPPING, actionNop}, /*"STOP_SCAN"*/
+ {SCAN_SRV_STATE_IDLE, scanSRVSM_handleRecovery}, /*"FW_RESET"*/
+ {SCAN_SRV_STATE_PS_WAIT, actionUnexpected}, /*"TIMER_EXPIRED"*/
+ {SCAN_SRV_STATE_PS_WAIT, actionUnexpected}, /*"SCAN_COMPLETE"*/
+ },
+
+ /* next state and actions for SCANNING state */
+ {
+ {SCAN_SRV_STATE_SCANNING, actionUnexpected}, /*"REQUEST_PS",*/
+ {SCAN_SRV_STATE_SCANNING, scanSRVSM_PsFailWhileScanning}, /*"PS_FAIL",*/
+ {SCAN_SRV_STATE_SCANNING, actionUnexpected}, /*"PS_SUCCESS", */
+ {SCAN_SRV_STATE_SCANNING, actionUnexpected}, /*"PS_PEND",*/
+ {SCAN_SRV_STATE_STOPPING, actionNop }, /*"STOP_SCAN"*/
+ {SCAN_SRV_STATE_IDLE, scanSRVSM_handleRecovery}, /*"FW_RESET"*/
+ {SCAN_SRV_STATE_SCANNING, scanSRVSM_handleTimerExpiry}, /*"TIMER_EXPIRED"*/
+ {SCAN_SRV_STATE_PS_EXIT, scanSRVSM_releasePS}, /*"SCAN_COMPLETE"*/
+
+ },
+
+ /* next state and actions for STOPPING state */
+ {
+ {SCAN_SRV_STATE_STOPPING, actionUnexpected}, /*"REQUEST_PS",*/
+ {SCAN_SRV_STATE_PS_EXIT, scanSRVSM_releasePS}, /*"PS_FAIL",*/
+ {SCAN_SRV_STATE_PS_EXIT, scanSRVSM_releasePS}, /*"PS_SUCCESS", */
+ {SCAN_SRV_STATE_STOPPING, actionUnexpected}, /*"PS_PEND",*/
+ {SCAN_SRV_STATE_STOPPING, actionNop }, /*"STOP_SCAN"*/
+ {SCAN_SRV_STATE_IDLE, scanSRVSM_handleRecovery}, /*"FW_RESET"*/
+ {SCAN_SRV_STATE_STOPPING, scanSRVSM_handleTimerExpiry}, /*"TIMER_EXPIRED"*/
+ {SCAN_SRV_STATE_PS_EXIT, scanSRVSM_releasePS} /*"SCAN_COMPLETE"*/
+
+ } ,
+
+ /* next state and actions for PS_EXIT state */
+ {
+ {SCAN_SRV_STATE_PS_EXIT, actionUnexpected}, /*"REQUEST_PS",*/
+ {SCAN_SRV_STATE_IDLE, scanSRVSM_notifyScanComplete}, /*"PS_FAIL",*/
+ {SCAN_SRV_STATE_IDLE, scanSRVSM_notifyScanComplete}, /*"PS_SUCCESS", */
+ {SCAN_SRV_STATE_PS_EXIT, actionNop}, /*"PS_PEND",*/
+ {SCAN_SRV_STATE_PS_EXIT, actionNop}, /*"STOP_SCAN"*/
+ {SCAN_SRV_STATE_IDLE, scanSRVSM_handleRecovery}, /*"FW_RESET"*/
+ {SCAN_SRV_STATE_PS_EXIT, actionUnexpected}, /*"TIMER_EXPIRED"*/
+ {SCAN_SRV_STATE_PS_EXIT, actionUnexpected}, /*"SCAN_COMPLETE"*/
+ }
+ };
+
+ /* initialize current state */
+ pScanSRV->SMState = SCAN_SRV_STATE_IDLE;
+
+ /* configure the state machine */
+ return fsm_Config( pScanSRV->SM, (fsm_Matrix_t)smMatrix,
+ (TI_UINT8)SCAN_SRV_NUM_OF_STATES, (TI_UINT8)SCAN_SRV_NUM_OF_EVENTS,
+ (fsm_eventActivation_t)scanSRVSM_SMEvent, pScanSRV->hOS );
+}
+
+/**
+ * \author Ronen Kalish\n
+ * \date 10-Jan-2005\n
+ * \brief Processes an event.
+ *
+ * Function Scope \e Public.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \param currentState - the current scan SRV SM state.\n
+ * \param event - the event to handle.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+TI_STATUS scanSRVSM_SMEvent( TI_HANDLE hScanSrv, scan_SRVSMStates_e* currentState,
+ scan_SRVSMEvents_e event )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t *)hScanSrv;
+ TI_STATUS status = TI_OK;
+ TI_UINT8 nextState;
+
+ /* obtain the next state */
+ status = fsm_GetNextState( pScanSRV->SM, *(TI_UINT8*)currentState, (TI_UINT8)event, &nextState );
+ if ( status != TI_OK )
+ {
+ TRACE2(pScanSRV->hReport, REPORT_SEVERITY_ERROR, "Failed getting scan SRV next state. state = %d event = %d\n", (TI_UINT8)*currentState,(TI_UINT8)event);
+ return TI_NOK;
+ }
+
+ TRACE3(pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "scanSRVSM_SMEvent: <currentState = %d, event = %d> --> nextState = %d\n", *currentState, event, nextState);
+
+ /* move */
+ return fsm_Event( pScanSRV->SM, (TI_UINT8*)currentState, (TI_UINT8)event, hScanSrv );
+}
+
+/**
+ * \author Ronen Kalish\n
+ * \date 10-Jan-2005\n
+ * \brief Request to enter driver mode from the power manager module.\n
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+TI_STATUS scanSRVSM_requestPS( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+ TI_STATUS psStatus;
+
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "Requesting Driver mode from PowerSave Srv.\n");
+
+ psStatus = powerSrv_ReservePS( pScanSRV->hPowerSrv,
+ pScanSRV->psRequest,
+ pScanSRV->bSendNullData,
+ hScanSrv,
+ MacServices_scanSRV_powerSaveCB);
+
+ switch (psStatus)
+ {
+ /* if successful */
+ case POWER_SAVE_802_11_IS_CURRENT:
+ /* send a PS_SUCCESS event */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "Driver mode successful, continuing to scan.\n");
+ return scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_PS_SUCCESS );
+
+ /* if pending */
+ case POWER_SAVE_802_11_PENDING:
+ case TI_OK:
+ /* send a PS_PEND event */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "Driver mode pending, Waiting.\n");
+ return scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_PS_PEND );
+
+ /* if not successful */
+ default:
+
+ /* mark not to exit from driver mode (no entry was performed) */
+ pScanSRV->bExitFromDriverMode = TI_FALSE;
+
+ /* if still wishing to scan */
+ if ( pScanSRV->bScanOnDriverModeFailure )
+ {
+ /* send a PS_SUCCESS event - scan will proceed regardless of the error */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "Driver mode failed, continuing to scan.\n");
+ scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_PS_SUCCESS );
+ }
+ /* otherwise, return */
+ else
+ {
+ /* mark the return code */
+ pScanSRV->returnStatus = TI_NOK;
+ /* send a PS_FAIL event */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "Driver mode failed, aborting scan.\n");
+ scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_PS_FAIL );
+ }
+ break;
+ }
+
+ return TI_OK;
+}
+
+/**
+ * \date 6-Oct-2005\n
+ * \brief Request to release PS mode from the PowerSRV , and wait for answer.\n\n
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+
+TI_STATUS scanSRVSM_releasePS( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+ TI_STATUS psStatus;
+
+ /* stop timer */
+ if ( TI_TRUE == pScanSRV->bTimerRunning )
+ {
+ tmr_StopTimer (pScanSRV->hScanSrvTimer);
+ pScanSRV->bTimerRunning = TI_FALSE;
+ }
+
+ /* if exit from driver mode requested, do so */
+ if ( TI_TRUE == pScanSRV->bExitFromDriverMode )
+ {
+ /* here we need to get an answer if we succeeded to exit driver mode */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, ": Releasing Driver mode from Power Srv.\n");
+
+ psStatus = powerSrv_ReleasePS( pScanSRV->hPowerSrv,
+ pScanSRV->bSendNullData,
+ hScanSrv,
+ MacServices_scanSRV_powerSaveCB);
+
+
+ }
+ else /* no need to exit PS - send PS_SUCCESS */
+ {
+ return scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_PS_SUCCESS );
+ }
+
+
+ switch (psStatus)
+ {
+ /* if successful */
+ case POWER_SAVE_802_11_IS_CURRENT:
+ /* send a PS_SUCCESS event */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, ": Driver mode exit successful, scan done.\n");
+ return scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_PS_SUCCESS );
+
+ /* if pending */
+ case POWER_SAVE_802_11_PENDING:
+ case TI_OK:
+ /* stay in the PS_EXIT state */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, ": Driver mode exit pending, Waiting.\n");
+ break;
+
+ /* if not successful */
+ default:
+
+ /* send a PS_FAIL event */
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, ": Driver mode exit failed, scan done.");
+ return scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_PS_FAIL );
+
+ }
+
+ return TI_OK;
+}
+
+/**
+ * \author Ronen Kalish\n
+ * \date 10-Jan-2005\n
+ * \brief Send the scan command to the firmware.\n
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+TI_STATUS scanSRVSM_startActualScan( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+
+
+ /* start the timer */
+ pScanSRV->bTimerRunning = TI_TRUE;
+ tmr_StartTimer (pScanSRV->hScanSrvTimer,
+ MacServices_scanSRV_scanTimerExpired,
+ (TI_HANDLE)pScanSRV,
+ MacServices_scanSRVcalculateScanTimeout (hScanSrv, pScanSRV->scanParams, !pScanSRV->bDtimOverlapping),
+ TI_FALSE);
+
+ TRACE1( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "Sending scan , type: %x to HAL.\n",pScanSRV->scanParams->scanType);
+
+ /* start the scan */
+ /* we send the MacServices_scanSRVCommandMailBoxCB to be called when this command is recieved */
+ if ( SCAN_TYPE_SPS == pScanSRV->scanParams->scanType )
+ {
+ pScanSRV->returnStatus = cmdBld_CmdStartSPSScan (pScanSRV->hCmdBld, pScanSRV->scanParams, pScanSRV->eScanTag,
+ (void *)MacServices_scanSRVCommandMailBoxCB, hScanSrv);
+ }
+ else
+ {
+ pScanSRV->returnStatus = cmdBld_CmdStartScan (pScanSRV->hCmdBld, pScanSRV->scanParams, pScanSRV->eScanTag,
+ pScanSRV->bHighPriority , (void *)MacServices_scanSRVCommandMailBoxCB,
+ hScanSrv);
+ }
+ /* if scan request failed */
+ if ( TI_OK != pScanSRV->returnStatus )
+ {
+ TRACE1( pScanSRV->hReport, REPORT_SEVERITY_ERROR, "HAL returned code %d for scan request, quitting scan.\n", pScanSRV->returnStatus);
+
+ /* send a scan complete event. This will do all necessary clean-up (timer, power manager, notifying scan complete) */
+ scanSRVSM_SMEvent( hScanSrv, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_SCAN_COMPLETE );
+ }
+
+ return TI_OK;
+}
+
+
+/**
+ * \author Ronen Kalish\n
+ * \date 10-Jan-2005\n
+ * \brief Notifies scan complete to upper layer.\n
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+TI_STATUS scanSRVSM_notifyScanComplete( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+ TCmdResponseCb CB_Func;
+ TI_HANDLE CB_Handle;
+ TI_STATUS PSMode;
+
+ /* call the scan complete CB - only if not currently running from within a request context! */
+ if ( TI_FALSE == pScanSRV->bInRequest )
+ {
+ /* this means that ResponseFunc was not called yet , so we call it before ScanComplete */
+ if (pScanSRV->commandResponseFunc)
+ {
+ /* must erase CB function before calling it to enable nested scans */
+ CB_Func = pScanSRV->commandResponseFunc;
+ CB_Handle = pScanSRV->commandResponseObj;
+
+ pScanSRV->commandResponseFunc = NULL;
+ pScanSRV->commandResponseObj = NULL;
+
+ /* if we reached here than response status was TI_OK */
+ CB_Func(CB_Handle, TI_OK);
+
+ }
+ /* if function returns TI_TRUE than we are in PS mode , else - not */
+ PSMode = powerSrv_getPsStatus(pScanSRV->hPowerSrv) ? POWER_SAVE_802_11_SUCCESS : POWER_SAVE_802_11_FAIL;
+
+ TRACE2( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "scanSRVSM_notifyScanComplete status = 0x%x PSMode = 0x%x\n",pScanSRV->returnStatus,PSMode);
+
+
+ TRACE0(pScanSRV->hReport, REPORT_SEVERITY_INFORMATION , "scanSRVSM_notifyScanComplete: call TWD_OWN_EVENT_SCAN_CMPLT CB. In std MacServices_scanSRV_scanCompleteCB()\n");
+
+ pScanSRV->scanCompleteNotificationFunc( pScanSRV->scanCompleteNotificationObj,
+ pScanSRV->eScanTag,
+ pScanSRV->uResultCount,
+ pScanSRV->SPSScanResult,
+ pScanSRV->bTSFError,
+ pScanSRV->returnStatus,
+ PSMode );
+ }
+
+ return TI_OK;
+}
+
+
+/**
+ * \author Ronen Kalish\n
+ * \date 10-Jan-2005\n
+ * \brief Handles a timer expiry event - starts a recovery process.
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+TI_STATUS scanSRVSM_handleTimerExpiry( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+
+ /*
+ * No scan complete bug workaround:
+ * Only after a consecutive configurable number of no scan complete events the recovery trigger
+ * will be issued. This is done as a workaround for a bug in the FW where if a channel is too
+ * loaded it wouldn't be able to send a probe request and will get stuck waiting for this channel
+ */
+
+ pScanSRV->currentNumberOfConsecutiveNoScanCompleteEvents++;
+
+ if ( pScanSRV->currentNumberOfConsecutiveNoScanCompleteEvents >=
+ pScanSRV->numberOfNoScanCompleteToRecovery )
+ {
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_ERROR, ": Timer expired. Starting recovery process.\n");
+
+ pScanSRV->currentNumberOfConsecutiveNoScanCompleteEvents = 0;
+
+ /* mark the return status */
+ pScanSRV->returnStatus = TI_NOK;
+
+ /* mark that the timer is no longer running */
+ pScanSRV->bTimerRunning = TI_FALSE;
+
+ /* call the recovery module */
+ pScanSRV->failureEventFunc(pScanSRV->failureEventObj ,NO_SCAN_COMPLETE_FAILURE);
+ }
+ else
+ {
+ TRACE2( pScanSRV->hReport, REPORT_SEVERITY_ERROR, ": Timer expired. consecutive failures:%d, threshold:%d, still not calling recovery.\n", pScanSRV->currentNumberOfConsecutiveNoScanCompleteEvents, pScanSRV->numberOfNoScanCompleteToRecovery);
+
+ /* send a top scan command, which can help solving the FW bug described above */
+ if ( TI_FALSE == pScanSRV->bSPSScan )
+ {
+ cmdBld_CmdStopScan (pScanSRV->hCmdBld, pScanSRV->eScanTag, NULL, NULL);
+ }
+ else
+ {
+ cmdBld_CmdStopSPSScan (pScanSRV->hCmdBld, pScanSRV->eScanTag, NULL, NULL);
+ }
+
+ /* imitate a scan complete event to the SM */
+ pScanSRV->bTSFError = TI_FALSE;
+ pScanSRV->SPSScanResult = 0xffff;
+ scanSRVSM_SMEvent( (TI_HANDLE)pScanSRV, (scan_SRVSMStates_e*)&pScanSRV->SMState, SCAN_SRV_EVENT_SCAN_COMPLETE );
+ }
+
+ return TI_OK;
+}
+
+/**
+ * \author Shirit Brook\n
+ * \date 10-Jan-2005\n
+ * \brief Handles PS Fail event while in Scanning - Indicate not to Exit PS.
+ * This event can be reached when Roaming is invoked while in Scanning state.
+ * The PM Module is stopped and generates PS Fail to all its clients.
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+static TI_STATUS scanSRVSM_PsFailWhileScanning( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "scanSRVSM_PsFailWhileScanning. Indicate not to Enter PS.\n");
+
+ pScanSRV->bExitFromDriverMode = TI_FALSE;
+
+ return TI_OK;
+}
+
+
+/**
+ * \author Ronen Kalish\n
+ * \date 17-Jan-2005\n
+ * \brief Handles a FW reset event (one that was detected outside the scan SRV) by stopping the timer.
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return TI_OK if successful, TI_NOK otherwise.\n
+ */
+TI_STATUS scanSRVSM_handleRecovery( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+
+ TRACE0( pScanSRV->hReport, REPORT_SEVERITY_INFORMATION, "FW reset event from outside.\n");
+
+ /* The Power Manager is responsible to exit PS mode in recovery. Also, the scan CB is not called -
+ The SCR is responsible to notify scan concentrator of the event (which actually notifies scan SRV */
+
+ /* if timer is running - stop it */
+ if ( TI_TRUE == pScanSRV->bTimerRunning )
+ {
+ tmr_StopTimer (pScanSRV->hScanSrvTimer);
+ pScanSRV->bTimerRunning = TI_FALSE;
+ }
+ else
+ {
+ /* shouldn't happen - only called if timer is supposedly running */
+ TRACE1( pScanSRV->hReport, REPORT_SEVERITY_WARNING, "SM: External FW reset in state %d and timer is not running?", pScanSRV->SMState);
+ }
+
+ return TI_OK;
+}
+
+/**
+ * \author Ronen Kalish\n
+ * \date 11-Jan-2005\n
+ * \brief Handles an unexpected event.\n
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return always TI_OK.\n
+ */
+static TI_STATUS actionUnexpected( TI_HANDLE hScanSrv )
+{
+ scanSRV_t *pScanSRV = (scanSRV_t*)hScanSrv;
+
+ TRACE1( pScanSRV->hReport, REPORT_SEVERITY_ERROR, "Scan SRV state machine error, unexpected Event, state=%d\n\n", pScanSRV->SMState);
+
+ if ( pScanSRV->bTimerRunning )
+ {
+ tmr_StopTimer (pScanSRV->hScanSrvTimer);
+ pScanSRV->bTimerRunning = TI_FALSE;
+ }
+
+ /* we must clean the old command response CB since they are no longer relevant
+ since the state machine may be corrupted */
+ pScanSRV->commandResponseFunc = NULL;
+ pScanSRV->commandResponseObj = NULL;
+
+ /* indicate the unexpected event in the return status */
+ pScanSRV->returnStatus = TI_NOK;
+
+ return TI_OK;
+}
+
+/**
+ * \author Ronen Kalish\n
+ * \date 10-Jan-2005\n
+ * \brief Handles an event that doesn't require any action.\n
+ *
+ * Function Scope \e Private.\n
+ * \param hScanSrv - handle to the scan SRV object.\n
+ * \return always TI_OK.\n
+ */
+static TI_STATUS actionNop( TI_HANDLE hScanSrv )
+{
+ return TI_OK;
+}
+
+