0
|
1 |
/*
|
|
2 |
* ScanSrvSM.h
|
|
3 |
*
|
|
4 |
* Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.
|
|
5 |
* All rights reserved.
|
|
6 |
*
|
|
7 |
* This program and the accompanying materials are made available under the
|
|
8 |
* terms of the Eclipse Public License v1.0 or BSD License which accompanies
|
|
9 |
* this distribution. The Eclipse Public License is available at
|
|
10 |
* http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.
|
|
11 |
*
|
|
12 |
* Redistribution and use in source and binary forms, with or without
|
|
13 |
* modification, are permitted provided that the following conditions
|
|
14 |
* are met:
|
|
15 |
*
|
|
16 |
* * Redistributions of source code must retain the above copyright
|
|
17 |
* notice, this list of conditions and the following disclaimer.
|
|
18 |
* * Redistributions in binary form must reproduce the above copyright
|
|
19 |
* notice, this list of conditions and the following disclaimer in
|
|
20 |
* the documentation and/or other materials provided with the
|
|
21 |
* distribution.
|
|
22 |
* * Neither the name Texas Instruments nor the names of its
|
|
23 |
* contributors may be used to endorse or promote products derived
|
|
24 |
* from this software without specific prior written permission.
|
|
25 |
*
|
|
26 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
27 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
28 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
29 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
30 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
31 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
32 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
33 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
34 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
35 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
36 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
37 |
*/
|
|
38 |
|
|
39 |
/** \file ScanSrvSM.h
|
|
40 |
* \brief This file include definitions for the scan SRV SM module.
|
|
41 |
* \author Ronen Kalish
|
|
42 |
* \date 10-Jan-2005
|
|
43 |
*/
|
|
44 |
|
|
45 |
#ifndef __SCANSRVSM_H__
|
|
46 |
#define __SCANSRVSM_H__
|
|
47 |
|
|
48 |
#include "fsm.h"
|
|
49 |
|
|
50 |
/*
|
|
51 |
***********************************************************************
|
|
52 |
* Constant definitions.
|
|
53 |
***********************************************************************
|
|
54 |
*/
|
|
55 |
|
|
56 |
/*
|
|
57 |
***********************************************************************
|
|
58 |
* Enums.
|
|
59 |
***********************************************************************
|
|
60 |
*/
|
|
61 |
|
|
62 |
/** \enum scan_SRVSMEvents_e
|
|
63 |
* \brief enumerates the different scan SRV SM events
|
|
64 |
*/
|
|
65 |
typedef enum
|
|
66 |
{
|
|
67 |
SCAN_SRV_EVENT_REQUEST_PS = 0,
|
|
68 |
SCAN_SRV_EVENT_PS_FAIL,
|
|
69 |
SCAN_SRV_EVENT_PS_SUCCESS,
|
|
70 |
SCAN_SRV_EVENT_PS_PEND,
|
|
71 |
SCAN_SRV_EVENT_STOP_SCAN,
|
|
72 |
SCAN_SRV_EVENT_FW_RESET,
|
|
73 |
SCAN_SRV_EVENT_TIMER_EXPIRED,
|
|
74 |
SCAN_SRV_EVENT_SCAN_COMPLETE,
|
|
75 |
SCAN_SRV_NUM_OF_EVENTS
|
|
76 |
} scan_SRVSMEvents_e;
|
|
77 |
|
|
78 |
/** \enum scan_SRVSMStates_e
|
|
79 |
* \brief enumerates the different scan SRV SM states
|
|
80 |
*/
|
|
81 |
typedef enum
|
|
82 |
{
|
|
83 |
SCAN_SRV_STATE_IDLE = 0,
|
|
84 |
SCAN_SRV_STATE_PS_WAIT,
|
|
85 |
SCAN_SRV_STATE_SCANNING,
|
|
86 |
SCAN_SRV_STATE_STOPPING,
|
|
87 |
SCAN_SRV_STATE_PS_EXIT,
|
|
88 |
SCAN_SRV_NUM_OF_STATES
|
|
89 |
} scan_SRVSMStates_e;
|
|
90 |
|
|
91 |
/*
|
|
92 |
***********************************************************************
|
|
93 |
* Typedefs.
|
|
94 |
***********************************************************************
|
|
95 |
*/
|
|
96 |
|
|
97 |
/*
|
|
98 |
***********************************************************************
|
|
99 |
* Structure definitions.
|
|
100 |
***********************************************************************
|
|
101 |
*/
|
|
102 |
|
|
103 |
/*
|
|
104 |
***********************************************************************
|
|
105 |
* External data definitions.
|
|
106 |
***********************************************************************
|
|
107 |
*/
|
|
108 |
|
|
109 |
/*
|
|
110 |
***********************************************************************
|
|
111 |
* External functions definitions
|
|
112 |
***********************************************************************
|
|
113 |
*/
|
|
114 |
|
|
115 |
/**
|
|
116 |
* \author Ronen Kalish\n
|
|
117 |
* \date 10-Jan-2005\n
|
|
118 |
* \brief Initialize the scan SRV SM.
|
|
119 |
*
|
|
120 |
* Function Scope \e Public.\n
|
|
121 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
122 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
123 |
*/
|
|
124 |
TI_STATUS scanSRVSM_init( TI_HANDLE hScanSrv );
|
|
125 |
|
|
126 |
/**
|
|
127 |
* \author Ronen Kalish\n
|
|
128 |
* \date 10-Jan-2005\n
|
|
129 |
* \brief Processes an event.
|
|
130 |
*
|
|
131 |
* Function Scope \e Public.\n
|
|
132 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
133 |
* \param currentState - the current scan SRV SM state.\n
|
|
134 |
* \param event - the event to handle.\n
|
|
135 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
136 |
*/
|
|
137 |
TI_STATUS scanSRVSM_SMEvent( TI_HANDLE hScanSrv, scan_SRVSMStates_e* currentState,
|
|
138 |
scan_SRVSMEvents_e event );
|
|
139 |
|
|
140 |
/**
|
|
141 |
* \author Ronen Kalish\n
|
|
142 |
* \date 10-Jan-2005\n
|
|
143 |
* \brief Request to enter driver mode from the power manager module.\n
|
|
144 |
*
|
|
145 |
* Function Scope \e Private.\n
|
|
146 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
147 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
148 |
*/
|
|
149 |
TI_STATUS scanSRVSM_requestPS( TI_HANDLE hScanSrv );
|
|
150 |
|
|
151 |
/**
|
|
152 |
* \date 6-Oct-2005\n
|
|
153 |
* \brief Request to release PS mode from the PowerSRV , and wait for answer.\n
|
|
154 |
*
|
|
155 |
* Function Scope \e Private.\n
|
|
156 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
157 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
158 |
*/
|
|
159 |
TI_STATUS scanSRVSM_releasePS( TI_HANDLE hScanSrv );
|
|
160 |
|
|
161 |
/**
|
|
162 |
* \author Ronen Kalish\n
|
|
163 |
* \date 10-Jan-2005\n
|
|
164 |
* \brief Send the scan command to the firmware.\n
|
|
165 |
*
|
|
166 |
* Function Scope \e Private.\n
|
|
167 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
168 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
169 |
*/
|
|
170 |
TI_STATUS scanSRVSM_startActualScan( TI_HANDLE hScanSrv );
|
|
171 |
|
|
172 |
/**
|
|
173 |
* \author Ronen Kalish\n
|
|
174 |
* \date 10-Jan-2005\n
|
|
175 |
* \brief Send a stop scan command to the firmware.\n
|
|
176 |
*
|
|
177 |
* Function Scope \e Private.\n
|
|
178 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
179 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
180 |
*/
|
|
181 |
TI_STATUS scanSRVSM_stopActualScan( TI_HANDLE hScanSrv );
|
|
182 |
|
|
183 |
/**
|
|
184 |
* \author Ronen Kalish\n
|
|
185 |
* \date 10-Jan-2005\n
|
|
186 |
* \brief Notifies scan complete to upper layer.\n
|
|
187 |
*
|
|
188 |
* Function Scope \e Private.\n
|
|
189 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
190 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
191 |
*/
|
|
192 |
TI_STATUS scanSRVSM_notifyScanComplete( TI_HANDLE hScanSrv );
|
|
193 |
|
|
194 |
/**
|
|
195 |
* \author Ronen Kalish\n
|
|
196 |
* \date 10-Jan-2005\n
|
|
197 |
* \brief Handles a timer expiry event - starts a recovery process.
|
|
198 |
*
|
|
199 |
* Function Scope \e Private.\n
|
|
200 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
201 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
202 |
*/
|
|
203 |
TI_STATUS scanSRVSM_handleTimerExpiry( TI_HANDLE hScanSrv );
|
|
204 |
|
|
205 |
/**
|
|
206 |
* \author Ronen Kalish\n
|
|
207 |
* \date 17-Jan-2005\n
|
|
208 |
* \brief Handles a FW reset event (one that was detected outside the scan SRV) by stopping the timer.
|
|
209 |
*
|
|
210 |
* Function Scope \e Private.\n
|
|
211 |
* \param hScanSrv - handle to the scan SRV object.\n
|
|
212 |
* \return TI_OK if successful, TI_NOK otherwise.\n
|
|
213 |
*/
|
|
214 |
TI_STATUS scanSRVSM_handleRecovery( TI_HANDLE hScanSrv );
|
|
215 |
|
|
216 |
#endif /* __SCANSRVSM_H__ */
|