59 lines
2.2 KiB
Text
59 lines
2.2 KiB
Text
.\" Copyright (c) 2014 Jeff Epler
|
|
.\"
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
.\" the License, or (at your option) any later version.
|
|
.\"
|
|
.\" The GNU General Public License's references to "object code"
|
|
.\" and "executables" are to be interpreted as the output of any
|
|
.\" document formatting or typesetting system, including
|
|
.\" intermediate and printed output.
|
|
.\"
|
|
.\" This manual is distributed in the hope that it will be useful,
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
.\" GNU General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU General Public
|
|
.\" License along with this manual; if not, write to the Free
|
|
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
|
|
.\" USA.
|
|
.TH funct "3rtapi" "2014-06-28" "LinuxCNC Documentation" "RTAPI"
|
|
.SH NAME
|
|
|
|
rtapi_list.h \- RTAPI wrappers for linux kernel functionality
|
|
|
|
.SH SYNTAX
|
|
.HP
|
|
#include <rtapi_list.h>
|
|
.HP
|
|
struct rtapi_list_head;
|
|
.HP
|
|
void rtapi_list_add(struct rtapi_list_head *new_, struct rtapi_list_head *head);
|
|
.HP
|
|
void rtapi_list_add_tail(struct rtapi_list_head *new_, struct rtapi_list_head *head);
|
|
.HP
|
|
void rtapi_list_del(struct rtapi_list_head *entry);
|
|
.HP
|
|
void RTAPI_INIT_LIST_HEAD(struct rtapi_list_head *entry);
|
|
.HP
|
|
rtapi_list_for_each(pos, head) { ... }
|
|
.HP
|
|
rtapi_list_entry(ptr, type, member)
|
|
|
|
.SH DESCRIPTION
|
|
In kernel space, each rtapi_xxx or RTAPI_XXX identifier is mapped to the
|
|
underlying kernel functionality, if available.
|
|
|
|
In userspace, or in kernels where the underlying functionality is not provided
|
|
by a kernel, generally another implementation--possibly with reduced
|
|
functionality--is provided. (For example, the userspace implementation for
|
|
rtapi_device_register always succeeds)
|
|
.SH REALTIME CONSIDERATIONS
|
|
Call from init/cleanup code and from realtime tasks. These functions will
|
|
cause illegal instruction exceptions in userspace components, as well as in
|
|
uspace rtapi_app when it is not setuid root.
|
|
.SH RETURN VALUE
|
|
As in Linux.
|
|
.SH SEE ALSO
|