Updated documentation about overlapping memory regions and priority to match the latest implementation.
Signed-off-by: Alexey Korolev <akoro...@gmail.com> --- docs/memory.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) 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 ---------- -- 1.7.9.5