Skip to content

Commit 0c06c17

Browse files
robertpjdayrobherring
authored andcommitted
Aesthetic tweaks to devicenodes.rst chapter
Aesthetic fixups to devicenodes.rst chapter of DT spec, including: * grammar fixes * font changes * define "PIR" acronym when first used Signed-off-by: Robert P. J. Day <[email protected]> Signed-off-by: Rob Herring <[email protected]>
1 parent 7d888a0 commit 0c06c17

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

source/devicenodes.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ Base Device Node Types
77
----------------------
88

99
The sections that follow specify the requirements for the base set of
10-
device nodes required in an |spec|-compliant devicetree.
10+
device nodes required in a |spec|-compliant devicetree.
1111

1212
All devicetrees shall have a root node and the following nodes shall be
1313
present at the root of all devicetrees:
1414

1515
* One ``/cpus`` node
1616

17-
* At least one ``memory`` node
17+
* At least one ``/memory`` node
1818

1919
Root node
2020
---------
@@ -65,7 +65,7 @@ and have the node name ``/aliases``.
6565
Each property of the ``/aliases`` node defines an alias. The property name
6666
specifies the alias name. The property value specifies the full path to
6767
a node in the devicetree. For example, the property serial0 =
68-
``"/simple-bus@fe000000/serial@llc500"`` defines the alias serial0.
68+
``"/simple-bus@fe000000/serial@llc500"`` defines the alias ``serial0``.
6969

7070
Alias names shall be a lowercase text strings of 1 to 31 characters from
7171
the following set of characters.
@@ -98,7 +98,7 @@ considering a string as a device path, shall detect and use the alias.
9898
ethernet0 = "/simple-bus@fe000000/ethernet@31c000";
9999
};
100100
101-
Given the alias serial0, a client program can look at the aliases node
101+
Given the alias ``serial0``, a client program can look at the ``/aliases`` node
102102
and determine the alias refers to the device path
103103
``/simple-bus@fe000000/serial@llc500``.
104104

@@ -110,8 +110,8 @@ physical memory layout for the system. If a system has multiple ranges
110110
of memory, multiple memory nodes can be created, or the ranges can be
111111
specified in the *reg* property of a single memory node.
112112

113-
The name component of the node name (see section :ref:`sect-node-names`)
114-
shall be memory.
113+
The *unit-name* component of the node name (see section :ref:`sect-node-names`)
114+
shall be ``memory``.
115115

116116
The client program may access memory not covered by any memory
117117
reservations (see section :ref:`sect-fdt-memory-reservation-block`)
@@ -241,16 +241,16 @@ time. It shall be a child of the root node.
241241
};
242242
243243
Older versions of devicetrees may be encountered that contain a
244-
deprecated form of the stdout-path property called linux,stdout-path.
244+
deprecated form of the *stdout-path* property called *linux,stdout-path*.
245245
For compatibility, a client program might want to support
246-
linux,stdout-path if a stdout-path property is not present. The meaning
246+
*linux,stdout-path* if a *stdout-path* property is not present. The meaning
247247
and use of the two properties is identical.
248248

249249
``/cpus`` Node Properties
250250
-------------------------
251251

252-
A cpus node is required for all devicetrees. It does not represent a
253-
real device in the system, but acts as a container for child cpu nodes
252+
A ``/cpus`` node is required for all devicetrees. It does not represent a
253+
real device in the system, but acts as a container for child ``cpu`` nodes
254254
which represent the systems CPUs.
255255

256256
.. tabularcolumns:: | l c l J |
@@ -272,7 +272,7 @@ which represent the systems CPUs.
272272
:ref:`sect-standard-properties`) are allowed but are optional.
273273

274274

275-
The cpus node may contain properties that are common across CPU nodes.
275+
The ``/cpus`` node may contain properties that are common across ``cpu`` nodes.
276276
See section :ref:`sect-cpus-cpu-node-properties` for details.
277277

278278
For an example, see section :ref:`sect-cpu-node-example`.
@@ -282,31 +282,31 @@ For an example, see section :ref:`sect-cpu-node-example`.
282282
``/cpus/cpu*`` Node Properties
283283
------------------------------
284284

285-
A cpu node represents a hardware execution block that is sufficiently
285+
A ``cpu`` node represents a hardware execution block that is sufficiently
286286
independent that it is capable of running an operating system without
287287
interfering with other CPUs possibly running other operating systems.
288288

289289
Hardware threads that share an MMU would generally be represented under
290-
one cpu node. If other more complex CPU topographies are designed, the
290+
one ``cpu`` node. If other more complex CPU topographies are designed, the
291291
binding for the CPU must describe the topography (e.g. threads that
292292
don’t share an MMU).
293293

294294
CPUs and threads are numbered through a unified number-space that should
295295
match as closely as possible the interrupt controller’s numbering of
296296
CPUs/threads.
297297

298-
Properties that have identical values across CPU nodes may be placed in
299-
the cpus node instead. A client program must first examine a specific
300-
CPU node, but if an expected property is not found then it should look
301-
at the parent cpus node. This results in a less verbose representation
298+
Properties that have identical values across ``cpu`` nodes may be placed in
299+
the ``/cpus`` node instead. A client program must first examine a specific
300+
``cpu`` node, but if an expected property is not found then it should look
301+
at the parent ``/cpus`` node. This results in a less verbose representation
302302
of properties which are identical across all CPUs.
303303

304-
The node name for every cpu node should be ``cpu``.
304+
The node name for every CPU node should be ``cpu``.
305305

306306
General Properties of ``/cpus/cpu*`` nodes
307307
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
308308

309-
The following table describes the general properties of CPU nodes. Some
309+
The following table describes the general properties of ``cpu`` nodes. Some
310310
of the properties described in :numref:`table-cpu-node-props` are select
311311
standard properties with specific applicable detail.
312312

@@ -342,7 +342,8 @@ standard properties with specific applicable detail.
342342
and out of bounds of the range addressed by
343343
the interrupt controller
344344

345-
If a CPU/thread's PIR is modifiable, a client
345+
If a CPU/thread's PIR (pending interrupt register)
346+
is modifiable, a client
346347
program should modify PIR to match the *reg*
347348
property value. If PIR cannot be modified and
348349
the PIR value is distinct from the interrupt

0 commit comments

Comments
 (0)