csl_sar.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
 * ================
 * 22-Sept-2008 Added a new API function - SAR_getStatus()
 * ============================================================================
 */

#ifndef _CSL_SAR_H_
#define _CSL_SAR_H_

#ifdef __cplusplus
extern "C" {
#endif

/* Header Files */
#include <cslr.h>
#include <soc.h>
#include <csl_error.h>
#include <csl_types.h>
#include <csl_general.h>


/*****************************************************************************\
          SAR global macro declarations
\*****************************************************************************/

#define CSL_SAR_MAX_CLKDIV 127

#define CSL_SAR_NUM_CHANNEL 6

#define CSL_SAR_NUM_GPAIN   4

# define CSL_SAR_ADC_BUSY  1

# define CSL_SAR_DATA_AVAILABLE  0

# define CSL_SAR_ADC_START  1

#define CSL_SAR_OPEN  1

#define CSL_SAR_CLOSE  0


/**************************************************************************\
* SAR global typedef declarations                                         *
\**************************************************************************/

typedef enum {
    CSL_SAR_CHAN_0   = 0,
    CSL_SAR_CHAN_1  =  1,
    CSL_SAR_CHAN_2  =  2,
    CSL_SAR_CHAN_3  =  3,
    CSL_SAR_CHAN_4  =  4,
    CSL_SAR_CHAN_5  =  5,
    CSL_SAR_NO_CHAN =  6
   } CSL_SarChanSel;



typedef enum {
    CSL_SAR_POLLING   = 0,
    CSL_SAR_INTERRUPT = 1,
     CSL_SAR_DMA      = 2
   } CSL_SarOpMode;


typedef enum {
    CSL_SAR_CONTINUOUS_CONVERSION = 0,
     CSL_SAR_SINGLE_CONVERSION    = 1
   } CSL_SarChanCyc;

typedef enum {
     CSL_SAR_NO_DISCHARGE   = 0,
    CSL_SAR_DISCHARGE_ARRAY = 1
} CSL_SarMultiCh;


typedef enum {
    CSL_SAR_REF_0_8v = 0,
    CSL_SAR_REF_1v   = 1 ,
    CSL_SAR_REF_VIN  = 2
} CSL_RefVoltage;


typedef enum {
    CSL_SAR_GPO_0 = 0,
    CSL_SAR_GPO_1 = 1,
    CSL_SAR_GPO_2 = 2,
    CSL_SAR_GPO_3 = 3
} CSL_SarGPOPinSel;


typedef enum {
 CSL_SAR_GPO_IN  = 0,
 CSL_SAR_GPO_OUT = 1
} CSL_SarGPODir;

typedef enum
{
 CSL_KEYPAD_MEAS        = 0,
 CSL_BATTRY_MEAS        = 1,
 CSL_INT_VOLT_MEAS      = 2,
 CSL_VOLUME_CTRL        = 3,
 CSL_TOUCH_SCREEN_XAXIS = 4,
 CSL_TOUCH_SCREEN_YAXIS = 5,
 CSL_PEN_PRESS_DOWN     = 6
}CSL_SARMeasParam;


typedef struct {
    Uint16 SysClkDiv;
    CSL_SarOpMode OpMode;
    CSL_SarMultiCh MultiCh;
    CSL_RefVoltage RefVoltage;
 } CSL_SarChSetup;

typedef struct{
    CSL_SarRegsOvly baseAddr;
    Uint16 chanNo;
    Uint16 status;
}CSL_SarHandleObj;

typedef CSL_SarHandleObj*  SAR_Handle;

typedef struct{
    volatile Uint16 SARCTRL;
    volatile Uint16 SARCLKCTRL;
    volatile Uint16 SARPINCTRL;
    volatile Uint16 SARGPOCTRL;
}CSL_SarChConfig;

/*******************************************************************************
 * SAR function declarations
 ******************************************************************************/

CSL_Status SAR_init(
    void
);


CSL_Status SAR_deInit (
   void
);


CSL_Status SAR_chanOpen (
CSL_SarHandleObj* Sarobj,
CSL_SarChanSel   chanSel
    );


CSL_Status SAR_chanClose (
    CSL_SarHandleObj        *hsar
);



CSL_Status  SAR_chanInit(
SAR_Handle      hSar
 );

CSL_Status SAR_chanConfig (
    CSL_SarHandleObj            *pSarHandle,
    CSL_SarChConfig             *pConfigParam
);

CSL_Status SAR_getConfig (
    CSL_SarHandleObj            *pSarHandle,
    CSL_SarChConfig             *pConfigParam
);

CSL_Status SAR_chanSetup(
    CSL_SarHandleObj            *pSarHandle,
    CSL_SarChSetup              *pSarParam
);



CSL_Status SAR_chanCycSet (
    CSL_SarHandleObj          *hSar,
    CSL_SarChanCyc            cycSelect
);

CSL_Status SAR_startConversion (
    CSL_SarHandleObj        *hSar
    );

CSL_Status SAR_stopConversion (
    CSL_SarHandleObj    *hSar
   );

CSL_Status SAR_A2DMeasParamSet (
    CSL_SarHandleObj            *hSar,
    CSL_SARMeasParam            param,
    CSL_SarChanSel*             chanNo
);

CSL_Status SAR_readData (
    CSL_SarHandleObj    *hSar,
    Uint16              *buffer
);


CSL_Status SAR_GPODirSet (
    CSL_SarHandleObj            *hSar,
    CSL_SarGPOPinSel             Index,
    CSL_SarGPODir                dir
  );




Bool SAR_getStatus(
    CSL_SarHandleObj            *hSar,
    CSL_Status                  *status
   );


#ifdef __cplusplus
}
#endif

#endif /* _CSL_SAR_H_ */