summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorSiddartha Mohanadoss <smohanad@codeaurora.org>2016-04-07 14:59:33 -0700
committerJeevan Shriram <jshriram@codeaurora.org>2016-04-13 11:12:11 -0700
commit4cb670d8db1073c3076d93e88ea299d94c81189e (patch)
tree81cface98f8947d077bec684898fd5a29a6ee936 /Documentation
parent00eb45fc95b968b9fa0f4228106c18a9efd6464b (diff)
msm: mhi_dev: Add MHI device driver
The Modem Host Interface (MHI) device driver supports clients to send control and data packets such as IP data packets, control messages and Diagnostic data between the Host and the device. It follows the MHI specification to transfer data. The driver interfaces with the IPA driver for Hardware accelerated channels and PCIe End point driver to communicate between the Host and the device. The driver exposes to both userspace and kernel space generic IO read/write/open/close system calls and kernel APIs to communicate and transfer data between Host and the device. Change-Id: I64990a972cbf7c2022d638c35f7517071de67f19 Signed-off-by: Siddartha Mohanadoss <smohanad@codeaurora.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/devicetree/bindings/mhi/msm_mhi_dev.txt34
1 files changed, 34 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/mhi/msm_mhi_dev.txt b/Documentation/devicetree/bindings/mhi/msm_mhi_dev.txt
new file mode 100644
index 000000000000..49d33a3c4440
--- /dev/null
+++ b/Documentation/devicetree/bindings/mhi/msm_mhi_dev.txt
@@ -0,0 +1,34 @@
+MSM MHI DEV
+
+MSM MHI DEV enables communication with the host over a PCIe link using the
+Modem Host Interface protocol. The driver interfaces with the IPA for
+enabling the HW acceleration channel path and provides interface for
+software channels to communicate between Host and device.
+
+Required properties:
+ - compatible: should be "qcom,msm-mhi-dev" for MHI device driver.
+ - reg: MHI MMIO physical register space.
+ - reg-names: resource names used for the MHI MMIO physical address region,
+ IPA uC command and event ring doorbell mail box address.
+ Should be "mhi_mmio_base" for MHI MMIO physical address,
+ "ipa_uc_mbox_crdb" for IPA uC Command Ring doorbell,
+ "ipa_uc_mbox_erdb" for IPA uC Event Ring doorbell passed to
+ the IPA driver.
+ - qcom,mhi-ifc-id: ID of HW interface via which MHI on device side
+ communicates with host side.
+ - qcom,mhi-ep-msi: End point MSI number.
+ - qcom,mhi-version: MHI specification version supported by the device.
+
+Example:
+
+ mhi: qcom,msm-mhi-dev {
+ compatible = "qcom,msm-mhi-dev";
+ reg = <0xfc527000 0x1000>,
+ <0xfd4fa000 0x1>,
+ <0xfd4fa080 0x1>;
+ reg-names = "mhi_mmio_base", "ipa_uc_mbox_crdb",
+ "ipa_uc_mbox_erdb";
+ qcom,mhi-ifc-id = <0x030017cb>;
+ qcom,mhi-ep-msi = <1>;
+ qcom,mhi-version = <0x1000000>;
+ };