bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

platform doc: Clean up section names

Browse Source 
Fixes up section names and the table of contents so that they align with
each other.  This necessitates a little reworking of content and relocation
of sections.

Change-Id: Ib9766f2090cf949eaf9a0d7686d496301b88a407
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
This commit is contained in:
Peter Mitsis 2015-08-25 13:11:27 -04:00 committed by Anas Nashif
parent d50f786145
commit 7752ddff16
2 changed files with 69 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
doc/platform/fsl_frdm_k64f.rst
View File

@ -1,8 +1,8 @@
.. _fsl_frdm_k64f:
====================================
fsl_frdm_k64f Platform Configuration
====================================
=====================================
Platform Configuration: fsl_frdm_k64f
=====================================
.. -----------------
.. Table of Contents
@ -11,24 +11,19 @@ fsl_frdm_k64f Platform Configuration
.. INTRODUCTION
..
.. Overview
.. Known Problems and Limitation
.. Supported Boards
.. Verification
.. SUPPORTED HARDWARE
.. frdm k64f Pin Names
.. SUPPORTED BOARDS
.. Pin Names
.. Jumpers & Switches
.. Memory Maps
.. Component Layout
..
.. SUPPORTED FEATURES
.. IRQ Controller and Vectored Exceptions Support
.. IRQ Controller and Vectored Exceptions
.. Interrupts
.. Interrupt Tables
.. Controlled Interrupt Table Options
.. System Clock (Frequency) Support
.. Serial Port Support
.. Unsupported Features
..
.. PROCEDURES
.. Loading a Project Image with mbed
@ -37,6 +32,10 @@ fsl_frdm_k64f Platform Configuration
.. Configuring the J-Link Debugger
.. Programming Flash with J-link
.. KNOWN PROBLEMS AND LIMITATIONS
.. BIBLIOGRAPHY
--------------
INTRODUCTION
@ -45,8 +44,8 @@ fsl_frdm_k64f Platform Configuration
This section provides an overview of the fsl_frdm_k64f platform configuration.
Configuration Overview
======================
Overview
========
The fsl_frdm_k64f platform configuration is used by Zephyr projects
that run on the Freescale Freedom Development Platform (FRDM-K64F).
@ -69,29 +68,14 @@ but they are not officially supported.
Known Problems or Limitations
-----------------------------
-----------------
SUPPORTED BOARDS
-----------------
There is no support for the following:
* Memory protection through optional MPU.
However, using a XIP kernel effectively provides
TEXT/RODATA write protection in ROM.
* SRAM at addresses 0x1FFF0000-0x0x1FFFFFFF
* Writing to the hardware's flash memory
--------------------
SUPPORTED HARDWARE
--------------------
This section describes the physical characteristics of
the board that is supported by the fsl_frdm_k64f platform configuration.
Subsections provide information on pin names, jumper
settings, memory mappings and a link to the board's component layout.
The fsl_frdm_k64f platform 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.
Pin Names
@ -853,6 +837,21 @@ Steps
h
--------------------------------
KNOWN PROBLEMS AND LIMITATIONS
--------------------------------
There is no support for the following:
* Memory protection through optional MPU.
However, using a XIP kernel effectively provides
TEXT/RODATA write protection in ROM.
* SRAM at addresses 0x1FFF0000-0x0x1FFFFFFF
* Writing to the hardware's flash memory
--------------
BIBLIOGRAPHY

69
doc/platform/galileo.rst
View File

@ -1,8 +1,8 @@
.. _galileo:
==============================
galileo Platform Configuration
==============================
===============================
Platform Configuration: galileo
===============================
.. -----------------
.. Table of Contents
@ -11,28 +11,28 @@ galileo Platform Configuration
.. INTRODUCTION
..
.. Overview
.. Known Problems and Limitation
.. SUPPORTED HARDWARE
.. galileo Pin Names
.. SUPPORTED BOARDS
.. Pin Names
.. Jumpers & Switches
.. Memory Maps
.. Component Layout
..
.. SUPPORTED FEATURES
.. High Precision Event Timer (HPET)
.. Peripheral Component Interconnect (PCI) bus query
.. Serial ports
.. Polling driven modes
.. Interrupt driven modes
.. Unsupported Features
.. PCI
.. Serial Port Polling Mode Support
.. Serial Port Interrupt Mode Support
.. Interrupts
.. HPET System Clock Support
..
.. PROCEDURES
.. Creating a GRUB2 Boot Loader Image from a Linux Host
.. Creating a Stripped Image
.. Preparing the Boot Device
.. Booting the Galileo Board
.. KNOWN PROBLEMS AND LIMITATIONS
.. BIBLIOGRAPHY
--------------
INTRODUCTION
@ -41,8 +41,8 @@ galileo Platform Configuration
This section provides an overview of the galileo platform configuration.
Configuration Overview
======================
Overview
========
The galileo platform configuration is used by Zephyr projects
that run on the Galileo Development Board.
@ -62,23 +62,9 @@ It provides support for a Quark CPU and the following devices:
* serial ports in polling and interrupt driven modes
Known Problems or Limitations
-----------------------------
There is no support for the following:
* Isolated Memory Regions
* Serial port in :abbr:`Direct Memory Access (DMA)` mode
* :abbr:`Serial Peripheral Interface (SPI)` flash
* :abbr:`General-Purpose Input/Output (GPIO)`
* :abbr:`Inter-Integrated Circuit (I2C)`
* Ethernet
* :abbr:`Supervisor Mode Execution Protection (SMEP)`
--------------------
SUPPORTED HARDWARE
--------------------
-----------------
SUPPORTED BOARDS
-----------------
This section either provides links to, or describes the physical
characteristics of the boards that are supported by the galileo
@ -101,8 +87,8 @@ Also, refer to page 9 of the
.. _Intel® Galileo Board User Guide: http://download.intel.com/support/galileo/sb/galileo_boarduserguide_330237_001.pdf
Jumpers
=======
Jumpers & Switches
==================
Zephyr Project uses the Galileo default jumper settings except
for the IOREF jumper which must be set to match the external
@ -508,6 +494,21 @@ Steps
Zephyr project.
--------------------------------
KNOWN PROBLEMS AND LIMITATIONS
--------------------------------
There is no support for the following:
* Isolated Memory Regions
* Serial port in :abbr:`Direct Memory Access (DMA)` mode
* :abbr:`Serial Peripheral Interface (SPI)` flash
* :abbr:`General-Purpose Input/Output (GPIO)`
* :abbr:`Inter-Integrated Circuit (I2C)`
* Ethernet
* :abbr:`Supervisor Mode Execution Protection (SMEP)`
--------------
BIBLIOGRAPHY
--------------