[coreboot-gerrit] Change in coreboot[master]: include/device/device: add comment that config_of_soc never returns NULL

[Felix Held (Code Review)]

Felix Held has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/48359 )

Change subject: include/device/device: add comment that config_of_soc never returns NULL
......................................................................

include/device/device: add comment that config_of_soc never returns NULL

Since config_of() calls die() if dev or dev->chip_info are NULL,
config_of_soc() will either return a non-NULL pointer or won't return.

Change-Id: I6de6bb1610e823af215436c94ff1a78ff6b86b78
Signed-off-by: Felix Held 
---
M src/include/device/device.h
1 file changed, 1 insertion(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/59/48359/1

diff --git a/src/include/device/device.h b/src/include/device/device.h
index 8a481b2..786a640 100644
--- a/src/include/device/device.h
+++ b/src/include/device/device.h
@@ -385,6 +385,7 @@
    devtree_die();
 }

+/* config_of_soc() either returns a non-NULL pointer or dies in the config_of() call. */
 static inline DEVTREE_CONST void *config_of_soc(void)
 {
    return config_of(pcidev_on_root(0, 0));