From 532ba867c6225d1fef4879fbcd1f922f799bbf09 Mon Sep 17 00:00:00 2001 From: patacongo Date: Sat, 2 Feb 2013 19:31:30 +0000 Subject: [PATCH] New interface task_spawn(); exec_builtin() now uses task_spawn(); All argv types should be char * const * not const char ** git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5598 42af7a65-404d-4744-a932-0658087f49c3 --- Documentation/NuttxUserGuide.html | 228 ++++++++++++++++++++++++++++-- 1 file changed, 219 insertions(+), 9 deletions(-) diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html index 10e5eb7ba4..2704196d07 100644 --- a/Documentation/NuttxUserGuide.html +++ b/Documentation/NuttxUserGuide.html @@ -13,7 +13,7 @@

NuttX Operating System

User's Manual

by

Gregory Nutt

-

Last Updated: January 23, 2013

+

Last Updated: February 2, 2013

@@ -221,7 +221,6 @@ paragraphs.

Standard posix_spawn interfaces:

- +

+ Non-standard task control interfaces inspired by posix_spawn: +

+

2.1.1 task_create

@@ -246,7 +253,7 @@ paragraphs. Function Prototype:

@@ -336,7 +343,7 @@ VxWorks provides the following similar interface:

    #include <sched.h>
    int task_init(_TCB *tcb, char *name, int priority, uint32_t *stack, uint32_t stack_size,
-                 maint_t entry, const char *argv[]);
+                 maint_t entry, char * const argv[]);
 

@@ -831,7 +838,7 @@ int posix_spawnp(FAR pid_t *pid, FAR const char *file,

Description: - The posix_spawn() and posix_spawnp() functions will create a new, child task, constructed from a regular executable file.

+ The posix_spawn() and posix_spawnp() functions will create a new, child task, constructed from a regular executable file.

Input Parameters: @@ -1403,6 +1410,206 @@ int posix_spawnattr_setsigmask(FAR posix_spawnattr_t *attr, FAR const sigset_t * On success, this function returns 0; on failure it will return an error number from <errno.h>

+

2.1.26 task_spawn

+

+ Function Prototype: +

+ +

+ Description: + The task_spawn() function will create a new, child task, where the entry point to the task is an address in memory. +

+

+ +

+ Returned Value: + task_spawn() will return zero on success. + Otherwise, an error number will be returned as the function return value to indicate the error: +

+

+ POSIX Compatibility: + This is a non-standard interface inspired by posix_spawn(). +

+ +

2.1.26 task_spawnattr_getstacksize

+

+ Function Prototype: +

+ +

+ Description: + The task_spawnattr_getstacksize() function will obtain the value of the spawn-stacksize attribute from the attributes object referenced by attr. +

+

+ Input Parameters: +

+ +

+ Returned Value: + On success, this function returns 0; on failure it will return an error number from <errno.h> +

+ +

2.1.26 task_spawnattr_setstacksize

+

+ Function Prototype: +

+ +

+ Description: + The task_spawnattr_setstacksize() function will set the spawn-stacksize attribute in an initialized attributes object referenced by attr. +

+

+ Input Parameters: +

+ +

+ Returned Value: + On success, this function returns 0; on failure it will return an error number from <errno.h> +

+ +

2.1.12 posix_spawn_file_actions_init

+

+ Function Prototype: +

+ +

+ Description: + The posix_spawn_file_actions_init() function initializes the object referenced by file_actions to an empty set of file actions for subsequent use in a call to posix_spawn() or posix_spawnp(). +

+

+ Input Parameters: +

+ +

+ Returned Value: + On success, this function returns 0; on failure it will return an error number from <errno.h>. +

+ - +
@@ -9277,9 +9484,9 @@ notify a task when a message is available on a queue.
  • poll
  • poll.h
  • posix_spawn
  • +
  • posix_spawn_file_actions_addclose
  • -
  • posix_spawn_file_actions_addclose
  • posix_spawn_file_actions_adddup2
  • posix_spawn_file_actions_addopen
  • posix_spawn_file_actions_destroy
  • @@ -9362,10 +9569,10 @@ notify a task when a message is available on a queue.
  • rename
  • rmdir
  • rewinddir
  • -
  • ROM disk driver
  • ROMFS
  • +
  • sched_getparam
  • sched_get_priority_max
  • sched_get_priority_min
  • @@ -9419,8 +9626,11 @@ notify a task when a message is available on a queue.
  • task_delete
  • task_init
  • task_restart
  • -
  • Task Control Interfaces
  • Task Scheduling Interfaces +
  • task_spawn
  • +
  • task_spawnattr_getstacksize
  • +
  • task_spawnattr_setstacksize
  • +
  • Task Switching Interfaces
  • telldir
  • timer_create
  • timer_delete