Documentation: update broken web addresses.
[linux-2.6.git] / Documentation / powerpc / booting-without-of.txt
1            Booting the Linux/ppc kernel without Open Firmware
2            --------------------------------------------------
3
4 (c) 2005 Benjamin Herrenschmidt <benh at kernel.crashing.org>,
5     IBM Corp.
6 (c) 2005 Becky Bruce <becky.bruce at freescale.com>,
7     Freescale Semiconductor, FSL SOC and 32-bit additions
8 (c) 2006 MontaVista Software, Inc.
9     Flash chip node definition
10
11 Table of Contents
12 =================
13
14   I - Introduction
15     1) Entry point for arch/powerpc
16     2) Board support
17
18   II - The DT block format
19     1) Header
20     2) Device tree generalities
21     3) Device tree "structure" block
22     4) Device tree "strings" block
23
24   III - Required content of the device tree
25     1) Note about cells and address representation
26     2) Note about "compatible" properties
27     3) Note about "name" properties
28     4) Note about node and property names and character set
29     5) Required nodes and properties
30       a) The root node
31       b) The /cpus node
32       c) The /cpus/* nodes
33       d) the /memory node(s)
34       e) The /chosen node
35       f) the /soc<SOCname> node
36
37   IV - "dtc", the device tree compiler
38
39   V - Recommendations for a bootloader
40
41   VI - System-on-a-chip devices and nodes
42     1) Defining child nodes of an SOC
43     2) Representing devices without a current OF specification
44       a) PHY nodes
45       b) Interrupt controllers
46       c) 4xx/Axon EMAC ethernet nodes
47       d) Xilinx IP cores
48       e) USB EHCI controllers
49       f) MDIO on GPIOs
50       g) SPI busses
51
52   VII - Marvell Discovery mv64[345]6x System Controller chips
53     1) The /system-controller node
54     2) Child nodes of /system-controller
55       a) Marvell Discovery MDIO bus
56       b) Marvell Discovery ethernet controller
57       c) Marvell Discovery PHY nodes
58       d) Marvell Discovery SDMA nodes
59       e) Marvell Discovery BRG nodes
60       f) Marvell Discovery CUNIT nodes
61       g) Marvell Discovery MPSCROUTING nodes
62       h) Marvell Discovery MPSCINTR nodes
63       i) Marvell Discovery MPSC nodes
64       j) Marvell Discovery Watch Dog Timer nodes
65       k) Marvell Discovery I2C nodes
66       l) Marvell Discovery PIC (Programmable Interrupt Controller) nodes
67       m) Marvell Discovery MPP (Multipurpose Pins) multiplexing nodes
68       n) Marvell Discovery GPP (General Purpose Pins) nodes
69       o) Marvell Discovery PCI host bridge node
70       p) Marvell Discovery CPU Error nodes
71       q) Marvell Discovery SRAM Controller nodes
72       r) Marvell Discovery PCI Error Handler nodes
73       s) Marvell Discovery Memory Controller nodes
74
75   VIII - Specifying interrupt information for devices
76     1) interrupts property
77     2) interrupt-parent property
78     3) OpenPIC Interrupt Controllers
79     4) ISA Interrupt Controllers
80
81   IX - Specifying GPIO information for devices
82     1) gpios property
83     2) gpio-controller nodes
84
85   X - Specifying device power management information (sleep property)
86
87   Appendix A - Sample SOC node for MPC8540
88
89
90 Revision Information
91 ====================
92
93    May 18, 2005: Rev 0.1 - Initial draft, no chapter III yet.
94
95    May 19, 2005: Rev 0.2 - Add chapter III and bits & pieces here or
96                            clarifies the fact that a lot of things are
97                            optional, the kernel only requires a very
98                            small device tree, though it is encouraged
99                            to provide an as complete one as possible.
100
101    May 24, 2005: Rev 0.3 - Precise that DT block has to be in RAM
102                          - Misc fixes
103                          - Define version 3 and new format version 16
104                            for the DT block (version 16 needs kernel
105                            patches, will be fwd separately).
106                            String block now has a size, and full path
107                            is replaced by unit name for more
108                            compactness.
109                            linux,phandle is made optional, only nodes
110                            that are referenced by other nodes need it.
111                            "name" property is now automatically
112                            deduced from the unit name
113
114    June 1, 2005: Rev 0.4 - Correct confusion between OF_DT_END and
115                            OF_DT_END_NODE in structure definition.
116                          - Change version 16 format to always align
117                            property data to 4 bytes. Since tokens are
118                            already aligned, that means no specific
119                            required alignment between property size
120                            and property data. The old style variable
121                            alignment would make it impossible to do
122                            "simple" insertion of properties using
123                            memmove (thanks Milton for
124                            noticing). Updated kernel patch as well
125                          - Correct a few more alignment constraints
126                          - Add a chapter about the device-tree
127                            compiler and the textural representation of
128                            the tree that can be "compiled" by dtc.
129
130    November 21, 2005: Rev 0.5
131                          - Additions/generalizations for 32-bit
132                          - Changed to reflect the new arch/powerpc
133                            structure
134                          - Added chapter VI
135
136
137  ToDo:
138         - Add some definitions of interrupt tree (simple/complex)
139         - Add some definitions for PCI host bridges
140         - Add some common address format examples
141         - Add definitions for standard properties and "compatible"
142           names for cells that are not already defined by the existing
143           OF spec.
144         - Compare FSL SOC use of PCI to standard and make sure no new
145           node definition required.
146         - Add more information about node definitions for SOC devices
147           that currently have no standard, like the FSL CPM.
148
149
150 I - Introduction
151 ================
152
153 During the recent development of the Linux/ppc64 kernel, and more
154 specifically, the addition of new platform types outside of the old
155 IBM pSeries/iSeries pair, it was decided to enforce some strict rules
156 regarding the kernel entry and bootloader <-> kernel interfaces, in
157 order to avoid the degeneration that had become the ppc32 kernel entry
158 point and the way a new platform should be added to the kernel. The
159 legacy iSeries platform breaks those rules as it predates this scheme,
160 but no new board support will be accepted in the main tree that
161 doesn't follows them properly.  In addition, since the advent of the
162 arch/powerpc merged architecture for ppc32 and ppc64, new 32-bit
163 platforms and 32-bit platforms which move into arch/powerpc will be
164 required to use these rules as well.
165
166 The main requirement that will be defined in more detail below is
167 the presence of a device-tree whose format is defined after Open
168 Firmware specification. However, in order to make life easier
169 to embedded board vendors, the kernel doesn't require the device-tree
170 to represent every device in the system and only requires some nodes
171 and properties to be present. This will be described in detail in
172 section III, but, for example, the kernel does not require you to
173 create a node for every PCI device in the system. It is a requirement
174 to have a node for PCI host bridges in order to provide interrupt
175 routing informations and memory/IO ranges, among others. It is also
176 recommended to define nodes for on chip devices and other busses that
177 don't specifically fit in an existing OF specification. This creates a
178 great flexibility in the way the kernel can then probe those and match
179 drivers to device, without having to hard code all sorts of tables. It
180 also makes it more flexible for board vendors to do minor hardware
181 upgrades without significantly impacting the kernel code or cluttering
182 it with special cases.
183
184
185 1) Entry point for arch/powerpc
186 -------------------------------
187
188    There is one and one single entry point to the kernel, at the start
189    of the kernel image. That entry point supports two calling
190    conventions:
191
192         a) Boot from Open Firmware. If your firmware is compatible
193         with Open Firmware (IEEE 1275) or provides an OF compatible
194         client interface API (support for "interpret" callback of
195         forth words isn't required), you can enter the kernel with:
196
197               r5 : OF callback pointer as defined by IEEE 1275
198               bindings to powerpc. Only the 32-bit client interface
199               is currently supported
200
201               r3, r4 : address & length of an initrd if any or 0
202
203               The MMU is either on or off; the kernel will run the
204               trampoline located in arch/powerpc/kernel/prom_init.c to
205               extract the device-tree and other information from open
206               firmware and build a flattened device-tree as described
207               in b). prom_init() will then re-enter the kernel using
208               the second method. This trampoline code runs in the
209               context of the firmware, which is supposed to handle all
210               exceptions during that time.
211
212         b) Direct entry with a flattened device-tree block. This entry
213         point is called by a) after the OF trampoline and can also be
214         called directly by a bootloader that does not support the Open
215         Firmware client interface. It is also used by "kexec" to
216         implement "hot" booting of a new kernel from a previous
217         running one. This method is what I will describe in more
218         details in this document, as method a) is simply standard Open
219         Firmware, and thus should be implemented according to the
220         various standard documents defining it and its binding to the
221         PowerPC platform. The entry point definition then becomes:
222
223                 r3 : physical pointer to the device-tree block
224                 (defined in chapter II) in RAM
225
226                 r4 : physical pointer to the kernel itself. This is
227                 used by the assembly code to properly disable the MMU
228                 in case you are entering the kernel with MMU enabled
229                 and a non-1:1 mapping.
230
231                 r5 : NULL (as to differentiate with method a)
232
233         Note about SMP entry: Either your firmware puts your other
234         CPUs in some sleep loop or spin loop in ROM where you can get
235         them out via a soft reset or some other means, in which case
236         you don't need to care, or you'll have to enter the kernel
237         with all CPUs. The way to do that with method b) will be
238         described in a later revision of this document.
239
240
241 2) Board support
242 ----------------
243
244 64-bit kernels:
245
246    Board supports (platforms) are not exclusive config options. An
247    arbitrary set of board supports can be built in a single kernel
248    image. The kernel will "know" what set of functions to use for a
249    given platform based on the content of the device-tree. Thus, you
250    should:
251
252         a) add your platform support as a _boolean_ option in
253         arch/powerpc/Kconfig, following the example of PPC_PSERIES,
254         PPC_PMAC and PPC_MAPLE. The later is probably a good
255         example of a board support to start from.
256
257         b) create your main platform file as
258         "arch/powerpc/platforms/myplatform/myboard_setup.c" and add it
259         to the Makefile under the condition of your CONFIG_
260         option. This file will define a structure of type "ppc_md"
261         containing the various callbacks that the generic code will
262         use to get to your platform specific code
263
264         c) Add a reference to your "ppc_md" structure in the
265         "machines" table in arch/powerpc/kernel/setup_64.c if you are
266         a 64-bit platform.
267
268         d) request and get assigned a platform number (see PLATFORM_*
269         constants in arch/powerpc/include/asm/processor.h
270
271 32-bit embedded kernels:
272
273   Currently, board support is essentially an exclusive config option.
274   The kernel is configured for a single platform.  Part of the reason
275   for this is to keep kernels on embedded systems small and efficient;
276   part of this is due to the fact the code is already that way. In the
277   future, a kernel may support multiple platforms, but only if the
278   platforms feature the same core architecture.  A single kernel build
279   cannot support both configurations with Book E and configurations
280   with classic Powerpc architectures.
281
282   32-bit embedded platforms that are moved into arch/powerpc using a
283   flattened device tree should adopt the merged tree practice of
284   setting ppc_md up dynamically, even though the kernel is currently
285   built with support for only a single platform at a time.  This allows
286   unification of the setup code, and will make it easier to go to a
287   multiple-platform-support model in the future.
288
289 NOTE: I believe the above will be true once Ben's done with the merge
290 of the boot sequences.... someone speak up if this is wrong!
291
292   To add a 32-bit embedded platform support, follow the instructions
293   for 64-bit platforms above, with the exception that the Kconfig
294   option should be set up such that the kernel builds exclusively for
295   the platform selected.  The processor type for the platform should
296   enable another config option to select the specific board
297   supported.
298
299 NOTE: If Ben doesn't merge the setup files, may need to change this to
300 point to setup_32.c
301
302
303    I will describe later the boot process and various callbacks that
304    your platform should implement.
305
306
307 II - The DT block format
308 ========================
309
310
311 This chapter defines the actual format of the flattened device-tree
312 passed to the kernel. The actual content of it and kernel requirements
313 are described later. You can find example of code manipulating that
314 format in various places, including arch/powerpc/kernel/prom_init.c
315 which will generate a flattened device-tree from the Open Firmware
316 representation, or the fs2dt utility which is part of the kexec tools
317 which will generate one from a filesystem representation. It is
318 expected that a bootloader like uboot provides a bit more support,
319 that will be discussed later as well.
320
321 Note: The block has to be in main memory. It has to be accessible in
322 both real mode and virtual mode with no mapping other than main
323 memory. If you are writing a simple flash bootloader, it should copy
324 the block to RAM before passing it to the kernel.
325
326
327 1) Header
328 ---------
329
330    The kernel is entered with r3 pointing to an area of memory that is
331    roughly described in arch/powerpc/include/asm/prom.h by the structure
332    boot_param_header:
333
334 struct boot_param_header {
335         u32     magic;                  /* magic word OF_DT_HEADER */
336         u32     totalsize;              /* total size of DT block */
337         u32     off_dt_struct;          /* offset to structure */
338         u32     off_dt_strings;         /* offset to strings */
339         u32     off_mem_rsvmap;         /* offset to memory reserve map
340                                            */
341         u32     version;                /* format version */
342         u32     last_comp_version;      /* last compatible version */
343
344         /* version 2 fields below */
345         u32     boot_cpuid_phys;        /* Which physical CPU id we're
346                                            booting on */
347         /* version 3 fields below */
348         u32     size_dt_strings;        /* size of the strings block */
349
350         /* version 17 fields below */
351         u32     size_dt_struct;         /* size of the DT structure block */
352 };
353
354    Along with the constants:
355
356 /* Definitions used by the flattened device tree */
357 #define OF_DT_HEADER            0xd00dfeed      /* 4: version,
358                                                    4: total size */
359 #define OF_DT_BEGIN_NODE        0x1             /* Start node: full name
360                                                    */
361 #define OF_DT_END_NODE          0x2             /* End node */
362 #define OF_DT_PROP              0x3             /* Property: name off,
363                                                    size, content */
364 #define OF_DT_END               0x9
365
366    All values in this header are in big endian format, the various
367    fields in this header are defined more precisely below. All
368    "offset" values are in bytes from the start of the header; that is
369    from the value of r3.
370
371    - magic
372
373      This is a magic value that "marks" the beginning of the
374      device-tree block header. It contains the value 0xd00dfeed and is
375      defined by the constant OF_DT_HEADER
376
377    - totalsize
378
379      This is the total size of the DT block including the header. The
380      "DT" block should enclose all data structures defined in this
381      chapter (who are pointed to by offsets in this header). That is,
382      the device-tree structure, strings, and the memory reserve map.
383
384    - off_dt_struct
385
386      This is an offset from the beginning of the header to the start
387      of the "structure" part the device tree. (see 2) device tree)
388
389    - off_dt_strings
390
391      This is an offset from the beginning of the header to the start
392      of the "strings" part of the device-tree
393
394    - off_mem_rsvmap
395
396      This is an offset from the beginning of the header to the start
397      of the reserved memory map. This map is a list of pairs of 64-
398      bit integers. Each pair is a physical address and a size. The
399      list is terminated by an entry of size 0. This map provides the
400      kernel with a list of physical memory areas that are "reserved"
401      and thus not to be used for memory allocations, especially during
402      early initialization. The kernel needs to allocate memory during
403      boot for things like un-flattening the device-tree, allocating an
404      MMU hash table, etc... Those allocations must be done in such a
405      way to avoid overriding critical things like, on Open Firmware
406      capable machines, the RTAS instance, or on some pSeries, the TCE
407      tables used for the iommu. Typically, the reserve map should
408      contain _at least_ this DT block itself (header,total_size). If
409      you are passing an initrd to the kernel, you should reserve it as
410      well. You do not need to reserve the kernel image itself. The map
411      should be 64-bit aligned.
412
413    - version
414
415      This is the version of this structure. Version 1 stops
416      here. Version 2 adds an additional field boot_cpuid_phys.
417      Version 3 adds the size of the strings block, allowing the kernel
418      to reallocate it easily at boot and free up the unused flattened
419      structure after expansion. Version 16 introduces a new more
420      "compact" format for the tree itself that is however not backward
421      compatible. Version 17 adds an additional field, size_dt_struct,
422      allowing it to be reallocated or moved more easily (this is
423      particularly useful for bootloaders which need to make
424      adjustments to a device tree based on probed information). You
425      should always generate a structure of the highest version defined
426      at the time of your implementation. Currently that is version 17,
427      unless you explicitly aim at being backward compatible.
428
429    - last_comp_version
430
431      Last compatible version. This indicates down to what version of
432      the DT block you are backward compatible. For example, version 2
433      is backward compatible with version 1 (that is, a kernel build
434      for version 1 will be able to boot with a version 2 format). You
435      should put a 1 in this field if you generate a device tree of
436      version 1 to 3, or 16 if you generate a tree of version 16 or 17
437      using the new unit name format.
438
439    - boot_cpuid_phys
440
441      This field only exist on version 2 headers. It indicate which
442      physical CPU ID is calling the kernel entry point. This is used,
443      among others, by kexec. If you are on an SMP system, this value
444      should match the content of the "reg" property of the CPU node in
445      the device-tree corresponding to the CPU calling the kernel entry
446      point (see further chapters for more informations on the required
447      device-tree contents)
448
449    - size_dt_strings
450
451      This field only exists on version 3 and later headers.  It
452      gives the size of the "strings" section of the device tree (which
453      starts at the offset given by off_dt_strings).
454
455    - size_dt_struct
456
457      This field only exists on version 17 and later headers.  It gives
458      the size of the "structure" section of the device tree (which
459      starts at the offset given by off_dt_struct).
460
461    So the typical layout of a DT block (though the various parts don't
462    need to be in that order) looks like this (addresses go from top to
463    bottom):
464
465
466              ------------------------------
467        r3 -> |  struct boot_param_header  |
468              ------------------------------
469              |      (alignment gap) (*)   |
470              ------------------------------
471              |      memory reserve map    |
472              ------------------------------
473              |      (alignment gap)       |
474              ------------------------------
475              |                            |
476              |    device-tree structure   |
477              |                            |
478              ------------------------------
479              |      (alignment gap)       |
480              ------------------------------
481              |                            |
482              |     device-tree strings    |
483              |                            |
484       -----> ------------------------------
485       |
486       |
487       --- (r3 + totalsize)
488
489   (*) The alignment gaps are not necessarily present; their presence
490       and size are dependent on the various alignment requirements of
491       the individual data blocks.
492
493
494 2) Device tree generalities
495 ---------------------------
496
497 This device-tree itself is separated in two different blocks, a
498 structure block and a strings block. Both need to be aligned to a 4
499 byte boundary.
500
501 First, let's quickly describe the device-tree concept before detailing
502 the storage format. This chapter does _not_ describe the detail of the
503 required types of nodes & properties for the kernel, this is done
504 later in chapter III.
505
506 The device-tree layout is strongly inherited from the definition of
507 the Open Firmware IEEE 1275 device-tree. It's basically a tree of
508 nodes, each node having two or more named properties. A property can
509 have a value or not.
510
511 It is a tree, so each node has one and only one parent except for the
512 root node who has no parent.
513
514 A node has 2 names. The actual node name is generally contained in a
515 property of type "name" in the node property list whose value is a
516 zero terminated string and is mandatory for version 1 to 3 of the
517 format definition (as it is in Open Firmware). Version 16 makes it
518 optional as it can generate it from the unit name defined below.
519
520 There is also a "unit name" that is used to differentiate nodes with
521 the same name at the same level, it is usually made of the node
522 names, the "@" sign, and a "unit address", which definition is
523 specific to the bus type the node sits on.
524
525 The unit name doesn't exist as a property per-se but is included in
526 the device-tree structure. It is typically used to represent "path" in
527 the device-tree. More details about the actual format of these will be
528 below.
529
530 The kernel powerpc generic code does not make any formal use of the
531 unit address (though some board support code may do) so the only real
532 requirement here for the unit address is to ensure uniqueness of
533 the node unit name at a given level of the tree. Nodes with no notion
534 of address and no possible sibling of the same name (like /memory or
535 /cpus) may omit the unit address in the context of this specification,
536 or use the "@0" default unit address. The unit name is used to define
537 a node "full path", which is the concatenation of all parent node
538 unit names separated with "/".
539
540 The root node doesn't have a defined name, and isn't required to have
541 a name property either if you are using version 3 or earlier of the
542 format. It also has no unit address (no @ symbol followed by a unit
543 address). The root node unit name is thus an empty string. The full
544 path to the root node is "/".
545
546 Every node which actually represents an actual device (that is, a node
547 which isn't only a virtual "container" for more nodes, like "/cpus"
548 is) is also required to have a "device_type" property indicating the
549 type of node .
550
551 Finally, every node that can be referenced from a property in another
552 node is required to have a "linux,phandle" property. Real open
553 firmware implementations provide a unique "phandle" value for every
554 node that the "prom_init()" trampoline code turns into
555 "linux,phandle" properties. However, this is made optional if the
556 flattened device tree is used directly. An example of a node
557 referencing another node via "phandle" is when laying out the
558 interrupt tree which will be described in a further version of this
559 document.
560
561 This "linux, phandle" property is a 32-bit value that uniquely
562 identifies a node. You are free to use whatever values or system of
563 values, internal pointers, or whatever to generate these, the only
564 requirement is that every node for which you provide that property has
565 a unique value for it.
566
567 Here is an example of a simple device-tree. In this example, an "o"
568 designates a node followed by the node unit name. Properties are
569 presented with their name followed by their content. "content"
570 represents an ASCII string (zero terminated) value, while <content>
571 represents a 32-bit hexadecimal value. The various nodes in this
572 example will be discussed in a later chapter. At this point, it is
573 only meant to give you a idea of what a device-tree looks like. I have
574 purposefully kept the "name" and "linux,phandle" properties which
575 aren't necessary in order to give you a better idea of what the tree
576 looks like in practice.
577
578   / o device-tree
579       |- name = "device-tree"
580       |- model = "MyBoardName"
581       |- compatible = "MyBoardFamilyName"
582       |- #address-cells = <2>
583       |- #size-cells = <2>
584       |- linux,phandle = <0>
585       |
586       o cpus
587       | | - name = "cpus"
588       | | - linux,phandle = <1>
589       | | - #address-cells = <1>
590       | | - #size-cells = <0>
591       | |
592       | o PowerPC,970@0
593       |   |- name = "PowerPC,970"
594       |   |- device_type = "cpu"
595       |   |- reg = <0>
596       |   |- clock-frequency = <5f5e1000>
597       |   |- 64-bit
598       |   |- linux,phandle = <2>
599       |
600       o memory@0
601       | |- name = "memory"
602       | |- device_type = "memory"
603       | |- reg = <00000000 00000000 00000000 20000000>
604       | |- linux,phandle = <3>
605       |
606       o chosen
607         |- name = "chosen"
608         |- bootargs = "root=/dev/sda2"
609         |- linux,phandle = <4>
610
611 This tree is almost a minimal tree. It pretty much contains the
612 minimal set of required nodes and properties to boot a linux kernel;
613 that is, some basic model informations at the root, the CPUs, and the
614 physical memory layout.  It also includes misc information passed
615 through /chosen, like in this example, the platform type (mandatory)
616 and the kernel command line arguments (optional).
617
618 The /cpus/PowerPC,970@0/64-bit property is an example of a
619 property without a value. All other properties have a value. The
620 significance of the #address-cells and #size-cells properties will be
621 explained in chapter IV which defines precisely the required nodes and
622 properties and their content.
623
624
625 3) Device tree "structure" block
626
627 The structure of the device tree is a linearized tree structure. The
628 "OF_DT_BEGIN_NODE" token starts a new node, and the "OF_DT_END_NODE"
629 ends that node definition. Child nodes are simply defined before
630 "OF_DT_END_NODE" (that is nodes within the node). A 'token' is a 32
631 bit value. The tree has to be "finished" with a OF_DT_END token
632
633 Here's the basic structure of a single node:
634
635      * token OF_DT_BEGIN_NODE (that is 0x00000001)
636      * for version 1 to 3, this is the node full path as a zero
637        terminated string, starting with "/". For version 16 and later,
638        this is the node unit name only (or an empty string for the
639        root node)
640      * [align gap to next 4 bytes boundary]
641      * for each property:
642         * token OF_DT_PROP (that is 0x00000003)
643         * 32-bit value of property value size in bytes (or 0 if no
644           value)
645         * 32-bit value of offset in string block of property name
646         * property value data if any
647         * [align gap to next 4 bytes boundary]
648      * [child nodes if any]
649      * token OF_DT_END_NODE (that is 0x00000002)
650
651 So the node content can be summarized as a start token, a full path,
652 a list of properties, a list of child nodes, and an end token. Every
653 child node is a full node structure itself as defined above.
654
655 NOTE: The above definition requires that all property definitions for
656 a particular node MUST precede any subnode definitions for that node.
657 Although the structure would not be ambiguous if properties and
658 subnodes were intermingled, the kernel parser requires that the
659 properties come first (up until at least 2.6.22).  Any tools
660 manipulating a flattened tree must take care to preserve this
661 constraint.
662
663 4) Device tree "strings" block
664
665 In order to save space, property names, which are generally redundant,
666 are stored separately in the "strings" block. This block is simply the
667 whole bunch of zero terminated strings for all property names
668 concatenated together. The device-tree property definitions in the
669 structure block will contain offset values from the beginning of the
670 strings block.
671
672
673 III - Required content of the device tree
674 =========================================
675
676 WARNING: All "linux,*" properties defined in this document apply only
677 to a flattened device-tree. If your platform uses a real
678 implementation of Open Firmware or an implementation compatible with
679 the Open Firmware client interface, those properties will be created
680 by the trampoline code in the kernel's prom_init() file. For example,
681 that's where you'll have to add code to detect your board model and
682 set the platform number. However, when using the flattened device-tree
683 entry point, there is no prom_init() pass, and thus you have to
684 provide those properties yourself.
685
686
687 1) Note about cells and address representation
688 ----------------------------------------------
689
690 The general rule is documented in the various Open Firmware
691 documentations. If you choose to describe a bus with the device-tree
692 and there exist an OF bus binding, then you should follow the
693 specification. However, the kernel does not require every single
694 device or bus to be described by the device tree.
695
696 In general, the format of an address for a device is defined by the
697 parent bus type, based on the #address-cells and #size-cells
698 properties.  Note that the parent's parent definitions of #address-cells
699 and #size-cells are not inherited so every node with children must specify
700 them.  The kernel requires the root node to have those properties defining
701 addresses format for devices directly mapped on the processor bus.
702
703 Those 2 properties define 'cells' for representing an address and a
704 size. A "cell" is a 32-bit number. For example, if both contain 2
705 like the example tree given above, then an address and a size are both
706 composed of 2 cells, and each is a 64-bit number (cells are
707 concatenated and expected to be in big endian format). Another example
708 is the way Apple firmware defines them, with 2 cells for an address
709 and one cell for a size.  Most 32-bit implementations should define
710 #address-cells and #size-cells to 1, which represents a 32-bit value.
711 Some 32-bit processors allow for physical addresses greater than 32
712 bits; these processors should define #address-cells as 2.
713
714 "reg" properties are always a tuple of the type "address size" where
715 the number of cells of address and size is specified by the bus
716 #address-cells and #size-cells. When a bus supports various address
717 spaces and other flags relative to a given address allocation (like
718 prefetchable, etc...) those flags are usually added to the top level
719 bits of the physical address. For example, a PCI physical address is
720 made of 3 cells, the bottom two containing the actual address itself
721 while the top cell contains address space indication, flags, and pci
722 bus & device numbers.
723
724 For busses that support dynamic allocation, it's the accepted practice
725 to then not provide the address in "reg" (keep it 0) though while
726 providing a flag indicating the address is dynamically allocated, and
727 then, to provide a separate "assigned-addresses" property that
728 contains the fully allocated addresses. See the PCI OF bindings for
729 details.
730
731 In general, a simple bus with no address space bits and no dynamic
732 allocation is preferred if it reflects your hardware, as the existing
733 kernel address parsing functions will work out of the box. If you
734 define a bus type with a more complex address format, including things
735 like address space bits, you'll have to add a bus translator to the
736 prom_parse.c file of the recent kernels for your bus type.
737
738 The "reg" property only defines addresses and sizes (if #size-cells is
739 non-0) within a given bus. In order to translate addresses upward
740 (that is into parent bus addresses, and possibly into CPU physical
741 addresses), all busses must contain a "ranges" property. If the
742 "ranges" property is missing at a given level, it's assumed that
743 translation isn't possible, i.e., the registers are not visible on the
744 parent bus.  The format of the "ranges" property for a bus is a list
745 of:
746
747         bus address, parent bus address, size
748
749 "bus address" is in the format of the bus this bus node is defining,
750 that is, for a PCI bridge, it would be a PCI address. Thus, (bus
751 address, size) defines a range of addresses for child devices. "parent
752 bus address" is in the format of the parent bus of this bus. For
753 example, for a PCI host controller, that would be a CPU address. For a
754 PCI<->ISA bridge, that would be a PCI address. It defines the base
755 address in the parent bus where the beginning of that range is mapped.
756
757 For a new 64-bit powerpc board, I recommend either the 2/2 format or
758 Apple's 2/1 format which is slightly more compact since sizes usually
759 fit in a single 32-bit word.   New 32-bit powerpc boards should use a
760 1/1 format, unless the processor supports physical addresses greater
761 than 32-bits, in which case a 2/1 format is recommended.
762
763 Alternatively, the "ranges" property may be empty, indicating that the
764 registers are visible on the parent bus using an identity mapping
765 translation.  In other words, the parent bus address space is the same
766 as the child bus address space.
767
768 2) Note about "compatible" properties
769 -------------------------------------
770
771 These properties are optional, but recommended in devices and the root
772 node. The format of a "compatible" property is a list of concatenated
773 zero terminated strings. They allow a device to express its
774 compatibility with a family of similar devices, in some cases,
775 allowing a single driver to match against several devices regardless
776 of their actual names.
777
778 3) Note about "name" properties
779 -------------------------------
780
781 While earlier users of Open Firmware like OldWorld macintoshes tended
782 to use the actual device name for the "name" property, it's nowadays
783 considered a good practice to use a name that is closer to the device
784 class (often equal to device_type). For example, nowadays, ethernet
785 controllers are named "ethernet", an additional "model" property
786 defining precisely the chip type/model, and "compatible" property
787 defining the family in case a single driver can driver more than one
788 of these chips. However, the kernel doesn't generally put any
789 restriction on the "name" property; it is simply considered good
790 practice to follow the standard and its evolutions as closely as
791 possible.
792
793 Note also that the new format version 16 makes the "name" property
794 optional. If it's absent for a node, then the node's unit name is then
795 used to reconstruct the name. That is, the part of the unit name
796 before the "@" sign is used (or the entire unit name if no "@" sign
797 is present).
798
799 4) Note about node and property names and character set
800 -------------------------------------------------------
801
802 While open firmware provides more flexible usage of 8859-1, this
803 specification enforces more strict rules. Nodes and properties should
804 be comprised only of ASCII characters 'a' to 'z', '0' to
805 '9', ',', '.', '_', '+', '#', '?', and '-'. Node names additionally
806 allow uppercase characters 'A' to 'Z' (property names should be
807 lowercase. The fact that vendors like Apple don't respect this rule is
808 irrelevant here). Additionally, node and property names should always
809 begin with a character in the range 'a' to 'z' (or 'A' to 'Z' for node
810 names).
811
812 The maximum number of characters for both nodes and property names
813 is 31. In the case of node names, this is only the leftmost part of
814 a unit name (the pure "name" property), it doesn't include the unit
815 address which can extend beyond that limit.
816
817
818 5) Required nodes and properties
819 --------------------------------
820   These are all that are currently required. However, it is strongly
821   recommended that you expose PCI host bridges as documented in the
822   PCI binding to open firmware, and your interrupt tree as documented
823   in OF interrupt tree specification.
824
825   a) The root node
826
827   The root node requires some properties to be present:
828
829     - model : this is your board name/model
830     - #address-cells : address representation for "root" devices
831     - #size-cells: the size representation for "root" devices
832     - device_type : This property shouldn't be necessary. However, if
833       you decide to create a device_type for your root node, make sure it
834       is _not_ "chrp" unless your platform is a pSeries or PAPR compliant
835       one for 64-bit, or a CHRP-type machine for 32-bit as this will
836       matched by the kernel this way.
837
838   Additionally, some recommended properties are:
839
840     - compatible : the board "family" generally finds its way here,
841       for example, if you have 2 board models with a similar layout,
842       that typically get driven by the same platform code in the
843       kernel, you would use a different "model" property but put a
844       value in "compatible". The kernel doesn't directly use that
845       value but it is generally useful.
846
847   The root node is also generally where you add additional properties
848   specific to your board like the serial number if any, that sort of
849   thing. It is recommended that if you add any "custom" property whose
850   name may clash with standard defined ones, you prefix them with your
851   vendor name and a comma.
852
853   b) The /cpus node
854
855   This node is the parent of all individual CPU nodes. It doesn't
856   have any specific requirements, though it's generally good practice
857   to have at least:
858
859                #address-cells = <00000001>
860                #size-cells    = <00000000>
861
862   This defines that the "address" for a CPU is a single cell, and has
863   no meaningful size. This is not necessary but the kernel will assume
864   that format when reading the "reg" properties of a CPU node, see
865   below
866
867   c) The /cpus/* nodes
868
869   So under /cpus, you are supposed to create a node for every CPU on
870   the machine. There is no specific restriction on the name of the
871   CPU, though It's common practice to call it PowerPC,<name>. For
872   example, Apple uses PowerPC,G5 while IBM uses PowerPC,970FX.
873
874   Required properties:
875
876     - device_type : has to be "cpu"
877     - reg : This is the physical CPU number, it's a single 32-bit cell
878       and is also used as-is as the unit number for constructing the
879       unit name in the full path. For example, with 2 CPUs, you would
880       have the full path:
881         /cpus/PowerPC,970FX@0
882         /cpus/PowerPC,970FX@1
883       (unit addresses do not require leading zeroes)
884     - d-cache-block-size : one cell, L1 data cache block size in bytes (*)
885     - i-cache-block-size : one cell, L1 instruction cache block size in
886       bytes
887     - d-cache-size : one cell, size of L1 data cache in bytes
888     - i-cache-size : one cell, size of L1 instruction cache in bytes
889
890 (*) The cache "block" size is the size on which the cache management
891 instructions operate. Historically, this document used the cache
892 "line" size here which is incorrect. The kernel will prefer the cache
893 block size and will fallback to cache line size for backward
894 compatibility.
895
896   Recommended properties:
897
898     - timebase-frequency : a cell indicating the frequency of the
899       timebase in Hz. This is not directly used by the generic code,
900       but you are welcome to copy/paste the pSeries code for setting
901       the kernel timebase/decrementer calibration based on this
902       value.
903     - clock-frequency : a cell indicating the CPU core clock frequency
904       in Hz. A new property will be defined for 64-bit values, but if
905       your frequency is < 4Ghz, one cell is enough. Here as well as
906       for the above, the common code doesn't use that property, but
907       you are welcome to re-use the pSeries or Maple one. A future
908       kernel version might provide a common function for this.
909     - d-cache-line-size : one cell, L1 data cache line size in bytes
910       if different from the block size
911     - i-cache-line-size : one cell, L1 instruction cache line size in
912       bytes if different from the block size
913
914   You are welcome to add any property you find relevant to your board,
915   like some information about the mechanism used to soft-reset the
916   CPUs. For example, Apple puts the GPIO number for CPU soft reset
917   lines in there as a "soft-reset" property since they start secondary
918   CPUs by soft-resetting them.
919
920
921   d) the /memory node(s)
922
923   To define the physical memory layout of your board, you should
924   create one or more memory node(s). You can either create a single
925   node with all memory ranges in its reg property, or you can create
926   several nodes, as you wish. The unit address (@ part) used for the
927   full path is the address of the first range of memory defined by a
928   given node. If you use a single memory node, this will typically be
929   @0.
930
931   Required properties:
932
933     - device_type : has to be "memory"
934     - reg : This property contains all the physical memory ranges of
935       your board. It's a list of addresses/sizes concatenated
936       together, with the number of cells of each defined by the
937       #address-cells and #size-cells of the root node. For example,
938       with both of these properties being 2 like in the example given
939       earlier, a 970 based machine with 6Gb of RAM could typically
940       have a "reg" property here that looks like:
941
942       00000000 00000000 00000000 80000000
943       00000001 00000000 00000001 00000000
944
945       That is a range starting at 0 of 0x80000000 bytes and a range
946       starting at 0x100000000 and of 0x100000000 bytes. You can see
947       that there is no memory covering the IO hole between 2Gb and
948       4Gb. Some vendors prefer splitting those ranges into smaller
949       segments, but the kernel doesn't care.
950
951   e) The /chosen node
952
953   This node is a bit "special". Normally, that's where open firmware
954   puts some variable environment information, like the arguments, or
955   the default input/output devices.
956
957   This specification makes a few of these mandatory, but also defines
958   some linux-specific properties that would be normally constructed by
959   the prom_init() trampoline when booting with an OF client interface,
960   but that you have to provide yourself when using the flattened format.
961
962   Recommended properties:
963
964     - bootargs : This zero-terminated string is passed as the kernel
965       command line
966     - linux,stdout-path : This is the full path to your standard
967       console device if any. Typically, if you have serial devices on
968       your board, you may want to put the full path to the one set as
969       the default console in the firmware here, for the kernel to pick
970       it up as its own default console. If you look at the function
971       set_preferred_console() in arch/ppc64/kernel/setup.c, you'll see
972       that the kernel tries to find out the default console and has
973       knowledge of various types like 8250 serial ports. You may want
974       to extend this function to add your own.
975
976   Note that u-boot creates and fills in the chosen node for platforms
977   that use it.
978
979   (Note: a practice that is now obsolete was to include a property
980   under /chosen called interrupt-controller which had a phandle value
981   that pointed to the main interrupt controller)
982
983   f) the /soc<SOCname> node
984
985   This node is used to represent a system-on-a-chip (SOC) and must be
986   present if the processor is a SOC. The top-level soc node contains
987   information that is global to all devices on the SOC. The node name
988   should contain a unit address for the SOC, which is the base address
989   of the memory-mapped register set for the SOC. The name of an soc
990   node should start with "soc", and the remainder of the name should
991   represent the part number for the soc.  For example, the MPC8540's
992   soc node would be called "soc8540".
993
994   Required properties:
995
996     - device_type : Should be "soc"
997     - ranges : Should be defined as specified in 1) to describe the
998       translation of SOC addresses for memory mapped SOC registers.
999     - bus-frequency: Contains the bus frequency for the SOC node.
1000       Typically, the value of this field is filled in by the boot
1001       loader.
1002
1003
1004   Recommended properties:
1005
1006     - reg : This property defines the address and size of the
1007       memory-mapped registers that are used for the SOC node itself.
1008       It does not include the child device registers - these will be
1009       defined inside each child node.  The address specified in the
1010       "reg" property should match the unit address of the SOC node.
1011     - #address-cells : Address representation for "soc" devices.  The
1012       format of this field may vary depending on whether or not the
1013       device registers are memory mapped.  For memory mapped
1014       registers, this field represents the number of cells needed to
1015       represent the address of the registers.  For SOCs that do not
1016       use MMIO, a special address format should be defined that
1017       contains enough cells to represent the required information.
1018       See 1) above for more details on defining #address-cells.
1019     - #size-cells : Size representation for "soc" devices
1020     - #interrupt-cells : Defines the width of cells used to represent
1021        interrupts.  Typically this value is <2>, which includes a
1022        32-bit number that represents the interrupt number, and a
1023        32-bit number that represents the interrupt sense and level.
1024        This field is only needed if the SOC contains an interrupt
1025        controller.
1026
1027   The SOC node may contain child nodes for each SOC device that the
1028   platform uses.  Nodes should not be created for devices which exist
1029   on the SOC but are not used by a particular platform. See chapter VI
1030   for more information on how to specify devices that are part of a SOC.
1031
1032   Example SOC node for the MPC8540:
1033
1034         soc8540@e0000000 {
1035                 #address-cells = <1>;
1036                 #size-cells = <1>;
1037                 #interrupt-cells = <2>;
1038                 device_type = "soc";
1039                 ranges = <00000000 e0000000 00100000>
1040                 reg = <e0000000 00003000>;
1041                 bus-frequency = <0>;
1042         }
1043
1044
1045
1046 IV - "dtc", the device tree compiler
1047 ====================================
1048
1049
1050 dtc source code can be found at
1051 <http://git.jdl.com/gitweb/?p=dtc.git>
1052
1053 WARNING: This version is still in early development stage; the
1054 resulting device-tree "blobs" have not yet been validated with the
1055 kernel. The current generated bloc lacks a useful reserve map (it will
1056 be fixed to generate an empty one, it's up to the bootloader to fill
1057 it up) among others. The error handling needs work, bugs are lurking,
1058 etc...
1059
1060 dtc basically takes a device-tree in a given format and outputs a
1061 device-tree in another format. The currently supported formats are:
1062
1063   Input formats:
1064   -------------
1065
1066      - "dtb": "blob" format, that is a flattened device-tree block
1067        with
1068         header all in a binary blob.
1069      - "dts": "source" format. This is a text file containing a
1070        "source" for a device-tree. The format is defined later in this
1071         chapter.
1072      - "fs" format. This is a representation equivalent to the
1073         output of /proc/device-tree, that is nodes are directories and
1074         properties are files
1075
1076  Output formats:
1077  ---------------
1078
1079      - "dtb": "blob" format
1080      - "dts": "source" format
1081      - "asm": assembly language file. This is a file that can be
1082        sourced by gas to generate a device-tree "blob". That file can
1083        then simply be added to your Makefile. Additionally, the
1084        assembly file exports some symbols that can be used.
1085
1086
1087 The syntax of the dtc tool is
1088
1089     dtc [-I <input-format>] [-O <output-format>]
1090         [-o output-filename] [-V output_version] input_filename
1091
1092
1093 The "output_version" defines what version of the "blob" format will be
1094 generated. Supported versions are 1,2,3 and 16. The default is
1095 currently version 3 but that may change in the future to version 16.
1096
1097 Additionally, dtc performs various sanity checks on the tree, like the
1098 uniqueness of linux, phandle properties, validity of strings, etc...
1099
1100 The format of the .dts "source" file is "C" like, supports C and C++
1101 style comments.
1102
1103 / {
1104 }
1105
1106 The above is the "device-tree" definition. It's the only statement
1107 supported currently at the toplevel.
1108
1109 / {
1110   property1 = "string_value";   /* define a property containing a 0
1111                                  * terminated string
1112                                  */
1113
1114   property2 = <1234abcd>;       /* define a property containing a
1115                                  * numerical 32-bit value (hexadecimal)
1116                                  */
1117
1118   property3 = <12345678 12345678 deadbeef>;
1119                                 /* define a property containing 3
1120                                  * numerical 32-bit values (cells) in
1121                                  * hexadecimal
1122                                  */
1123   property4 = [0a 0b 0c 0d de ea ad be ef];
1124                                 /* define a property whose content is
1125                                  * an arbitrary array of bytes
1126                                  */
1127
1128   childnode@addresss {  /* define a child node named "childnode"
1129                                  * whose unit name is "childnode at
1130                                  * address"
1131                                  */
1132
1133     childprop = "hello\n";      /* define a property "childprop" of
1134                                  * childnode (in this case, a string)
1135                                  */
1136   };
1137 };
1138
1139 Nodes can contain other nodes etc... thus defining the hierarchical
1140 structure of the tree.
1141
1142 Strings support common escape sequences from C: "\n", "\t", "\r",
1143 "\(octal value)", "\x(hex value)".
1144
1145 It is also suggested that you pipe your source file through cpp (gcc
1146 preprocessor) so you can use #include's, #define for constants, etc...
1147
1148 Finally, various options are planned but not yet implemented, like
1149 automatic generation of phandles, labels (exported to the asm file so
1150 you can point to a property content and change it easily from whatever
1151 you link the device-tree with), label or path instead of numeric value
1152 in some cells to "point" to a node (replaced by a phandle at compile
1153 time), export of reserve map address to the asm file, ability to
1154 specify reserve map content at compile time, etc...
1155
1156 We may provide a .h include file with common definitions of that
1157 proves useful for some properties (like building PCI properties or
1158 interrupt maps) though it may be better to add a notion of struct
1159 definitions to the compiler...
1160
1161
1162 V - Recommendations for a bootloader
1163 ====================================
1164
1165
1166 Here are some various ideas/recommendations that have been proposed
1167 while all this has been defined and implemented.
1168
1169   - The bootloader may want to be able to use the device-tree itself
1170     and may want to manipulate it (to add/edit some properties,
1171     like physical memory size or kernel arguments). At this point, 2
1172     choices can be made. Either the bootloader works directly on the
1173     flattened format, or the bootloader has its own internal tree
1174     representation with pointers (similar to the kernel one) and
1175     re-flattens the tree when booting the kernel. The former is a bit
1176     more difficult to edit/modify, the later requires probably a bit
1177     more code to handle the tree structure. Note that the structure
1178     format has been designed so it's relatively easy to "insert"
1179     properties or nodes or delete them by just memmoving things
1180     around. It contains no internal offsets or pointers for this
1181     purpose.
1182
1183   - An example of code for iterating nodes & retrieving properties
1184     directly from the flattened tree format can be found in the kernel
1185     file arch/ppc64/kernel/prom.c, look at scan_flat_dt() function,
1186     its usage in early_init_devtree(), and the corresponding various
1187     early_init_dt_scan_*() callbacks. That code can be re-used in a
1188     GPL bootloader, and as the author of that code, I would be happy
1189     to discuss possible free licensing to any vendor who wishes to
1190     integrate all or part of this code into a non-GPL bootloader.
1191
1192
1193
1194 VI - System-on-a-chip devices and nodes
1195 =======================================
1196
1197 Many companies are now starting to develop system-on-a-chip
1198 processors, where the processor core (CPU) and many peripheral devices
1199 exist on a single piece of silicon.  For these SOCs, an SOC node
1200 should be used that defines child nodes for the devices that make
1201 up the SOC. While platforms are not required to use this model in
1202 order to boot the kernel, it is highly encouraged that all SOC
1203 implementations define as complete a flat-device-tree as possible to
1204 describe the devices on the SOC.  This will allow for the
1205 genericization of much of the kernel code.
1206
1207
1208 1) Defining child nodes of an SOC
1209 ---------------------------------
1210
1211 Each device that is part of an SOC may have its own node entry inside
1212 the SOC node.  For each device that is included in the SOC, the unit
1213 address property represents the address offset for this device's
1214 memory-mapped registers in the parent's address space.  The parent's
1215 address space is defined by the "ranges" property in the top-level soc
1216 node. The "reg" property for each node that exists directly under the
1217 SOC node should contain the address mapping from the child address space
1218 to the parent SOC address space and the size of the device's
1219 memory-mapped register file.
1220
1221 For many devices that may exist inside an SOC, there are predefined
1222 specifications for the format of the device tree node.  All SOC child
1223 nodes should follow these specifications, except where noted in this
1224 document.
1225
1226 See appendix A for an example partial SOC node definition for the
1227 MPC8540.
1228
1229
1230 2) Representing devices without a current OF specification
1231 ----------------------------------------------------------
1232
1233 Currently, there are many devices on SOCs that do not have a standard
1234 representation pre-defined as part of the open firmware
1235 specifications, mainly because the boards that contain these SOCs are
1236 not currently booted using open firmware.   This section contains
1237 descriptions for the SOC devices for which new nodes have been
1238 defined; this list will expand as more and more SOC-containing
1239 platforms are moved over to use the flattened-device-tree model.
1240
1241 VII - Specifying interrupt information for devices
1242 ===================================================
1243
1244 The device tree represents the busses and devices of a hardware
1245 system in a form similar to the physical bus topology of the
1246 hardware.
1247
1248 In addition, a logical 'interrupt tree' exists which represents the
1249 hierarchy and routing of interrupts in the hardware.
1250
1251 The interrupt tree model is fully described in the
1252 document "Open Firmware Recommended Practice: Interrupt
1253 Mapping Version 0.9".  The document is available at:
1254 <http://playground.sun.com/1275/practice>.
1255
1256 1) interrupts property
1257 ----------------------
1258
1259 Devices that generate interrupts to a single interrupt controller
1260 should use the conventional OF representation described in the
1261 OF interrupt mapping documentation.
1262
1263 Each device which generates interrupts must have an 'interrupt'
1264 property.  The interrupt property value is an arbitrary number of
1265 of 'interrupt specifier' values which describe the interrupt or
1266 interrupts for the device.
1267
1268 The encoding of an interrupt specifier is determined by the
1269 interrupt domain in which the device is located in the
1270 interrupt tree.  The root of an interrupt domain specifies in
1271 its #interrupt-cells property the number of 32-bit cells
1272 required to encode an interrupt specifier.  See the OF interrupt
1273 mapping documentation for a detailed description of domains.
1274
1275 For example, the binding for the OpenPIC interrupt controller
1276 specifies  an #interrupt-cells value of 2 to encode the interrupt
1277 number and level/sense information. All interrupt children in an
1278 OpenPIC interrupt domain use 2 cells per interrupt in their interrupts
1279 property.
1280
1281 The PCI bus binding specifies a #interrupt-cell value of 1 to encode
1282 which interrupt pin (INTA,INTB,INTC,INTD) is used.
1283
1284 2) interrupt-parent property
1285 ----------------------------
1286
1287 The interrupt-parent property is specified to define an explicit
1288 link between a device node and its interrupt parent in
1289 the interrupt tree.  The value of interrupt-parent is the
1290 phandle of the parent node.
1291
1292 If the interrupt-parent property is not defined for a node, its
1293 interrupt parent is assumed to be an ancestor in the node's
1294 _device tree_ hierarchy.
1295
1296 3) OpenPIC Interrupt Controllers
1297 --------------------------------
1298
1299 OpenPIC interrupt controllers require 2 cells to encode
1300 interrupt information.  The first cell defines the interrupt
1301 number.  The second cell defines the sense and level
1302 information.
1303
1304 Sense and level information should be encoded as follows:
1305
1306         0 = low to high edge sensitive type enabled
1307         1 = active low level sensitive type enabled
1308         2 = active high level sensitive type enabled
1309         3 = high to low edge sensitive type enabled
1310
1311 4) ISA Interrupt Controllers
1312 ----------------------------
1313
1314 ISA PIC interrupt controllers require 2 cells to encode
1315 interrupt information.  The first cell defines the interrupt
1316 number.  The second cell defines the sense and level
1317 information.
1318
1319 ISA PIC interrupt controllers should adhere to the ISA PIC
1320 encodings listed below:
1321
1322         0 =  active low level sensitive type enabled
1323         1 =  active high level sensitive type enabled
1324         2 =  high to low edge sensitive type enabled
1325         3 =  low to high edge sensitive type enabled
1326
1327 VIII - Specifying Device Power Management Information (sleep property)
1328 ===================================================================
1329
1330 Devices on SOCs often have mechanisms for placing devices into low-power
1331 states that are decoupled from the devices' own register blocks.  Sometimes,
1332 this information is more complicated than a cell-index property can
1333 reasonably describe.  Thus, each device controlled in such a manner
1334 may contain a "sleep" property which describes these connections.
1335
1336 The sleep property consists of one or more sleep resources, each of
1337 which consists of a phandle to a sleep controller, followed by a
1338 controller-specific sleep specifier of zero or more cells.
1339
1340 The semantics of what type of low power modes are possible are defined
1341 by the sleep controller.  Some examples of the types of low power modes
1342 that may be supported are:
1343
1344  - Dynamic: The device may be disabled or enabled at any time.
1345  - System Suspend: The device may request to be disabled or remain
1346    awake during system suspend, but will not be disabled until then.
1347  - Permanent: The device is disabled permanently (until the next hard
1348    reset).
1349
1350 Some devices may share a clock domain with each other, such that they should
1351 only be suspended when none of the devices are in use.  Where reasonable,
1352 such nodes should be placed on a virtual bus, where the bus has the sleep
1353 property.  If the clock domain is shared among devices that cannot be
1354 reasonably grouped in this manner, then create a virtual sleep controller
1355 (similar to an interrupt nexus, except that defining a standardized
1356 sleep-map should wait until its necessity is demonstrated).
1357
1358 Appendix A - Sample SOC node for MPC8540
1359 ========================================
1360
1361         soc@e0000000 {
1362                 #address-cells = <1>;
1363                 #size-cells = <1>;
1364                 compatible = "fsl,mpc8540-ccsr", "simple-bus";
1365                 device_type = "soc";
1366                 ranges = <0x00000000 0xe0000000 0x00100000>
1367                 bus-frequency = <0>;
1368                 interrupt-parent = <&pic>;
1369
1370                 ethernet@24000 {
1371                         #address-cells = <1>;
1372                         #size-cells = <1>;
1373                         device_type = "network";
1374                         model = "TSEC";
1375                         compatible = "gianfar", "simple-bus";
1376                         reg = <0x24000 0x1000>;
1377                         local-mac-address = [ 00 E0 0C 00 73 00 ];
1378                         interrupts = <29 2 30 2 34 2>;
1379                         phy-handle = <&phy0>;
1380                         sleep = <&pmc 00000080>;
1381                         ranges;
1382
1383                         mdio@24520 {
1384                                 reg = <0x24520 0x20>;
1385                                 compatible = "fsl,gianfar-mdio";
1386
1387                                 phy0: ethernet-phy@0 {
1388                                         interrupts = <5 1>;
1389                                         reg = <0>;
1390                                         device_type = "ethernet-phy";
1391                                 };
1392
1393                                 phy1: ethernet-phy@1 {
1394                                         interrupts = <5 1>;
1395                                         reg = <1>;
1396                                         device_type = "ethernet-phy";
1397                                 };
1398
1399                                 phy3: ethernet-phy@3 {
1400                                         interrupts = <7 1>;
1401                                         reg = <3>;
1402                                         device_type = "ethernet-phy";
1403                                 };
1404                         };
1405                 };
1406
1407                 ethernet@25000 {
1408                         device_type = "network";
1409                         model = "TSEC";
1410                         compatible = "gianfar";
1411                         reg = <0x25000 0x1000>;
1412                         local-mac-address = [ 00 E0 0C 00 73 01 ];
1413                         interrupts = <13 2 14 2 18 2>;
1414                         phy-handle = <&phy1>;
1415                         sleep = <&pmc 00000040>;
1416                 };
1417
1418                 ethernet@26000 {
1419                         device_type = "network";
1420                         model = "FEC";
1421                         compatible = "gianfar";
1422                         reg = <0x26000 0x1000>;
1423                         local-mac-address = [ 00 E0 0C 00 73 02 ];
1424                         interrupts = <41 2>;
1425                         phy-handle = <&phy3>;
1426                         sleep = <&pmc 00000020>;
1427                 };
1428
1429                 serial@4500 {
1430                         #address-cells = <1>;
1431                         #size-cells = <1>;
1432                         compatible = "fsl,mpc8540-duart", "simple-bus";
1433                         sleep = <&pmc 00000002>;
1434                         ranges;
1435
1436                         serial@4500 {
1437                                 device_type = "serial";
1438                                 compatible = "ns16550";
1439                                 reg = <0x4500 0x100>;
1440                                 clock-frequency = <0>;
1441                                 interrupts = <42 2>;
1442                         };
1443
1444                         serial@4600 {
1445                                 device_type = "serial";
1446                                 compatible = "ns16550";
1447                                 reg = <0x4600 0x100>;
1448                                 clock-frequency = <0>;
1449                                 interrupts = <42 2>;
1450                         };
1451                 };
1452
1453                 pic: pic@40000 {
1454                         interrupt-controller;
1455                         #address-cells = <0>;
1456                         #interrupt-cells = <2>;
1457                         reg = <0x40000 0x40000>;
1458                         compatible = "chrp,open-pic";
1459                         device_type = "open-pic";
1460                 };
1461
1462                 i2c@3000 {
1463                         interrupts = <43 2>;
1464                         reg = <0x3000 0x100>;
1465                         compatible  = "fsl-i2c";
1466                         dfsrr;
1467                         sleep = <&pmc 00000004>;
1468                 };
1469
1470                 pmc: power@e0070 {
1471                         compatible = "fsl,mpc8540-pmc", "fsl,mpc8548-pmc";
1472                         reg = <0xe0070 0x20>;
1473                 };
1474         };