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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
|
/*
** Id: //Department/DaVinci/BRANCHES/MT6620_WIFI_DRIVER_V2_3/include/link.h#1
*/
/*! \file link.h
\brief Definition for simple doubly linked list operations.
In this file we define the simple doubly linked list data structure and its
operation MACROs and INLINE functions.
*/
/*
** Log: link.h
*
* 08 05 2010 yuche.tsai
* NULL
* Modify a MACRO of LINK_FOR_EACH_SAFE for compile error.
*
* 07 19 2010 cm.chang
*
* Set RLM parameters and enable CNM channel manager
*
* 07 08 2010 cp.wu
*
* [WPD00003833] [MT6620 and MT5931] Driver migration - move to new repository.
*
* 06 07 2010 cp.wu
* [WPD00003833][MT6620 and MT5931] Driver migration
* [WPD00003833] [MT6620 and MT5931] Driver migration
* .
*
*
*
*
* May 4 2009 mtk01084
* [BORA00000018] Integrate WIFI part into BORA for the 1st time
* add WIFI to BORA source control
** \main\maintrunk.MT5921\8 2008-10-16 15:57:11 GMT mtk01461
** Update driver to fix lint warning
** \main\maintrunk.MT5921\7 2008-08-10 18:47:53 GMT mtk01461
** Update for Driver Review
** \main\maintrunk.MT5921\6 2007-12-11 00:09:00 GMT mtk01461
** Add macro for checking valid list
** \main\maintrunk.MT5921\5 2007-11-13 14:27:01 GMT mtk01461
** Add LINK_IS_INVALID macro
** Revision 1.1.1.1 2007/06/22 08:09:05 MTK01461
** no message
**
*/
#ifndef _LINK_H
#define _LINK_H
/*******************************************************************************
* C O M P I L E R F L A G S
********************************************************************************
*/
/*******************************************************************************
* E X T E R N A L R E F E R E N C E S
********************************************************************************
*/
#include "gl_typedef.h"
/*******************************************************************************
* C O N S T A N T S
********************************************************************************
*/
/* May cause page fault & unalignment issue (data abort) */
#define INVALID_LINK_POISON1 ((VOID *) 0x00100101)
/* Used to verify that nonbody uses non-initialized link entries. */
#define INVALID_LINK_POISON2 ((VOID *) 0x00100201)
/*******************************************************************************
* D A T A T Y P E S
********************************************************************************
*/
/* Simple Doubly Linked List Structures - Entry Part */
typedef struct _LINK_ENTRY_T {
struct _LINK_ENTRY_T *prNext, *prPrev;
} LINK_ENTRY_T, *P_LINK_ENTRY_T;
/* Simple Doubly Linked List Structures - List Part */
typedef struct _LINK_T {
P_LINK_ENTRY_T prNext;
P_LINK_ENTRY_T prPrev;
UINT_32 u4NumElem;
} LINK_T, *P_LINK_T;
/*******************************************************************************
* P U B L I C D A T A
********************************************************************************
*/
/*******************************************************************************
* P R I V A T E D A T A
********************************************************************************
*/
/*******************************************************************************
* M A C R O S
********************************************************************************
*/
#if 0 /* No one use it, temporarily mark it for [Lint - Info 773] */
#define LINK_ADDR(rLink) { (P_LINK_ENTRY_T)(&(rLink)), (P_LINK_ENTRY_T)(&(rLink)), 0 }
#define LINK_DECLARATION(rLink) \
struct _LINK_T rLink = LINK_ADDR(rLink)
#endif
#define LINK_INITIALIZE(prLink) \
do { \
((P_LINK_T)(prLink))->prNext = (P_LINK_ENTRY_T)(prLink); \
((P_LINK_T)(prLink))->prPrev = (P_LINK_ENTRY_T)(prLink); \
((P_LINK_T)(prLink))->u4NumElem = 0; \
} while (0)
#define LINK_ENTRY_INITIALIZE(prEntry) \
do { \
((P_LINK_ENTRY_T)(prEntry))->prNext = (P_LINK_ENTRY_T)NULL; \
((P_LINK_ENTRY_T)(prEntry))->prPrev = (P_LINK_ENTRY_T)NULL; \
} while (0)
#define LINK_ENTRY_INVALID(prEntry) \
do { \
((P_LINK_ENTRY_T)(prEntry))->prNext = (P_LINK_ENTRY_T)INVALID_LINK_POISON1; \
((P_LINK_ENTRY_T)(prEntry))->prPrev = (P_LINK_ENTRY_T)INVALID_LINK_POISON2; \
} while (0)
#define LINK_IS_EMPTY(prLink) (((P_LINK_T)(prLink))->prNext == (P_LINK_ENTRY_T)(prLink))
/* NOTE: We should do memory zero before any LINK been initiated, so we can check
* if it is valid before parsing the LINK.
*/
#define LINK_IS_INVALID(prLink) (((P_LINK_T)(prLink))->prNext == (P_LINK_ENTRY_T)NULL)
#define LINK_IS_VALID(prLink) (((P_LINK_T)(prLink))->prNext != (P_LINK_ENTRY_T)NULL)
#define LINK_ENTRY(ptr, type, member) ENTRY_OF(ptr, type, member)
/* Insert an entry into a link list's head */
#define LINK_INSERT_HEAD(prLink, prEntry) \
{ \
linkAdd(prEntry, prLink); \
((prLink)->u4NumElem)++; \
}
/* Append an entry into a link list's tail */
#define LINK_INSERT_TAIL(prLink, prEntry) \
{ \
linkAddTail(prEntry, prLink); \
((prLink)->u4NumElem)++; \
}
/* Peek head entry, but keep still in link list */
#define LINK_PEEK_HEAD(prLink, _type, _member) \
( \
LINK_IS_EMPTY(prLink) ? \
NULL : LINK_ENTRY((prLink)->prNext, _type, _member) \
)
/* Peek tail entry, but keep still in link list */
#define LINK_PEEK_TAIL(prLink, _type, _member) \
( \
LINK_IS_EMPTY(prLink) ? \
NULL : LINK_ENTRY((prLink)->prPrev, _type, _member) \
)
/* Get first entry from a link list */
/* NOTE: We assume the link entry located at the beginning of "prEntry Type",
* so that we can cast the link entry to other data type without doubts.
* And this macro also decrease the total entry count at the same time.
*/
#define LINK_REMOVE_HEAD(prLink, prEntry, _P_TYPE) \
{ \
ASSERT(prLink); \
if (LINK_IS_EMPTY(prLink)) { \
prEntry = (_P_TYPE)NULL; \
} \
else { \
prEntry = (_P_TYPE)(((P_LINK_T)(prLink))->prNext); \
linkDel((P_LINK_ENTRY_T)prEntry); \
((prLink)->u4NumElem)--; \
} \
}
/* Assume the link entry located at the beginning of prEntry Type.
* And also decrease the total entry count.
*/
#define LINK_REMOVE_KNOWN_ENTRY(prLink, prEntry) \
{ \
ASSERT(prLink); \
ASSERT(prEntry); \
linkDel((P_LINK_ENTRY_T)prEntry); \
((prLink)->u4NumElem)--; \
}
/* Iterate over a link list */
#define LINK_FOR_EACH(prEntry, prLink) \
for (prEntry = (prLink)->prNext; \
prEntry != (P_LINK_ENTRY_T)(prLink); \
prEntry = (P_LINK_ENTRY_T)prEntry->prNext)
/* Iterate over a link list backwards */
#define LINK_FOR_EACH_PREV(prEntry, prLink) \
for (prEntry = (prLink)->prPrev; \
prEntry != (P_LINK_ENTRY_T)(prLink); \
prEntry = (P_LINK_ENTRY_T)prEntry->prPrev)
/* Iterate over a link list safe against removal of link entry */
#define LINK_FOR_EACH_SAFE(prEntry, prNextEntry, prLink) \
for (prEntry = (prLink)->prNext, prNextEntry = prEntry->prNext; \
prEntry != (P_LINK_ENTRY_T)(prLink); \
prEntry = prNextEntry, prNextEntry = prEntry->prNext)
/* Iterate over a link list of given type */
#define LINK_FOR_EACH_ENTRY(prObj, prLink, rMember, _TYPE) \
for (prObj = LINK_ENTRY((prLink)->prNext, _TYPE, rMember); \
&prObj->rMember != (P_LINK_ENTRY_T)(prLink); \
prObj = LINK_ENTRY(prObj->rMember.prNext, _TYPE, rMember))
/* Iterate backwards over a link list of given type */
#define LINK_FOR_EACH_ENTRY_PREV(prObj, prLink, rMember, _TYPE) \
for (prObj = LINK_ENTRY((prLink)->prPrev, _TYPE, rMember); \
&prObj->rMember != (P_LINK_ENTRY_T)(prLink); \
prObj = LINK_ENTRY(prObj->rMember.prPrev, _TYPE, rMember))
/* Iterate over a link list of given type safe against removal of link entry */
#define LINK_FOR_EACH_ENTRY_SAFE(prObj, prNextObj, prLink, rMember, _TYPE) \
for (prObj = LINK_ENTRY((prLink)->prNext, _TYPE, rMember), \
prNextObj = LINK_ENTRY(prObj->rMember.prNext, _TYPE, rMember); \
&prObj->rMember != (P_LINK_ENTRY_T)(prLink); \
prObj = prNextObj, \
prNextObj = LINK_ENTRY(prNextObj->rMember.prNext, _TYPE, rMember))
/*******************************************************************************
* F U N C T I O N D E C L A R A T I O N S
********************************************************************************
*/
/*******************************************************************************
* F U N C T I O N S
********************************************************************************
*/
/*----------------------------------------------------------------------------*/
/*!
* \brief This function is only for internal link list manipulation.
*
* \param[in] prNew Pointer of new link head
* \param[in] prPrev Pointer of previous link head
* \param[in] prNext Pointer of next link head
*
* \return (none)
*/
/*----------------------------------------------------------------------------*/
static inline VOID __linkAdd(IN P_LINK_ENTRY_T prNew, IN P_LINK_ENTRY_T prPrev, IN P_LINK_ENTRY_T prNext)
{
prNext->prPrev = prNew;
prNew->prNext = prNext;
prNew->prPrev = prPrev;
prPrev->prNext = prNew;
} /* end of __linkAdd() */
/*----------------------------------------------------------------------------*/
/*!
* \brief This function will add a new entry after the specified link head.
*
* \param[in] prNew New entry to be added
* \param[in] prHead Specified link head to add it after
*
* \return (none)
*/
/*----------------------------------------------------------------------------*/
static inline VOID linkAdd(IN P_LINK_ENTRY_T prNew, IN P_LINK_T prLink)
{
__linkAdd(prNew, (P_LINK_ENTRY_T) prLink, prLink->prNext);
} /* end of linkAdd() */
/*----------------------------------------------------------------------------*/
/*!
* \brief This function will add a new entry before the specified link head.
*
* \param[in] prNew New entry to be added
* \param[in] prHead Specified link head to add it before
*
* \return (none)
*/
/*----------------------------------------------------------------------------*/
static inline VOID linkAddTail(IN P_LINK_ENTRY_T prNew, IN P_LINK_T prLink)
{
__linkAdd(prNew, prLink->prPrev, (P_LINK_ENTRY_T) prLink);
} /* end of linkAddTail() */
/*----------------------------------------------------------------------------*/
/*!
* \brief This function is only for internal link list manipulation.
*
* \param[in] prPrev Pointer of previous link head
* \param[in] prNext Pointer of next link head
*
* \return (none)
*/
/*----------------------------------------------------------------------------*/
static inline VOID __linkDel(IN P_LINK_ENTRY_T prPrev, IN P_LINK_ENTRY_T prNext)
{
prNext->prPrev = prPrev;
prPrev->prNext = prNext;
} /* end of __linkDel() */
/*----------------------------------------------------------------------------*/
/*!
* \brief This function will delete a specified entry from link list.
* NOTE: the entry is in an initial state.
*
* \param prEntry Specified link head(entry)
*
* \return (none)
*/
/*----------------------------------------------------------------------------*/
static inline VOID linkDel(IN P_LINK_ENTRY_T prEntry)
{
__linkDel(prEntry->prPrev, prEntry->prNext);
LINK_ENTRY_INITIALIZE(prEntry);
} /* end of linkDel() */
/*----------------------------------------------------------------------------*/
/*!
* \brief This function will delete a specified entry from link list and then add it
* after the specified link head.
*
* \param[in] prEntry Specified link head(entry)
* \param[in] prOtherHead Another link head to add it after
*
* \return (none)
*/
/*----------------------------------------------------------------------------*/
static inline VOID linkMove(IN P_LINK_ENTRY_T prEntry, IN P_LINK_T prLink)
{
__linkDel(prEntry->prPrev, prEntry->prNext);
linkAdd(prEntry, prLink);
} /* end of linkMove() */
/*----------------------------------------------------------------------------*/
/*!
* \brief This function will delete a specified entry from link list and then add it
* before the specified link head.
*
* \param[in] prEntry Specified link head(entry)
* \param[in] prOtherHead Another link head to add it before
*
* \return (none)
*/
/*----------------------------------------------------------------------------*/
static inline VOID linkMoveTail(IN P_LINK_ENTRY_T prEntry, IN P_LINK_T prLink)
{
__linkDel(prEntry->prPrev, prEntry->prNext);
linkAddTail(prEntry, prLink);
} /* end of linkMoveTail() */
#endif /* _LINK_H */
|
