rtems/score/timecounterimpl.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreTimecounter
0007  *
0008  * @brief This header file provides interfaces of the
0009  *   @ref RTEMSScoreTimecounter which are only used by the implementation.
0010  */
0011
0012 /*
0013  * Copyright (c) 2015 embedded brains GmbH & Co. KG
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_SCORE_TIMECOUNTERIMPL_H
0038 #define _RTEMS_SCORE_TIMECOUNTERIMPL_H
0039
0040 #include <rtems/score/timecounter.h>
0041 #include <sys/timetc.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif /* __cplusplus */
0046
0047 /**
0048  * @addtogroup RTEMSScoreTimecounter
0049  *
0050  * @{
0051  */
0052
0053 /**
0054  * @brief Sets the timecounter clock to the given value.
0055  *
0056  * @param bt The value to set the clock to.
0057  * @param lock_context The interrupt lock context.
0058  */
0059 void _Timecounter_Set_clock(
0060   const struct bintime *bt,
0061   ISR_lock_Context     *lock_context
0062 );
0063
0064 /** @} */
0065
0066 #ifdef __cplusplus
0067 }
0068 #endif /* __cplusplus */
0069
0070 #endif /* _RTEMS_SCORE_TIMECOUNTERIMPL_H */