[RFC PATCH] Documentation/arm64: describe the kernel's expectations of 'memory'

[James Morse]

Standards such as CXL allow memory on PCIe devices to be made
available to the operating system for use as regular memory.

Document linux's expectations around the behaviour of memory as the
implementations of these new standards may need special treatment in
the OS, firmware or bootloader.

Signed-off-by: James Morse <james.morse at arm.com>
---
 Documentation/arm64/memory.rst | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/Documentation/arm64/memory.rst b/Documentation/arm64/memory.rst
index 901cd094f4ec..951802aee55f 100644
--- a/Documentation/arm64/memory.rst
+++ b/Documentation/arm64/memory.rst
@@ -167,3 +167,34 @@ from a 52-bit space by enabling the following kernel config options:
 
 Note that this option is only intended for debugging applications
 and should not be used in production.
+
+On device memory used as regular memory
+---------------------------------------
+Standards such as CXL allow memory on PCIe device to be made
+available to the operating system for use as regular memory.
+
+If memory is added to the UEFI memory map or DT, or discovered via ACPI's SRAT,
+linux expects it to function in the same way as the bulk DRAM. This section
+terms this 'regular memory'.
+
+The kernel may use any attributes to map this memory, e.g. Device-nGnRnE or
+Normal Writeback-Cacheable. The kernel may not be in control of the attributes
+used, e.g. if the memory is used by a KVM guest.
+The kernel will perform cache maintenance to resolve mismatched attributes,
+e.g. invalidating clean stale lines after writing new data when the MMU is
+disabled.
+
+The memory may be used by any instruction supported by the CPUs.
+e.g. Even when the v8.1 LSE atomic instructions are supported, the v8.0
+exclusives are still used for the futex code, and conditional waits, and still
+used by existing user-space binaries. When the CPUs support features such as
+MTE, all regular memory must support MTE tags.
+
+On device memory that does not function in the same way as regular memory must
+not be added to the UEFI memory map or DT, or be discovered via ACPI's SRAT.
+
+On arm64, the kernel does not rewrite the UEFI memory map when memory is added
+or removed. On device memory that is present at boot, but must be removed later
+should be discovered via ACPI's SRAT to ensure it is not used for non-movable
+structures.
+e.g. the kernel text, page tables or the GIC ITS Pending Table.
-- 
2.30.0