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

Commit 8df41f47 authored by Swathi Sridhar's avatar Swathi Sridhar
Browse files

documentation: dt-bindings: mem-offline: Add doc for offline-sizes 



Add documentation for offline-sizes which helps specify
an array of offlinable memory region sizes to apply to
targets based on their DDR sizes.

Change-Id: I9c356528799c969fecb65f287cc895fb4627dbbc
Signed-off-by: default avatarSwathi Sridhar <swatsrid@codeaurora.org>
parent c6217dd5

Documentation/devicetree/bindings/arm/msm/memory-offline.txt

+24 −4
Original line number Diff line number Diff line
@@ -16,9 +16,28 @@ see the memory hotplug documentation (Documentation/memory-hotplug.txt). 
Required properties:

- compatible: "qcom,mem-offline"

- granule: The minimum granule size in mega-bytes for memory onlining/offlining.

- mem-percent: Percentage of the DDR which will support being onlined/offlined.

	The system will round down the value to align with the minimum offlinable

	granule size supported by DDR.

- offline-sizes: Array of offlinable memory region sizes to apply to targets

	based on their DDR size.



	Each entry in the array is a pair of sizes, where the first size in the

	pair is the minimum amount of DDR required in the system in bytes, and

	the second item in the pair is the size of the offlinable region in

	bytes which will be applied to the system.



	The offlinable memory region size from the entry where the minimum amount

	of DDR required in the system is closest, but not greater, than the

	amount of DDR in the system will be applied.

	If there are no entries with a minimum amount of DDR required that is less

	than the amount of DDR in the system then no offlinable region will be

	created.



	For example, in the following configuration:

              offline-sizes = <0x1 0x40000000 0x0 0x40000000>,

			      <0x1 0xc0000000 0x0 0x80000000>;

	On a 4GB target no offlinable region will be created.

	On a 6GB target a 1GB offlinable region will be created.

	On an 8GB target a 2GB offlinable region will be created.

	On a 12GB target a 2GB offlinable region will be created.

- mboxes: Reference to the mailbox used by the driver to make requests to

	online/offline memory.
@@ -26,6 +45,7 @@ Example: 
  mem-offline {

	compatible = "qcom,mem-offline";

	granule = <512>;

	mem-percent = "35";

	offline-sizes = <0x1 0x40000000 0x0 0x40000000>,

                        <0x1 0xc0000000 0x0 0x80000000>;

	mboxes = <&qmp_aop 0>;

  };