summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAntonio Nino Diaz <antonio.ninodiaz@arm.com>2017-05-16 09:52:02 +0100
committerAntonio Nino Diaz <antonio.ninodiaz@arm.com>2017-05-16 09:58:08 +0100
commit0da2fe7e29380f1b45286ae8a5a999547d250d33 (patch)
tree9ff074119a21f48cb7c82bef5fadbdf52f64f0d0 /docs
parent823cc7a9d28aa77a8329f7581bb91038935b4df8 (diff)
Simplify assert() to reduce memory usage
The behaviour of assert() now depends on the value of the new optional platform define `PLAT_LOG_LEVEL_ASSERT`. This defaults to `LOG_LEVEL` if not defined by the platform. - If `PLAT_LOG_LEVEL_ASSERT` >= `LOG_LEVEL_VERBOSE`, it prints the file name, line and asserted expression. - If `PLAT_LOG_LEVEL_ASSERT` >= `LOG_LEVEL_INFO`, it prints the file name and line. - If not, it doesn't print anything. Note the old behaviour was to print the function name whereas now it prints the file name. This reduces memory usage because the file name is shared between all assert calls in a given file. Also, the default behaviour in debug builds is to no longer print the asserted expression, greatly reducing the string usage. For FVP debug builds this change saves approximately: No TBBR TBBR BL1 1.6 KB 2.2 KB BL2 1.7 KB 2.1 KB BL31 2.6 KB 3.3 KB Change-Id: I2947569d593df0b25611dc3c7a6096f42155c115 Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/porting-guide.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/porting-guide.md b/docs/porting-guide.md
index 0189ec40..4d7a5ead 100644
--- a/docs/porting-guide.md
+++ b/docs/porting-guide.md
@@ -535,6 +535,17 @@ optionally be defined:
PLAT_PARTITION_MAX_ENTRIES := 12
$(eval $(call add_define,PLAT_PARTITION_MAX_ENTRIES))
+The following constant is optional. It should be defined to override the default
+behaviour of the `assert()` function (for example, to save memory).
+
+* **PLAT_LOG_LEVEL_ASSERT**
+ If `PLAT_LOG_LEVEL_ASSERT` is higher or equal than `LOG_LEVEL_VERBOSE`,
+ `assert()` prints the name of the file, the line number and the asserted
+ expression. Else if it is higher than `LOG_LEVEL_INFO`, it prints the file
+ name and the line number. Else if it is lower than `LOG_LEVEL_INFO`, it
+ doesn't print anything to the console. If `PLAT_LOG_LEVEL_ASSERT` isn't
+ defined, it defaults to `LOG_LEVEL`.
+
### File : plat_macros.S [mandatory]