spl: Add a comment to spl_set_bd()

There is a strange feature to set global_data to a data-section variable
early in SPL. This only works if SPL actually has access to SRAM which is
not the case on x86, for eaxmple. Add a comment to this effect.

Reviewed-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Simon Glass <sjg@chromium.org>

diff --git a/common/spl/spl.c b/common/spl/spl.c
index 5a026b844e916cadb2a0cb8f9232525324b0be88..43137105bab27863040bcffe5712d71e8b9f4543 100644 (file)
--- a/common/spl/spl.c
+++ b/common/spl/spl.c
@@ -378,6 +378,10 @@ static int spl_common_init(bool setup_malloc)
 
 void spl_set_bd(void)
 {
+       /*
+        * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
+        * writeable.
+        */
        if (!gd->bd)
                gd->bd = &bdata;
 }