diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 386f1d5668..5ff6b55748 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@

NuttX RTOS Porting Guide

-

Last Updated: August 10, 2014

+

Last Updated: August 12, 2014

@@ -2460,8 +2460,17 @@ config ARCH_SIM
  • - CONFIG_SCHED_TICKLESS: - If CONFIG_ARCH_HAVE_TICKLESS is selected, then it will enable the Tickless OS features in NuttX. + CONFIG_SCHED_TICKLESS: + If CONFIG_ARCH_HAVE_TICKLESS is selected, then it will enable the Tickless OS features in NuttX. +

    +
  • +
  • +

    + CONFIG_SCHED_TICKLESS_ALARM: + The tickless option can be supported either via a simple interval timer (plus elapsed time) or via an alarm. The interval timer allows programming events to occur after an interval. With the alarm, you can set a time in the future and get an event when that alarm goes off. This option selects the use of an alarm. +

    +

    + The advantage of an alarm is that it avoids some small timing errors; the advantage of the use of the interval timer is that the hardware requirement may be less.

  • @@ -2495,6 +2504,27 @@ config ARCH_SIM up_timer_gettime(): Returns the current time from the platform specific time source.
  • + +

    + The tickless option can be supported either via a simple interval timer (plus elapsed time) or via an alarm. The interval timer allows programming events to occur after an interval. With the alarm, you can set a time in* the future and get an event when that alarm goes off. +

    +

    + If CONFIG_SCHED_TICKLESS_ALARM is defined, then the platform code must provide the following: +

    +

    +

    + If CONFIG_SCHED_TICKLESS_ALARM is notdefined, then the platform code must provide the following verify similar functions: +

    +

    Input Parameters:

    Returned Value:

    -
    4.3.4.4.3 up_timer_cancel()
    +
    4.3.4.4.3 up_alarm_cancel()
    +

    Prototype:

    +

    +

    Description:

    + Cancel the alarm and return the time of cancellation of the alarm. These two steps need to be as nearly atomic as possible. sched_timer_expiration() will not be called unless the alarm is restarted with up_alarm_start(). If, as a race condition, the alarm has already expired when this function is called, then time returned is the current time. + +

    Input Parameters:

    + +

    Returned Value:

    + +

    Assumptions:

    + + +
    4.3.4.4.5 up_alarm_start()
    +

    Prototype:

    +

    +

    Description:

    + Start the alarm. sched_timer_expiration() will be called when the alarm occurs (unless up_alaram_cancel is called to stop it). + +

    Input Parameters:

    + +

    Returned Value:

    + +

    Assumptions:

    + + +
    4.3.4.4.5 up_timer_cancel()

    Prototype:

    -
    4.3.4.4.4 up_timer_start()
    +
    4.3.4.4.6 up_timer_start()

    Prototype: