| ISF 2.1 Intelligent Sensing Framework for Kinetis with Processor Expert

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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) 2014, 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 "PE_Types.h"
19 #include "PE_Error.h"
20 #include "PE_Const.h"
21 #include "IO_Map.h"
22 /* Include inherited components */
23
24 #include "Cpu.h"
25
26 #include "isf_sm_types.h"
27 #include "isf_dsa_adapter.h"
28
29 /*! @brief This structure defines the dummy DSA data buffer format.*/
30 typedef struct {
31 uint32 timeStamp; /*!< The time stamp for the data packet.*/
32 int16 mag[3]; /*!< The magnetometer data */
33 uint8 addr; /*!< The device "address" can uniquely identify the sensor */
34 } mag3110_DataBuffer_t;
35
36 /*! @brief Supported sensor and data types for MMA8652 */
37 extern isf_SensorTypes_t mag3110_SupportedSensorTypes[];
38 extern isf_SensorDataTypes_t mag3110_SupportedDataTypes[];
39
40 /*
41 ** ===================================================================
42 ** Method : fsl_mag3110_i2c_3D_mag_Initialize (component ISFDSA)
43 ** @brief
44 **
45 ** Parameters :
46 ** NAME - DESCRIPTION
47 ** @param
48 ** void* pSensorHandle -
49 ** @return
50 ** int32_t -
51 ** ===================================================================
52 */
53 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Initialize( isf_SensorHandle_t *pSensorHandle);
54
55 /*
56 ** ===================================================================
57 ** Method : fsl_mag3110_i2c_3D_mag_ValidateSettings (component ISFDSA)
58 ** @brief
59 **
60 ** Parameters :
61 ** NAME - DESCRIPTION
62 ** @param
63 ** void* pSensorHandle -
64 ** @param
65 ** void* pSettings -
66 ** @return
67 ** int32_t -
68 ** ===================================================================
69 */
70 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_ValidateSettings(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSubSettings);
71
72 /*
73 ** ===================================================================
74 ** Method : fsl_mag3110_i2c_3D_mag_Configure (component ISFDSA)
75 ** @brief
76 **
77 ** Parameters :
78 ** NAME - DESCRIPTION
79 ** @param
80 ** void* pSensorHandle -
81 ** @param
82 ** void* pConfigSettings -
83 ** @return
84 ** int32_t -
85 ** ===================================================================
86 */
87 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Configure(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings);
88
89 /*
90 ** ===================================================================
91 ** Method : fsl_mag3110_i2c_3D_mag_StartData (component ISFDSA)
92 ** @brief
93 **
94 ** Parameters :
95 ** NAME - DESCRIPTION
96 ** @param
97 ** void* pSensorHandle -
98 ** @return
99 ** int32_t -
100 ** ===================================================================
101 */
102 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_StartData(isf_SensorHandle_t *pSensorHandle );
103
104 /*
105 ** ===================================================================
106 ** Method : fsl_mag3110_i2c_3D_mag_EndData (component ISFDSA)
107 ** @brief
108 **
109 ** Parameters :
110 ** NAME - DESCRIPTION
111 ** @param
112 ** void* pSensorHandle -
113 ** @return
114 ** int32_t -
115 ** ===================================================================
116 */
117 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_EndData(isf_SensorHandle_t *pSensorHandle );
118
119 /*
120 ** ===================================================================
121 ** Method : fsl_mag3110_i2c_3D_mag_Calibrate (component ISFDSA)
122 ** @brief
123 **
124 ** Parameters :
125 ** NAME - DESCRIPTION
126 ** @param
127 ** void* pSensorHandle -
128 ** @return
129 ** int32_t -
130 ** ===================================================================
131 */
132 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Calibrate(isf_SensorHandle_t *pSensorHandle, void *pCalData );
133
134 /*
135 ** ===================================================================
136 ** Method : fsl_mag3110_i2c_3D_mag_Shutdown (component ISFDSA)
137 ** @brief
138 **
139 ** Parameters :
140 ** NAME - DESCRIPTION
141 ** @param
142 ** void* pSensorHandle -
143 ** @return
144 ** int32_t -
145 ** ===================================================================
146 */
147 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Shutdown(isf_SensorHandle_t *pSensorHandle );
148
149 /*
150 ** ===================================================================
151 ** Method : fsl_mag3110_i2c_3D_mag_PeriodicCallback (component ISFDSA)
152 ** @brief
153 **
154 ** Parameters :
155 ** NAME - DESCRIPTION
156 ** @param
157 ** void* pSensorHandle -
158 ** @return
159 ** void -
160 ** ===================================================================
161 */
162 void fsl_mag3110_i2c_3D_mag_PeriodicCallback(void *pSensorHandle);
163
164 /*
165 ** ===================================================================
166 ** Method : fsl_mag3110_i2c_3D_mag_Convert (component ISFDSA)
167 ** @brief
168 **
169 ** Parameters :
170 ** NAME - DESCRIPTION
171 ** @param
172 ** void* pSensorHandle -
173 ** @return
174 ** void -
175 ** ===================================================================
176 */
177 isf_dsa_status_t fsl_mag3110_i2c_3D_mag_Convert
178 (
179 volatile isf_SensorHandle_t *pSensorHandle,
180 isf_SensorDataTypes_t convertToType, isf_dsa_result_types_t resultType,
181 void *pNativeSample,
182 void *pConvertedSample,
183 int32 *numBytes
184 );
185
186 #endif
187 /* END FSL_MAG3110_I2C_3D_MAG_H_ */
188 /*!
189 ** @}
190 */
uint8
unsigned char uint8
This defines uint8 as unsigned char.
Definition: isf_types.h:18
mag3110_DataBuffer_t
This structure defines the dummy DSA data buffer format.
Definition: fsl_mag3110_i2c_3D_mag.h:30
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:408
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:428
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:456
isf_SensorHandle_st
This defines the DSA sensor device handle structure used to invoke the adapter access functions...
Definition: isf_dsa_adapter.h:109
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:344
uint32
unsigned long uint32
This defines uint32 as unsigned long.
Definition: isf_types.h:36
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:64
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:155
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:188
mag3110_SupportedDataTypes
isf_SensorDataTypes_t mag3110_SupportedDataTypes[]
Definition: fsl_mag3110_i2c_3D_mag.c:49
isf_dsa_status_t
int32 isf_dsa_status_t
This is the Sensor Manager API return type definition.
Definition: isf_dsa_adapter.h:23
mag3110_SupportedSensorTypes
isf_SensorTypes_t mag3110_SupportedSensorTypes[]
Supported sensor and data types for MMA8652.
Definition: fsl_mag3110_i2c_3D_mag.c:48
mag3110_DataBuffer_t::timeStamp
uint32 timeStamp
Definition: fsl_mag3110_i2c_3D_mag.h:31
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:33
isf_SensorDataTypes_t
isf_SensorDataTypes_t
Definition: isf_sensor_types.h:61
int32
long int32
This defines int32 as long.
Definition: isf_types.h:32
int16
short int16
This defines int16 as short.
Definition: isf_types.h:23
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:283
isf_dsa_SensorSettings_st
This defines the DSA sensor configuration parameter structure configuring the sensor settings by a su...
Definition: isf_dsa_adapter.h:81
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:563
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. 2015. All Rights Reserved.