michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: s/device tree/devicetree/

Browse source 
DTSpec writes this as a single word, presumably to make it easier to
grep for / more precise. Follow along in the rest of the docs now that
our main DT docs page agrees with this usage.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Marti Bolivar 2019-10-07 10:37:09 -07:00 • committed by Carles Cufí
commit 27e5dd131f
23 changed files with 59 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

5
boards/arm/nrf52840_pca10056/doc/index.rst
View file

@ -195,8 +195,9 @@ more than one UART for connecting peripheral devices:
Overlay file naming
===================
The file has to be named ``<board>.overlay`` and placed in the app main directory to be
picked up automatically by the device tree compiler.
picked up automatically by the build system.
Selecting the pins
==================
@ -211,7 +212,7 @@ In the table 7.1.1 'aQFN73 ball assignments' select the pins marked
'General purpose I/O'. Note that pins marked as 'low frequency I/O only' can only be used
in under-10KHz applications. They are not suitable for 115200 speed of UART.
Translate 'Pin' into number for Device tree by using the following formula::
Translate the 'Pin' into number for devicetree by using the following formula::
pin_no = b\*32 + a

30
doc/application/index.rst
View file

@ -118,9 +118,8 @@ subdirectories which are not described here.
Device driver code.
:file:`dts`
Device tree source (.dts) files used to describe non-discoverable
board-specific hardware details previously hard coded in the OS
source code.
:ref:`device-tree` source files used to describe non-discoverable
board-specific hardware details.
:file:`ext`
Externally created code that has been integrated into Zephyr
@ -232,11 +231,8 @@ Follow these steps to create a new application directory. (Refer to
are interested in. See :ref:`application_kconfig` for more details, and
:ref:`configuration_options` for a complete list of available options.
#. Optionally, you can also configure any Device Tree overlays needed by your
application. Zephyr uses the same Device Tree system as the Linux kernel,
but with its own definitions.
This is usually not necessary; see :ref:`application_dt` below for details.
#. Optionally, you can also configure any devicetree overlays needed by your
application. See :ref:`application_dt` below for details.
.. _important-build-vars:
@ -276,9 +272,9 @@ should know about.
semicolons. Each file includes Kconfig configuration values that override
the default configuration values.
* :makevar:`DTC_OVERLAY_FILE`: Indicates the name of one or more Device Tree
* :makevar:`DTC_OVERLAY_FILE`: Indicates the name of one or more devicetree
overlay files. Multiple filenames can be separated with either spaces or
semicolons. Each file includes Device Tree values that override the default
semicolons. Each file includes devicetree values that override the default
DT values. See :ref:`application_dt` below for details on devicetree
overlays, and :ref:`device-tree` for an overview on devicetree and Zephyr.
@ -1093,7 +1089,7 @@ Make sure to follow these steps in order.
More details are available below in :ref:`application_kconfig`.
#. If your application uses a Device Tree overlay file or files other than
#. If your application uses a devicetree overlay file or files other than
the usual :file:`<board>.overlay`, add lines setting the
:makevar:`DTC_OVERLAY_FILE` variable to these files appropriately.
@ -1490,19 +1486,19 @@ docstrings at the top of ``scripts/kconfig/menuconfig.py`` and
.. _application_dt:
Device Tree Overlays
====================
Devicetree Overlays
===================
As described in :ref:`device-tree`, Zephyr uses Device Tree to describe the
As described in :ref:`device-tree`, Zephyr uses devicetree to describe the
hardware it runs on. This section describes how you can modify an application
build's devicetree using overlay files. For additional information regarding
the relationship between Device Tree and Kconfig see :ref:`dt_vs_kconfig`. For
the relationship between devicetree and Kconfig see :ref:`dt_vs_kconfig`. For
an example of how to use custom overlays with ``west build``, see
:ref:`west-building-cmake-args`.
In some cases the information contained in Device Tree files is closely
In some cases the information contained in devicetree files is closely
connected to the software and might need to be modified using the overlay file
concept. This can be relevant for many of the different Device Tree nodes, but
concept. This can be relevant for many of the different devicetree nodes, but
is particularly useful for :ref:`certain types of nodes <dt-alias-chosen>`.
Overlay files, which customarily have the :file:`.overlay` extension,

6
doc/guides/kconfig/index.rst
View file

@ -808,12 +808,12 @@ Kconfig Functions
*****************
Kconfiglib provides user-defined preprocessor functions that
we use in Zephyr to expose Device Tree information to Kconfig.
we use in Zephyr to expose devicetree information to Kconfig.
For example, we can get the default value for a Kconfig symbol
from the devicetree.
Device Tree Related Functions
=============================
Devicetree Related Functions
============================
See the Python docstrings in ``scripts/kconfig/kconfigfunctions.py`` for more
details on the functions.

4
doc/guides/porting/shields.rst
View file

@ -47,8 +47,8 @@ This should be done at two different level:
* Pinmux: Connector pins should be correctly configured to match shield pins
* Device tree: A board device tree file should define a node alias for each
connector interface. For example, for Arduino I2C:
* Devicetree: A board :ref:`device-tree` file should define a node alias for
each connector interface. For example, for Arduino I2C:
.. code-block:: none

8
doc/introduction/index.rst
View file

@ -99,11 +99,9 @@ Zephyr offers a large and ever growing number of features including:
drivers configured into the system and Allows the reuse of drivers across
platforms that have common devices/IP blocks
**Device Tree Support**
Use of Device Tree (DTS) to describe hardware and configuration information for
boards. The DTS information will be used only during compile time.
Information about the system is extracted from the compiled DTS and used to
create the application image.
**Devicetree Support**
Use of :ref:`device-tree` to describe hardware. Information from devicetree
is used to create the application image.
**Native Networking Stack supporting multiple protocols**
Networking support is fully featured and optimized, including LwM2M and BSD

4
samples/bluetooth/hci_spi/README.rst
View file

@ -21,8 +21,8 @@ In order to use this application, you need a board with a Bluetooth
controller and SPI slave drivers, and a spare GPIO to use as an
interrupt line to the SPI master.
You then need to ensure that your Device Tree settings provide a definition
for the slave HCI SPI device::
You then need to ensure that your :ref:`device-tree` settings provide a
definition for the slave HCI SPI device::
bt-hci@0 {
compatible = "zephyr,bt-hci-spi-slave";