Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/sage/ceph...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / regmap / regmap.txt
1 Device-Tree binding for regmap
2
3 The endianness mode of CPU & Device scenarios:
4 Index     Device     Endianness properties
5 ---------------------------------------------------
6 1         BE         'big-endian'
7 2         LE         'little-endian'
8
9 For one device driver, which will run in different scenarios above
10 on different SoCs using the devicetree, we need one way to simplify
11 this.
12
13 Required properties:
14 - {big,little}-endian: these are boolean properties, if absent
15   meaning that the CPU and the Device are in the same endianness mode,
16   these properties are for register values and all the buffers only.
17
18 Examples:
19 Scenario 1 : CPU in LE mode & device in LE mode.
20 dev: dev@40031000 {
21               compatible = "name";
22               reg = <0x40031000 0x1000>;
23               ...
24 };
25
26 Scenario 2 : CPU in LE mode & device in BE mode.
27 dev: dev@40031000 {
28               compatible = "name";
29               reg = <0x40031000 0x1000>;
30               ...
31               big-endian;
32 };
33
34 Scenario 3 : CPU in BE mode & device in BE mode.
35 dev: dev@40031000 {
36               compatible = "name";
37               reg = <0x40031000 0x1000>;
38               ...
39 };
40
41 Scenario 4 : CPU in BE mode & device in LE mode.
42 dev: dev@40031000 {
43               compatible = "name";
44               reg = <0x40031000 0x1000>;
45               ...
46               little-endian;
47 };