rtems/src/taskwakewhen.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplClassicTask
0007  *
0008  * @brief This source file contains the implementation of
0009  *   rtems_task_wake_when().
0010  */
0011
0012 /*
0013  *  COPYRIGHT (c) 1989-1999.
0014  *  On-Line Applications Research Corporation (OAR).
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifdef HAVE_CONFIG_H
0039 #include "config.h"
0040 #endif
0041
0042 #include <rtems/rtems/tasks.h>
0043 #include <rtems/rtems/clockimpl.h>
0044 #include <rtems/score/threadimpl.h>
0045 #include <rtems/score/todimpl.h>
0046 #include <rtems/score/watchdogimpl.h>
0047
0048 rtems_status_code rtems_task_wake_when(
0049   const rtems_time_of_day *time_buffer
0050 )
0051 {
0052   uint32_t          seconds;
0053   Thread_Control   *executing;
0054   Per_CPU_Control  *cpu_self;
0055   rtems_status_code status;
0056
0057   if ( !_TOD_Is_set() )
0058     return RTEMS_NOT_DEFINED;
0059
0060   status = _TOD_Validate( time_buffer, TOD_DISABLE_TICKS_VALIDATION );
0061
0062   if ( status != RTEMS_SUCCESSFUL ) {
0063     return status;
0064   }
0065
0066   seconds = _TOD_To_seconds( time_buffer );
0067
0068   if ( seconds <= _TOD_Seconds_since_epoch() )
0069     return RTEMS_INVALID_CLOCK;
0070
0071   cpu_self = _Thread_Dispatch_disable();
0072     executing = _Per_CPU_Get_executing( cpu_self );
0073     _Thread_Set_state( executing, STATES_WAITING_FOR_TIME );
0074     _Thread_Wait_flags_set( executing, THREAD_WAIT_STATE_BLOCKED );
0075     _Thread_Timer_insert_realtime(
0076       executing,
0077       cpu_self,
0078       _Thread_Timeout,
0079       _Watchdog_Ticks_from_seconds( seconds )
0080     );
0081   _Thread_Dispatch_direct( cpu_self );
0082   return RTEMS_SUCCESSFUL;
0083 }