| ISF 2.2 rev 5 Intelligent Sensing Framework for Kinetis with Processor Expert

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

fsl_mag3110_i2c_3D_mag.h
Go to the documentation of this file.
1 /**
2 ** @file fsl_mag3110_i2c_3D_mag.h
3 ** @brief The \b fsl_mag3110_i2c_3D_mag.h file contains the definitions and functions supporting the MAG3110 Sensor Adapter header file
4 * @copyright Copyright (c) 2015, Freescale Semiconductor, Inc.
5 ** @version 01.00
6 ** @brief
7 **
8 */
9 /*!
10 ** @addtogroup fsl_mag3110_i2c_3D_mag_module fsl_mag3110_i2c_3D_mag module documentation
11 ** @{
12 */
13
14 #ifndef FSL_MAG3110_I2C_3D_MAG_H_
15 #define FSL_MAG3110_I2C_3D_MAG_H_
16
17 /* Include shared modules, which are used for whole project */
18 #include "isf.h"
19 #include "isf_sm_types.h"
20 #include "isf_dsa_adapter.h"
21
22 /*! @brief This structure defines the dummy DSA data buffer format.*/
23 typedef struct {
24 uint32 timeStamp; /*!< The time stamp for the data packet.*/
25 int16 mag[3]; /*!< The magnetometer data */
26 uint8 addr; /*!< The device "address" can uniquely identify the sensor */
27 } mag3110_DataBuffer_t;
28
29 /*! @brief Supported sensor and data types for MMA8652 */
30 extern isf_SensorTypes_t mag3110_SupportedSensorTypes[];
31 extern isf_SensorDataTypes_t mag3110_SupportedDataTypes[];
32
33 /*
34 ** ===================================================================
35 ** Method : fsl_mag3110_i2c_3D_mag_Initialize (component ISFDSA)
36 ** @brief
37 **
38 ** Parameters :
39 ** NAME - DESCRIPTION
40 ** @param
41 ** void* pSensorHandle -
42 ** @return
43 ** int32_t -
44 ** ===================================================================
45 */
46 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Initialize( isf_SensorHandle_t *pSensorHandle);
47
48 /*
49 ** ===================================================================
50 ** Method : fsl_mag3110_i2c_3D_mag_ValidateSettings (component ISFDSA)
51 ** @brief
52 **
53 ** Parameters :
54 ** NAME - DESCRIPTION
55 ** @param
56 ** void* pSensorHandle -
57 ** @param
58 ** void* pSettings -
59 ** @return
60 ** int32_t -
61 ** ===================================================================
62 */
63 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_ValidateSettings(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSubSettings);
64
65 /*
66 ** ===================================================================
67 ** Method : fsl_mag3110_i2c_3D_mag_Configure (component ISFDSA)
68 ** @brief
69 **
70 ** Parameters :
71 ** NAME - DESCRIPTION
72 ** @param
73 ** void* pSensorHandle -
74 ** @param
75 ** void* pConfigSettings -
76 ** @return
77 ** int32_t -
78 ** ===================================================================
79 */
80 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Configure(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings);
81
82 /*
83 ** ===================================================================
84 ** Method : fsl_mag3110_i2c_3D_mag_StartData (component ISFDSA)
85 ** @brief
86 **
87 ** Parameters :
88 ** NAME - DESCRIPTION
89 ** @param
90 ** void* pSensorHandle -
91 ** @return
92 ** int32_t -
93 ** ===================================================================
94 */
95 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_StartData(isf_SensorHandle_t *pSensorHandle );
96
97 /*
98 ** ===================================================================
99 ** Method : fsl_mag3110_i2c_3D_mag_EndData (component ISFDSA)
100 ** @brief
101 **
102 ** Parameters :
103 ** NAME - DESCRIPTION
104 ** @param
105 ** void* pSensorHandle -
106 ** @return
107 ** int32_t -
108 ** ===================================================================
109 */
110 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_EndData(isf_SensorHandle_t *pSensorHandle );
111
112 /*
113 ** ===================================================================
114 ** Method : fsl_mag3110_i2c_3D_mag_Calibrate (component ISFDSA)
115 ** @brief
116 **
117 ** Parameters :
118 ** NAME - DESCRIPTION
119 ** @param
120 ** void* pSensorHandle -
121 ** @return
122 ** int32_t -
123 ** ===================================================================
124 */
125 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Calibrate(isf_SensorHandle_t *pSensorHandle, void *pCalData );
126
127 /*
128 ** ===================================================================
129 ** Method : fsl_mag3110_i2c_3D_mag_Shutdown (component ISFDSA)
130 ** @brief
131 **
132 ** Parameters :
133 ** NAME - DESCRIPTION
134 ** @param
135 ** void* pSensorHandle -
136 ** @return
137 ** int32_t -
138 ** ===================================================================
139 */
140 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Shutdown(isf_SensorHandle_t *pSensorHandle );
141
142 /*
143 ** ===================================================================
144 ** Method : fsl_mag3110_i2c_3D_mag_PeriodicCallback (component ISFDSA)
145 ** @brief
146 **
147 ** Parameters :
148 ** NAME - DESCRIPTION
149 ** @param
150 ** void* pSensorHandle -
151 ** @return
152 ** void -
153 ** ===================================================================
154 */
155 void fsl_mag3110_i2c_3D_mag_PeriodicCallback(void *pSensorHandle);
156
157 /*
158 ** ===================================================================
159 ** Method : fsl_mag3110_i2c_3D_mag_Convert (component ISFDSA)
160 ** @brief
161 **
162 ** Parameters :
163 ** NAME - DESCRIPTION
164 ** @param
165 ** void* pSensorHandle -
166 ** @return
167 ** void -
168 ** ===================================================================
169 */
170 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Convert
171 (
172 volatile isf_SensorHandle_t *pSensorHandle,
173 isf_SensorDataTypes_t convertToType, isf_dsa_result_types_t resultType,
174 void *pNativeSample,
175 void *pConvertedSample,
176 int32 *numBytes
177 );
178
179 #endif
180 /* END FSL_MAG3110_I2C_3D_MAG_H_ */
181 /*!
182 ** @}
183 */
uint8
unsigned char uint8
Definition: isf_types.h:76
mag3110_DataBuffer_t
This structure defines the dummy DSA data buffer format.
Definition: fsl_mag3110_i2c_3D_mag.h:23
fsl_mag3110_i2c_3D_mag_Calibrate
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Calibrate(isf_SensorHandle_t *pSensorHandle, void *pCalData)
Definition: fsl_mag3110_i2c_3D_mag.c:416
fsl_mag3110_i2c_3D_mag_Shutdown
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Shutdown(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mag3110_i2c_3D_mag.c:436
isf_dsa_adapter.h
fsl_mag3110_i2c_3D_mag_PeriodicCallback
void fsl_mag3110_i2c_3D_mag_PeriodicCallback(void *pSensorHandle)
Definition: fsl_mag3110_i2c_3D_mag.c:464
isf_SensorHandle_st
This defines the DSA sensor device handle structure used to invoke the adapter access functions...
Definition: isf_dsa_adapter.h:107
fsl_mag3110_i2c_3D_mag_EndData
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_EndData(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mag3110_i2c_3D_mag.c:349
isf_SensorTypes_t
isf_SensorTypes_t
Definition: isf_sensor_types.h:14
fsl_mag3110_i2c_3D_mag_Initialize
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Initialize(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mag3110_i2c_3D_mag.c:62
fsl_mag3110_i2c_3D_mag_ValidateSettings
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_ValidateSettings(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSubSettings)
Definition: fsl_mag3110_i2c_3D_mag.c:156
fsl_mag3110_i2c_3D_mag_Configure
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Configure(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
Definition: fsl_mag3110_i2c_3D_mag.c:189
mag3110_SupportedDataTypes
isf_SensorDataTypes_t mag3110_SupportedDataTypes[]
Definition: fsl_mag3110_i2c_3D_mag.c:47
isf_dsa_status_t
int32 isf_dsa_status_t
This is the Sensor Manager API return type definition.
Definition: isf_dsa_adapter.h:21
mag3110_SupportedSensorTypes
isf_SensorTypes_t mag3110_SupportedSensorTypes[]
Supported sensor and data types for MMA8652.
Definition: fsl_mag3110_i2c_3D_mag.c:46
int16
signed short int int16
Definition: isf_types.h:73
mag3110_DataBuffer_t::timeStamp
uint32 timeStamp
Definition: fsl_mag3110_i2c_3D_mag.h:24
isf_dsa_result_types_t
enum isf_dsa_result_enums isf_dsa_result_types_t
mag3110_DataBuffer_t::addr
uint8 addr
Definition: fsl_mag3110_i2c_3D_mag.h:26
isf_SensorDataTypes_t
isf_SensorDataTypes_t
Definition: isf_sensor_types.h:61
isf.h
Main ISF header file. Contains code common to all ISF components.
int32
signed long int int32
Definition: isf_types.h:74
fsl_mag3110_i2c_3D_mag_StartData
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_StartData(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mag3110_i2c_3D_mag.c:286
isf_dsa_SensorSettings_st
This defines the DSA sensor configuration parameter structure configuring the sensor settings by a su...
Definition: isf_dsa_adapter.h:79
uint32
unsigned long int uint32
Definition: isf_types.h:78
fsl_mag3110_i2c_3D_mag_Convert
isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Convert(volatile isf_SensorHandle_t *pSensorHandle, isf_SensorDataTypes_t convertToType, isf_dsa_result_types_t resultType, void *pNativeSample, void *pConvertedSample, int32 *numBytes)
This function coverts the raw sample data to the desired output type.
Definition: fsl_mag3110_i2c_3D_mag.c:574
isf_sm_types.h
The isf_sm_types.h contains the collection of type definitions used in the Sensor Manager Interface a...
- © Freescale Semiconductor, Inc. 2016. All Rights Reserved.