funct(3rtapi)

💖 funct — the RTAPI byte-order bestie 💖

okay so this is funct from section 3rtapi of the RTAPI manual, and honestly? it's a lil header file doing the absolute most so you don't have to. rtapi_byteorder.h is literally the RTAPI wrapper glow-up for linux kernel functionality, and she's here to tell you which way your bytes are facing. 🦋

✨ NAME ✨

rtapi_byteorder.h — RTAPI wrappers for linux kernel functionality

🌸 SYNTAX 🌸

#include <rtapi_byteorder.h>

• RTAPI_BIG_ENDIAN — defined to 1 if the platform is big-endian, 0 otherwise 💅
• RTAPI_LITTLE_ENDIAN — defined to 1 if the platform is little-endian, 0 otherwise ✨
• RTAPI_FLOAT_BIG_ENDIAN — defined to 1 if the platform double-precision value is big-endian, 0 otherwise. 🎀

🫶 DESCRIPTION 🫶

ok so here's the tea, bestie. In kernel space, every single rtapi_xxx or RTAPI_XXX identifier gets mapped straight onto the underlying kernel functionality — if available. that's it, that's the mapping. no cap. 👑

In userspace, or in kernels where the underlying functionality isn't provided by a kernel, generally another implementation is provided — and lowkey it might have reduced functionality. (for example: the userspace implementation for rtapi_byteorder_register always succeeds. iconic behaviour, honestly, she never misses 💀✨)

🔥 REALTIME CONSIDERATIONS 🔥

may be used at any time. that's the whole vibe check and she passed it. no realtime drama, no restrictions, just vibes. 🌈

⭐ RETURN VALUE ⭐

as in Linux. periodt. 💅

💜 SEE ALSO 💜

• LinuxCNC Documentation

and that's the whole page, bestie!! go forth and byte-order responsibly 🎀🦋💖

this lil masterpiece is from the LinuxCNC Documentation, dated 2014-06-28, and she lives in funct(3rtapi). mwah 💋