1  .\" Copyright (c) 2014 Jeff Epler
 2  .\"
 3  .\" This is free documentation; you can redistribute it and/or
 4  .\" modify it under the terms of the GNU General Public License as
 5  .\" published by the Free Software Foundation; either version 2 of
 6  .\" the License, or (at your option) any later version.
 7  .\"
 8  .\" The GNU General Public License's references to "object code"
 9  .\" and "executables" are to be interpreted as the output of any
10  .\" document formatting or typesetting system, including
11  .\" intermediate and printed output.
12  .\"
13  .\" This manual is distributed in the hope that it will be useful,
14  .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
15  .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  .\" GNU General Public License for more details.
17  .\"
18  .\" You should have received a copy of the GNU General Public
19  .\" License along with this manual; if not, write to the Free
20  .\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
21  .\" USA.
22  .TH funct "3rtapi" "2014-06-28" "LinuxCNC Documentation" "RTAPI"
23  .SH NAME
24  
25  rtapi_stdint.h \- RTAPI wrappers for linux kernel functionality
26  
27  .SH SYNTAX
28  .HP
29  #include <rtapi_stdint.h>
30  .HP
31  typedef ... rtapi_s8;
32  .HP
33  typedef ... rtapi_s16;
34  .HP
35  typedef ... rtapi_s32;
36  .HP
37  typedef ... rtapi_s64;
38  .HP
39  typedef ... rtapi_intptr_t;
40  .HP
41  typedef ... rtapi_u8;
42  .HP
43  typedef ... rtapi_u16;
44  .HP
45  typedef ... rtapi_u32;
46  .HP
47  typedef ... rtapi_u64;
48  .HP
49  typedef ... rtapi_uintptr_t;
50  .HP
51  .RI #define\ RTAPI_INT xx _MIN\ ...
52  .HP
53  .RI #define\ RTAPI_INT xx _MAX\ ...
54  .HP
55  .RI #define\ RTAPI_UINT xx _MAX\ ...
56  .HP
57  .SH DESCRIPTION
58  In kernel space, each rtapi_xxx or RTAPI_XXX identifier is mapped to the
59  underlying kernel functionality, if available.
60  
61  In userspace, or in kernels where the underlying functionality is not provided
62  by a kernel, generally another implementation--possibly with reduced
63  functionality--is provided.  (For example, the userspace implementation for
64  rtapi_device_register always succeeds)
65  .SH REALTIME CONSIDERATIONS
66  None.
67  .SH RETURN VALUE
68  As in Linux.
69  .SH SEE ALSO