TimerP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2023 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    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.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  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 TIMERP_H
#define TIMERP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
typedef struct TimerP_Params_ {
 
    uint32_t inputPreScaler; 
    uint32_t inputClkHz;  
    uint32_t periodInUsec; 
    uint32_t periodInNsec; 
    uint32_t oneshotMode; 
    uint32_t enableOverflowInt; 
    uint32_t enableDmaTrigger;  
} TimerP_Params;
 
#define TIME_IN_MICRO_SECONDS       (1000000U)
 
#define MAX_TIMER_COUNT_VALUE   (0xFFFFFFFFU)
 
#define TIME_IN_MILLI_SECONDS  (1000U)
 
#define TIME_IN_NANO_SECONDS  (1000000000U)
 
#define TIMERP_SHIFT_BY_EIGHT    (8U)
 
#define MAX_NUMBER_OF_CYCLES  (0xFFFFFFFFU)
 
#define MAX_NUMBER_OF_COUNT  (0xFFFFFFFFU)
 
void TimerP_Params_init(TimerP_Params *params);
 
void TimerP_setup(uint32_t baseAddr, TimerP_Params *params);
 
void TimerP_start(uint32_t baseAddr);
 
void TimerP_stop(uint32_t baseAddr);
 
uint32_t TimerP_getCount(uint32_t baseAddr);
 
uint32_t TimerP_getReloadCount(uint32_t baseAddr);
 
void TimerP_clearOverflowInt(uint32_t baseAddr);
 
 
uint32_t TimerP_isOverflowed(uint32_t baseAddr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* TIMERP_H */