1 Booting the Linux/ppc kernel without Open Firmware
2 --------------------------------------------------
4 (c) 2005 Benjamin Herrenschmidt <benh at kernel.crashing.org>,
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
15 1) Entry point for arch/powerpc
18 II - The DT block format
20 2) Device tree generalities
21 3) Device tree "structure" block
22 4) Device tree "strings" block
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
33 d) the /memory node(s)
35 f) the /soc<SOCname> node
37 IV - "dtc", the device tree compiler
39 V - Recommendations for a bootloader
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
45 b) Gianfar-compatible ethernet nodes
47 d) Interrupt controllers
49 f) Freescale SOC USB controllers
50 g) Freescale SOC SEC Security Engines
51 h) Board Control and Status (BCSR)
52 i) Freescale QUICC Engine module (QE)
53 j) CFI or JEDEC memory-mapped NOR flash
54 k) Global Utilities Block
55 l) Freescale Communications Processor Module
56 m) Chipselect/Local Bus
57 n) 4xx/Axon EMAC ethernet nodes
59 p) Freescale Synchronous Serial Interface
60 q) USB EHCI controllers
63 VII - Marvell Discovery mv64[345]6x System Controller chips
64 1) The /system-controller node
65 2) Child nodes of /system-controller
66 a) Marvell Discovery MDIO bus
67 b) Marvell Discovery ethernet controller
68 c) Marvell Discovery PHY nodes
69 d) Marvell Discovery SDMA nodes
70 e) Marvell Discovery BRG nodes
71 f) Marvell Discovery CUNIT nodes
72 g) Marvell Discovery MPSCROUTING nodes
73 h) Marvell Discovery MPSCINTR nodes
74 i) Marvell Discovery MPSC nodes
75 j) Marvell Discovery Watch Dog Timer nodes
76 k) Marvell Discovery I2C nodes
77 l) Marvell Discovery PIC (Programmable Interrupt Controller) nodes
78 m) Marvell Discovery MPP (Multipurpose Pins) multiplexing nodes
79 n) Marvell Discovery GPP (General Purpose Pins) nodes
80 o) Marvell Discovery PCI host bridge node
81 p) Marvell Discovery CPU Error nodes
82 q) Marvell Discovery SRAM Controller nodes
83 r) Marvell Discovery PCI Error Handler nodes
84 s) Marvell Discovery Memory Controller nodes
86 VIII - Specifying interrupt information for devices
87 1) interrupts property
88 2) interrupt-parent property
89 3) OpenPIC Interrupt Controllers
90 4) ISA Interrupt Controllers
92 VIII - Specifying GPIO information for devices
94 2) gpio-controller nodes
96 Appendix A - Sample SOC node for MPC8540
102 May 18, 2005: Rev 0.1 - Initial draft, no chapter III yet.
104 May 19, 2005: Rev 0.2 - Add chapter III and bits & pieces here or
105 clarifies the fact that a lot of things are
106 optional, the kernel only requires a very
107 small device tree, though it is encouraged
108 to provide an as complete one as possible.
110 May 24, 2005: Rev 0.3 - Precise that DT block has to be in RAM
112 - Define version 3 and new format version 16
113 for the DT block (version 16 needs kernel
114 patches, will be fwd separately).
115 String block now has a size, and full path
116 is replaced by unit name for more
118 linux,phandle is made optional, only nodes
119 that are referenced by other nodes need it.
120 "name" property is now automatically
121 deduced from the unit name
123 June 1, 2005: Rev 0.4 - Correct confusion between OF_DT_END and
124 OF_DT_END_NODE in structure definition.
125 - Change version 16 format to always align
126 property data to 4 bytes. Since tokens are
127 already aligned, that means no specific
128 required alignment between property size
129 and property data. The old style variable
130 alignment would make it impossible to do
131 "simple" insertion of properties using
132 memmove (thanks Milton for
133 noticing). Updated kernel patch as well
134 - Correct a few more alignment constraints
135 - Add a chapter about the device-tree
136 compiler and the textural representation of
137 the tree that can be "compiled" by dtc.
139 November 21, 2005: Rev 0.5
140 - Additions/generalizations for 32-bit
141 - Changed to reflect the new arch/powerpc
147 - Add some definitions of interrupt tree (simple/complex)
148 - Add some definitions for PCI host bridges
149 - Add some common address format examples
150 - Add definitions for standard properties and "compatible"
151 names for cells that are not already defined by the existing
153 - Compare FSL SOC use of PCI to standard and make sure no new
154 node definition required.
155 - Add more information about node definitions for SOC devices
156 that currently have no standard, like the FSL CPM.
162 During the recent development of the Linux/ppc64 kernel, and more
163 specifically, the addition of new platform types outside of the old
164 IBM pSeries/iSeries pair, it was decided to enforce some strict rules
165 regarding the kernel entry and bootloader <-> kernel interfaces, in
166 order to avoid the degeneration that had become the ppc32 kernel entry
167 point and the way a new platform should be added to the kernel. The
168 legacy iSeries platform breaks those rules as it predates this scheme,
169 but no new board support will be accepted in the main tree that
170 doesn't follows them properly. In addition, since the advent of the
171 arch/powerpc merged architecture for ppc32 and ppc64, new 32-bit
172 platforms and 32-bit platforms which move into arch/powerpc will be
173 required to use these rules as well.
175 The main requirement that will be defined in more detail below is
176 the presence of a device-tree whose format is defined after Open
177 Firmware specification. However, in order to make life easier
178 to embedded board vendors, the kernel doesn't require the device-tree
179 to represent every device in the system and only requires some nodes
180 and properties to be present. This will be described in detail in
181 section III, but, for example, the kernel does not require you to
182 create a node for every PCI device in the system. It is a requirement
183 to have a node for PCI host bridges in order to provide interrupt
184 routing informations and memory/IO ranges, among others. It is also
185 recommended to define nodes for on chip devices and other busses that
186 don't specifically fit in an existing OF specification. This creates a
187 great flexibility in the way the kernel can then probe those and match
188 drivers to device, without having to hard code all sorts of tables. It
189 also makes it more flexible for board vendors to do minor hardware
190 upgrades without significantly impacting the kernel code or cluttering
191 it with special cases.
194 1) Entry point for arch/powerpc
195 -------------------------------
197 There is one and one single entry point to the kernel, at the start
198 of the kernel image. That entry point supports two calling
201 a) Boot from Open Firmware. If your firmware is compatible
202 with Open Firmware (IEEE 1275) or provides an OF compatible
203 client interface API (support for "interpret" callback of
204 forth words isn't required), you can enter the kernel with:
206 r5 : OF callback pointer as defined by IEEE 1275
207 bindings to powerpc. Only the 32-bit client interface
208 is currently supported
210 r3, r4 : address & length of an initrd if any or 0
212 The MMU is either on or off; the kernel will run the
213 trampoline located in arch/powerpc/kernel/prom_init.c to
214 extract the device-tree and other information from open
215 firmware and build a flattened device-tree as described
216 in b). prom_init() will then re-enter the kernel using
217 the second method. This trampoline code runs in the
218 context of the firmware, which is supposed to handle all
219 exceptions during that time.
221 b) Direct entry with a flattened device-tree block. This entry
222 point is called by a) after the OF trampoline and can also be
223 called directly by a bootloader that does not support the Open
224 Firmware client interface. It is also used by "kexec" to
225 implement "hot" booting of a new kernel from a previous
226 running one. This method is what I will describe in more
227 details in this document, as method a) is simply standard Open
228 Firmware, and thus should be implemented according to the
229 various standard documents defining it and its binding to the
230 PowerPC platform. The entry point definition then becomes:
232 r3 : physical pointer to the device-tree block
233 (defined in chapter II) in RAM
235 r4 : physical pointer to the kernel itself. This is
236 used by the assembly code to properly disable the MMU
237 in case you are entering the kernel with MMU enabled
238 and a non-1:1 mapping.
240 r5 : NULL (as to differentiate with method a)
242 Note about SMP entry: Either your firmware puts your other
243 CPUs in some sleep loop or spin loop in ROM where you can get
244 them out via a soft reset or some other means, in which case
245 you don't need to care, or you'll have to enter the kernel
246 with all CPUs. The way to do that with method b) will be
247 described in a later revision of this document.
255 Board supports (platforms) are not exclusive config options. An
256 arbitrary set of board supports can be built in a single kernel
257 image. The kernel will "know" what set of functions to use for a
258 given platform based on the content of the device-tree. Thus, you
261 a) add your platform support as a _boolean_ option in
262 arch/powerpc/Kconfig, following the example of PPC_PSERIES,
263 PPC_PMAC and PPC_MAPLE. The later is probably a good
264 example of a board support to start from.
266 b) create your main platform file as
267 "arch/powerpc/platforms/myplatform/myboard_setup.c" and add it
268 to the Makefile under the condition of your CONFIG_
269 option. This file will define a structure of type "ppc_md"
270 containing the various callbacks that the generic code will
271 use to get to your platform specific code
273 c) Add a reference to your "ppc_md" structure in the
274 "machines" table in arch/powerpc/kernel/setup_64.c if you are
277 d) request and get assigned a platform number (see PLATFORM_*
278 constants in include/asm-powerpc/processor.h
280 32-bit embedded kernels:
282 Currently, board support is essentially an exclusive config option.
283 The kernel is configured for a single platform. Part of the reason
284 for this is to keep kernels on embedded systems small and efficient;
285 part of this is due to the fact the code is already that way. In the
286 future, a kernel may support multiple platforms, but only if the
287 platforms feature the same core architecture. A single kernel build
288 cannot support both configurations with Book E and configurations
289 with classic Powerpc architectures.
291 32-bit embedded platforms that are moved into arch/powerpc using a
292 flattened device tree should adopt the merged tree practice of
293 setting ppc_md up dynamically, even though the kernel is currently
294 built with support for only a single platform at a time. This allows
295 unification of the setup code, and will make it easier to go to a
296 multiple-platform-support model in the future.
298 NOTE: I believe the above will be true once Ben's done with the merge
299 of the boot sequences.... someone speak up if this is wrong!
301 To add a 32-bit embedded platform support, follow the instructions
302 for 64-bit platforms above, with the exception that the Kconfig
303 option should be set up such that the kernel builds exclusively for
304 the platform selected. The processor type for the platform should
305 enable another config option to select the specific board
308 NOTE: If Ben doesn't merge the setup files, may need to change this to
312 I will describe later the boot process and various callbacks that
313 your platform should implement.
316 II - The DT block format
317 ========================
320 This chapter defines the actual format of the flattened device-tree
321 passed to the kernel. The actual content of it and kernel requirements
322 are described later. You can find example of code manipulating that
323 format in various places, including arch/powerpc/kernel/prom_init.c
324 which will generate a flattened device-tree from the Open Firmware
325 representation, or the fs2dt utility which is part of the kexec tools
326 which will generate one from a filesystem representation. It is
327 expected that a bootloader like uboot provides a bit more support,
328 that will be discussed later as well.
330 Note: The block has to be in main memory. It has to be accessible in
331 both real mode and virtual mode with no mapping other than main
332 memory. If you are writing a simple flash bootloader, it should copy
333 the block to RAM before passing it to the kernel.
339 The kernel is entered with r3 pointing to an area of memory that is
340 roughly described in include/asm-powerpc/prom.h by the structure
343 struct boot_param_header {
344 u32 magic; /* magic word OF_DT_HEADER */
345 u32 totalsize; /* total size of DT block */
346 u32 off_dt_struct; /* offset to structure */
347 u32 off_dt_strings; /* offset to strings */
348 u32 off_mem_rsvmap; /* offset to memory reserve map
350 u32 version; /* format version */
351 u32 last_comp_version; /* last compatible version */
353 /* version 2 fields below */
354 u32 boot_cpuid_phys; /* Which physical CPU id we're
356 /* version 3 fields below */
357 u32 size_dt_strings; /* size of the strings block */
359 /* version 17 fields below */
360 u32 size_dt_struct; /* size of the DT structure block */
363 Along with the constants:
365 /* Definitions used by the flattened device tree */
366 #define OF_DT_HEADER 0xd00dfeed /* 4: version,
368 #define OF_DT_BEGIN_NODE 0x1 /* Start node: full name
370 #define OF_DT_END_NODE 0x2 /* End node */
371 #define OF_DT_PROP 0x3 /* Property: name off,
373 #define OF_DT_END 0x9
375 All values in this header are in big endian format, the various
376 fields in this header are defined more precisely below. All
377 "offset" values are in bytes from the start of the header; that is
378 from the value of r3.
382 This is a magic value that "marks" the beginning of the
383 device-tree block header. It contains the value 0xd00dfeed and is
384 defined by the constant OF_DT_HEADER
388 This is the total size of the DT block including the header. The
389 "DT" block should enclose all data structures defined in this
390 chapter (who are pointed to by offsets in this header). That is,
391 the device-tree structure, strings, and the memory reserve map.
395 This is an offset from the beginning of the header to the start
396 of the "structure" part the device tree. (see 2) device tree)
400 This is an offset from the beginning of the header to the start
401 of the "strings" part of the device-tree
405 This is an offset from the beginning of the header to the start
406 of the reserved memory map. This map is a list of pairs of 64-
407 bit integers. Each pair is a physical address and a size. The
408 list is terminated by an entry of size 0. This map provides the
409 kernel with a list of physical memory areas that are "reserved"
410 and thus not to be used for memory allocations, especially during
411 early initialization. The kernel needs to allocate memory during
412 boot for things like un-flattening the device-tree, allocating an
413 MMU hash table, etc... Those allocations must be done in such a
414 way to avoid overriding critical things like, on Open Firmware
415 capable machines, the RTAS instance, or on some pSeries, the TCE
416 tables used for the iommu. Typically, the reserve map should
417 contain _at least_ this DT block itself (header,total_size). If
418 you are passing an initrd to the kernel, you should reserve it as
419 well. You do not need to reserve the kernel image itself. The map
420 should be 64-bit aligned.
424 This is the version of this structure. Version 1 stops
425 here. Version 2 adds an additional field boot_cpuid_phys.
426 Version 3 adds the size of the strings block, allowing the kernel
427 to reallocate it easily at boot and free up the unused flattened
428 structure after expansion. Version 16 introduces a new more
429 "compact" format for the tree itself that is however not backward
430 compatible. Version 17 adds an additional field, size_dt_struct,
431 allowing it to be reallocated or moved more easily (this is
432 particularly useful for bootloaders which need to make
433 adjustments to a device tree based on probed information). You
434 should always generate a structure of the highest version defined
435 at the time of your implementation. Currently that is version 17,
436 unless you explicitly aim at being backward compatible.
440 Last compatible version. This indicates down to what version of
441 the DT block you are backward compatible. For example, version 2
442 is backward compatible with version 1 (that is, a kernel build
443 for version 1 will be able to boot with a version 2 format). You
444 should put a 1 in this field if you generate a device tree of
445 version 1 to 3, or 16 if you generate a tree of version 16 or 17
446 using the new unit name format.
450 This field only exist on version 2 headers. It indicate which
451 physical CPU ID is calling the kernel entry point. This is used,
452 among others, by kexec. If you are on an SMP system, this value
453 should match the content of the "reg" property of the CPU node in
454 the device-tree corresponding to the CPU calling the kernel entry
455 point (see further chapters for more informations on the required
456 device-tree contents)
460 This field only exists on version 3 and later headers. It
461 gives the size of the "strings" section of the device tree (which
462 starts at the offset given by off_dt_strings).
466 This field only exists on version 17 and later headers. It gives
467 the size of the "structure" section of the device tree (which
468 starts at the offset given by off_dt_struct).
470 So the typical layout of a DT block (though the various parts don't
471 need to be in that order) looks like this (addresses go from top to
475 ------------------------------
476 r3 -> | struct boot_param_header |
477 ------------------------------
478 | (alignment gap) (*) |
479 ------------------------------
480 | memory reserve map |
481 ------------------------------
483 ------------------------------
485 | device-tree structure |
487 ------------------------------
489 ------------------------------
491 | device-tree strings |
493 -----> ------------------------------
498 (*) The alignment gaps are not necessarily present; their presence
499 and size are dependent on the various alignment requirements of
500 the individual data blocks.
503 2) Device tree generalities
504 ---------------------------
506 This device-tree itself is separated in two different blocks, a
507 structure block and a strings block. Both need to be aligned to a 4
510 First, let's quickly describe the device-tree concept before detailing
511 the storage format. This chapter does _not_ describe the detail of the
512 required types of nodes & properties for the kernel, this is done
513 later in chapter III.
515 The device-tree layout is strongly inherited from the definition of
516 the Open Firmware IEEE 1275 device-tree. It's basically a tree of
517 nodes, each node having two or more named properties. A property can
520 It is a tree, so each node has one and only one parent except for the
521 root node who has no parent.
523 A node has 2 names. The actual node name is generally contained in a
524 property of type "name" in the node property list whose value is a
525 zero terminated string and is mandatory for version 1 to 3 of the
526 format definition (as it is in Open Firmware). Version 16 makes it
527 optional as it can generate it from the unit name defined below.
529 There is also a "unit name" that is used to differentiate nodes with
530 the same name at the same level, it is usually made of the node
531 names, the "@" sign, and a "unit address", which definition is
532 specific to the bus type the node sits on.
534 The unit name doesn't exist as a property per-se but is included in
535 the device-tree structure. It is typically used to represent "path" in
536 the device-tree. More details about the actual format of these will be
539 The kernel powerpc generic code does not make any formal use of the
540 unit address (though some board support code may do) so the only real
541 requirement here for the unit address is to ensure uniqueness of
542 the node unit name at a given level of the tree. Nodes with no notion
543 of address and no possible sibling of the same name (like /memory or
544 /cpus) may omit the unit address in the context of this specification,
545 or use the "@0" default unit address. The unit name is used to define
546 a node "full path", which is the concatenation of all parent node
547 unit names separated with "/".
549 The root node doesn't have a defined name, and isn't required to have
550 a name property either if you are using version 3 or earlier of the
551 format. It also has no unit address (no @ symbol followed by a unit
552 address). The root node unit name is thus an empty string. The full
553 path to the root node is "/".
555 Every node which actually represents an actual device (that is, a node
556 which isn't only a virtual "container" for more nodes, like "/cpus"
557 is) is also required to have a "device_type" property indicating the
560 Finally, every node that can be referenced from a property in another
561 node is required to have a "linux,phandle" property. Real open
562 firmware implementations provide a unique "phandle" value for every
563 node that the "prom_init()" trampoline code turns into
564 "linux,phandle" properties. However, this is made optional if the
565 flattened device tree is used directly. An example of a node
566 referencing another node via "phandle" is when laying out the
567 interrupt tree which will be described in a further version of this
570 This "linux, phandle" property is a 32-bit value that uniquely
571 identifies a node. You are free to use whatever values or system of
572 values, internal pointers, or whatever to generate these, the only
573 requirement is that every node for which you provide that property has
574 a unique value for it.
576 Here is an example of a simple device-tree. In this example, an "o"
577 designates a node followed by the node unit name. Properties are
578 presented with their name followed by their content. "content"
579 represents an ASCII string (zero terminated) value, while <content>
580 represents a 32-bit hexadecimal value. The various nodes in this
581 example will be discussed in a later chapter. At this point, it is
582 only meant to give you a idea of what a device-tree looks like. I have
583 purposefully kept the "name" and "linux,phandle" properties which
584 aren't necessary in order to give you a better idea of what the tree
585 looks like in practice.
588 |- name = "device-tree"
589 |- model = "MyBoardName"
590 |- compatible = "MyBoardFamilyName"
591 |- #address-cells = <2>
593 |- linux,phandle = <0>
597 | | - linux,phandle = <1>
598 | | - #address-cells = <1>
599 | | - #size-cells = <0>
602 | |- name = "PowerPC,970"
603 | |- device_type = "cpu"
605 | |- clock-frequency = <5f5e1000>
607 | |- linux,phandle = <2>
611 | |- device_type = "memory"
612 | |- reg = <00000000 00000000 00000000 20000000>
613 | |- linux,phandle = <3>
617 |- bootargs = "root=/dev/sda2"
618 |- linux,phandle = <4>
620 This tree is almost a minimal tree. It pretty much contains the
621 minimal set of required nodes and properties to boot a linux kernel;
622 that is, some basic model informations at the root, the CPUs, and the
623 physical memory layout. It also includes misc information passed
624 through /chosen, like in this example, the platform type (mandatory)
625 and the kernel command line arguments (optional).
627 The /cpus/PowerPC,970@0/64-bit property is an example of a
628 property without a value. All other properties have a value. The
629 significance of the #address-cells and #size-cells properties will be
630 explained in chapter IV which defines precisely the required nodes and
631 properties and their content.
634 3) Device tree "structure" block
636 The structure of the device tree is a linearized tree structure. The
637 "OF_DT_BEGIN_NODE" token starts a new node, and the "OF_DT_END_NODE"
638 ends that node definition. Child nodes are simply defined before
639 "OF_DT_END_NODE" (that is nodes within the node). A 'token' is a 32
640 bit value. The tree has to be "finished" with a OF_DT_END token
642 Here's the basic structure of a single node:
644 * token OF_DT_BEGIN_NODE (that is 0x00000001)
645 * for version 1 to 3, this is the node full path as a zero
646 terminated string, starting with "/". For version 16 and later,
647 this is the node unit name only (or an empty string for the
649 * [align gap to next 4 bytes boundary]
651 * token OF_DT_PROP (that is 0x00000003)
652 * 32-bit value of property value size in bytes (or 0 if no
654 * 32-bit value of offset in string block of property name
655 * property value data if any
656 * [align gap to next 4 bytes boundary]
657 * [child nodes if any]
658 * token OF_DT_END_NODE (that is 0x00000002)
660 So the node content can be summarized as a start token, a full path,
661 a list of properties, a list of child nodes, and an end token. Every
662 child node is a full node structure itself as defined above.
664 NOTE: The above definition requires that all property definitions for
665 a particular node MUST precede any subnode definitions for that node.
666 Although the structure would not be ambiguous if properties and
667 subnodes were intermingled, the kernel parser requires that the
668 properties come first (up until at least 2.6.22). Any tools
669 manipulating a flattened tree must take care to preserve this
672 4) Device tree "strings" block
674 In order to save space, property names, which are generally redundant,
675 are stored separately in the "strings" block. This block is simply the
676 whole bunch of zero terminated strings for all property names
677 concatenated together. The device-tree property definitions in the
678 structure block will contain offset values from the beginning of the
682 III - Required content of the device tree
683 =========================================
685 WARNING: All "linux,*" properties defined in this document apply only
686 to a flattened device-tree. If your platform uses a real
687 implementation of Open Firmware or an implementation compatible with
688 the Open Firmware client interface, those properties will be created
689 by the trampoline code in the kernel's prom_init() file. For example,
690 that's where you'll have to add code to detect your board model and
691 set the platform number. However, when using the flattened device-tree
692 entry point, there is no prom_init() pass, and thus you have to
693 provide those properties yourself.
696 1) Note about cells and address representation
697 ----------------------------------------------
699 The general rule is documented in the various Open Firmware
700 documentations. If you choose to describe a bus with the device-tree
701 and there exist an OF bus binding, then you should follow the
702 specification. However, the kernel does not require every single
703 device or bus to be described by the device tree.
705 In general, the format of an address for a device is defined by the
706 parent bus type, based on the #address-cells and #size-cells
707 properties. Note that the parent's parent definitions of #address-cells
708 and #size-cells are not inhereted so every node with children must specify
709 them. The kernel requires the root node to have those properties defining
710 addresses format for devices directly mapped on the processor bus.
712 Those 2 properties define 'cells' for representing an address and a
713 size. A "cell" is a 32-bit number. For example, if both contain 2
714 like the example tree given above, then an address and a size are both
715 composed of 2 cells, and each is a 64-bit number (cells are
716 concatenated and expected to be in big endian format). Another example
717 is the way Apple firmware defines them, with 2 cells for an address
718 and one cell for a size. Most 32-bit implementations should define
719 #address-cells and #size-cells to 1, which represents a 32-bit value.
720 Some 32-bit processors allow for physical addresses greater than 32
721 bits; these processors should define #address-cells as 2.
723 "reg" properties are always a tuple of the type "address size" where
724 the number of cells of address and size is specified by the bus
725 #address-cells and #size-cells. When a bus supports various address
726 spaces and other flags relative to a given address allocation (like
727 prefetchable, etc...) those flags are usually added to the top level
728 bits of the physical address. For example, a PCI physical address is
729 made of 3 cells, the bottom two containing the actual address itself
730 while the top cell contains address space indication, flags, and pci
731 bus & device numbers.
733 For busses that support dynamic allocation, it's the accepted practice
734 to then not provide the address in "reg" (keep it 0) though while
735 providing a flag indicating the address is dynamically allocated, and
736 then, to provide a separate "assigned-addresses" property that
737 contains the fully allocated addresses. See the PCI OF bindings for
740 In general, a simple bus with no address space bits and no dynamic
741 allocation is preferred if it reflects your hardware, as the existing
742 kernel address parsing functions will work out of the box. If you
743 define a bus type with a more complex address format, including things
744 like address space bits, you'll have to add a bus translator to the
745 prom_parse.c file of the recent kernels for your bus type.
747 The "reg" property only defines addresses and sizes (if #size-cells is
748 non-0) within a given bus. In order to translate addresses upward
749 (that is into parent bus addresses, and possibly into CPU physical
750 addresses), all busses must contain a "ranges" property. If the
751 "ranges" property is missing at a given level, it's assumed that
752 translation isn't possible, i.e., the registers are not visible on the
753 parent bus. The format of the "ranges" property for a bus is a list
756 bus address, parent bus address, size
758 "bus address" is in the format of the bus this bus node is defining,
759 that is, for a PCI bridge, it would be a PCI address. Thus, (bus
760 address, size) defines a range of addresses for child devices. "parent
761 bus address" is in the format of the parent bus of this bus. For
762 example, for a PCI host controller, that would be a CPU address. For a
763 PCI<->ISA bridge, that would be a PCI address. It defines the base
764 address in the parent bus where the beginning of that range is mapped.
766 For a new 64-bit powerpc board, I recommend either the 2/2 format or
767 Apple's 2/1 format which is slightly more compact since sizes usually
768 fit in a single 32-bit word. New 32-bit powerpc boards should use a
769 1/1 format, unless the processor supports physical addresses greater
770 than 32-bits, in which case a 2/1 format is recommended.
772 Alternatively, the "ranges" property may be empty, indicating that the
773 registers are visible on the parent bus using an identity mapping
774 translation. In other words, the parent bus address space is the same
775 as the child bus address space.
777 2) Note about "compatible" properties
778 -------------------------------------
780 These properties are optional, but recommended in devices and the root
781 node. The format of a "compatible" property is a list of concatenated
782 zero terminated strings. They allow a device to express its
783 compatibility with a family of similar devices, in some cases,
784 allowing a single driver to match against several devices regardless
785 of their actual names.
787 3) Note about "name" properties
788 -------------------------------
790 While earlier users of Open Firmware like OldWorld macintoshes tended
791 to use the actual device name for the "name" property, it's nowadays
792 considered a good practice to use a name that is closer to the device
793 class (often equal to device_type). For example, nowadays, ethernet
794 controllers are named "ethernet", an additional "model" property
795 defining precisely the chip type/model, and "compatible" property
796 defining the family in case a single driver can driver more than one
797 of these chips. However, the kernel doesn't generally put any
798 restriction on the "name" property; it is simply considered good
799 practice to follow the standard and its evolutions as closely as
802 Note also that the new format version 16 makes the "name" property
803 optional. If it's absent for a node, then the node's unit name is then
804 used to reconstruct the name. That is, the part of the unit name
805 before the "@" sign is used (or the entire unit name if no "@" sign
808 4) Note about node and property names and character set
809 -------------------------------------------------------
811 While open firmware provides more flexible usage of 8859-1, this
812 specification enforces more strict rules. Nodes and properties should
813 be comprised only of ASCII characters 'a' to 'z', '0' to
814 '9', ',', '.', '_', '+', '#', '?', and '-'. Node names additionally
815 allow uppercase characters 'A' to 'Z' (property names should be
816 lowercase. The fact that vendors like Apple don't respect this rule is
817 irrelevant here). Additionally, node and property names should always
818 begin with a character in the range 'a' to 'z' (or 'A' to 'Z' for node
821 The maximum number of characters for both nodes and property names
822 is 31. In the case of node names, this is only the leftmost part of
823 a unit name (the pure "name" property), it doesn't include the unit
824 address which can extend beyond that limit.
827 5) Required nodes and properties
828 --------------------------------
829 These are all that are currently required. However, it is strongly
830 recommended that you expose PCI host bridges as documented in the
831 PCI binding to open firmware, and your interrupt tree as documented
832 in OF interrupt tree specification.
836 The root node requires some properties to be present:
838 - model : this is your board name/model
839 - #address-cells : address representation for "root" devices
840 - #size-cells: the size representation for "root" devices
841 - device_type : This property shouldn't be necessary. However, if
842 you decide to create a device_type for your root node, make sure it
843 is _not_ "chrp" unless your platform is a pSeries or PAPR compliant
844 one for 64-bit, or a CHRP-type machine for 32-bit as this will
845 matched by the kernel this way.
847 Additionally, some recommended properties are:
849 - compatible : the board "family" generally finds its way here,
850 for example, if you have 2 board models with a similar layout,
851 that typically get driven by the same platform code in the
852 kernel, you would use a different "model" property but put a
853 value in "compatible". The kernel doesn't directly use that
854 value but it is generally useful.
856 The root node is also generally where you add additional properties
857 specific to your board like the serial number if any, that sort of
858 thing. It is recommended that if you add any "custom" property whose
859 name may clash with standard defined ones, you prefix them with your
860 vendor name and a comma.
864 This node is the parent of all individual CPU nodes. It doesn't
865 have any specific requirements, though it's generally good practice
868 #address-cells = <00000001>
869 #size-cells = <00000000>
871 This defines that the "address" for a CPU is a single cell, and has
872 no meaningful size. This is not necessary but the kernel will assume
873 that format when reading the "reg" properties of a CPU node, see
878 So under /cpus, you are supposed to create a node for every CPU on
879 the machine. There is no specific restriction on the name of the
880 CPU, though It's common practice to call it PowerPC,<name>. For
881 example, Apple uses PowerPC,G5 while IBM uses PowerPC,970FX.
885 - device_type : has to be "cpu"
886 - reg : This is the physical CPU number, it's a single 32-bit cell
887 and is also used as-is as the unit number for constructing the
888 unit name in the full path. For example, with 2 CPUs, you would
890 /cpus/PowerPC,970FX@0
891 /cpus/PowerPC,970FX@1
892 (unit addresses do not require leading zeroes)
893 - d-cache-block-size : one cell, L1 data cache block size in bytes (*)
894 - i-cache-block-size : one cell, L1 instruction cache block size in
896 - d-cache-size : one cell, size of L1 data cache in bytes
897 - i-cache-size : one cell, size of L1 instruction cache in bytes
899 (*) The cache "block" size is the size on which the cache management
900 instructions operate. Historically, this document used the cache
901 "line" size here which is incorrect. The kernel will prefer the cache
902 block size and will fallback to cache line size for backward
905 Recommended properties:
907 - timebase-frequency : a cell indicating the frequency of the
908 timebase in Hz. This is not directly used by the generic code,
909 but you are welcome to copy/paste the pSeries code for setting
910 the kernel timebase/decrementer calibration based on this
912 - clock-frequency : a cell indicating the CPU core clock frequency
913 in Hz. A new property will be defined for 64-bit values, but if
914 your frequency is < 4Ghz, one cell is enough. Here as well as
915 for the above, the common code doesn't use that property, but
916 you are welcome to re-use the pSeries or Maple one. A future
917 kernel version might provide a common function for this.
918 - d-cache-line-size : one cell, L1 data cache line size in bytes
919 if different from the block size
920 - i-cache-line-size : one cell, L1 instruction cache line size in
921 bytes if different from the block size
923 You are welcome to add any property you find relevant to your board,
924 like some information about the mechanism used to soft-reset the
925 CPUs. For example, Apple puts the GPIO number for CPU soft reset
926 lines in there as a "soft-reset" property since they start secondary
927 CPUs by soft-resetting them.
930 d) the /memory node(s)
932 To define the physical memory layout of your board, you should
933 create one or more memory node(s). You can either create a single
934 node with all memory ranges in its reg property, or you can create
935 several nodes, as you wish. The unit address (@ part) used for the
936 full path is the address of the first range of memory defined by a
937 given node. If you use a single memory node, this will typically be
942 - device_type : has to be "memory"
943 - reg : This property contains all the physical memory ranges of
944 your board. It's a list of addresses/sizes concatenated
945 together, with the number of cells of each defined by the
946 #address-cells and #size-cells of the root node. For example,
947 with both of these properties being 2 like in the example given
948 earlier, a 970 based machine with 6Gb of RAM could typically
949 have a "reg" property here that looks like:
951 00000000 00000000 00000000 80000000
952 00000001 00000000 00000001 00000000
954 That is a range starting at 0 of 0x80000000 bytes and a range
955 starting at 0x100000000 and of 0x100000000 bytes. You can see
956 that there is no memory covering the IO hole between 2Gb and
957 4Gb. Some vendors prefer splitting those ranges into smaller
958 segments, but the kernel doesn't care.
962 This node is a bit "special". Normally, that's where open firmware
963 puts some variable environment information, like the arguments, or
964 the default input/output devices.
966 This specification makes a few of these mandatory, but also defines
967 some linux-specific properties that would be normally constructed by
968 the prom_init() trampoline when booting with an OF client interface,
969 but that you have to provide yourself when using the flattened format.
971 Recommended properties:
973 - bootargs : This zero-terminated string is passed as the kernel
975 - linux,stdout-path : This is the full path to your standard
976 console device if any. Typically, if you have serial devices on
977 your board, you may want to put the full path to the one set as
978 the default console in the firmware here, for the kernel to pick
979 it up as its own default console. If you look at the function
980 set_preferred_console() in arch/ppc64/kernel/setup.c, you'll see
981 that the kernel tries to find out the default console and has
982 knowledge of various types like 8250 serial ports. You may want
983 to extend this function to add your own.
985 Note that u-boot creates and fills in the chosen node for platforms
988 (Note: a practice that is now obsolete was to include a property
989 under /chosen called interrupt-controller which had a phandle value
990 that pointed to the main interrupt controller)
992 f) the /soc<SOCname> node
994 This node is used to represent a system-on-a-chip (SOC) and must be
995 present if the processor is a SOC. The top-level soc node contains
996 information that is global to all devices on the SOC. The node name
997 should contain a unit address for the SOC, which is the base address
998 of the memory-mapped register set for the SOC. The name of an soc
999 node should start with "soc", and the remainder of the name should
1000 represent the part number for the soc. For example, the MPC8540's
1001 soc node would be called "soc8540".
1003 Required properties:
1005 - device_type : Should be "soc"
1006 - ranges : Should be defined as specified in 1) to describe the
1007 translation of SOC addresses for memory mapped SOC registers.
1008 - bus-frequency: Contains the bus frequency for the SOC node.
1009 Typically, the value of this field is filled in by the boot
1013 Recommended properties:
1015 - reg : This property defines the address and size of the
1016 memory-mapped registers that are used for the SOC node itself.
1017 It does not include the child device registers - these will be
1018 defined inside each child node. The address specified in the
1019 "reg" property should match the unit address of the SOC node.
1020 - #address-cells : Address representation for "soc" devices. The
1021 format of this field may vary depending on whether or not the
1022 device registers are memory mapped. For memory mapped
1023 registers, this field represents the number of cells needed to
1024 represent the address of the registers. For SOCs that do not
1025 use MMIO, a special address format should be defined that
1026 contains enough cells to represent the required information.
1027 See 1) above for more details on defining #address-cells.
1028 - #size-cells : Size representation for "soc" devices
1029 - #interrupt-cells : Defines the width of cells used to represent
1030 interrupts. Typically this value is <2>, which includes a
1031 32-bit number that represents the interrupt number, and a
1032 32-bit number that represents the interrupt sense and level.
1033 This field is only needed if the SOC contains an interrupt
1036 The SOC node may contain child nodes for each SOC device that the
1037 platform uses. Nodes should not be created for devices which exist
1038 on the SOC but are not used by a particular platform. See chapter VI
1039 for more information on how to specify devices that are part of a SOC.
1041 Example SOC node for the MPC8540:
1044 #address-cells = <1>;
1046 #interrupt-cells = <2>;
1047 device_type = "soc";
1048 ranges = <00000000 e0000000 00100000>
1049 reg = <e0000000 00003000>;
1050 bus-frequency = <0>;
1055 IV - "dtc", the device tree compiler
1056 ====================================
1059 dtc source code can be found at
1060 <http://ozlabs.org/~dgibson/dtc/dtc.tar.gz>
1062 WARNING: This version is still in early development stage; the
1063 resulting device-tree "blobs" have not yet been validated with the
1064 kernel. The current generated bloc lacks a useful reserve map (it will
1065 be fixed to generate an empty one, it's up to the bootloader to fill
1066 it up) among others. The error handling needs work, bugs are lurking,
1069 dtc basically takes a device-tree in a given format and outputs a
1070 device-tree in another format. The currently supported formats are:
1075 - "dtb": "blob" format, that is a flattened device-tree block
1077 header all in a binary blob.
1078 - "dts": "source" format. This is a text file containing a
1079 "source" for a device-tree. The format is defined later in this
1081 - "fs" format. This is a representation equivalent to the
1082 output of /proc/device-tree, that is nodes are directories and
1083 properties are files
1088 - "dtb": "blob" format
1089 - "dts": "source" format
1090 - "asm": assembly language file. This is a file that can be
1091 sourced by gas to generate a device-tree "blob". That file can
1092 then simply be added to your Makefile. Additionally, the
1093 assembly file exports some symbols that can be used.
1096 The syntax of the dtc tool is
1098 dtc [-I <input-format>] [-O <output-format>]
1099 [-o output-filename] [-V output_version] input_filename
1102 The "output_version" defines what version of the "blob" format will be
1103 generated. Supported versions are 1,2,3 and 16. The default is
1104 currently version 3 but that may change in the future to version 16.
1106 Additionally, dtc performs various sanity checks on the tree, like the
1107 uniqueness of linux, phandle properties, validity of strings, etc...
1109 The format of the .dts "source" file is "C" like, supports C and C++
1115 The above is the "device-tree" definition. It's the only statement
1116 supported currently at the toplevel.
1119 property1 = "string_value"; /* define a property containing a 0
1123 property2 = <1234abcd>; /* define a property containing a
1124 * numerical 32-bit value (hexadecimal)
1127 property3 = <12345678 12345678 deadbeef>;
1128 /* define a property containing 3
1129 * numerical 32-bit values (cells) in
1132 property4 = [0a 0b 0c 0d de ea ad be ef];
1133 /* define a property whose content is
1134 * an arbitrary array of bytes
1137 childnode@addresss { /* define a child node named "childnode"
1138 * whose unit name is "childnode at
1142 childprop = "hello\n"; /* define a property "childprop" of
1143 * childnode (in this case, a string)
1148 Nodes can contain other nodes etc... thus defining the hierarchical
1149 structure of the tree.
1151 Strings support common escape sequences from C: "\n", "\t", "\r",
1152 "\(octal value)", "\x(hex value)".
1154 It is also suggested that you pipe your source file through cpp (gcc
1155 preprocessor) so you can use #include's, #define for constants, etc...
1157 Finally, various options are planned but not yet implemented, like
1158 automatic generation of phandles, labels (exported to the asm file so
1159 you can point to a property content and change it easily from whatever
1160 you link the device-tree with), label or path instead of numeric value
1161 in some cells to "point" to a node (replaced by a phandle at compile
1162 time), export of reserve map address to the asm file, ability to
1163 specify reserve map content at compile time, etc...
1165 We may provide a .h include file with common definitions of that
1166 proves useful for some properties (like building PCI properties or
1167 interrupt maps) though it may be better to add a notion of struct
1168 definitions to the compiler...
1171 V - Recommendations for a bootloader
1172 ====================================
1175 Here are some various ideas/recommendations that have been proposed
1176 while all this has been defined and implemented.
1178 - The bootloader may want to be able to use the device-tree itself
1179 and may want to manipulate it (to add/edit some properties,
1180 like physical memory size or kernel arguments). At this point, 2
1181 choices can be made. Either the bootloader works directly on the
1182 flattened format, or the bootloader has its own internal tree
1183 representation with pointers (similar to the kernel one) and
1184 re-flattens the tree when booting the kernel. The former is a bit
1185 more difficult to edit/modify, the later requires probably a bit
1186 more code to handle the tree structure. Note that the structure
1187 format has been designed so it's relatively easy to "insert"
1188 properties or nodes or delete them by just memmoving things
1189 around. It contains no internal offsets or pointers for this
1192 - An example of code for iterating nodes & retrieving properties
1193 directly from the flattened tree format can be found in the kernel
1194 file arch/ppc64/kernel/prom.c, look at scan_flat_dt() function,
1195 its usage in early_init_devtree(), and the corresponding various
1196 early_init_dt_scan_*() callbacks. That code can be re-used in a
1197 GPL bootloader, and as the author of that code, I would be happy
1198 to discuss possible free licensing to any vendor who wishes to
1199 integrate all or part of this code into a non-GPL bootloader.
1203 VI - System-on-a-chip devices and nodes
1204 =======================================
1206 Many companies are now starting to develop system-on-a-chip
1207 processors, where the processor core (CPU) and many peripheral devices
1208 exist on a single piece of silicon. For these SOCs, an SOC node
1209 should be used that defines child nodes for the devices that make
1210 up the SOC. While platforms are not required to use this model in
1211 order to boot the kernel, it is highly encouraged that all SOC
1212 implementations define as complete a flat-device-tree as possible to
1213 describe the devices on the SOC. This will allow for the
1214 genericization of much of the kernel code.
1217 1) Defining child nodes of an SOC
1218 ---------------------------------
1220 Each device that is part of an SOC may have its own node entry inside
1221 the SOC node. For each device that is included in the SOC, the unit
1222 address property represents the address offset for this device's
1223 memory-mapped registers in the parent's address space. The parent's
1224 address space is defined by the "ranges" property in the top-level soc
1225 node. The "reg" property for each node that exists directly under the
1226 SOC node should contain the address mapping from the child address space
1227 to the parent SOC address space and the size of the device's
1228 memory-mapped register file.
1230 For many devices that may exist inside an SOC, there are predefined
1231 specifications for the format of the device tree node. All SOC child
1232 nodes should follow these specifications, except where noted in this
1235 See appendix A for an example partial SOC node definition for the
1239 2) Representing devices without a current OF specification
1240 ----------------------------------------------------------
1242 Currently, there are many devices on SOCs that do not have a standard
1243 representation pre-defined as part of the open firmware
1244 specifications, mainly because the boards that contain these SOCs are
1245 not currently booted using open firmware. This section contains
1246 descriptions for the SOC devices for which new nodes have been
1247 defined; this list will expand as more and more SOC-containing
1248 platforms are moved over to use the flattened-device-tree model.
1252 The MDIO is a bus to which the PHY devices are connected. For each
1253 device that exists on this bus, a child node should be created. See
1254 the definition of the PHY node below for an example of how to define
1257 Required properties:
1258 - reg : Offset and length of the register set for the device
1259 - compatible : Should define the compatible device type for the
1260 mdio. Currently, this is most likely to be "fsl,gianfar-mdio"
1266 compatible = "fsl,gianfar-mdio";
1274 b) Gianfar-compatible ethernet nodes
1276 Required properties:
1278 - device_type : Should be "network"
1279 - model : Model of the device. Can be "TSEC", "eTSEC", or "FEC"
1280 - compatible : Should be "gianfar"
1281 - reg : Offset and length of the register set for the device
1282 - mac-address : List of bytes representing the ethernet address of
1284 - interrupts : <a b> where a is the interrupt number and b is a
1285 field that represents an encoding of the sense and level
1286 information for the interrupt. This should be encoded based on
1287 the information in section 2) depending on the type of interrupt
1288 controller you have.
1289 - interrupt-parent : the phandle for the interrupt controller that
1290 services interrupts for this device.
1291 - phy-handle : The phandle for the PHY connected to this ethernet
1293 - fixed-link : <a b c d e> where a is emulated phy id - choose any,
1294 but unique to the all specified fixed-links, b is duplex - 0 half,
1295 1 full, c is link speed - d#10/d#100/d#1000, d is pause - 0 no
1296 pause, 1 pause, e is asym_pause - 0 no asym_pause, 1 asym_pause.
1298 Recommended properties:
1300 - phy-connection-type : a string naming the controller/PHY interface type,
1301 i.e., "mii" (default), "rmii", "gmii", "rgmii", "rgmii-id", "sgmii",
1302 "tbi", or "rtbi". This property is only really needed if the connection
1303 is of type "rgmii-id", as all other connection types are detected by
1311 device_type = "network";
1313 compatible = "gianfar";
1315 mac-address = [ 00 E0 0C 00 73 00 ];
1316 interrupts = <d 3 e 3 12 3>;
1317 interrupt-parent = <40000>;
1318 phy-handle = <2452000>
1325 Required properties:
1327 - device_type : Should be "ethernet-phy"
1328 - interrupts : <a b> where a is the interrupt number and b is a
1329 field that represents an encoding of the sense and level
1330 information for the interrupt. This should be encoded based on
1331 the information in section 2) depending on the type of interrupt
1332 controller you have.
1333 - interrupt-parent : the phandle for the interrupt controller that
1334 services interrupts for this device.
1335 - reg : The ID number for the phy, usually a small integer
1336 - linux,phandle : phandle for this node; likely referenced by an
1337 ethernet controller node.
1343 linux,phandle = <2452000>
1344 interrupt-parent = <40000>;
1345 interrupts = <35 1>;
1347 device_type = "ethernet-phy";
1351 d) Interrupt controllers
1353 Some SOC devices contain interrupt controllers that are different
1354 from the standard Open PIC specification. The SOC device nodes for
1355 these types of controllers should be specified just like a standard
1356 OpenPIC controller. Sense and level information should be encoded
1357 as specified in section 2) of this chapter for each device that
1358 specifies an interrupt.
1363 linux,phandle = <40000>;
1364 clock-frequency = <0>;
1365 interrupt-controller;
1366 #address-cells = <0>;
1367 reg = <40000 40000>;
1369 compatible = "chrp,open-pic";
1370 device_type = "open-pic";
1377 Required properties :
1379 - device_type : Should be "i2c"
1380 - reg : Offset and length of the register set for the device
1382 Recommended properties :
1384 - compatible : Should be "fsl-i2c" for parts compatible with
1385 Freescale I2C specifications.
1386 - interrupts : <a b> where a is the interrupt number and b is a
1387 field that represents an encoding of the sense and level
1388 information for the interrupt. This should be encoded based on
1389 the information in section 2) depending on the type of interrupt
1390 controller you have.
1391 - interrupt-parent : the phandle for the interrupt controller that
1392 services interrupts for this device.
1393 - dfsrr : boolean; if defined, indicates that this I2C device has
1394 a digital filter sampling rate register
1395 - fsl5200-clocking : boolean; if defined, indicated that this device
1396 uses the FSL 5200 clocking mechanism.
1401 interrupt-parent = <40000>;
1402 interrupts = <1b 3>;
1404 device_type = "i2c";
1405 compatible = "fsl-i2c";
1410 f) Freescale SOC USB controllers
1412 The device node for a USB controller that is part of a Freescale
1413 SOC is as described in the document "Open Firmware Recommended
1414 Practice : Universal Serial Bus" with the following modifications
1417 Required properties :
1418 - compatible : Should be "fsl-usb2-mph" for multi port host USB
1419 controllers, or "fsl-usb2-dr" for dual role USB controllers
1420 - phy_type : For multi port host USB controllers, should be one of
1421 "ulpi", or "serial". For dual role USB controllers, should be
1422 one of "ulpi", "utmi", "utmi_wide", or "serial".
1423 - reg : Offset and length of the register set for the device
1424 - port0 : boolean; if defined, indicates port0 is connected for
1425 fsl-usb2-mph compatible controllers. Either this property or
1426 "port1" (or both) must be defined for "fsl-usb2-mph" compatible
1428 - port1 : boolean; if defined, indicates port1 is connected for
1429 fsl-usb2-mph compatible controllers. Either this property or
1430 "port0" (or both) must be defined for "fsl-usb2-mph" compatible
1432 - dr_mode : indicates the working mode for "fsl-usb2-dr" compatible
1433 controllers. Can be "host", "peripheral", or "otg". Default to
1434 "host" if not defined for backward compatibility.
1436 Recommended properties :
1437 - interrupts : <a b> where a is the interrupt number and b is a
1438 field that represents an encoding of the sense and level
1439 information for the interrupt. This should be encoded based on
1440 the information in section 2) depending on the type of interrupt
1441 controller you have.
1442 - interrupt-parent : the phandle for the interrupt controller that
1443 services interrupts for this device.
1445 Example multi port host USB controller device node :
1447 compatible = "fsl-usb2-mph";
1449 #address-cells = <1>;
1451 interrupt-parent = <700>;
1452 interrupts = <27 1>;
1458 Example dual role USB controller device node :
1460 compatible = "fsl-usb2-dr";
1462 #address-cells = <1>;
1464 interrupt-parent = <700>;
1465 interrupts = <26 1>;
1471 g) Freescale SOC SEC Security Engines
1473 Required properties:
1475 - device_type : Should be "crypto"
1476 - model : Model of the device. Should be "SEC1" or "SEC2"
1477 - compatible : Should be "talitos"
1478 - reg : Offset and length of the register set for the device
1479 - interrupts : <a b> where a is the interrupt number and b is a
1480 field that represents an encoding of the sense and level
1481 information for the interrupt. This should be encoded based on
1482 the information in section 2) depending on the type of interrupt
1483 controller you have.
1484 - interrupt-parent : the phandle for the interrupt controller that
1485 services interrupts for this device.
1486 - num-channels : An integer representing the number of channels
1488 - channel-fifo-len : An integer representing the number of
1489 descriptor pointers each channel fetch fifo can hold.
1490 - exec-units-mask : The bitmask representing what execution units
1491 (EUs) are available. It's a single 32-bit cell. EU information
1492 should be encoded following the SEC's Descriptor Header Dword
1493 EU_SEL0 field documentation, i.e. as follows:
1495 bit 0 = reserved - should be 0
1496 bit 1 = set if SEC has the ARC4 EU (AFEU)
1497 bit 2 = set if SEC has the DES/3DES EU (DEU)
1498 bit 3 = set if SEC has the message digest EU (MDEU)
1499 bit 4 = set if SEC has the random number generator EU (RNG)
1500 bit 5 = set if SEC has the public key EU (PKEU)
1501 bit 6 = set if SEC has the AES EU (AESU)
1502 bit 7 = set if SEC has the Kasumi EU (KEU)
1504 bits 8 through 31 are reserved for future SEC EUs.
1506 - descriptor-types-mask : The bitmask representing what descriptors
1507 are available. It's a single 32-bit cell. Descriptor type
1508 information should be encoded following the SEC's Descriptor
1509 Header Dword DESC_TYPE field documentation, i.e. as follows:
1511 bit 0 = set if SEC supports the aesu_ctr_nonsnoop desc. type
1512 bit 1 = set if SEC supports the ipsec_esp descriptor type
1513 bit 2 = set if SEC supports the common_nonsnoop desc. type
1514 bit 3 = set if SEC supports the 802.11i AES ccmp desc. type
1515 bit 4 = set if SEC supports the hmac_snoop_no_afeu desc. type
1516 bit 5 = set if SEC supports the srtp descriptor type
1517 bit 6 = set if SEC supports the non_hmac_snoop_no_afeu desc.type
1518 bit 7 = set if SEC supports the pkeu_assemble descriptor type
1519 bit 8 = set if SEC supports the aesu_key_expand_output desc.type
1520 bit 9 = set if SEC supports the pkeu_ptmul descriptor type
1521 bit 10 = set if SEC supports the common_nonsnoop_afeu desc. type
1522 bit 11 = set if SEC supports the pkeu_ptadd_dbl descriptor type
1524 ..and so on and so forth.
1530 device_type = "crypto";
1532 compatible = "talitos";
1533 reg = <30000 10000>;
1534 interrupts = <1d 3>;
1535 interrupt-parent = <40000>;
1537 channel-fifo-len = <18>;
1538 exec-units-mask = <000000fe>;
1539 descriptor-types-mask = <012b0ebf>;
1542 h) Board Control and Status (BCSR)
1544 Required properties:
1546 - device_type : Should be "board-control"
1547 - reg : Offset and length of the register set for the device
1552 device_type = "board-control";
1553 reg = <f8000000 8000>;
1556 i) Freescale QUICC Engine module (QE)
1557 This represents qe module that is installed on PowerQUICC II Pro.
1559 NOTE: This is an interim binding; it should be updated to fit
1560 in with the CPM binding later in this document.
1562 Basically, it is a bus of devices, that could act more or less
1563 as a complete entity (UCC, USB etc ). All of them should be siblings on
1564 the "root" qe node, using the common properties from there.
1565 The description below applies to the qe of MPC8360 and
1566 more nodes and properties would be extended in the future.
1570 Required properties:
1571 - compatible : should be "fsl,qe";
1572 - model : precise model of the QE, Can be "QE", "CPM", or "CPM2"
1573 - reg : offset and length of the device registers.
1574 - bus-frequency : the clock frequency for QUICC Engine.
1576 Recommended properties
1577 - brg-frequency : the internal clock source frequency for baud-rate
1582 #address-cells = <1>;
1584 #interrupt-cells = <2>;
1585 compatible = "fsl,qe";
1586 ranges = <0 e0100000 00100000>;
1587 reg = <e0100000 480>;
1588 brg-frequency = <0>;
1589 bus-frequency = <179A7B00>;
1593 ii) SPI (Serial Peripheral Interface)
1595 Required properties:
1596 - cell-index : SPI controller index.
1597 - compatible : should be "fsl,spi".
1598 - mode : the SPI operation mode, it can be "cpu" or "cpu-qe".
1599 - reg : Offset and length of the register set for the device
1600 - interrupts : <a b> where a is the interrupt number and b is a
1601 field that represents an encoding of the sense and level
1602 information for the interrupt. This should be encoded based on
1603 the information in section 2) depending on the type of interrupt
1604 controller you have.
1605 - interrupt-parent : the phandle for the interrupt controller that
1606 services interrupts for this device.
1611 compatible = "fsl,spi";
1613 interrupts = <82 0>;
1614 interrupt-parent = <700>;
1619 iii) USB (Universal Serial Bus Controller)
1621 Required properties:
1622 - compatible : could be "qe_udc" or "fhci-hcd".
1623 - mode : the could be "host" or "slave".
1624 - reg : Offset and length of the register set for the device
1625 - interrupts : <a b> where a is the interrupt number and b is a
1626 field that represents an encoding of the sense and level
1627 information for the interrupt. This should be encoded based on
1628 the information in section 2) depending on the type of interrupt
1629 controller you have.
1630 - interrupt-parent : the phandle for the interrupt controller that
1631 services interrupts for this device.
1635 compatible = "qe_udc";
1637 interrupts = <8b 0>;
1638 interrupt-parent = <700>;
1643 iv) UCC (Unified Communications Controllers)
1645 Required properties:
1646 - device_type : should be "network", "hldc", "uart", "transparent"
1647 "bisync", "atm", or "serial".
1648 - compatible : could be "ucc_geth" or "fsl_atm" and so on.
1649 - cell-index : the ucc number(1-8), corresponding to UCCx in UM.
1650 - reg : Offset and length of the register set for the device
1651 - interrupts : <a b> where a is the interrupt number and b is a
1652 field that represents an encoding of the sense and level
1653 information for the interrupt. This should be encoded based on
1654 the information in section 2) depending on the type of interrupt
1655 controller you have.
1656 - interrupt-parent : the phandle for the interrupt controller that
1657 services interrupts for this device.
1658 - pio-handle : The phandle for the Parallel I/O port configuration.
1659 - port-number : for UART drivers, the port number to use, between 0 and 3.
1660 This usually corresponds to the /dev/ttyQE device, e.g. <0> = /dev/ttyQE0.
1661 The port number is added to the minor number of the device. Unlike the
1662 CPM UART driver, the port-number is required for the QE UART driver.
1663 - soft-uart : for UART drivers, if specified this means the QE UART device
1664 driver should use "Soft-UART" mode, which is needed on some SOCs that have
1665 broken UART hardware. Soft-UART is provided via a microcode upload.
1666 - rx-clock-name: the UCC receive clock source
1667 "none": clock source is disabled
1668 "brg1" through "brg16": clock source is BRG1-BRG16, respectively
1669 "clk1" through "clk24": clock source is CLK1-CLK24, respectively
1670 - tx-clock-name: the UCC transmit clock source
1671 "none": clock source is disabled
1672 "brg1" through "brg16": clock source is BRG1-BRG16, respectively
1673 "clk1" through "clk24": clock source is CLK1-CLK24, respectively
1674 The following two properties are deprecated. rx-clock has been replaced
1675 with rx-clock-name, and tx-clock has been replaced with tx-clock-name.
1676 Drivers that currently use the deprecated properties should continue to
1677 do so, in order to support older device trees, but they should be updated
1678 to check for the new properties first.
1679 - rx-clock : represents the UCC receive clock source.
1680 0x00 : clock source is disabled;
1681 0x1~0x10 : clock source is BRG1~BRG16 respectively;
1682 0x11~0x28: clock source is QE_CLK1~QE_CLK24 respectively.
1683 - tx-clock: represents the UCC transmit clock source;
1684 0x00 : clock source is disabled;
1685 0x1~0x10 : clock source is BRG1~BRG16 respectively;
1686 0x11~0x28: clock source is QE_CLK1~QE_CLK24 respectively.
1688 Required properties for network device_type:
1689 - mac-address : list of bytes representing the ethernet address.
1690 - phy-handle : The phandle for the PHY connected to this controller.
1692 Recommended properties:
1693 - phy-connection-type : a string naming the controller/PHY interface type,
1694 i.e., "mii" (default), "rmii", "gmii", "rgmii", "rgmii-id" (Internal
1695 Delay), "rgmii-txid" (delay on TX only), "rgmii-rxid" (delay on RX only),
1700 device_type = "network";
1701 compatible = "ucc_geth";
1704 interrupts = <a0 0>;
1705 interrupt-parent = <700>;
1706 mac-address = [ 00 04 9f 00 23 23 ];
1709 phy-handle = <212000>;
1710 phy-connection-type = "gmii";
1711 pio-handle = <140001>;
1715 v) Parallel I/O Ports
1717 This node configures Parallel I/O ports for CPUs with QE support.
1718 The node should reside in the "soc" node of the tree. For each
1719 device that using parallel I/O ports, a child node should be created.
1720 See the definition of the Pin configuration nodes below for more
1723 Required properties:
1724 - device_type : should be "par_io".
1725 - reg : offset to the register set and its length.
1726 - num-ports : number of Parallel I/O ports
1731 #address-cells = <1>;
1733 device_type = "par_io";
1740 vi) Pin configuration nodes
1742 Required properties:
1743 - linux,phandle : phandle of this node; likely referenced by a QE
1745 - pio-map : array of pin configurations. Each pin is defined by 6
1746 integers. The six numbers are respectively: port, pin, dir,
1747 open_drain, assignment, has_irq.
1748 - port : port number of the pin; 0-6 represent port A-G in UM.
1749 - pin : pin number in the port.
1750 - dir : direction of the pin, should encode as follows:
1752 0 = The pin is disabled
1753 1 = The pin is an output
1754 2 = The pin is an input
1757 - open_drain : indicates the pin is normal or wired-OR:
1759 0 = The pin is actively driven as an output
1760 1 = The pin is an open-drain driver. As an output, the pin is
1761 driven active-low, otherwise it is three-stated.
1763 - assignment : function number of the pin according to the Pin Assignment
1764 tables in User Manual. Each pin can have up to 4 possible functions in
1765 QE and two options for CPM.
1766 - has_irq : indicates if the pin is used as source of external
1771 linux,phandle = <140001>;
1773 /* port pin dir open_drain assignment has_irq */
1774 0 3 1 0 1 0 /* TxD0 */
1775 0 4 1 0 1 0 /* TxD1 */
1776 0 5 1 0 1 0 /* TxD2 */
1777 0 6 1 0 1 0 /* TxD3 */
1778 1 6 1 0 3 0 /* TxD4 */
1779 1 7 1 0 1 0 /* TxD5 */
1780 1 9 1 0 2 0 /* TxD6 */
1781 1 a 1 0 2 0 /* TxD7 */
1782 0 9 2 0 1 0 /* RxD0 */
1783 0 a 2 0 1 0 /* RxD1 */
1784 0 b 2 0 1 0 /* RxD2 */
1785 0 c 2 0 1 0 /* RxD3 */
1786 0 d 2 0 1 0 /* RxD4 */
1787 1 1 2 0 2 0 /* RxD5 */
1788 1 0 2 0 2 0 /* RxD6 */
1789 1 4 2 0 2 0 /* RxD7 */
1790 0 7 1 0 1 0 /* TX_EN */
1791 0 8 1 0 1 0 /* TX_ER */
1792 0 f 2 0 1 0 /* RX_DV */
1793 0 10 2 0 1 0 /* RX_ER */
1794 0 0 2 0 1 0 /* RX_CLK */
1795 2 9 1 0 3 0 /* GTX_CLK - CLK10 */
1796 2 8 2 0 1 0>; /* GTX125 - CLK9 */
1799 vii) Multi-User RAM (MURAM)
1801 Required properties:
1802 - compatible : should be "fsl,qe-muram", "fsl,cpm-muram".
1803 - mode : the could be "host" or "slave".
1804 - ranges : Should be defined as specified in 1) to describe the
1805 translation of MURAM addresses.
1806 - data-only : sub-node which defines the address area under MURAM
1807 bus that can be allocated as data/parameter
1812 compatible = "fsl,qe-muram", "fsl,cpm-muram";
1813 ranges = <0 00010000 0000c000>;
1816 compatible = "fsl,qe-muram-data",
1817 "fsl,cpm-muram-data";
1822 viii) Uploaded QE firmware
1824 If a new firwmare has been uploaded to the QE (usually by the
1825 boot loader), then a 'firmware' child node should be added to the QE
1826 node. This node provides information on the uploaded firmware that
1827 device drivers may need.
1829 Required properties:
1830 - id: The string name of the firmware. This is taken from the 'id'
1831 member of the qe_firmware structure of the uploaded firmware.
1832 Device drivers can search this string to determine if the
1833 firmware they want is already present.
1834 - extended-modes: The Extended Modes bitfield, taken from the
1835 firmware binary. It is a 64-bit number represented
1836 as an array of two 32-bit numbers.
1837 - virtual-traps: The virtual traps, taken from the firmware binary.
1838 It is an array of 8 32-bit numbers.
1844 extended-modes = <0 0>;
1845 virtual-traps = <0 0 0 0 0 0 0 0>;
1848 j) CFI or JEDEC memory-mapped NOR flash
1850 Flash chips (Memory Technology Devices) are often used for solid state
1851 file systems on embedded devices.
1853 - compatible : should contain the specific model of flash chip(s)
1854 used, if known, followed by either "cfi-flash" or "jedec-flash"
1855 - reg : Address range of the flash chip
1856 - bank-width : Width (in bytes) of the flash bank. Equal to the
1857 device width times the number of interleaved chips.
1858 - device-width : (optional) Width of a single flash chip. If
1859 omitted, assumed to be equal to 'bank-width'.
1860 - #address-cells, #size-cells : Must be present if the flash has
1861 sub-nodes representing partitions (see below). In this case
1862 both #address-cells and #size-cells must be equal to 1.
1864 For JEDEC compatible devices, the following additional properties
1867 - vendor-id : Contains the flash chip's vendor id (1 byte).
1868 - device-id : Contains the flash chip's device id (1 byte).
1870 In addition to the information on the flash bank itself, the
1871 device tree may optionally contain additional information
1872 describing partitions of the flash address space. This can be
1873 used on platforms which have strong conventions about which
1874 portions of the flash are used for what purposes, but which don't
1875 use an on-flash partition table such as RedBoot.
1877 Each partition is represented as a sub-node of the flash device.
1878 Each node's name represents the name of the corresponding
1879 partition of the flash device.
1882 - reg : The partition's offset and size within the flash bank.
1883 - label : (optional) The label / name for this flash partition.
1884 If omitted, the label is taken from the node name (excluding
1886 - read-only : (optional) This parameter, if present, is a hint to
1887 Linux that this flash partition should only be mounted
1888 read-only. This is usually used for flash partitions
1889 containing early-boot firmware images or data which should not
1895 compatible = "amd,am29lv128ml", "cfi-flash";
1896 reg = <ff000000 01000000>;
1899 #address-cells = <1>;
1907 reg = <f80000 80000>;
1912 k) Global Utilities Block
1914 The global utilities block controls power management, I/O device
1915 enabling, power-on-reset configuration monitoring, general-purpose
1916 I/O signal configuration, alternate function selection for multiplexed
1917 signals, and clock control.
1919 Required properties:
1921 - compatible : Should define the compatible device type for
1923 - reg : Offset and length of the register set for the device.
1925 Recommended properties:
1927 - fsl,has-rstcr : Indicates that the global utilities register set
1928 contains a functioning "reset control register" (i.e. the board
1929 is wired to reset upon setting the HRESET_REQ bit in this register).
1933 global-utilities@e0000 { /* global utilities block */
1934 compatible = "fsl,mpc8548-guts";
1939 l) Freescale Communications Processor Module
1941 NOTE: This is an interim binding, and will likely change slightly,
1942 as more devices are supported. The QE bindings especially are
1948 - compatible : "fsl,cpm1", "fsl,cpm2", or "fsl,qe".
1949 - reg : A 48-byte region beginning with CPCR.
1953 #address-cells = <1>;
1955 #interrupt-cells = <2>;
1956 compatible = "fsl,mpc8272-cpm", "fsl,cpm2";
1960 ii) Properties common to mulitple CPM/QE devices
1962 - fsl,cpm-command : This value is ORed with the opcode and command flag
1963 to specify the device on which a CPM command operates.
1965 - fsl,cpm-brg : Indicates which baud rate generator the device
1966 is associated with. If absent, an unused BRG
1967 should be dynamically allocated. If zero, the
1968 device uses an external clock rather than a BRG.
1970 - reg : Unless otherwise specified, the first resource represents the
1971 scc/fcc/ucc registers, and the second represents the device's
1972 parameter RAM region (if it has one).
1976 Currently defined compatibles:
1986 device_type = "serial";
1987 compatible = "fsl,mpc8272-scc-uart",
1988 "fsl,cpm2-scc-uart";
1989 reg = <11a00 20 8000 100>;
1990 interrupts = <28 8>;
1991 interrupt-parent = <&PIC>;
1993 fsl,cpm-command = <00800000>;
1998 Currently defined compatibles:
2002 - fsl,cpm2-fcc-enet (third resource is GFEMR)
2008 device_type = "network";
2009 compatible = "fsl,mpc8272-fcc-enet",
2010 "fsl,cpm2-fcc-enet";
2011 reg = <11300 20 8400 100 11390 1>;
2012 local-mac-address = [ 00 00 00 00 00 00 ];
2013 interrupts = <20 8>;
2014 interrupt-parent = <&PIC>;
2015 phy-handle = <&PHY0>;
2016 fsl,cpm-command = <12000300>;
2021 Currently defined compatibles:
2022 fsl,pq1-fec-mdio (reg is same as first resource of FEC device)
2023 fsl,cpm2-mdio-bitbang (reg is port C registers)
2025 Properties for fsl,cpm2-mdio-bitbang:
2026 fsl,mdio-pin : pin of port C controlling mdio data
2027 fsl,mdc-pin : pin of port C controlling mdio clock
2032 device_type = "mdio";
2033 compatible = "fsl,mpc8272ads-mdio-bitbang",
2034 "fsl,mpc8272-mdio-bitbang",
2035 "fsl,cpm2-mdio-bitbang";
2037 #address-cells = <1>;
2039 fsl,mdio-pin = <12>;
2043 v) Baud Rate Generators
2045 Currently defined compatibles:
2051 - reg : There may be an arbitrary number of reg resources; BRG
2052 numbers are assigned to these in order.
2053 - clock-frequency : Specifies the base frequency driving
2059 compatible = "fsl,mpc8272-brg",
2062 reg = <119f0 10 115f0 10>;
2063 clock-frequency = <d#25000000>;
2066 vi) Interrupt Controllers
2068 Currently defined compatibles:
2070 - only one interrupt cell
2073 - second interrupt cell is level/sense:
2079 interrupt-controller@10c00 {
2080 #interrupt-cells = <2>;
2081 interrupt-controller;
2083 compatible = "mpc8272-pic", "fsl,cpm2-pic";
2086 vii) USB (Universal Serial Bus Controller)
2089 - compatible : "fsl,cpm1-usb", "fsl,cpm2-usb", "fsl,qe-usb"
2093 #address-cells = <1>;
2095 compatible = "fsl,cpm2-usb";
2096 reg = <11b60 18 8b00 100>;
2098 interrupt-parent = <&PIC>;
2099 fsl,cpm-command = <2e600000>;
2102 viii) Multi-User RAM (MURAM)
2104 The multi-user/dual-ported RAM is expressed as a bus under the CPM node.
2106 Ranges must be set up subject to the following restrictions:
2108 - Children's reg nodes must be offsets from the start of all muram, even
2109 if the user-data area does not begin at zero.
2110 - If multiple range entries are used, the difference between the parent
2111 address and the child address must be the same in all, so that a single
2112 mapping can cover them all while maintaining the ability to determine
2113 CPM-side offsets with pointer subtraction. It is recommended that
2114 multiple range entries not be used.
2115 - A child address of zero must be translatable, even if no reg resources
2118 A child "data" node must exist, compatible with "fsl,cpm-muram-data", to
2119 indicate the portion of muram that is usable by the OS for arbitrary
2120 purposes. The data node may have an arbitrary number of reg resources,
2121 all of which contribute to the allocatable muram pool.
2123 Example, based on mpc8272:
2126 #address-cells = <1>;
2128 ranges = <0 0 10000>;
2131 compatible = "fsl,cpm-muram-data";
2132 reg = <0 2000 9800 800>;
2136 m) Chipselect/Local Bus
2139 - name : Should be localbus
2140 - #address-cells : Should be either two or three. The first cell is the
2141 chipselect number, and the remaining cells are the
2142 offset into the chipselect.
2143 - #size-cells : Either one or two, depending on how large each chipselect
2145 - ranges : Each range corresponds to a single chipselect, and cover
2146 the entire access window as configured.
2150 compatible = "fsl,mpc8272-localbus",
2152 #address-cells = <2>;
2154 reg = <f0010100 40>;
2156 ranges = <0 0 fe000000 02000000
2157 1 0 f4500000 00008000>;
2160 compatible = "jedec-flash";
2161 reg = <0 0 2000000>;
2168 compatible = "fsl,mpc8272ads-bcsr";
2173 n) 4xx/Axon EMAC ethernet nodes
2175 The EMAC ethernet controller in IBM and AMCC 4xx chips, and also
2176 the Axon bridge. To operate this needs to interact with a ths
2177 special McMAL DMA controller, and sometimes an RGMII or ZMII
2178 interface. In addition to the nodes and properties described
2179 below, the node for the OPB bus on which the EMAC sits must have a
2180 correct clock-frequency property.
2182 i) The EMAC node itself
2184 Required properties:
2185 - device_type : "network"
2187 - compatible : compatible list, contains 2 entries, first is
2188 "ibm,emac-CHIP" where CHIP is the host ASIC (440gx,
2189 405gp, Axon) and second is either "ibm,emac" or
2190 "ibm,emac4". For Axon, thus, we have: "ibm,emac-axon",
2192 - interrupts : <interrupt mapping for EMAC IRQ and WOL IRQ>
2193 - interrupt-parent : optional, if needed for interrupt mapping
2194 - reg : <registers mapping>
2195 - local-mac-address : 6 bytes, MAC address
2196 - mal-device : phandle of the associated McMAL node
2197 - mal-tx-channel : 1 cell, index of the tx channel on McMAL associated
2199 - mal-rx-channel : 1 cell, index of the rx channel on McMAL associated
2201 - cell-index : 1 cell, hardware index of the EMAC cell on a given
2202 ASIC (typically 0x0 and 0x1 for EMAC0 and EMAC1 on
2204 - max-frame-size : 1 cell, maximum frame size supported in bytes
2205 - rx-fifo-size : 1 cell, Rx fifo size in bytes for 10 and 100 Mb/sec
2208 - tx-fifo-size : 1 cell, Tx fifo size in bytes for 10 and 100 Mb/sec
2211 - fifo-entry-size : 1 cell, size of a fifo entry (used to calculate
2213 For Axon, 0x00000010
2214 - mal-burst-size : 1 cell, MAL burst size (used to calculate thresholds)
2216 For Axon, 0x00000100 (I think ...)
2217 - phy-mode : string, mode of operations of the PHY interface.
2218 Supported values are: "mii", "rmii", "smii", "rgmii",
2219 "tbi", "gmii", rtbi", "sgmii".
2220 For Axon on CAB, it is "rgmii"
2221 - mdio-device : 1 cell, required iff using shared MDIO registers
2222 (440EP). phandle of the EMAC to use to drive the
2223 MDIO lines for the PHY used by this EMAC.
2224 - zmii-device : 1 cell, required iff connected to a ZMII. phandle of
2225 the ZMII device node
2226 - zmii-channel : 1 cell, required iff connected to a ZMII. Which ZMII
2227 channel or 0xffffffff if ZMII is only used for MDIO.
2228 - rgmii-device : 1 cell, required iff connected to an RGMII. phandle
2229 of the RGMII device node.
2230 For Axon: phandle of plb5/plb4/opb/rgmii
2231 - rgmii-channel : 1 cell, required iff connected to an RGMII. Which
2232 RGMII channel is used by this EMAC.
2233 Fox Axon: present, whatever value is appropriate for each
2234 EMAC, that is the content of the current (bogus) "phy-port"
2237 Optional properties:
2238 - phy-address : 1 cell, optional, MDIO address of the PHY. If absent,
2239 a search is performed.
2240 - phy-map : 1 cell, optional, bitmap of addresses to probe the PHY
2241 for, used if phy-address is absent. bit 0x00000001 is
2243 For Axon it can be absent, thouugh my current driver
2244 doesn't handle phy-address yet so for now, keep
2246 - rx-fifo-size-gige : 1 cell, Rx fifo size in bytes for 1000 Mb/sec
2247 operations (if absent the value is the same as
2248 rx-fifo-size). For Axon, either absent or 2048.
2249 - tx-fifo-size-gige : 1 cell, Tx fifo size in bytes for 1000 Mb/sec
2250 operations (if absent the value is the same as
2251 tx-fifo-size). For Axon, either absent or 2048.
2252 - tah-device : 1 cell, optional. If connected to a TAH engine for
2253 offload, phandle of the TAH device node.
2254 - tah-channel : 1 cell, optional. If appropriate, channel used on the
2259 EMAC0: ethernet@40000800 {
2260 device_type = "network";
2261 compatible = "ibm,emac-440gp", "ibm,emac";
2262 interrupt-parent = <&UIC1>;
2263 interrupts = <1c 4 1d 4>;
2264 reg = <40000800 70>;
2265 local-mac-address = [00 04 AC E3 1B 1E];
2266 mal-device = <&MAL0>;
2267 mal-tx-channel = <0 1>;
2268 mal-rx-channel = <0>;
2270 max-frame-size = <5dc>;
2271 rx-fifo-size = <1000>;
2272 tx-fifo-size = <800>;
2274 phy-map = <00000001>;
2275 zmii-device = <&ZMII0>;
2281 Required properties:
2282 - device_type : "dma-controller"
2283 - compatible : compatible list, containing 2 entries, first is
2284 "ibm,mcmal-CHIP" where CHIP is the host ASIC (like
2285 emac) and the second is either "ibm,mcmal" or
2287 For Axon, "ibm,mcmal-axon","ibm,mcmal2"
2288 - interrupts : <interrupt mapping for the MAL interrupts sources:
2289 5 sources: tx_eob, rx_eob, serr, txde, rxde>.
2290 For Axon: This is _different_ from the current
2291 firmware. We use the "delayed" interrupts for txeob
2292 and rxeob. Thus we end up with mapping those 5 MPIC
2293 interrupts, all level positive sensitive: 10, 11, 32,
2295 - dcr-reg : < DCR registers range >
2296 - dcr-parent : if needed for dcr-reg
2297 - num-tx-chans : 1 cell, number of Tx channels
2298 - num-rx-chans : 1 cell, number of Rx channels
2302 Required properties:
2303 - compatible : compatible list, containing 2 entries, first is
2304 "ibm,zmii-CHIP" where CHIP is the host ASIC (like
2305 EMAC) and the second is "ibm,zmii".
2306 For Axon, there is no ZMII node.
2307 - reg : <registers mapping>
2311 Required properties:
2312 - compatible : compatible list, containing 2 entries, first is
2313 "ibm,rgmii-CHIP" where CHIP is the host ASIC (like
2314 EMAC) and the second is "ibm,rgmii".
2315 For Axon, "ibm,rgmii-axon","ibm,rgmii"
2316 - reg : <registers mapping>
2317 - revision : as provided by the RGMII new version register if
2319 For Axon: 0x0000012a
2323 The Xilinx EDK toolchain ships with a set of IP cores (devices) for use
2324 in Xilinx Spartan and Virtex FPGAs. The devices cover the whole range
2325 of standard device types (network, serial, etc.) and miscellanious
2326 devices (gpio, LCD, spi, etc). Also, since these devices are
2327 implemented within the fpga fabric every instance of the device can be
2328 synthesised with different options that change the behaviour.
2330 Each IP-core has a set of parameters which the FPGA designer can use to
2331 control how the core is synthesized. Historically, the EDK tool would
2332 extract the device parameters relevant to device drivers and copy them
2333 into an 'xparameters.h' in the form of #define symbols. This tells the
2334 device drivers how the IP cores are configured, but it requres the kernel
2335 to be recompiled every time the FPGA bitstream is resynthesized.
2337 The new approach is to export the parameters into the device tree and
2338 generate a new device tree each time the FPGA bitstream changes. The
2339 parameters which used to be exported as #defines will now become
2340 properties of the device node. In general, device nodes for IP-cores
2341 will take the following form:
2343 (name): (generic-name)@(base-address) {
2344 compatible = "xlnx,(ip-core-name)-(HW_VER)"
2345 [, (list of compatible devices), ...];
2346 reg = <(baseaddr) (size)>;
2347 interrupt-parent = <&interrupt-controller-phandle>;
2348 interrupts = < ... >;
2349 xlnx,(parameter1) = "(string-value)";
2350 xlnx,(parameter2) = <(int-value)>;
2353 (generic-name): an open firmware-style name that describes the
2354 generic class of device. Preferably, this is one word, such
2355 as 'serial' or 'ethernet'.
2356 (ip-core-name): the name of the ip block (given after the BEGIN
2357 directive in system.mhs). Should be in lowercase
2358 and all underscores '_' converted to dashes '-'.
2359 (name): is derived from the "PARAMETER INSTANCE" value.
2360 (parameter#): C_* parameters from system.mhs. The C_ prefix is
2361 dropped from the parameter name, the name is converted
2362 to lowercase and all underscore '_' characters are
2363 converted to dashes '-'.
2364 (baseaddr): the baseaddr parameter value (often named C_BASEADDR).
2365 (HW_VER): from the HW_VER parameter.
2366 (size): the address range size (often C_HIGHADDR - C_BASEADDR + 1).
2368 Typically, the compatible list will include the exact IP core version
2369 followed by an older IP core version which implements the same
2370 interface or any other device with the same interface.
2372 'reg', 'interrupt-parent' and 'interrupts' are all optional properties.
2374 For example, the following block from system.mhs:
2377 PARAMETER INSTANCE = opb_uartlite_0
2378 PARAMETER HW_VER = 1.00.b
2379 PARAMETER C_BAUDRATE = 115200
2380 PARAMETER C_DATA_BITS = 8
2381 PARAMETER C_ODD_PARITY = 0
2382 PARAMETER C_USE_PARITY = 0
2383 PARAMETER C_CLK_FREQ = 50000000
2384 PARAMETER C_BASEADDR = 0xEC100000
2385 PARAMETER C_HIGHADDR = 0xEC10FFFF
2386 BUS_INTERFACE SOPB = opb_7
2387 PORT OPB_Clk = CLK_50MHz
2388 PORT Interrupt = opb_uartlite_0_Interrupt
2389 PORT RX = opb_uartlite_0_RX
2390 PORT TX = opb_uartlite_0_TX
2391 PORT OPB_Rst = sys_bus_reset_0
2394 becomes the following device tree node:
2396 opb_uartlite_0: serial@ec100000 {
2397 device_type = "serial";
2398 compatible = "xlnx,opb-uartlite-1.00.b";
2399 reg = <ec100000 10000>;
2400 interrupt-parent = <&opb_intc_0>;
2401 interrupts = <1 0>; // got this from the opb_intc parameters
2402 current-speed = <d#115200>; // standard serial device prop
2403 clock-frequency = <d#50000000>; // standard serial device prop
2404 xlnx,data-bits = <8>;
2405 xlnx,odd-parity = <0>;
2406 xlnx,use-parity = <0>;
2409 Some IP cores actually implement 2 or more logical devices. In
2410 this case, the device should still describe the whole IP core with
2411 a single node and add a child node for each logical device. The
2412 ranges property can be used to translate from parent IP-core to the
2413 registers of each device. In addition, the parent node should be
2414 compatible with the bus type 'xlnx,compound', and should contain
2415 #address-cells and #size-cells, as with any other bus. (Note: this
2416 makes the assumption that both logical devices have the same bus
2417 binding. If this is not true, then separate nodes should be used
2418 for each logical device). The 'cell-index' property can be used to
2419 enumerate logical devices within an IP core. For example, the
2420 following is the system.mhs entry for the dual ps2 controller found
2421 on the ml403 reference design.
2423 BEGIN opb_ps2_dual_ref
2424 PARAMETER INSTANCE = opb_ps2_dual_ref_0
2425 PARAMETER HW_VER = 1.00.a
2426 PARAMETER C_BASEADDR = 0xA9000000
2427 PARAMETER C_HIGHADDR = 0xA9001FFF
2428 BUS_INTERFACE SOPB = opb_v20_0
2429 PORT Sys_Intr1 = ps2_1_intr
2430 PORT Sys_Intr2 = ps2_2_intr
2431 PORT Clkin1 = ps2_clk_rx_1
2432 PORT Clkin2 = ps2_clk_rx_2
2433 PORT Clkpd1 = ps2_clk_tx_1
2434 PORT Clkpd2 = ps2_clk_tx_2
2435 PORT Rx1 = ps2_d_rx_1
2436 PORT Rx2 = ps2_d_rx_2
2437 PORT Txpd1 = ps2_d_tx_1
2438 PORT Txpd2 = ps2_d_tx_2
2441 It would result in the following device tree nodes:
2443 opb_ps2_dual_ref_0: opb-ps2-dual-ref@a9000000 {
2444 #address-cells = <1>;
2446 compatible = "xlnx,compound";
2447 ranges = <0 a9000000 2000>;
2448 // If this device had extra parameters, then they would
2451 compatible = "xlnx,opb-ps2-dual-ref-1.00.a";
2453 interrupt-parent = <&opb_intc_0>;
2458 compatible = "xlnx,opb-ps2-dual-ref-1.00.a";
2460 interrupt-parent = <&opb_intc_0>;
2466 Also, the system.mhs file defines bus attachments from the processor
2467 to the devices. The device tree structure should reflect the bus
2468 attachments. Again an example; this system.mhs fragment:
2470 BEGIN ppc405_virtex4
2471 PARAMETER INSTANCE = ppc405_0
2472 PARAMETER HW_VER = 1.01.a
2473 BUS_INTERFACE DPLB = plb_v34_0
2474 BUS_INTERFACE IPLB = plb_v34_0
2478 PARAMETER INSTANCE = opb_intc_0
2479 PARAMETER HW_VER = 1.00.c
2480 PARAMETER C_BASEADDR = 0xD1000FC0
2481 PARAMETER C_HIGHADDR = 0xD1000FDF
2482 BUS_INTERFACE SOPB = opb_v20_0
2486 PARAMETER INSTANCE = opb_uart16550_0
2487 PARAMETER HW_VER = 1.00.d
2488 PARAMETER C_BASEADDR = 0xa0000000
2489 PARAMETER C_HIGHADDR = 0xa0001FFF
2490 BUS_INTERFACE SOPB = opb_v20_0
2494 PARAMETER INSTANCE = plb_v34_0
2495 PARAMETER HW_VER = 1.02.a
2498 BEGIN plb_bram_if_cntlr
2499 PARAMETER INSTANCE = plb_bram_if_cntlr_0
2500 PARAMETER HW_VER = 1.00.b
2501 PARAMETER C_BASEADDR = 0xFFFF0000
2502 PARAMETER C_HIGHADDR = 0xFFFFFFFF
2503 BUS_INTERFACE SPLB = plb_v34_0
2506 BEGIN plb2opb_bridge
2507 PARAMETER INSTANCE = plb2opb_bridge_0
2508 PARAMETER HW_VER = 1.01.a
2509 PARAMETER C_RNG0_BASEADDR = 0x20000000
2510 PARAMETER C_RNG0_HIGHADDR = 0x3FFFFFFF
2511 PARAMETER C_RNG1_BASEADDR = 0x60000000
2512 PARAMETER C_RNG1_HIGHADDR = 0x7FFFFFFF
2513 PARAMETER C_RNG2_BASEADDR = 0x80000000
2514 PARAMETER C_RNG2_HIGHADDR = 0xBFFFFFFF
2515 PARAMETER C_RNG3_BASEADDR = 0xC0000000
2516 PARAMETER C_RNG3_HIGHADDR = 0xDFFFFFFF
2517 BUS_INTERFACE SPLB = plb_v34_0
2518 BUS_INTERFACE MOPB = opb_v20_0
2521 Gives this device tree (some properties removed for clarity):
2524 #address-cells = <1>;
2526 compatible = "xlnx,plb-v34-1.02.a";
2527 device_type = "ibm,plb";
2528 ranges; // 1:1 translation
2530 plb_bram_if_cntrl_0: bram@ffff0000 {
2531 reg = <ffff0000 10000>;
2535 #address-cells = <1>;
2537 ranges = <20000000 20000000 20000000
2538 60000000 60000000 20000000
2539 80000000 80000000 40000000
2540 c0000000 c0000000 20000000>;
2542 opb_uart16550_0: serial@a0000000 {
2543 reg = <a00000000 2000>;
2546 opb_intc_0: interrupt-controller@d1000fc0 {
2547 reg = <d1000fc0 20>;
2552 That covers the general approach to binding xilinx IP cores into the
2553 device tree. The following are bindings for specific devices:
2555 i) Xilinx ML300 Framebuffer
2557 Simple framebuffer device from the ML300 reference design (also on the
2558 ML403 reference design as well as others).
2560 Optional properties:
2561 - resolution = <xres yres> : pixel resolution of framebuffer. Some
2562 implementations use a different resolution.
2563 Default is <d#640 d#480>
2564 - virt-resolution = <xvirt yvirt> : Size of framebuffer in memory.
2565 Default is <d#1024 d#480>.
2566 - rotate-display (empty) : rotate display 180 degrees.
2568 ii) Xilinx SystemACE
2570 The Xilinx SystemACE device is used to program FPGAs from an FPGA
2571 bitstream stored on a CF card. It can also be used as a generic CF
2574 Optional properties:
2575 - 8-bit (empty) : Set this property for SystemACE in 8 bit mode
2577 iii) Xilinx EMAC and Xilinx TEMAC
2579 Xilinx Ethernet devices. In addition to general xilinx properties
2580 listed above, nodes for these devices should include a phy-handle
2581 property, and may include other common network device properties
2582 like local-mac-address.
2586 Xilinx uartlite devices are simple fixed speed serial ports.
2589 - current-speed : Baud rate of uartlite
2593 Xilinx hwicap devices provide access to the configuration logic
2594 of the FPGA through the Internal Configuration Access Port
2595 (ICAP). The ICAP enables partial reconfiguration of the FPGA,
2596 readback of the configuration information, and some control over
2597 'warm boots' of the FPGA fabric.
2599 Required properties:
2600 - xlnx,family : The family of the FPGA, necessary since the
2601 capabilities of the underlying ICAP hardware
2602 differ between different families. May be
2603 'virtex2p', 'virtex4', or 'virtex5'.
2605 vi) Xilinx Uart 16550
2607 Xilinx UART 16550 devices are very similar to the NS16550 but with
2608 different register spacing and an offset from the base address.
2611 - clock-frequency : Frequency of the clock input
2612 - reg-offset : A value of 3 is required
2613 - reg-shift : A value of 2 is required
2616 p) Freescale Synchronous Serial Interface
2618 The SSI is a serial device that communicates with audio codecs. It can
2619 be programmed in AC97, I2S, left-justified, or right-justified modes.
2621 Required properties:
2622 - compatible : compatible list, containing "fsl,ssi"
2623 - cell-index : the SSI, <0> = SSI1, <1> = SSI2, and so on
2624 - reg : offset and length of the register set for the device
2625 - interrupts : <a b> where a is the interrupt number and b is a
2626 field that represents an encoding of the sense and
2627 level information for the interrupt. This should be
2628 encoded based on the information in section 2)
2629 depending on the type of interrupt controller you
2631 - interrupt-parent : the phandle for the interrupt controller that
2632 services interrupts for this device.
2633 - fsl,mode : the operating mode for the SSI interface
2634 "i2s-slave" - I2S mode, SSI is clock slave
2635 "i2s-master" - I2S mode, SSI is clock master
2636 "lj-slave" - left-justified mode, SSI is clock slave
2637 "lj-master" - l.j. mode, SSI is clock master
2638 "rj-slave" - right-justified mode, SSI is clock slave
2639 "rj-master" - r.j., SSI is clock master
2640 "ac97-slave" - AC97 mode, SSI is clock slave
2641 "ac97-master" - AC97 mode, SSI is clock master
2643 Optional properties:
2644 - codec-handle : phandle to a 'codec' node that defines an audio
2645 codec connected to this SSI. This node is typically
2646 a child of an I2C or other control node.
2648 Child 'codec' node required properties:
2649 - compatible : compatible list, contains the name of the codec
2651 Child 'codec' node optional properties:
2652 - clock-frequency : The frequency of the input clock, which typically
2653 comes from an on-board dedicated oscillator.
2655 * Freescale 83xx DMA Controller
2657 Freescale PowerPC 83xx have on chip general purpose DMA controllers.
2659 Required properties:
2661 - compatible : compatible list, contains 2 entries, first is
2662 "fsl,CHIP-dma", where CHIP is the processor
2663 (mpc8349, mpc8360, etc.) and the second is
2665 - reg : <registers mapping for DMA general status reg>
2666 - ranges : Should be defined as specified in 1) to describe the
2667 DMA controller channels.
2668 - cell-index : controller index. 0 for controller @ 0x8100
2669 - interrupts : <interrupt mapping for DMA IRQ>
2670 - interrupt-parent : optional, if needed for interrupt mapping
2673 - DMA channel nodes:
2674 - compatible : compatible list, contains 2 entries, first is
2675 "fsl,CHIP-dma-channel", where CHIP is the processor
2676 (mpc8349, mpc8350, etc.) and the second is
2677 "fsl,elo-dma-channel"
2678 - reg : <registers mapping for channel>
2679 - cell-index : dma channel index starts at 0.
2681 Optional properties:
2682 - interrupts : <interrupt mapping for DMA channel IRQ>
2683 (on 83xx this is expected to be identical to
2684 the interrupts property of the parent node)
2685 - interrupt-parent : optional, if needed for interrupt mapping
2689 #address-cells = <1>;
2691 compatible = "fsl,mpc8349-dma", "fsl,elo-dma";
2693 ranges = <0 8100 1a4>;
2694 interrupt-parent = <&ipic>;
2695 interrupts = <47 8>;
2698 compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
2703 compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
2708 compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
2713 compatible = "fsl,mpc8349-dma-channel", "fsl,elo-dma-channel";
2719 * Freescale 85xx/86xx DMA Controller
2721 Freescale PowerPC 85xx/86xx have on chip general purpose DMA controllers.
2723 Required properties:
2725 - compatible : compatible list, contains 2 entries, first is
2726 "fsl,CHIP-dma", where CHIP is the processor
2727 (mpc8540, mpc8540, etc.) and the second is
2729 - reg : <registers mapping for DMA general status reg>
2730 - cell-index : controller index. 0 for controller @ 0x21000,
2731 1 for controller @ 0xc000
2732 - ranges : Should be defined as specified in 1) to describe the
2733 DMA controller channels.
2735 - DMA channel nodes:
2736 - compatible : compatible list, contains 2 entries, first is
2737 "fsl,CHIP-dma-channel", where CHIP is the processor
2738 (mpc8540, mpc8560, etc.) and the second is
2739 "fsl,eloplus-dma-channel"
2740 - cell-index : dma channel index starts at 0.
2741 - reg : <registers mapping for channel>
2742 - interrupts : <interrupt mapping for DMA channel IRQ>
2743 - interrupt-parent : optional, if needed for interrupt mapping
2747 #address-cells = <1>;
2749 compatible = "fsl,mpc8540-dma", "fsl,eloplus-dma";
2751 ranges = <0 21100 200>;
2754 compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
2757 interrupt-parent = <&mpic>;
2758 interrupts = <14 2>;
2761 compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
2764 interrupt-parent = <&mpic>;
2765 interrupts = <15 2>;
2768 compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
2771 interrupt-parent = <&mpic>;
2772 interrupts = <16 2>;
2775 compatible = "fsl,mpc8540-dma-channel", "fsl,eloplus-dma-channel";
2778 interrupt-parent = <&mpic>;
2779 interrupts = <17 2>;
2783 * Freescale 8xxx/3.0 Gb/s SATA nodes
2785 SATA nodes are defined to describe on-chip Serial ATA controllers.
2786 Each SATA port should have its own node.
2788 Required properties:
2789 - compatible : compatible list, contains 2 entries, first is
2790 "fsl,CHIP-sata", where CHIP is the processor
2791 (mpc8315, mpc8379, etc.) and the second is
2793 - interrupts : <interrupt mapping for SATA IRQ>
2794 - cell-index : controller index.
2795 1 for controller @ 0x18000
2796 2 for controller @ 0x19000
2797 3 for controller @ 0x1a000
2798 4 for controller @ 0x1b000
2800 Optional properties:
2801 - interrupt-parent : optional, if needed for interrupt mapping
2802 - reg : <registers mapping>
2807 compatible = "fsl,mpc8379-sata", "fsl,pq-sata";
2808 reg = <0x18000 0x1000>;
2810 interrupts = <2c 8>;
2811 interrupt-parent = < &ipic >;
2814 q) USB EHCI controllers
2816 Required properties:
2817 - compatible : should be "usb-ehci".
2818 - reg : should contain at least address and length of the standard EHCI
2819 register set for the device. Optional platform-dependent registers
2820 (debug-port or other) can be also specified here, but only after
2821 definition of standard EHCI registers.
2822 - interrupts : one EHCI interrupt should be described here.
2823 If device registers are implemented in big endian mode, the device
2824 node should have "big-endian-regs" property.
2825 If controller implementation operates with big endian descriptors,
2826 "big-endian-desc" property should be specified.
2827 If both big endian registers and descriptors are used by the controller
2828 implementation, "big-endian" property can be specified instead of having
2829 both "big-endian-regs" and "big-endian-desc".
2831 Example (Sequoia 440EPx):
2833 compatible = "ibm,usb-ehci-440epx", "usb-ehci";
2834 interrupt-parent = <&UIC0>;
2835 interrupts = <1a 4>;
2836 reg = <0 e0000300 90 0 e0000390 70>;
2840 r) Freescale Display Interface Unit
2842 The Freescale DIU is a LCD controller, with proper hardware, it can also
2845 Required properties:
2846 - compatible : should be "fsl-diu".
2847 - reg : should contain at least address and length of the DIU register
2849 - Interrupts : one DIU interrupt should be describe here.
2851 Example (MPC8610HPCD)
2853 compatible = "fsl,diu";
2854 reg = <0x2c000 100>;
2855 interrupts = <72 2>;
2856 interrupt-parent = <&mpic>;
2859 s) Freescale on board FPGA
2861 This is the memory-mapped registers for on board FPGA.
2863 Required properities:
2864 - compatible : should be "fsl,fpga-pixis".
2865 - reg : should contain the address and the lenght of the FPPGA register
2868 Example (MPC8610HPCD)
2869 board-control@e8000000 {
2870 compatible = "fsl,fpga-pixis";
2871 reg = <0xe8000000 32>;
2876 Currently defined compatibles:
2879 MDC and MDIO lines connected to GPIO controllers are listed in the
2880 gpios property as described in section VIII.1 in the following order:
2887 compatible = "virtual,mdio-gpio";
2888 #address-cells = <1>;
2890 gpios = <&qe_pio_a 11
2894 VII - Marvell Discovery mv64[345]6x System Controller chips
2895 ===========================================================
2897 The Marvell mv64[345]60 series of system controller chips contain
2898 many of the peripherals needed to implement a complete computer
2899 system. In this section, we define device tree nodes to describe
2900 the system controller chip itself and each of the peripherals
2901 which it contains. Compatible string values for each node are
2902 prefixed with the string "marvell,", for Marvell Technology Group Ltd.
2904 1) The /system-controller node
2906 This node is used to represent the system-controller and must be
2907 present when the system uses a system contller chip. The top-level
2908 system-controller node contains information that is global to all
2909 devices within the system controller chip. The node name begins
2910 with "system-controller" followed by the unit address, which is
2911 the base address of the memory-mapped register set for the system
2914 Required properties:
2916 - ranges : Describes the translation of system controller addresses
2917 for memory mapped registers.
2918 - clock-frequency: Contains the main clock frequency for the system
2920 - reg : This property defines the address and size of the
2921 memory-mapped registers contained within the system controller
2922 chip. The address specified in the "reg" property should match
2923 the unit address of the system-controller node.
2924 - #address-cells : Address representation for system controller
2925 devices. This field represents the number of cells needed to
2926 represent the address of the memory-mapped registers of devices
2927 within the system controller chip.
2928 - #size-cells : Size representation for for the memory-mapped
2929 registers within the system controller chip.
2930 - #interrupt-cells : Defines the width of cells used to represent
2933 Optional properties:
2935 - model : The specific model of the system controller chip. Such
2936 as, "mv64360", "mv64460", or "mv64560".
2937 - compatible : A string identifying the compatibility identifiers
2938 of the system controller chip.
2940 The system-controller node contains child nodes for each system
2941 controller device that the platform uses. Nodes should not be created
2942 for devices which exist on the system controller chip but are not used
2944 Example Marvell Discovery mv64360 system-controller node:
2946 system-controller@f1000000 { /* Marvell Discovery mv64360 */
2947 #address-cells = <1>;
2949 model = "mv64360"; /* Default */
2950 compatible = "marvell,mv64360";
2951 clock-frequency = <133333333>;
2952 reg = <0xf1000000 0x10000>;
2953 virtual-reg = <0xf1000000>;
2954 ranges = <0x88000000 0x88000000 0x1000000 /* PCI 0 I/O Space */
2955 0x80000000 0x80000000 0x8000000 /* PCI 0 MEM Space */
2956 0xa0000000 0xa0000000 0x4000000 /* User FLASH */
2957 0x00000000 0xf1000000 0x0010000 /* Bridge's regs */
2958 0xf2000000 0xf2000000 0x0040000>;/* Integrated SRAM */
2960 [ child node definitions... ]
2963 2) Child nodes of /system-controller
2965 a) Marvell Discovery MDIO bus
2967 The MDIO is a bus to which the PHY devices are connected. For each
2968 device that exists on this bus, a child node should be created. See
2969 the definition of the PHY node below for an example of how to define
2972 Required properties:
2973 - #address-cells : Should be <1>
2974 - #size-cells : Should be <0>
2975 - device_type : Should be "mdio"
2976 - compatible : Should be "marvell,mv64360-mdio"
2981 #address-cells = <1>;
2983 device_type = "mdio";
2984 compatible = "marvell,mv64360-mdio";
2992 b) Marvell Discovery ethernet controller
2994 The Discover ethernet controller is described with two levels
2995 of nodes. The first level describes an ethernet silicon block
2996 and the second level describes up to 3 ethernet nodes within
2997 that block. The reason for the multiple levels is that the
2998 registers for the node are interleaved within a single set
2999 of registers. The "ethernet-block" level describes the
3000 shared register set, and the "ethernet" nodes describe ethernet
3001 port-specific properties.
3005 Required properties:
3006 - #address-cells : <1>
3008 - compatible : "marvell,mv64360-eth-block"
3009 - reg : Offset and length of the register set for this block
3011 Example Discovery Ethernet block node:
3012 ethernet-block@2000 {
3013 #address-cells = <1>;
3015 compatible = "marvell,mv64360-eth-block";
3016 reg = <0x2000 0x2000>;
3024 Required properties:
3025 - device_type : Should be "network".
3026 - compatible : Should be "marvell,mv64360-eth".
3027 - reg : Should be <0>, <1>, or <2>, according to which registers
3028 within the silicon block the device uses.
3029 - interrupts : <a> where a is the interrupt number for the port.
3030 - interrupt-parent : the phandle for the interrupt controller
3031 that services interrupts for this device.
3032 - phy : the phandle for the PHY connected to this ethernet
3034 - local-mac-address : 6 bytes, MAC address
3036 Example Discovery Ethernet port node:
3038 device_type = "network";
3039 compatible = "marvell,mv64360-eth";
3042 interrupt-parent = <&PIC>;
3044 local-mac-address = [ 00 00 00 00 00 00 ];
3049 c) Marvell Discovery PHY nodes
3051 Required properties:
3052 - device_type : Should be "ethernet-phy"
3053 - interrupts : <a> where a is the interrupt number for this phy.
3054 - interrupt-parent : the phandle for the interrupt controller that
3055 services interrupts for this device.
3056 - reg : The ID number for the phy, usually a small integer
3058 Example Discovery PHY node:
3060 device_type = "ethernet-phy";
3061 compatible = "broadcom,bcm5421";
3062 interrupts = <76>; /* GPP 12 */
3063 interrupt-parent = <&PIC>;
3068 d) Marvell Discovery SDMA nodes
3070 Represent DMA hardware associated with the MPSC (multiprotocol
3071 serial controllers).
3073 Required properties:
3074 - compatible : "marvell,mv64360-sdma"
3075 - reg : Offset and length of the register set for this device
3076 - interrupts : <a> where a is the interrupt number for the DMA
3078 - interrupt-parent : the phandle for the interrupt controller
3079 that services interrupts for this device.
3081 Example Discovery SDMA node:
3083 compatible = "marvell,mv64360-sdma";
3084 reg = <0x4000 0xc18>;
3085 virtual-reg = <0xf1004000>;
3087 interrupt-parent = <&PIC>;
3091 e) Marvell Discovery BRG nodes
3093 Represent baud rate generator hardware associated with the MPSC
3094 (multiprotocol serial controllers).
3096 Required properties:
3097 - compatible : "marvell,mv64360-brg"
3098 - reg : Offset and length of the register set for this device
3099 - clock-src : A value from 0 to 15 which selects the clock
3100 source for the baud rate generator. This value corresponds
3101 to the CLKS value in the BRGx configuration register. See
3102 the mv64x60 User's Manual.
3103 - clock-frequence : The frequency (in Hz) of the baud rate
3104 generator's input clock.
3105 - current-speed : The current speed setting (presumably by
3106 firmware) of the baud rate generator.
3108 Example Discovery BRG node:
3110 compatible = "marvell,mv64360-brg";
3113 clock-frequency = <133333333>;
3114 current-speed = <9600>;
3118 f) Marvell Discovery CUNIT nodes
3120 Represent the Serial Communications Unit device hardware.
3122 Required properties:
3123 - reg : Offset and length of the register set for this device
3125 Example Discovery CUNIT node:
3127 reg = <0xf200 0x200>;
3131 g) Marvell Discovery MPSCROUTING nodes
3133 Represent the Discovery's MPSC routing hardware
3135 Required properties:
3136 - reg : Offset and length of the register set for this device
3138 Example Discovery CUNIT node:
3144 h) Marvell Discovery MPSCINTR nodes
3146 Represent the Discovery's MPSC DMA interrupt hardware registers
3147 (SDMA cause and mask registers).
3149 Required properties:
3150 - reg : Offset and length of the register set for this device
3152 Example Discovery MPSCINTR node:
3154 reg = <0xb800 0x100>;
3158 i) Marvell Discovery MPSC nodes
3160 Represent the Discovery's MPSC (Multiprotocol Serial Controller)
3163 Required properties:
3164 - device_type : "serial"
3165 - compatible : "marvell,mv64360-mpsc"
3166 - reg : Offset and length of the register set for this device
3167 - sdma : the phandle for the SDMA node used by this port
3168 - brg : the phandle for the BRG node used by this port
3169 - cunit : the phandle for the CUNIT node used by this port
3170 - mpscrouting : the phandle for the MPSCROUTING node used by this port
3171 - mpscintr : the phandle for the MPSCINTR node used by this port
3172 - cell-index : the hardware index of this cell in the MPSC core
3173 - max_idle : value needed for MPSC CHR3 (Maximum Frame Length)
3175 - interrupts : <a> where a is the interrupt number for the MPSC.
3176 - interrupt-parent : the phandle for the interrupt controller
3177 that services interrupts for this device.
3179 Example Discovery MPSCINTR node:
3181 device_type = "serial";
3182 compatible = "marvell,mv64360-mpsc";
3183 reg = <0x8000 0x38>;
3184 virtual-reg = <0xf1008000>;
3188 mpscrouting = <&MPSCROUTING>;
3189 mpscintr = <&MPSCINTR>;
3193 interrupt-parent = <&PIC>;
3197 j) Marvell Discovery Watch Dog Timer nodes
3199 Represent the Discovery's watchdog timer hardware
3201 Required properties:
3202 - compatible : "marvell,mv64360-wdt"
3203 - reg : Offset and length of the register set for this device
3205 Example Discovery Watch Dog Timer node:
3207 compatible = "marvell,mv64360-wdt";
3212 k) Marvell Discovery I2C nodes
3214 Represent the Discovery's I2C hardware
3216 Required properties:
3217 - device_type : "i2c"
3218 - compatible : "marvell,mv64360-i2c"
3219 - reg : Offset and length of the register set for this device
3220 - interrupts : <a> where a is the interrupt number for the I2C.
3221 - interrupt-parent : the phandle for the interrupt controller
3222 that services interrupts for this device.
3224 Example Discovery I2C node:
3225 compatible = "marvell,mv64360-i2c";
3226 reg = <0xc000 0x20>;
3227 virtual-reg = <0xf100c000>;
3229 interrupt-parent = <&PIC>;
3233 l) Marvell Discovery PIC (Programmable Interrupt Controller) nodes
3235 Represent the Discovery's PIC hardware
3237 Required properties:
3238 - #interrupt-cells : <1>
3239 - #address-cells : <0>
3240 - compatible : "marvell,mv64360-pic"
3241 - reg : Offset and length of the register set for this device
3242 - interrupt-controller
3244 Example Discovery PIC node:
3246 #interrupt-cells = <1>;
3247 #address-cells = <0>;
3248 compatible = "marvell,mv64360-pic";
3250 interrupt-controller;
3254 m) Marvell Discovery MPP (Multipurpose Pins) multiplexing nodes
3256 Represent the Discovery's MPP hardware
3258 Required properties:
3259 - compatible : "marvell,mv64360-mpp"
3260 - reg : Offset and length of the register set for this device
3262 Example Discovery MPP node:
3264 compatible = "marvell,mv64360-mpp";
3265 reg = <0xf000 0x10>;
3269 n) Marvell Discovery GPP (General Purpose Pins) nodes
3271 Represent the Discovery's GPP hardware
3273 Required properties:
3274 - compatible : "marvell,mv64360-gpp"
3275 - reg : Offset and length of the register set for this device
3277 Example Discovery GPP node:
3279 compatible = "marvell,mv64360-gpp";
3280 reg = <0xf100 0x20>;
3284 o) Marvell Discovery PCI host bridge node
3286 Represents the Discovery's PCI host bridge device. The properties
3287 for this node conform to Rev 2.1 of the PCI Bus Binding to IEEE
3288 1275-1994. A typical value for the compatible property is
3289 "marvell,mv64360-pci".
3291 Example Discovery PCI host bridge node
3293 #address-cells = <3>;
3295 #interrupt-cells = <1>;
3296 device_type = "pci";
3297 compatible = "marvell,mv64360-pci";
3299 ranges = <0x01000000 0x0 0x0
3300 0x88000000 0x0 0x01000000
3301 0x02000000 0x0 0x80000000
3302 0x80000000 0x0 0x08000000>;
3303 bus-range = <0 255>;
3304 clock-frequency = <66000000>;
3305 interrupt-parent = <&PIC>;
3306 interrupt-map-mask = <0xf800 0x0 0x0 0x7>;
3309 0x5000 0 0 1 &PIC 80
3310 0x5000 0 0 2 &PIC 81
3311 0x5000 0 0 3 &PIC 91
3312 0x5000 0 0 4 &PIC 93
3315 0x5800 0 0 1 &PIC 91
3316 0x5800 0 0 2 &PIC 93
3317 0x5800 0 0 3 &PIC 80
3318 0x5800 0 0 4 &PIC 81
3321 0x6000 0 0 1 &PIC 91
3322 0x6000 0 0 2 &PIC 93
3323 0x6000 0 0 3 &PIC 80
3324 0x6000 0 0 4 &PIC 81
3327 0x6800 0 0 1 &PIC 93
3328 0x6800 0 0 2 &PIC 80
3329 0x6800 0 0 3 &PIC 81
3330 0x6800 0 0 4 &PIC 91
3335 p) Marvell Discovery CPU Error nodes
3337 Represent the Discovery's CPU error handler device.
3339 Required properties:
3340 - compatible : "marvell,mv64360-cpu-error"
3341 - reg : Offset and length of the register set for this device
3342 - interrupts : the interrupt number for this device
3343 - interrupt-parent : the phandle for the interrupt controller
3344 that services interrupts for this device.
3346 Example Discovery CPU Error node:
3348 compatible = "marvell,mv64360-cpu-error";
3349 reg = <0x70 0x10 0x128 0x28>;
3351 interrupt-parent = <&PIC>;
3355 q) Marvell Discovery SRAM Controller nodes
3357 Represent the Discovery's SRAM controller device.
3359 Required properties:
3360 - compatible : "marvell,mv64360-sram-ctrl"
3361 - reg : Offset and length of the register set for this device
3362 - interrupts : the interrupt number for this device
3363 - interrupt-parent : the phandle for the interrupt controller
3364 that services interrupts for this device.
3366 Example Discovery SRAM Controller node:
3368 compatible = "marvell,mv64360-sram-ctrl";
3371 interrupt-parent = <&PIC>;
3375 r) Marvell Discovery PCI Error Handler nodes
3377 Represent the Discovery's PCI error handler device.
3379 Required properties:
3380 - compatible : "marvell,mv64360-pci-error"
3381 - reg : Offset and length of the register set for this device
3382 - interrupts : the interrupt number for this device
3383 - interrupt-parent : the phandle for the interrupt controller
3384 that services interrupts for this device.
3386 Example Discovery PCI Error Handler node:
3388 compatible = "marvell,mv64360-pci-error";
3389 reg = <0x1d40 0x40 0xc28 0x4>;
3391 interrupt-parent = <&PIC>;
3395 s) Marvell Discovery Memory Controller nodes
3397 Represent the Discovery's memory controller device.
3399 Required properties:
3400 - compatible : "marvell,mv64360-mem-ctrl"
3401 - reg : Offset and length of the register set for this device
3402 - interrupts : the interrupt number for this device
3403 - interrupt-parent : the phandle for the interrupt controller
3404 that services interrupts for this device.
3406 Example Discovery Memory Controller node:
3408 compatible = "marvell,mv64360-mem-ctrl";
3409 reg = <0x1400 0x60>;
3411 interrupt-parent = <&PIC>;
3415 VIII - Specifying interrupt information for devices
3416 ===================================================
3418 The device tree represents the busses and devices of a hardware
3419 system in a form similar to the physical bus topology of the
3422 In addition, a logical 'interrupt tree' exists which represents the
3423 hierarchy and routing of interrupts in the hardware.
3425 The interrupt tree model is fully described in the
3426 document "Open Firmware Recommended Practice: Interrupt
3427 Mapping Version 0.9". The document is available at:
3428 <http://playground.sun.com/1275/practice>.
3430 1) interrupts property
3431 ----------------------
3433 Devices that generate interrupts to a single interrupt controller
3434 should use the conventional OF representation described in the
3435 OF interrupt mapping documentation.
3437 Each device which generates interrupts must have an 'interrupt'
3438 property. The interrupt property value is an arbitrary number of
3439 of 'interrupt specifier' values which describe the interrupt or
3440 interrupts for the device.
3442 The encoding of an interrupt specifier is determined by the
3443 interrupt domain in which the device is located in the
3444 interrupt tree. The root of an interrupt domain specifies in
3445 its #interrupt-cells property the number of 32-bit cells
3446 required to encode an interrupt specifier. See the OF interrupt
3447 mapping documentation for a detailed description of domains.
3449 For example, the binding for the OpenPIC interrupt controller
3450 specifies an #interrupt-cells value of 2 to encode the interrupt
3451 number and level/sense information. All interrupt children in an
3452 OpenPIC interrupt domain use 2 cells per interrupt in their interrupts
3455 The PCI bus binding specifies a #interrupt-cell value of 1 to encode
3456 which interrupt pin (INTA,INTB,INTC,INTD) is used.
3458 2) interrupt-parent property
3459 ----------------------------
3461 The interrupt-parent property is specified to define an explicit
3462 link between a device node and its interrupt parent in
3463 the interrupt tree. The value of interrupt-parent is the
3464 phandle of the parent node.
3466 If the interrupt-parent property is not defined for a node, it's
3467 interrupt parent is assumed to be an ancestor in the node's
3468 _device tree_ hierarchy.
3470 3) OpenPIC Interrupt Controllers
3471 --------------------------------
3473 OpenPIC interrupt controllers require 2 cells to encode
3474 interrupt information. The first cell defines the interrupt
3475 number. The second cell defines the sense and level
3478 Sense and level information should be encoded as follows:
3480 0 = low to high edge sensitive type enabled
3481 1 = active low level sensitive type enabled
3482 2 = active high level sensitive type enabled
3483 3 = high to low edge sensitive type enabled
3485 4) ISA Interrupt Controllers
3486 ----------------------------
3488 ISA PIC interrupt controllers require 2 cells to encode
3489 interrupt information. The first cell defines the interrupt
3490 number. The second cell defines the sense and level
3493 ISA PIC interrupt controllers should adhere to the ISA PIC
3494 encodings listed below:
3496 0 = active low level sensitive type enabled
3497 1 = active high level sensitive type enabled
3498 2 = high to low edge sensitive type enabled
3499 3 = low to high edge sensitive type enabled
3501 VIII - Specifying GPIO information for devices
3502 ==============================================
3507 Nodes that makes use of GPIOs should define them using `gpios' property,
3508 format of which is: <&gpio-controller1-phandle gpio1-specifier
3509 &gpio-controller2-phandle gpio2-specifier
3510 0 /* holes are permitted, means no GPIO 3 */
3511 &gpio-controller4-phandle gpio4-specifier
3514 Note that gpio-specifier length is controller dependent.
3516 gpio-specifier may encode: bank, pin position inside the bank,
3517 whether pin is open-drain and whether pin is logically inverted.
3519 Example of the node using GPIOs:
3522 gpios = <&qe_pio_e 18 0>;
3525 In this example gpio-specifier is "18 0" and encodes GPIO pin number,
3526 and empty GPIO flags as accepted by the "qe_pio_e" gpio-controller.
3528 2) gpio-controller nodes
3529 ------------------------
3531 Every GPIO controller node must have #gpio-cells property defined,
3532 this information will be used to translate gpio-specifiers.
3534 Example of two SOC GPIO banks defined as gpio-controller nodes:
3536 qe_pio_a: gpio-controller@1400 {
3538 compatible = "fsl,qe-pario-bank-a", "fsl,qe-pario-bank";
3539 reg = <0x1400 0x18>;
3543 qe_pio_e: gpio-controller@1460 {
3545 compatible = "fsl,qe-pario-bank-e", "fsl,qe-pario-bank";
3546 reg = <0x1460 0x18>;
3550 Appendix A - Sample SOC node for MPC8540
3551 ========================================
3553 Note that the #address-cells and #size-cells for the SoC node
3554 in this example have been explicitly listed; these are likely
3555 not necessary as they are usually the same as the root node.
3558 #address-cells = <1>;
3560 #interrupt-cells = <2>;
3561 device_type = "soc";
3562 ranges = <00000000 e0000000 00100000>
3563 reg = <e0000000 00003000>;
3564 bus-frequency = <0>;
3568 device_type = "mdio";
3569 compatible = "gianfar";
3572 linux,phandle = <2452000>
3573 interrupt-parent = <40000>;
3574 interrupts = <35 1>;
3576 device_type = "ethernet-phy";
3580 linux,phandle = <2452001>
3581 interrupt-parent = <40000>;
3582 interrupts = <35 1>;
3584 device_type = "ethernet-phy";
3588 linux,phandle = <2452002>
3589 interrupt-parent = <40000>;
3590 interrupts = <35 1>;
3592 device_type = "ethernet-phy";
3599 device_type = "network";
3601 compatible = "gianfar";
3603 mac-address = [ 00 E0 0C 00 73 00 ];
3604 interrupts = <d 3 e 3 12 3>;
3605 interrupt-parent = <40000>;
3606 phy-handle = <2452000>;
3610 #address-cells = <1>;
3612 device_type = "network";
3614 compatible = "gianfar";
3616 mac-address = [ 00 E0 0C 00 73 01 ];
3617 interrupts = <13 3 14 3 18 3>;
3618 interrupt-parent = <40000>;
3619 phy-handle = <2452001>;
3623 #address-cells = <1>;
3625 device_type = "network";
3627 compatible = "gianfar";
3629 mac-address = [ 00 E0 0C 00 73 02 ];
3630 interrupts = <19 3>;
3631 interrupt-parent = <40000>;
3632 phy-handle = <2452002>;
3636 device_type = "serial";
3637 compatible = "ns16550";
3639 clock-frequency = <0>;
3640 interrupts = <1a 3>;
3641 interrupt-parent = <40000>;
3645 linux,phandle = <40000>;
3646 clock-frequency = <0>;
3647 interrupt-controller;
3648 #address-cells = <0>;
3649 reg = <40000 40000>;
3651 compatible = "chrp,open-pic";
3652 device_type = "open-pic";
3657 interrupt-parent = <40000>;
3658 interrupts = <1b 3>;
3660 device_type = "i2c";
3661 compatible = "fsl-i2c";