Add configurable application entry point

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5070 42af7a65-404d-4744-a932-0658087f49c3

ChangeLog

@@ -3221,3 +3221,7 @@
 	  common configurations and in configs/*/README.txt for board and MCU_
 	  specific configurations.
 	* configs/stm3240g-eval: Add USB host support.
+	* sched/os_bring.c, configs/*/defconfig, tools/mkconfig.c, and others:  Added
+	  configuration variable CONFIG_USER_ENTRYPOINT that may be used to change
+	  the default entry from user_start to some other symbol.  Contributed by
+	  Kate.

Documentation/NuttShell.html

@@ -3066,7 +3066,7 @@ Builtin Apps:
 <p>
   <code><b>apps/examples/hello</code></b>.
    The main routine for apps/examples/hello can be found in <code>apps/examples/hello/main.c</code>.
-   When <code>CONFIG_EXAMPLES_HELLO_BUILTIN</code> is defined, this main routine simplifies to:
+   The main routine is:
 </p>
 <ul><pre>
 int hello_main(int argc, char *argv[])
@@ -3165,10 +3165,8 @@ STACKSIZE       = 2048
    </p>
 <ul><pre>
 .context:
-ifeq ($(CONFIG_EXAMPLES_HELLO_BUILTIN),y)
   $(call REGISTER,$(APPNAME),$(PRIORITY),$(STACKSIZE),$(APPNAME)_main)
   @touch $@
-endif
 </pre></ul>
 </ol>
 
@@ -3189,7 +3187,7 @@ endif
 CONFIG_BUILTIN_APP_START=&lt;application name&gt;
 </pre></ul>
     <p>
-      that application will be invoked immediately after system starts instead of the normal, default <code>user_start()</code> entry point.
+      that application will be invoked immediately after system starts instead of the default <code>CONFIG_USER_ENTRYPOINT</code>() entry point.
       Note that <code>&lt;application name&gt;</code> must be provided just as it would have been on the NSH command line.
       For example, <code>hello</code> would result in <code>hello_main()</code> being started at power-up.
     </p>
@@ -3276,8 +3274,8 @@ CONFIGURED_APPS += examples/hello
     <p>
       You replace the sample code at <code>apps/examples/nsh/nsh_main.c</code> with whatever start-up logic that you want.
       NSH is a library at <code>apps/nshlib</code>. 
-      <code>apps.examplex/nsh</code> is just a tiny, example start-up function (<code>user_start()</code>) that that runs immediately and illustrates how to start NSH
+      <code>apps.examplex/nsh</code> is just a tiny, example start-up function (<code>CONFIG_USER_ENTRYPOINT</code>()) that that runs immediately and illustrates how to start NSH
-      If you want something else to run immediately then you can write your write your own custom <code>user_start()</code> function and then start other tasks from your custom <code>user_start()</code>.
+      If you want something else to run immediately then you can write your write your own custom <code>CONFIG_USER_ENTRYPOINT</code>() function and then start other tasks from your custom <code>CONFIG_USER_ENTRYPOINT</code>().
     </p>
   <li>
     <p>

Documentation/NuttxPortingGuide.html

@@ -4085,6 +4085,14 @@ build
     <code>CONFIG_SCHED_ONEXIT_MAX</code>:  By default if <code>CONFIG_SCHED_ONEXIT</code> is selected, only a single <code>on_exit()</code> function is supported.
     That number can be increased by defined this setting to the number that you require.
   </li>
+  <li>
+    <code>CONFIG_USER_ENTRYPOINT</code>: The name of the entry point for user
+    applications.
+    For the example applications this is of the form <code>app_main</code>
+    where <code>app</code> is the application name.
+    If not defined, <code>CONFIG_USER_ENTRYPOINT</code> defaults to
+    <code>user_start</code>.
+  </li>
 </ul>
 
 <p>
@@ -5792,13 +5800,14 @@ build
   <li>
     <code>CONFIG_IDLETHREAD_STACKSIZE</code>: The size of the initial stack.
     This is the thread that (1) performs the initial boot of the system up
-    to the point where user_start() is spawned, and (2) there after is the
+    to the point where <code>CONFIG_USER_ENTRYPOINT</code>() is spawned,
-    IDLE thread that executes only when there is no other thread ready to
+    and (2) there after is the IDLE thread that executes only when there
-    run.
+    is no other thread ready to run.
   </li>
   <li>
     <code>CONFIG_USERMAIN_STACKSIZE</code>: The size of the stack to allocate
-    for the main user thread that begins at the user_start() entry point.
+    for the main user thread that begins at the <code>CONFIG_USER_ENTRYPOINT</code>()
+    entry point.
   </li>
   <li>
     <code>CONFIG_PTHREAD_STACK_MIN</code>: Minimum pthread stack size

Documentation/UsbTrace.html

@@ -150,7 +150,7 @@
   </tr>
   <tr>
     <td align="center">&nbsp;</td>
-    <td align="left"><code>user_start: Registering USB serial driver</code></td>
+    <td align="left"><code>usbserial_main: Registering USB serial driver</code></td>
   </tr>
   <tr>
     <td align="center">&nbsp;</td>
@@ -158,7 +158,7 @@
   </tr>
   <tr>
     <td align="center">&nbsp;</td>
-    <td align="left"><code>user_start: Successfully registered the serial driver</code></td>
+    <td align="left"><code>usbserial_main: Successfully registered the serial driver</code></td>
   </tr>
   <tr>
     <td align="center">1</td>
@@ -170,11 +170,11 @@
   </tr>
   <tr>
     <td align="center">&nbsp;</td>
-    <td align="left"><code>user_start: ERROR: Failed to open /dev/ttyUSB0 for reading: 107</code></td>
+    <td align="left"><code>usbserial_main: ERROR: Failed to open /dev/ttyUSB0 for reading: 107</code></td>
   </tr>
   <tr>
     <td align="center">&nbsp;</td>
-    <td align="left"><code>user_start: Not connected. Wait and try again.</code></td>
+    <td align="left"><code>usbserial_main: Not connected. Wait and try again.</code></td>
   </tr>
   <tr>
     <td align="center">3</td>

configs/README.txt

@@ -268,6 +268,7 @@ defconfig -- This is a configuration file similar to the Linux
       by default)
     CONFIG_DEBUG_GRAPHICS - enable NX graphics debug output
       (disabled by default)
+
     CONFIG_ARCH_LOWPUTC - architecture supports low-level, boot
       time console output
     CONFIG_MM_REGIONS - If the architecture includes multiple
@@ -375,6 +376,10 @@ defconfig -- This is a configuration file similar to the Linux
     CONFIG_SCHED_ONEXIT_MAX -  By default if CONFIG_SCHED_ONEXIT is selected,
       only a single on_exit() function is supported. That number can be
       increased by defined this setting to the number that you require.
+    CONFIG_USER_ENTRYPOINT - The name of the entry point for user
+      applications.  For the example applications this is of the form 'app_main'
+      where 'app' is the application name. If not defined, CONFIG_USER_ENTRYPOINT
+      defaults to user_start.
 
   System Logging:
     CONFIG_SYSLOG enables general system logging support.

configs/amber/hello/defconfig

@@ -115,6 +115,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="hello_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/avr32dev1/nsh/defconfig

@@ -141,6 +141,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/avr32dev1/ostest/defconfig

@@ -141,6 +141,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/c5471evm/httpd/defconfig

@@ -91,6 +91,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="uip_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/c5471evm/nettest/defconfig

@@ -91,6 +91,7 @@ CONFIG_NET_C5471_BASET10=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nettest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/c5471evm/nsh/defconfig

@@ -91,6 +91,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/c5471evm/ostest/defconfig

@@ -91,6 +91,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/compal_e88/nsh_highram/defconfig

@@ -93,6 +93,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/compal_e99/nsh_compalram/defconfig

@@ -96,6 +96,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/compal_e99/nsh_highram/defconfig

@@ -96,6 +96,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_GRAPHICS=n
 CONFIG_DEBUG_VERBOSE=n

configs/demo9s12ne64/ostest/defconfig

@@ -115,6 +115,7 @@ CONFIG_PASS1_OBJECT=
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ea3131/nsh/defconfig

@@ -113,6 +113,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ea3131/ostest/defconfig

@@ -113,6 +113,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ea3131/pgnsh/defconfig

@@ -126,6 +126,7 @@ CONFIG_PASS1_OBJECT=locked.r
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ea3131/usbserial/defconfig

@@ -113,6 +113,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="usbserial_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_FS=n

configs/ea3131/usbstorage/defconfig

@@ -113,6 +113,8 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="msconn_main"
+#CONFIG_USER_ENTRYPOINT="msdis_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_FS=n

configs/ea3152/ostest/defconfig

@@ -113,6 +113,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/eagle100/httpd/defconfig

@@ -120,6 +120,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="uip_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/eagle100/nettest/defconfig

@@ -120,6 +120,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nettest_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/eagle100/nsh/defconfig

@@ -120,6 +120,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/eagle100/nxflat/defconfig

@@ -120,6 +120,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nxflat_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/eagle100/ostest/defconfig

@@ -120,6 +120,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/eagle100/thttpd/defconfig

@@ -120,6 +120,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="thttp_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ekk-lm3s9b96/nsh/defconfig

@@ -137,6 +137,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ekk-lm3s9b96/ostest/defconfig

@@ -137,6 +137,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ez80f910200kitg/ostest/defconfig

@@ -99,6 +99,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ez80f910200zco/dhcpd/defconfig

@@ -102,6 +102,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="dhcpd_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ez80f910200zco/httpd/defconfig

@@ -102,6 +102,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="uip_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ez80f910200zco/nettest/defconfig

@@ -102,6 +102,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nettest_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ez80f910200zco/nsh/defconfig

@@ -102,6 +102,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ez80f910200zco/ostest/defconfig

@@ -101,6 +101,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/ez80f910200zco/poll/defconfig

@@ -102,6 +102,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="poll_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/hymini-stm32v/buttons/defconfig

@@ -175,6 +175,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="buttons_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/hymini-stm32v/nsh/defconfig

@@ -173,6 +173,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/hymini-stm32v/nsh2/defconfig

@@ -180,6 +180,7 @@ CONFIG_RTC=y
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=y
 CONFIG_DEBUG_VERBOSE=y
 CONFIG_DEBUG_GRAPHICS=y

configs/hymini-stm32v/nx/defconfig

@@ -173,6 +173,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nx_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_GRAPHICS=n

configs/hymini-stm32v/nxlines/defconfig

@@ -177,6 +177,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nxlines_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_GRAPHICS=n

configs/hymini-stm32v/usbserial/defconfig

@@ -175,6 +175,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="usbserial_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_USB=n

configs/hymini-stm32v/usbstorage/defconfig

@@ -174,6 +174,8 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="msconn_main"
+#CONFIG_USER_ENTRYPOINT="msdis_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_FS=n

configs/kwikstik-k40/ostest/defconfig

@@ -185,6 +185,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/lincoln60/nsh/defconfig

@@ -153,6 +153,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/lincoln60/ostest/defconfig

@@ -159,6 +159,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/lm3s6432-s2e/nsh/defconfig

@@ -136,6 +136,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/lm3s6432-s2e/ostest/defconfig

@@ -136,6 +136,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="ostest_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n

configs/lm3s6965-ek/nsh/defconfig

@@ -136,6 +136,7 @@ CONFIG_HAVE_LIBM=n
 #
 # General OS setup
 #
+CONFIG_USER_ENTRYPOINT="nsh_main"
 CONFIG_DEBUG=n
 CONFIG_DEBUG_VERBOSE=n
 CONFIG_DEBUG_SYMBOLS=n