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_gfp.h \- RTAPI wrappers for linux kernel functionality
26  
27  .SH SYNTAX
28  .HP
29  #include <rtapi_gfp.h>
30  .HP
31  enum rtapi_gfp_e;
32  .HP
33  RTAPI_GFP_xxx
34  .HP
35  typedef ... rtapi_gfp_t;
36  
37  .SH DESCRIPTION
38  In kernel space, each rtapi_xxx or RTAPI_XXX identifier is mapped to the
39  underlying kernel functionality, if available.
40  
41  In userspace, or in kernels where the underlying functionality is not provided
42  by a kernel, generally another implementation--possibly with reduced
43  functionality--is provided.  (For example, the userspace implementation for
44  rtapi_device_register always succeeds)
45  .SH REALTIME CONSIDERATIONS
46  Typically, these functions may be called from realtime init/cleanup code.
47  .SH RETURN VALUE
48  As in Linux.
49  .SH SEE ALSO