From 7071ca9d21d783827f93fcd25631aa2da8df8fe4 Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>
Date: Mon, 4 Feb 2013 18:46:28 +0000
Subject: Rename _TCB to struct tcb_s

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5610 42af7a65-404d-4744-a932-0658087f49c3
---
 nuttx/Documentation/NuttXDemandPaging.html | 14 +++++++-------
 nuttx/Documentation/NuttxPortingGuide.html | 24 ++++++++++++------------
 nuttx/Documentation/NuttxUserGuide.html    |  8 ++++----
 3 files changed, 23 insertions(+), 23 deletions(-)

(limited to 'nuttx/Documentation')

diff --git a/nuttx/Documentation/NuttXDemandPaging.html b/nuttx/Documentation/NuttXDemandPaging.html
index 082edd21b..baa2626c2 100644
--- a/nuttx/Documentation/NuttXDemandPaging.html
+++ b/nuttx/Documentation/NuttXDemandPaging.html
@@ -8,7 +8,7 @@
   <tr align="center" bgcolor="#e4e4e4">
     <td>
       <h1><big><font color="#3c34ec"><i>On-Demand Paging</i></font></big></h1>
-      <p>Last Updated: August 12, 2010</p>
+      <p>Last Updated: February 4, 2010</p>
     </td>
   </tr>
 </table>
@@ -306,7 +306,7 @@
 </p>
 
 <p>
-  The page fill worker thread will maintain a static variable called <code>_TCB *g_pftcb</code>.
+  The page fill worker thread will maintain a static variable called <code>struct tcb_s *g_pftcb</code>.
   If no fill is in progress, <code>g_pftcb</code> will be NULL.
   Otherwise, it will point to the TCB of the task which is receiving the fill that is in progess.
 </p>
@@ -619,7 +619,7 @@
 </p>
 <ul><dl>
   <dt>
-    <code>void up_block_task(FAR _TCB *tcb, tstate_t task_state);</code>
+    <code>void up_block_task(FAR struct tcb_s *tcb, tstate_t task_state);</code>
   </dt>
   <dd>
     The currently executing task at the head of the ready to run list must be stopped.
@@ -628,7 +628,7 @@
     page fill, and to 
   </dd>
   <dt>
-    <code>void up_unblock_task(FAR _TCB *tcb);</code>
+    <code>void up_unblock_task(FAR struct tcb_s *tcb);</code>
   </dt>
   <dd>
     A task is currently in an inactive task list but has been prepped to execute.
@@ -643,7 +643,7 @@
 
 <ul><dl>
   <dt>
-    <code>int up_checkmapping(FAR _TCB *tcb);</code>
+    <code>int up_checkmapping(FAR struct tcb_s *tcb);</code>
   </dt>
   <dd>
     The function <code>up_checkmapping()</code> returns an indication if the page fill still needs to performed or not.
@@ -651,7 +651,7 @@
     This function will prevent the same page from be filled multiple times.
   </dd>
   <dt>
-    <code>int up_allocpage(FAR _TCB *tcb, FAR void *vpage);</code>
+    <code>int up_allocpage(FAR struct tcb_s *tcb, FAR void *vpage);</code>
   </dt>
   <dd>
     This architecture-specific function will set aside page in memory and map to its correct virtual address.
@@ -661,7 +661,7 @@
     NOTE:  This function must <i>always</i> return a page allocation.
     If all available pages are in-use (the typical case), then this function will select a page in-use, un-map it, and make it available.
   </dd>
-  <dt><code>int up_fillpage(FAR _TCB *tcb, FAR const void *vpage, void (*pg_callback)(FAR _TCB *tcb, int result));</code>
+  <dt><code>int up_fillpage(FAR struct tcb_s *tcb, FAR const void *vpage, void (*pg_callback)(FAR struct tcb_s *tcb, int result));</code>
   </dt>
     The actual filling of the page with data from the non-volatile, must be performed by a separate call to the architecture-specific function, <code>up_fillpage()</code>.
     This will start asynchronous page fill.
diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index f2f7ada02..9eb114fd2 100644
--- a/nuttx/Documentation/NuttxPortingGuide.html
+++ b/nuttx/Documentation/NuttxPortingGuide.html
@@ -12,7 +12,7 @@
       <h1><big><font color="#3c34ec">
         <i>NuttX RTOS Porting Guide</i>
       </font></big></h1>
-      <p>Last Updated: January 23, 2013</p>
+      <p>Last Updated: February 4, 2013</p>
     </td>
   </tr>
 </table>
@@ -1590,7 +1590,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 </p>
 
 <h3><a name="upinitialstate">4.1.3 <code>up_initial_state()</code></a></h3>
-<p><b>Prototype</b>: <code>void up_initial_state(FAR _TCB *tcb);</code></p>
+<p><b>Prototype</b>: <code>void up_initial_state(FAR struct tcb_s *tcb);</code></p>
 
 <p><b>Description</b>.
   A new thread is being started and a new TCB has been created.
@@ -1613,7 +1613,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 </p>
 
 <h3><a name="upcreatestack">4.1.4 <code>up_create_stack()</code></a></h3>
-<p><b>Prototype</b>: <code>STATUS up_create_stack(FAR _TCB *tcb, size_t stack_size);</code></p>
+<p><b>Prototype</b>: <code>STATUS up_create_stack(FAR struct tcb_s *tcb, size_t stack_size);</code></p>
 
 <p><b>Description</b>.
   Allocate a stack for a new thread and setup
@@ -1648,7 +1648,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 
 <h3><a name="upusestack">4.1.5 <code>up_use_stack()</code></a></h3>
 <p><b>Prototype</b>: 
-  <code>STATUS up_use_stack(FAR _TCB *tcb, FAR void *stack, size_t stack_size);</code>
+  <code>STATUS up_use_stack(FAR struct tcb_s *tcb, FAR void *stack, size_t stack_size);</code>
 </p>
 
 <p><b>Description</b>.
@@ -1682,7 +1682,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 </ul>
 
 <h3><a name="upreleasestack">4.1.6 <code>up_release_stack()</code></a></h3>
-<p><b>Prototype</b>: <code>void up_release_stack(FAR _TCB *dtcb);</code></p>
+<p><b>Prototype</b>: <code>void up_release_stack(FAR struct tcb_s *dtcb);</code></p>
 
 <p><b>Description</b>.
   A task has been stopped. Free all stack
@@ -1694,7 +1694,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 </p>
 
 <h3><a name="upunblocktask">4.1.7 <code>up_unblock_task()</code></a></h3>
-<p><b>Prototype</b>: <code>void up_unblock_task(FAR _TCB *tcb);</code></p>
+<p><b>Prototype</b>: <code>void up_unblock_task(FAR struct tcb_s *tcb);</code></p>
 
 <p><b>Description</b>.
   A task is currently in an inactive task list
@@ -1717,7 +1717,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 </ul>
 
 <h3><a name="upblocktask">4.1.8 <code>up_block_task()</code></a></h3>
-<p><b>Prototype</b>: <code>void up_block_task(FAR _TCB *tcb, tstate_t task_state);</code></p>
+<p><b>Prototype</b>: <code>void up_block_task(FAR struct tcb_s *tcb, tstate_t task_state);</code></p>
 
 <p><b>Description</b>.
   The currently executing task at the head of
@@ -1760,7 +1760,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 </p>
 
 <h3><a name="upreprioritizertr">4.1.10 <code>up_reprioritize_rtr()</code></a></h3>
-<p><b>Prototype</b>: <code>void up_reprioritize_rtr(FAR _TCB *tcb, uint8_t priority);</code></p>
+<p><b>Prototype</b>: <code>void up_reprioritize_rtr(FAR struct tcb_s *tcb, uint8_t priority);</code></p>
 
 <p><b>Description</b>.
   Called when the priority of a running or
@@ -1821,7 +1821,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
 
 <h3><a name="upschedulesigaction">4.1.13 <code>up_schedule_sigaction()</code></a></h3>
 <p><b>Prototype</b>:
-  <code>void up_schedule_sigaction(FAR _TCB *tcb, sig_deliver_t sigdeliver);</code>
+  <code>void up_schedule_sigaction(FAR struct tcb_s *tcb, sig_deliver_t sigdeliver);</code>
 </p>
 
 <p><b>Description</b>.
@@ -2297,7 +2297,7 @@ else
 <h4><a name="up_addrenv_assign">4.1.21.6 <code>up_addrenv_assign()</code></a></h4>
 <p><b>Prototype</b>:<p>
 <ul>
-  <code>int up_addrenv_assign(task_addrenv_t addrenv, FAR _TCB *tcb);</code>
+  <code>int up_addrenv_assign(task_addrenv_t addrenv, FAR struct tcb_s *tcb);</code>
 </ul>
 <p><b>Description</b>:</p>
 <ul>
@@ -2316,7 +2316,7 @@ else
 <h4><a name="up_addrenv_share">4.1.21.7 <code>up_addrenv_share()</code></a></h4>
 <p><b>Prototype</b>:<p>
 <ul>
-  <code>int up_addrenv_share(FAR const _TCB *ptcb, FAR _TCB *ctcb);</code>
+  <code>int up_addrenv_share(FAR const struct tcb_s *ptcb, FAR struct tcb_s *ctcb);</code>
 </ul>
 <p><b>Description</b>:</p>
 <ul>
@@ -2336,7 +2336,7 @@ else
 <h4><a name="up_addrenv_release">4.1.21.8 <code>up_addrenv_release()</code></a></h4>
 <p><b>Prototype</b>:<p>
 <ul>
-  <code>int up_addrenv_release(FAR _TCB *tcb);</code>
+  <code>int up_addrenv_release(FAR struct tcb_s *tcb);</code>
 </ul>
 <p><b>Description</b>:</p>
 <ul>
diff --git a/nuttx/Documentation/NuttxUserGuide.html b/nuttx/Documentation/NuttxUserGuide.html
index 2704196d0..3aeb30788 100644
--- a/nuttx/Documentation/NuttxUserGuide.html
+++ b/nuttx/Documentation/NuttxUserGuide.html
@@ -13,7 +13,7 @@
       <h1><big><font color="#3c34ec"><i>NuttX Operating System<p>User's Manual</i></font></big></h1>
       <p><small>by</small></p>
       <p>Gregory Nutt<p>
-      <p>Last Updated: February 2, 2013</p>
+      <p>Last Updated: February 4, 2013</p>
     </td>
   </tr>
 </table>
@@ -342,7 +342,7 @@ VxWorks provides the following similar interface:
 <b>Function Prototype:</b> 
 <pre>
    #include &lt;sched.h&gt;
-   int task_init(_TCB *tcb, char *name, int priority, uint32_t *stack, uint32_t stack_size,
+   int task_init(struct tcb_s *tcb, char *name, int priority, uint32_t *stack, uint32_t stack_size,
                  maint_t entry, char * const argv[]);
 </pre>
 
@@ -414,7 +414,7 @@ VxWorks provides the following similar interface:
 <b>Function Prototype:</b> 
 <pre>
     #include &lt;sched.h&gt;
-    int task_activate(_TCB *tcb);
+    int task_activate(struct tcb_s *tcb);
 </pre>
 
 <p>
@@ -9188,7 +9188,7 @@ From the standpoint of the application, these structures (and
 structure pointers) should be treated as simple handles to reference
 OS resources. These hidden structures include:
 <ul>
-<li>_TCB
+<li>struct tcb_s
 <li>mqd_t
 <li>sem_t
 <li>WDOG_ID
-- 
cgit v1.2.3