ISF  2.2 rev 5
Intelligent Sensing Framework for Kinetis with Processor Expert
fsl_Sensor_Custom_1_Functions.h
Go to the documentation of this file.
1 /* ###################################################################
2 ** Filename : fsl_Sensor_Custom_1_Functions.h
3 ** Project : ISF2P2_K64F_MQX_PROJ
4 ** Processor : MK64FN1M0VLL12
5 ** Component : Events
6 ** Version : Driver 01.00
7 ** Compiler : GNU C Compiler
8 ** Date/Time : 2016-10-06, 13:38, # CodeGen: 0
9 ** Abstract :
10 ** This is user's event module.
11 ** Put your event handler code here.
12 ** Settings :
13 ** Contents :
14 ** Custom_1__Void_ - void Custom_1__Void_(void);
15 ** Custom_1_fsl_Sensor_Custom_Convert - void Custom_1_fsl_Sensor_Custom_Convert(void);
16 ** Custom_1_fsl_Sensor_Custom_PeriodicCallback - void Custom_1_fsl_Sensor_Custom_PeriodicCallback(void);
17 ** Custom_1_fsl_Sensor_Custom_Shutdown - void Custom_1_fsl_Sensor_Custom_Shutdown(void);
18 ** Custom_1_fsl_Sensor_Custom_EndData - void Custom_1_fsl_Sensor_Custom_EndData(void);
19 ** Custom_1_fsl_Sensor_Custom_StartData - void Custom_1_fsl_Sensor_Custom_StartData(void);
20 ** Custom_1_fsl_Sensor_Custom_Configure - void Custom_1_fsl_Sensor_Custom_Configure(void);
21 ** Custom_1_fsl_Sensor_Custom_ValidateSettings - void Custom_1_fsl_Sensor_Custom_ValidateSettings(void);
22 ** Custom_1_fsl_Sensor_Custom_Initialize - void Custom_1_fsl_Sensor_Custom_Initialize(void);
23 **
24 ** ###################################################################*/
25 /*!
26 ** @file fsl_Sensor_Custom_1_Functions.h
27 ** @version 01.00
28 ** @brief
29 ** This is user's event module.
30 ** Put your event handler code here.
31 */
32 /*!
33 ** @addtogroup fsl_Sensor_Custom_1_Functions_module fsl_Sensor_Custom_1_Functions module documentation
34 ** @{
35 */
36 
37 #ifndef __fsl_Sensor_Custom_1_Functions_H
38 #define __fsl_Sensor_Custom_1_Functions_H
39 /* MODULE fsl_Sensor_Custom_1_Functions */
40 
41 #include "fsl_device_registers.h"
42 #include "clockMan1.h"
43 #include "pin_init.h"
44 #include "osa1.h"
45 #include "mqx_ksdk.h"
46 #include "uart1.h"
47 #include "fsl_mpu1.h"
48 #include "fsl_hwtimer1.h"
49 #include "MainTask.h"
50 #include "I2C1.h"
51 #include "ISF_I2C1.h"
52 #include "UART2.h"
53 #include "ISF_UART1.h"
54 #include "SPI1.h"
55 #include "ISF_SPI1.h"
56 #include "ISFCore1.h"
57 #include "ISFBusManager1.h"
58 #include "BMTIMER1.h"
59 #include "EventHandler_Task1.h"
60 #include "CommChannelConfig1.h"
61 #include "Protocol1.h"
62 #include "App1.h"
63 #include "BasicApp1.h"
64 #include "RLI1.h"
65 #include "RLIChipSelect.h"
66 #include "Custom_1.h"
67 #include "FXAS21002_1.h"
68 #include "FXAS21002_2.h"
69 #include "ChipSelect.h"
70 #include "FXLC95000_1.h"
71 #include "FXLC95000_2.h"
72 #include "SPIChipSelect.h"
73 #include "SPISelect.h"
74 #include "ResetSensor.h"
75 #include "FXLS8471_1.h"
76 #include "FXLS8952_1.h"
77 #include "FXLS8471_2.h"
78 #include "FXOS8700_1.h"
79 #include "FXOS8700_2.h"
80 #include "Analog_1.h"
81 #include "ADC1.h"
82 #include "MAG3110_1.h"
83 #include "MMA8491Q_1.h"
84 #include "SensorEnable.h"
85 #include "OutX.h"
86 #include "OutY.h"
87 #include "OutZ.h"
88 #include "MMA865x_1.h"
89 #include "MMA955x_1.h"
90 #include "MMA955x_2.h"
91 #include "MPL3115_1.h"
92 #include "ORIENT_1.h"
93 #include "SensorReset.h"
94 
95 #ifdef __cplusplus
96 extern "C" {
97 #endif
98 
99 void Custom_1__Void_();
100 #include "isf_devmsg.h"
101 #include "isf_sensors.h"
102 #include "isf_dsa_adapter.h"
103 #include "isf_sensor_types.h"
104 
105 /* Begin: Shared types with Embedded Application Modules.
106  * The following types are wrapped in #preprocessor conditions to prevent multiple declaration error. */
107 #endif
108 #ifndef __fsl_Sensor_Custom_1_Functions_H_
109 #define __fsl_Sensor_Custom_1_Functions_H_
110 
111 /**
112  * @brief SENSOR internal return codes.
113  */
115 typedef uint32_t isf_Custom_1_fixed_data_t;
117 
118 /*! @brief This structure defines the dummy DSA data buffer format.*/
119 typedef struct
120 {
121  uint32 timeStamp; /*!< The time stamp for the data packet.*/
122  int16 data[3]; /*!< The Sensor data */
125 
126 typedef struct {
128  isf_Custom_1_fixed_data_t sensorData[3];
130 
131 /** @brief Standard fixed type for three axis accelerometers */
132 typedef struct {
134  isf_Custom_1_float_data_t sensorData[3];
136 
137 #define Custom_1_DATA_TYPE Custom_1_DataBuffer_t
138 
139 /* END: Shared types with Embedded Application Modules. */
140 #endif
141 #ifndef __fsl_Sensor_Custom_1_Functions_H__
142 #define __fsl_Sensor_Custom_1_Functions_H__
143 
144 typedef struct
145 {
149 
150 typedef struct
151 {
152  /* Filled as per MMA865x Sensor Specific flags and registers */
157 
158 /*! @brief This structure defines important settings.*/
159 typedef struct
160 {
161  uint8 sampleRateIndex; //!< Holds the ODR index into the rate array fsl_mma865x_period */
163 
164 /* @brief The Sensor Internal Register Map.
165  * Updated for MMA865x Sensor register map.
166  */
167 enum
168 {
173 };
174 
175 enum
176 {
180 };
181 
182 extern const uint8_t Custom_1_Who_Am_I_Values[];
183 
184 /*
185  * General purpose macros to set/get a specific bit field within a register.
186  * The macro assumes that the root identifier for the field is a consistent character string (e.g., "BIT_FIELD").
187  * The bit field mask is the character string followed by "_MASK" (e.g., BIT_FIELD_MASK).
188  * The bit field shift is the character string followed by "_SHIFT" (e.g., BIT_FIELD_SHIFT).
189  */
190 #define Custom_1_SET_FIELD(name,val) (((val)<<Custom_1_##name##_SHIFT)&(Custom_1_##name##_MASK))
191 #define Custom_1_GET_FIELD(name,val) ((val&Custom_1_##name##_MASK)>>Custom_1_##name##_SHIFT)
192 
193 #define Custom_1_FREAD_MASK 0x02
194 #define Custom_1_FREAD_SHIFT 1
195 #define Custom_1_ASLP_RATE_MASK 0xC0
196 #define Custom_1_ASLP_RATE_SHIFT 6
197 #define Custom_1_DR_MASK 0x38
198 #define Custom_1_DR_SHIFT 3
199 #define Custom_1_ST_MASK 0x80
200 #define Custom_1_ST_SHIFT 7
201 #define Custom_1_RST_MASK 0x40
202 #define Custom_1_RST_SHIFT 6
203 #define Custom_1_SLPE_MASK 0x04
204 #define Custom_1_SLPE_SHIFT 2
205 #define Custom_1_SMODS_MASK 0x18
206 #define Custom_1_SMODS_SHIFT 3
207 #define Custom_1_MODS_MASK 0x03
208 #define Custom_1_MODS_SHIFT 0
209 #define Custom_1_ZYXDR_MASK 0x08
210 #define Custom_1_ZYXDR_SHIFT 3
211 #define Custom_1_ACTIVE_MASK 0x01
212 
213 /* Converter routines for the supported data types.
214  */
215 isf_dsa_status_t Custom_1_float_Custom_converter(Custom_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Custom_1_DataBuffer_t *nativeSample, void *vpConvertedSample);
216 isf_dsa_status_t Custom_1_fixed_Custom_converter(Custom_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Custom_1_DataBuffer_t *nativeSample, void *vpConvertedSample);
217 
218 /* Internal warper functions for use by ISF Core.
219  */
220 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);
227 
228 
229 /*
230 ** ===================================================================
231 ** Event : Custom_1_fsl_Sensor_Custom_Convert (module fsl_Sensor_Custom_1_Functions)
232 **
233 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
234 ** @brief
235 ** Parameters :
236 ** NAME - DESCRIPTION
237 ** @param
238 ** @param
239 ** @param
240 ** @param
241 ** @param
242 ** @param
243 ** @param
244 ** @return
245 ** Returns : Nothing
246 ** ===================================================================
247 */
248 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);
249 
250 /*
251 ** ===================================================================
252 ** Event : Custom_1_fsl_Sensor_Custom_PeriodicCallback (module fsl_Sensor_Custom_1_Functions)
253 **
254 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
255 ** @brief
256 ** Parameters :
257 ** NAME - DESCRIPTION
258 ** @param
259 ** @return
260 ** Returns : Nothing
261 ** ===================================================================
262 */
263 void Custom_1_fsl_Sensor_Custom_PeriodicCallback(void* pSensorHandle);
264 
265 /*
266 ** ===================================================================
267 ** Event : Custom_1_fsl_Sensor_Custom_Shutdown (module fsl_Sensor_Custom_1_Functions)
268 **
269 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
270 ** @brief
271 ** Parameters :
272 ** NAME - DESCRIPTION
273 ** @param
274 ** @param
275 ** @return
276 ** Returns : Nothing
277 ** ===================================================================
278 */
279 void Custom_1_fsl_Sensor_Custom_Shutdown(void* pSensorHandle, uint8_t *retVal);
280 
281 /*
282 ** ===================================================================
283 ** Event : Custom_1_fsl_Sensor_Custom_EndData (module fsl_Sensor_Custom_1_Functions)
284 **
285 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
286 ** @brief
287 ** Parameters :
288 ** NAME - DESCRIPTION
289 ** @param
290 ** @param
291 ** @return
292 ** Returns : Nothing
293 ** ===================================================================
294 */
295 void Custom_1_fsl_Sensor_Custom_EndData(void* pSensorHandle, uint8_t *retVal);
296 
297 /*
298 ** ===================================================================
299 ** Event : Custom_1_fsl_Sensor_Custom_StartData (module fsl_Sensor_Custom_1_Functions)
300 **
301 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
302 ** @brief
303 ** Parameters :
304 ** NAME - DESCRIPTION
305 ** @param
306 ** @param
307 ** @return
308 ** Returns : Nothing
309 ** ===================================================================
310 */
311 void Custom_1_fsl_Sensor_Custom_StartData(void* pSensorHandle, uint8_t *retVal);
312 
313 /*
314 ** ===================================================================
315 ** Event : Custom_1_fsl_Sensor_Custom_Configure (module fsl_Sensor_Custom_1_Functions)
316 **
317 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
318 ** @brief
319 ** Parameters :
320 ** NAME - DESCRIPTION
321 ** @param
322 ** @param
323 ** @param
324 ** @return
325 ** Returns : Nothing
326 ** ===================================================================
327 */
328 void Custom_1_fsl_Sensor_Custom_Configure(void* pSensorHandle, void* pSensorSettings, uint8_t *retVal);
329 
330 /*
331 ** ===================================================================
332 ** Event : Custom_1_fsl_Sensor_Custom_ValidateSettings (module fsl_Sensor_Custom_1_Functions)
333 **
334 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
335 ** @brief
336 ** Parameters :
337 ** NAME - DESCRIPTION
338 ** @param
339 ** @param
340 ** @param
341 ** @return
342 ** Returns : Nothing
343 ** ===================================================================
344 */
345 void Custom_1_fsl_Sensor_Custom_ValidateSettings(void* pSensorHandle, void* pSensorSettings, uint8_t *retVal);
346 
347 /*
348 ** ===================================================================
349 ** Event : Custom_1_fsl_Sensor_Custom_Initialize (module fsl_Sensor_Custom_1_Functions)
350 **
351 ** Component : Custom_1 [ISF_KSDK_Sensor_Custom_Adaptor]
352 ** @brief
353 ** Parameters :
354 ** NAME - DESCRIPTION
355 ** @param
356 ** @param
357 ** @return
358 ** Returns : Nothing
359 ** ===================================================================
360 */
361 void Custom_1_fsl_Sensor_Custom_Initialize(void* pSensorHandle, uint8_t *retVal);
362 
363 
364 /* END fsl_Sensor_Custom_1_Functions */
365 
366 #ifdef __cplusplus
367 } /* extern "C" */
368 #endif
369 
370 #endif
371 /* ifndef __fsl_Sensor_Custom_1_Functions_H*/
372 /*!
373 ** @}
374 */
375 /*
376 ** ###################################################################
377 **
378 ** This file was created by Processor Expert 10.5 [05.21]
379 ** for the Freescale Kinetis series of microcontrollers.
380 **
381 ** ###################################################################
382 */
unsigned char uint8
Definition: isf_types.h:76
isf_dsa_status_t Custom_1_float_Custom_converter(Custom_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Custom_1_DataBuffer_t *nativeSample, void *vpConvertedSample)
OS_Task component.
isf_dsa_status_t fsl_Sensor_Custom_1_Initialize(isf_SensorHandle_t *pSensorHandle)
uint32_t isf_Custom_1_fixed_data_t
isf_dsa_status_t fsl_Sensor_Custom_1_EndData(isf_SensorHandle_t *pSensorHandle)
isf_sensors.h contains the ISF Generic Sensor definitions and data structures required when a client ...
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)
This defines the DSA sensor device handle structure used to invoke the adapter access functions...
This structure defines important settings.
void Custom_1_fsl_Sensor_Custom_EndData(void *pSensorHandle, uint8_t *retVal)
int32 Custom_1_Status_t
SENSOR internal return codes.
void Custom_1_fsl_Sensor_Custom_Shutdown(void *pSensorHandle, uint8_t *retVal)
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_Configure(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
void Custom_1_fsl_Sensor_Custom_PeriodicCallback(void *pSensorHandle)
isf_dsa_status_t Custom_1_fixed_Custom_converter(Custom_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Custom_1_DataBuffer_t *nativeSample, void *vpConvertedSample)
Standard fixed type for three axis accelerometers.
uint8 sampleRateIndex
Holds the ODR index into the rate array fsl_mma865x_period */.
int32 isf_dsa_status_t
This is the Sensor Manager API return type definition.
signed short int int16
Definition: isf_types.h:73
The isf_sensor_types.h contains the enumerated list of sensor types used by ISF.
isf_dsa_status_t fsl_Sensor_Custom_1_StartData(isf_SensorHandle_t *pSensorHandle)
enum isf_dsa_result_enums isf_dsa_result_types_t
OS_Task component.
const uint8_t Custom_1_Who_Am_I_Values[]
Define the WHO_AM_I register values for both possible sensor variations.
isf_SensorDataTypes_t
uint32 isf_timestamp_t
Standard timestamp.
signed long int int32
Definition: isf_types.h:74
float isf_Custom_1_float_data_t
This defines the DSA sensor configuration parameter structure configuring the sensor settings by a su...
void Custom_1_fsl_Sensor_Custom_Initialize(void *pSensorHandle, uint8_t *retVal)
void Custom_1__Void_()
unsigned long int uint32
Definition: isf_types.h:78
This structure defines the dummy DSA data buffer format.
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)
MQX Lite RTOS Adapter component.
isf_devmsg.h defines the API definitions and types for the Intelligent Sensing (ISF) Device Messaging...
void Custom_1_fsl_Sensor_Custom_ValidateSettings(void *pSensorHandle, void *pSensorSettings, uint8_t *retVal)
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)
isf_dsa_status_t fsl_Sensor_Custom_1_Shutdown(isf_SensorHandle_t *pSensorHandle)