include/bsp/system-clocks.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsARMTMS570
0007  *
0008  * @brief This header file provides a free-running timer interface.
0009  */
0010
0011 /*
0012  * Copyright (C) 2014 Pavel Pisa <pisa@cmp.felk.cvut.cz>
0013  *
0014  * Czech Technical University in Prague
0015  * Zikova 1903/4
0016  * 166 36 Praha 6
0017  * Czech Republic
0018  *
0019  * Redistribution and use in source and binary forms, with or without
0020  * modification, are permitted provided that the following conditions
0021  * are met:
0022  * 1. Redistributions of source code must retain the above copyright
0023  *    notice, this list of conditions and the following disclaimer.
0024  * 2. Redistributions in binary form must reproduce the above copyright
0025  *    notice, this list of conditions and the following disclaimer in the
0026  *    documentation and/or other materials provided with the distribution.
0027  *
0028  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0029  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0030  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0031  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0032  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0033  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0034  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0035  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0036  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0037  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0038  * POSSIBILITY OF SUCH DAMAGE.
0039  */
0040
0041 #ifndef LIBBSP_ARM_TMS570_SYSTEM_CLOCKS_H
0042 #define LIBBSP_ARM_TMS570_SYSTEM_CLOCKS_H
0043
0044 #include <bsp/tms570.h>
0045
0046 #ifdef __cplusplus
0047 extern "C" {
0048 #endif /* __cplusplus */
0049
0050 /**
0051  * @defgroup tms570_clock System Clocks
0052  *
0053  * @ingroup RTEMSBSPsARMTMS570
0054  *
0055  * @brief System clocks.
0056  *
0057  * @{
0058  */
0059
0060 /**
0061  * @brief Returns current standard timer value in microseconds.
0062  *
0063  * This function uses RTI module free running counter 0 used
0064  * which is used as system tick timebase as well.
0065  */
0066 static inline unsigned tms570_timer(void)
0067 {
0068   uint32_t actual_fcr0 = TMS570_RTI.CNT[0].FRCx;
0069   return actual_fcr0;
0070 }
0071
0072 /** @} */
0073
0074 #ifdef __cplusplus
0075 }
0076 #endif /* __cplusplus */
0077
0078 #endif /* LIBBSP_ARM_TMS570_SYSTEM_CLOCKS_H */