dev/clock/arm-generic-timer.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsShared
0007  *
0008  * @brief Header defining architecture-specific clock functions.
0009  */
0010
0011 /*
0012  * Copyright (C) 2020 On-Line Applications Research Corporation (OAR)
0013  * Written by Kinsey Moore <kinsey.moore@oarcorp.com>
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 #include <rtems/score/basedefs.h>
0038
0039 /**
0040  * This function returns the current compare value for the ARM General Purpose
0041  * Timer.
0042  *
0043  * @return The current compare value.
0044  */
0045 uint64_t arm_gt_clock_get_compare_value(void);
0046
0047 /**
0048  * This function sets the current compare value for the ARM General Purpose
0049  * Timer.
0050  *
0051  * @param[in] cval The value to set as the compare value
0052  */
0053 void arm_gt_clock_set_compare_value(uint64_t cval);
0054
0055 /**
0056  * This function returns the count for the ARM General Purpose Timer.
0057  *
0058  * @return The current count.
0059  */
0060 uint64_t arm_gt_clock_get_count(void);
0061
0062 /**
0063  * This function sets the control register for the ARM General Purpose Timer.
0064  *
0065  * @param[in] ctl The value to set to the control register
0066  */
0067 void arm_gt_clock_set_control(uint32_t ctl);
0068
0069 /**
0070  * This function gets the frequency and IRQ number used by the ARM General
0071  * Purpose Timer.
0072  *
0073  * @param[out] frequency The frequency at which the timer will fire.
0074  * @param[out] irq The number of the IRQ on which the timer will fire.
0075  */
0076 void arm_generic_timer_get_config(uint32_t *frequency, uint32_t *irq);