Skip to content

Commit 2781a51

Browse files
committed
Fix broken section references
Replace old ePAPR section reference numbers with proper rST reference syntax. Signed-off-by: Grant Likely <[email protected]>
1 parent 4c1bf96 commit 2781a51

File tree

4 files changed

+19
-23
lines changed

4 files changed

+19
-23
lines changed

source/devicenodes.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ If the VLE storage attribute is supported, with VLE=0.
141141
size pairs that specify the physical address
142142
and size of the memory ranges.
143143
``initial-mapped-area`` O ``<prop-encoded-array>`` Specifies the address and size of the Initial
144-
Mapped Area (see section FIXME 5.3).
144+
Mapped Area
145145

146146
Is a prop-encoded-array consisting of a
147147
triplet of (effective address, physical
@@ -312,10 +312,11 @@ General Properties of ``/cpus/cpu*`` nodes
312312
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
313313

314314
The following table describes the general properties of CPU nodes. Some
315-
of the properties described in FIXME are select standard properties with
316-
specific applicable detail.
315+
of the properties described in :numref:`table-cpu-node-props` are select
316+
standard properties with specific applicable detail.
317317

318318
.. tabularcolumns:: p{2.5cm} p{1cm} p{2cm} p{9.5cm}
319+
.. _table-cpu-node-props:
319320
.. table:: ``/cpus/cpu*`` Node General Properties
320321
:class: longtable
321322

@@ -398,11 +399,6 @@ specific applicable detail.
398399
loop, held in reset, and electrically isolated
399400
from the system bus or in another
400401
implementation dependent state.
401-
402-
Note: See section FIXME 5.5 (Symmetric
403-
Multiprocessing (SMP) Boot Requirements) for a
404-
description of how these values are used for
405-
booting multi-CPU SMP systems.
406402
``enable-method`` SD ``<stringlist>`` Describes the method by which a CPU in a
407403
disabled state is enabled. This property is
408404
required for CPUs with a status property with
@@ -433,9 +429,6 @@ specific applicable detail.
433429
value of "spin-table". The value specifies the
434430
physical address of a spin table entry that
435431
releases a secondary CPU from its spin loop.
436-
437-
See section FIXME 5.5.2, Spin Table or details on
438-
the structure of a spin table.
439432
Usage legend: R=Required, O=Optional, OR=Optional but Recommended, SD=See Definition
440433
===================================================================================================
441434

source/devicetree-basics.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,8 @@ organization that defined the property. Examples:
282282
| ``ibm,ppc-interrupt-server#s``
283283
| ``linux,network-index``
284284
285+
.. _sect-property-values:
286+
285287
Property Values
286288
^^^^^^^^^^^^^^^
287289

source/flattened-format.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,16 @@ big-endian format.
9696

9797
``off_dt_struct``
9898
This field shall contain the offset in bytes of the structure block
99-
(see 8.4) from the beginning of the header.
99+
(see :ref:`sect-fdt-structure-block`) from the beginning of the header.
100100

101101
``off_dt_strings``
102102
This field shall contain the offset in bytes of the strings block
103-
(see FIXME 8.5) from the beginning of the header.
103+
(see :ref:`sect-fdt-strings-block`) from the beginning of the header.
104104

105105
``off_mem_rsvmap``
106106
This field shall contain the offset in bytes of the memory
107-
reservation block (see 8.3) from the beginning of the header.
107+
reservation block (see :ref:`sect-fdt-memory-reservation-block`)
108+
from the beginning of the header.
108109

109110
``version``
110111
This field shall contain the version of the device tree data
@@ -138,7 +139,7 @@ big-endian format.
138139
section of the device tree blob.
139140

140141

141-
.. *FIXME: Add reserved memory node*
142+
.. FIXME: Add reserved memory node
142143
143144
.. _sect-fdt-memory-reservation-block:
144145

@@ -238,6 +239,8 @@ Each token in the structure block, and thus the structure block itself,
238239
shall be located at a 4-byte aligned offset from the beginning of the
239240
device tree blob (see :ref:`sect-fdt-alignment`).
240241

242+
.. _sect-fdt-lexical-structure:
243+
241244
Lexical structure
242245
~~~~~~~~~~~~~~~~~
243246

@@ -254,7 +257,7 @@ The five token types are as follows:
254257
The FDT_BEGIN_NODE token marks the beginning of a node’s
255258
representation. It shall be followed by the node’s unit name as
256259
extra data. The name is stored as a null-terminated string, and
257-
shall include the unit address (see 2.2.1, Node Names), if any. The
260+
shall include the unit address (see :ref:`sect-node-names`), if any. The
258261
node name is followed by zeroed padding bytes, if necessary for
259262
alignment, and then the next token, which may be any token except
260263
FDT_END.
@@ -280,10 +283,10 @@ The five token types are as follows:
280283
Both the fields in this structure are 32-bit big-endian integers.
281284

282285
* len gives the length of the property’s value in bytes (which may be
283-
zero, indicating an empty property, see 2.2.4.2, Property Values).
286+
zero, indicating an empty property, see :ref:`sect-property-values`).
284287

285-
* nameoff gives an offset into the strings block (see 8.5) at which the
286-
property’s name is stored as a null-terminated string.
288+
* nameoff gives an offset into the strings block (see :ref:`sect-fdt-strings-block`)
289+
at which the property’s name is stored as a null-terminated string.
287290

288291
After this structure, the property’s value is given as a byte string of
289292
length len. This value is followed by zeroed padding bytes (if
@@ -331,7 +334,7 @@ components:
331334
* For each property of the node:
332335
* (optionally) any number of FDT_NOP tokens
333336
* FDT_PROP token
334-
* property information as given in 8.4.1
337+
* property information as given in :ref:`sect-fdt-lexical-structure`
335338
* [zeroed padding bytes to align to a 4-byte boundary]
336339
* Representations of all child nodes in this format
337340
* (optionally) any number of FDT_NOP tokens
@@ -375,7 +378,7 @@ shall have aligned offsets from the beginning of the device tree blob.
375378
To ensure the in-memory alignment of the blocks, it is sufficient to
376379
ensure that the device tree as a whole is loaded at an address aligned
377380
to the largest alignment of any of the subblocks, that is, to an 8-byte
378-
boundary. As described in 5.2 (Device Tree) an |spec| compliant boot
381+
boundary. A |spec| compliant boot
379382
program shall load the device tree blob at such an aligned address
380383
before passing it to the client program. If an |spec| client program
381384
relocates the device tree blob in memory, it should only do so to

source/introduction.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ may include:
5353
* Chapter :ref:`chapter-device-node-requirements` specifies the
5454
definition of a base set of device nodes required by |spec|-compliant
5555
device trees.
56-
* Chapter FIXME specifies the requirements for boot programs to start client
57-
programs on single and multiple CPU systems.
5856
* Chapter :ref:`chapter-device-bindings` describes device bindings for
5957
certain classes of devices and specific device types.
6058
* Chapter :ref:`chapter-fdt-structure` specifies the physical structure

0 commit comments

Comments
 (0)