From 2c8925e08bf0ee076834a7caf292b338328e093e Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>
Date: Sat, 24 Mar 2012 17:52:10 +0000
Subject: [PATCH] Update documenation to include Calypso and the Compal phones

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4513 42af7a65-404d-4744-a932-0658087f49c3
---
 Documentation/NuttX.html      | 24 +++++++++++++++++++++++-
 Documentation/README.html     |  6 +++++-
 README.txt                    |  4 ++++
 arch/README.txt               | 33 ++++++++++++++++++++-------------
 configs/README.txt            |  6 ++++++
 configs/compal_e88/README.txt | 28 ++++++++++++++++++++++++++++
 configs/compal_e99/README.txt | 28 ++++++++++++++++++++++++++++
 7 files changed, 114 insertions(+), 15 deletions(-)
 create mode 100755 configs/compal_e88/README.txt
 create mode 100755 configs/compal_e99/README.txt

diff --git a/Documentation/NuttX.html b/Documentation/NuttX.html
index 760d49e6df..6869b6f7d6 100644
--- a/Documentation/NuttX.html
+++ b/Documentation/NuttX.html
@@ -1040,7 +1040,7 @@
   <li><a href="#linuxusermode">Linux user mode simulation</a> (1)</li>
   <li>ARM
     <ul>
-      <li><a href="#arm7tdmi">ARM7TDMI</b></a> (4)</li>
+      <li><a href="#arm7tdmi">ARM7TDMI</b></a> (5)</li>
       <li><a href="#arm920t">ARM920T</a> (1) </li>
       <li><a href="#arm926ejs">ARM926EJS</a> (3) </li>
       <li><a href="#armcortexm3">ARM Cortex-M3</a> (14)</li>
@@ -1133,6 +1133,28 @@
   <td><br></td>
   <td><hr></td>
 </tr>
+<tr>
+  <td><br></td>
+  <td>
+    <p>
+      <b>TI Calypso</b>.
+      This port supports the TI &quot;Calypso&quot; MCU used in various cell phones (and, in particular,
+      by the <a href="http://bb.osmocom.org/trac/">Osmocom-bb project</a>).
+      Like the c5471, NuttX operates on the  ARM7 of this dual core processor.
+    </p>
+    <ul>
+      <p>
+        <b>STATUS:</b>
+        This port was contributed by  Denis Carilki and includes the work of Denis, Alan Carvalho de Assis, and Stefan Richter.
+        Calypso support first appeared in NuttX-6.17.
+      </p>
+    </ul>
+  </td>
+</tr>
+<tr>
+  <td><br></td>
+  <td><hr></td>
+</tr>
 <tr>
   <td><br></td>
   <td>
diff --git a/Documentation/README.html b/Documentation/README.html
index cd654d6d2e..26930283f2 100644
--- a/Documentation/README.html
+++ b/Documentation/README.html
@@ -8,7 +8,7 @@
   <tr align="center" bgcolor="#e4e4e4">
     <td>
       <h1><big><font color="#3c34ec"><i>NuttX README Files</i></font></big></h1>
-      <p>Last Updated: March 9, 2012</p>
+      <p>Last Updated: March 24, 2012</p>
     </td>
   </tr>
 </table>
@@ -58,6 +58,10 @@
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/c5471evm/include/README.txt?view=log">include/README.txt</a>
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/c5471evm/src/README.txt?view=log">src/README.txt</a>
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/c5471evm/README.txt?view=log"><b><i>README.txt</i></b></a>
+ |   |   |- compal_e88/
+ |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/compal_e88/README.txt?view=log"><b><i>README.txt</i></b></a>
+ |   |   |- compal_e99/
+ |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/compal_e99/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   |- demo9s12ne64/
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/demo9s12ne64/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   |- ea3131/
diff --git a/README.txt b/README.txt
index 12edb24988..9b5bf8bdf0 100755
--- a/README.txt
+++ b/README.txt
@@ -542,6 +542,10 @@ nuttx
  |   |   |- include/README.txt
  |   |   |- src/README.txt
  |   |   `- README.txt
+ |   |- compal_e88
+ |   |   `- README.txt
+ |   |- compal_e99
+ |   |   `- README.txt
  |   |- demo0s12ne64/
  |   |   `- README.txt
  |   |- ea3131/
diff --git a/arch/README.txt b/arch/README.txt
index 177f37d803..67b99b255d 100644
--- a/arch/README.txt
+++ b/arch/README.txt
@@ -146,12 +146,19 @@ arch/arm - ARM-based micro-controllers
 
     arch/arm/src/armv7-m and arch/arm/include/armv7-m
         Common ARMv7-M logic (Cortex-M3 and Cortex-M4)
-        
+
     arch/arm/include/c5471 and arch/arm/src/c5471
         TI TMS320C5471 (also called TMS320DM180 or just C5471).
         NuttX operates on the ARM7 of this dual core processor. This port
         complete, verified, and included in the NuttX release 0.1.1.
 
+    arch/arm/include/calypso and arch/arm/src/calypso
+        TI "Calypso" MCU used in various cell phones (and, in particular,
+        by the Osmocom-bb project).  Like the c5471, NuttX operates on the
+        ARM7 of this dual core processor. This port was contributed by
+        Denis Carilki and includes the work of Denis, Alan Carvalho de Assis,
+        and Stefan Richter.  Calypso support first appeared in NuttX-6.17.
+
     arch/arm/include/dm320 and arch/arm/src/dm320
         TI TMS320DM320 (also called just DM320).
         NuttX operates on the ARM9EJS of this dual core processor.  This port
@@ -185,8 +192,8 @@ arch/arm - ARM-based micro-controllers
         complete and verified. As of NuttX 5.3, the port includes only basic
         timer interrupts and serial console support.
 
-    arch/arm/include/lpc313x and arch/arm/src/lpc313x
-        These directories provide support for NXP LPC313x family of
+    arch/arm/include/lpc31xx and arch/arm/src/lpc31xx
+        These directories provide support for NXP LPC31xx family of
         ARM926EJ-S processors.  The port for the NXP LPC3131 was first
         released in NuttX-5.1 (but was not functional until NuttX-5.2).
         STATUS: The basic EA3131 port is complete and verified in NuttX-5.2
@@ -196,6 +203,9 @@ arch/arm - ARM-based micro-controllers
         verified using the NuttX OS test, USB serial and mass storage tests
         and includes a working implementation of the NuttShell ((NSH)).
 
+        This port was later extended to support additional members of the
+        LPC31xx family including, specifically, the LPC3152.
+
     arch/arm/include/sam3u and arch/arm/src/sam3u
         Atmel AT91SAM3U. This port is for Atmel AT91SAM3U4E MCU.
         STATUS: The basic AT91SAM3U port was released in NuttX version 5.1.
@@ -205,16 +215,13 @@ arch/arm - ARM-based micro-controllers
         onfiguration to support the NuttShell is also included.
 
     arch/arm/include/stm32 and arch/arm/src/stm32
-        These directories contain support for the STMicro STM32 family, particularly
-        for the STM32F103ZET6. 
-        STATUS: The basic STM32 port was released in NuttX version 0.4.12.
-        The basic port includes boot-up logic, interrupt driven serial console,
-        and system timer interrupts. The 0.4.13 release added support for SPI,
-        serial FLASH, and USB device.; The 4.14 release added support for
-        buttons and SDIO-based MMC/SD and verifed DMA support. Verified
-        configurations are available for NuttX OS test, the NuttShell (NSH)
-        example, the USB serial device class, and the USB mass storage device 
-        lass example. 
+        These directories contain support for the STMicro STM32 F1, F2, and
+        F4 families.
+
+        STATUS: The basic STM32 F1 port was released in NuttX version 0.4.12.
+        and has continued to develop consistently over time.  It now includes
+        support for the F2 and F4 families and a rich offering of peripheral
+        drivers.
 
     arch/arm/include/str71x and arch/arm/src/str71x
         These directories provide support for the STMicro STR71x processors.
diff --git a/configs/README.txt b/configs/README.txt
index 78f6a97335..d587b1115f 100644
--- a/configs/README.txt
+++ b/configs/README.txt
@@ -1347,6 +1347,12 @@ configs/c5471evm
   NuttX runs on the ARM core and is built with a GNU arm-elf toolchain*.
   This port is complete and verified.
 
+configs/compal_e88 and compal_e99
+  These directories contain the board support for compal e88 and e99 phones.
+  These ports are based on patches contributed by Denis Carikli for both the
+  compal e99 and e88.  The patches were made by Alan Carvalho de Assis and
+  Denis Carikli using the Stefan Richter's Osmocom-bb patches.
+
 configs/demo9s12ne64
   Feescale DMO9S12NE64 board based on the MC9S12NE64 hcs12 cpu.  This
   port uses the m9s12x GCC toolchain.  STATUS:  (Still) under development; it
diff --git a/configs/compal_e88/README.txt b/configs/compal_e88/README.txt
new file mode 100755
index 0000000000..fb45fb1d6c
--- /dev/null
+++ b/configs/compal_e88/README.txt
@@ -0,0 +1,28 @@
+compal_e88
+==========
+
+This directory contains the board support for compal e88 phones.
+
+This port is based on patches contributed by Denis Carikli for both the
+compal e99 and e88. At the time of initial check-in, the following phones
+were tested:
+
+* motorolla c155 (compal e99) with the compalram and highram configuration
+* motorolla W220 (compal e88)
+* The openmoko freerunner baseband(compal e88)
+
+The patches were made by Alan Carvalho de Assis and Denis Carikli using
+the Stefan Richter's patches that can be found here:
+
+http://cgit.osmocom.org/cgit/nuttx-bb/log/?h=lputt%2Ftesting
+
+http://bb.osmocom.org/trac/wiki/nuttx-bb/run detail the usage of nuttx with
+sercomm(the transport used by osmocom-bb that runs on top of serial).
+
+The way of loading nuttx(which is also documented in osmocom-bb wiki) depend
+on the configuration(highram/compalram) and phone:
+
+compalram is for the ramloader(for phone having a bootloader on flash)
+highram is for phones having the romloader(if the phone has a bootrom) or for
+loading in the ram trough a special loader(loaded first on ram by talking to
+the ramloader) when having a ramloader(which can only load 64k).
diff --git a/configs/compal_e99/README.txt b/configs/compal_e99/README.txt
new file mode 100755
index 0000000000..905843dcef
--- /dev/null
+++ b/configs/compal_e99/README.txt
@@ -0,0 +1,28 @@
+compal_e99
+==========
+
+This directory contains the board support for compal e99 phones.
+
+This port is based on patches contributed by Denis Carikli for both the
+compal e99 and e88. At the time of initial check-in, the following phones
+were tested:
+
+* motorolla c155 (compal e99) with the compalram and highram configuration
+* motorolla W220 (compal e88)
+* The openmoko freerunner baseband(compal e88)
+
+The patches were made by Alan Carvalho de Assis and Denis Carikli using
+the Stefan Richter's patches that can be found here:
+
+http://cgit.osmocom.org/cgit/nuttx-bb/log/?h=lputt%2Ftesting
+
+http://bb.osmocom.org/trac/wiki/nuttx-bb/run detail the usage of nuttx with
+sercomm(the transport used by osmocom-bb that runs on top of serial).
+
+The way of loading nuttx(which is also documented in osmocom-bb wiki) depend
+on the configuration(highram/compalram) and phone:
+
+compalram is for the ramloader(for phone having a bootloader on flash)
+highram is for phones having the romloader(if the phone has a bootrom) or for
+loading in the ram trough a special loader(loaded first on ram by talking to
+the ramloader) when having a ramloader(which can only load 64k).