_is_module_ready(9)

πŸ“¦ version 7.3.1, in nixpkgs unstable

πŸ’… _is_module_ready(9)

okay so this is a page from the Kernel API Manual and honestly? it's a little baddie of a function. it answers one (1) very important question: can we touch this module's registers without the whole thing going abort on us? 🫢


✨ NAME ✨

_is_module_ready β€” can module registers be accessed without causing an abort?

like, literally, is it safe to poke the registers or are we about to have a bad time. that's the whole vibe check. πŸ’€


πŸŽ€ SYNOPSIS πŸŽ€

bool _is_module_ready (u8 part , u16 inst , u16 clkctrl_offs );

it returns a bool, bestie. true or false. that's the whole API. πŸ”₯


🌸 ARGUMENTS 🌸

  • part β€” the PRCM partition ID, i.e. which partition the CM_CLKCTRL register lives in. it's a u8, keep it cute.
  • inst β€” the CM instance register offset. you get this from the *_INST macro, mkay? 🎯
  • clkctrl_offs β€” the module clock control register offset, courtesy of the *_CLKCTRL macro. very demure, very macro. ✨

πŸ‘‘ DESCRIPTION πŸ‘‘

returns true if the module's CM_*_CLKCTRL.IDLEST bitfield is either *FUNCTIONAL or *INTERFACE_IDLE. returns false otherwise.

that's it. that's the function. it looks at the IDLEST bits and tells you if the module is chill or not chill. no cap. πŸ’…

bestie note: if it comes back false, do not go accessing those registers anyway. that's the abort. we don't do aborts here. πŸ™ˆ

πŸ¦‹ SEE ALSO πŸ¦‹

all the siblings and cousins, fr fr β€” and they're all in the kernel file ./arch/arm/mach-omap2/cminst44xx.c:

go read them. iykyk. πŸ“šβœ¨


k bye bestie!! πŸ§šπŸ’– this iconic little page lives in ./arch/arm/mach-omap2 and was stamped October 2026 β€” mwah, slay, periodt. πŸŽ€πŸ’œ

πŸ“¦ where this page comes from