Timer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016, 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_drivers_Timer__include
#define ti_drivers_Timer__include

#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif

typedef struct Timer_Config_ *Timer_Handle;

#define TIMER_CMD_RESERVED                (32)

#define TIMER_STATUS_RESERVED            (-32)

#define TIMER_STATUS_SUCCESS               (0)

#define TIMER_STATUS_ERROR                (-1)

#define TIMER_STATUS_UNDEFINEDCMD         (-2)

typedef enum Timer_Mode_
{
    TIMER_ONESHOT_CB, 
    TIMER_ONESHOT_BLOCK, 
    TIMER_CONTINUOUS_CB, 
    TIMER_MODE_FREE_RUNNING
} Timer_Mode;

typedef enum Timer_Period_Units_
{
    TIMER_PERIOD_US, /* Period in microseconds */
    TIMER_PERIOD_HZ, /* Period in frequency */
    TIMER_PERIOD_COUNTS /* Period in counts */
} Timer_Period_Units;

typedef void (*Timer_CallBackFxn)(Timer_Handle handle);

typedef struct Timer_Params_
{
    Timer_Mode timerMode;
    Timer_Period_Units periodUnits;
    Timer_CallBackFxn timerCallback;
    uint32_t period;
} Timer_Params;

typedef int_fast16_t (*Timer_ControlFxn)(Timer_Handle handle, uint_fast16_t cmd,
        void *arg);

typedef void (*Timer_CloseFxn)(Timer_Handle handle);

typedef uint32_t (*Timer_GetCountFxn)(Timer_Handle handle);

typedef void (*Timer_InitFxn)(Timer_Handle handle);

typedef Timer_Handle (*Timer_OpenFxn)(Timer_Handle handle,
        Timer_Params *params);

typedef void (*Timer_StartFxn)(Timer_Handle handle);

typedef void (*Timer_StopFxn)(Timer_Handle handle);

typedef struct Timer_FxnTable_
{
    Timer_CloseFxn closeFxn;
    Timer_ControlFxn controlFxn;
    Timer_GetCountFxn getCountFxn;
    Timer_InitFxn initFxn;
    Timer_OpenFxn openFxn;
    Timer_StartFxn startFxn;
    Timer_StopFxn stopFxn;
} Timer_FxnTable;

typedef struct Timer_Config_
{
    Timer_FxnTable const *fxnTablePtr;
    void *object;
    void const *hwAttrs;
} Timer_Config;

extern int_fast16_t Timer_control(Timer_Handle handle, uint_fast16_t cmd,
                                  void *arg);


extern void Timer_close(Timer_Handle handle);

extern uint32_t Timer_getCount(Timer_Handle handle);


extern void Timer_init(void);

extern Timer_Handle Timer_open(uint_least8_t index, Timer_Params *params);

extern void Timer_Params_init(Timer_Params *params);

extern void Timer_start(Timer_Handle handle);

extern void Timer_stop(Timer_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_driver_Timer__include */