sshp_parse_frame(9)

📦 version 7.3.1, in nixpkgs unstable

💅 sshp_parse_frame(9) — the Kernel API Manual, bestie edition 🦋

okay so real talk, we're looking at sshp_parse_frame today, from the sshp_parse_frame(9) page of the Kernel API Manual. it's the little parser that could, and she is iconic. buckle up 🎀

✨ NAME ✨

sshp_parse_frame — Parse SSH frame. that's it, that's the whole vibe. she parses the frame. 👑

🌸 SYNOPSIS 🌸

int sshp_parse_frame (const struct device *dev , const struct ssam_span
*source , struct ssh_frame **frame , struct ssam_span *payload , size_t
maxlen );

look at her, all signed and int-returning 💖 no cap, copy it exactly, spaces and all, i'm not kidding 🙈

🎀 ARGUMENTS 🎀

  • dev — the device that gets used for logging. she's just here so we have somewhere to gossip, yk? 💬
  • source — the source we're parsing from. the origin story ✨
  • frame — the parsed frame. this one's an output, so she's getting written to, not read. main character actually 🫶
  • payload — the parsed payload, also output. the little friend that comes with the frame 💫
  • maxlen — the maximum supported message length, i.e. the vibe check for how big this message is allowed to be 🔥

🦋 DESCRIPTION 🦋

so what she does is: she parses and validates an SSH frame — payload included, ngl, the whole package 💅 — from the given source. then she sets the provided frame pointer to the start of the frame, and writes the limits of the frame payload into the provided payload span pointer. two pointers, two jobs, she's multitasking and she ate.

the important thing, and the way that i need you to understand this: this function does not copy any data. not a single byte. she's not moving anything around, she's just looking at the message data, validating it, and setting pointers (and length values) so everyone knows where each respective part lives. she's giving pure inspector energy, not mover energy 🔍💜

and if no complete SSH frame could be found? then the frame pointer gets set to the NULL pointer, and the payload span gets set to the null span — that's start pointer NULL, size zero — so nothing's dangling, everything's tidy ✨ no crashy vibes.

🔥 RETURN 🔥

  • returns zero on success, or if the frame is incomplete — incomplete is chillin, she's not mad ❤️
  • -ENOMSG if the start of the message is invalid 🚫
  • -EBADMSG if any CRC is invalid — frame-header CRC or payload CRC, doesn't matter, either one 💀
  • -EMSGSIZE if the SSH message is bigger than the maximum message length specified in the maxlen parameter 🍓

🌈 SEE ALSO 🌈

the whole friend group, honestly 🫶⭐

okay and finally, the sign-off 🎀 this page comes from source ./drivers/platform/surface/agg... and it's dated October 2026 — so go forth, parse those frames, and remember: no copying, only validating. periodt 💅💖🌸

📦 where this page comes from