funct(3rtapi)

💅 funct(3rtapi) — bestie edition

okay so this is the manual page for funct, living in section 3rtapi of the RTAPI manual set. it's the one about rtapi_stdint.h — RTAPI wrappers for linux kernel functionality. yes, "funct" is the name, no we don't know why either, moving on ✨

✨ NAME ✨

rtapi_stdint.h — RTAPI wrappers for linux kernel functionality 🫶

✨ SYNTAX ✨

#include <rtapi_stdint.h>

typedef ... rtapi_s8;

typedef ... rtapi_s16;

typedef ... rtapi_s32;

typedef ... rtapi_s64;

typedef ... rtapi_intptr_t;

typedef ... rtapi_u8;

typedef ... rtapi_u16;

typedef ... rtapi_u32;

typedef ... rtapi_u64;

typedef ... rtapi_uintptr_t;

#define RTAPI_INTxx_MIN ...

#define RTAPI_INTxx_MAX ...

#define RTAPI_UINTxx_MAX ...

like… the ... is doing a lot of heavy lifting here but that's literally what the page says, so it stays. no cap. 💅

✨ DESCRIPTION ✨

so here's the tea, bestie 🍓 — this header is giving portability icon. the whole vibe is: you write your code against the rtapi_xxx / RTAPI_XXX names, and depending on where you are, something else handles it.

• In kernel space — every single rtapi_xxx or RTAPI_XXX identifier gets mapped to the underlying kernel functionality, if available. that "if available" is doing cardio, keep it in mind. 👑
• In userspace, or in kernels where the underlying functionality isn't provided by a kernel — generally another implementation shows up, and it may come with reduced functionality. 😭

the page's own example, verbatim energy: the userspace implementation for rtapi_device_register always succeeds. so like. it's fine. it's fine!! (it's giving "we just said yes to everything" energy and honestly? respect.) 🌈

✨ REALTIME CONSIDERATIONS ✨

None. zero. nada. the realtime vibe check is clean, we are unbothered, we are at peace 🧚

✨ RETURN VALUE ✨

As in Linux. periodt. 🎀

✨ SEE ALSO ✨

(the page lists nothing here, bestie — so there's nothing to link, and I'm not about to invent one. that would be a fake friend move 🙈)

cute sign-off 💜: this lil page comes to you from the LinuxCNC Documentation, dated 2014-06-28, and yes it's filed under funct(3rtapi). it's short, it's sweet, it's lowkey iconic, and it ate. 🦋✨