OSDN Git Service

soc: qcom: hab: add dts parsing into hab driver
[sagit-ice-cold/kernel_xiaomi_msm8998.git] / Documentation / devicetree / bindings / soc / qcom / hab.txt
1 * HAB
2
3 HAB(Hypervisor ABstraction) is meant to be a cross-platform abstraction layer
4 for utilizing the underlying hypervisor system. This API can be accessed from
5 both user and kernel sides.
6 The intended users of this are primarily the multimedia drivers who want to
7 communicate with the host OS to use the multimedia hardware.
8
9 Required properties:
10 - compatible: Must be "qcom,hab"
11 - vmid: the local VM's ID
12   It should be unique in a system, and host's ID should be 0. Here is an
13   example for a system as qvm host + agl gvm + android gvm, and such below
14   setting is proper,
15     qvm host's vmid: 0
16     agl gvm's vmid: 1
17     android gvm's vmid: 2
18 - mmid group properties:
19   - grp-start-id: mmid group starting ID, eg, 100 is for MM_AUD_1~4
20   - role: the local role of this group, and must be "fe" or "be"
21   - remote-vmids: When the local role is "fe", this is to tell which VM is the
22     relevant BE. When it is "be", this is to tell which VMs it will support as
23     BE.
24
25 Example:
26         qcom,hab {
27                 compatible = "qcom,hab";
28                 vmid = <2>;
29
30                 mmid100: mmid-grp@100 {
31                         grp-start-id = <100>;
32                         role = "fe";
33                         remote-vmids = <0>;
34                 };
35
36                 mmid200: mmid-grp@200 {
37                         grp-start-id = <200>;
38                         role = "fe";
39                         remote-vmids = <0>;
40                 };
41         }