os: Add caveats to some timespec conversion functions.

This commit is contained in:
Ryan Pavlik 2021-03-30 11:18:52 -05:00
parent ddc9b00d14
commit 00915cab0f

View file

@ -81,6 +81,9 @@ os_nanosleep(long nsec)
#ifdef XRT_HAVE_TIMESPEC #ifdef XRT_HAVE_TIMESPEC
/*! /*!
* @brief Convert a timespec struct to nanoseconds. * @brief Convert a timespec struct to nanoseconds.
*
* Note that this just does the value combining, no adjustment for epochs is performed.
*
* @ingroup aux_os_time_extra * @ingroup aux_os_time_extra
*/ */
static inline uint64_t static inline uint64_t
@ -94,6 +97,8 @@ os_timespec_to_ns(const struct timespec *spec)
/*! /*!
* @brief Convert an nanosecond integer to a timespec struct. * @brief Convert an nanosecond integer to a timespec struct.
*
* Note that this just does the value splitting, no adjustment for epochs is performed.
* @ingroup aux_os_time_extra * @ingroup aux_os_time_extra
*/ */
static inline void static inline void