1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* FwEvent_api.h
*
* Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.
* All rights reserved.
*
* 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 FwEvent_api.h
* \brief FwEvent api
*
* \see FwEvent.c
*/
#ifndef _FW_EVENT_API_H
#define _FW_EVENT_API_H
/* Public Function Definitions */
/*
* \brief Create the FwEvent module object
*
* \param hOs - OS module object handle
* \return Handle to the created object
*
* \par Description
* Calling this function creates a FwEvent object
*
* \sa fwEvent_Destroy
*/
TI_HANDLE fwEvent_Create (TI_HANDLE hOs);
/*
* \brief Destroys the FwEvent object
*
* \param hFwEvent - The object to free
* \return TI_OK
*
* \par Description
* Calling this function destroys a FwEvent object
*
* \sa fwEvent_Create
*/
TI_STATUS fwEvent_Destroy (TI_HANDLE hFwEvent);
/*
* \brief Requests the context engine to schedule the driver task
*
* \param hFwEvent - FwEvent Driver handle
* \return void
*
* \par Description
* Called by the FW-Interrupt ISR.
* Requests the context engine to schedule the driver task
* for handling the FW-Events (FwEvent callback).
*
* \sa
*/
void fwEvent_InterruptRequest (TI_HANDLE hFwEvent);
/*
* \brief Config the FwEvent module object
*
* \param hFwEvent - FwEvent Driver handle
* \param hTWD - Handle to TWD module
* \return TI_OK
*
* \par Description
* From hTWD we extract : hOs, hReport, hTwIf, hContext,
* hHealthMonitor, hEventMbox, hCmdMbox, hRxXfer,
* hTxHwQueue, hTxResult
* In this function we also register the FwEvent to the context engine
*
* \sa
*/
TI_STATUS fwEvent_Init (TI_HANDLE hFwEvent, TI_HANDLE hTWD);
/*
* \brief Called by any handler that completed after pending
*
* \param hFwEvent - FwEvent Driver handle
*
* \par Description
*
* Decrement pending handlers counter and if 0 call the SM to complete its process.
*
* \sa
*/
void fwEvent_HandlerCompleted (TI_HANDLE hFwEvent);
/*
* \brief Stop & reset FwEvent (called by the driver stop process)
*
* \param hFwEvent - FwEvent Driver handle
* \return TI_OK
*
* \par Description
*
* \sa
*/
TI_STATUS fwEvent_Stop (TI_HANDLE hFwEvent);
/*
* \brief Translate host to FW time (Usec)
*
* \param hFwEvent - FwEvent Driver handle
* \param uHostTime - The host time in MS to translate
*
* \return FW Time in Usec
*
* \par Description
*
* \sa
*/
TI_UINT32 fwEvent_TranslateToFwTime (TI_HANDLE hFwEvent, TI_UINT32 uHostTime);
/*
* \brief Disable the FwEvent client of the context thread handler
*
* \param hFwEvent - FwEvent Driver handle
* \return void
*
* \par Description
*
* \sa
*/
void fwEvent_DisableInterrupts (TI_HANDLE hFwEvent);
/*
* \brief Enable the FwEvent client of the context thread handler
*
* \param hFwEvent - FwEvent Driver handle
* \return void
*
* \par Description
*
* \sa
*/
void fwEvent_EnableInterrupts (TI_HANDLE hFwEvent);
/*
* \brief Unmask all interrupts, set Rx interrupt bit and call FwEvent_Handle
*
* \param hFwEvent - FwEvent Driver handle
* \return void
*
* \par Description
* Called when driver Start or recovery process is completed.
* Unmask all interrupts, set Rx interrupt bit and call FwEvent_Handle
* (in case we missed an Rx interrupt in a recovery process).
*
* \sa
*/
void fwEvent_EnableExternalEvents(TI_HANDLE hFwEvent);
/*
* \brief Unmask only cmd-cmplt and events interrupts (needed for init phase)
*
* \param hFwEvent - FwEvent Driver handle
* \return Event mask
*
* \par Description
* Unmask only cmd-cmplt and events interrupts (needed for init phase).
*
* \sa
*/
void fwEvent_SetInitMask (TI_HANDLE hFwEvent);
#ifdef TI_DBG
void fwEvent_PrintStat (TI_HANDLE hFwEvent);
#endif /* TI_DBG */
#endif /* _FW_EVENT_API_H */
|
