SSAM_DEFINE_SYNC_REQUEST_R(9)

💫 SSAM_DEFINE_SYNC_REQUEST_R 💫

okay bestie, this is a page from the Kernel API Manual (kernel macro era, we love to see it) and it's literally about defining a synchronous SAM request function that hands you a return value. she's giving "make the compiler write the boring part for you" and honestly? iconic. ✨

---

🎀 NAME 🎀

SSAM_DEFINE_SYNC_REQUEST_R — the macro that defines a synchronous SAM request function with a return value. no cap, that's the whole vibe. 💅

---

🌸 SYNOPSIS 🌸

SSAM_DEFINE_SYNC_REQUEST_R (name , rtype , spec... );

---

🦋 ARGUMENTS 🦋

• name — the name your shiny new generated function gets. main character naming rights fr fr. 👑
• rtype — the type of the request's return value. like, what are we getting back here bestie.
• spec — the specification (struct ssam_request_spec) that actually defines the request. the blueprint, the whole plan. 📋

---

💖 DESCRIPTION 💖

so what this does: it defines a function that executes the synchronous SAM request specified by spec. the request takes no argument, but it does have a return value of type rtype. so it's the "no thoughts, just results" one of the family. 🙈

the generated function handles literally all the setup for you — setting up the request and response structs, buffer allocation, and then actually executing the request itself. it returns once the request has been fully completed, so no sneaky async nonsense, she waits. the required transport buffer gets allocated on the stack. ✨

here's the generated function's shape, exactly:

static int name(struct ssam_controller *ctrl, rtype *ret)

it returns the status of the request — zero on success and negative on failure. 🙏

• the ctrl parameter is the controller via which the request is sent (the transport bestie 🚀)
• the request's return value gets written to the memory pointed to by the ret parameter (that's your little output slot 🫶)

if you want the full tea on how the generated function behaves, go read ssam_request_do_sync_onstack. she's the source of truth. ⭐

---

🔥 SEE ALSO 🔥

Kernel file ./include/linux/surface_aggregator/controller.h, plus the whole friend group:

• enum ssam_event_flags(9)
• struct ssam_event(9)
• enum ssam_request_flags(9)
• struct ssam_request(9)
• struct ssam_response(9)
• struct ssam_request_sync(9)
• ssam_request_sync_set_data(9)
• ssam_request_sync_set_resp(9)
• ssam_request_sync_wait(9)
• ssam_request_do_sync_onstack(9)
• __ssam_retry(9)
• ssam_retry(9)
• struct ssam_request_spec(9)
• struct ssam_request_spec_md(9)
• SSAM_DEFINE_SYNC_REQUEST_N(9)
• SSAM_DEFINE_SYNC_REQUEST_W(9)
• SSAM_DEFINE_SYNC_REQUEST_WR(9)
• SSAM_DEFINE_SYNC_REQUEST_MD_N(9)
• SSAM_DEFINE_SYNC_REQUEST_MD_W(9)
• SSAM_DEFINE_SYNC_REQUEST_MD_R(9)
• SSAM_DEFINE_SYNC_REQUEST_MD_WR(9)
• enum ssam_notif_flags(9)
• struct ssam_notifier_block(9)
• ssam_notifier_from_errno(9)
• ssam_notifier_to_errno(9)
• struct ssam_event_registry(9)
• struct ssam_event_id(9)
• enum ssam_event_mask(9)
• SSAM_EVENT_REGISTRY(9)
• enum ssam_event_notifier_flags(9)
• struct ssam_event_notifier(9)
• ssam_notifier_unregister(9)

---

and that's the whole page, bestie, love that for us 💜

sign-off time: this little number lives at source ./include/linux/surface_aggreg..., dated October 2026, and yes, the whole thing is filed under SSAM_DEFINE_SYNC_REQUEST_R(9) 🍓🧚 go forth and define your requests. periodt. 💅