TimerP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2017, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_osal_TimerP__include
#define ti_osal_TimerP__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#define TimerP_ANY            ((uint32_t)0xFEEDU)

#define TimerP_ANY_MAX_RESTRICTIONS            ((uint32_t)15U)

#define TimerP_ID_INVALID     ((uint32_t)0xFFFFU)

#define TimerP_MAX_PERIOD     ((uint32_t)0xFFFFFFFFU)

#define TimerP_USE_DEFAULT    ((uint32_t)0xFFFFFFFFU)

typedef struct TimerP_FreqHz_s {
    uint32_t hi;      
    uint32_t lo;      
} TimerP_FreqHz;

typedef enum TimerP_Status_e {
    TimerP_OK            =             0,
    TimerP_FAILURE       = (-(int32_t) 1),
    TimerP_NOT_AVAILABLE = (-(int32_t) 2),
    TimerP_BAD_INT_NUM   = (-(int32_t) 3),
    TimerP_ISR_HOOK_ERR  = (-(int32_t) 4)
} TimerP_Status;

typedef uint32_t TimerP_PeriodType;
#define TimerP_PeriodType_MICROSECS               ( (uint32_t) 0U)

#define TimerP_PeriodType_COUNTS                  ( (uint32_t) 1U)
/* @} */

typedef uint32_t TimerP_RunMode;
#define TimerP_RunMode_CONTINUOUS                 ( (uint32_t) 0U)

#define TimerP_RunMode_ONESHOT                    ( (uint32_t) 1U) 
/* @} */

typedef uint32_t TimerP_StartMode;
#define TimerP_StartMode_AUTO                     ( (uint32_t) 0U)

#define TimerP_StartMode_USER                     ( (uint32_t) 1U)    
/* @} */

typedef enum TimerP_Timer64Mode_e {
  TimerP_Timer64Mode_64BITGPTIMER,
  TimerP_Timer64Mode_UNCHAINED,
  TimerP_Timer64Mode_CHAINED
} TimerP_Timer64Mode;

typedef enum TimerP_Timer64Half_e {
  TimerP_Timer64Half_LOWER,
  TimerP_Timer64Half_UPPER,
  TimerP_Timer64Half_DEFAULT
}TimerP_Timer64Half;

typedef  void *TimerP_Handle;

typedef void (*TimerP_Fxn)(uintptr_t arg);

typedef struct TimerP_Params_s {
    char    *name;        
    uint32_t periodType;  
    uint32_t  extfreqLo;  
    uint32_t  extfreqHi;  
    uint32_t  intfreqLo;  
    uint32_t  intfreqHi;  
    uint32_t startMode;   
    uint32_t runMode;     
    uint32_t period;      
    TimerP_Timer64Mode timerMode; 
    TimerP_Timer64Half timerHalf; 
    uint32_t  intNum;      
#if (defined (_TMS320C6X) || defined (BUILD_C7X))
    uint32_t  eventId;     
#endif
    void*    arg;         
} TimerP_Params;

extern TimerP_Handle TimerP_create(uint32_t        id,
                                   TimerP_Fxn     tickFxn,
                                   const TimerP_Params *timerParams);

extern TimerP_Status TimerP_delete(TimerP_Handle timerHandle);

extern TimerP_Status TimerP_setPeriodMicroSecs(TimerP_Handle timerHandle, uint32_t microsecs);

extern void TimerP_Params_init(TimerP_Params *timerParams);

extern TimerP_Status TimerP_start(TimerP_Handle timerHandle);

extern TimerP_Status TimerP_stop(TimerP_Handle timerHandle);

extern TimerP_Status TimerP_ClearInterrupt(TimerP_Handle timerHandle);

extern uint64_t TimerP_getTimeInUsecs(void);

extern uint32_t TimerP_getReloadCount(TimerP_Handle timerHandle);

uint32_t TimerP_getCount(TimerP_Handle timerHandle);

#ifdef __cplusplus
}
#endif

#endif /* ti_osal_ClockP__include */
/* @} */