clock.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2014, 2021 embedded brains GmbH & Co. KG
 * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */
 
/* Generated from spec:/rtems/clock/if/header */
 
#ifndef _RTEMS_RTEMS_CLOCK_H
#define _RTEMS_RTEMS_CLOCK_H
 
#include <stdbool.h>
#include <stdint.h>
#include <time.h>
#include <rtems/config.h>
#include <sys/_timespec.h>
#include <sys/_timeval.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/watchdogticks.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Generated from spec:/rtems/clock/if/group */
 
/* Generated from spec:/rtems/clock/if/bintime */
 
/* Forward declaration */
struct bintime;
 
/* Generated from spec:/rtems/clock/if/set */
 
rtems_status_code rtems_clock_set( const rtems_time_of_day *time_of_day );
 
/* Generated from spec:/rtems/clock/if/get-tod */
 
rtems_status_code rtems_clock_get_tod( rtems_time_of_day *time_of_day );
 
/* Generated from spec:/rtems/clock/if/get-tod-timeval */
 
rtems_status_code rtems_clock_get_tod_timeval( struct timeval *time_of_day );
 
/* Generated from spec:/rtems/clock/if/get-realtime */
 
void rtems_clock_get_realtime( struct timespec *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-realtime-bintime */
 
void rtems_clock_get_realtime_bintime( struct bintime *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-realtime-timeval */
 
void rtems_clock_get_realtime_timeval( struct timeval *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-realtime-coarse */
 
void rtems_clock_get_realtime_coarse( struct timespec *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-realtime-coarse-bintime */
 
void rtems_clock_get_realtime_coarse_bintime( struct bintime *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-realtime-coarse-timeval */
 
void rtems_clock_get_realtime_coarse_timeval( struct timeval *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-monotonic */
 
void rtems_clock_get_monotonic( struct timespec *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-monotonic-bintime */
 
void rtems_clock_get_monotonic_bintime( struct bintime *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-monotonic-sbintime */
 
int64_t rtems_clock_get_monotonic_sbintime( void );
 
/* Generated from spec:/rtems/clock/if/get-monotonic-timeval */
 
void rtems_clock_get_monotonic_timeval( struct timeval *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-monotonic-coarse */
 
void rtems_clock_get_monotonic_coarse( struct timespec *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-monotonic-coarse-bintime */
 
void rtems_clock_get_monotonic_coarse_bintime( struct bintime *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-monotonic-coarse-timeval */
 
void rtems_clock_get_monotonic_coarse_timeval( struct timeval *time_snapshot );
 
/* Generated from spec:/rtems/clock/if/get-boot-time */
 
void rtems_clock_get_boot_time( struct timespec *boot_time );
 
/* Generated from spec:/rtems/clock/if/get-boot-time-bintime */
 
void rtems_clock_get_boot_time_bintime( struct bintime *boot_time );
 
/* Generated from spec:/rtems/clock/if/get-boot-time-timeval */
 
void rtems_clock_get_boot_time_timeval( struct timeval *boot_time );
 
/* Generated from spec:/rtems/clock/if/get-seconds-since-epoch */
 
rtems_status_code rtems_clock_get_seconds_since_epoch(
  rtems_interval *seconds_since_rtems_epoch
);
 
/* Generated from spec:/rtems/clock/if/get-ticks-per-second */
 
rtems_interval rtems_clock_get_ticks_per_second( void );
 
/* Generated from spec:/rtems/clock/if/get-ticks-per-second-macro */
#define rtems_clock_get_ticks_per_second() _Watchdog_Ticks_per_second
 
/* Generated from spec:/rtems/clock/if/get-ticks-since-boot */
 
rtems_interval rtems_clock_get_ticks_since_boot( void );
 
/* Generated from spec:/rtems/clock/if/get-ticks-since-boot-macro */
#define rtems_clock_get_ticks_since_boot() _Watchdog_Ticks_since_boot
 
/* Generated from spec:/rtems/clock/if/get-uptime */
 
rtems_status_code rtems_clock_get_uptime( struct timespec *uptime );
 
/* Generated from spec:/rtems/clock/if/get-uptime-timeval */
 
void rtems_clock_get_uptime_timeval( struct timeval *uptime );
 
/* Generated from spec:/rtems/clock/if/get-uptime-seconds */
 
time_t rtems_clock_get_uptime_seconds( void );
 
/* Generated from spec:/rtems/clock/if/get-uptime-nanoseconds */
 
uint64_t rtems_clock_get_uptime_nanoseconds( void );
 
/* Generated from spec:/rtems/clock/if/tick-later */
 
static inline rtems_interval rtems_clock_tick_later( rtems_interval delta )
{
  return _Watchdog_Ticks_since_boot + delta;
}
 
/* Generated from spec:/rtems/clock/if/tick-later-usec */
 
static inline rtems_interval rtems_clock_tick_later_usec(
  rtems_interval delta_in_usec
)
{
  rtems_interval us_per_tick;
 
  us_per_tick = rtems_configuration_get_microseconds_per_tick();
 
  /*
   * Add one additional tick, since we do not know the time to the clock
   * next tick.
   */
  return _Watchdog_Ticks_since_boot + 1
    + ( delta_in_usec + us_per_tick - 1 ) / us_per_tick;
}
 
/* Generated from spec:/rtems/clock/if/tick-before */
 
static inline bool rtems_clock_tick_before( rtems_interval ticks )
{
  return (int32_t) ( ticks - _Watchdog_Ticks_since_boot ) > 0;
}
 
/* Generated from spec:/rtems/clock/if/tick */
 
rtems_status_code rtems_clock_tick( void );
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTEMS_RTEMS_CLOCK_H */