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

Commit 6dfa303f authored by Satyajit Desai's avatar Satyajit Desai Committed by Kyle Yan
Browse files

Documentation: msm: imem: snapshot of imem documentation file



This is snapshot of the imem documentation file as of msm-4.4
commit 'fb5706b7462b0b855d10da12ed88ebf10a2e8643'.

Change-Id: I6f3e837e414598e2e8d7119e67b666e33d8af686
Signed-off-by: default avatarSatyajit Desai <sadesai@codeaurora.org>
parent d1f2c07b
Loading
Loading
Loading
Loading
+107 −0
Original line number Original line Diff line number Diff line
Qualcomm IMEM

IMEM is fast on-chip memory used for various debug features and dma transactions.

Required properties

-compatible: "qcom,msm-imem"
-reg: start address and size of imem memory

If any children nodes exist the following properties are required:
-#address-cells: should be 1
-#size-cells: should be 1
-ranges: A triplet that includes the child address, parent address, &
	 length.  The child address is assumed to be 0.

Child nodes:
------------

Peripheral Image Loader (pil):
------------------------------
Required properties:
-compatible: "qcom,msm-imem-pil"
-reg: start address and size of PIL region in imem

Bootloader Stats:
-----------------
Required properties:
-compatible: "qcom,msm-imem-boot_stats"
-reg: start address and size of boot_stats region in imem

Cache error reporting:
-----------------
Required properties:
-compatible: "qcom,msm-imem-cache_erp"
-reg: start address and size of cache_erp region in imem

Memory Dump:
------------
Required properties:
-compatible: "qcom,msm-imem-mem_dump_table"
-reg: start address and size of mem_dump_table region in imem

Restart Reason:
---------------
Required properties:
-compatible: "qcom,msm-imem-restart_reason
-reg: start address and size of restart_reason region in imem

Download Mode:
--------------
Required properties:
-compatible: "qcom,msm-imem-download_mode"
-reg: start address and size of download_mode region in imem

Emergency Download Mode:
------------------------
-compatible: "qcom,msm-imem-emergency_download_mode"
-reg: start address and size of emergency_download_mode region in imem

USB Diag Cookies:
-----------------
Memory region used to store USB PID and serial numbers to be used by
bootloader in download mode.

Required properties:
-compatible: "qcom,msm-imem-diag-dload"
-reg: start address and size of USB Diag download mode region in imem

Example:

	qcom,msm-imem {
		compatible = "qcom,msm-imem";
		reg = <0xdeadbeef 0x1000>; /* < start_address size > */
		ranges = <0x0 0xdeadbeef 0x1000>;
		#address-cells = <1>;
		#size-cells = <1>;

		download_mode@0 {
			compatible = "qcom,msm-imem-download_mode";
			reg = <0x0 8>;
		};

		restart_reason@65c {
			compatible = "qcom,msm-imem-restart_reason";
			reg = <0x65c 4>;
		};

		imem_cache_erp: cache_erp@6a4 {
			compatible = "qcom,msm-imem-cache_erp";
			reg = <0x6a4 4>;
		};

		boot_stats@6b0 {
			compatible = "qcom,msm-imem-boot_stats";
			reg = <0x6b0 32>;
		};

		pil@94c {
			compatible = "qcom,msm-imem-pil";
			reg = <0x94c 200>;
		};

		emergency_download_mode@fe0 {
			compatible = "qcom,msm-imem-emergency_download_mode";
			reg = <0xfe0 12>;
		};
	};