clock_time2ticks.c 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. /****************************************************************************
  2. * sched/clock/clock_time2ticks.c
  3. *
  4. * Copyright (C) 2007, 2009 Gregory Nutt. All rights reserved.
  5. * Author: Gregory Nutt <gnutt@nuttx.org>
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions
  9. * are met:
  10. *
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in
  15. * the documentation and/or other materials provided with the
  16. * distribution.
  17. * 3. Neither the name NuttX nor the names of its contributors may be
  18. * used to endorse or promote products derived from this software
  19. * without specific prior written permission.
  20. *
  21. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24. * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25. * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26. * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27. * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  28. * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29. * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31. * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32. * POSSIBILITY OF SUCH DAMAGE.
  33. *
  34. ****************************************************************************/
  35. /****************************************************************************
  36. * Included Files
  37. ****************************************************************************/
  38. #include <nuttx/config.h>
  39. #include <stdint.h>
  40. #include <time.h>
  41. #include "clock/clock.h"
  42. /****************************************************************************
  43. * Public Functions
  44. ****************************************************************************/
  45. /****************************************************************************
  46. * Name: clock_time2ticks
  47. *
  48. * Description:
  49. * Convert a timespec delay to system timer ticks. This function is
  50. * suitable for calculating relative time delays and does not depend on
  51. * the other clock_* logic.
  52. *
  53. * Input Parameters:
  54. * reltime - Convert this relative time to system clock ticks.
  55. * ticks - Return the converted number of ticks here.
  56. *
  57. * Returned Value:
  58. * Always returns OK
  59. *
  60. * Assumptions:
  61. *
  62. ****************************************************************************/
  63. int clock_time2ticks(FAR const struct timespec *reltime,
  64. FAR sclock_t *ticks)
  65. {
  66. #ifdef CONFIG_HAVE_LONG_LONG
  67. int64_t relnsec;
  68. /* Convert the relative time into nanoseconds. The range of the int64_t
  69. * is sufficiently large that there is no real need for range checking.
  70. */
  71. relnsec = (int64_t)reltime->tv_sec * NSEC_PER_SEC +
  72. (int64_t)reltime->tv_nsec;
  73. /* Convert nanoseconds to clock ticks, rounding up to the smallest integer
  74. * that is greater than or equal to the exact number of tick.
  75. */
  76. *ticks = (sclock_t)((relnsec + NSEC_PER_TICK - 1) / NSEC_PER_TICK);
  77. return OK;
  78. #else
  79. int32_t relusec;
  80. /* This function uses an int32_t to only the relative time in microseconds.
  81. * that means that the maximum supported relative time is 2,147,487.647
  82. * seconds
  83. */
  84. #if 0 // overkill
  85. DEBUGASSERT(reltime->tv_sec < 2147487 ||
  86. reltime->tv_sec == 2147487 &&
  87. reltime->tv_nsec <= 647 * NSEC_PER_MSEC);
  88. #endif
  89. /* Convert the relative time into microseconds, rounding up to the smallest
  90. * value that is greater than or equal to the exact number of microseconds.
  91. */
  92. relusec = reltime->tv_sec * USEC_PER_SEC +
  93. (reltime->tv_nsec + NSEC_PER_USEC - 1) / NSEC_PER_USEC;
  94. /* Convert microseconds to clock ticks, rounding up to the smallest integer
  95. * that is greater than or equal to the exact number of tick.
  96. */
  97. *ticks = (sclock_t)((relusec + USEC_PER_TICK - 1) / USEC_PER_TICK);
  98. return OK;
  99. #endif
  100. }