Last Updated: August 12, 2014
+Last Updated: August 21, 2014
@@ -101,7 +101,8 @@ 4.3.1 Basic System Timer 4.3.2 Hardware 4.3.3 System Tick and Time - 4.3.4 Tickless OS + 4.3.4 Tickless OSmake.
up_initialize()Prototype: void up_initialize(void);
Function Prototype: void up_initialize(void);
Description.
up_initialize() will be called once during OS
@@ -1754,7 +1755,7 @@ The system can be re-made subsequently by just typing make.
up_idle()Prototype: void up_idle(void);
Function Prototype: void up_idle(void);
Description.
up_idle() is the logic that will be executed
@@ -1768,7 +1769,7 @@ The system can be re-made subsequently by just typing make.
up_initial_state()Prototype: void up_initial_state(FAR struct tcb_s *tcb);
Function Prototype: void up_initial_state(FAR struct tcb_s *tcb);
Description.
A new thread is being started and a new TCB has been created.
@@ -1791,7 +1792,7 @@ The system can be re-made subsequently by just typing make.
up_create_stack()Prototype: STATUS up_create_stack(FAR struct tcb_s *tcb, size_t stack_size, uint8_t ttype);
Function Prototype: STATUS up_create_stack(FAR struct tcb_s *tcb, size_t stack_size, uint8_t ttype);
Description.
Allocate a stack for a new thread and setup up stack-related information in the TCB.
@@ -1843,7 +1844,7 @@ The system can be re-made subsequently by just typing make.
up_use_stack()Prototype: +
Function Prototype:
STATUS up_use_stack(FAR struct tcb_s *tcb, FAR void *stack, size_t stack_size);
make.
up_stack_frame()Prototype: FAR void *up_stack_frame(FAR struct tcb_s *tcb, size_t frame_size);
Function Prototype: FAR void *up_stack_frame(FAR struct tcb_s *tcb, size_t frame_size);
Description.
@@ -1932,7 +1933,7 @@ The system can be re-made subsequently by just typing make.
up_release_stack()Prototype: void up_release_stack(FAR struct tcb_s *dtcb);
Function Prototype: void up_release_stack(FAR struct tcb_s *dtcb);
Description.
A task has been stopped.
@@ -1971,7 +1972,7 @@ The system can be re-made subsequently by just typing make.
up_unblock_task()Prototype: void up_unblock_task(FAR struct tcb_s *tcb);
Function Prototype: void up_unblock_task(FAR struct tcb_s *tcb);
Description.
A task is currently in an inactive task list
@@ -1994,7 +1995,7 @@ The system can be re-made subsequently by just typing make.
up_block_task()Prototype: void up_block_task(FAR struct tcb_s *tcb, tstate_t task_state);
Function Prototype: void up_block_task(FAR struct tcb_s *tcb, tstate_t task_state);
Description.
The currently executing task at the head of
@@ -2020,7 +2021,7 @@ The system can be re-made subsequently by just typing make.
up_release_pending()Prototype: void up_release_pending(void);
Function Prototype: void up_release_pending(void);
Description.
When tasks become ready-to-run but cannot run because pre-emption
@@ -2037,7 +2038,7 @@ The system can be re-made subsequently by just typing make.
up_reprioritize_rtr()Prototype: void up_reprioritize_rtr(FAR struct tcb_s *tcb, uint8_t priority);
Function Prototype: void up_reprioritize_rtr(FAR struct tcb_s *tcb, uint8_t priority);
Description.
Called when the priority of a running or
@@ -2072,7 +2073,7 @@ The system can be re-made subsequently by just typing make.
_exit()Prototype: void _exit(int status) noreturn_function;
Function Prototype: void _exit(int status) noreturn_function;
Description.
This function causes the currently executing task to cease
@@ -2086,7 +2087,7 @@ The system can be re-made subsequently by just typing make.
up_assert()Prototype:
+
Function Prototype:
void up_assert(FAR const uint8_t *filename, int linenum);
make.
up_schedule_sigaction()Prototype: +
Function Prototype:
void up_schedule_sigaction(FAR struct tcb_s *tcb, sig_deliver_t sigdeliver);
make.
up_allocate_heap()Prototype: void up_allocate_heap(FAR void **heap_start, size_t *heap_size);
Function Prototype: void up_allocate_heap(FAR void **heap_start, size_t *heap_size);
Description.
This function will be called to dynamically set aside the heap region.
@@ -2153,14 +2154,14 @@ The system can be re-made subsequently by just typing make.
up_interrupt_context()Prototype: bool up_interrupt_context(void)
Function Prototype: bool up_interrupt_context(void)
Description. Return true if we are currently executing in the interrupt handler context.
up_disable_irq()Prototype:
+Function Prototype:
#ifndef CONFIG_ARCH_NOINTC void up_disable_irq(int irq); @@ -2187,7 +2188,7 @@ The system can be re-made subsequently by just typingmake.4.2.18
-up_enable_irq()Prototype:
+Function Prototype:
#ifndef CONFIG_ARCH_NOINTC void up_enable_irq(int irq); @@ -2208,7 +2209,7 @@ The system can be re-made subsequently by just typingmake.4.2.19
-up_prioritize_irq()Prototype:
+Function Prototype:
#ifdef CONFIG_ARCH_IRQPRIO void up_enable_irq(int irq); @@ -2226,7 +2227,7 @@ The system can be re-made subsequently by just typingmake.4.2.20
-up_putc()Prototype:
+int up_putc(int ch);Function Prototype:
int up_putc(int ch);Description. This is a debug interface exported by the architecture-specific logic. Output one character on the console @@ -2555,7 +2556,7 @@ config ARCH_SIM
4.3.4.4.1
-up_timer_initialize()Prototype:
+Function Prototype:
#include <nuttx/arch.h> void up_timer_initialize(void); @@ -2578,7 +2579,7 @@ void up_timer_initialize(void);4.3.4.4.2
-up_timer_gettime()Prototype:
+
Function Prototype:
#include <nuttx/arch.h> int up_timer_gettime(FAR struct timespec *ts); @@ -2602,7 +2603,7 @@ int up_timer_gettime(FAR struct timespec *ts);4.3.4.4.3
-up_alarm_cancel()Prototype:
+
Function Prototype:
#include <nuttx/arch.h> int up_alarm_cancel(FAR struct timespec *ts); @@ -2625,7 +2626,7 @@ int up_alarm_cancel(FAR struct timespec *ts);4.3.4.4.5
-up_alarm_start()Prototype:
+
Function Prototype:
#include <nuttx/arch.h> int up_alarm_start(FAR const struct timespec *ts); @@ -2648,7 +2649,7 @@ int up_alarm_start(FAR const struct timespec *ts);4.3.4.4.5
-up_timer_cancel()Prototype:
+
Function Prototype:
#include <nuttx/arch.h> int up_timer_cancel(FAR struct timespec *ts); @@ -2671,7 +2672,7 @@ int up_timer_cancel(FAR struct timespec *ts);4.3.4.4.6
-up_timer_start()Prototype:
+
Function Prototype:
#include <nuttx/arch.h> int up_timer_start(FAR const struct timespec *ts); @@ -2693,6 +2694,221 @@ int up_timer_start(FAR const struct timespec *ts); May be called from interrupt level handling or from the normal tasking level. Interrupts may need to be disabled internally to assure non-reentrancy. +4.3.5 Watchdog Timer Interfaces
++ NuttX provides a general watchdog timer facility. + This facility allows the NuttX user to specify a watchdog timer function + that will run after a specified delay. + The watchdog timer function will run in the context of the timer interrupt handler. + Because of this, a limited number of NuttX interfaces are available to he watchdog timer function. + However, the watchdog timer function may use
+mq_send(),sigqueue(), + orkill()to communicate with NuttX tasks. +
+Function Prototype: +
+ #include <nuttx/wdog.h> + WDOG_ID wd_create(void); ++ +
+Description: The wd_create function will create a watchdog +by allocating the appropriate resources for the watchdog. +
+Input Parameters: None. +
+Returned Value: +
+Assumptions/Limitations: +
+ POSIX Compatibility: This is a NON-POSIX interface. +VxWorks provides the following comparable interface: +
+ WDOG_ID wdCreate (void); ++ +
+Differences from the VxWorks interface include: +
+Function Prototype: +
+ #include <nuttx/wdog.h> + int wd_delete(WDOG_ID wdog); ++ +
+Description: The wd_delete function will deallocate a +watchdog. The watchdog will be removed from the timer queue if +has been started. +
+Input Parameters: +
wdog. The watchdog ID to delete. This is actually a
+pointer to a watchdog structure.
++Returned Value: +
+Assumptions/Limitations: It is the responsibility of the +caller to assure that the watchdog is inactive before deleting +it. +
+POSIX Compatibility: This is a NON-POSIX interface. +VxWorks provides the following comparable interface: +
+ STATUS wdDelete (WDOG_ID wdog); ++ +
+Differences from the VxWorks interface include: +
+Function Prototype: +
+ #include <nuttx/wdog.h> + int wd_start(WDOG_ID wdog, int delay, wdentry_t wdentry, + int argc, ....); ++ +
+Description: This function adds a watchdog to the timer +queue. The specified watchdog function will be called from the +interrupt level after the specified number of ticks has elapsed. +Watchdog timers may be started from the interrupt level. +
+Watchdog times execute in the context of the timer interrupt handler. +
+Watchdog timers execute only once. +
+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. +
+Input Parameters: +
wdog. Watchdog ID
+delay. Delay count in clock ticks
+wdentry. Function to call on timeout
+argc. The number of uint32_t parameters to pass to wdentry.
+.... uint32_t size parameters to pass to wdentry
++Returned Value: +
+Assumptions/Limitations: The watchdog routine runs in the +context of the timer interrupt handler and is subject to all ISR +restrictions. +
+POSIX Compatibility: This is a NON-POSIX interface. +VxWorks provides the following comparable interface: +
+ STATUS wdStart (WDOG_ID wdog, int delay, FUNCPTR wdentry, int parameter); ++ +
+Differences from the VxWorks interface include: +
+Function Prototype: +
+ #include <nuttx/wdog.h> + int wd_cancel(WDOG_ID wdog); ++ +
+Description: This function cancels a currently running +watchdog timer. Watchdog timers may be canceled from the interrupt +level. +
+Input Parameters: +
wdog. ID of the watchdog to cancel.
++Returned Value: +
+Assumptions/Limitations: +
+POSIX Compatibility: This is a NON-POSIX interface. +VxWorks provides the following comparable interface: +
+ STATUS wdCancel (WDOG_ID wdog); ++ +
+ Function Prototype: +
++ #include <nuttx/wdog.h> + Sint wd_gettime(WDOG_ID wdog); ++
+ Description: + This function returns the time remaining before the specified watchdog expires. +
++ Input Parameters: +
wdog. Identifies the watchdog that the request is for.+ Returned Value: + 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. +
+CPUs that support memory management units (MMUs) may provide address environments within which tasks and their child threads execute. @@ -2763,7 +2979,7 @@ int up_timer_start(FAR const struct timespec *ts);
up_addrenv_create()Prototype:
+Function Prototype:
int up_addrenv_create(size_t envsize, FAR task_addrenv_t *addrenv);
up_addrenv_vaddr()Prototype:
+
Function Prototype:
int up_addrenv_vaddr(FAR task_addrenv_t addrenv, FAR void **vaddr);
up_addrenv_select()Prototype:
+
Function Prototype:
int up_addrenv_select(task_addrenv_t addrenv, hw_addrenv_t *oldenv);
up_addrenv_restore()Prototype:
+
Function Prototype:
int up_addrenv_restore(hw_addrenv_t oldenv);
up_addrenv_destroy()Prototype:
+
Function Prototype:
int up_addrenv_destroy(task_addrenv_t addrenv);
up_addrenv_assign()Prototype:
+
Function Prototype:
int up_addrenv_assign(task_addrenv_t addrenv, FAR struct tcb_s *tcb);
up_addrenv_share()Prototype:
+
Function Prototype:
int up_addrenv_share(FAR const struct tcb_s *ptcb, FAR struct tcb_s *ctcb);
up_addrenv_release()Prototype:
+
Function Prototype:
int up_addrenv_release(FAR struct tcb_s *tcb);
sched_process_timer()Prototype: void sched_process_timer(void);
Function Prototype: void sched_process_timer(void);
Description. This function handles system timer events. @@ -2950,7 +3166,7 @@ int up_timer_start(FAR const struct timespec *ts);
sched_timer_expiration()Prototype:
+
Function Prototype:
#include <nuttx/arch.h> void sched_timer_expiration(void); @@ -2973,7 +3189,7 @@ void sched_timer_expiration(void);4.5.5
-sched_alaram_expiration()Prototype:
+
Function Prototype:
#include <nuttx/arch.h> void sched_timer_expiration(void); @@ -2996,7 +3212,7 @@ void sched_timer_expiration(void);4.5.6
-irq_dispatch()Prototype:
+void irq_dispatch(int irq, FAR void *context);Function Prototype:
void irq_dispatch(int irq, FAR void *context);Description. This function must be called from the architecture- diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html index 9c8b5adb045..07246ff7e82 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 13, 2014
+Last Updated: August 21, 2014
@@ -57,13 +57,12 @@
- 2.6 Watchdog Timer Interfaces- |
-
- NuttX provides a general watchdog timer facility.
- This facility allows the NuttX user to specify a watchdog timer function
- that will run after a specified delay.
- The watchdog timer function will run in the context of the timer interrupt handler.
- Because of this, a limited number of NuttX interfaces are available to he watchdog timer function.
- However, the watchdog timer function may use mq_send(), sigqueue(),
- or kill() to communicate with NuttX tasks.
-
-Function Prototype: -
- #include <wdog.h> - WDOG_ID wd_create(void); -- -
-Description: The wd_create function will create a watchdog -by allocating the appropriate resources for the watchdog. -
-Input Parameters: None. -
-Returned Value: -
-Assumptions/Limitations: -
- POSIX Compatibility: This is a NON-POSIX interface. -VxWorks provides the following comparable interface: -
- WDOG_ID wdCreate (void); -- -
-Differences from the VxWorks interface include: -
-Function Prototype: -
- #include <wdog.h> - int wd_delete(WDOG_ID wdog); -- -
-Description: The wd_delete function will deallocate a -watchdog. The watchdog will be removed from the timer queue if -has been started. -
-Input Parameters: -
wdog. The watchdog ID to delete. This is actually a
-pointer to a watchdog structure.
--Returned Value: -
-Assumptions/Limitations: It is the responsibility of the -caller to assure that the watchdog is inactive before deleting -it. -
-POSIX Compatibility: This is a NON-POSIX interface. -VxWorks provides the following comparable interface: -
- STATUS wdDelete (WDOG_ID wdog); -- -
-Differences from the VxWorks interface include: -
-Function Prototype: -
- #include <wdog.h> - int wd_start(WDOG_ID wdog, int delay, wdentry_t wdentry, - int argc, ....); -- -
-Description: This function adds a watchdog to the timer -queue. The specified watchdog function will be called from the -interrupt level after the specified number of ticks has elapsed. -Watchdog timers may be started from the interrupt level. -
-Watchdog times execute in the context of the timer interrupt handler. -
-Watchdog timers execute only once. -
-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. -
-Input Parameters: -
wdog. Watchdog ID
-delay. Delay count in clock ticks
-wdentry. Function to call on timeout
-argc. The number of uint32_t parameters to pass to wdentry.
-.... uint32_t size parameters to pass to wdentry
--Returned Value: -
-Assumptions/Limitations: The watchdog routine runs in the -context of the timer interrupt handler and is subject to all ISR -restrictions. -
-POSIX Compatibility: This is a NON-POSIX interface. -VxWorks provides the following comparable interface: -
- STATUS wdStart (WDOG_ID wdog, int delay, FUNCPTR wdentry, int parameter); -- -
-Differences from the VxWorks interface include: -
-Function Prototype: -
- #include <wdog.h> - int wd_cancel(WDOG_ID wdog); -- -
-Description: This function cancels a currently running -watchdog timer. Watchdog timers may be canceled from the interrupt -level. -
-Input Parameters: -
wdog. ID of the watchdog to cancel.
--Returned Value: -
-Assumptions/Limitations: -
-POSIX Compatibility: This is a NON-POSIX interface. -VxWorks provides the following comparable interface: -
- STATUS wdCancel (WDOG_ID wdog); -- -
- Function Prototype: -
-- #include <wdog.h> - Sint wd_gettime(WDOG_ID wdog); --
- Description: - This function returns the time remaining before the specified watchdog expires. -
-- Input Parameters: -
wdog. Identifies the watchdog that the request is for.- Returned Value: - 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. -
- -
- 2.7 Clocks and Timers+2.6 Clocks and Timers |
Function Prototype:
@@ -4144,7 +3921,7 @@ VxWorks provides the following comparable interface:To be provided.Function Prototype:
@@ -4172,7 +3949,7 @@ VxWorks provides the following comparable interface:To be provided.Function Prototype:
@@ -4200,7 +3977,7 @@ VxWorks provides the following comparable interface:To be provided.Function Prototype:
@@ -4228,7 +4005,7 @@ VxWorks provides the following comparable interface:To be provided.Function Prototype:
@@ -4261,13 +4038,13 @@ VxWorks provides the following comparable interface:To be provided.
#include <time.h>
#define localtime(c) gmtime(c)
-Function Prototype:
@@ -4301,13 +4078,13 @@ VxWorks provides the following comparable interface:To be provided.
#include <time.h>
#define localtime_r(c,r) gmtime_r(c,r)
-Function Prototype:
@@ -4377,7 +4154,7 @@ VxWorks provides the following comparable interface:CLOCK_REALTIME is supported for the clockid argument.Function Prototype:
@@ -4416,7 +4193,7 @@ VxWorks provides the following comparable interface: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -4499,7 +4276,7 @@ VxWorks provides the following comparable interface:ovalue argument is ignored.Function Prototype:
@@ -4546,7 +4323,7 @@ VxWorks provides the following comparable interface: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -4607,7 +4384,7 @@ VxWorks provides the following comparable interface: interface of the same name. -Function Prototype:
@@ -4637,7 +4414,7 @@ interface of the same name.
- 2.8 Signal Interfaces+2.7 Signal Interfaces |
Function Prototype: @@ -4749,7 +4526,7 @@ by set such that all signals are excluded. POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype: @@ -4779,7 +4556,7 @@ by set such that all signals are included. POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype: @@ -4810,7 +4587,7 @@ signo to the signal set specified by set. POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype: @@ -4841,7 +4618,7 @@ by signo from the signal set specified by set. POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype: @@ -4874,7 +4651,7 @@ by signo is a member of the set specified by set. POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype: @@ -4951,7 +4728,7 @@ Differences from the POSIX implementation include: -
Function Prototype:
@@ -5001,7 +4778,7 @@ pointed to by the set input parameter.
POSIX Compatibility: Comparable to the POSIX
interface of the same name.
-
Function Prototype: @@ -5039,7 +4816,7 @@ is delivered more than once." POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype: @@ -5087,7 +4864,7 @@ function or to terminate the task." Only delivery of the signal is required in the present implementation (even if the signal is ignored). -
Function Prototype: @@ -5119,7 +4896,7 @@ with a NULL timeout parameter. (see below). POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype: @@ -5185,7 +4962,7 @@ that the unblocked signal be caught; the task will be resumed even if the unblocked signal is ignored. -
Function Prototype: @@ -5242,7 +5019,7 @@ There is no null signal in the present implementation; a zero signal will be sent. -
Function Prototype: @@ -5298,7 +5075,7 @@ be sent.
Function Prototype: @@ -5334,7 +5111,7 @@ be sent.
- 2.9 Pthread Interfaces+2.8 Pthread Interfaces |
Thread Specific Data. @@ -5391,64 +5168,64 @@ be sent. (2) The main task thread does not had thread-specific data.
pthread Mutexes.
Condition Variables.
Barriers.
Initialization.
Signals.
@@ -5505,7 +5282,7 @@ be sent.
pthread_testcancel. set cancelability state.Function Prototype:
@@ -5538,7 +5315,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name.
-
Function Prototype:
@@ -5570,7 +5347,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name.
-
Function Prototype:
@@ -5601,7 +5378,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5632,7 +5409,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5664,7 +5441,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5696,7 +5473,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5728,7 +5505,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name.
-
Function Prototype:
@@ -5760,7 +5537,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5791,7 +5568,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5822,7 +5599,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5861,7 +5638,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5894,7 +5671,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5926,7 +5703,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -5982,7 +5759,7 @@ the time when cancellation is re-enabled.
Function Prototype:
@@ -6024,7 +5801,7 @@ No thread could be found corresponding to that specified by the given thread ID. POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6055,7 +5832,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6088,7 +5865,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6121,7 +5898,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6153,7 +5930,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6219,7 +5996,7 @@ interface of the same name. Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -6311,7 +6088,7 @@ interface of the same name. Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -6366,7 +6143,7 @@ interface of the same name.
Function Prototype:
@@ -6416,7 +6193,7 @@ interface of the same name. destructor function. -
Function Prototype:
@@ -6457,7 +6234,7 @@ interface of the same name. destructor function. -
Function Prototype:
@@ -6489,7 +6266,7 @@ this function does nothing in the present implementation. POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6520,7 +6297,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6551,7 +6328,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6583,7 +6360,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6615,7 +6392,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6650,7 +6427,7 @@ returned to indicate the error:
POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6704,7 +6481,7 @@ returned to indicate the error:
POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6736,7 +6513,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6767,7 +6544,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6833,7 +6610,7 @@ Otherwise, an error number will be returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6873,7 +6650,7 @@ Otherwise, an error number will be returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6919,7 +6696,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6950,7 +6727,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -6981,7 +6758,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -7012,7 +6789,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -7043,7 +6820,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -7074,7 +6851,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -7105,7 +6882,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -7136,7 +6913,7 @@ returned to indicate the error: POSIX Compatibility: Comparable to the POSIX interface of the same name. -
Function Prototype:
@@ -7173,7 +6950,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7206,7 +6983,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7238,7 +7015,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7276,7 +7053,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7308,7 +7085,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7378,7 +7155,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7422,7 +7199,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7482,7 +7259,7 @@ interface of the same name. -Function Prototype:
@@ -7526,7 +7303,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7588,7 +7365,7 @@ interface of the same name. POSIX Compatibility: Comparable to the POSIX interface of the same name. -Function Prototype:
@@ -7647,7 +7424,7 @@ interface of the same name.
- 2.10 Environment Variables+2.9 Environment Variables |
getenvputenvclearenvsetenvunsetenvgetenvputenvclearenvsetenvunsetenvDisabling Environment Variable Support.
All support for environment variables can be disabled by setting CONFIG_DISABLE_ENVIRON
in the board configuration file.
getenvgetenvFunction Prototype:
@@ -7718,7 +7495,7 @@ interface of the same name. The value of the variable (read-only) or NULL on failure. -putenvputenvFunction Prototype:
@@ -7749,7 +7526,7 @@ interface of the same name. Zero on success. -clearenvclearenvFunction Prototype:
@@ -7771,7 +7548,7 @@ interface of the same name. Zero on success. -setenvsetenvFunction Prototype:
@@ -7809,7 +7586,7 @@ interface of the same name. Zero on success. -unsetenvunsetenvFunction Prototype:
@@ -7839,24 +7616,24 @@ interface of the same name.
- 2.11 File System Interfaces+2.10 File System Interfaces |
mmap() and eXecute In Place (XIP)mmap() and eXecute In Place (XIP)Overview. NuttX includes an optional, scalable file system. @@ -7916,23 +7693,23 @@ interface of the same name. in a file-system-like name space.
-fcntl.hunistd.hsys/ioctl.hpoll.hsys/select.hfcntl.hunistd.hsys/ioctl.hpoll.hsys/select.h#include <fcntl.h> int open(const char *path, int oflag, ...);-
#include <unistd.h> @@ -7945,16 +7722,16 @@ interface of the same name. ssize_t write(int fd, const void *buf, size_t nbytes);-
#include <sys/ioctl.h> int ioctl(int fd, int req, unsigned long arg);-
Function Prototype:
@@ -8024,9 +7801,9 @@ interface of the same name.ENOSYS. One or more of the drivers supporting the file descriptor does not support the poll method.Function Prototype:
@@ -8070,7 +7847,7 @@ int select(int nfds, FAR fd_set *readfds, FAR fd_set *writefds, seepoll()).
-#include <dirent.h> @@ -8085,7 +7862,7 @@ int telldir(FAR DIR *dirp);-
#include <unistd.h> @@ -8121,7 +7898,7 @@ int getopt(int argc, FAR char *const argv[], FAR const char *optstring);-
#include <stdio.h> @@ -8183,7 +7960,7 @@ int statfs(const char *path, struct statfs *buf); int fstatfs(int fd, struct statfs *buf);-
#include <string.h> @@ -8217,9 +7994,9 @@ void *memmove(void *dest, const void *src, size_t count); # define bzero(s,n) (void)memset(s,0,n)-
pipepipeFunction Prototype:
@@ -8253,7 +8030,7 @@ int pipe(int fd[2]); -mkfifomkfifoFunction Prototype:
@@ -8300,8 +8077,8 @@ int mkfifo(FAR const char *pathname, mode_t mode); -mkfatfsmkfatfsFunction Prototype:
@@ -8378,7 +8155,7 @@ struct fat_format_s -mmap() and eXecute In Place (XIP)mmap() and eXecute In Place (XIP)NuttX operates in a flat open address space and is focused on MCUs that do support Memory Management Units (MMUs). Therefore, NuttX generally does not @@ -8507,7 +8284,7 @@ struct fat_format_s -
mmapmmapFunction Prototype:
@@ -8637,7 +8414,7 @@ FAR void *mmap(FAR void *start, size_t length, int prot, int flags, int fd, off_
- 2.12 Network Interfaces+2.11 Network Interfaces |
socketsocketFunction Prototype:
@@ -8705,7 +8482,7 @@ int socket(int domain, int type, int protocol); The protocol type or the specified protocol is not supported within this domain. -bindbindFunction Prototype:
@@ -8747,7 +8524,7 @@ int bind(int sockfd, const struct sockaddr *addr, socklen_t addrlen);sockfd is a descriptor for a file, not a socket.
-connectconnectFunction Prototype:
@@ -8826,7 +8603,7 @@ int connect(int sockfd, const struct sockaddr *addr, socklen_t addrlen); to accept new connections. -Function Prototype:
@@ -8864,7 +8641,7 @@ int listen(int sockfd, int backlog);EOPNOTSUPP: The socket is not of a type that supports the listen operation.Function Prototype:
@@ -8942,7 +8719,7 @@ int accept(int sockfd, struct sockaddr *addr, socklen_t *addrlen); Firewall rules forbid connection. -sendsendFunction Prototype:
@@ -8974,7 +8751,7 @@ ssize_t send(int sockfd, const void *buf, size_t len, int flags); Seesendto().
-sendtosendtoFunction Prototype:
@@ -9047,7 +8824,7 @@ ssize_t send(int sockfd, const void *buf, size_t len, int flags); MSG_NOSIGNAL is set. -recvrecvFunction Prototype:
@@ -9077,7 +8854,7 @@ ssize_t recv(int sockfd, void *buf, size_t len, int flags); Seerecvfrom().
-recvfromrecvfromFunction Prototype:
@@ -9140,7 +8917,7 @@ ssize_t recvfrom(int sockfd, void *buf, size_t len, int flags, The argumentsockfd does not refer to a socket.
-setsockoptsetsockoptFunction Prototype:
@@ -9200,7 +8977,7 @@ int setsockopt(int sockfd, int level, int option, Insufficient resources are available in the system to complete the call. -getsockoptgetsockoptFunction Prototype:
@@ -9593,10 +9370,10 @@ notify a task when a message is available on a queue.