Documentatin updated; fix errors in some comments

This commit is contained in:
Gregory Nutt 2014-03-28 09:52:07 -06:00
parent 1e7a14ed2e
commit f12e37cae4
20 changed files with 68 additions and 100 deletions

View File

@ -47,7 +47,7 @@
****************************************************************************************************/
/* SAMA5D3 Family
*
* ATSAMA5D31 ATSAMA5D33 ATSAMA5D34 ATSAMA5D35 ATSAMA5D35
* ATSAMA5D31 ATSAMA5D33 ATSAMA5D34 ATSAMA5D35 ATSAMA5D36
* ------------------------- ------------- ------------- ------------- ------------- -------------
* Pin Count 324 324 324 324 324
* Max. Operating Frequency 536 MHz 536 MHz 536 MHz 536 MHz 536 MHz
@ -64,7 +64,7 @@
* LIN 4 4 4 4 4
* SSC 2 2 2 2 2
* Ethernet 1 1 1 2 2
* SD / eMMC 3 2 3 2 2
* SD / eMMC 3 2 3 2 3
* Graphic LCD Yes Yes Yes - Yes
* Camera Interface Yes Yes Yes Yes Yes
* ADC channels 12 12 12 12 12

View File

@ -323,8 +323,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project
Makefile Build
--------------
@ -350,7 +349,7 @@ IDEs
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -115,8 +115,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -140,9 +139,9 @@ IDEs
on the command line.
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/lpc31xx/lpc31_vectors.S. With RIDE, I have to build NuttX
is arch/arm/src/lpc31xx/lpc31_vectors.S. You may have to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX buildroot Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -114,8 +114,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project
Makefile Build
--------------
@ -139,9 +138,9 @@ IDEs
on the command line.
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/lpc31xx/lpc31_vectors.S. With RIDE, I have to build NuttX
is arch/arm/src/lpc31xx/lpc31_vectors.S. You may have to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX buildroot Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -165,9 +165,7 @@ Development Environment
Either Linux or Cygwin on Windows can be used for the development environment.
The source has been built only using the GNU toolchain (see below). Other
toolchains will likely cause problems. Testing was performed using the Cygwin
environment because the CodeSourcery Toolchain. The Raisonance R-Link
emulatator and some RIDE7 development tools were used and those tools works
only under Windows.
environment because the CodeSourcery Toolchain.
GNU Toolchain Options
=====================
@ -273,8 +271,7 @@ IDEs
====
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -298,9 +295,9 @@ IDEs
on the command line.
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX
is arch/arm/src/stm32/stm32_vectors.S. You many have to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
================================

View File

@ -25,8 +25,7 @@ Development Environment
Either Linux or Cygwin on Windows can be used for the development environment.
The source has been built only using the GNU toolchain (see below). Other
toolchains will likely cause problems. Testing was performed using the Cygwin
environment because the Raisonance R-Link emulatator and some RIDE7 development tools
were used and those tools works only under Windows.
environment.
GNU Toolchain Options
=====================
@ -94,8 +93,7 @@ IDEs
====
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -119,9 +117,9 @@ IDEs
on the command line.
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX
is arch/arm/src/stm32/stm32_vectors.S. You many have to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
================================

View File

@ -118,8 +118,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------

View File

@ -88,8 +88,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------

View File

@ -134,8 +134,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------

View File

@ -148,8 +148,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------

View File

@ -120,8 +120,7 @@ IDEs
====
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -145,9 +144,9 @@ IDEs
on the command line.
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/lpc31xx/lpc31_vectors.S. With RIDE, I have to build NuttX
is arch/arm/src/lpc31xx/lpc31_vectors.S. You may have to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX buildroot Toolchain
=========================

View File

@ -234,8 +234,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------

View File

@ -98,8 +98,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -125,7 +124,7 @@ IDEs
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -95,8 +95,7 @@ IDEs
====
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -122,7 +121,7 @@ IDEs
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
================================

View File

@ -258,8 +258,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -285,7 +284,7 @@ IDEs
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -151,8 +151,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -178,7 +177,7 @@ IDEs
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -66,7 +66,6 @@ Contents
- GNU Toolchain Options
- IDEs
- NuttX EABI "buildroot" Toolchain
- NuttX OABI "buildroot" Toolchain
- NXFLAT Toolchain
- Loading Code into SRAM with J-Link
- Writing to FLASH using SAM-BA
@ -129,12 +128,9 @@ GNU Toolchain Options
CONFIG_ARMV7A_TOOLCHAIN_GNU_EABIW=y : Generic GCC ARM EABI toolchain for Windows
The CodeSourcery GCC toolchain is selected with
CONFIG_ARMV7A_TOOLCHAIN_GNU_EABIW=y and setting the PATH variable
CONFIG_ARMV7A_TOOLCHAIN_CODESOURCERYW=y and setting the PATH variable
appropriately.
If you are not using AtmelStudio GCC toolchain, then you may also have to
modify the PATH in the setenv.h file if your make cannot find the tools.
NOTE about Windows native toolchains
------------------------------------
@ -165,20 +161,11 @@ GNU Toolchain Options
MKDEP = $(TOPDIR)/tools/mknulldeps.sh
NOTE 1: Older CodeSourcery toolchains (2009q1) do not work with default
optimization level of -Os (See Make.defs). It will work with -O0, -O1, or
-O2, but not with -Os.
NOTE 2: The devkitARM toolchain includes a version of MSYS make. Make sure that
the paths to Cygwin's /bin and /usr/bin directories appear BEFORE the devkitARM
path or will get the wrong version of make.
IDEs
====
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -204,7 +191,7 @@ IDEs
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
================================
@ -230,9 +217,23 @@ NuttX EABI "buildroot" Toolchain
4. cd <some-dir>/buildroot
5. cp configs/cortexm3-eabi-defconfig-4.6.3 .config
5. Copy the configuration file from the configs/ sub-directory to the
top-level build directory:
6. make oldconfig
cp configs/cortexa8-eabi-defconfig-4.8.2 .config
6a. You may wish to modify the configuration before you build it. For
example, it is recommended that you build the kconfig-frontends tools,
generomfs, and the NXFLAT tools as well. You may also want to change
the selected toolchain. These reconfigurations can all be done with
make menuconfig
6b. If you chose to make the configuration with no changes, then you
should still do the following to make certain that the build
configuration is up-to-date:
make oldconfig
7. make
@ -243,21 +244,6 @@ NuttX EABI "buildroot" Toolchain
details PLUS some special instructions that you will need to follow if you are
building a Cortex-M3 toolchain for Cygwin under Windows.
NOTE: Unfortunately, the 4.6.3 EABI toolchain is not compatible with the
the NXFLAT tools. See the top-level TODO file (under "Binary loaders") for
more information about this problem. If you plan to use NXFLAT, please do not
use the GCC 4.6.3 EABI toochain; instead use the GCC 4.3.3 OABI toolchain.
See instructions below.
NuttX OABI "buildroot" Toolchain
================================
The older, OABI buildroot toolchain is also available. To use the OABI
toolchain, use the build instructions above, but (1) modify the
cortexm3-eabi-defconfig-4.6.3 configuration to use OABI (using 'make
menuconfig'), or (2) use an existing OABI configuration such as
cortexm3-defconfig-4.3.3
NXFLAT Toolchain
================
@ -291,6 +277,11 @@ NXFLAT Toolchain
8. Edit setenv.h, if necessary, so that the PATH variable includes
the path to the newly built NXFLAT binaries.
NOTE: There are some known incompatibilities with 4.6.3 EABI toolchain
and the NXFLAT tools. See the top-level TODO file (under "Binary
loaders") for more information about this problem. If you plan to use
NXFLAT, please do not use the GCC 4.6.3 EABI toochain.
Loading Code into SRAM with J-Link
==================================

View File

@ -297,8 +297,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -324,7 +323,7 @@ IDEs
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/sam34/sam_vectors.S. You may need to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -28,8 +28,7 @@ Development Environment
Either Linux or Cygwin on Windows can be used for the development environment.
The source has been built only using the GNU toolchain (see below). Other
toolchains will likely cause problems. Testing was performed using the Cygwin
environment because the Raisonance R-Link emulatator and some RIDE7 development tools
were used and those tools works only under Windows.
environment.
GNU Toolchain Options
=====================
@ -97,8 +96,7 @@ IDEs
====
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -122,9 +120,9 @@ IDEs
on the command line.
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX
is arch/arm/src/stm32/stm32_vectors.S. You may have to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
================================

View File

@ -25,8 +25,7 @@ Development Environment
Either Linux or Cygwin on Windows can be used for the development environment.
The source has been built only using the GNU toolchain (see below). Other
toolchains will likely cause problems. Testing was performed using the Cygwin
environment because the Raisonance R-Link emulatator and some RIDE7 development tools
were used and those tools works only under Windows.
environment.
GNU Toolchain Options
^^^^^^^^^^^^^^^^^^^^^
@ -94,8 +93,7 @@ IDEs
^^^^
NuttX is built using command-line make. It can be used with an IDE, but some
effort will be required to create the project (There is a simple RIDE project
in the RIDE subdirectory).
effort will be required to create the project.
Makefile Build
--------------
@ -119,9 +117,9 @@ IDEs
on the command line.
Startup files will probably cause you some headaches. The NuttX startup file
is arch/arm/src/stm32/stm32_vectors.S. With RIDE, I have to build NuttX
is arch/arm/src/stm32/stm32_vectors.S. You may have to build NuttX
one time from the Cygwin command line in order to obtain the pre-built
startup object needed by RIDE.
startup object needed by an IDE.
NuttX EABI "buildroot" Toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^