Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[pandora-kernel.git] / Documentation / powerpc / dts-bindings / fsl / cpm_qe / qe.txt
1 * Freescale QUICC Engine module (QE)
2 This represents qe module that is installed on PowerQUICC II Pro.
3
4 NOTE:  This is an interim binding; it should be updated to fit
5 in with the CPM binding later in this document.
6
7 Basically, it is a bus of devices, that could act more or less
8 as a complete entity (UCC, USB etc ). All of them should be siblings on
9 the "root" qe node, using the common properties from there.
10 The description below applies to the qe of MPC8360 and
11 more nodes and properties would be extended in the future.
12
13 i) Root QE device
14
15 Required properties:
16 - compatible : should be "fsl,qe";
17 - model : precise model of the QE, Can be "QE", "CPM", or "CPM2"
18 - reg : offset and length of the device registers.
19 - bus-frequency : the clock frequency for QUICC Engine.
20 - fsl,qe-num-riscs: define how many RISC engines the QE has.
21 - fsl,qe-num-snums: define how many serial number(SNUM) the QE can use for the
22   threads.
23
24 Recommended properties
25 - brg-frequency : the internal clock source frequency for baud-rate
26   generators in Hz.
27
28 Example:
29      qe@e0100000 {
30         #address-cells = <1>;
31         #size-cells = <1>;
32         #interrupt-cells = <2>;
33         compatible = "fsl,qe";
34         ranges = <0 e0100000 00100000>;
35         reg = <e0100000 480>;
36         brg-frequency = <0>;
37         bus-frequency = <179A7B00>;
38      }
39
40 * Multi-User RAM (MURAM)
41
42 Required properties:
43 - compatible : should be "fsl,qe-muram", "fsl,cpm-muram".
44 - mode : the could be "host" or "slave".
45 - ranges : Should be defined as specified in 1) to describe the
46    translation of MURAM addresses.
47 - data-only : sub-node which defines the address area under MURAM
48    bus that can be allocated as data/parameter
49
50 Example:
51
52      muram@10000 {
53         compatible = "fsl,qe-muram", "fsl,cpm-muram";
54         ranges = <0 00010000 0000c000>;
55
56         data-only@0{
57                 compatible = "fsl,qe-muram-data",
58                              "fsl,cpm-muram-data";
59                 reg = <0 c000>;
60         };
61      };