timecounter.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 * Copyright (C) 2015, 2021 embedded brains GmbH & Co. KG
 *
 * 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_SCORE_TIMECOUNTER_H
#define _RTEMS_SCORE_TIMECOUNTER_H
 
#include <sys/time.h>
#include <sys/timetc.h>
#include <machine/_timecounter.h>
 
#include <rtems/score/isrlock.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


void _Timecounter_Bintime( struct bintime *bt );

void _Timecounter_Nanotime( struct timespec *ts );

void _Timecounter_Microtime( struct timeval *tv );

void _Timecounter_Binuptime( struct bintime *bt );

int64_t _Timecounter_Sbinuptime( void );

void _Timecounter_Nanouptime( struct timespec *ts );

void _Timecounter_Microuptime( struct timeval *tv );

void _Timecounter_Getbintime( struct bintime *bt );

void _Timecounter_Getnanotime( struct timespec *ts );

void _Timecounter_Getmicrotime( struct timeval *tv );

void _Timecounter_Getbinuptime( struct bintime *bt );

void _Timecounter_Getnanouptime( struct timespec *ts );

void _Timecounter_Getmicrouptime( struct timeval *tv );

void _Timecounter_Getboottime( struct timeval *tv );

void _Timecounter_Getboottimebin( struct bintime *bt );

void _Timecounter_Install( struct timecounter *tc );

void _Timecounter_Tick( void );
 
#if ISR_LOCK_NEEDS_OBJECT
extern ISR_lock_Control _Timecounter_Lock;
#endif

#define _Timecounter_Acquire( lock_context ) \
  _ISR_lock_ISR_disable_and_acquire( &_Timecounter_Lock, lock_context )

#define _Timecounter_Release(lock_context) \
   _ISR_lock_Release_and_ISR_enable(&_Timecounter_Lock, lock_context)

void _Timecounter_Tick_simple(
  uint32_t delta,
  uint32_t offset,
  ISR_lock_Context *lock_context
);

extern volatile time_t _Timecounter_Time_second;

extern volatile int32_t _Timecounter_Time_uptime;

extern struct timecounter *_Timecounter;

typedef void ( *Timecounter_NTP_update_second )(
  int64_t *adjustment,
  time_t  *newsec
);

void _Timecounter_Set_NTP_update_second(
  Timecounter_NTP_update_second handler
);

void _Timecounter_NTP_update_second(int64_t *adjustment, time_t *newsec);

uint64_t _Timecounter_Get_frequency(void);

void _Timecounter_Discipline(struct timespec *tsp, long nsec);

 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _RTEMS_SCORE_TIMECOUNTER_H */