Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 83814237 authored by Swathi Sridhar's avatar Swathi Sridhar
Browse files

documentation/ion: Add description for secure carveout heap



Add documentation for the secure carveout heap which helps
manage secure memory that is not accessible by the HLOS.

Change-Id: I549d4a434f839f5005750cc2fcd435f00f8eb370
Signed-off-by: default avatarSwathi Sridhar <swatsrid@codeaurora.org>
parent fa101d02
Loading
Loading
Loading
Loading
+30 −0
Original line number Diff line number Diff line
@@ -19,6 +19,7 @@ Required properties for Ion heaps
  the following:
    - "SYSTEM"
    - "CARVEOUT"
    - "SECURE_CARVEOUT"
    - "DMA"
    - "HYP_CMA"
    - "SYSTEM_SECURE"
@@ -57,3 +58,32 @@ Example:
                 };

        };

"SECURE_CARVEOUT"

This heap type is expected to contain multiple child nodes. Each child node
shall contain the following required properties:

- memory-region:
Refer to Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt

- token:
A u32 containing the set of secure domains which will be able to access the
memory-region.

Example:
qcom,ion {
	compatible = "qcom,msm-ion";
	#address-cells = <1>;
	#size-cells = <0>;

	qcom,ion-heap@14 {
		reg = <14>;
		qcom,ion-heap-type = "SECURE_CARVEOUT";

		node1 {
			memory-region = <&cp_region>;
			token = <ION_FLAG_CP_TOUCH>;
		};
	};
};