ENUM K3_RING_MODE(9)

📦 version 7.3.1, in nixpkgs unstable

💅 enum k3_ring_mode(9)

okay bestie, welcome to the Kernel API Manual ✨ we're doing the enum k3_ring_mode page today and honestly? it's a whole vibe. it's the mode field of &struct k3_ring_cfg, iykyk 🎀

✨ NAME ✨

enum k3_ring_mode — literally just the &struct k3_ring_cfg mode. that's the whole name. short king energy 👑

🦋 SYNOPSIS 🦋

enum k3_ring_mode {
    K3_RINGACC_RING_MODE_RING ,
    K3_RINGACC_RING_MODE_MESSAGE ,
    K3_RINGACC_RING_MODE_CREDENTIALS ,
    K3_RINGACC_RING_MODE_INVALID

};

no cap, that's the whole enum. four constants, zero drama 💀

🌸 Constants 🌸

okay so here's the lineup, and each one has its own little personality:

  • K3_RINGACC_RING_MODE_RING — the "exposed Ring" mode, for when SW wants direct access. it's giving main character energy: straight in, no middleman 💅
  • K3_RINGACC_RING_MODE_MESSAGE — Messaging mode, and listen, it is strict: every single access to the queue must go through this IP so that all accesses to the memory are controlled and ordered. this IP then controls the entire state of the queue, and SW has no direct control — like, none — such as through doorbells, and it also cannot access the storage memory directly. 🙈 why is this useful? because it's particularly useful when more than one SW or HW entity can be the producer and/or consumer at the same time. shared queue chaos? handled. periodt 🔥
  • K3_RINGACC_RING_MODE_CREDENTIALS — Credentials mode is literally message mode plus it stores credentials with each message, which means the element size has to be doubled to fit the credentials. ⭐ and heads up: any exposed memory should be protected by a firewall from unwanted access. that's a real warning, bestie, not decoration 🫶
  • K3_RINGACC_RING_MODE_INVALID — -- undescribed -- 😭 the manpage literally has nothing for this one. we respect the mystery. 🧚

💜 Description 💜

RA ring operational modes. that's it, that's the description. iconic minimalism 🌈

🌟 SEE ALSO 🌟

go read these next, they're all in the Kernel file ./include/linux/soc/ti/k3-ringacc.h:

one thing fr fr: K3_RINGACC_RING_MODE_MESSAGE and K3_RINGACC_RING_MODE_CREDENTIALS both mean SW loses direct control of the queue, and credentials mode doubles your element size. plan accordingly, gorgeous 💖

and that's the page!! sourced from ./include/linux/soc/ti, dated October 2026, filed under enum k3_ring_mode(9) — mwah, slay, go read your ringacc docs 🎀💅✨

📦 where this page comes from