rtapi_list(3rtapi)

rtapi_list3rtapi

Rtapi wrappers for linux kernel functionality

Usage

#include <rtapi_list.h>

struct rtapi_list_head;

void rtapi_list_add(struct rtapi_list_head *new_, struct rtapi_list_head *head);

void rtapi_list_add_tail(struct rtapi_list_head *new_, struct rtapi_list_head *head);

void rtapi_list_del(struct rtapi_list_head *entry);

void RTAPI_INIT_LIST_HEAD(struct rtapi_list_head *entry);

rtapi_list_for_each(pos, head) { ... }

rtapi_list_entry(ptr, type, member)

Overview

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)

Realtime considerations

Call from init/cleanup code and from realtime tasks. These functions will cause illegal instruction exceptions in non-realtime components, as well as in uspace rtapi_app when it is not setuid root.

Return value

As in Linux.

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

From linuxcnc-uspace-dev 1:2.9.4-2+deb13u1 in Debian 13 (Trixie). Parsed by carta from the page's man source.