csl_gpt.h

Go to the documentation of this file.

/*  ===========================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in
 *   the license agreement under which this software has been supplied.
 *  ===========================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 28-Sept-2008 Added GPT for CSL.
 * ============================================================================
 */

#ifndef _CSL_GPT_H_
#define _CSL_GPT_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "soc.h"
#include "csl_error.h"
#include "csl_types.h"
#include "csl_general.h"

/*****************************************************************************\
          GPT global macro declarations
\*****************************************************************************/
#define CSL_IAFR_TIMER_FLAG_0_RESETVAL (0x0001u)

#define CSL_IAFR_TIMER_FLAG_1_RESETVAL (0x0002u)

#define CSL_IAFR_TIMER_FLAG_2_RESETVAL (0x0004u)

#define CSL_IAFR_TIMER_FLAG_0_1_2_RESETVAL (0x0007u)

/**************************************************************************\
* GPT global typedef declarations                                         *
\**************************************************************************/

typedef enum{
    GPT_0 = 0,      
    GPT_1,          
    GPT_2,          
    GPT_INVALID     
}CSL_Instance;

typedef enum{
    GPT_AUTO_DISABLE = 0,   
    GPT_AUTO_ENABLE         
}CSL_AutoReLoad;


typedef enum{
    GPT_TIMER_DISABLE = 0,  
    GPT_TIMER_ENABLE        
}CSL_CtrlTimer;

typedef enum{
    GPT_PRE_SC_DIV_0 = 0,   
    GPT_PRE_SC_DIV_1,       
    GPT_PRE_SC_DIV_2,       
    GPT_PRE_SC_DIV_3,       
    GPT_PRE_SC_DIV_4,       
    GPT_PRE_SC_DIV_5,       
    GPT_PRE_SC_DIV_6,       
    GPT_PRE_SC_DIV_7,       
    GPT_PRE_SC_DIV_8,       
    GPT_PRE_SC_DIV_9,       
    GPT_PRE_SC_DIV_10,      
    GPT_PRE_SC_DIV_11,      
    GPT_PRE_SC_DIV_12,      
    GPT_PRE_SC_DIV_RESERVE  
}CSL_PreScale;

typedef struct{
    CSL_AutoReLoad  autoLoad;      
    CSL_PreScale    preScaleDiv;   
    CSL_CtrlTimer   ctrlTim;       
    Uint16          prdLow;        
    Uint16          prdHigh;       
}CSL_Config;

typedef struct {
    CSL_Instance    Instance;   
    Uint16          EventId;    
    CSL_TimRegsOvly regs;       
} CSL_GptObj;

typedef CSL_GptObj *CSL_Handle;


/******************************************************************************
 * GPT function declarations
 *****************************************************************************/

CSL_Handle GPT_open(CSL_Instance    instance,
                    CSL_GptObj      *gptObj,
                    CSL_Status      *status);

CSL_Status GPT_reset(CSL_Handle hGpt);

CSL_Status GPT_close(CSL_Handle hGpt);


CSL_Status GPT_start(CSL_Handle hGpt);

CSL_Status GPT_stop(CSL_Handle hGpt);

CSL_Status GPT_getCnt(CSL_Handle hGpt, Uint32 *timeCnt);

CSL_Status GPT_config(CSL_Handle hGpt, CSL_Config *hwConfig);
#ifdef __cplusplus
}
#endif

#endif /* _CSL_GPT_H_ */