devm_gpiod_get_index(9)

📦 version 7.3.1, in nixpkgs unstable

💅 devm_gpiod_get_index 💅

okay bestie, welcome to the Kernel API Manual — yes we're reading kernel docs for fun now, this is who we are 💖

🌸 NAME 🌸

devm_gpiod_get_index — it's gpiod_get_index(), but make it resource-managed ✨ (the devm girlies simply do not do manual cleanup)

🎀 SYNOPSIS 🎀

struct gpio_desc * devm_gpiod_get_index (struct device *dev , const char *con_id , unsigned int idx , enum gpiod_flags flags );

like… it returns a struct gpio_desc * and takes four things. that's the whole vibe check 🦋

✨ ARGUMENTS ✨

  • dev — the GPIO consumer, aka the device that's being all "I want a GPIO 🥺"
  • con_id — the function within the GPIO consumer. it's the which one of it all, ykyk
  • idx — index of the GPIO to obtain in the consumer. yes there can be multiple, slay 👑
  • flags — optional GPIO initialization flags. optional bestie, don't stress 🫶

🧚 DESCRIPTION 🧚

so this is the Managed gpiod_get_index. the GPIO descriptors you get back from this function are automatically disposed on driver detach — no cap, you literally don't have to free them yourself, the devm machinery handles it 💅✨

the way that this is just the tidy version… obsessed 😭

if you want the detailed tea on behavior and return values, go read gpiod_get_index — that's the main character, this one's the resource-managed remix 🌈

🔥 RETURN 🔥

  • the GPIO descriptor corresponding to the function con_id of device dev — the good ending 💖
  • -ENOENT if no GPIO has been assigned to the requested function — like, it's not there, bestie 💀
  • or another IS_ERR code if an error occurred while trying to acquire the GPIO — check for errors always, fr fr 🙈

⭐ SEE ALSO ⭐

Kernel file ./drivers/gpio/gpiolib-devres.c and its besties:

like a whole friend group of devm GPIO functions, and every single one of them ate 💅🎀

heads up: the managed cleanup only kicks in on driver detach, so this is a driver vibe — it's giving devres, not giving "call it from your random userspace-adjacent code". also remember -ENOENT and the other IS_ERR codes have different meanings, so check properly 🌸

okay that's the whole page! brought to you by the kernel source tree at ./drivers/gpio, dated October 2026 — periodt, go get your GPIOs bestie 💜🦋✨

📦 where this page comes from