Rename sched_timer_expiration to nxsched_timer_expiration. That is the appropriate name for an internal sched/ function (still many named incorrectly).

This commit is contained in:
Gregory Nutt 2019-03-20 19:31:43 -06:00
parent b290160b3b
commit 9acb652e29
12 changed files with 57 additions and 57 deletions

View File

@ -158,7 +158,7 @@
<a href="#osstart">4.7.1 <code>nx_start()</code></a><br>
<a href="#listmgmt">4.7.2 OS List Management APIs</a><br>
<a href="#schedprocesstimer">4.7.3 <code>nxsched_process_timer()</code></a><br>
<a href="#schedtimerexpiration">4.7.4 <code>sched_timer_expiration()</code></a><br>
<a href="#schedtimerexpiration">4.7.4 <code>nxsched_timer_expiration()</code></a><br>
<a href="#schedalarmexpiration">4.7.5 <code>sched_alarm_expiration()</code></a><br>
<a href="#irqdispatch">4.7.6 <code>irq_dispatch()</code></a>
</ul>
@ -2653,7 +2653,7 @@ config ARCH_SIM
<a href="#schedalarmexpiration"><code>sched_alarm_expiration()</code></a>. Called by the platform-specific logic when the alarm expires.
</li>
<li>
<a href="#schedtimerexpiration"><code>sched_timer_expiration()</code></a>. Called by the platform-specific logic when the interval time expires.
<a href="#schedtimerexpiration"><code>nxsched_timer_expiration()</code></a>. Called by the platform-specific logic when the interval time expires.
</li>
</ul>
@ -2711,7 +2711,7 @@ int up_timer_gettime(FAR struct timespec *ts);
int up_alarm_cancel(FAR struct timespec *ts);
</pre></ul>
<p><b>Description</b>:</p>
Cancel the alarm and return the time of cancellation of the alarm. These two steps need to be as nearly atomic as possible. <code>sched_timer_expiration()</code> will not be called unless the alarm is restarted with <code>up_alarm_start()</code>. If, as a race condition, the alarm has already expired when this function is called, then time returned is the current time.
Cancel the alarm and return the time of cancellation of the alarm. These two steps need to be as nearly atomic as possible. <code>nxsched_timer_expiration()</code> will not be called unless the alarm is restarted with <code>up_alarm_start()</code>. If, as a race condition, the alarm has already expired when this function is called, then time returned is the current time.
<ul>
</ul>
<p><b>Input Parameters</b>:</p>
@ -2734,12 +2734,12 @@ int up_alarm_cancel(FAR struct timespec *ts);
int up_alarm_start(FAR const struct timespec *ts);
</pre></ul>
<p><b>Description</b>:</p>
Start the alarm. <code>sched_timer_expiration()</code> will be called when the alarm occurs (unless <code>up_alarm_cancel</code> is called to stop it).
Start the alarm. <code>nxsched_timer_expiration()</code> will be called when the alarm occurs (unless <code>up_alarm_cancel</code> is called to stop it).
<ul>
</ul>
<p><b>Input Parameters</b>:</p>
<ul>
<li><code>ts</code>: The time in the future at the alarm is expected to occur. When the alarm occurs the timer logic will call <code>sched_timer_expiration()</code>.</li>
<li><code>ts</code>: The time in the future at the alarm is expected to occur. When the alarm occurs the timer logic will call <code>nxsched_timer_expiration()</code>.</li>
</ul>
<p><b>Returned Value</b>:</p>
<ul>
@ -2757,7 +2757,7 @@ int up_alarm_start(FAR const struct timespec *ts);
int up_timer_cancel(FAR struct timespec *ts);
</pre></ul>
<p><b>Description</b>:</p>
Cancel the interval timer and return the time remaining on the timer. These two steps need to be as nearly atomic as possible. <code>sched_timer_expiration()</code> will not be called unless the timer is restarted with <code>up_timer_start()</code>. If, as a race condition, the timer has already expired when this function is called, then that pending interrupt must be cleared so that <code>sched_timer_expiration()</code> is not called spuriously and the remaining time of zero should be returned.
Cancel the interval timer and return the time remaining on the timer. These two steps need to be as nearly atomic as possible. <code>nxsched_timer_expiration()</code> will not be called unless the timer is restarted with <code>up_timer_start()</code>. If, as a race condition, the timer has already expired when this function is called, then that pending interrupt must be cleared so that <code>nxsched_timer_expiration()</code> is not called spuriously and the remaining time of zero should be returned.
<ul>
</ul>
<p><b>Input Parameters</b>:</p>
@ -2780,12 +2780,12 @@ int up_timer_cancel(FAR struct timespec *ts);
int up_timer_start(FAR const struct timespec *ts);
</pre></ul>
<p><b>Description</b>:</p>
Start the interval timer. <code>sched_timer_expiration()</code> will be called at the completion of the timeout (unless <code>up_timer_cancel()</code> is called to stop the timing).
Start the interval timer. <code>nxsched_timer_expiration()</code> will be called at the completion of the timeout (unless <code>up_timer_cancel()</code> is called to stop the timing).
<ul>
</ul>
<p><b>Input Parameters</b>:</p>
<ul>
<li><code>ts</code>: Provides the time interval until <code>sched_timer_expiration()</code> is called.</li>
<li><code>ts</code>: Provides the time interval until <code>nxsched_timer_expiration()</code> is called.</li>
</ul>
<p><b>Returned Value</b>:</p>
<ul>
@ -3960,11 +3960,11 @@ void nxsched_process_timer(void);
<code>CONFIG_USEC_PER_TICK</code>.
</p>
<h3><a name="schedtimerexpiration">4.7.4 <code>sched_timer_expiration()</code></a></h3>
<h3><a name="schedtimerexpiration">4.7.4 <code>nxsched_timer_expiration()</code></a></h3>
<p><b>Function Prototype</b>:<p>
<ul><pre>
#include &lt;nuttx/arch.h&gt;
void sched_timer_expiration(void);
void nxsched_timer_expiration(void);
</pre></ul>
<p><b>Description</b>:</p>
Description: if <code>CONFIG_SCHED_TICKLESS</code> is defined, then this function is provided by the RTOS base code and called from platform-specific code when the interval timer used to implemented the tick-less OS expires.
@ -3987,7 +3987,7 @@ void sched_timer_expiration(void);
<p><b>Function Prototype</b>:<p>
<ul><pre>
#include &lt;nuttx/arch.h&gt;
void sched_timer_expiration(void);
void nxsched_timer_expiration(void);
</ul>
<p><b>Description</b>:</p>
Description: if <code>CONFIG_SCHED_TICKLESS</code> is defined, then this function is provided by the RTOS base code and called from platform-specific code when the interval timer used to implemented the tick-less OS expires.

View File

@ -530,7 +530,7 @@ static inline void lpc43_tl_alarm(uint32_t curr)
up_timer_gettime(&ts);
sched_alarm_expiration(&ts);
#else
sched_timer_expiration();
nxsched_timer_expiration();
#endif
}

View File

@ -560,7 +560,7 @@ static inline void lpc54_tl_alarm(uint64_t curr)
up_timer_gettime(&ts);
sched_alarm_expiration(&ts);
#else
sched_timer_expiration();
nxsched_timer_expiration();
#endif
}

View File

@ -50,7 +50,7 @@
* The RTOS will provide the following interfaces for use by the platform-
* specific interval timer implementation:
*
* void sched_timer_expiration(void): Called by the platform-specific
* void nxsched_timer_expiration(void): Called by the platform-specific
* logic when the interval timer expires.
*
****************************************************************************/
@ -198,7 +198,7 @@ static struct sam_tickless_s g_tickless;
static void sam_oneshot_handler(void *arg)
{
tmrinfo("Expired...\n");
sched_timer_expiration();
nxsched_timer_expiration();
}
/****************************************************************************
@ -333,7 +333,7 @@ int up_timer_gettime(FAR struct timespec *ts)
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -374,14 +374,14 @@ int up_timer_cancel(FAR struct timespec *ts)
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be
* Start the interval timer. nxsched_timer_expiration() will be
* called at the completion of the timeout (unless up_timer_cancel
* is called to stop the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:

View File

@ -50,7 +50,7 @@
* The RTOS will provide the following interfaces for use by the platform-
* specific interval timer implementation:
*
* void sched_timer_expiration(void): Called by the platform-specific
* void nxsched_timer_expiration(void): Called by the platform-specific
* logic when the interval timer expires.
*
****************************************************************************/
@ -210,7 +210,7 @@ static struct sam_tickless_s g_tickless;
static void sam_oneshot_handler(void *arg)
{
tmrinfo("Expired...\n");
sched_timer_expiration();
nxsched_timer_expiration();
}
/****************************************************************************
@ -345,7 +345,7 @@ int up_timer_gettime(FAR struct timespec *ts)
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -386,14 +386,14 @@ int up_timer_cancel(FAR struct timespec *ts)
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be
* Start the interval timer. nxsched_timer_expiration() will be
* called at the completion of the timeout (unless up_timer_cancel
* is called to stop the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:

View File

@ -50,7 +50,7 @@
* The RTOS will provide the following interfaces for use by the platform-
* specific interval timer implementation:
*
* void sched_timer_expiration(void): Called by the platform-specific
* void nxsched_timer_expiration(void): Called by the platform-specific
* logic when the interval timer expires.
*
****************************************************************************/
@ -222,7 +222,7 @@ static struct sam_tickless_s g_tickless;
static void sam_oneshot_handler(void *arg)
{
tmrinfo("Expired...\n");
sched_timer_expiration();
nxsched_timer_expiration();
}
/****************************************************************************
@ -331,7 +331,7 @@ int up_timer_gettime(FAR struct timespec *ts)
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -372,14 +372,14 @@ int up_timer_cancel(FAR struct timespec *ts)
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be
* Start the interval timer. nxsched_timer_expiration() will be
* called at the completion of the timeout (unless up_timer_cancel
* is called to stop the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:

View File

@ -52,7 +52,7 @@
* The RTOS will provide the following interfaces for use by the platform-
* specific interval timer implementation:
*
* void sched_timer_expiration(void): Called by the platform-specific
* void nxsched_timer_expiration(void): Called by the platform-specific
* logic when the interval timer expires.
*
****************************************************************************/
@ -319,7 +319,7 @@ static void stm32_interval_handler(void)
g_tickless.pending = false;
sched_timer_expiration();
nxsched_timer_expiration();
}
/****************************************************************************
@ -736,7 +736,7 @@ void up_timer_getmask(FAR uint64_t *mask)
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -873,14 +873,14 @@ int up_timer_cancel(FAR struct timespec *ts)
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be
* Start the interval timer. nxsched_timer_expiration() will be
* called at the completion of the timeout (unless up_timer_cancel
* is called to stop the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:

View File

@ -51,7 +51,7 @@
* The RTOS will provide the following interfaces for use by the platform-
* specific interval timer implementation:
*
* void sched_timer_expiration(void): Called by the platform-specific
* void nxsched_timer_expiration(void): Called by the platform-specific
* logic when the interval timer expires.
*
****************************************************************************/
@ -155,7 +155,7 @@ static struct stm32l4_tickless_s g_tickless;
static void stm32l4_oneshot_handler(FAR void *arg)
{
tmrinfo("Expired...\n");
sched_timer_expiration();
nxsched_timer_expiration();
}
/****************************************************************************
@ -284,7 +284,7 @@ int up_timer_gettime(FAR struct timespec *ts)
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -323,14 +323,14 @@ int up_timer_cancel(FAR struct timespec *ts)
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be
* Start the interval timer. nxsched_timer_expiration() will be
* called at the completion of the timeout (unless up_timer_cancel
* is called to stop the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:

View File

@ -50,7 +50,7 @@
* The RTOS will provide the following interfaces for use by the platform-
* specific interval timer implementation:
*
* void sched_timer_expiration(void): Called by the platform-specific
* void nxsched_timer_expiration(void): Called by the platform-specific
* logic when the interval timer expires.
*
****************************************************************************/
@ -170,7 +170,7 @@ int up_timer_gettime(FAR struct timespec *ts)
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -223,14 +223,14 @@ int up_timer_cancel(FAR struct timespec *ts)
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be
* Start the interval timer. nxsched_timer_expiration() will be
* called at the completion of the timeout (unless up_timer_cancel
* is called to stop the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:
@ -291,7 +291,7 @@ void up_timer_update(void)
/* No more seconds left... the timer has expired */
g_timer_active = false;
sched_timer_expiration();
nxsched_timer_expiration();
}
else
{
@ -321,7 +321,7 @@ void up_timer_update(void)
else
{
g_timer_active = false;
sched_timer_expiration();
nxsched_timer_expiration();
}
}
}

View File

@ -222,7 +222,7 @@ static bool timer_callback(FAR uint32_t *next_interval_us, FAR void *arg)
g_timer.timebase += *next_interval_us;
next_interval = g_timer.maxtimeout;
g_timer.next_interval = &next_interval;
sched_timer_expiration();
nxsched_timer_expiration();
g_timer.next_interval = NULL;
TIMER_GETSTATUS(g_timer.lower, &status);
@ -344,7 +344,7 @@ int up_timer_gettime(FAR struct timespec *ts)
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -393,14 +393,14 @@ int up_timer_cancel(FAR struct timespec *ts)
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be called at
* Start the interval timer. nxsched_timer_expiration() will be called at
* the completion of the timeout (unless up_timer_cancel is called to stop
* the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:

View File

@ -1434,7 +1434,7 @@ int up_prioritize_irq(int irq, int priority);
* void sched_alarm_expiration(FAR const struct timespec *ts): Called
* by the platform-specific logic when the alarm expires.
* #else
* void sched_timer_expiration(void): Called by the platform-specific
* void nxsched_timer_expiration(void): Called by the platform-specific
* logic when the interval timer expires.
* #endif
*
@ -1554,7 +1554,7 @@ int up_alarm_start(FAR const struct timespec *ts);
* Description:
* Cancel the interval timer and return the time remaining on the timer.
* These two steps need to be as nearly atomic as possible.
* sched_timer_expiration() will not be called unless the timer is
* nxsched_timer_expiration() will not be called unless the timer is
* restarted with up_timer_start().
*
* If, as a race condition, the timer has already expired when this
@ -1592,14 +1592,14 @@ int up_timer_cancel(FAR struct timespec *ts);
* Name: up_timer_start
*
* Description:
* Start the interval timer. sched_timer_expiration() will be called at
* Start the interval timer. nxsched_timer_expiration() will be called at
* the completion of the timeout (unless up_timer_cancel is called to stop
* the timing.
*
* Provided by platform-specific code and called from the RTOS base code.
*
* Input Parameters:
* ts - Provides the time interval until sched_timer_expiration() is
* ts - Provides the time interval until nxsched_timer_expiration() is
* called.
*
* Returned Value:
@ -2006,7 +2006,7 @@ void nxsched_process_timer(void);
#endif
/****************************************************************************
* Name: sched_timer_expiration
* Name: nxsched_timer_expiration
*
* Description:
* if CONFIG_SCHED_TICKLESS is defined, then this function is provided by
@ -2026,7 +2026,7 @@ void nxsched_process_timer(void);
****************************************************************************/
#if defined(CONFIG_SCHED_TICKLESS) && !defined(CONFIG_SCHED_TICKLESS_ALARM)
void sched_timer_expiration(void);
void nxsched_timer_expiration(void);
#endif
/****************************************************************************

View File

@ -141,7 +141,7 @@ static void nxsched_timer_start(unsigned int ticks);
static struct timespec g_stop_time;
#else
/* This is the duration of the currently active timer or, when
* sched_timer_expiration() is called, the duration of interval timer
* nxsched_timer_expiration() is called, the duration of interval timer
* that just expired. The value zero means that no timer was active.
*/
@ -533,7 +533,7 @@ void sched_alarm_expiration(FAR const struct timespec *ts)
#endif
/****************************************************************************
* Name: sched_timer_expiration
* Name: nxsched_timer_expiration
*
* Description:
* if CONFIG_SCHED_TICKLESS is defined, then this function is provided by
@ -549,7 +549,7 @@ void sched_alarm_expiration(FAR const struct timespec *ts)
****************************************************************************/
#ifndef CONFIG_SCHED_TICKLESS_ALARM
void sched_timer_expiration(void)
void nxsched_timer_expiration(void)
{
unsigned int elapsed;
unsigned int nexttime;