cbmem.h: Align comment with the reality of implementations

cbmem_top() should simply not be called before memory is initialed,
in order for the implementation to return something meaningful.

Change-Id: I8fe32844af290626a0f91279143fda4d3442680f
Signed-off-by: Arthur Heymans <arthur@aheymans.xyz>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/36334
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-by: Michael Niewöhner
This commit is contained in:
Arthur Heymans 2019-10-25 18:06:58 +02:00 committed by Nico Huber
parent eafc81514a
commit b759a4f987
1 changed files with 2 additions and 3 deletions

View File

@ -71,9 +71,8 @@ void cbmem_top_init(void);
/* Return the top address for dynamic cbmem. The address returned needs to /* Return the top address for dynamic cbmem. The address returned needs to
* be consistent across romstage and ramstage, and it is required to be * be consistent across romstage and ramstage, and it is required to be
* below 4GiB for 32bit coreboot builds. On 64bit coreboot builds there's no * below 4GiB for 32bit coreboot builds. On 64bit coreboot builds there's no
* upper limit. * upper limit. This should not be called before memory is initialized.
* x86 boards or chipsets must return NULL before the cbmem backing store has */
* been initialized. */
void *cbmem_top(void); void *cbmem_top(void);
/* Add a cbmem entry of a given size and id. These return NULL on failure. The /* Add a cbmem entry of a given size and id. These return NULL on failure. The