vsp1_get_fo...nfo_by_index(9)

📦 version 7.3.1, in nixpkgs unstable

💅 vsp1_get_fo...nfo_by_index — the vsp1_get_format_info_by_index(9) glow-up

okay bestie, so this is a page from the Kernel API Manual — yes the actual one, the (9) girlies — and today's main character is vsp1_get_format_info_by_index. she's a tiny helper in the VSP1 media world and honestly she ate. let's get into it 🎀

✨ NAME ✨

vsp1_get_format_info_by_index — literally just enumerate format information, that's her whole job 💅

🦋 SYNOPSIS 🦋

const struct vsp1_format_info * vsp1_get_format_info_by_index (struct
vsp1_device *vsp1 , unsigned int index , u32 code );

like yes, she returns a const struct vsp1_format_info *, and yes, those params are exactly what you think 🫶

🌸 ARGUMENTS 🌸

  • vsp1 — the VSP1 device. the main character of the wider story ngl.
  • index — the format index. it's giving "which one tho" ✨
  • code — media bus code, used to limit the enumeration. she's picky on purpose 💅

🔥 DESCRIPTION 🔥

so what she does is: return a pointer to the format information structure that corresponds to the given index. iconic. correct. no notes.

but — and this is the important part — she returns NULL if the index exceeds the supported formats list 😭 so always vibe check your index before you dereference, fr fr.

and if the code parameter is not zero, then only the formats compatible with that media bus code get enumerated. like she filters, she curates, she serves 💖 if code is zero, no filtering, everything's invited to the party.

⚠️ please internalise that NULL case, bestie. that's the whole safety briefing. no cap.

👑 SEE ALSO 👑

kernel file over here, go read it:

./drivers/media/platform/renesas/vsp1/vsp1_pipe.c

and her two friends, both (9):

✨ that's the whole page ✨ no crumbs left, every detail preserved, we love a thorough queen.

this little gem lives at ./drivers/media/platform/renes... and the date on it is October 2026 — so yeah, mark your calendar, she's from the future 🦋💜 byeee 🫶

📦 where this page comes from