140 lines
4.9 KiB
C
140 lines
4.9 KiB
C
/****************************************************************************
|
|
* include/nuttx/time.h
|
|
*
|
|
* Copyright (C) 2009, 2011, 2015 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* 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.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* 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 __INCLUDE_NUTTX_TIME_H
|
|
#define __INCLUDE_NUTTX_TIME_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdbool.h>
|
|
#include <time.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* If Gregorian time is not supported, then neither is Julian */
|
|
|
|
#ifndef CONFIG_GREGORIAN_TIME
|
|
# undef CONFIG_JULIAN_TIME
|
|
#else
|
|
# define JD_OF_EPOCH 2440588 /* Julian Date of noon, J1970 */
|
|
|
|
# ifdef CONFIG_JULIAN_TIME
|
|
# define GREG_DUTC -141427 /* Default is October 15, 1582 */
|
|
# define GREG_YEAR 1582
|
|
# define GREG_MONTH 10
|
|
# define GREG_DAY 15
|
|
# endif /* CONFIG_JULIAN_TIME */
|
|
#endif /* !CONFIG_GREGORIAN_TIME */
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: clock_isleapyear
|
|
*
|
|
* Description:
|
|
* Return true if the specified year is a leap year
|
|
*
|
|
****************************************************************************/
|
|
|
|
int clock_isleapyear(int year);
|
|
|
|
/****************************************************************************
|
|
* Name: clock_daysbeforemonth
|
|
*
|
|
* Description:
|
|
* Get the number of days that occurred before the beginning of the month.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int clock_daysbeforemonth(int month, bool leapyear);
|
|
|
|
/****************************************************************************
|
|
* Name: clock_dayoftheweek
|
|
*
|
|
* Description:
|
|
* Get the day of the week
|
|
*
|
|
* Input Parameters:
|
|
* mday - The day of the month 1 - 31
|
|
* month - The month of the year 1 - 12
|
|
* year - the year including the 1900
|
|
*
|
|
* Returned Value:
|
|
* Zero based day of the week 0-6, 0 = Sunday, 1 = Monday... 6 = Saturday
|
|
*
|
|
****************************************************************************/
|
|
|
|
int clock_dayoftheweek(int mday, int month, int year);
|
|
|
|
/****************************************************************************
|
|
* Name: clock_calendar2utc
|
|
*
|
|
* Description:
|
|
* Calendar/UTC conversion based on algorithms from p. 604
|
|
* of Seidelman, P. K. 1992. Explanatory Supplement to
|
|
* the Astronomical Almanac. University Science Books,
|
|
* Mill Valley.
|
|
*
|
|
****************************************************************************/
|
|
|
|
time_t clock_calendar2utc(int year, int month, int day);
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_NUTTX_TIME_H */
|