booting-without-of.txt 61 KB

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