Patchwork [3/3] Docs update: Overlapping memory regions and priority

login
register
mail settings
Submitter Alexey Korolev
Date Feb. 18, 2013, 11:12 p.m.
Message ID <1361229171-23902-4-git-send-email-akorolex@gmail.com>
Download mbox | patch
Permalink /patch/221554/
State New
Headers show

Comments

Alexey Korolev - Feb. 18, 2013, 11:12 p.m.
Updated documentation about overlapping memory regions and priority
to match the latest implementation.

Signed-off-by: Alexey Korolev <akorolex@gmail.com>
---
 docs/memory.txt |   14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

Patch

diff --git a/docs/memory.txt b/docs/memory.txt
index 5bbee8e..37ebeb8 100644
--- a/docs/memory.txt
+++ b/docs/memory.txt
@@ -70,13 +70,13 @@  guest.
 
 Overlapping regions and priority
 --------------------------------
-Usually, regions may not overlap each other; a memory address decodes into
-exactly one target.  In some cases it is useful to allow regions to overlap,
-and sometimes to control which of an overlapping regions is visible to the
-guest.  This is done with memory_region_add_subregion_overlap(), which
-allows the region to overlap any other region in the same container, and
-specifies a priority that allows the core to decide which of two regions at
-the same address are visible (highest wins).
+In some cases memory regions may overlap each other, when two regions are
+pretending for the same address range. The control of which of an overlapping
+regions is visible to the guest is done with memory_region_set_priority().
+There are four predefined priorities MR_PRIORITY_LOW, MR_PRIORITY_MEDIUM,
+MR_PRIORITY_HIGH and MR_PRIORITY_EXCLUSIVE. The MR_PRIORITY_EXCLUSIVE is
+the highest priority and regions with this priority must never be overlapped.
+By default memory regions are initialised with priority MR_PRIORITY_LOW.
 
 Visibility
 ----------