LXR 6.1/​cpukit/​include/​rtems/​timespec.h	Source navigation Diff markup Identifier search General search
	Version: 6.1 Revert   Change

File indexing completed on 2025-05-11 08:24:14

 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
  * @file
  *
  * @brief Timespec API
  *
  * This include file contains API for manipulating timespecs.
  */
 
 /*
  *  Copyright (c) 2012.
  *  Krzysztof Miesowicz <krzysztof.miesowicz@gmail.com>
  *
  * 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.
  */
 
 #ifndef _RTEMS_TIMESPEC_H
 #define _RTEMS_TIMESPEC_H
 
 #include <rtems/score/timespec.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
  *  @defgroup TimespecAPI Timespec
  *
  *  @ingroup RTEMSAPIClassic
  *
  *  @brief Timespec API
  * 
  * @{
  *
  */
 
 /**
  * @brief Is timespec valid
  *
  * This method determines the validity of a timespec.
  *
  * @param[in] time is the timespec instance to validate.
  *
  * @retval true The timespec is valid.
  * @retval false The timespec is not valid.
  */
 static inline bool rtems_timespec_is_valid(
   const struct timespec *time
 )
 {
   return _Timespec_Is_valid(time);
 }
 
 /**
  * @brief Timespec less than operator.
  *
  * This method is the less than operator for timespecs.
  *
  * @param[in] lhs is the left hand side timespec
  * @param[in] rhs is the right hand side timespec
  *
  * @retval true @a lhs is less than @a rhs.
  * @retval false @a lhs is not less than @a rhs.
  * 
  */
 static inline bool rtems_timespec_less_than(
   const struct timespec *lhs,
   const struct timespec *rhs
 )
 {
   return _Timespec_Less_than(lhs,rhs);
 }
 
 /**
  * @brief Add to a timespec.
  *
  * This routine adds two timespecs.  The second argument is added
  * to the first.
  *
  * @param[in] time is the base time to be added to
  * @param[in] add is the timespec to add to the first argument
  *
  * @return This method returns the number of seconds @a time increased by.
  */
 static inline time_t rtems_timespec_add_to(
   struct timespec       *time,
   const struct timespec *add
 )
 {
   return _Timespec_Add_to(time,add);
 }
 
 /**
  * @brief Convert timespec to number of ticks.
  *
  * This routine convert the @a time timespec to the corresponding number
  * of clock ticks.
  *
  * @param[in] time is the time to be converted
  *
  * @return This method returns the number of ticks computed.
  */
 static inline uint32_t rtems_timespec_to_ticks(
   const struct timespec *time
 )
 {
   return _Timespec_To_ticks(time);
 }
 
 /**
  * @brief Convert ticks to timespec.
  *
  * This routine converts the @a ticks value to the corresponding
  * timespec format @a time.
  *
  * @param[in] time is the timespec format time result
  * @param[in] ticks is the number of ticks to convert
  */
 
 static inline void rtems_timespec_from_ticks(
   uint32_t         ticks,
   struct timespec *time
 )
 {
   _Timespec_From_ticks(ticks,time);
 }
 
 /**
  * @brief Subtract two timespec.
  *
  * This routine subtracts two timespecs.  @a result is set to
  * @a end - @a start.
  *
  * @param[in] start is the starting time
  * @param[in] end is the ending time
  * @param[in] result is the difference between starting and ending time.
  *
  * @return This method fills in @a result.
  */
 static inline void rtems_timespec_subtract(
   const struct timespec *start,
   const struct timespec *end,
   struct timespec       *result
 )
 {
   _Timespec_Subtract(start,end,result);
 }
 
 /**
  * @brief Divide timespec by integer.
  *
  * This routine divides a timespec by an integer value.  The expected
  * use is to assist in benchmark calculations where you typically
  * divide a duration by a number of iterations.
  *
  * @param[in] time is the total
  * @param[in] iterations is the number of iterations
  * @param[in] result is the average time.
  *
  * @return This method fills in @a result.
  */
 static inline void rtems_timespec_divide_by_integer(
   const struct timespec *time,
   uint32_t               iterations,
   struct timespec       *result
 )
 {
   _Timespec_Divide_by_integer(time,iterations,result);
 }
 
 /**
  * @brief Divide timespec.
  *
  * This routine divides a timespec by another timespec.  The
  * intended use is for calculating percentages to three decimal points.
  *
  * @param[in] lhs is the left hand number
  * @param[in] rhs is the right hand number
  * @param[in] ival_percentage is the integer portion of the average
  * @param[in] fval_percentage is the thousandths of percentage
  *
  * @return This method fills in @a result.
  */
 static inline void rtems_timespec_divide(
   const struct timespec *lhs,
   const struct timespec *rhs,
   uint32_t              *ival_percentage,
   uint32_t              *fval_percentage
 )
 {
   _Timespec_Divide(lhs,rhs,ival_percentage,fval_percentage);
 }
 
 /**
  * @brief Set timespec to seconds nanosecond.
  *
  * This method sets the timespec to the specified seconds and nanoseconds
  * value.
  *
  * @param[in] _time points to the timespec instance to validate.
  * @param[in] _seconds is the seconds portion of the timespec
  * @param[in] _nanoseconds is the nanoseconds portion of the timespec
  */
 static inline void rtems_timespec_set(
   struct timespec *_time,
   time_t _seconds,
   uint32_t _nanoseconds
 )
 {
   _Timespec_Set( _time, _seconds, _nanoseconds );
 }
 
 /**
  * @brief Zero timespec.
  *
  * This method sets the timespec to zero.
  * value.
  *
  * @param[in] _time points to the timespec instance to zero.
  */
 static inline void rtems_timespec_zero( 
   struct timespec *_time
 )
 {
   _Timespec_Set_to_zero( _time );
 }
 
 /**
  * @brief Get seconds portion of timespec.
  *
  * This method returns the seconds portion of the specified timespec
  *
  * @param[in] _time points to the timespec
  *
  * @return The seconds portion of @a _time.
  */
 static inline time_t rtems_timespec_get_seconds(
   struct timespec *_time
 )
 {
   return _Timespec_Get_seconds( _time );
 }
 
 /**
  * @brief Get nanoseconds portion of timespec.
  *
  * This method returns the nanoseconds portion of the specified timespec
  *
  * @param[in] _time points to the timespec
  *
  * @return The nanoseconds portion of @a _time.
  */
 static inline uint32_t rtems_timespec_get_nanoseconds(
   struct timespec *_time
 )
 {
   return _Timespec_Get_nanoseconds( _time );
 }
 
 /**
  * @brief Timespec greater than operator.
  *
  * This method is the greater than operator for timespecs.
  *
  * @param[in] _lhs is the left hand side timespec
  * @param[in] _rhs is the right hand side timespec
  *
  * @retval true @a _lhs is greater than @a _rhs.
  * @retval false @a _lhs is not greater than @a _rhs.
  */
 static inline bool rtems_timespec_greater_than(
   const struct timespec *_lhs,
   const struct timespec *_rhs
 )
 {
   return _Timespec_Greater_than( _lhs, _rhs );
 }
 /**
  * @brief Timespec equal to Operator
  *
  * This method is the is equal to than operator for timespecs.
  *
  * @param[in] lhs is the left hand side timespec
  * @param[in] rhs is the right hand side timespec
  *
  * @retval true @a lhs is equal to @a rhs.
  * @retval false @a lhs is not equal to @a rhs.
  */
 static inline bool rtems_timespec_equal_to(
   const struct timespec *lhs,
   const struct timespec *rhs
 )
 {
   return _Timespec_Equal_to( lhs, rhs);
 }
 
 /** @} */
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif
 /* end of include file */

This page was automatically generated by the 2.3.7 LXR engine. The LXR team