ISF  2.2 rev 5
Intelligent Sensing Framework for Kinetis with Processor Expert
fsl_Sensor_Custom_1_Functions module documentation

Data Structures

struct  Custom_1_DataBuffer_t
 This structure defines the dummy DSA data buffer format. More...
 
struct  Custom_1_SensorData_EngFixed_t
 
struct  Custom_1_SensorData_Float_t
 Standard fixed type for three axis accelerometers. More...
 
struct  Custom_1_Sensor_Specific_Reg_t
 
struct  Custom_1_Sensor_Specific_Settings_t
 
struct  Custom_1_Rate_Specific_Settings_t
 This structure defines important settings. More...
 

Macros

#define Custom_1_CONVERT_FLOAT_FACTOR   0.000061
 
#define Custom_1_CONVERT_FIXED_FACTOR   4
 
#define __fsl_Sensor_Custom_1_Functions_H_
 
#define Custom_1_DATA_TYPE   Custom_1_DataBuffer_t
 
#define __fsl_Sensor_Custom_1_Functions_H__
 
#define Custom_1_SET_FIELD(name, val)   (((val)<<Custom_1_##name##_SHIFT)&(Custom_1_##name##_MASK))
 
#define Custom_1_GET_FIELD(name, val)   ((val&Custom_1_##name##_MASK)>>Custom_1_##name##_SHIFT)
 
#define Custom_1_FREAD_MASK   0x02
 
#define Custom_1_FREAD_SHIFT   1
 
#define Custom_1_ASLP_RATE_MASK   0xC0
 
#define Custom_1_ASLP_RATE_SHIFT   6
 
#define Custom_1_DR_MASK   0x38
 
#define Custom_1_DR_SHIFT   3
 
#define Custom_1_ST_MASK   0x80
 
#define Custom_1_ST_SHIFT   7
 
#define Custom_1_RST_MASK   0x40
 
#define Custom_1_RST_SHIFT   6
 
#define Custom_1_SLPE_MASK   0x04
 
#define Custom_1_SLPE_SHIFT   2
 
#define Custom_1_SMODS_MASK   0x18
 
#define Custom_1_SMODS_SHIFT   3
 
#define Custom_1_MODS_MASK   0x03
 
#define Custom_1_MODS_SHIFT   0
 
#define Custom_1_ZYXDR_MASK   0x08
 
#define Custom_1_ZYXDR_SHIFT   3
 
#define Custom_1_ACTIVE_MASK   0x01
 

Typedefs

typedef int32 Custom_1_Status_t
 SENSOR internal return codes. More...
 
typedef uint32_t isf_Custom_1_fixed_data_t
 
typedef float isf_Custom_1_float_data_t
 

Enumerations

enum  { Custom_1_STATUS_00 = 0x00, Custom_1_WHO_AM_I = 0x0D, Custom_1_CTRL_REG1 = 0x2A, Custom_1_CTRL_REG2 = 0x2B }
 
enum  { Custom_1_SUCCESS, Custom_1_DATA_OVERWRITE, Custom_1_ERROR }
 

Functions

void Custom_1__Void_ ()
 
isf_dsa_status_t Custom_1_float_Custom_converter (Custom_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Custom_1_DataBuffer_t *nativeSample, void *vpConvertedSample)
 
isf_dsa_status_t Custom_1_fixed_Custom_converter (Custom_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Custom_1_DataBuffer_t *nativeSample, void *vpConvertedSample)
 
isf_dsa_status_t fsl_Sensor_Custom_1_Convert (volatile isf_SensorHandle_t *pSensorHandle, isf_SensorDataTypes_t convertToType, isf_dsa_result_types_t resultType, void *pNativeSample, void *pConvertedSample, int32_t *numBytes)
 
isf_dsa_status_t fsl_Sensor_Custom_1_Configure (isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
 
isf_dsa_status_t fsl_Sensor_Custom_1_ValidateSettings (isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
 
isf_dsa_status_t fsl_Sensor_Custom_1_Initialize (isf_SensorHandle_t *pSensorHandle)
 
isf_dsa_status_t fsl_Sensor_Custom_1_StartData (isf_SensorHandle_t *pSensorHandle)
 
isf_dsa_status_t fsl_Sensor_Custom_1_EndData (isf_SensorHandle_t *pSensorHandle)
 
isf_dsa_status_t fsl_Sensor_Custom_1_Shutdown (isf_SensorHandle_t *pSensorHandle)
 
void Custom_1_fsl_Sensor_Custom_Convert (volatile void *pSensorHandle, uint32_t convertToType, uint8_t resultType, void *pNativeSample, void *pConvertedSample, int32_t *numBytes, uint8_t *retVal)
 
void Custom_1_fsl_Sensor_Custom_PeriodicCallback (void *pSensorHandle)
 
void Custom_1_fsl_Sensor_Custom_Shutdown (void *pSensorHandle, uint8_t *retVal)
 
void Custom_1_fsl_Sensor_Custom_EndData (void *pSensorHandle, uint8_t *retVal)
 
void Custom_1_fsl_Sensor_Custom_StartData (void *pSensorHandle, uint8_t *retVal)
 
void Custom_1_fsl_Sensor_Custom_Configure (void *pSensorHandle, void *pSensorSettings, uint8_t *retVal)
 
void Custom_1_fsl_Sensor_Custom_ValidateSettings (void *pSensorHandle, void *pSensorSettings, uint8_t *retVal)
 
void Custom_1_fsl_Sensor_Custom_Initialize (void *pSensorHandle, uint8_t *retVal)
 

Variables

const uint8_t Custom_1_Who_Am_I_Values [] = {0x4A, 0x5A}
 Define the WHO_AM_I register values for both possible sensor variations. More...
 
Custom_1_Sensor_Specific_Settings_t Custom_1_Sensor_Specific_Config
 This allows access to the sensor specific configuration for the target sensor. More...
 
const i2c_device_t Custom_1_DeviceInfo
 This allows access to the sensor communications specific configuration. More...
 
isf_SensorTypes_t Custom_1_SupportedSensorTypes []
 Supported sensor and data types for the Sensor. More...
 
isf_SensorDataTypes_t Custom_1_SupportedDataTypes []
 
const uint8_t Custom_1_Who_Am_I_Values []
 Define the WHO_AM_I register values for both possible sensor variations. More...
 

Detailed Description

Macro Definition Documentation

#define __fsl_Sensor_Custom_1_Functions_H_

Definition at line 109 of file fsl_Sensor_Custom_1_Functions.h.

#define __fsl_Sensor_Custom_1_Functions_H__

Definition at line 142 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_ASLP_RATE_MASK   0xC0

Definition at line 195 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_ASLP_RATE_SHIFT   6

Definition at line 196 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_CONVERT_FIXED_FACTOR   4

Definition at line 77 of file fsl_Sensor_Custom_1_Functions.c.

Referenced by Custom_1_fixed_Custom_converter().

#define Custom_1_CONVERT_FLOAT_FACTOR   0.000061

Definition at line 76 of file fsl_Sensor_Custom_1_Functions.c.

Referenced by Custom_1_float_Custom_converter().

#define Custom_1_DATA_TYPE   Custom_1_DataBuffer_t

Definition at line 137 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_DR_MASK   0x38

Definition at line 197 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_DR_SHIFT   3

Definition at line 198 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_FREAD_MASK   0x02

Definition at line 193 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_FREAD_SHIFT   1

Definition at line 194 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_GET_FIELD (   name,
  val 
)    ((val&Custom_1_##name##_MASK)>>Custom_1_##name##_SHIFT)
#define Custom_1_MODS_MASK   0x03

Definition at line 207 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_MODS_SHIFT   0

Definition at line 208 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_RST_MASK   0x40

Definition at line 201 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_RST_SHIFT   6

Definition at line 202 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_SET_FIELD (   name,
  val 
)    (((val)<<Custom_1_##name##_SHIFT)&(Custom_1_##name##_MASK))
#define Custom_1_SLPE_MASK   0x04

Definition at line 203 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_SLPE_SHIFT   2

Definition at line 204 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_SMODS_MASK   0x18

Definition at line 205 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_SMODS_SHIFT   3

Definition at line 206 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_ST_MASK   0x80

Definition at line 199 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_ST_SHIFT   7

Definition at line 200 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_ZYXDR_MASK   0x08

Definition at line 209 of file fsl_Sensor_Custom_1_Functions.h.

#define Custom_1_ZYXDR_SHIFT   3

Definition at line 210 of file fsl_Sensor_Custom_1_Functions.h.

Typedef Documentation

SENSOR internal return codes.

Definition at line 114 of file fsl_Sensor_Custom_1_Functions.h.

typedef uint32_t isf_Custom_1_fixed_data_t

Definition at line 115 of file fsl_Sensor_Custom_1_Functions.h.

Definition at line 116 of file fsl_Sensor_Custom_1_Functions.h.

Enumeration Type Documentation

anonymous enum
Enumerator
Custom_1_STATUS_00 
Custom_1_WHO_AM_I 
Custom_1_CTRL_REG1 
Custom_1_CTRL_REG2 

Definition at line 167 of file fsl_Sensor_Custom_1_Functions.h.

anonymous enum
Enumerator
Custom_1_SUCCESS 
Custom_1_DATA_OVERWRITE 
Custom_1_ERROR 

Definition at line 175 of file fsl_Sensor_Custom_1_Functions.h.

Function Documentation

void Custom_1__Void_ ( )

Definition at line 55 of file fsl_Sensor_Custom_1_Functions.c.

isf_dsa_status_t Custom_1_fixed_Custom_converter ( Custom_1_Sensor_Specific_Settings_t pSensorSpecificConfig,
Custom_1_DataBuffer_t nativeSample,
void *  vpConvertedSample 
)
isf_dsa_status_t Custom_1_float_Custom_converter ( Custom_1_Sensor_Specific_Settings_t pSensorSpecificConfig,
Custom_1_DataBuffer_t nativeSample,
void *  vpConvertedSample 
)
void Custom_1_fsl_Sensor_Custom_Convert ( volatile void *  pSensorHandle,
uint32_t  convertToType,
uint8_t  resultType,
void *  pNativeSample,
void *  pConvertedSample,
int32_t *  numBytes,
uint8_t *  retVal 
)
void Custom_1_fsl_Sensor_Custom_EndData ( void *  pSensorHandle,
uint8_t *  retVal 
)
void Custom_1_fsl_Sensor_Custom_Shutdown ( void *  pSensorHandle,
uint8_t *  retVal 
)

Definition at line 341 of file fsl_Sensor_Custom_1_Functions.c.

References bm_unregister_callback(), DSA_ERR_PARAM, DSA_STATE_INITIALIZED, ISF_SUCCESS, and DeviceDescriptor_struct::token.

Referenced by fsl_Sensor_Custom_1_Shutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

void Custom_1_fsl_Sensor_Custom_ValidateSettings ( void *  pSensorHandle,
void *  pSensorSettings,
uint8_t *  retVal 
)

Definition at line 659 of file fsl_Sensor_Custom_1_Functions.c.

References DSA_ERR_PARAM, and ISF_SUCCESS.

Referenced by fsl_Sensor_Custom_1_ValidateSettings().

Here is the caller graph for this function:

isf_dsa_status_t fsl_Sensor_Custom_1_Configure ( isf_SensorHandle_t pSensorHandle,
isf_dsa_SensorSettings_t pSensorSettings 
)

Definition at line 128 of file fsl_Sensor_Custom_1_Functions.c.

References Custom_1_fsl_Sensor_Custom_Configure().

Here is the call graph for this function:

isf_dsa_status_t fsl_Sensor_Custom_1_Convert ( volatile isf_SensorHandle_t pSensorHandle,
isf_SensorDataTypes_t  convertToType,
isf_dsa_result_types_t  resultType,
void *  pNativeSample,
void *  pConvertedSample,
int32_t *  numBytes 
)

Definition at line 122 of file fsl_Sensor_Custom_1_Functions.c.

References Custom_1_fsl_Sensor_Custom_Convert().

Referenced by Custom_1_fsl_Sensor_Custom_PeriodicCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

isf_dsa_status_t fsl_Sensor_Custom_1_EndData ( isf_SensorHandle_t pSensorHandle)

Definition at line 152 of file fsl_Sensor_Custom_1_Functions.c.

References Custom_1_fsl_Sensor_Custom_EndData().

Here is the call graph for this function:

isf_dsa_status_t fsl_Sensor_Custom_1_Initialize ( isf_SensorHandle_t pSensorHandle)

Definition at line 140 of file fsl_Sensor_Custom_1_Functions.c.

References Custom_1_fsl_Sensor_Custom_Initialize().

Here is the call graph for this function:

isf_dsa_status_t fsl_Sensor_Custom_1_Shutdown ( isf_SensorHandle_t pSensorHandle)

Definition at line 158 of file fsl_Sensor_Custom_1_Functions.c.

References Custom_1_fsl_Sensor_Custom_Shutdown().

Here is the call graph for this function:

isf_dsa_status_t fsl_Sensor_Custom_1_StartData ( isf_SensorHandle_t pSensorHandle)

Definition at line 146 of file fsl_Sensor_Custom_1_Functions.c.

References Custom_1_fsl_Sensor_Custom_StartData().

Here is the call graph for this function:

isf_dsa_status_t fsl_Sensor_Custom_1_ValidateSettings ( isf_SensorHandle_t pSensorHandle,
isf_dsa_SensorSettings_t pSensorSettings 
)

Definition at line 134 of file fsl_Sensor_Custom_1_Functions.c.

References Custom_1_fsl_Sensor_Custom_ValidateSettings().

Here is the call graph for this function:

Variable Documentation

const i2c_device_t Custom_1_DeviceInfo
Initial value:
=
{
.baudRate_kbps = 400,
.address = 29
}

This allows access to the sensor communications specific configuration.

Updated as per MMA865x device settings.

Definition at line 80 of file fsl_Sensor_Custom_1_Functions.c.

Custom_1_Sensor_Specific_Settings_t Custom_1_Sensor_Specific_Config
Initial value:
=
{
.sensorFullScaleRange = 0,
.regCount = 2,
.regPairs =
{
{ Custom_1_CTRL_REG1, (Custom_1_SET_FIELD(ASLP_RATE,0)) | (Custom_1_SET_FIELD(DR,0)) | (Custom_1_SET_FIELD(FREAD,0)) },
}
}
#define Custom_1_SET_FIELD(name, val)

This allows access to the sensor specific configuration for the target sensor.

Definition at line 62 of file fsl_Sensor_Custom_1_Functions.c.

isf_SensorTypes_t Custom_1_SupportedSensorTypes[]
Initial value:

Supported sensor and data types for the Sensor.

Supported sensor and data types.

Definition at line 87 of file fsl_Sensor_Custom_1_Functions.c.

const uint8_t Custom_1_Who_Am_I_Values[] = {0x4A, 0x5A}

Define the WHO_AM_I register values for both possible sensor variations.

Definition at line 59 of file fsl_Sensor_Custom_1_Functions.c.

const uint8_t Custom_1_Who_Am_I_Values[]

Define the WHO_AM_I register values for both possible sensor variations.

Definition at line 59 of file fsl_Sensor_Custom_1_Functions.c.