DEVICE_SET_DESC(9)

💅 DEVICE_SET_DESC(9) — bestie's guide to device descriptions ✨

okay so this is the Kernel Developer's Manual, and we're talking about device_set_desc, device_set_descf, device_set_desc_copy, and device_get_desc — the little squad that handles a device's description. yes bestie, you're gonna be setting and getting desc strings like a main character 🎀

---

🌸 NAME 🌸

device_set_desc, device_set_descf, device_set_desc_copy, device_get_desc — access the description of a device 💖

---

✨ SYNOPSIS ✨

okay so first the includes, gotta have 'em:

#include <sys/param.h>
#include <sys/bus.h>

then the actual functions, slay:

void
device_set_desc(device_t dev, const char *desc);

void
device_set_descf(device_t dev, const char *fmt, ...);

void
device_set_desc_copy(device_t dev, const char *desc);

const char *
device_get_desc(device_t dev);

---

🔥 DESCRIPTION 🔥

So what we're doing here is manipulating the verbose description of a device — literally its little blurb, its bio, its whole vibe ✨

This description (if it's actually present) gets printed as part of the message when the device is attached during autoconfiguration. so like, it's the thing that shows up in the boot chatter, iconic.

Now the variations, because of course there are variations:

• device_set_desc_copy() — use this one when the string you're passing in is a temporary buffer that's gonna get overwritten 😭 In that case the system copies the string for you. Otherwise (with the plain device_set_desc()), the pointer you passed is just used directly — no copy, no safety net, fr fr.
• device_set_descf() — it's the printf-like version of device_set_desc(). so you can format your desc all cute instead of pre-building the string yourself. obsessed 💅

ngl the pointer-vs-copy distinction is the whole plot here — if your string is temporary and you don't use the _copy version, that's a you problem waiting to happen 🙈

---

🦋 SEE ALSO 🦋

• device(9) — go read it, it's the whole context iykyk 🫶

---

👑 AUTHORS 👑

This manual page was written by Doug Rabson. king behavior, we stan 💖

---

and that's the whole page bestie, no cap 💜 this was the Debian edition, dated January 9, 2024 — catch you in the next manpage, mwah 🎀✨🌈