Xenomai  3.0.8
rngLib.h
1 /*
2  * * Copyright (C) 2008 Niklaus Giger <niklaus.giger@member.fsf.org>.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13 
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17  *
18  * This file satisfies the references within the emulator code
19  * mimicking a VxWorks-like API built upon the copperplate library.
20  *
21  * VxWorks is a registered trademark of Wind River Systems, Inc.
22  */
23 
24 #ifndef _XENOMAI_VXWORKS_RNGLIB_H
25 #define _XENOMAI_VXWORKS_RNGLIB_H
26 
27 #include <vxworks/types.h>
28 
29 typedef uintptr_t RING_ID;
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 RING_ID rngCreate(int nbytes);
36 
37 void rngDelete(RING_ID ringId);
38 
39 void rngFlush(RING_ID ringId);
40 
41 int rngBufGet(RING_ID rngId, char *buffer, int maxbytes);
42 
43 int rngBufPut(RING_ID rngId, char *buffer, int nbytes);
44 
45 BOOL rngIsEmpty(RING_ID ringId);
46 
47 BOOL rngIsFull(RING_ID ringId);
48 
49 int rngFreeBytes(RING_ID ringId);
50 
51 int rngNBytes(RING_ID ringId);
52 
53 void rngPutAhead(RING_ID ringId, char byte, int offset);
54 
55 void rngMoveAhead(RING_ID ringId, int n);
56 
57 #ifdef __cplusplus
58 }
59 #endif
60 
61 #endif /* !_XENOMAI_VXWORKS_RNGLIB_H */