0
|
1 |
/*
|
|
2 |
* TxnQueue.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 |
|
|
40 |
/** \file TxnQueue.h
|
|
41 |
* \brief TxnQueue module API definition
|
|
42 |
*
|
|
43 |
* \see TxnQueue.c
|
|
44 |
*/
|
|
45 |
|
|
46 |
#ifndef __TXN_QUEUE_API_H__
|
|
47 |
#define __TXN_QUEUE_API_H__
|
|
48 |
|
|
49 |
|
|
50 |
#include "TxnDefs.h"
|
|
51 |
#include "BusDrv.h"
|
|
52 |
|
|
53 |
|
|
54 |
|
|
55 |
/************************************************************************
|
|
56 |
* Defines
|
|
57 |
************************************************************************/
|
|
58 |
|
|
59 |
|
|
60 |
/************************************************************************
|
|
61 |
* Macros
|
|
62 |
************************************************************************/
|
|
63 |
|
|
64 |
|
|
65 |
/************************************************************************
|
|
66 |
* Types
|
|
67 |
************************************************************************/
|
|
68 |
|
|
69 |
|
|
70 |
/************************************************************************
|
|
71 |
* Functions
|
|
72 |
************************************************************************/
|
|
73 |
/** \brief Create the TxnQ module
|
|
74 |
*
|
|
75 |
* \param hOs - Handle to Os Abstraction Layer
|
|
76 |
* \return Handle of the allocated object, NULL if allocation failed
|
|
77 |
*
|
|
78 |
* \par Description
|
|
79 |
* Allocate and clear the module's object
|
|
80 |
*
|
|
81 |
* \sa txnQ_Destroy
|
|
82 |
*/
|
|
83 |
TI_HANDLE txnQ_Create (TI_HANDLE hOs);
|
|
84 |
|
|
85 |
/** \brief Destroy the module
|
|
86 |
*
|
|
87 |
* \param The module's object
|
|
88 |
* \return TI_OK on success or TI_NOK on failure
|
|
89 |
*
|
|
90 |
* \par Description
|
|
91 |
* Destroy bus driver and free the module's object
|
|
92 |
*
|
|
93 |
* \sa txnQ_Create
|
|
94 |
*/
|
|
95 |
TI_STATUS txnQ_Destroy (TI_HANDLE hTxnQ);
|
|
96 |
|
|
97 |
/** \brief Init module
|
|
98 |
*
|
|
99 |
* \param hTxnQ - The module's object
|
|
100 |
* \param hOs - Handle to Os Abstraction Layer
|
|
101 |
* \param hReport - Handle to report module
|
|
102 |
* \param hContext - Handle to context module
|
|
103 |
* \return void
|
|
104 |
*
|
|
105 |
* \par Description
|
|
106 |
*
|
|
107 |
* \sa
|
|
108 |
*/
|
|
109 |
void txnQ_Init (TI_HANDLE hTxnQ,
|
|
110 |
TI_HANDLE hOs,
|
|
111 |
TI_HANDLE hReport,
|
|
112 |
TI_HANDLE hContext);
|
|
113 |
|
|
114 |
/** \brief Configure bus driver
|
|
115 |
*
|
|
116 |
* \param hTxnQ - The module's object
|
|
117 |
* \param pBusDrvCfg - A union used for per-bus specific configuration.
|
|
118 |
* \param pRxDmaBufLen - The Rx DMA buffer length in bytes (needed as a limit of the Rx aggregation length)
|
|
119 |
* \param pTxDmaBufLen - The Tx DMA buffer length in bytes (needed as a limit of the Tx aggregation length)
|
|
120 |
* \return TI_OK / TI_NOK
|
|
121 |
*
|
|
122 |
* \par Description
|
|
123 |
* Called by DrvMain (future - by Chip-Manager).
|
|
124 |
* Configure the bus driver with its connection configuration (such as baud-rate, bus width etc)
|
|
125 |
* and establish the physical connection. Done once (and not per functional driver startup).
|
|
126 |
*
|
|
127 |
* \sa
|
|
128 |
*/
|
|
129 |
TI_STATUS txnQ_ConnectBus (TI_HANDLE hTxnQ,
|
|
130 |
TBusDrvCfg *pBusDrvCfg,
|
|
131 |
TTxnDoneCb fConnectCb,
|
|
132 |
TI_HANDLE hConnectCb,
|
|
133 |
TI_UINT32 *pRxDmaBufLen,
|
|
134 |
TI_UINT32 *pTxDmaBufLen);
|
|
135 |
|
|
136 |
/** \brief Disconnect bus driver
|
|
137 |
*
|
|
138 |
* \param hTxnQ - The module's object
|
|
139 |
* \return TI_OK / TI_NOK
|
|
140 |
*
|
|
141 |
* \par Description
|
|
142 |
* Called by DrvMain (future - by Chip-Manager).
|
|
143 |
* Disconnect the bus driver.
|
|
144 |
*
|
|
145 |
* \sa
|
|
146 |
*/
|
|
147 |
TI_STATUS txnQ_DisconnectBus (TI_HANDLE hTxnQ);
|
|
148 |
|
|
149 |
/** \brief Register functional driver to TxnQ
|
|
150 |
*
|
|
151 |
* \param hTxnQ - The module's object
|
|
152 |
* \param uFuncId - The calling functional driver
|
|
153 |
* \param uNumPrios - The number of queues/priorities
|
|
154 |
* \param fTxnQueueDoneCb - The callback to call upon full transaction completion.
|
|
155 |
* \param hCbHandle - The callback handle
|
|
156 |
* \return TI_OK / TI_NOK
|
|
157 |
*
|
|
158 |
* \par Description
|
|
159 |
* Called by each functional driver (WLAN, future-BT) that uses the TxnQ.
|
|
160 |
* Save driver's info and create its queues.
|
|
161 |
* Perform in critical section to prevent preemption from TxnDone.
|
|
162 |
*
|
|
163 |
* \sa txnQ_Close
|
|
164 |
*/
|
|
165 |
TI_STATUS txnQ_Open (TI_HANDLE hTxnQ,
|
|
166 |
TI_UINT32 uFuncId,
|
|
167 |
TI_UINT32 uNumPrios,
|
|
168 |
TTxnQueueDoneCb fTxnQueueDoneCb,
|
|
169 |
TI_HANDLE hCbHandle);
|
|
170 |
|
|
171 |
/** \brief Unregister functional driver from TxnQ
|
|
172 |
*
|
|
173 |
* \param hTxnQ - The module's object
|
|
174 |
* \param uFuncId - The calling functional driver
|
|
175 |
* \return void
|
|
176 |
* \sa txnQ_Open
|
|
177 |
*
|
|
178 |
* \par Description
|
|
179 |
* Called by registered functional driver that uses the TxnQ to unregister.
|
|
180 |
* Clear the function's data and destroy its queues.
|
|
181 |
* Perform in critical section to prevent preemption from TxnDone.
|
|
182 |
*
|
|
183 |
* \sa txnQ_Open
|
|
184 |
*/
|
|
185 |
void txnQ_Close (TI_HANDLE hTxnQ, TI_UINT32 uFuncId);
|
|
186 |
|
|
187 |
/** \brief Restart caller's queues
|
|
188 |
*
|
|
189 |
* \param hTxnQ - The module's object
|
|
190 |
* \param uFuncId - The calling functional driver
|
|
191 |
* \return COMPLETE if queues were restarted, PENDING if waiting for TxnDone to restart queues
|
|
192 |
*
|
|
193 |
* \par Description
|
|
194 |
* Called upon functional driver stop command or upon recovery.
|
|
195 |
* If no transaction in progress for the calling function, clear its queues (call the CBs).
|
|
196 |
* If a transaction from this function is in progress, just set state to RESTART and when
|
|
197 |
* called back upon TxnDone clear the queues.
|
|
198 |
* Perform in critical section to prevent preemption from TxnDone.
|
|
199 |
* \note
|
|
200 |
* The Restart applies only to the calling function's queues.
|
|
201 |
*
|
|
202 |
* \sa txnQ_ClearQueues
|
|
203 |
*/
|
|
204 |
ETxnStatus txnQ_Restart (TI_HANDLE hTxnQ, TI_UINT32 uFuncId);
|
|
205 |
|
|
206 |
/** \brief Run caller's queues
|
|
207 |
*
|
|
208 |
* \param hTxnQ - The module's object
|
|
209 |
* \param uFuncId - The calling functional driver
|
|
210 |
* \return void
|
|
211 |
*
|
|
212 |
* \par Description
|
|
213 |
* Enable TxnQ scheduler to process transactions from the calling function's queues.
|
|
214 |
* Run scheduler to issue transactions as possible.
|
|
215 |
* Run in critical section to protect from preemption by TxnDone.
|
|
216 |
*
|
|
217 |
* \sa txnQ_ClearQueues
|
|
218 |
*/
|
|
219 |
void txnQ_Run (TI_HANDLE hTxnQ, TI_UINT32 uFuncId);
|
|
220 |
|
|
221 |
/** \brief Stop caller's queues
|
|
222 |
*
|
|
223 |
* \param hTxnQ - The module's object
|
|
224 |
* \param uFuncId - The calling functional driver
|
|
225 |
* \return void
|
|
226 |
*
|
|
227 |
* \par Description
|
|
228 |
* Disable TxnQ scheduler to process transactions from the calling function's queues.
|
|
229 |
*
|
|
230 |
* \sa
|
|
231 |
*/
|
|
232 |
void txnQ_Stop (TI_HANDLE hTxnQ, TI_UINT32 uFuncId);
|
|
233 |
|
|
234 |
/** \brief Issue a new transaction
|
|
235 |
*
|
|
236 |
* \param hTxnQ - The module's object
|
|
237 |
* \param pTxn - The transaction object
|
|
238 |
* \return COMPLETE if input pTxn completed in this context, PENDING if not, ERROR if failed
|
|
239 |
*
|
|
240 |
* \par Description
|
|
241 |
* Called by the functional driver to initiate a new transaction.
|
|
242 |
* In critical section save transaction and call scheduler.
|
|
243 |
*
|
|
244 |
* \sa
|
|
245 |
*/
|
|
246 |
ETxnStatus txnQ_Transact (TI_HANDLE hTxnQ, TTxnStruct *pTxn);
|
|
247 |
|
|
248 |
/**
|
|
249 |
* \fn txnQ_ClearQueues
|
|
250 |
* \brief Clear the function queues
|
|
251 |
*
|
|
252 |
* Clear the specified function queues and call its CB for each Txn with status=RECOVERY.
|
|
253 |
*
|
|
254 |
* \note Called in critical section.
|
|
255 |
* \param hTxnQ - The module's object
|
|
256 |
* \param uFuncId - The calling functional driver
|
|
257 |
* \return void
|
|
258 |
* \sa
|
|
259 |
*/
|
|
260 |
void txnQ_ClearQueues (TI_HANDLE hTxnQ, TI_UINT32 uFuncId);
|
|
261 |
|
|
262 |
|
|
263 |
#ifdef TI_DBG
|
|
264 |
/** \brief Print Txn Queues
|
|
265 |
*
|
|
266 |
* \param hTxnQ - The module's object
|
|
267 |
* \return void
|
|
268 |
*
|
|
269 |
* \par Description
|
|
270 |
*
|
|
271 |
* \sa
|
|
272 |
*/
|
|
273 |
void txnQ_PrintQueues (TI_HANDLE hTxnQ);
|
|
274 |
#endif
|
|
275 |
|
|
276 |
|
|
277 |
|
|
278 |
#endif /*__TXN_QUEUE_API_H__*/
|