From 98c7eacaaa318ef3e5b5a878d8bedebc5faf5a22 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 23 Jul 2013 09:48:38 +0200 Subject: sapi: Merge timespec API into one file --- cpukit/sapi/Makefile.am | 1 - cpukit/sapi/include/rtems/timespec.h | 268 ++++++++++++++++++++++++++++++- cpukit/sapi/inline/rtems/timespec.inl | 293 ---------------------------------- cpukit/sapi/preinstall.am | 4 - 4 files changed, 261 insertions(+), 305 deletions(-) delete mode 100644 cpukit/sapi/inline/rtems/timespec.inl (limited to 'cpukit') diff --git a/cpukit/sapi/Makefile.am b/cpukit/sapi/Makefile.am index c73787d90c..558b873aa7 100644 --- a/cpukit/sapi/Makefile.am +++ b/cpukit/sapi/Makefile.am @@ -21,7 +21,6 @@ EXTRA_DIST = include/rtems/README include_rtems_HEADERS += inline/rtems/extension.inl include_rtems_HEADERS += inline/rtems/rbtree.inl -include_rtems_HEADERS += inline/rtems/timespec.inl ## src AM_CPPFLAGS += -D__RTEMS_INSIDE__ diff --git a/cpukit/sapi/include/rtems/timespec.h b/cpukit/sapi/include/rtems/timespec.h index b67e95c2d3..e588c5b789 100644 --- a/cpukit/sapi/include/rtems/timespec.h +++ b/cpukit/sapi/include/rtems/timespec.h @@ -20,6 +20,10 @@ #include +#ifdef __cplusplus +extern "C" { +#endif + /** * @defgroup TimespecAPI Timespec * @@ -31,15 +35,265 @@ * */ -#include /* bool */ -#include /* uint32_t */ -#include /* struct timespec */ +/** + * @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. + */ +RTEMS_INLINE_ROUTINE bool rtems_timespec_is_valid( + const struct timespec *time +) +{ + return _Timespec_Is_valid(time); +} -#ifdef __cplusplus -extern "C" { -#endif +/** + * @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. + * + */ +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE uint32_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. + */ +RTEMS_INLINE_ROUTINE 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 + */ + +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE 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 + */ +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE uint32_t rtems_timespec_get_nanoseconds( + struct timespec *_time +) +{ + return _Timespec_Get_nanoseconds( _time ); +} -#include +/** + * @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. + */ +RTEMS_INLINE_ROUTINE 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. + */ +RTEMS_INLINE_ROUTINE bool rtems_timespec_equal_to( + const struct timespec *lhs, + const struct timespec *rhs +) +{ + return _Timespec_Equal_to( lhs, rhs); +} /** @} */ diff --git a/cpukit/sapi/inline/rtems/timespec.inl b/cpukit/sapi/inline/rtems/timespec.inl deleted file mode 100644 index 31d445c45d..0000000000 --- a/cpukit/sapi/inline/rtems/timespec.inl +++ /dev/null @@ -1,293 +0,0 @@ -/** - * @file - * - * @brief Timespec API - */ - -/* - * Copyright (c) 2012. - * Krzysztof Miesowicz - * - * The license and distribution terms for this file may be - * found in the file LICENSE in this distribution or at - * http://www.rtems.com/license/LICENSE. - */ - -#ifndef _RTEMS_TIMESPEC_H -# error "Never use directly; include instead." -#endif - -#ifndef _RTEMS_TIMESPEC_INL -#define _RTEMS_TIMESPEC_INL - -#include - -/** - * @addtogroup TimespecAPI Timespec - */ -/**@{**/ - -/** - * @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. - */ -RTEMS_INLINE_ROUTINE 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. - * - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE uint32_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. - */ -RTEMS_INLINE_ROUTINE 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 - */ - -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE 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 - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE 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. - */ -RTEMS_INLINE_ROUTINE bool rtems_timespec_equal_to( - const struct timespec *lhs, - const struct timespec *rhs -) -{ - return _Timespec_Equal_to( lhs, rhs); -} - -/** @} */ - -#endif -/* end of include file */ diff --git a/cpukit/sapi/preinstall.am b/cpukit/sapi/preinstall.am index 1ed410f0ba..a9d87bbec3 100644 --- a/cpukit/sapi/preinstall.am +++ b/cpukit/sapi/preinstall.am @@ -88,10 +88,6 @@ $(PROJECT_INCLUDE)/rtems/rbtree.inl: inline/rtems/rbtree.inl $(PROJECT_INCLUDE)/ $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/rbtree.inl PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/rbtree.inl -$(PROJECT_INCLUDE)/rtems/timespec.inl: inline/rtems/timespec.inl $(PROJECT_INCLUDE)/rtems/$(dirstamp) - $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/timespec.inl -PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/timespec.inl - $(PROJECT_LIB)/libsapi.a: libsapi.a $(PROJECT_LIB)/$(dirstamp) $(INSTALL_DATA) $< $(PROJECT_LIB)/libsapi.a TMPINSTALL_FILES += $(PROJECT_LIB)/libsapi.a -- cgit v1.2.3