32b/cal.h File Reference

Contains the public interface to the calibrator (CAL) module routines. More...

#include "sw/modules/types/src/types.h"
#include "sw/modules/cal/src/cal_states.h"
#include "sw/modules/hal/src/32b/hal_data.h"
#include "sw/modules/math/src/32b/math.h"
#include "sw/modules/offset/src/32b/offset.h"
#include "sw/modules/user/src/32b/userParams.h"
#include "user.h"

Go to the source code of this file.

Data Structures
struct	_CAL_Obj_
	Defines the calibrator (CAL) object. More...

Typedefs
typedef struct _CAL_Obj_	CAL_Obj
	Defines the calibrator (CAL) object. More...
typedef struct _CAL_Obj_ *	CAL_Handle
	Defines the CAL handle. More...

Functions
static void	CAL_disable (CAL_Handle handle)
	Disables the calibrator (CAL) module. More...
static void	CAL_enable (CAL_Handle handle)
	Enables the calibrator (CAL) module. More...
static uint_least32_t	CAL_getCount_state (CAL_Handle handle)
	Gets the state count value. More...
static bool	CAL_getFlag_enable (CAL_Handle handle)
	Gets the value of the enable flag. More...
static bool	CAL_getFlag_enableAdcOffset (CAL_Handle handle)
	Gets the value of the enable ADC offset flag. More...
static OFFSET_Handle *	CAL_getOffsetHandleAddr_I (CAL_Handle handle)
	Gets the current offset handle address. More...
static OFFSET_Handle *	CAL_getOffsetHandleAddr_V (CAL_Handle handle)
	Gets the voltage offset handle address. More...
static _iq	CAL_getOffsetValue_I (CAL_Handle handle, const uint_least8_t sensorNumber)
	Gets the current offset value. More...
static _iq	CAL_getOffsetValue_V (CAL_Handle handle, const uint_least8_t sensorNumber)
	Gets the voltage offset value. More...
static CAL_State_e	CAL_getState (CAL_Handle handle)
	Gets the calibration state. More...
static uint_least32_t	CAL_getWaitTime (CAL_Handle handle, const CAL_State_e state)
	Gets the wait time for a given state. More...
static void	CAL_incrCounter_state (CAL_Handle handle)
	Increments the state count value. More...
CAL_Handle	CAL_init (void *pMemory, const size_t numBytes)
	Initializes the calibrator (CAL) module. More...
static bool	CAL_isEnabled (CAL_Handle handle)
	Returns a boolean value denoting if the module is enabled (true) or not (false) More...
static bool	CAL_isError (CAL_Handle handle)
	Determines if there is a calibrator error. More...
static bool	CAL_isIdle (CAL_Handle handle)
	Determines if the calibrator is in the idle state. More...
static bool	CAL_isNotIdle (CAL_Handle handle)
	Determines if the calibrator is not in the idle state. More...
void	CAL_reset (CAL_Handle handle)
	Resets the calibrator. More...
static void	CAL_resetCounter_state (CAL_Handle handle)
	Resets the state count value. More...
static void	CAL_setCount_state (CAL_Handle handle, const uint_least32_t count)
	Sets the state count value. More...
static void	CAL_setFlag_enable (CAL_Handle handle, const bool value)
	Sets the value of the enable flag. More...
static void	CAL_setFlag_enableAdcOffset (CAL_Handle handle, const bool value)
	Sets the value of the enable ADC offset flag. More...
void	CAL_setParams (CAL_Handle handle, const USER_Params *pUserParams)
	Sets the parameters. More...
static void	CAL_setState (CAL_Handle handle, const CAL_State_e state)
	Sets the calibration state. More...
static void	CAL_setWaitTime (CAL_Handle handle, const CAL_State_e state, const uint_least32_t waitTime)
	Sets the wait time for a given state. More...
void	CAL_setWaitTimes (CAL_Handle handle, const uint_least32_t *pWaitTimes)
	Sets the wait times. More...
static void	CAL_setup (CAL_Handle handle)
	Sets up the calibrator (CAL) module. More...
static void	CAL_run (CAL_Handle handle, const HAL_AdcData_t *pAdcData)
	Runs the calibrator (CAL) module. More...
bool	CAL_updateState (CAL_Handle handle)
	Updates the calibrator (CAL) state. More...

Detailed Description

Contains the public interface to the calibrator (CAL) module routines.

(C) Copyright 2014, Texas Instruments, Inc.

Definition in file 32b/cal.h.