qman_retire_fq(9)

✨ NAME ✨

okay bestie, welcome to qman_retire_fq(9) from the Kernel API Manual 💖

qman_retire_fq — Retires a FQ. That’s the whole vibe. 👑

---

🫶 SYNOPSIS 🫶

int qman_retire_fq (struct qman_fq *fq , u32 *flags );

---

🎀 ARGUMENTS 🎀

• fq — the frame queue object to retire, aka the main character getting its retirement arc 🌸
• flags — FQ flags (QMAN_FQ_STATE*) if retirement completes immediately ✨

---

🔥 DESCRIPTION 🔥

Retires the frame queue. This returns zero if it succeeds immediately, +1 if the retirement was started asynchronously, otherwise it returns negative for failure. No cap, that’s the whole return-value situation 💅

When this function returns zero, flags is set to indicate whether the retired FQ is empty and/or whether it has any ORL fragments (to show up as ERNs). Otherwise the corresponding flags will be known when a subsequent FQRN message shows up on the portal's message ring. 🌀

NB, if the retirement is asynchronous (the FQ was in the Truly Scheduled or Active state), the completion will be via the message ring as a FQRN — but the corresponding callback may occur before this function returns!! Ie. the caller should be prepared to accept the callback as the function is called, not only once it has returned. 😭 This is not a drill, bestie — be ready early. 🚨

---

🌈 SEE ALSO 🌈

Kernel file ./include/soc/fsl/qman.h and all these function besties 👑:

• qman_p_irqsource_add(9)
• qman_p_irqsource_remove(9)
• qman_affine_cpus(9)
• qman_affine_channel(9)
• qman_get_affine_portal(9)
• qman_start_using_portal(9)
• qman_p_poll_dqrr(9)
• qman_p_static_dequeue_add(9)
• qman_create_fq(9)
• qman_destroy_fq(9)
• qman_fq_fqid(9)
• qman_init_fq(9)
• qman_schedule_fq(9)
• qman_oos_fq(9)
• qman_enqueue(9)
• qman_alloc_fqid_range(9)
• qman_release_fqid(9)
• qman_query_fq_np(9)
• qman_alloc_pool_range(9)
• qman_release_pool(9)
• qman_create_cgr(9)
• qman_delete_cgr(9)
• qman_delete_cgr_safe(9)
• qman_update_cgr_safe(9)
• qman_query_cgr_congested(9)
• qman_alloc_cgrid_range(9)
• qman_release_cgrid(9)
• qman_is_probed(9)
• qman_portals_probed(9)
• qman_dqrr_get_ithresh(9)
• qman_dqrr_set_ithresh(9)

---

mwah 💋 — source/version is ./include/soc/fsl, dated October 2026. slay, go read those refs 🫶