Skip to content

Commit

Permalink
fix(doc): improve shared memory documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Diogo Costa <[email protected]>
  • Loading branch information
Diogo21Costa committed Sep 17, 2024
1 parent f6b8cde commit 07452d7
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions source/bao_hyp/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -562,11 +562,14 @@ This struct contains the following parameters:

- **size** [mandatory] - defines the total size of the shared memory. The size of the shared \
memory must always be multiples of 4Kb (0x1000);
- **place_phys** [optional] - shared memory is mapped into the virtual memory and it's important \
to note that the guest address might not necessarily be the same as the physical address (PA). \
When ``place_phys`` is set to true, the guest address corresponds to the physical address. By \
default, ``place_phy`` equals to false;
- **base / phys** [optional] - defines the physical address (base address) of the shared memory.
- **place_phys** [optional] - This flag determines the mapping of shared memory into virtual \
memory. When ``place_phys`` is set to ``false`` (default value), the base address is a guest \
(virtual) address. When set to ``true``, the guest address directly corresponds to the physical \
address (PA) of the shared memory.
- **base / phys** [optional] - When ``place_phys`` is set to ``false``, the ``base`` parameter \
should be used to specify the guest virtual address of the shared memory. When place_phys is \
``true``, the ``phys`` parameter should be used to specify the physical address of the shared \
memory.


Configuration File Location
Expand Down

0 comments on commit 07452d7

Please sign in to comment.