doc: add more notes and warning for code and doc

Signed-off-by: Huaqi Fang <[email protected]>
riscv-mcu · Dec 6, 2024 · 8c26996 · 8c26996
1 parent e704497
commit 8c26996
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -56,7 +56,10 @@ The flash loader(loader/loader.c) binary will ``loader_main`` with parameters pa
 **The following environment must be setuped**
 
 - **Nuclei Studio Version >= 2024.02**, which contains prebuilt gcc and openocd
-- Don't use any global variables.(**Warning**)
+
+> [!WARNING]
+
+- **WARNING** Don't use any global variables in flashloader implementation source code.
 
 ### Flash Driver API
 
@@ -87,7 +90,7 @@ Initialize nuspi, read flash ID and return the flash ID.
 
 **Return values**
 
-Flash ID（**Warning**）
+Flash ID
 
 #### flash_erase
 

diff --git a/flash/w25q256fv.c b/flash/w25q256fv.c
@@ -1,6 +1,8 @@
 #include "flash.h"
 #include "spi.h"
 
+/* WARNING: NEVER USE GLOBAL VARIABLE IN THIS FILE */
+
 /*==== FLASH ====*/
 #define SPIFLASH_BSY            0
 #define SPIFLASH_BSY_BIT        (1 << SPIFLASH_BSY) /* WIP Bit of SPI SR */

diff --git a/loader/loader.c b/loader/loader.c
@@ -1,5 +1,7 @@
 #include "flash.h"
 
+/* WARNING: NEVER USE GLOBAL VARIABLE IN THIS FILE */
+
 /*==== Loader ====*/
 #define ERASE_CMD           (1)
 #define WRITE_CMD           (2)

diff --git a/spi/fespi.c b/spi/fespi.c
@@ -1,5 +1,7 @@
 #include "spi.h"
 
+/* WARNING: NEVER USE GLOBAL VARIABLE IN THIS FILE */
+
 /* Register offsets */
 #define FESPI_REG_SCKMODE           (0x04)
 #define FESPI_REG_FORCE             (0x0C)

diff --git a/spi/nuspi.c b/spi/nuspi.c
@@ -1,5 +1,7 @@
 #include "spi.h"
 
+/* WARNING: NEVER USE GLOBAL VARIABLE IN THIS FILE */
+
 /* Register offsets */
 #define NUSPI_REG_SCKMODE           (0x04)
 #define NUSPI_REG_FORCE             (0x0C)

diff --git a/test/main.c b/test/main.c
@@ -1,6 +1,8 @@
 #include <stdio.h>
 #include <stdint.h>
 
+/* NOTE: THIS TEST CODE IS USED WITH NUCLEI SDK */
+
 #define DEBUG_INFO          (1)
 
 /*==== Loader ====*/