| 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_mpl3115_i2c_1D_press.h
Go to the documentation of this file.
1 /**
2 * @file fsl_mpl3115_i2c_1D_press.h
3 * @brief The \b fsl_mpl3115_i2c_1D_press.h file contains the definitions and functions supporting the MMA8652 Sensor adapter header file
4 * @copyright Copyright (c) 2014, Freescale Semiconductor, Inc.
5 * @version 01.00
6 * @brief
7 *
8 */
9 /*!
10 ** @addtogroup fsl_mpl3115_i2c_1D_press_module fsl_mpl3115_i2c_1D_press module documentation
11 ** @{
12 */
13
14 #ifndef FSL_MPL3115_I2C_1D_PRESS_H_
15 #define FSL_MPL3115_I2C_1D_PRESS_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 "Cpu.h"
23 #include "isf_sm_types.h"
24 #include "isf_dsa_adapter.h"
25
26 /*! @brief This enumerator describes the available sample rates for the MPL3115 accelerometer */
27 enum {
28 FSL_MPL3115_ACCEL_800HZ = 1250, //!< 800 Hz
29 FSL_MPL3115_ACCEL_400HZ = 2500, //!< 400 Hz
30 FSL_MPL3115_ACCEL_200HZ = 5000, //!< 200 Hz
31 FSL_MPL3115_ACCEL_100HZ = 10000, //!< 100 Hz
32 FSL_MPL3115_ACCEL_50HZ = 20000, //!< 50 Hz
33 FSL_MPL3115_ACCEL_12p5HZ = 80000, //!< 12.5 Hz
34 FSL_MPL3115_ACCEL_6p25HZ = 160000, //!< 6.25 Hz
35 FSL_MPL3115_ACCEL_1p56HZ = 640000 //!< 1.56 Hz
36 };
37
38 /*! @brief This enumerator describes the available acceleration ranges for the MM865X family of accelerometers. */
39 enum {
40 FSL_MPL3115_ACCEL_SCALE_2G = 0, //!< select +/-2G range
41 FSL_MPL3115_ACCEL_SCALE_4G = 1, //!< select +/-4G range
42 FSL_MPL3115_ACCEL_SCALE_8G = 2 //!< select +/-8G range
43 };
44
45 /*! @brief This structure defines important settings.*/
46 typedef struct
47 {
48 uint8 sampleRateIndex; //!< Holds the ODR index into the rate array fsl_mpl3115_period */
49 } mpl3115_Specific_Settings_t;
50
51 /*! @brief This structure defines the dummy DSA data buffer format.*/
52 typedef struct
53 {
54 uint32 timestamp;
55 //!< Time stamp value in micro-seconds.
56 uint32 pressure;
57 //!< Sensor pressure output: unsigned 20-bits justified to MSBs;
58 //!< MS 18-bits are integer Pascals; LS 2-bits are fractional Pascals.
59 int32 altitude;
60 //!< Sensor altitude output: 2's complement 20-bits justified to MSBs;
61 //!< MS 16-bits are integer meters; LS 4-bits are fractional meters.
62 int16 temperature;
63 //!< Sensor temperature output; 2's complement 12-bits justified to MSBs;
64 //!< MS 8-bits are integer degrees Celsius; LS 4-bits are fractional degrees Celsius.
65 } mpl3115_DataBuffer_t;
66
67 /*! @brief Supported sensor and data types for MPL3115 */
68 extern isf_SensorTypes_t mpl3115_SupportedSensorTypes[];
69 extern isf_SensorDataTypes_t mpl3115_SupportedDataTypes[];
70
71
72 /*
73 ** ===================================================================
74 ** Method : fsl_mpl3115_i2c_1D_press_Initialize
75 ** @brief
76 **
77 ** Parameters :
78 ** NAME - DESCRIPTION
79 ** @param
80 ** isf_SensorHandle_t *pSensorHandle
81 ** @return
82 ** isf_dsa_status_t -
83 ** ===================================================================
84 */
85 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Initialize(isf_SensorHandle_t *pSensorHandle);
86
87 /*
88 ** ===================================================================
89 ** Method : fsl_mpl3115_i2c_1D_press_ValidateSettings
90 ** @brief
91 **
92 ** Parameters :
93 ** NAME - DESCRIPTION
94 ** @param
95 ** isf_SensorHandle_t *pSensorHandle
96 ** @param
97 ** isf_SubscriptionSettings_t *pSettings
98 ** @return
99 ** isf_dsa_status_t -
100 ** ===================================================================
101 */
102 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_ValidateSettings(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings);
103
104 /*
105 ** ===================================================================
106 ** Method : fsl_mpl3115_i2c_1D_press_Configure
107 ** @brief
108 **
109 ** Parameters :
110 ** NAME - DESCRIPTION
111 ** @param
112 ** isf_SensorHandle_t *pSensorHandle
113 ** @param
114 ** isf_SubscriptionSettings_t *pConfigSettings
115 ** @return
116 ** isf_dsa_status_t -
117 ** ===================================================================
118 */
119 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Configure(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings);
120
121 /*
122 ** ===================================================================
123 ** Method : fsl_mpl3115_i2c_1D_press_StartData
124 ** @brief
125 **
126 ** Parameters :
127 ** NAME - DESCRIPTION
128 ** @param
129 ** isf_SensorHandle_t *pSensorHandle
130 ** @return
131 ** isf_dsa_status_t -
132 ** ===================================================================
133 */
134 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_StartData(isf_SensorHandle_t *pSensorHandle);
135
136 /*
137 ** ===================================================================
138 ** Method : fsl_mpl3115_i2c_1D_press_EndData
139 ** @brief
140 **
141 ** Parameters :
142 ** NAME - DESCRIPTION
143 ** @param
144 ** isf_SensorHandle_t *pSensorHandle
145 ** @return
146 ** isf_dsa_status_t -
147 ** ===================================================================
148 */
149 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_EndData(isf_SensorHandle_t *pSensorHandle);
150
151 /*
152 ** ===================================================================
153 ** Method : fsl_mpl3115_i2c_1D_press_Calibrate
154 ** @brief
155 **
156 ** Parameters :
157 ** NAME - DESCRIPTION
158 ** @param
159 ** isf_SensorHandle_t *pSensorHandle
160 ** @return
161 ** isf_dsa_status_t -
162 ** ===================================================================
163 */
164 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Calibrate(isf_SensorHandle_t *pSensorHandle, void *pCalData );
165
166 /*
167 ** ===================================================================
168 ** Method : fsl_mpl3115_i2c_1D_press_Shutdown
169 ** @brief
170 **
171 ** Parameters :
172 ** NAME - DESCRIPTION
173 ** @param
174 ** isf_SensorHandle_t *pSensorHandle
175 ** @return
176 ** isf_dsa_status_t -
177 ** ===================================================================
178 */
179 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Shutdown(isf_SensorHandle_t *pSensorHandle );
180
181 /*
182 ** ===================================================================
183 ** Method : fsl_mpl3115_i2c_1D_press_Convert
184 ** @brief The DSA interface conversion function to convert native samples to specified standard types
185 **
186 ** Parameters :
187 ** NAME - DESCRIPTION
188 ** @param
189 ** isf_SensorHandle_t *pSensorHandle
190 ** @return
191 ** void -
192 ** ===================================================================
193 */
194 isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Convert(volatile isf_SensorHandle_t *pSensorHandle, isf_SensorDataTypes_t convertToType, isf_dsa_result_types_t resultType, void *nativeSample, void *convertedSample, int32 *numBytes );
195 /*
196 ** ===================================================================
197 ** Method : fsl_mpl3115_i2c_1D_press_PeriodicCallback (component ISFDSA)
198 ** @brief
199 **
200 ** Parameters :
201 ** NAME - DESCRIPTION
202 ** @param
203 ** isf_SensorHandle_t *pSensorHandle
204 ** @return
205 ** void -
206 ** ===================================================================
207 */
208 void fsl_mpl3115_i2c_1D_press_PeriodicCallback(void* pSensorHandle);
209
210 #endif
211 /* END FSL_MPL3115_I2C_1D_PRESS_H_ */
212 /*!
213 ** @}
214 */
215
FSL_MPL3115_ACCEL_SCALE_8G
select +/-8G range
Definition: fsl_mpl3115_i2c_1D_press.h:42
uint8
unsigned char uint8
This defines uint8 as unsigned char.
Definition: isf_types.h:18
FSL_MPL3115_ACCEL_SCALE_2G
select +/-2G range
Definition: fsl_mpl3115_i2c_1D_press.h:40
FSL_MPL3115_ACCEL_1p56HZ
1.56 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:35
FSL_MPL3115_ACCEL_6p25HZ
6.25 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:34
isf_dsa_adapter.h
FSL_MPL3115_ACCEL_12p5HZ
12.5 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:33
FSL_MPL3115_ACCEL_200HZ
200 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:30
fsl_mpl3115_i2c_1D_press_Shutdown
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Shutdown(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mpl3115_i2c_1D_press.c:545
fsl_mpl3115_i2c_1D_press_Convert
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_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_mpl3115_i2c_1D_press.c:668
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_MPL3115_ACCEL_SCALE_4G
select +/-4G range
Definition: fsl_mpl3115_i2c_1D_press.h:41
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_MPL3115_ACCEL_50HZ
50 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:32
mpl3115_SupportedDataTypes
isf_SensorDataTypes_t mpl3115_SupportedDataTypes[]
Definition: fsl_mpl3115_i2c_1D_press.c:157
fsl_mpl3115_i2c_1D_press_Configure
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Configure(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
Definition: fsl_mpl3115_i2c_1D_press.c:312
fsl_mpl3115_i2c_1D_press_Calibrate
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Calibrate(isf_SensorHandle_t *pSensorHandle, void *pCalData)
Definition: fsl_mpl3115_i2c_1D_press.c:525
isf_dsa_status_t
int32 isf_dsa_status_t
This is the Sensor Manager API return type definition.
Definition: isf_dsa_adapter.h:23
mpl3115_Specific_Settings_t
This structure defines important settings.
Definition: fsl_mpl3115_i2c_1D_press.h:46
mpl3115_DataBuffer_t
This structure defines the dummy DSA data buffer format.
Definition: fsl_mpl3115_i2c_1D_press.h:52
fsl_mpl3115_i2c_1D_press_ValidateSettings
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_ValidateSettings(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
Definition: fsl_mpl3115_i2c_1D_press.c:283
FSL_MPL3115_ACCEL_400HZ
400 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:29
mpl3115_DataBuffer_t::altitude
int32 altitude
Definition: fsl_mpl3115_i2c_1D_press.h:59
isf_dsa_result_types_t
enum isf_dsa_result_enums isf_dsa_result_types_t
isf_SensorDataTypes_t
isf_SensorDataTypes_t
Definition: isf_sensor_types.h:61
fsl_mpl3115_i2c_1D_press_PeriodicCallback
void fsl_mpl3115_i2c_1D_press_PeriodicCallback(void *pSensorHandle)
Definition: fsl_mpl3115_i2c_1D_press.c:574
FSL_MPL3115_ACCEL_100HZ
100 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:31
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_mpl3115_i2c_1D_press_StartData
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_StartData(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mpl3115_i2c_1D_press.c:401
mpl3115_DataBuffer_t::temperature
int16 temperature
Definition: fsl_mpl3115_i2c_1D_press.h:62
mpl3115_Specific_Settings_t::sampleRateIndex
uint8 sampleRateIndex
Holds the ODR index into the rate array fsl_mpl3115_period */.
Definition: fsl_mpl3115_i2c_1D_press.h:48
mpl3115_SupportedSensorTypes
isf_SensorTypes_t mpl3115_SupportedSensorTypes[]
Supported sensor and data types for MPL3115.
Definition: fsl_mpl3115_i2c_1D_press.c:156
mpl3115_DataBuffer_t::pressure
uint32 pressure
Definition: fsl_mpl3115_i2c_1D_press.h:56
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_MPL3115_ACCEL_800HZ
800 Hz
Definition: fsl_mpl3115_i2c_1D_press.h:28
isf_sm_types.h
The isf_sm_types.h contains the collection of type definitions used in the Sensor Manager Interface a...
fsl_mpl3115_i2c_1D_press_Initialize
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_Initialize(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mpl3115_i2c_1D_press.c:191
fsl_mpl3115_i2c_1D_press_EndData
isf_dsa_status_t fsl_mpl3115_i2c_1D_press_EndData(isf_SensorHandle_t *pSensorHandle)
Definition: fsl_mpl3115_i2c_1D_press.c:461
mpl3115_DataBuffer_t::timestamp
uint32 timestamp
Time stamp value in micro-seconds.
Definition: fsl_mpl3115_i2c_1D_press.h:54
- © Freescale Semiconductor, Inc. 2015. All Rights Reserved.