time.h

Go to the documentation of this file.

/*
 * Amazon FreeRTOS POSIX V1.0.0
 * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef _FREERTOS_POSIX_TIME_H_
#define _FREERTOS_POSIX_TIME_H_

/* FreeRTOS+POSIX includes. */
#include "FreeRTOS_POSIX/sys/types.h"
#include "FreeRTOS_POSIX/signal.h"

#define MICROSECONDS_PER_SECOND    ( 1000000LL )                                   
#define NANOSECONDS_PER_SECOND     ( 1000000000LL )                                
#define NANOSECONDS_PER_TICK       ( NANOSECONDS_PER_SECOND / configTICK_RATE_HZ ) 
#define CLOCK_REALTIME     0     
#define CLOCK_MONOTONIC    1     
#define CLOCKS_PER_SEC    ( ( clock_t ) configTICK_RATE_HZ )

#define TIMER_ABSTIME     0x01

#if !defined( posixconfigENABLE_TIMESPEC ) || ( posixconfigENABLE_TIMESPEC == 1 )

    struct timespec
    {
        time_t tv_sec;     
        long tv_nsec;      
    };
#endif

#if !defined( posixconfigENABLE_ITIMERSPEC ) || ( posixconfigENABLE_ITIMERSPEC == 1 )

    struct itimerspec
    {
        struct timespec it_interval;     
        struct timespec it_value;        
    };
#endif

#if !defined( posixconfigENABLE_TM ) || ( posixconfigENABLE_TM == 1 )

    struct tm
    {
        time_t tm_tick;     
        int tm_sec;         
        int tm_min;         
        int tm_hour;        
        int tm_mday;        
        int tm_mon;         
        int tm_year;        
        int tm_wday;        
        int tm_yday;        
        int tm_isdst;       
    };
#endif /* if !defined( posixconfigENABLE_TM ) || ( posixconfigENABLE_TM == 1 ) */

clock_t clock( void );

int clock_getcpuclockid( pid_t pid,
                         clockid_t * clock_id );

int clock_getres( clockid_t clock_id,
                  struct timespec * res );

int clock_gettime( clockid_t clock_id,
                   struct timespec * tp );

int clock_nanosleep( clockid_t clock_id,
                     int flags,
                     const struct timespec * rqtp,
                     struct timespec * rmtp );

int clock_settime( clockid_t clock_id,
                   const struct timespec * tp );

struct tm * localtime_r( const time_t * timer,
                         struct tm * result );

int nanosleep( const struct timespec * rqtp,
               struct timespec * rmtp );

size_t strftime( char * s,
                 size_t maxsize,
                 const char * format,
                 const struct tm * timeptr );

time_t time( time_t * tloc );

int timer_create( clockid_t clockid,
                  struct sigevent * evp,
                  timer_t * timerid );

int timer_delete( timer_t timerid );

int timer_getoverrun( timer_t timerid );

int timer_gettime( timer_t timerid,
                   struct itimerspec * value );

int timer_settime( timer_t timerid,
                   int flags,
                   const struct itimerspec * value,
                   struct itimerspec * ovalue );

#endif /* ifndef _FREERTOS_POSIX_TIME_H_ */