ISF  2.2 rev 5
Intelligent Sensing Framework for Kinetis with Processor Expert
fsl_Sensor_Analog_1_Functions.h
Go to the documentation of this file.
1 /* ###################################################################
2 ** Filename : fsl_Sensor_Analog_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 ** Analog_1__Void_ - void Analog_1__Void_(void);
15 ** Analog_1_fsl_Sensor_Generic_Analog_Convert - void Analog_1_fsl_Sensor_Generic_Analog_Convert(void);
16 ** Analog_1_fsl_Sensor_Generic_AnalogCallback - void Analog_1_fsl_Sensor_Generic_AnalogCallback(void);
17 ** Analog_1_fsl_Sensor_Generic_Analog_Shutdown - void Analog_1_fsl_Sensor_Generic_Analog_Shutdown(void);
18 ** Analog_1_fsl_Sensor_Generic_Analog_EndData - void Analog_1_fsl_Sensor_Generic_Analog_EndData(void);
19 ** Analog_1_fsl_Sensor_Generic_Analog_StartData - void Analog_1_fsl_Sensor_Generic_Analog_StartData(void);
20 ** Analog_1_fsl_Sensor_Generic_Analog_Configure - void Analog_1_fsl_Sensor_Generic_Analog_Configure(void);
21 ** Analog_1_fsl_Sensor_Generic_Analog_ValidateSettings - void Analog_1_fsl_Sensor_Generic_Analog_ValidateSettings(void);
22 ** Analog_1_fsl_Sensor_Generic_Analog_Initialize - void Analog_1_fsl_Sensor_Generic_Analog_Initialize(void);
23 **
24 ** ###################################################################*/
25 /*!
26 ** @file fsl_Sensor_Analog_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_Analog_1_Functions_module fsl_Sensor_Analog_1_Functions module documentation
34 ** @{
35 */
36 
37 #ifndef __fsl_Sensor_Analog_1_Functions_H
38 #define __fsl_Sensor_Analog_1_Functions_H
39 /* MODULE fsl_Sensor_Analog_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 Analog_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_Analog_1_Functions_H_
109 #define __fsl_Sensor_Analog_1_Functions_H_
110 
111 #define MAX_ADC_CHANNELS 6
112 
113 /*! @brief This structure stores sample Information necessary to communicate with non I2C slave device.*/
114 typedef struct
115 {
116  uint16_t dummy;
117  uint16_t address;
119 
120 /**
121  * @brief SENSOR internal return codes.
122  */
126 
127 /*! @brief This structure defines the dummy DSA data buffer format.*/
128 typedef struct
129 {
130  uint32 timeStamp; /*!< The time stamp for the data packet.*/
131  uint16 data[MAX_ADC_CHANNELS]; /*!< The Sensor data */
134 
135 #define Analog_1_DATA_TYPE Analog_1_DataBuffer_t
136 
137 typedef struct {
139  isf_Analog_1_fixed_data_t sensorData[MAX_ADC_CHANNELS];
141 
142 /** @brief Standard fixed type for three axis accelerometers */
143 typedef struct {
145  isf_Analog_1_float_data_t sensorData[MAX_ADC_CHANNELS];
147 
148 /* END: Shared types with Embedded Application Modules. */
149 #endif
150 #ifndef __fsl_Sensor_Analog_1_Functions_H__
151 #define __fsl_Sensor_Analog_1_Functions_H__
152 
153 typedef struct
154 {
155  /* Filled as per Generic Analog Sensor Specific flags and registers */
158 
160 
161 enum
162 {
166 };
167 
168 /*
169  * General purpose macros to set/get a specific bit field within a register.
170  * The macro assumes that the root identifier for the field is a consistent character string (e.g., "BIT_FIELD").
171  * The bit field mask is the character string followed by "_MASK" (e.g., BIT_FIELD_MASK).
172  * The bit field shift is the character string followed by "_SHIFT" (e.g., BIT_FIELD_SHIFT).
173  */
174 #define Analog_1_SET_FIELD(name,val) (((val)<<Analog_1_##name##_SHIFT)&(Analog_1_##name##_MASK))
175 #define Analog_1_GET_FIELD(name,val) ((val&Analog_1_##name##_MASK)>>Analog_1_##name##_SHIFT)
176 
177 /* Converter routines for the supported data types.
178  */
179 isf_dsa_status_t Analog_1_float_converter(Analog_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Analog_1_DataBuffer_t *nativeSample, void *vpConvertedSample);
180 isf_dsa_status_t Analog_1_fixed_converter(Analog_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Analog_1_DataBuffer_t *nativeSample, void *vpConvertedSample);
181 
182 /* Internal wraper functions for use by ISF Core.
183  */
184 isf_dsa_status_t fsl_Sensor_Analog_1_Convert(isf_SensorHandle_t* pSensorHandle, isf_SensorDataTypes_t convertToType, isf_dsa_result_types_t resultType, void* pNativeSample, void* pConvertedSample, int32_t *numBytes);
191 
192 void Analog_1_fsl_Sensor_Generic_Analog_Convert(void* pSensorHandle, uint32_t convertToType, uint8_t resultType, void* pNativeSample, void* pConvertedSample, int32_t *numBytes, int8_t *retValue);
193 /*
194 ** ===================================================================
195 ** Event : Analog_1_fsl_Sensor_Generic_Analog_Convert (module fsl_Sensor_Analog_1_Functions)
196 **
197 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
198 ** @brief
199 ** Parameters :
200 ** NAME - DESCRIPTION
201 ** @param
202 ** @param
203 ** @param
204 ** @param
205 ** @param
206 ** @param
207 ** @param
208 ** @return
209 ** Returns : Nothing
210 ** ===================================================================
211 */
212 void Analog_1_fsl_Sensor_Generic_AnalogCallback(void* pSensorHandle);
213 /*
214 ** ===================================================================
215 ** Event : Analog_1_fsl_Sensor_Generic_AnalogCallback (module fsl_Sensor_Analog_1_Functions)
216 **
217 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
218 ** @brief
219 ** Parameters :
220 ** NAME - DESCRIPTION
221 ** @param
222 ** @return
223 ** Returns : Nothing
224 ** ===================================================================
225 */
226 void Analog_1_fsl_Sensor_Generic_Analog_Shutdown(void* pSensorHandle, int8_t *retValue);
227 /*
228 ** ===================================================================
229 ** Event : Analog_1_fsl_Sensor_Generic_Analog_Shutdown (module fsl_Sensor_Analog_1_Functions)
230 **
231 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
232 ** @brief
233 ** Parameters :
234 ** NAME - DESCRIPTION
235 ** @param
236 ** @param
237 ** @return
238 ** Returns : Nothing
239 ** ===================================================================
240 */
241 void Analog_1_fsl_Sensor_Generic_Analog_EndData(void* pSensorHandle, int8_t *retValue);
242 /*
243 ** ===================================================================
244 ** Event : Analog_1_fsl_Sensor_Generic_Analog_EndData (module fsl_Sensor_Analog_1_Functions)
245 **
246 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
247 ** @brief
248 ** Parameters :
249 ** NAME - DESCRIPTION
250 ** @param
251 ** @param
252 ** @return
253 ** Returns : Nothing
254 ** ===================================================================
255 */
256 void Analog_1_fsl_Sensor_Generic_Analog_StartData(void* pSensorHandle, int8_t *retValue);
257 /*
258 ** ===================================================================
259 ** Event : Analog_1_fsl_Sensor_Generic_Analog_StartData (module fsl_Sensor_Analog_1_Functions)
260 **
261 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
262 ** @brief
263 ** Parameters :
264 ** NAME - DESCRIPTION
265 ** @param
266 ** @param
267 ** @return
268 ** Returns : Nothing
269 ** ===================================================================
270 */
271 void Analog_1_fsl_Sensor_Generic_Analog_Configure(void* pSensorHandle, void* pSensorSettings, int8_t *retValue);
272 /*
273 ** ===================================================================
274 ** Event : Analog_1_fsl_Sensor_Generic_Analog_Configure (module fsl_Sensor_Analog_1_Functions)
275 **
276 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
277 ** @brief
278 ** Parameters :
279 ** NAME - DESCRIPTION
280 ** @param
281 ** @param
282 ** @param
283 ** @return
284 ** Returns : Nothing
285 ** ===================================================================
286 */
287 void Analog_1_fsl_Sensor_Generic_Analog_ValidateSettings(void* pSensorHandle, void* pSensorSettings, int8_t *retValue);
288 /*
289 ** ===================================================================
290 ** Event : Analog_1_fsl_Sensor_Generic_Analog_ValidateSettings (module fsl_Sensor_Analog_1_Functions)
291 **
292 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
293 ** @brief
294 ** Parameters :
295 ** NAME - DESCRIPTION
296 ** @param
297 ** @param
298 ** @param
299 ** @return
300 ** Returns : Nothing
301 ** ===================================================================
302 */
303 void Analog_1_fsl_Sensor_Generic_Analog_Initialize(void* pSensorHandle, int8_t *retValue);
304 /*
305 ** ===================================================================
306 ** Event : Analog_1_fsl_Sensor_Generic_Analog_Initialize (module fsl_Sensor_Analog_1_Functions)
307 **
308 ** Component : Analog_1 [ISF_KSDK_Sensor_Generic_Analog]
309 ** @brief
310 ** Parameters :
311 ** NAME - DESCRIPTION
312 ** @param
313 ** @param
314 ** @return
315 ** Returns : Nothing
316 ** ===================================================================
317 */
318 
319 /* END fsl_Sensor_Analog_1_Functions */
320 
321 #ifdef __cplusplus
322 } /* extern "C" */
323 #endif
324 
325 #endif
326 /* ifndef __fsl_Sensor_Analog_1_Functions_H*/
327 /*!
328 ** @}
329 */
330 /*
331 ** ###################################################################
332 **
333 ** This file was created by Processor Expert 10.5 [05.21]
334 ** for the Freescale Kinetis series of microcontrollers.
335 **
336 ** ###################################################################
337 */
unsigned char uint8
Definition: isf_types.h:76
void Analog_1_fsl_Sensor_Generic_Analog_Configure(void *pSensorHandle, void *pSensorSettings, int8_t *retValue)
OS_Task component.
void Analog_1_fsl_Sensor_Generic_Analog_EndData(void *pSensorHandle, int8_t *retValue)
isf_dsa_status_t fsl_Sensor_Analog_1_ValidateSettings(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
isf_dsa_status_t fsl_Sensor_Analog_1_Initialize(isf_SensorHandle_t *pSensorHandle)
isf_sensors.h contains the ISF Generic Sensor definitions and data structures required when a client ...
int32 isf_Analog_1_fixed_data_t
This defines the DSA sensor device handle structure used to invoke the adapter access functions...
isf_dsa_status_t Analog_1_fixed_converter(Analog_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Analog_1_DataBuffer_t *nativeSample, void *vpConvertedSample)
isf_dsa_status_t fsl_Sensor_Analog_1_StartData(isf_SensorHandle_t *pSensorHandle)
void Analog_1_fsl_Sensor_Generic_AnalogCallback(void *pSensorHandle)
isf_dsa_status_t Analog_1_float_converter(Analog_1_Sensor_Specific_Settings_t *pSensorSpecificConfig, Analog_1_DataBuffer_t *nativeSample, void *vpConvertedSample)
isf_dsa_status_t fsl_Sensor_Analog_1_Configure(isf_SensorHandle_t *pSensorHandle, isf_dsa_SensorSettings_t *pSensorSettings)
int32 isf_dsa_status_t
This is the Sensor Manager API return type definition.
Standard fixed type for three axis accelerometers.
The isf_sensor_types.h contains the enumerated list of sensor types used by ISF.
void Analog_1_fsl_Sensor_Generic_Analog_Shutdown(void *pSensorHandle, int8_t *retValue)
enum isf_dsa_result_enums isf_dsa_result_types_t
This structure stores sample Information necessary to communicate with non I2C slave device...
OS_Task component.
void Analog_1__Void_()
isf_SensorDataTypes_t
void Analog_1_fsl_Sensor_Generic_Analog_Initialize(void *pSensorHandle, int8_t *retValue)
uint32 isf_timestamp_t
Standard timestamp.
isf_dsa_status_t fsl_Sensor_Analog_1_EndData(isf_SensorHandle_t *pSensorHandle)
isf_dsa_status_t fsl_Sensor_Analog_1_Shutdown(isf_SensorHandle_t *pSensorHandle)
signed long int int32
Definition: isf_types.h:74
unsigned short int uint16
Definition: isf_types.h:77
int32 Analog_1_Status_t
SENSOR internal return codes.
void Analog_1_fsl_Sensor_Generic_Analog_StartData(void *pSensorHandle, int8_t *retValue)
void Analog_1_fsl_Sensor_Generic_Analog_Convert(void *pSensorHandle, uint32_t convertToType, uint8_t resultType, void *pNativeSample, void *pConvertedSample, int32_t *numBytes, int8_t *retValue)
#define MAX_ADC_CHANNELS
This defines the DSA sensor configuration parameter structure configuring the sensor settings by a su...
void Analog_1_fsl_Sensor_Generic_Analog_ValidateSettings(void *pSensorHandle, void *pSensorSettings, int8_t *retValue)
unsigned long int uint32
Definition: isf_types.h:78
float isf_Analog_1_float_data_t
MQX Lite RTOS Adapter component.
isf_devmsg.h defines the API definitions and types for the Intelligent Sensing (ISF) Device Messaging...
This structure defines the dummy DSA data buffer format.
isf_dsa_status_t fsl_Sensor_Analog_1_Convert(isf_SensorHandle_t *pSensorHandle, isf_SensorDataTypes_t convertToType, isf_dsa_result_types_t resultType, void *pNativeSample, void *pConvertedSample, int32_t *numBytes)