Skip to content

Commit

Permalink
Fixing some typos and adding missing dots, commas, and hyphens
Browse files Browse the repository at this point in the history
Signed-off-by: Reda Maher <[email protected]>
  • Loading branch information
RedaMaher authored and robherring committed Feb 5, 2024
1 parent bbb6c79 commit 2697c66
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 29 deletions.
6 changes: 3 additions & 3 deletions source/chapter2-devicetree-basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ of its scan, for passing to the Operating System.
:numref:`example-simple-devicetree` shows an example representation of a
simple devicetree that is nearly
complete enough to boot a simple operating system, with the platform
type, CPU, memory and a single UART described. Device nodes are shown
type, CPU, memory, and a single UART described. Device nodes are shown
with properties and values inside each node.

.. _example-simple-devicetree:
Expand Down Expand Up @@ -488,7 +488,7 @@ Description:
The *compatible* property value consists of one or more strings that
define the specific programming model for the device. This list of
strings should be used by a client program for device driver selection.
The property value consists of a concatenated list of null terminated
The property value consists of a concatenated list of null-terminated
strings, from most specific to most general. They allow a device to
express its compatibility with a family of similar devices, potentially
allowing a single device driver to match against several devices.
Expand All @@ -498,7 +498,7 @@ Description:
(such as a stock ticker symbol), and ``model`` specifies the model
number.

The compatible string should consist only of lowercase letters, digits and
The compatible string should consist only of lowercase letters, digits, and
dashes, and should start with a letter. A single comma is typically only
used following a vendor prefix. Underscores should not be used.

Expand Down
10 changes: 5 additions & 5 deletions source/chapter3-devicenodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ specifies the alias name. The property value specifies the full path to
a node in the devicetree. For example, the property serial0 =
``"/simple-bus@fe000000/serial@llc500"`` defines the alias ``serial0``.

Alias names shall be a lowercase text strings of 1 to 31 characters from
Alias names shall be lowercase text strings of 1 to 31 characters from
the following set of characters.

.. tabularcolumns:: | c p{8cm} |
Expand Down Expand Up @@ -582,7 +582,7 @@ standard properties with specific applicable detail.
If a CPU/thread cannot be the target of an
external interrupt, then *reg* must be unique
and out of bounds of the range addressed by
the interrupt controller
the interrupt controller.

If a CPU/thread's PIR (pending interrupt register)
is modifiable, a client
Expand Down Expand Up @@ -811,12 +811,12 @@ The following properties of a cpu node describe the processor’s internal
(combined instructions and data).
``cache-sets`` SD ``<u32>`` Specifies the number of associativity sets in
a unified cache. Required if the cache is
unified (combined instructions and data)
unified (combined instructions and data).
``cache-block-size`` SD ``<u32>`` Specifies the block size in bytes of a unified
cache. Required if the processor has a unified
cache (combined instructions and data)
cache (combined instructions and data).
``cache-line-size`` SD ``<u32>`` Specifies the line size in bytes of a unified
cache, if different than the cache block size
cache, if different than the cache block size.
Required if the processor has a unified cache
(combined instructions and data).
``i-cache-size`` SD ``<u32>`` Specifies the size in bytes of the instruction
Expand Down
34 changes: 17 additions & 17 deletions source/chapter4-device-bindings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ types and classes of devices are represented in the devicetree. The
compatible property of a device node describes the specific binding (or
bindings) to which the node complies.

Bindings may be defined as extensions of other each. For example a new
Bindings may be defined as extensions of each other. For example, a new
bus type could be defined as an extension of the simple-bus binding. In
this case, the compatible property would contain several strings
identifying each binding—from the most specific to the most general (see
Expand Down Expand Up @@ -75,10 +75,10 @@ here to facilitate standardization of names and usage.
``<prop-encoded-array>`` in one of two forms:

a 32-bit integer consisting of one ``<u32>`` specifying the
frequency
frequency.

a 64-bit integer represented as a ``<u64>`` specifying the
frequency
frequency.
=========== ==============================================================

``reg-shift`` Property
Expand Down Expand Up @@ -115,7 +115,7 @@ here to facilitate standardization of names and usage.
Property ``label``
=========== ==============================================================
Value type ``<string>``
Description The label property defines a human readable string describing
Description The label property defines a human-readable string describing
a device. The binding for a given device specifies the exact
meaning of the property for that device.
=========== ==============================================================
Expand All @@ -126,10 +126,10 @@ Serial devices
Serial Class Binding
~~~~~~~~~~~~~~~~~~~~

The class of serial devices consists of various types of point to point
The class of serial devices consists of various types of point-to-point
serial line devices. Examples of serial line devices include the 8250
UART, 16550 UART, HDLC device, and BISYNC device. In most cases hardware
compatible with the RS-232 standard fit into the serial device class.
UART, 16550 UART, HDLC device, and BISYNC device. In most cases, hardware
compatible with the RS-232 standard fits into the serial device class.

I\ :sup:`2`\ C and SPI (Serial Peripheral Interface) devices shall not
be represented as serial port devices because they have their own
Expand Down Expand Up @@ -181,12 +181,12 @@ the devicetree using following properties.
======================= ===== ===================== ===============================================
``compatible`` R <string list> Value shall include "ns16550".
``clock-frequency`` R ``<u32>`` Specifies the frequency (in Hz) of the baud
rate generator’s input clock
rate generator’s input clock.
``current-speed`` OR ``<u32>`` Specifies current serial device speed in bits
per second
per second.
``reg`` R ``<prop encoded Specifies the physical address of the
array>`` registers device within the address space of
the parent bus
the parent bus.
``interrupts`` OR ``<prop encoded Specifies the interrupts generated by this
array>`` device. The value of the interrupts property
consists of one or more interrupt specifiers.
Expand Down Expand Up @@ -248,7 +248,7 @@ Network Class Binding
=========== ==============================================================
Property ``local-mac-address``
=========== ==============================================================
Value type ``<prop-encoded-array>`` encoded as an array of hex numbers
Value type ``<prop-encoded-array>`` encoded as an array of hex numbers.
Description Specifies MAC address that was assigned to the network device
described by the node containing this property.
Example ``local-mac-address = [ 00 00 12 34 56 78 ];``
Expand All @@ -263,7 +263,7 @@ Network Class Binding
=========== ==============================================================
Property ``mac-address``
=========== ==============================================================
Value type ``<prop-encoded-array>`` encoded as an array of hex numbers
Value type ``<prop-encoded-array>`` encoded as an array of hex numbers.
Description Specifies the MAC address that was last used by the boot
program. This property should be used in cases where the MAC
address assigned to the device by the boot program is
Expand Down Expand Up @@ -368,8 +368,8 @@ the network device class.
Value type ``<phandle>``
Description Specifies a reference to a node representing a physical layer
(PHY) device connected to this Ethernet device. This property
is required in case where the Ethernet device is connected a
physical layer device.
is required in case where the Ethernet device is connected to
a physical layer device.
Example ``phy-handle = <&PHY0>;``
=========== ==============================================================

Expand Down Expand Up @@ -402,11 +402,11 @@ specifiers:
======================== ===== ===================== ===============================================
Property Name Usage Value Type Definition
======================== ===== ===================== ===============================================
``compatible`` R ``<string>`` Value shall include ``"open-pic"``
``compatible`` R ``<string>`` Value shall include ``"open-pic"``.
``reg`` R ``<prop encoded Specifies the physical address of the
array>`` registers device within the address space of
the parent bus
``interrupt-controller`` R ``<empty>`` Specifies that this node is an interrupt controller
the parent bus.
``interrupt-controller`` R ``<empty>`` Specifies that this node is an interrupt controller.
``#interrupt-cells`` R ``<u32>`` Shall be 2.
``#address-cells`` R ``<u32>`` Shall be 0.
Usage legend: R=Required, O=Optional, OR=Optional but Recommended, SD=See Definition
Expand Down
8 changes: 4 additions & 4 deletions source/chapter5-flattened-format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Flattened Devicetree (DTB) Format
==================================

The Devicetree Blob (DTB) format is a flat binary encoding of devicetree data.
It used to exchange devicetree data between software programs.
It is used to exchange devicetree data between software programs.
For example, when booting an operating system, firmware will pass a DTB to the OS kernel.

.. note::
Expand Down Expand Up @@ -60,10 +60,10 @@ the original definition of the format. Fields in the header give the version,
so that the client program can determine if the devicetree is encoded in a
compatible format.

This document describes only version 17 of the format. |spec| compliant boot
This document describes only version 17 of the format. |spec|-compliant boot
programs shall provide a devicetree of version 17 or later, and should provide
a devicetree of a version that is backwards compatible with version 16.
|spec| compliant client programs shall accept devicetrees of any version
|spec|-compliant client programs shall accept devicetrees of any version
backwards compatible with version 17 and may accept other versions as well.

.. note:: The version is with respect to the binary structure of the device
Expand Down Expand Up @@ -408,7 +408,7 @@ shall have aligned offsets from the beginning of the devicetree blob.
To ensure the in-memory alignment of the blocks, it is sufficient to
ensure that the devicetree as a whole is loaded at an address aligned
to the largest alignment of any of the subblocks, that is, to an 8-byte
boundary. A |spec| compliant boot
boundary. A |spec|-compliant boot
program shall load the devicetree blob at such an aligned address
before passing it to the client program. If an |spec| client program
relocates the devicetree blob in memory, it should only do so to
Expand Down

0 comments on commit 2697c66

Please sign in to comment.