diff options
| author | Gregory Nutt <gnutt@nuttx.org> | 2013-09-28 16:50:07 -0600 |
|---|---|---|
| committer | Gregory Nutt <gnutt@nuttx.org> | 2013-09-28 16:50:07 -0600 |
| commit | 4c24c7c4a741eaeffc76339f07076cdad7a36c56 (patch) | |
| tree | 337a94000f0e849884e81e8ac2ee188bf0a38179 /nuttx/Documentation/NuttxUserGuide.html | |
| parent | e735773fe5ea269b43dbecb246cec846b3a0368e (diff) | |
| download | nuttx-4c24c7c4a741eaeffc76339f07076cdad7a36c56.tar.gz nuttx-4c24c7c4a741eaeffc76339f07076cdad7a36c56.tar.bz2 nuttx-4c24c7c4a741eaeffc76339f07076cdad7a36c56.zip | |
Clean up some naming: fd vs. fildes vs. filedes and filep vs filp
Diffstat (limited to 'nuttx/Documentation/NuttxUserGuide.html')
| -rw-r--r-- | nuttx/Documentation/NuttxUserGuide.html | 604 |
1 files changed, 302 insertions, 302 deletions
diff --git a/nuttx/Documentation/NuttxUserGuide.html b/nuttx/Documentation/NuttxUserGuide.html index 68df699dd..bedc07226 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: June 4, 2013</p> + <p>Last Updated: September 28, 2013</p> </td> </tr> </table> @@ -250,14 +250,14 @@ paragraphs. <H3><a name="taskcreate">2.1.1 task_create</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <ul><pre> #include <sched.h> int task_create(char *name, int priority, int stack_size, main_t entry, char * const argv[]); </pre></ul> <p> -<b>Description:</b> +<b>Description:</b> This function creates and activates a new task with a specified priority and returns its system-assigned ID. </p> @@ -291,7 +291,7 @@ int task_create(char *name, int priority, int stack_size, main_t entry, char * c redirection of standard I/O is supported. </p> <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>name</code>. Name of the new task</LI> <li><code>priority</code>. Priority of the new task</LI> @@ -304,7 +304,7 @@ int task_create(char *name, int priority, int stack_size, main_t entry, char * c If no parameters are required, argv may be NULL. </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> </P> <ul> <li> @@ -315,7 +315,7 @@ int task_create(char *name, int priority, int stack_size, main_t entry, char * c </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> This is a NON-POSIX interface. VxWorks provides the following similar interface: @@ -339,7 +339,7 @@ VxWorks provides the following similar interface: <H3><a name="taskinit">2.1.2 task_init</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int task_init(struct tcb_s *tcb, char *name, int priority, uint32_t *stack, uint32_t stack_size, @@ -358,7 +358,7 @@ VxWorks provides the following similar interface: This must be done by calling task_activate(). </P> <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>tcb</code>. Address of the new task's TCB <li><code>name</code>. Name of the new task (not used) @@ -374,7 +374,7 @@ VxWorks provides the following similar interface: </ul> </p> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> </p> <ul> <li><p>OK, or ERROR if the task cannot be initialized.</P> @@ -411,7 +411,7 @@ VxWorks provides the following similar interface: <H3><a name="taskactivate">2.1.3 task_activate</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int task_activate(struct tcb_s *tcb); @@ -422,14 +422,14 @@ VxWorks provides the following similar interface: Without activation, a task is ineligible for execution by the scheduler. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>tcb</code>. The TCB for the task for the task (same as the task_init argument). </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>OK, or ERROR if the task cannot be activated (<a href="#ErrnoAccess"><code>errno</code></a> is not set). </ul> @@ -461,7 +461,7 @@ the pointer to the WIND_TCB cast to an integer. <H3><a name="taskdelete">2.1.4 task_delete</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <ul><pre> #include <sched.h> int task_delete(pid_t pid); @@ -472,7 +472,7 @@ int task_delete(pid_t pid); This function causes a specified task to cease to exist -- its stack and TCB will be deallocated. This function is the companion to task_create(). <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li> <code>pid</code>. @@ -481,7 +481,7 @@ int task_delete(pid_t pid); Any attempt by the calling task will be automatically re-directed to <code>exit()</code>. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li> <code>OK</code>, or <code>ERROR</code> if the task cannot be deleted. @@ -489,7 +489,7 @@ int task_delete(pid_t pid); </li> </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <code>task_delete()</code> must be used with caution: If the task holds resources (for example, allocated memory or semaphores needed by other tasks), then <code>task_delete()</code> can strand those resources. @@ -544,14 +544,14 @@ int task_restart(pid_t pid); </li> </ol> <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>pid</code>. The task ID of the task to delete. An ID of zero would signify the calling task (However, support for a task to restart itself has not been implemented). </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li> OK, or ERROR if the task ID is invalid or the task could @@ -562,7 +562,7 @@ int task_restart(pid_t pid); </li> </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> This is a NON-POSIX interface. VxWorks provides the following similar interface: @@ -586,7 +586,7 @@ VxWorks provides the following similar interface: <H3><a name="exit">2.1.6 exit</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> void exit(int code); @@ -601,7 +601,7 @@ to exist -- its stack and TCB will be deallocated. exit differs from _exit in that it flushes streams, closes file descriptors and will execute any function registered with <code>atexit()</code> or <code>on_exit()</code>. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>code</code>. (ignored) </ul> @@ -610,7 +610,7 @@ execute any function registered with <code>atexit()</code> or <code>on_exit()</c <b>Returned Value:</b> None. <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> This is equivalent to the ANSI interface: @@ -632,7 +632,7 @@ And the UNIX interface: <H3><a name="getpid">2.1.7 getpid</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <unistd.h> pid_t getpid(void); @@ -645,13 +645,13 @@ level. <p> <b>Input Parameters:</b> None. <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>The task ID of the calling task. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> Compatible with the POSIX interface of the same name. @@ -667,7 +667,7 @@ pid_t vfork(void); </pre></ul> <p> <b>Description:</b> - The <code>vfork()</code> function has the same effect as <code>fork()</code>, except that the behavior is undefined if the process created by <code>vfork()</code> either modifies any data other than a variable of type <code>pid_t</code> used to store the return value from <code>vfork()</code>, or returns from the function in which <code>vfork()</code> was called, or calls any other function before successfully calling <code>_exit()</code> or one of the <code>exec</code> family of functions. + The <code>vfork()</code> function has the same effect as <code>fork()</code>, except that the behavior is undefined if the process created by <code>vfork()</code> either modifies any data other than a variable of type <code>pid_t</code> used to store the return value from <code>vfork()</code>, or returns from the function in which <code>vfork()</code> was called, or calls any other function before successfully calling <code>_exit()</code> or one of the <code>exec</code> family of functions. <p> <blockquote><small> <b>NOTE:</b> @@ -679,12 +679,12 @@ pid_t vfork(void); None. </p> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> Upon successful completion, <code>vfork()</code> returns 0 to the child process and returns the process ID of the child process to the parent process. - Otherwise, -1 is returned to the parent, no child process is created, and <code>errno</code> is set to indicate the error. + Otherwise, -1 is returned to the parent, no child process is created, and <code>errno</code> is set to indicate the error. <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -765,11 +765,11 @@ int execv(FAR const char *path, FAR char *const argv[]); </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> This function does not return on success. - On failure, it will return -1 (<code>ERROR</code>) and will set the <code>errno</code> value appropriately. + On failure, it will return -1 (<code>ERROR</code>) and will set the <code>errno</code> value appropriately. <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -804,16 +804,16 @@ int execl(FAR const char *path, ...); <li> </li> <code>...</code>: - A list of the string arguments to be recevied by the program. + A list of the string arguments to be recevied by the program. Zero indicates the end of the list. </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> This function does not return on success. - On failure, it will return -1 (<code>ERROR</code>) and will set the <code>errno</code> value appropriately. + On failure, it will return -1 (<code>ERROR</code>) and will set the <code>errno</code> value appropriately. <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -924,7 +924,7 @@ int posix_spawnp(FAR pid_t *pid, FAR const char *file, </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> <code>posix_spawn()</code> and <code>posix_spawnp()</code> will return zero on success. Otherwise, an error number will be returned as the function return value to indicate the error: </p> @@ -938,7 +938,7 @@ int posix_spawnp(FAR pid_t *pid, FAR const char *file, </li> </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <ul> <li> @@ -1013,7 +1013,7 @@ int posix_spawn_file_actions_destroy(FAR posix_spawn_file_actions_t *file_action </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> <p> @@ -1044,7 +1044,7 @@ int posix_spawn_file_actions_addclose(FAR posix_spawn_file_actions_t *file_actio </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1081,7 +1081,7 @@ int posix_spawn_file_actions_adddup2(FAR posix_spawn_file_actions_t *file_action </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1126,7 +1126,7 @@ int posix_spawn_file_actions_addopen(FAR posix_spawn_file_actions_t *file_action </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1162,7 +1162,7 @@ int posix_spawnattr_init(FAR posix_spawnattr_t *attr); </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1192,7 +1192,7 @@ int posix_spawnattr_getflags(FAR const posix_spawnattr_t *attr, FAR short *flags </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1222,7 +1222,7 @@ int posix_spawnattr_getschedparam(FAR const posix_spawnattr_t *attr, FAR struct </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1252,7 +1252,7 @@ int posix_spawnattr_getschedpolicy(FAR const posix_spawnattr_t *attr, FAR int *p </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1284,7 +1284,7 @@ int posix_spawnattr_getsigmask(FAR const posix_spawnattr_t *attr, FAR sigset_t * </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1314,7 +1314,7 @@ int posix_spawnattr_setflags(FAR posix_spawnattr_t *attr, short flags); </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1347,7 +1347,7 @@ int posix_spawnattr_setschedparam(FAR posix_spawnattr_t *attr, FAR const struct <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> - + <h3><a name="posix_spawnattr_setschedpolicy">2.1.24 posix_spawnattr_setschedpolicy</a></h3> <p> <b>Function Prototype:</b> @@ -1406,7 +1406,7 @@ int posix_spawnattr_setsigmask(FAR posix_spawnattr_t *attr, FAR const sigset_t * </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1515,7 +1515,7 @@ int task_spawn(FAR pid_t *pid, FAR const char *name, main_t entry, </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> <code>task_spawn()</code> will return zero on success. Otherwise, an error number will be returned as the function return value to indicate the error: </p> @@ -1550,7 +1550,7 @@ int task_spawnattr_getstacksize(FAR const posix_spawnattr_t *attr, FAR size_t *s </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, this function returns 0; on failure it will return an error number from <code><errno.h></code> </p> @@ -1712,7 +1712,7 @@ int posix_spawn_file_actions_init(FAR posix_spawn_file_actions_t *file_actions); <H3><a name="schedgetparam">2.2.2 sched_getparam</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int sched_getparam (pid_t pid, struct sched_param *param); @@ -1722,7 +1722,7 @@ int posix_spawn_file_actions_init(FAR posix_spawn_file_actions_t *file_actions); <b>Description:</b> This function gets the scheduling priority of the task specified by pid. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li> <code>pid</code>. The task ID of the task. @@ -1736,20 +1736,20 @@ of the task specified by pid. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) if successful, otherwise -1 (<code>ERROR</code>). </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. <H3><a name="schedsetscheduler">2.2.3 sched_setscheduler</a></H3> <p> - <b>Function Prototype:</b> + <b>Function Prototype:</b> </p> <ul><pre> #include <sched.h> @@ -1762,7 +1762,7 @@ int sched_setscheduler (pid_t pid, int policy, const struct sched_param *param); The parameter <code>param</code> holds the priority of the thread under the new policy. </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li> @@ -1781,7 +1781,7 @@ int sched_setscheduler (pid_t pid, int policy, const struct sched_param *param); </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, <code>sched_setscheduler()</code> returns <code>OK</code> (zero). On error, <code>ERROR</code> (-1) is returned, and <a href="#ErrnoAccess"><code>errno</code></a> is set appropriately: </p> @@ -1798,7 +1798,7 @@ int sched_setscheduler (pid_t pid, int policy, const struct sched_param *param); <H3><a name="setgetscheduler">2.2.4 sched_getscheduler</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <ul><pre> #include <sched.h> int sched_getscheduler (pid_t pid); @@ -1810,7 +1810,7 @@ int sched_getscheduler (pid_t pid); <code>pid</code> equals zero, the policy of the calling process will be retrieved. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>pid</code>. The task ID of the task to query. @@ -1818,7 +1818,7 @@ int sched_getscheduler (pid_t pid); </LI> </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li> On success, <code>sched_getscheduler()</code> returns the policy for @@ -1830,14 +1830,14 @@ int sched_getscheduler (pid_t pid); </li> </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. <H3><a name="sched_yield">2.2.5 sched_yield</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int sched_yield(void); @@ -1849,13 +1849,13 @@ up the CPU (only to other tasks at the same priority). <p> <b>Input Parameters:</b> None. <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) or -1 (<code>ERROR</code>) </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -1863,7 +1863,7 @@ interface of the same name. <H3><a name="schedgetprioritymax">2.2.6 sched_get_priority_max</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int sched_get_priority_max (int policy) @@ -1873,19 +1873,19 @@ interface of the same name. <b>Description:</b> This function returns the value of the highest possible task priority for a specified scheduling policy. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>policy</code>. Scheduling policy requested. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>The maximum priority value or -1 (<code>ERROR</code>). </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -1893,7 +1893,7 @@ interface of the same name. <H3><a name="schedgetprioritymin">2.2.7 sched_get_priority_min</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int sched_get_priority_min (int policy); @@ -1903,19 +1903,19 @@ interface of the same name. <b>Description:</b> This function returns the value of the lowest possible task priority for a specified scheduling policy. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>policy</code>. Scheduling policy requested. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>The minimum priority value or -1 (<code>ERROR</code>) </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -1923,14 +1923,14 @@ interface of the same name. <H3><a name="schedgetrrinterval">2.2.8 sched_get_rr_interval</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int sched_get_rr_interval (pid_t pid, struct timespec *interval); </pre> <p> - <b>Description:</b> + <b>Description:</b> <code>sched_rr_get_interval()</code> writes the timeslice interval for task identified by <code>pid</code> into the timespec structure pointed to by <code>interval</code>. If pid is zero, the timeslice @@ -1939,7 +1939,7 @@ interface of the same name. scheduling policy.' </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>pid</code>. The task ID of the task. If pid is zero, the @@ -1948,7 +1948,7 @@ priority of the calling task is returned. </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, sched_rr_get_interval() returns OK (0). On error, ERROR (-1) is returned, and <a href="#ErrnoAccess"><code>errno</code></a> is set to: </p> @@ -1960,7 +1960,7 @@ priority of the calling task is returned. </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -2100,7 +2100,7 @@ int ret = sigaction(SIGCHLD, &sa, NULL); <H3><a name="schedlock">2.3.1 sched_lock</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int sched_lock(void); @@ -2115,13 +2115,13 @@ number of times) or until it blocks itself. <p> <b>Input Parameters:</b> None. <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>OK or ERROR. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> This is a NON-POSIX interface. VxWorks provides the comparable interface: @@ -2132,7 +2132,7 @@ VxWorks provides the comparable interface: <H3><a name="schedunlock">2.3.2 sched_unlock</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int sched_unlock(void); @@ -2148,13 +2148,13 @@ eligible to preempt the current task will execute. <p> <b>Input Parameters:</b> None. <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>OK or ERROR. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> This is a NON-POSIX interface. VxWorks provides the comparable interface: @@ -2165,7 +2165,7 @@ VxWorks provides the comparable interface: <H3><a name="schedlockcount">2.3.3 sched_lockcount</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sched.h> int32_t sched_lockcount(void) @@ -2179,13 +2179,13 @@ on this thread of execution. <p> <b>Input Parameters:</b> None. <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>The current value of the lockCount. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> None. </p> @@ -2193,14 +2193,14 @@ on this thread of execution. <H3><a name="waitpid">2.3.4 waitpid</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sys/wait.h> ipid_t waitpid(pid_t pid, int *stat_loc, int options); </pre> <p> - <b>Description:</b> + <b>Description:</b> </p> <blockquote><small> The following discussion is a general description of the <code>waitpid()</code> interface. @@ -2223,7 +2223,7 @@ on this thread of execution. Because <code>waitpid()</code> is not fully POSIX compliant, it must be specifically enabled by setting <code>CONFIG_SCHED_WAITPID</code> in the NuttX configuration file. </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>pid</code>. The task ID of the thread to waid for</li> @@ -2256,19 +2256,19 @@ on this thread of execution. <ul> <li> <code>WCONTINUED</code>. - The <code>waitpid()</code> function will report the status of any continued child process specified by pid whose status has not been reported since it continued from a job control stop. + The <code>waitpid()</code> function will report the status of any continued child process specified by pid whose status has not been reported since it continued from a job control stop. </li> <li> <code>WNOHANG</code>. - The <code>waitpid()</code> function will not suspend execution of the calling thread if status is not immediately available for one of the child processes specified by <code>pid</code>. + The <code>waitpid()</code> function will not suspend execution of the calling thread if status is not immediately available for one of the child processes specified by <code>pid</code>. </li> <li> <code>WUNTRACED</code>. - The status of any child processes specified by <code>pid</code> that are stopped, and whose status has not yet been reported since they stopped, will also be reported to the requesting process. + The status of any child processes specified by <code>pid</code> that are stopped, and whose status has not yet been reported since they stopped, will also be reported to the requesting process. </li> </ul> <p> - If the calling process has <code>SA_NOCLDWAIT</code> set or has <code>SIGCHLD</code> set to <code>SIG_IGN</code>, and the process has no unwaited-for children that were transformed into zombie processes, the calling thread will block until all of the children of the process containing the calling thread terminate, and <code>waitpid()</code> will fail and set <code>errno</code> to <code>ECHILD</code>. + If the calling process has <code>SA_NOCLDWAIT</code> set or has <code>SIGCHLD</code> set to <code>SIG_IGN</code>, and the process has no unwaited-for children that were transformed into zombie processes, the calling thread will block until all of the children of the process containing the calling thread terminate, and <code>waitpid()</code> will fail and set <code>errno</code> to <code>ECHILD</code>. </p> <p> If <code>waitpid()</code> returns because the status of a child process is available, these functions will return a value equal to the process ID of the child process. @@ -2296,23 +2296,23 @@ on this thread of execution. </li> <li> <code>WEXITSTATUS(stat_val)</code>. - If the value of <code>WIFEXITED(stat_val)</code> is non-zero, this macro evaluates to the low-order 8 bits of the status argument that the child process passed to <code>_exit()</code> or <code>exit()</code>, or the value the child process returned from <code>main()</code>. + If the value of <code>WIFEXITED(stat_val)</code> is non-zero, this macro evaluates to the low-order 8 bits of the status argument that the child process passed to <code>_exit()</code> or <code>exit()</code>, or the value the child process returned from <code>main()</code>. </li> <li> <code>WIFSIGNALED(stat_val)</code>. - Evaluates to a non-zero value if status was returned for a child process that terminated due to the receipt of a signal that was not caught (see >signal.h<). + Evaluates to a non-zero value if status was returned for a child process that terminated due to the receipt of a signal that was not caught (see >signal.h<). </li> <li> <code>WTERMSIG(stat_val)</code>. - If the value of <code>WIFSIGNALED(stat_val)</code> is non-zero, this macro evaluates to the number of the signal that caused the termination of the child process. + If the value of <code>WIFSIGNALED(stat_val)</code> is non-zero, this macro evaluates to the number of the signal that caused the termination of the child process. </li> <li> <code>WIFSTOPPED(stat_val)</code>. - Evaluates to a non-zero value if status was returned for a child process that is currently stopped. + Evaluates to a non-zero value if status was returned for a child process that is currently stopped. </li> <li> <code>WSTOPSIG(stat_val)</code>. - If the value of <code>WIFSTOPPED(stat_val)</code> is non-zero, this macro evaluates to the number of the signal that caused the child process to stop. + If the value of <code>WIFSTOPPED(stat_val)</code> is non-zero, this macro evaluates to the number of the signal that caused the child process to stop. </li> <li> <code>WIFCONTINUED(stat_val)</code>. @@ -2320,7 +2320,7 @@ on this thread of execution. </li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> </p> <p> If <code>waitpid()</code> returns because the status of a child process is available, it will return a value equal to the process ID of the child process for which status is reported. @@ -2337,21 +2337,21 @@ on this thread of execution. <ul> <li> <code>ECHILD</code>. - The process specified by <code>pid</code> does not exist or is not a child of the calling process, or the process group specified by <code>pid</code> does not exist or does not have any member process that is a child of the calling process. + The process specified by <code>pid</code> does not exist or is not a child of the calling process, or the process group specified by <code>pid</code> does not exist or does not have any member process that is a child of the calling process. </li> <li> <code>EINTR</code>. The function was interrupted by a signal. - The value of the location pointed to by <code>stat_loc</code> is undefined. + The value of the location pointed to by <code>stat_loc</code> is undefined. </li> <li> <code>EINVAL</code>. - The <code>options</code> argument is not valid. + The <code>options</code> argument is not valid. </li> </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> Comparable to the POSIX interface of the same name, but the implementation is incomplete (as detailed above). @@ -2359,7 +2359,7 @@ on this thread of execution. <h3><a name="waitid">2.3.5 waitid</a></li></h3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sys/wait.h> #ifdef CONFIG_SCHED_HAVE_PARENT @@ -2406,25 +2406,25 @@ on this thread of execution. <ul> <li> <code>WEXITED</code>: - Wait for processes that have exited. + Wait for processes that have exited. </li> <li> <code>WSTOPPED</code>: - Status will be returned for any child that has stopped upon receipt of a signal. + Status will be returned for any child that has stopped upon receipt of a signal. </li> <li> <code>WCONTINUES</code>: - Status will be returned for any child that was stopped and has been continued. + Status will be returned for any child that was stopped and has been continued. </li> <li> <code>WNOHANG</code>: - Return immediately if there are no children to wait for. + Return immediately if there are no children to wait for. </li> <li> <code>WNOWAIT</code>: Keep the process whose status is returned in <code>info</code> in a waitable state. This will not affect the state of the process; - the process may be waited for again after this call completes. + the process may be waited for again after this call completes. </li> </ul> The <code>info</code> argument must point to a <code>siginfo_t</code> structure. @@ -2436,9 +2436,9 @@ on this thread of execution. See the description above. </p> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> If <code>waitid()</code> returns due to the change of state of one of its children, 0 is returned. - Otherwise, -1 is returned and <code>errno</code> is set to indicate the error. + Otherwise, -1 is returned and <code>errno</code> is set to indicate the error. </p> <p> The <code>waitid()</code> function will fail if: @@ -2447,18 +2447,18 @@ on this thread of execution. <li> <code>ECHILD</code>: </li> - The calling process has no existing unwaited-for child processes. + The calling process has no existing unwaited-for child processes. <li> <code>EINTR</code>: </li> - The <code>waitid()</code> function was interrupted by a signal. + The <code>waitid()</code> function was interrupted by a signal. <li> <code>EINVAL</code>: An invalid value was specified for <code>options</code>, or <code>idtype</code> and <code>id</code> specify an invalid set of processes. </li> </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> Comparable to the POSIX interface of the same name, but the implementation is incomplete (as detailed in the description above). @@ -2466,7 +2466,7 @@ on this thread of execution. <h3><a name="wait">2.3.6 wait</a></li></h3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sys/wait.h> #ifdef CONFIG_SCHED_HAVE_PARENT @@ -2474,7 +2474,7 @@ on this thread of execution. #endif </pre> <p> - <b>Description:</b> + <b>Description:</b> </p> <blockquote><small> The following discussion is a general description of the <code>wait()</code> interface. @@ -2492,17 +2492,17 @@ on this thread of execution. Otherwise, its behavior will be modified by the values of the <code>pid</code> and <code>options</code> arguments. </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>stat_loc</code>. The location to return the exit status</li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> See the values returned by <a href="#waitpid"><code>waitpaid()</code></a>. </p> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> Comparable to the POSIX interface of the same name, but the implementation is incomplete (as detailed in the description <a href="#waitpid"><code>waitpaid()</code></a>). @@ -2511,13 +2511,13 @@ on this thread of execution. <h3><a name="atexit">2.3.7 atexit</a></h3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <stdlib.h> int atexit(void (*func)(void)); </pre> <p> - <b>Description:</b> + <b>Description:</b> Registers a function to be called at program exit. The <code>atexit()</code> function registers the given function to be called at normal process termination, whether via <code>exit()</code> or via return from the program's <code>main()</code>. </p> @@ -2525,19 +2525,19 @@ on this thread of execution. <b>NOTE</b>: <code>CONFIG_SCHED_ATEXIT</code> must be defined to enable this function. </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>func</code>. A pointer to the function to be called when the task exits.</li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, <code>atexit()</code> returns OK (0). On error, ERROR (-1) is returned, and <a href="#ErrnoAccess"><code>errno</code></a> is set to indicate the cause of the failure. </p> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> Comparable to the ISO C interface of the same name. Limitiations in the current implementation: @@ -2550,13 +2550,13 @@ on this thread of execution. <H3><a name="onexit">2.3.8 on_exit</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <stdlib.h> int on_exit(CODE void (*func)(int, FAR void *), FAR void *arg) </pre> <p> - <b>Description:</b> + <b>Description:</b> Registers a function to be called at program exit. The <code>on_exit()</code> function registers the given function to be called at normal process termination, whether via <code>exit()</code> or via return from the program's <code>main()</code>. The function is passed the status argument given to the last call to <code>exit()</code> and the <code>arg</code> argument from <code>on_exit()</code>. @@ -2565,25 +2565,25 @@ on this thread of execution. <b>NOTE</b>: <code>CONFIG_SCHED_ONEXIT</code> must be defined to enable this function </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>func</code>. A pointer to the function to be called when the task exits.</li> <li><code>arg</code>. An argument that will be provided to the <code>on_exit()</code> function when the task exits.</li> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> On success, <code>on_exit()</code> returns OK (0). On error, ERROR (-1) is returned, and <a href="#ErrnoAccess"><code>errno</code></a> is set to indicate the cause of the failure. </p> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> This function comes from SunOS 4, but is also present in libc4, libc5 and glibc. It no longer occurs in Solaris (SunOS 5). - Avoid this function, and use the standard <code>atexit()</code> instead. + Avoid this function, and use the standard <code>atexit()</code> instead. </p> <ol> <li>Only a single <code>on_exit</code> function can be registered unless <code>CONFIG_SCHED_ONEXIT_MAX</code> defines a larger number.</li> @@ -2619,7 +2619,7 @@ on this thread of execution. <H3><a name="mqopen">2.4.1 mq_open</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <mqueue.h> mqd_t mq_open(const char *mqName, int oflags, ...); @@ -2632,7 +2632,7 @@ call of mq_open(), the task can reference the message queue using the address returned by the call. The message queue remains usable until it is closed by a successful call to mq_close(). <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>mqName</code>. Name of the queue to open <li><code>oflags</code>. Open flags. These may be any combination of: @@ -2668,13 +2668,13 @@ message that can be sent or received. Other elements of attr are ignored </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>A message queue descriptor or -1 (<code>ERROR</code>) </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -2688,7 +2688,7 @@ message size is limited at 22 bytes. <H3><a name="mqclose">2.4.2 mq_close</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <mqueue.h> int mq_close(mqd_t mqdes); @@ -2705,20 +2705,20 @@ queue via this <code>mqdes</code> (see <code>mq_notify()</code>), this attachmen removed and the message queue is available for another task to attach for notification. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>mqdes</code>. Message queue descriptor. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) if the message queue is closed successfully, otherwise, -1 (<code>ERROR</code>). </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <ul> <li> @@ -2735,7 +2735,7 @@ of the same name. <H3><a name="mqunlink">2.4.3 mq_unlink</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <mqueue.h> int mq_unlink(const char *mqName); @@ -2748,7 +2748,7 @@ open when <code>mq_unlink()</code> is called, removal of the message queue is postponed until all references to the message queue have been closed. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>mqName</code>. Name of the message queue </ul> @@ -2756,14 +2756,14 @@ closed. <p> <b>Returned Value:</b> None. <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. <H3><a name="mqsend">2.4.4 mq_send</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> </p> <pre> #include <mqueue.h> @@ -2808,7 +2808,7 @@ interface of the same name. </li> </ul> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>mqdes</code>. Message queue descriptor.</li> @@ -2845,7 +2845,7 @@ interface of the same name. </li> </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -2853,7 +2853,7 @@ interface of the same name. </p> <h3><a name="mqtimedsend">mq_timedsend</a></h3> -<b>Function Prototype:</b> +<b>Function Prototype:</b> </p> <pre> #include <mqueue.h> @@ -2891,7 +2891,7 @@ interface of the same name. of the call, <code>mq_timedsend()</code> returns immediately. </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>mqdes</code>. Message queue descriptor.</li> @@ -2928,7 +2928,7 @@ interface of the same name. </li> </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -2937,7 +2937,7 @@ interface of the same name. <h3><a name="mqreceive">2.4.5 mq_receive</a></h3> <p> - <b>Function Prototype:</b> + <b>Function Prototype:</b> </p> <pre> #include <mqueue.h> @@ -2962,7 +2962,7 @@ interface of the same name. If the queue is empty and <code>O_NONBLOCK</code> is set, <code>ERROR</code> will be returned. </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>mqdes</code>. Message Queue Descriptor.</li> @@ -2998,7 +2998,7 @@ interface of the same name. </li> </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -3007,7 +3007,7 @@ interface of the same name. <h3><a name="mqtimedreceive">2.4.6 mq_timedreceive</a></h3> <p> - <b>Function Prototype:</b> + <b>Function Prototype:</b> </p> <pre> #include <mqueue.h> @@ -3042,7 +3042,7 @@ interface of the same name. the call, <code>mq_timedreceive()</code> returns immediately. </p> <p> - <b>Input Parameters:</b> + <b>Input Parameters:</b> </p> <ul> <li><code>mqdes</code>. Message Queue Descriptor.</li> @@ -3083,7 +3083,7 @@ interface of the same name. </li> </ul> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -3093,7 +3093,7 @@ interface of the same name. <h3><a name="mqnotify">2.4.7 mq_notify</a></h3> <p> - <b>Function Prototype:</b> + <b>Function Prototype:</b> <pre> #include <mqueue.h> int mq_notify(mqd_t mqdes, const struct sigevent *notification); @@ -3135,16 +3135,16 @@ interface of the same name. <code>errno</code> set to indicate the error: <ul> <li> - <code>EBADF</code>. The descriptor specified in <code>mqdes</code> is invalid. + <code>EBADF</code>. The descriptor specified in <code>mqdes</code> is invalid. </li> <li> <code>EBUSY</code>. Another process has already registered to receive notification - for this message queue. + for this message queue. </li> <li> <code>EINVAL</code>. <code>sevp->sigev_notify</code> is not one of the permitted values; or <code>sevp->sigev_notify</code> is <code>SIGEV_SIGNAL</code> and <code>sevp->sigev_signo</code> is not a - valid signal number. + valid signal number. </li> <li> <code>ENOMEM</code>. Insufficient memory. @@ -3174,7 +3174,7 @@ interface of the same name. <H3><a name="mqsetattr">2.4.8 mq_setattr</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <mqueue.h> int mq_setattr(mqd_t mqdes, const struct mq_attr *mqStat, @@ -3190,7 +3190,7 @@ If "oldMqStat" is non-null, mq_setattr() will store the previous message queue attributes at that location (just as would have been returned by mq_getattr()). <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>mqdes</code>. Message queue descriptor <li><code>mqStat</code>. New attributes @@ -3198,14 +3198,14 @@ would have been returned by mq_getattr()). </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) if attributes are set successfully, otherwise -1 (<code>ERROR</code>). </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3213,7 +3213,7 @@ interface of the same name. <H3><a name="mqgetattr">2.4.9 mq_getattr</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <mqueue.h> int mq_getattr(mqd_t mqdes, struct mq_attr *mqStat); @@ -3223,7 +3223,7 @@ interface of the same name. <b>Description:</b> This functions gets status information and attributes associated with the specified message queue. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>mqdes</code>. Message queue descriptor <li><code>mqStat</code>. Buffer in which to return attributes. The returned @@ -3238,13 +3238,13 @@ attributes include: </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) if attributes provided, -1 (<code>ERROR</code>) otherwise. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3400,7 +3400,7 @@ interface of the same name. <H3><a name="seminit">2.5.1 sem_init</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_init(sem_t *sem, int pshared, unsigned int value); @@ -3417,21 +3417,21 @@ result of referring to copies of <code>sem</code> in calls to <code>sem_wait()</ <code>sem_trywait()</code>, <code>sem_post()</code>, and <code>sem_destroy()</code>, is not defined. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sem</code>. Semaphore to be initialized <li><code>pshared</code>. Process sharing (not used) -<li><code>value</code>. Semaphore initialization value +<li><code>value</code>. Semaphore initialization value </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if unsuccessful. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3443,7 +3443,7 @@ Differences from the full POSIX implementation include: <H3><a name="semdestroy">2.5.2 sem_destroy</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_destroy(sem_t *sem); @@ -3460,19 +3460,19 @@ effect of subsequent use of the semaphore <code>sem</code> is undefined until The effect of destroying a semaphore upon which other tasks are currently blocked is undefined. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sem</code>. Semaphore to be destroyed. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if unsuccessful. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3480,7 +3480,7 @@ interface of the same name. <H3><a name="semopen">2.5.3 sem_open</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> sem_t *sem_open(const char *name, int oflag, ...); @@ -3499,7 +3499,7 @@ If a task makes multiple calls to sem_open() with the same name, then the same semaphore address is returned (provided there have been no calls to sem_unlink()). <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>name</code>. Semaphore name <li><code>oflag</code>. Semaphore creation options. This may one of @@ -3516,7 +3516,7 @@ a new semaphore unless one of this name already exists. NOTE: When the O_CREAT flag is specified, POSIX requires that a third and fourth parameter be supplied: <ul> -<li><code>mode</code>. The mode parameter is of type mode_t. +<li><code>mode</code>. The mode parameter is of type mode_t. This parameter is required but not used in the present implementation. <li><code>value</code>. The value parameter is type unsigned int. The semaphore @@ -3527,13 +3527,13 @@ semaphores must be less than or equal to <code>SEM_VALUE_MAX</code> (defined in </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>A pointer to sem_t or -1 (<code>ERROR</code>) if unsuccessful. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3546,7 +3546,7 @@ just a counting semaphore. <H3><a name="semclose">2.5.4 sem_close</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_close(sem_t *sem); @@ -3566,13 +3566,13 @@ will vanish when the last task closes it. Care must be taken to avoid risking the deletion of a semaphore that another calling task has already locked. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sem</code>. Semaphore descriptor </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if unsuccessful. </ul> @@ -3591,7 +3591,7 @@ interface of the same name. <H3><a name="semunlink">2.5.5 sem_unlink</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_unlink(const char *name); @@ -3604,19 +3604,19 @@ name open when sem_unlink() is called, destruction of the semaphore will be postponed until all references have been destroyed by calls to sem_close(). <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>name</code>. Semaphore name </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if unsuccessful. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <ul> <li>Care must be taken to avoid deletion of a semaphore that another task has already locked. @@ -3637,7 +3637,7 @@ same name should be created after sem_unlink() is called. <H3><a name="semwait">2.5.6 sem_wait</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_wait(sem_t *sem); @@ -3649,13 +3649,13 @@ referenced by sem. If the semaphore as already locked by another task, the calling task will not return until it either successfully acquires the lock or the call is interrupted by a signal. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sem</code>. Semaphore descriptor. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) is unsuccessful </ul> @@ -3671,7 +3671,7 @@ not valid. received by this task. In this case, the semaphore has not be acquired. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3679,7 +3679,7 @@ interface of the same name. <H3><a name="semtimedwait">2.5.7 sem_timedwait</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> #include <time.h> @@ -3687,7 +3687,7 @@ interface of the same name. </pre> <p> -<b>Description:</b> +<b>Description:</b> This function will lock the semaphore referenced by sem as in the <code>sem_wait()</code> function. However, if the semaphore cannot be locked without waiting for another process or thread to unlock the semaphore by performing a <code>sem_post()</code> function, this wait will be terminated when the specified timeout expires. </p> @@ -3695,7 +3695,7 @@ interface of the same name. This function attempts to lock the semaphore referenced by <code>sem</code>. If the semaphore as already locked by another task, the calling task will not return until it either successfully acquires the lock or the call is interrupted by a signal. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li> <code>sem</code>. Semaphore descriptor. @@ -3706,7 +3706,7 @@ interface of the same name. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) is unsuccessful </ul> @@ -3748,7 +3748,7 @@ The following lists the possible values for <a href="#ErrnoAccess"><code>errno</ <H3><a name="semtrywait">2.5.8 sem_trywait</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_trywait(sem_t *sem); @@ -3759,13 +3759,13 @@ The following lists the possible values for <a href="#ErrnoAccess"><code>errno</ only if the semaphore is currently not locked. In any event, the call returns without blocking. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sem</code>. The semaphore descriptor </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) or -1 (<code>ERROR</code>) if unsuccessful </ul> @@ -3781,7 +3781,7 @@ not valid. <p> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3789,7 +3789,7 @@ interface of the same name. <H3><a name="sempost">2.5.9 sem_post</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_post(sem_t *sem); @@ -3810,13 +3810,13 @@ return successfully from its call to <code>sem_wait()</code>. <p> <b>NOTE</b>: <code>sem_post()</code> may be called from an interrupt handler. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sem</code>. Semaphore descriptor </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) or -1 (<code>ERROR</code>) if unsuccessful. </ul> @@ -3832,7 +3832,7 @@ interface of the same name. <H3><a name="semgetvalue">2.5.10 sem_getvalue</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <semaphore.h> int sem_getvalue(sem_t *sem, int *sval); @@ -3850,20 +3850,20 @@ If sem is locked, the value return by sem_getvalue() will either be zero or a negative number whose absolute value represents the number of tasks waiting for the semaphore. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sem</code>. Semaphore descriptor <li><code>sval</code>. Buffer by which the value is returned </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) or -1 (<code>ERROR</code>) if unsuccessful. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -3897,7 +3897,7 @@ interface of the same name. <H3><a name="wdcreate">2.6.1 wd_create</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <wdog.h> WDOG_ID wd_create(void); @@ -3909,7 +3909,7 @@ by allocating the appropriate resources for the watchdog. <p> <b>Input Parameters:</b> None. <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>Pointer to watchdog that may be used as a handle in subsequent NuttX calls (i.e., the watchdog ID), or NULL if insufficient resources @@ -3917,7 +3917,7 @@ are available to create the watchdogs. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> This is a NON-POSIX interface. VxWorks provides the following comparable interface: @@ -3935,7 +3935,7 @@ initialization time). <H3><a name="wddelete">2.6.2 wd_delete</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <wdog.h> int wd_delete(WDOG_ID wdog); @@ -3946,14 +3946,14 @@ initialization time). watchdog. The watchdog will be removed from the timer queue if has been started. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>wdog</code>. The watchdog ID to delete. This is actually a pointer to a watchdog structure. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>OK or ERROR </ul> @@ -3979,7 +3979,7 @@ before deallocating it (i.e., never returns ERROR). <H3><a name="wdstart">2.6.3 wd_start</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <wdog.h> int wd_start(WDOG_ID wdog, int delay, wdentry_t wdentry, @@ -4000,7 +4000,7 @@ To replace either the timeout delay or the function to be executed, call wd_start again with the same wdog; only the most recent wd_start() on a given watchdog ID has any effect. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>wdog</code>. Watchdog ID <li><code>delay</code>. Delay count in clock ticks @@ -4010,7 +4010,7 @@ wd_start() on a given watchdog ID has any effect. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>OK or ERROR </ul> @@ -4031,12 +4031,12 @@ Differences from the VxWorks interface include: <ul> <li>The present implementation supports multiple parameters passed to wdentry; VxWorks supports only a single parameter. The maximum -number of parameters is determined by +number of parameters is determined by </ul> <H3><a name="wdcancel">2.6.4 wd_cancel</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <wdog.h> int wd_cancel(WDOG_ID wdog); @@ -4047,19 +4047,19 @@ number of parameters is determined by watchdog timer. Watchdog timers may be canceled from the interrupt level. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>wdog</code>. ID of the watchdog to cancel. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>OK or ERROR </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b>POSIX Compatibility:</b> This is a NON-POSIX interface. VxWorks provides the following comparable interface: @@ -4076,7 +4076,7 @@ VxWorks provides the following comparable interface: Sint wd_gettime(WDOG_ID wdog); </pre> <p> - <b>Description:</b> + <b>Description:</b> This function returns the time remaining before the specified watchdog expires. </p> <p> @@ -4086,7 +4086,7 @@ VxWorks provides the following comparable interface: </ul> </p> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> The time in system ticks remaining until the watchdog time expires. Zero means either that wdog is not valid or that the wdog has already expired. </p> @@ -4483,7 +4483,7 @@ VxWorks provides the following comparable interface: </p> <p> If the timer_gettime() succeeds, a value of 0 (<code>OK</code>) will be returned. - If an error occurs, the value -1 (<code>ERROR</code>) will be returned, and + If an error occurs, the value -1 (<code>ERROR</code>) will be returned, and <a href="#ErrnoAccess"><code>errno</code></a> set to indicate the error. </p> <ul> @@ -4564,7 +4564,7 @@ VxWorks provides the following comparable interface: <code>timer_getoverrun()</code> function will return the timer expiration overrun count for the specified timer. The overrun count returned contains the number of extra timer expirations that occurred between the time the signal was generated - (queued) and when it was delivered or accepted, up to but not including an + (queued) and when it was delivered or accepted, up to but not including an implementation-defined maximum of <code>DELAYTIMER_MAX</code>. If the number of such extra expirations is greater than or equal to <code>DELAYTIMER_MAX</code>, then the overrun count will be set to <code>DELAYTIMER_MAX</code>. The value returned by @@ -4722,7 +4722,7 @@ interface of the same name. <H3><a name="sigemptyset">2.8.1 sigemptyset</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigemptyset(sigset_t *set); @@ -4732,19 +4732,19 @@ interface of the same name. <b>Description:</b> This function initializes the signal set specified by set such that all signals are excluded. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. Signal set to initialize. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if the signal set cannot be initialized. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -4752,7 +4752,7 @@ interface of the same name. <H3><a name="sigfillset">2.8.2 sigfillset</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigfillset(sigset_t *set); @@ -4762,19 +4762,19 @@ interface of the same name. <b>Description:</b> This function initializes the signal set specified by set such that all signals are included. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. Signal set to initialize </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if the signal set cannot be initialized. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -4782,7 +4782,7 @@ interface of the same name. <H3><a name="sigaddset">2.8.3 sigaddset</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigaddset(sigset_t *set, int signo); @@ -4792,20 +4792,20 @@ interface of the same name. <b>Description:</b> This function adds the signal specified by signo to the signal set specified by set. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. Signal set to add signal to <li><code>signo</code>. Signal to add </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if the signal number is invalid. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -4813,7 +4813,7 @@ interface of the same name. <H3><a name="sigdelset">2.8.4 sigdelset</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigdelset(sigset_t *set, int signo); @@ -4823,20 +4823,20 @@ interface of the same name. <b>Description:</b> This function deletes the signal specified by signo from the signal set specified by set. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. Signal set to delete the signal from <li><code>signo</code>. Signal to delete </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if the signal number is invalid. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -4844,7 +4844,7 @@ interface of the same name. <H3><a name="sigismember">2.8.5 sigismember</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigismember(const sigset_t *set, int signo); @@ -4854,14 +4854,14 @@ interface of the same name. <b>Description:</b> This function tests whether the signal specified by signo is a member of the set specified by set. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. Signal set to test <li><code>signo</code>. Signal to test for </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>1 (TRUE), if the specified signal is a member of the set, <li>0 (OK or FALSE), if it is not, or @@ -4869,7 +4869,7 @@ by signo is a member of the set specified by set. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -4877,7 +4877,7 @@ interface of the same name. <H3><a name="sigaction">2.8.6 sigaction</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigaction(int signo, const struct sigaction *act, @@ -4921,7 +4921,7 @@ Once an action is installed for a specific signal, it remains installed until another action is explicitly requested by another call to sigaction(). <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>sig</code>. Signal of interest <li><code>act</code>. Location of new handler @@ -4929,13 +4929,13 @@ sigaction(). </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if the signal number is invalid. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -4954,7 +4954,7 @@ Differences from the POSIX implementation include: <H3><a name="sigprocmask">2.8.7 sigprocmask</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigprocmask(int how, const sigset_t *set, sigset_t *oset); @@ -4972,7 +4972,7 @@ those signals will be delivered before sigprocmask() returns. <p> If sigprocmask() fails, the signal mask of the task is not changed. <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>how</code>. How the signal mast will be changed: <ul> @@ -4990,13 +4990,13 @@ pointed to by the <code>set</code> input parameter. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>), or -1 (<code>ERROR</code>) if how is invalid. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -5004,7 +5004,7 @@ interface of the same name. <H3><a name="sigpending">2.8.8 sigpending</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigpending(sigset_t *set); @@ -5022,19 +5022,19 @@ with POSIX which states: "If a subsequent occurrence of a pending signal is generated, it is implementation defined as to whether the signal is delivered more than once." <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. The location to return the pending signal set. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>0 (<code>OK</code>) or -1 (<code>ERROR</code>) </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -5042,7 +5042,7 @@ interface of the same name. <H3><a name="sigsuspend">2.8.9 sigsuspend</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigsuspend(const sigset_t *set); @@ -5068,13 +5068,13 @@ suspended. </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>-1 (<code>ERROR</code>) always </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -5090,7 +5090,7 @@ is required in the present implementation (even if the signal is ignored). <H3><a name="sigwaitinfo">2.8.10 sigwaitinfo</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigwaitinfo(const sigset_t *set, struct siginfo *info); @@ -5100,21 +5100,21 @@ is required in the present implementation (even if the signal is ignored). <b>Description:</b> This function is equivalent to sigtimedwait() with a NULL timeout parameter. (see below). <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. The set of pending signals to wait for. <li><code>info</code>. The returned signal values </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>Signal number that cause the wait to be terminated, otherwise -1 (<code>ERROR</code>) is returned. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -5122,7 +5122,7 @@ interface of the same name. <H3><a name="sigtimedwait">2.8.11 sigtimedwait</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigtimedwait(const sigset_t *set, struct siginfo *info, @@ -5148,12 +5148,12 @@ for si_code are defined in signal.h: <li><code>SI_USER</code>. Signal sent from kill, raise, or abort <li><code>SI_QUEUE</code>. Signal sent from sigqueue <li><code>SI_TIMER</code>. Signal is result of timer expiration - <li><code>SI_ASYNCIO</code>. Signal is the result of asynchronous IO completion + <li><code>SI_ASYNCIO</code>. Signal is the result of asynchronous IO completion <li><code>SI_MESGQ</code>. Signal generated by arrival of a message on an empty message queue. </ul> <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>set</code>. The set of pending signals to wait for. <li><code>info</code>. The returned signal values @@ -5161,14 +5161,14 @@ for si_code are defined in signal.h: </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li>Signal number that cause the wait to be terminated, otherwise -1 (<code>ERROR</code>) is returned. </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -5188,7 +5188,7 @@ the unblocked signal is ignored. <H3><a name="sigqueue">2.8.12 sigqueue</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <signal.h> int sigqueue (int tid, int signo, union sigval value); @@ -5206,7 +5206,7 @@ POSIX which states: "If a subsequent occurrence of a pending signal is generated, it is implementation defined as to whether the signal is delivered more than once." <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>tid</code>. ID of the task to receive signal <li><code>signo</code>. Signal number @@ -5214,7 +5214,7 @@ is delivered more than once." </ul> <p> -<b>Returned Value:</b> +<b>Returned Value:</b> <ul> <li> On success (at least one signal was sent), zero (<code>OK</code>) is returned. @@ -5228,7 +5228,7 @@ is delivered more than once." </ul> <p> -<b>Assumptions/Limitations:</b> +<b>Assumptions/Limitations:</b> <p> <b> POSIX Compatibility:</b> Comparable to the POSIX interface of the same name. @@ -5245,7 +5245,7 @@ be sent. <H3><a name="kill">2.8.13 kill</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <sys/types.h> #include <signal.h> @@ -5253,7 +5253,7 @@ be sent. </pre> <p> -<b>Description:</b> +<b>Description:</b> The kill() system call can be used to send any signal to any task. </p> @@ -5266,7 +5266,7 @@ be sent. is delivered more than once." </p> <p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><code>pid</code>. The id of the task to receive the signal. The POSIX <code>kill()</code> specification encodes process group @@ -5278,14 +5278,14 @@ be sent. </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> <ul> <li>OK or ERROR </ul> </p> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -5301,29 +5301,29 @@ be sent. <H3><a name="pause">2.8.14 pause</a></H3> <p> -<b>Function Prototype:</b> +<b>Function Prototype:</b> <pre> #include <unistd.h> int pause(void); </pre> <p> -<b>Description:</b> +<b>Description:</b> The <code>pause()</code> function will suspend the calling thread until delivery of a non-blocked signal. </p> -<b>Input Parameters:</b> +<b>Input Parameters:</b> <ul> <li><i>None</i> </ul> <p> - <b>Returned Value:</b> + <b>Returned Value:</b> Since <code>pause()</code> suspends thread execution indefinitely unless interrupted a signal, there is no successful completion return value. A value of -1 (<code>ERROR</code> will always be returned and errno set to indicate the error (<code>EINTR</code>). </p> <p> - <b>Assumptions/Limitations:</b> + <b>Assumptions/Limitations:</b> </p> <p> <b>POSIX Compatibility:</b> @@ -5405,7 +5405,7 @@ be sent. <li><a href="#pthreadmutexattrgetpshared">2.9.28 pthread_mutexattr_getpshared</a></li> <li><a href="#pthreadmutexattrsetpshared">2.9.29 pthread_mutexattr_setpshared</a></li> <li><a href="#pthreadmutexattrgettype">2.9.30 pthread_mutexattr_gettype</a></li> - <li><a href="#pthreadmutexattrsettype">2.9.31 pthread_mutexattr_settype</a></li> + <li><a href="#pthreadmutexattrsettype">2.9.31 pthread_mutexattr_settype</a></li> <li><a href="#pthreadmutexinit">2.9.32 pthread_mutex_init</a></li> <li><a href="#pthreadmutexdestrory">2.9.33 pthread_mutex_destroy</a></li> <li><a href="#pthreadmutexlock">2.9.34 pthread_mutex_lock</a></li> @@ -6004,7 +6004,7 @@ cancellation state is set to PTHREAD_CANCEL_ENABLE.</p> <b>Input Parameters:</b> <p> <ul> -<li><code>state</code> +<li><code>state</code> New cancellation state. One of PTHREAD_CANCEL_ENABLE or PTHREAD_CANCEL_DISABLE.<.li> <li><code>oldstate</code>. Location to return the previous cancellation state. @@ -6164,7 +6164,7 @@ interface of the same name. </pre> <p> <b>Description:</b> - The <code>pthread_getschedparam()</code> functions will get the + The <code>pthread_getschedparam()</code> functions will get the scheduling policy and parameters of threads. For <code>SCHED_FIFO</code> and <code>SCHED_RR</code>, the only required member of the <code>sched_param</code> structure is the @@ -7321,7 +7321,7 @@ interface of the same name. <b>Description:</b> The <code>pthread_barrier_init()</code> function allocates any resources required to use the barrier referenced by <code>barrier</code> and initialized the barrier with - the attributes referenced by <code>attr</code>. + the attributes referenced by <code>attr</code>. If <code>attr</code> is NULL, the default barrier attributes will be used. The results are undefined if <code>pthread_barrier_init()</code> is called when any thread is blocked on the barrier. @@ -7444,7 +7444,7 @@ interface of the same name. recent <code>pthread_barrier_init()</code> function that referenced it. </p> <p> - The constant <code>PTHREAD_BARRIER_SERIAL_THREAD</code> is defined in + The constant <code>PTHREAD_BARRIER_SERIAL_THREAD</code> is defined in <code>pthread.h</code> and its value must be distinct from any other value returned by <code>pthread_barrier_wait()</code>. </p> @@ -7879,7 +7879,7 @@ interface of the same name. <p> Any user supplied data or logic can be accessed via the pseudo-file system. - Built in support is provided for character and block + Built in support is provided for character and block <a href="NuttxPortingGuide.html#DeviceDrivers">driver</a> <i>nodes</i> in the any pseudo file system directory. (By convention, however, all driver nodes should be in the <code>/dev</code> @@ -7937,8 +7937,8 @@ interface of the same name. <ul><pre> #include <unistd.h> int close(int fd); - int dup(int fildes); - int dup2(int fildes1, int fildes2); + int dup(int fd); + int dup2(int fd1, int fd2); off_t lseek(int fd, off_t offset, int whence); ssize_t read(int fd, void *buf, size_t nbytes); int unlink(const char *path); @@ -8103,7 +8103,7 @@ off_t lseek(int fd, off_t offset, int whence); ssize_t read(int fd, FAR void *buf, size_t nbytes); ssize_t write(int fd, FAR const void *buf, size_t nbytes); -int pipe(int filedes[2]); +int pipe(int fd[2]); int chdir(FAR const char *path); FAR char *getcwd(FAR char *buf, size_t size); @@ -8224,22 +8224,22 @@ void *memmove(void *dest, const void *src, size_t count); </p> <ul><pre> #include <unistd.h> -int pipe(int filedes[2]); +int pipe(int fd[2]); </pre></ul> <p> <b>Description:</b> <ul> <p> <code>pipe()</code> creates a pair of file descriptors, pointing to a pipe inode, and - places them in the array pointed to by <code>filedes</code>. - <code>filedes[0]</code> is for reading, <code>filedes[1]</code> is for writing. + places them in the array pointed to by <code>fd</code>. + <code>fd[0]</code> is for reading, <code>fd[1]</code> is for writing. </p> </ul> </p> <p> <b>Input Parameters:</b> <ul> - <li><code>filedes[2]</code>. The user provided array in which to catch the pipe file descriptors.</li> + <li><code>fd[2]</code>. The user provided array in which to catch the pipe file descriptors.</li> </ul> </p> </p> @@ -8266,7 +8266,7 @@ int mkfifo(FAR const char *pathname, mode_t mode); <p> <code>mkfifo()</code> makes a FIFO device driver file with name <code>pathname</code>. Unlike Linux, a NuttX FIFO is not a special file type but simply a device driver instance. - <code>mode</code> specifies the FIFO's permissions (but is ignored in the current implementation). + <code>mode</code> specifies the FIFO's permissions (but is ignored in the current implementation). </p> <p> Once the FIFO has been created by <code>mkfifo()</code>, any thread can open it for @@ -8316,7 +8316,7 @@ int mkfatfs(FAR const char *pathname, FAR struct fat_format_s *fmt); device specified by <code>pathname</code> </p> <p>Assumptions: The caller must assure that the block driver is not mounted and not in - use when this function is called. + use when this function is called. The result of formatting a mounted device is indeterminate (but likely not good). </p> </ul> @@ -8363,7 +8363,7 @@ struct fat_format_s NULL block driver string, bad number of FATS in <code>fmt</code>, bad FAT size in <code>fmt</code>, bad cluster size in <code>fmt</code> </li> - <li><code>ENOENT</code> - + <li><code>ENOENT</code> - <code>pathname</code> does not refer to anything in the file-system. </li> <li><code>ENOTBLK</code> - @@ -8387,7 +8387,7 @@ struct fat_format_s <p> However, memory mapping of files is the mechanism used by NXFLAT, the NuttX tiny binary format, to get files into memory in order to execute them. - <code>mmap()</code> support is therefore required to support NXFLAT. + <code>mmap()</code> support is therefore required to support NXFLAT. There are two conditions where <code>mmap()</code> can be supported: </p> <ol type="1"> @@ -8618,7 +8618,7 @@ FAR void *mmap(FAR void *start, size_t length, int prot, int flags, int fd, off_ <li><code>ENOSYS</code> - Returned if any of the unsupported <code>mmap()</code> features are attempted. </li> - <li><code>EBADF</code> - + <li><code>EBADF</code> - <code>fd</code> is not a valid file descriptor. </li> <li><code>EINVAL</code> - @@ -8862,7 +8862,7 @@ int listen(int sockfd, int backlog); <li><code>ENOTSOCK</code>: The argument <code>sockfd</code> is not a socket.</li> <li><code>EOPNOTSUPP</code>: The socket is not of a type that supports the listen operation.</li> </ul> - + <h3><a name="accept">2.12.5 accept</a></h3> <p> <b>Function Prototype:</b> |