summaryrefslogtreecommitdiffstatshomepage
path: root/cc3200/util/fifo.h
blob: c8590f5c2c798c98e09f9a84ce356fc25649a698 (plain) (blame)
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Daniel Campora
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef FIFO_H_
#define FIFO_H_

typedef struct {
    void *pvElements;
    unsigned int uiElementCount;
    unsigned int uiElementsMax;
    unsigned int uiFirst;
    unsigned int uiLast;
    void (*pfElementPush)(void * const pvFifo, const void * const pvElement);
    void (*pfElementPop)(void * const pvFifo, void * const pvElement);
}FIFO_t;

extern void FIFO_Init (FIFO_t *fifo, unsigned int uiElementsMax,
void (*pfElmentPush)(void * const pvFifo, const void * const pvElement),
void (*pfElementPop)(void * const pvFifo, void * const pvElement));
extern bool FIFO_bPushElement (FIFO_t *fifo, const void * const pvElement);
extern bool FIFO_bPopElement (FIFO_t *fifo, void * const pvElement);
extern bool FIFO_bPeekElement (FIFO_t *fifo, void * const pvElement);
extern bool FIFO_IsEmpty (FIFO_t *fifo);
extern bool FIFO_IsFull (FIFO_t *fifo);
extern void FIFO_Flush (FIFO_t *fifo);

#endif /* FIFO_H_ */