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
|
/******************************************************************************
*
* Copyright (C) 2009-2012 Broadcom Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************/
/******************************************************************************
*
* Filename: utils.h
*
* Description: Utility functions declaration
*
******************************************************************************/
#ifndef UTILS_H
#define UTILS_H
/******************************************************************************
** Constants & Macros
******************************************************************************/
#define STREAM_TO_UINT16(u16, p) {u16 = ((uint16_t)(*(p)) + (((uint16_t)(*((p) + 1))) << 8)); (p) += 2;}
#define UINT16_TO_STREAM(p, u16) {*(p)++ = (uint8_t)(u16); *(p)++ = (uint8_t)((u16) >> 8);}
#define UINT32_TO_STREAM(p, u32) {*(p)++ = (uint8_t)(u32); *(p)++ = (uint8_t)((u32) >> 8); *(p)++ = (uint8_t)((u32) >> 16); *(p)++ = (uint8_t)((u32) >> 24);}
/******************************************************************************
** Type definitions
******************************************************************************/
typedef struct
{
void *p_first;
void *p_last;
uint16_t count;
} BUFFER_Q;
/******************************************************************************
** Extern variables and functions
******************************************************************************/
/******************************************************************************
** Functions
******************************************************************************/
/*******************************************************************************
**
** Function utils_init
**
** Description Utils initialization
**
** Returns None
**
*******************************************************************************/
void utils_init ();
/*******************************************************************************
**
** Function utils_cleanup
**
** Description Utils cleanup
**
** Returns None
**
*******************************************************************************/
void utils_cleanup ();
/*******************************************************************************
**
** Function utils_queue_init
**
** Description Initialize the given buffer queue
**
** Returns None
**
*******************************************************************************/
void utils_queue_init (BUFFER_Q *p_q);
/*******************************************************************************
**
** Function utils_enqueue
**
** Description Enqueue a buffer at the tail of the given queue
**
** Returns None
**
*******************************************************************************/
void utils_enqueue (BUFFER_Q *p_q, void *p_buf);
/*******************************************************************************
**
** Function utils_dequeue
**
** Description Dequeues a buffer from the head of the given queue
**
** Returns NULL if queue is empty, else buffer
**
*******************************************************************************/
void *utils_dequeue (BUFFER_Q *p_q);
/*******************************************************************************
**
** Function utils_dequeue_unlocked
**
** Description Dequeues a buffer from the head of the given queue without lock
**
** Returns NULL if queue is empty, else buffer
**
*******************************************************************************/
void *utils_dequeue_unlocked (BUFFER_Q *p_q);
/*******************************************************************************
**
** Function utils_getnext
**
** Description Return a pointer to the next buffer linked to the given buffer
**
** Returns NULL if the given buffer does not point to any next buffer,
** else next buffer address
**
*******************************************************************************/
void *utils_getnext (void *p_buf);
/*******************************************************************************
**
** Function utils_remove_from_queue
**
** Description Dequeue the given buffer from the middle of the given queue
**
** Returns NULL if the given queue is empty, else the given buffer
**
*******************************************************************************/
void *utils_remove_from_queue (BUFFER_Q *p_q, void *p_buf);
/*******************************************************************************
**
** Function utils_remove_from_queue_unlocked
**
** Description Dequeue the given buffer from the middle of the given queue without lock
**
** Returns NULL if the given queue is empty, else the given buffer
**
*******************************************************************************/
void *utils_remove_from_queue_unlocked (BUFFER_Q *p_q, void *p_buf);
/*******************************************************************************
**
** Function utils_delay
**
** Description sleep unconditionally for timeout milliseconds
**
** Returns None
**
*******************************************************************************/
void utils_delay (uint32_t timeout);
/*******************************************************************************
**
** Function utils_lock
**
** Description application calls this function before entering critical
** section
**
** Returns None
**
*******************************************************************************/
void utils_lock (void);
/*******************************************************************************
**
** Function utils_unlock
**
** Description application calls this function when leaving critical
** section
**
** Returns None
**
*******************************************************************************/
void utils_unlock (void);
#endif /* UTILS_H */
|
