board: rockchip: Add Edgeble Neural Compute Module 6

[platform/kernel/u-boot.git] / doc / README.POST

diff --git a/doc/README.POST b/doc/README.POST
index eeb218d..1366f95 100644 (file)
--- a/doc/README.POST
+++ b/doc/README.POST
@@ -126,7 +126,7 @@ The following flags will be defined:
 
 The POST layer will export the following interface routines:
 
-  o) int post_run(bd_t *bd, char *name, int flags);
+  o) int post_run(struct bd_info *bd, char *name, int flags);
 
      This routine will run the test (or the group of tests) specified
      by the name and flag arguments. More specifically, if the name
@@ -159,17 +159,6 @@ The POST layer will export the following interface routines:
 Also, the following board-specific routines will be called from the
 U-Boot common code:
 
-  o) int board_power_mode(void)
-
-     This routine will return the mode the system is running in
-     (POST_POWERON, POST_NORMAL or POST_SHUTDOWN).
-
-  o) void board_poweroff(void)
-
-     This routine will turn off the power supply of the board. It
-     will be called on power-fail booting after running all POST
-     tests.
-
   o) int post_hotkeys_pressed(gd_t *gd)
 
      This routine will scan the keyboard to detect if a magic key
@@ -186,7 +175,7 @@ struct post_test {
     char *cmd;
     char *desc;
     int flags;
-    int (*test)(bd_t *bd, int flags);
+    int (*test)(struct bd_info *bd, int flags);
 };
 
   o) name
@@ -253,11 +242,11 @@ storage server and etc.
 
 All POST-related code will be #ifdef'ed with the CONFIG_POST macro.
 This macro will be defined in the config_<board>.h file for those
-boards that need POST. The CONFIG_POST macro will contain the list of
+boards that need POST. The CFG_POST macro will contain the list of
 POST tests for the board. The macro will have the format of array
 composed of post_test structures:
 
-#define CONFIG_POST \
+#define CFG_POST \
        {
                "On-board peripherals test", "board", \
                "  This test performs full check-up of the " \
@@ -268,7 +257,7 @@ composed of post_test structures:
 
 A new file, post.h, will be created in the include/ directory. This
 file will contain common POST declarations and will define a set of
-macros that will be reused for defining CONFIG_POST. As an example,
+macros that will be reused for defining CFG_POST. As an example,
 the following macro may be defined:
 
 #define POST_CACHE \
@@ -375,7 +364,7 @@ declaration/body:
 ...
 
 ...
-int watchdog_post_test(bd_t *bd, int flags)
+int watchdog_post_test(struct bd_info *bd, int flags)
 {
        unsigned long start_time;
 
@@ -494,7 +483,7 @@ This test will verify the following ALU instructions:
      This group will contain: b, bl, bc.
 
      The first 2 instructions (b, bl) will be verified by jumping to
-     a fixed address and checking whether control was transfered to
+     a fixed address and checking whether control was transferred to
      that very point. For the bl instruction the value of the link
      register will be checked as well (using mfspr). To verify the bc
      instruction various combinations of the BI/BO fields, the CTR
@@ -659,12 +648,19 @@ not need any modifications for porting them to another board/CPU.
 2.2.2.1. I2C test
 
 For verifying the I2C bus, a full I2C bus scanning will be performed
-using the i2c_probe() routine. If any I2C device is found, the test
-will be considered as passed, otherwise failed. This particular way
-will be used because it provides the most common method of testing.
-For example, using the internal loopback mode of the CPM I2C
-controller for testing would not work on boards where the software
-I2C driver (also known as bit-banged driver) is used.
+using the i2c_probe() routine. If a board defines
+CFG_SYS_POST_I2C_ADDRS the I2C test will pass if all devices
+listed in CFG_SYS_POST_I2C_ADDRS are found, and no additional
+devices are detected.  If CFG_SYS_POST_I2C_ADDRS is not defined
+the test will pass if any I2C device is found.
+
+The CFG_SYS_POST_I2C_IGNORES define can be used to list I2C
+devices which may or may not be present when using
+CFG_SYS_POST_I2C_ADDRS.  The I2C POST test will pass regardless
+if the devices in CFG_SYS_POST_I2C_IGNORES are found or not.
+This is useful in cases when I2C devices are optional (eg on a
+daughtercard that may or may not be present) or not critical
+to board operation.
 
 2.2.2.2. Watchdog timer test