devm_gpiod_...dex_optional(9)

💖 NAME 💖

devm_gpiod_get_index_optional — it's literally the resource-managed glow-up of gpiod_get_index_optional(), bestie ✨

So this is from the Kernel API Manual, and honestly? She's giving "I handle the cleanup so you don't have to" main character energy 👑

---

🌸 SYNOPSIS 🌸

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

okay so that's the whole signature, no cap — we'll walk through every single piece 🫶

---

🎀 ARGUMENTS 🎀

• dev — the GPIO consumer 👑 like, the device that's gonna be using this GPIO
• con_id — the function within the GPIO consumer 🦋 (the name of the role it's playing)
• index — the index of the GPIO to obtain in the consumer ✨ so if there's more than one, this picks which one
• flags — optional GPIO initialization flags 💅 optional optional, iykyk

---

💜 DESCRIPTION 💜

So this is the managed version of gpiod_get_index_optional. The way that this works: any GPIO descriptors you get back from this function are automatically disposed on driver detach 😭🙌 which is genuinely the best part — no manual cleanup arc, no leaking, just vibes.

For the detailed tea on behavior and return values, go read gpiod_get_index_optional — that's where the full lore lives 📖

---

⭐ RETURN ⭐

Here's what you can get back, and yes there are three whole possibilities:

• the GPIO descriptor corresponding to the function con_id of device dev 💖 (the slay outcome)
• NULL if no GPIO has been assigned to the requested function 🙈 (not an error, just... nothing was assigned)
• or another IS_ERR code if an error occurred while trying to acquire the GPIO 💀 (check for errors properly, fr fr)

bestie please actually check the return value — NULL and IS_ERR are two completely different situations and mixing them up is not the move 🚨

---

🌈 SEE ALSO 🌈

Kernel file ./drivers/gpio/gpiolib-devres.c, plus the whole friend group:

• devm_gpiod_get(9)
• devm_gpiod_get_optional(9)
• devm_gpiod_get_index(9)
• devm_fwnode_gpiod_get_index(9)
• devm_gpiod_get_array(9)
• devm_gpiod_get_array_optional(9)
• devm_gpiod_put(9)
• devm_gpiod_unhinge(9)
• devm_gpiod_put_array(9)
• devm_gpiochip_add_data_with_key(9)

---

okay that's the whole page, periodt 💅 she lives in ./drivers/gpio, dated October 2026, in the Kernel API Manual — go forth and acquire your GPIOs responsibly, ily 🧚💜