refactor(mm): document quirks
Log when quirks are triggered, and document them in `mm_test.cc`.
Change-Id: I591f43ae2e650d6a58c5823b7f69288717069f89
Signed-off-by: Karl Meakin <karl.meakin@arm.com>
diff --git a/src/mm_test.cc b/src/mm_test.cc
index 99bf08a..d060139 100644
--- a/src/mm_test.cc
+++ b/src/mm_test.cc
@@ -300,8 +300,11 @@
/**
* Mapping a reverse range, i.e. the end comes before the start, is treated as
* an empty range so no mappings are made.
+ *
+ * This serves as a form of documentation of behaviour rather than a
+ * requirement. Check whether any code relies on this before changing it.
*/
-TEST_F(mm, map_reverse_range)
+TEST_F(mm, map_reverse_range_quirk)
{
constexpr mm_mode_t mode = 0;
ipaddr_t ipa = ipa_init(-1);
@@ -320,7 +323,7 @@
* This serves as a form of documentation of behaviour rather than a
* requirement. Check whether any code relies on this before changing it.
*/
-TEST_F(mm, map_reverse_range_quirk)
+TEST_F(mm, map_reverse_range_rounded_quirk)
{
constexpr mm_mode_t mode = 0;
ipaddr_t ipa = ipa_init(-1);
@@ -922,8 +925,11 @@
/**
* The mode of unmapped addresses can be retrieved and is set to invalid,
* unowned and shared.
+ *
+ * This serves as a form of documentation of behaviour rather than a
+ * requirement. Check whether any code relies on this before changing it.
*/
-TEST_F(mm, get_mode_empty)
+TEST_F(mm, get_mode_empty_quirk)
{
constexpr int default_mode =
MM_MODE_INVALID | MM_MODE_UNOWNED | MM_MODE_SHARED;