serial_buf.c
12.7 KB
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/*
*********************************************************************************************************
* SERIAL (BYTE) COMMUNICATION
*
* (c) Copyright 2007-2009; Micrium, Inc.; Weston, FL
*
* All rights reserved. Protected by international copyright laws.
* Knowledge of the source code may NOT be used to develop a similar product.
* Please help us continue to provide the Embedded community with the finest
* software available. Your honesty is greatly appreciated.
*********************************************************************************************************
*/
/*
*********************************************************************************************************
*
* SERIAL (BYTE) COMMUNICATION
*
* Filename : serial.c
* Version : V2.00
* Programmer(s) : FGK
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* INCLUDE FILES
*********************************************************************************************************
*/
#define SERIAL_BUF_MODULE
#include <serial.h>
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_Init()
*
* Description : Initialize buffer.
*
* Argument(s) : pbuf Pointer to buffer.
*
* pdata Pointer to buffer data.
*
* len Buffer length.
*
* full Indicates that buffer is full upon initialization.
*
* Return(s) : None.
*
* Caller(s) : Application.
*
* Note(s) : None.
*********************************************************************************************************
*/
void SerialBuf_Init (SERIAL_BUF *pbuf,
CPU_INT08U *pdata,
CPU_SIZE_T len,
CPU_BOOLEAN full)
{
pbuf->Len = len;
pbuf->EmptyCnt = ((full == DEF_YES) ? (0) : (len));
pbuf->IxRd = 0;
pbuf->IxWr = 0;
pbuf->DataPtr = pdata;
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_Clr()
*
* Description : Clear buffer.
*
* Argument(s) : pbuf Pointer to buffer.
*
* Return(s) : None.
*
* Caller(s) : Application.
*
* Note(s) : (1) Write index is moved to read index to reset circular buffer.
*********************************************************************************************************
*/
void SerialBuf_Clr (SERIAL_BUF *pbuf)
{
pbuf->EmptyCnt = pbuf->Len;
pbuf->IxWr = pbuf->IxRd;
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_Rd()
*
* Description : Read from buffer.
*
* Argument(s) : pbuf Pointer to buffer.
*
* pdest Pointer to destination buffer.
*
* len Number of octets to read.
*
* Return(s) : The number of octets read from buffer.
*
* Caller(s) : Application.
*
* Note(s) : None.
*********************************************************************************************************
*/
CPU_SIZE_T SerialBuf_Rd (SERIAL_BUF *pbuf,
CPU_INT08U *pdest,
CPU_SIZE_T len)
{
CPU_SIZE_T buf_avail;
CPU_SIZE_T buf_copy_start;
CPU_SIZE_T buf_copy_end;
CPU_SIZE_T buf_copy_tot;
CPU_SIZE_T ix_rd;
CPU_SIZE_T ix_rd_new;
CPU_SIZE_T buf_len;
CPU_INT08U *pdest_08;
CPU_SR_ALLOC();
CPU_CRITICAL_ENTER();
buf_len = pbuf->Len;
buf_avail = buf_len - pbuf->EmptyCnt; /* Calc nbr data octets in buf. */
pdest_08 = (CPU_INT08U *)pdest;
if (buf_avail == 0) { /* ------------------ HANDLE EMPTY BUF ---------------- */
CPU_CRITICAL_EXIT();
return ((CPU_SIZE_T)0);
}
/* ------------- CALC BUF IX & LEN TO COPY ------------ */
ix_rd = pbuf->IxRd;
buf_copy_tot = DEF_MIN(buf_avail, len); /* Calc nbr data octets tot to copy. */
buf_copy_end = DEF_MIN(buf_copy_tot, buf_len - ix_rd); /* Calc nbr data octets to copy from buf end. */
buf_copy_start = buf_copy_tot - buf_copy_end; /* Calc nbr data octets to copy from buf start. */
if (buf_copy_start > 0) { /* Update buf ix rd. */
pbuf->IxRd = buf_copy_start;
} else {
ix_rd_new = ix_rd + buf_copy_tot;
if (ix_rd_new == buf_len) {
pbuf->IxRd = 0;
} else {
pbuf->IxRd = ix_rd_new;
}
}
CPU_CRITICAL_EXIT();
/* --------------- COPY DATA AT BUF END --------------- */
/* Copy data. */
Mem_Copy((void *)pdest_08, (void *)&pbuf->DataPtr[ix_rd], buf_copy_end);
/* -------------- COPY DATA AT BUF START -------------- */
pdest_08 += buf_copy_end; /* Adj buf ptr. */
/* Copy data. */
Mem_Copy((void *)pdest_08, (void *)&pbuf->DataPtr[0], buf_copy_start);
CPU_CRITICAL_ENTER();
pbuf->EmptyCnt += buf_copy_tot; /* Update buf empty octets rem. */
CPU_CRITICAL_EXIT();
return (buf_copy_tot);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_RdOctet()
*
* Description : Read octet from buffer.
*
* Argument(s) : pbuf Pointer to buffer.
*
* pdatum Pointer to variable that will receive octet.
*
* Return(s) : DEF_YES, if a octet was read from the buffer.
* DEF_NO, otherwise.
*
* Caller(s) : Application.
*
* Note(s) : None.
*********************************************************************************************************
*/
CPU_BOOLEAN SerialBuf_RdOctet (SERIAL_BUF *pbuf,
CPU_INT08U *pdatum)
{
CPU_SIZE_T empty_cnt;
CPU_SIZE_T ix_rd;
CPU_SIZE_T len;
CPU_SR_ALLOC();
CPU_CRITICAL_ENTER();
len = pbuf->Len;
empty_cnt = pbuf->EmptyCnt;
if (empty_cnt == len) {
CPU_CRITICAL_EXIT();
return (DEF_NO);
}
ix_rd = pbuf->IxRd;
*pdatum = pbuf->DataPtr[ix_rd];
pbuf->EmptyCnt = empty_cnt + 1;
if (ix_rd + 1 == len) {
pbuf->IxRd = 0;
} else {
pbuf->IxRd = ix_rd + 1;
}
CPU_CRITICAL_EXIT();
return (DEF_YES);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_WrOctet()
*
* Description : Write octet to buffer.
*
* Argument(s) : pbuf Pointer to buffer.
*
* datum Octet to write.
*
* Return(s) : DEF_YES, if the octet was stored in buffer.
* DEF_NO, otherwise.
*
* Caller(s) : Application.
*
* Note(s) : None.
*********************************************************************************************************
*/
CPU_BOOLEAN SerialBuf_WrOctet (SERIAL_BUF *pbuf,
CPU_INT08U datum)
{
CPU_SIZE_T empty_cnt;
CPU_SIZE_T ix_wr;
CPU_SIZE_T len;
CPU_SR_ALLOC();
CPU_CRITICAL_ENTER();
empty_cnt = pbuf->EmptyCnt;
if (empty_cnt == 0) {
CPU_CRITICAL_EXIT();
return (DEF_NO);
}
ix_wr = pbuf->IxWr;
pbuf->DataPtr[ix_wr] = datum;
pbuf->EmptyCnt = empty_cnt - 1;
len = pbuf->Len;
if (ix_wr + 1 == len) {
pbuf->IxWr = 0;
} else {
pbuf->IxWr = ix_wr + 1;
}
CPU_CRITICAL_EXIT();
return (DEF_YES);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_Cmp()
*
* Description : Compare incoming octets to buffer.
*
* Argument(s) : pbuf Pointer to buffer.
*
* datum Octet to compare.
*
* Return(s) : DEF_YES, if compare finished successfully.
* DEF_NO, otherwise.
*
* Caller(s) : Application.
*
* Note(s) : None.
*********************************************************************************************************
*/
CPU_BOOLEAN SerialBuf_Cmp (SERIAL_BUF *pbuf,
CPU_INT08U datum)
{
CPU_SIZE_T ix_rd;
CPU_BOOLEAN full;
CPU_SR_ALLOC();
CPU_CRITICAL_ENTER();
full = SerialBuf_IsFull(pbuf);
if (full == DEF_NO) {
CPU_CRITICAL_EXIT();
return (DEF_NO);
}
ix_rd = pbuf->IxRd;
if(pbuf->DataPtr[ix_rd] != datum) {
pbuf->IxRd = 0; /* Reset comparison. */
CPU_CRITICAL_EXIT();
return (DEF_NO);
}
ix_rd++;
if (ix_rd == pbuf->Len) {
pbuf->IxRd = 0;
CPU_CRITICAL_EXIT();
return (DEF_YES);
}
pbuf->IxRd = ix_rd;
CPU_CRITICAL_EXIT();
return (DEF_NO);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_IsEmpty()
*
* Description : Determine whether buffer is empty.
*
* Argument(s) : pbuf Pointer to buffer.
*
* Return(s) : DEF_YES, if buffer is empty.
* DEF_NO, otherwise.
*
* Caller(s) : Application.
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
CPU_BOOLEAN SerialBuf_IsEmpty (SERIAL_BUF *pbuf)
{
CPU_BOOLEAN empty;
empty = ((pbuf->EmptyCnt == pbuf->Len) ? (DEF_YES) : (DEF_NO));
return (empty);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_IsFull()
*
* Description : Determine whether buffer is full.
*
* Argument(s) : pbuf Pointer to buffer.
*
* Return(s) : DEF_YES, if buffer is full.
* DEF_NO, otherwise.
*
* Caller(s) : Application.
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
CPU_BOOLEAN SerialBuf_IsFull (SERIAL_BUF *pbuf)
{
CPU_BOOLEAN full;
full = ((pbuf->EmptyCnt == 0) ? (DEF_YES) : (DEF_NO));
return (full);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_Size()
*
* Description : Retrieve buffer size.
*
* Argument(s) : pbuf Pointer to buffer.
*
* Return(s) : Size of buffer in octets.
*
* Caller(s) : Application.
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
CPU_SIZE_T SerialBuf_Size (SERIAL_BUF *pbuf)
{
CPU_SIZE_T size;
size = pbuf->Len;
return (size);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialBuf_DataLen()
*
* Description : Determine buffer data area length.
*
* Argument(s) : pbuf Pointer to buffer.
*
* Return(s) : Number of octets in buffer data area.
*
* Caller(s) : Application.
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
CPU_SIZE_T SerialBuf_DataLen (SERIAL_BUF *pbuf)
{
CPU_SIZE_T len;
len = pbuf->Len - pbuf->EmptyCnt;
return (len);
}