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

List overview All Threads
Download

newer

older

Change in coreboot[master]:...

Felix Held (Code Review)

5 Dec 2020 5 Dec '20

3:12 p.m.

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 felix-coreboot@felixheld.de --- 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));

Attachments:

attachment.htm (text/html — 2.4 KB)

Show replies by date

Angel Pons (Code Review)

5 Dec 5 Dec

4:46 p.m.

Angel Pons has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/48359 )

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

Patch Set 1:

(1 comment)

https://review.coreboot.org/c/coreboot/+/48359/1/src/include/device/device.h File src/include/device/device.h:

https://review.coreboot.org/c/coreboot/+/48359/1/src/include/device/device.h... PS1, Line 388: /* config_of_soc() either returns a non-NULL pointer or dies in the config_of() call. */ I wouldn't expect anyone to read this comment if they won't read the code right above it anyway.

-- To view, visit https://review.coreboot.org/c/coreboot/+/48359 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I6de6bb1610e823af215436c94ff1a78ff6b86b78 Gerrit-Change-Number: 48359 Gerrit-PatchSet: 1 Gerrit-Owner: Felix Held felix-coreboot@felixheld.de Gerrit-Reviewer: Furquan Shaikh furquan@google.com Gerrit-Reviewer: Marshall Dawson marshalldawson3rd@gmail.com Gerrit-Reviewer: Martin Roth martinroth@google.com Gerrit-Reviewer: Nico Huber nico.h@gmx.de Gerrit-Reviewer: build bot (Jenkins) no-reply@coreboot.org Gerrit-CC: Angel Pons th3fanbus@gmail.com Gerrit-Comment-Date: Sat, 05 Dec 2020 19:46:56 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Gerrit-MessageType: comment

Alexander Couzens (Code Review)

4:49 p.m.

Alexander Couzens has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/48359 )

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

Patch Set 1: Code-Review+2

-- To view, visit https://review.coreboot.org/c/coreboot/+/48359 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I6de6bb1610e823af215436c94ff1a78ff6b86b78 Gerrit-Change-Number: 48359 Gerrit-PatchSet: 1 Gerrit-Owner: Felix Held felix-coreboot@felixheld.de Gerrit-Reviewer: Alexander Couzens lynxis@fe80.eu Gerrit-Reviewer: Furquan Shaikh furquan@google.com Gerrit-Reviewer: Marshall Dawson marshalldawson3rd@gmail.com Gerrit-Reviewer: Martin Roth martinroth@google.com Gerrit-Reviewer: Nico Huber nico.h@gmx.de Gerrit-Reviewer: build bot (Jenkins) no-reply@coreboot.org Gerrit-CC: Angel Pons th3fanbus@gmail.com Gerrit-Comment-Date: Sat, 05 Dec 2020 19:49:24 +0000 Gerrit-HasComments: No Gerrit-Has-Labels: Yes Gerrit-MessageType: comment

Alexander Couzens (Code Review)

4:50 p.m.

Alexander Couzens has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/48359 )

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

Patch Set 1:

(1 comment)

https://review.coreboot.org/c/coreboot/+/48359/1/src/include/device/device.h File src/include/device/device.h:

https://review.coreboot.org/c/coreboot/+/48359/1/src/include/device/device.h... PS1, Line 388: /* config_of_soc() either returns a non-NULL pointer or dies in the config_of() call. */

...

I wouldn't expect anyone to read this comment if they won't read the code right above it anyway.

when using an IDE you might run into this. I might also run into it without an ide ;)

-- To view, visit https://review.coreboot.org/c/coreboot/+/48359 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I6de6bb1610e823af215436c94ff1a78ff6b86b78 Gerrit-Change-Number: 48359 Gerrit-PatchSet: 1 Gerrit-Owner: Felix Held felix-coreboot@felixheld.de Gerrit-Reviewer: Alexander Couzens lynxis@fe80.eu Gerrit-Reviewer: Furquan Shaikh furquan@google.com Gerrit-Reviewer: Marshall Dawson marshalldawson3rd@gmail.com Gerrit-Reviewer: Martin Roth martinroth@google.com Gerrit-Reviewer: Nico Huber nico.h@gmx.de Gerrit-Reviewer: build bot (Jenkins) no-reply@coreboot.org Gerrit-CC: Angel Pons th3fanbus@gmail.com Gerrit-Comment-Date: Sat, 05 Dec 2020 19:50:02 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Angel Pons th3fanbus@gmail.com Gerrit-MessageType: comment

Felix Held (Code Review)

5:56 p.m.

Felix Held has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/48359 )

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

Patch Set 1:

(1 comment)

https://review.coreboot.org/c/coreboot/+/48359/1/src/include/device/device.h File src/include/device/device.h:

https://review.coreboot.org/c/coreboot/+/48359/1/src/include/device/device.h... PS1, Line 388: /* config_of_soc() either returns a non-NULL pointer or dies in the config_of() call. */

...

when using an IDE you might run into this. […]

my IDE (SlickEdit) shows when i hover over the function name with the cursor which it doesn't do without the comment here

-- To view, visit https://review.coreboot.org/c/coreboot/+/48359 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I6de6bb1610e823af215436c94ff1a78ff6b86b78 Gerrit-Change-Number: 48359 Gerrit-PatchSet: 1 Gerrit-Owner: Felix Held felix-coreboot@felixheld.de Gerrit-Reviewer: Alexander Couzens lynxis@fe80.eu Gerrit-Reviewer: Furquan Shaikh furquan@google.com Gerrit-Reviewer: Marshall Dawson marshalldawson3rd@gmail.com Gerrit-Reviewer: Martin Roth martinroth@google.com Gerrit-Reviewer: Nico Huber nico.h@gmx.de Gerrit-Reviewer: build bot (Jenkins) no-reply@coreboot.org Gerrit-CC: Angel Pons th3fanbus@gmail.com Gerrit-Comment-Date: Sat, 05 Dec 2020 20:56:51 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No Comment-In-Reply-To: Angel Pons th3fanbus@gmail.com Comment-In-Reply-To: Alexander Couzens lynxis@fe80.eu Gerrit-MessageType: comment

Felix Held (Code Review)

6 Dec 6 Dec

4 p.m.

Felix Held has submitted this change. ( 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 felix-coreboot@felixheld.de Reviewed-on: https://review.coreboot.org/c/coreboot/+/48359 Tested-by: build bot (Jenkins) no-reply@coreboot.org Reviewed-by: Alexander Couzens lynxis@fe80.eu --- M src/include/device/device.h 1 file changed, 1 insertion(+), 0 deletions(-)

Approvals: build bot (Jenkins): Verified Alexander Couzens: Looks good to me, approved

+/* 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));

-- To view, visit https://review.coreboot.org/c/coreboot/+/48359 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-Change-Id: I6de6bb1610e823af215436c94ff1a78ff6b86b78 Gerrit-Change-Number: 48359 Gerrit-PatchSet: 2 Gerrit-Owner: Felix Held felix-coreboot@felixheld.de Gerrit-Reviewer: Alexander Couzens lynxis@fe80.eu Gerrit-Reviewer: Felix Held felix-coreboot@felixheld.de Gerrit-Reviewer: Furquan Shaikh furquan@google.com Gerrit-Reviewer: Marshall Dawson marshalldawson3rd@gmail.com Gerrit-Reviewer: Martin Roth martinroth@google.com Gerrit-Reviewer: Nico Huber nico.h@gmx.de Gerrit-Reviewer: build bot (Jenkins) no-reply@coreboot.org Gerrit-CC: Angel Pons th3fanbus@gmail.com Gerrit-CC: Paul Menzel paulepanter@users.sourceforge.net Gerrit-MessageType: merged

1308

days inactive

1309

days old

coreboot-gerrit@coreboot.org

5 comments

3 participants

tags (0)

participants (3)

Alexander Couzens (Code Review)
Angel Pons (Code Review)
Felix Held (Code Review)