rtems/src/clocktodvalidate.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplClassicClock
0007  *
0008  * @brief This source file contains the implementation of
0009  *   _TOD_Validate().
0010  */
0011
0012 /*
0013  *  COPYRIGHT (c) 1989-2007.
0014  *  On-Line Applications Research Corporation (OAR).
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifdef HAVE_CONFIG_H
0039 #include "config.h"
0040 #endif
0041
0042 #include <rtems/rtems/clockimpl.h>
0043 #include <rtems/score/todimpl.h>
0044 #include <rtems/config.h>
0045
0046 /*
0047  *  The following array contains the number of days in all months.
0048  *  The first dimension should be 0 for leap years, and 1 otherwise.
0049  *  The second dimension should range from 1 to 12 for January to
0050  *  December, respectively.
0051  */
0052 static const uint32_t _TOD_Days_per_month[ 2 ][ 13 ] = {
0053   { 0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 },
0054   { 0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }
0055 };
0056
0057 rtems_status_code _TOD_Validate(
0058   const rtems_time_of_day *the_tod,
0059   TOD_Ticks_validation     ticks_validation
0060 )
0061 {
0062   size_t  leap_year_index;
0063   uint32_t days_in_month;
0064   uint32_t ticks_per_second;
0065   uint32_t ticks_mask;
0066
0067   if ( the_tod == NULL ) {
0068     return RTEMS_INVALID_ADDRESS;
0069   }
0070
0071   ticks_per_second = rtems_clock_get_ticks_per_second();
0072   ticks_mask = (uint32_t) ticks_validation;
0073
0074   if ( ( the_tod->ticks & ticks_mask ) >= ticks_per_second ) {
0075     return RTEMS_INVALID_CLOCK;
0076   }
0077
0078   if ( the_tod->second >= TOD_SECONDS_PER_MINUTE ) {
0079     return RTEMS_INVALID_CLOCK;
0080   }
0081
0082   if ( the_tod->minute >= TOD_MINUTES_PER_HOUR ) {
0083     return RTEMS_INVALID_CLOCK;
0084   }
0085
0086   if ( the_tod->hour >= TOD_HOURS_PER_DAY ) {
0087     return RTEMS_INVALID_CLOCK;
0088   }
0089
0090   if ( the_tod->month == 0 || the_tod->month > TOD_MONTHS_PER_YEAR ) {
0091     return RTEMS_INVALID_CLOCK;
0092   }
0093
0094   if ( the_tod->year < TOD_BASE_YEAR || the_tod->year > TOD_LATEST_YEAR ) {
0095     return RTEMS_INVALID_CLOCK;
0096   }
0097
0098   if ( the_tod->day == 0 ) {
0099     return RTEMS_INVALID_CLOCK;
0100   }
0101
0102   leap_year_index = _TOD_Get_leap_year_index( the_tod->year );
0103   days_in_month = _TOD_Days_per_month[ leap_year_index ][ the_tod->month ];
0104
0105   if ( the_tod->day > days_in_month ) {
0106     return RTEMS_INVALID_CLOCK;
0107   }
0108
0109   return RTEMS_SUCCESSFUL;
0110 }