1 files changed, 53 insertions, 12 deletions
diff --git a/cpukit/include/rtems/rtems/clockimpl.h b/cpukit/include/rtems/rtems/clockimpl.h
index c13c158410..c025ea9c9a 100644
--- a/cpukit/include/rtems/rtems/clockimpl.h
+++ b/cpukit/include/rtems/rtems/clockimpl.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
@@ -10,9 +12,26 @@
 /* COPYRIGHT (c) 1989-2013.
  * On-Line Applications Research Corporation (OAR).
  *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.org/license/LICENSE.
+ * 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_RTEMS_CLOCKIMPL_H
@@ -35,19 +54,41 @@ extern "C" {
  */
 
 /**
- * @brief TOD Validate
- *
- * This support function returns true if @a the_tod contains
- * a valid time of day, and false otherwise.
+ * @brief The enumerators of this type determine if the ticks member is
+ *   validated in _TOD_Validate().
+ */
+typedef enum {
+  /**
+   * @brief Use this option to disable the validation of the ticks member in
+   *   _TOD_Validate().
+   */
+  TOD_DISABLE_TICKS_VALIDATION = 0,
+
+  /**
+   * @brief Use this option to enable the validation of the ticks member in
+   *   _TOD_Validate().
+   */
+  TOD_ENABLE_TICKS_VALIDATION = -1
+} TOD_Ticks_validation;
+
+/**
+ * @brief Validates the time of day.
  *
- * @param[in] the_tod is the TOD structure to validate
+ * @param the_tod is the reference to the time of day structure to validate or
+ *   NULL.
  *
- * @retval This method returns true if the TOD is valid and false otherwise.
+ * @param ticks_validation indicates if the ticks member of the time of day
+ *   should be validated.  Use #TOD_ENABLE_TICKS_VALIDATION to validate the
+ *   ticks member.  Use #TOD_DISABLE_TICKS_VALIDATION to skip the validation of
+ *   the ticks member.
  *
- * @note This routine only works for leap-years through 2099.
+ * @retval RTEMS_SUCCESSFUL @a the_tod references a valid time of day.
+ * @retval RTEMS_INVALID_CLOCK @a the_tod references an invalid time of day.
+ * @retval RTEMS_INVALID_ADDRESS @a the_tod reference is @c NULL.
  */
-bool _TOD_Validate(
-  const rtems_time_of_day *the_tod
+rtems_status_code _TOD_Validate(
+  const rtems_time_of_day *the_tod,
+  TOD_Ticks_validation     ticks_validation
 );
 
 /**