doc: spelling error changes
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / arm / omap / omap.txt
1 * Texas Instruments OMAP
2
3 OMAP is currently using a static file per SoC family to describe the
4 IPs present in the SoC.
5 On top of that an omap_device is created to extend the platform_device
6 capabilities and to allow binding with one or several hwmods.
7 The hwmods will contain all the information to build the device:
8 address range, irq lines, dma lines, interconnect, PRCM register,
9 clock domain, input clocks.
10 For the moment just point to the existing hwmod, the next step will be
11 to move data from hwmod to device-tree representation.
12
13
14 Required properties:
15 - compatible: Every devices present in OMAP SoC should be in the
16   form: "ti,XXX"
17 - ti,hwmods: list of hwmod names (ascii strings), that comes from the OMAP
18   HW documentation, attached to a device. Must contain at least
19   one hwmod.
20
21 Optional properties:
22 - ti,no_idle_on_suspend: When present, it prevents the PM to idle the module
23   during suspend.
24 - ti,no-reset-on-init: When present, the module should not be reset at init
25 - ti,no-idle-on-init: When present, the module should not be idled at init
26
27 Example:
28
29 spinlock@1 {
30     compatible = "ti,omap4-spinlock";
31     ti,hwmods = "spinlock";
32 };
33
34 SoC Type (optional):
35
36 - General Purpose devices
37   compatible = "ti,gp"
38 - High Security devices
39   compatible = "ti,hs"
40
41 SoC Families:
42
43 - OMAP2 generic - defaults to OMAP2420
44   compatible = "ti,omap2"
45 - OMAP3 generic - defaults to OMAP3430
46   compatible = "ti,omap3"
47 - OMAP4 generic - defaults to OMAP4430
48   compatible = "ti,omap4"
49 - OMAP5 generic - defaults to OMAP5430
50   compatible = "ti,omap5"
51 - DRA7 generic - defaults to DRA742
52   compatible = "ti,dra7"
53 - AM43x generic - defaults to AM4372
54   compatible = "ti,am43"
55
56 SoCs:
57
58 - OMAP2420
59   compatible = "ti,omap2420", "ti,omap2"
60 - OMAP2430
61   compatible = "ti,omap2430", "ti,omap2"
62
63 - OMAP3430
64   compatible = "ti,omap3430", "ti,omap3"
65 - AM3517
66   compatible = "ti,am3517", "ti,omap3"
67 - OMAP3630
68   compatible = "ti,omap36xx", "ti,omap3"
69 - AM33xx
70   compatible = "ti,am33xx", "ti,omap3"
71
72 - OMAP4430
73   compatible = "ti,omap4430", "ti,omap4"
74 - OMAP4460
75   compatible = "ti,omap4460", "ti,omap4"
76
77 - OMAP5430
78   compatible = "ti,omap5430", "ti,omap5"
79 - OMAP5432
80   compatible = "ti,omap5432", "ti,omap5"
81
82 - DRA742
83   compatible = "ti,dra7xx", "ti,dra7"
84
85 - AM4372
86   compatible = "ti,am4372", "ti,am43"
87
88 Boards:
89
90 - OMAP3 BeagleBoard : Low cost community board
91   compatible = "ti,omap3-beagle", "ti,omap3"
92
93 - OMAP3 Tobi with Overo : Commercial expansion board with daughter board
94   compatible = "gumstix,omap3-overo-tobi", "gumstix,omap3-overo", "ti,omap3"
95
96 - OMAP4 SDP : Software Development Board
97   compatible = "ti,omap4-sdp", "ti,omap4430"
98
99 - OMAP4 PandaBoard : Low cost community board
100   compatible = "ti,omap4-panda", "ti,omap4430"
101
102 - OMAP3 EVM : Software Development Board for OMAP35x, AM/DM37x
103   compatible = "ti,omap3-evm", "ti,omap3"
104
105 - AM335X EVM : Software Development Board for AM335x
106   compatible = "ti,am335x-evm", "ti,am33xx", "ti,omap3"
107
108 - AM335X Bone : Low cost community board
109   compatible = "ti,am335x-bone", "ti,am33xx", "ti,omap3"
110
111 - OMAP5 EVM : Evaluation Module
112   compatible = "ti,omap5-evm", "ti,omap5"
113
114 - AM43x EPOS EVM
115   compatible = "ti,am43x-epos-evm", "ti,am4372", "ti,am43"
116
117 - DRA7 EVM:  Software Development Board for DRA7XX
118   compatible = "ti,dra7-evm", "ti,dra7"