funct(3rtapi)

funct(3rtapi) 💖

okay bestie, welcome to the RTAPI corner of the manual — this one's from section 3, and it's all about firmware wrappers. yes, firmware. slay. 🎀

✨ NAME ✨

rtapi_firmware.h — RTAPI wrappers for linux kernel functionality 🧚

🌸 SYNTAX 🌸

like, here's how you actually pull it in, no cap:

#include <rtapi_firmware.h>

struct rtapi_firmware;

int rtapi_request_firmware(const struct rtapi_firmware **fw,
           const char *name, struct rtapi_device *device);

void rtapi_release_firmware(const struct rtapi_firmware *fw);

💅 DESCRIPTION 💅

so the whole vibe here is: in kernel space, every single rtapi_xxx or RTAPI_XXX identifier gets mapped onto the underlying kernel functionality — if it's available. periodt. ✨

and in userspace, or in kernels where the underlying functionality isn't provided by a kernel at all? generally you get another implementation instead — and lowkey it might come with reduced functionality. 🙈 like, for example, the userspace implementation for rtapi_device_register always succeeds. iconic behaviour honestly.

🔥 REALTIME CONSIDERATIONS 🔥

typically, these functions may be called from realtime init/cleanup code. that's it, that's the tea. ☕

⭐ RETURN VALUE ⭐

as in Linux. fr fr. 🫶

🌈 SEE ALSO 🌈

(no references listed here, bestie — that's the whole section) 💜

and that's a wrap! this page came to you from the LinuxCNC Documentation, dated 2014-06-28, living at funct(3rtapi). go forth and request some firmware, queen. 👑💖