[coreboot-gerrit] Change in coreboot[master]: device: Clarify use of `config_of()`

[Nico Huber (Code Review)]

Nico Huber has submitted this change. ( https://review.coreboot.org/c/coreboot/+/46046 )

Change subject: device: Clarify use of `config_of()`
......................................................................

device: Clarify use of `config_of()`

We don't want unnecessary die() calls to spread throughout coreboot.
Chances are high that we'd add a NON_FATAL_DIE Kconfig eventually.

Change-Id: I01c7efdf23672bad3a195b7dc1565a3cc8a087bd
Signed-off-by: Nico Huber 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/46046
Reviewed-by: Angel Pons 
Reviewed-by: Werner Zeh 
Tested-by: build bot (Jenkins) 
---
M src/include/device/device.h
1 file changed, 6 insertions(+), 0 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Werner Zeh: Looks good to me, approved
  Angel Pons: Looks good to me, approved

diff --git a/src/include/device/device.h b/src/include/device/device.h
index b53b64a..031091a 100644
--- a/src/include/device/device.h
+++ b/src/include/device/device.h
@@ -339,6 +339,12 @@
 void devtree_bug(const char *func, pci_devfn_t devfn);
 void __noreturn devtree_die(void);

+/*
+ * Dies if `dev` or `dev->chip_info` are NULL. Returns `dev->chip_info` otherwise.
+ *
+ * Only use if missing `chip_info` is fatal and we can't boot. If it's
+ * not fatal, please handle the NULL case gracefully.
+ */
 static inline DEVTREE_CONST void *config_of(const struct device *dev)
 {
    if (dev && dev->chip_info)