include/mpc83xx/gtm.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @brief Header file for timer functions.
0007  */
0008
0009 /*
0010  * Copyright (c) 2008 embedded brains GmbH & Co. KG
0011  * Redistribution and use in source and binary forms, with or without
0012  * modification, are permitted provided that the following conditions
0013  * are met:
0014  * 1. Redistributions of source code must retain the above copyright
0015  *    notice, this list of conditions and the following disclaimer.
0016  * 2. Redistributions in binary form must reproduce the above copyright
0017  *    notice, this list of conditions and the following disclaimer in the
0018  *    documentation and/or other materials provided with the distribution.
0019  *
0020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0021  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0022  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0023  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0024  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0025  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0026  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0029  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0030  * POSSIBILITY OF SUCH DAMAGE.
0031  */
0032
0033 #ifndef LIBBSP_POWERPC_MPC83XX_TIMER_H
0034 #define LIBBSP_POWERPC_MPC83XX_TIMER_H
0035
0036 #include <stdint.h>
0037 #include <stdbool.h>
0038
0039 #include <rtems.h>
0040
0041 #define MPC83XX_GTM_NUMBER 8
0042
0043 #define MPC83XX_GTM_CLOCK_CASCADED 0x0000
0044 #define MPC83XX_GTM_CLOCK_SYSTEM 0x0002
0045 #define MPC83XX_GTM_CLOCK_SYSTEM_SLOW 0x0004
0046 #define MPC83XX_GTM_CLOCK_EXTERN 0x0006
0047
0048 rtems_status_code mpc83xx_gtm_initialize( int timer, int clock);
0049
0050 rtems_status_code mpc83xx_gtm_enable_restart( int timer, bool enable);
0051
0052 rtems_status_code mpc83xx_gtm_set_clock( int timer, int clock);
0053
0054 rtems_status_code mpc83xx_gtm_get_clock( int timer, int *clock);
0055
0056 rtems_status_code mpc83xx_gtm_start( int timer);
0057
0058 rtems_status_code mpc83xx_gtm_stop( int timer);
0059
0060 rtems_status_code mpc83xx_gtm_set_value( int timer, uint16_t value);
0061
0062 rtems_status_code mpc83xx_gtm_get_value( int timer, uint16_t *value);
0063
0064 rtems_status_code mpc83xx_gtm_set_reference( int timer, uint16_t reference);
0065
0066 rtems_status_code mpc83xx_gtm_get_reference( int timer, uint16_t *reference);
0067
0068 rtems_status_code mpc83xx_gtm_set_prescale( int timer, uint8_t prescale);
0069
0070 rtems_status_code mpc83xx_gtm_get_prescale( int timer, uint8_t *prescale);
0071
0072 rtems_status_code mpc83xx_gtm_interrupt_get_vector( int timer, rtems_vector_number *vector);
0073
0074 rtems_status_code mpc83xx_gtm_interrupt_enable( int timer);
0075
0076 rtems_status_code mpc83xx_gtm_interrupt_disable( int timer);
0077
0078 rtems_status_code mpc83xx_gtm_interrupt_clear( int timer);
0079
0080 #endif /* LIBBSP_POWERPC_MPC83XX_TIMER_H */