michaelh/zephyr
1
0
Fork 0
Code Releases Activity

update documentation to use boards where applicable

Browse source 
Change the terminology in the documentation and use board instead
of platform where applicable.

Change-Id: I812598e1948ee7df8739e5cc9029278e9e849c7f
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-12-17 19:12:33 -05:00
commit 8ba05cc2ad
18 changed files with 96 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/application/apps_dev_process.rst
View file

@ -53,4 +53,4 @@ Workflow
with QEMU, see :ref:`apps_run`.
10. To load an application image on a target hardware, see using
:ref:`platform` documentation.
:ref:`board` documentation.

14
doc/application/apps_kernel_conf.rst
View file

@ -14,13 +14,13 @@ it is specified:
b. The value specified by the application’s default
configuration; that is, its :file:`prj.conf` file.
c. The value specified by the platform configuration.
c. The value specified by the board configuration.
d. The kernel’s default value for the configuration option.
.. note::
When the default platform configuration settings are sufficient for your
When the default board configuration settings are sufficient for your
application, a :file:`prj.conf` file is not needed. Skip ahead to
:ref:`override_kernel_conf`.
@ -35,7 +35,7 @@ Procedures
The procedures that follow describe how to configure a :file:`prj.conf`
file and how to configure kernel options for microkernel and nanokernel
applications. For information on how to work with kernel option
inter-dependencies and platform configuration-default options, see the
inter-dependencies and board configuration-default options, see the
:ref:`configuration`.
.. note::
@ -50,10 +50,10 @@ Defining the Application's Default Kernel Configuration
Create a :file:`prj.conf` file to define the application's
default kernel configuration. This file can contain
settings that override or augment platform-configuration settings.
settings that override or augment board-configuration settings.
The contents of the supported platform configuration files
can be viewed in :file:`~/rootDir/architectureDir/configs`.
The contents of the supported board configuration files
can be viewed in :file:`~/rootDir/boards/BOARD/BOARD_defconfig`.
Before you begin
----------------
@ -85,7 +85,7 @@ Steps
d) Use a # followed by a space to comment a line.
This example shows a comment line and a platform
This example shows a comment line and a board
configuration override in the :file:`prj.conf`.
.. code-block:: c

6
doc/application/apps_run.rst
View file

@ -21,7 +21,7 @@ Prerequisites
-------------
* You must have already generated a .elf image file for a
QEMU-supported platform configuration, such as
QEMU-supported board configuration, such as
basic_cortex_m3 or basic_minuteia.
* The environment variable must be set for each console
@ -57,6 +57,6 @@ Loading and Running an Application on Target Hardware
An application image is loaded on the target based on functionality
available on the hardware device. Loading instructions are often
unique to the particular target board. For this reason, loading
instructions reside with the platform-specific documentation.
instructions reside with the board-specific documentation.
For more information see :ref:`platform`.
For more information see :ref:`board`.

12
doc/application/apps_structure.rst
View file

@ -74,7 +74,7 @@ Creating an Application Makefile
================================
Create an application Makefile to define basic information such as the kernel
type, microkernel or nanokernel, and the platform configuration used by the
type, microkernel or nanokernel, and the board configuration used by the
application. The build system uses the Makefile to build an image with both
the application and the kernel libraries called either
:file:`microkernel.elf` or :file:`nanokernel.elf`.
@ -84,8 +84,8 @@ Before You Begin
* Be familiar with the standard GNU Make language.
* Be familiar with the platform configuration used for your application
and, if it is a custom platform configuration, where it is located.
* Be familiar with the board configuration used for your application
and, if it is a custom board configuration, where it is located.
* Set the environment variable for each console terminal using
:ref:`set_environment_variables`.
@ -115,14 +115,14 @@ Steps
Either micro or nano, short for microkernel or
nanokernel respectively.
b) Add the name of the platform configuration for your application on a
b) Add the name of the board configuration for your application on a
new line:
.. code-block:: make
BOARD ?= platform_configuration_name
BOARD ?= board_configuration_name
The supported platforms can be found in :ref:`platform`.
The supported boards can be found in :ref:`board`.
c) Add the name of the default kernel configuration file for your
application on a new line:

2
doc/kernel/common/common_float.rst
View file

@ -11,7 +11,7 @@ Concepts
********
The kernel allows an application's tasks and fibers to use floating point
registers on platform configurations that support these registers.
registers on board configurations that support these registers.
Threads that use the x87 FPU/MMX registers are known as "FPU users",
while threads that use SSE registers are known as "SSE users".

2
doc/kernel/nanokernel/nanokernel_fibers.rst
View file

@ -30,7 +30,7 @@ include:
The kernel may automatically spawn zero or more system fibers during system
initialization. The specific set of fibers spawned depends on the kernel
capabilities that have been configured by the application and by the
platform configuration used to build the application image.
board configuration used to build the application image.
Fiber Lifecycle
===============

2
doc/kernel/overview/application_fundamentals.rst
View file

@ -23,7 +23,7 @@ following files.
* **Makefile**: This file typically contains a handful of lines that tell the build
system where to find the files mentioned above, as well as the desired target
platform configuration and kernel type (either microkernel or nanokernel).
board configuration and kernel type (either microkernel or nanokernel).
Once the application has been defined, it can be built with a single command.
The results of the build process, including the final application image,

4
doc/kernel/overview/kernel_fundamentals.rst
View file

@ -344,10 +344,10 @@ Device Driver Library
*********************
The Zephyr kernel supports a variety of device drivers. The specific set of
device drivers available for an application's platform configuration varies
device drivers available for an application's board configuration varies
according to the associated hardware components and device driver software.
Device drivers which are present on all supported platform configurations
Device drivers which are present on all supported board configurations
are listed below.
* **Interrupt controller**: This device driver is used by the nanokernel's

2
doc/kernel/overview/source_tree.rst
View file

@ -15,7 +15,7 @@ which are not described here.
* architecture-specific nanokernel source files
* architecture-specific nanokernel include files for private APIs
* platform-specific code
* platform configuration files
* board configuration files
:file:`doc`
Zephyr documentation-related material and tools.

10
doc/kernel/overview/system_fundamentals.rst
View file

@ -21,10 +21,10 @@ least one Makefile. The application's kernel configuration settings enable the b
system to create a kernel tailor-made to meet the needs of the application
and to make the best use of the system's resources.
The Zephyr Kernel supports a variety of target systems, known as *platforms*;
each :dfn:`platform` has its own set of hardware devices and capabilities. One or more
*platform configurations* are defined for a given platform; each
:dfn:`platform configuration` indicates how the devices that may be present on the
platform are to be used by the kernel. The platform and platform configuration concepts
The Zephyr Kernel supports a variety of target systems, known as *boards*;
each :dfn:`board` has its own set of hardware devices and capabilities. One or more
*board configurations* are defined for a given board; each
:dfn:`board configuration` indicates how the devices that may be present on the
board are to be used by the kernel. The board and board configuration concepts
make it possible to develop a single application that can be used by a set of related
target systems, or even target systems based on different CPU architectures.

18
doc/platform/basic_minuteia.rst
View file

@ -1,13 +1,13 @@
.. _basic_minuteia:
Platform Configuration: basic_minuteia
Board Configuration: basic_minuteia
######################################
Overview
********
The Zephyr Kernel uses the basic_minuteia platform configuration
to emulate the galileo platform (or something similar) running on QEMU.
The Zephyr Kernel uses the basic_minuteia board configuration
to emulate the galileo board (or something similar) running on QEMU.
It provides support for an x86 Minute IA CPU and the following devices:
* HPET
@ -17,18 +17,18 @@ It provides support for an x86 Minute IA CPU and the following devices:
* NS16550 UART
.. note::
This platform configuration makes no claims about its suitability for use
This board configuration makes no claims about its suitability for use
with actual galileo hardware, or any other hardware.
Supported Boards
****************
The basic_minuteia platform configuration has been tested on QEMU 2.1.
The basic_minuteia board configuration has been tested on QEMU 2.1.
Supported Features
******************
The basic_minuteia platform configuration supports the following
The basic_minuteia board configuration supports the following
hardware features:
+--------------+------------+-----------------------+
@ -50,18 +50,18 @@ Interrupt Controller
Refer to the :ref:`galileo`.
.. note::
The basic_minuteia platform configuration does not support PCI.
The basic_minuteia board configuration does not support PCI.
HPET System Clock Support
=========================
The basic_minuteia platform configuration uses an HPET clock frequency
The basic_minuteia board configuration uses an HPET clock frequency
of 25 MHz.
Serial Port
===========
The basic_minuteia platform configuration uses a single serial
The basic_minuteia board configuration uses a single serial
communication channel that uses the NS16550 serial driver
operating in polling mode. To override, enable the UART_INTERRUPT_DRIVEN
Kconfig option, which allows the system to be interrupt-driven.

18
doc/platform/fsl_frdm_k64f.rst
View file

@ -1,12 +1,12 @@
.. _fsl_frdm_k64f:
Platform Configuration: fsl_frdm_k64f
Board Configuration: fsl_frdm_k64f
#####################################
Overview
********
The fsl_frdm_k64f platform configuration is used by Zephyr applications
The fsl_frdm_k64f board configuration is used by Zephyr applications
that run on the Freescale Freedom Development Platform (FRDM-K64F).
It provides support for an ARM Cortex-M4 CPU and the following devices:
@ -22,13 +22,13 @@ Zephyr application image on the target. Debugging is
done with GNU Debugger (GDB), using Eclipse plugins.
.. note::
This platform configuration may work with similar boards,
This board configuration may work with similar boards,
but they are not officially supported.
Supported Boards
****************
The fsl_frdm_k64f platform configuration has been tested to run on the
The fsl_frdm_k64f board configuration has been tested to run on the
Freescale Freedom Development Platform. The physical characteristics of
this board (including pin names, jumper settings, memory mappings, ...)
can be found below. No claims are made about its suitability for use with
@ -110,7 +110,7 @@ The default switch settings for the Freescale FRDM-K64F are:
Memory Mappings
===============
The fsl_frdm_k64f platform configuration uses the
The fsl_frdm_k64f board configuration uses the
following default hardware memory map addresses and sizes:
+--------------------------+---------+------------------+
@ -182,7 +182,7 @@ http://infocenter.arm.com/help/topic/com.arm.doc.dui0552a/DUI0552A_cortex_m3_dgu
Supported Features
******************
The fsl_frdm_k64f platform configuration supports the following
The fsl_frdm_k64f board configuration supports the following
hardware features:
+--------------+------------+----------------------+
@ -421,7 +421,7 @@ Configuration Options
Set to 'n' only when there is a good reason to do it.
:option:`NUM_IRQ_PRIO_BITS`
The platform configuration sets this to the correct value for the board
The board configuration sets this to the correct value for the board
("4" for FRDM board, IIRC).
:option:`RUNTIME_NMI`
@ -432,11 +432,11 @@ Configuration Options
enable this option and attach it via _NmiHandlerSet().
:option:`NUM_IRQS`
The platform configuration sets this value to the correct number of
The board configuration sets this value to the correct number of
interrupts available on the board. The default is '34'.
:option:`SW_ISR_TABLE`
Set to 'n' when the platform configuration does not provide one.
Set to 'n' when the board configuration does not provide one.
:option:`SW_ISR_TABLE_DYNAMIC`
Set to 'n' to override the default.

18
doc/platform/galileo.rst
View file

@ -1,15 +1,15 @@
.. _galileo:
Platform Configuration: galileo
Board Configuration: galileo
###############################
Overview
********
Developers can use the galileo platform configuration
Developers can use the galileo board configuration
to build a Zephyr Kernel that runs on a Galileo Development Board (Gen 1 or Gen 2).
This platform configuration enables kernel support for the board's Quark SoC,
This board configuration enables kernel support for the board's Quark SoC,
along with the following devices:
* High Precision Event Timer (HPET)
@ -21,14 +21,14 @@ along with the following devices:
See `Procedures`_ for using third-party tools to load an image onto the target.
.. note::
This platform configuration may work with similar boards
This board configuration may work with similar boards
that are not officially supported.
Supported Boards
****************
This section provides information about the physical characteristics of boards
that the galileo platform configuration supports.
that the galileo board configuration supports.
Subsections contain detailed information on pin names, jumper settings, memory mappings,
and board component layout.
@ -66,7 +66,7 @@ For more information, see page 14 of the
Memory Mappings
===============
The galileo platform configuration uses default hardware memory map
The galileo board configuration uses default hardware memory map
addresses and sizes.
For a list of memory mapped registers, see page 868 of the
@ -86,7 +86,7 @@ For a block diagram, see page 38 of the `Intel® Quark SoC X1000 Datasheet`_.
Supported Features
******************
The galileo platform configuration supports the following hardware features:
The galileo board configuration supports the following hardware features:
* HPET
@ -146,7 +146,7 @@ For more information, see `Intel® Quark SoC X1000 Datasheet`_, section 21.12.1.
Interrupt Controller
====================
The galileo platform configuration uses the kernel's static
The galileo board configuration uses the kernel's static
Interrupt Descriptor Table (IDT) to program the
Advanced Programmable Interrupt Controller (APIC)
interrupt redirection table.
@ -225,7 +225,7 @@ application image on a Galileo board. The following instructions apply to both
devices.
#. Set the platform configuration to Galileo by changing the :command:`make`
#. Set the board configuration to Galileo by changing the :command:`make`
command to:
.. code-block:: console

20
doc/platform/minnowboard.rst
View file

@ -1,14 +1,14 @@
.. _minnowboard:
Platform Configuration: Minnowboard Max
Board Configuration: Minnowboard Max
#######################################
Overview
********
The minnowboard platform configuration is used by Zephyr applications
that run on QEMU emulating the Atom N28xx platform. This platform
configuration provides support for an x86 Atom CPU and the following devices:
The minnowboard board configuration is used by Zephyr applications
that run on QEMU emulating the Atom N28xx platform. This configuration
provides support for an x86 Atom CPU and the following devices:
* HPET
@ -17,18 +17,18 @@ configuration provides support for an x86 Atom CPU and the following devices:
* NS16550 UART
.. note::
This platform configuration makes no claims about its suitability for use
This board configuration makes no claims about its suitability for use
with an actual Atom N28xx hardware system, or any other hardware system.
Supported Boards
****************
The minnowboard platform configuration has been tested on QEMU 2.1.
The minnowboard board configuration has been tested on QEMU 2.1.
Supported Features
******************
The minnowboard platform configuration supports the following
The minnowboard board configuration supports the following
hardware features:
+--------------+------------+-----------------------+
@ -49,12 +49,12 @@ Interrupt Controller
Refer to the :ref:`galileo`.
.. note::
The minnowboard platform configuration does not support PCI.
The minnowboard board configuration does not support PCI.
HPET System Clock Support
=========================
The minnowboard platform configuration uses a system clock frequency of 25 MHz.
The minnowboard board configuration uses a system clock frequency of 25 MHz.
.. note::
The LOAPIC timer may be used instead of the HPET. To do so,
@ -63,7 +63,7 @@ The minnowboard platform configuration uses a system clock frequency of 25 MHz.
Serial Port
===========
The minnowboard platform configuration uses a single serial communication channel
The minnowboard board configuration uses a single serial communication channel
with a NS16550 serial driver that operates in polling mode.
For an interrupt-driven driver, enable the UART_INTERRUPT_DRIVEN kernel configuration option.

24
doc/platform/platform.rst
View file

@ -1,15 +1,15 @@
.. _platform:
.. _board:
Supported Platforms
Supported Boards
###################
The Zephyr Kernel supports the platform configurations listed in the
table below. An application can use a platform configuration as is,
or it can customize a platform configuration by changing its default
The Zephyr Kernel supports the board configurations listed in the
table below. An application can use a board configuration as is,
or it can customize a board configuration by changing its default
kernel configuration settings.
.. note::
Developers can create new platform configurations
Developers can create new board configurations
that allow an application to run on other target systems.
+----------------------+-----------------+------------------------+
@ -18,9 +18,15 @@ kernel configuration settings.
+======================+=================+========================+
| minnowboard | X86 | Minnowboard Max |
+----------------------+-----------------+------------------------+
| basic_cortex_m3 | ARM v7-M | QEMU 2.1 + patch |
| qemu_cortex_m3 | ARM v7-M | QEMU 2.1 + patch |
+----------------------+-----------------+------------------------+
| basic_minuteia | X86 | QEMU 2.1 |
| qemu_x86 | X86 | QEMU 2.1 |
+----------------------+-----------------+------------------------+
| quark_d2000_crb | X86 | Quark D2000 Boards |
+----------------------+-----------------+------------------------+
| quark_se_ctb | X86 | Quark SE Boards |
+----------------------+-----------------+------------------------+
| arduino_101 | X86 | Arduino 101 Board |
+----------------------+-----------------+------------------------+
| fsl_frdm_k64f | ARM v7E-M | Freescale Freedom |
| | | Development Platform |
@ -35,7 +41,7 @@ The following sections provide details on the respective platforms:
:maxdepth: 1
minnowboard.rst
basic_cortex_m3.rst
qemu_cortex_m3.rst
basic_minuteia.rst
fsl_frdm_k64f.rst
galileo.rst

20
doc/platform/basic_cortex_m3.rst → doc/platform/qemu_cortex_m3.rst
View file

@ -1,12 +1,12 @@
.. _basic_cortex_m3:
.. _qemu_cortex_m3:
Platform Configuration: basic_cortex_m3
Board Configuration: qemu_cortex_m3
#######################################
Overview
********
The Zephyr kernel uses the basic_cortex_m3 platform configuration
The Zephyr kernel uses the qemu_cortex_m3 board configuration
to emulate the TI LM3S6965 platform running on QEMU. It provides support
for an ARM Cortex-M3 CPU and the following devices:
@ -17,20 +17,20 @@ for an ARM Cortex-M3 CPU and the following devices:
* Stellaris UART
.. note::
This platform configuration makes no claims about its suitability for use
This board configuration makes no claims about its suitability for use
with an actual ti_lm3s6965 hardware system, or any other hardware system.
Supported Boards
****************
The basic_cortex_m3 platform configuration has been tested on
The qemu_cortex_m3 board configuration has been tested on
QEMU 2.1 patched with Zephyr's
:file:`0001-armv7m-support-basepri-primask-interrupt-locking.patch`.
Supported Features
******************
The basic_cortex_m3 platform configuration supports the following
The qemu_cortex_m3 board configuration supports the following
hardware features:
+--------------+------------+----------------------+
@ -54,18 +54,18 @@ Interrupt Controller
Refer to the :ref:`fsl_frdm_k64f`.
.. note::
Unlike the fsl_frdm_k64 platform configuration, the basic_cortex_m3
platform configuration sets option :option:`NUM_IRQ_PRIO_BITS` to '3'.
Unlike the fsl_frdm_k64 board configuration, the qemu_cortex_m3
board configuration sets option :option:`NUM_IRQ_PRIO_BITS` to '3'.
System Clock
============
The basic_cortex_m3 platform configuration uses a system
The qemu_cortex_m3 board configuration uses a system
clock frequency of 12 MHz.
Serial Port
===========
The basic_cortex_m3 platform configuration uses a single
The qemu_cortex_m3 board configuration uses a single
serial communication channel with the CPU's UART0.
Known Problems or Limitations

6
doc/quick_start/application.rst
View file

@ -59,19 +59,19 @@ use QEMU with some of the supported platforms and architecture. This can be easi
accomplished by calling a special target when building an application that
invokes Qemu once the build process is completed.
To run an application using the default platform configuration, type:
To run an application using the default board configuration, type:
.. code-block:: console
$ make qemu
To run an application using the x86 minnowboard platform configuration, type:
To run an application using the x86 minnowboard board configuration, type:
.. code-block:: console
$ make BOARD=qemu_x86 qemu
To run an application using the ARM basic_cortex_m3 platform configuration, type:
To run an application using the ARM basic_cortex_m3 board configuration, type:
.. code-block:: console

2
doc/reference/kbuild/kbuild_kconfig.rst
View file

@ -87,7 +87,7 @@ example:
$ make galileo_defconfig
The command takes the default configuration for the architecture
and the galileo platform configuration to compile the kernel.
and the galileo board configuration to compile the kernel.
.. _configuration_snippets: