ISSDK  1.7
IoT Sensing Software Development Kit
mma865x_fifo.c
Go to the documentation of this file.
1 /*
2  * The Clear BSD License
3  * Copyright (c) 2016, Freescale Semiconductor, Inc.
4  * Copyright 2016-2017 NXP
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without modification,
8  * are permitted (subject to the limitations in the disclaimer below) provided
9  * that the following conditions are met:
10  *
11  * o Redistributions of source code must retain the above copyright notice, this list
12  * of conditions and the following disclaimer.
13  *
14  * o Redistributions in binary form must reproduce the above copyright notice, this
15  * list of conditions and the following disclaimer in the documentation and/or
16  * other materials provided with the distribution.
17  *
18  * o Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from this
20  * software without specific prior written permission.
21  *
22  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
27  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
30  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 /**
36  * @file mma865x_fifo.c
37 * @brief The mma865x_fifo.c file implements the ISSDK MMA865x sensor driver
38 * example demonstration with FIFO mode.
39 */
40 
41 //-----------------------------------------------------------------------
42 // SDK Includes
43 //-----------------------------------------------------------------------
44 #include "board.h"
45 #include "pin_mux.h"
46 #include "clock_config.h"
47 #include "fsl_debug_console.h"
48 
49 //-----------------------------------------------------------------------
50 // CMSIS Includes
51 //-----------------------------------------------------------------------
52 #include "Driver_I2C.h"
53 
54 /* ISSDK Includes */
55 #include "issdk_hal.h"
56 #include "mma865x_drv.h"
57 
58 //-----------------------------------------------------------------------
59 // Macros
60 //-----------------------------------------------------------------------
61 /* The watermark value configured for MMA865x FIFO Buffer. */
62 #define FIFO_WATERMARK (16) /* Must be between 1 - 32 */
63 #define MMA865x_ACCEL_DATA_SIZE (6) /* 2 byte X,Y,Z Axis Data each. */
64 
65 //-----------------------------------------------------------------------
66 // Constants
67 //-----------------------------------------------------------------------
68 /*! Prepare the register write list to configure MMA865x in FIFO mode. */
70  {/*! Configure the MMA865x to enable FIFO Mode and set Watermark. */
73  /*! Configure the MMA865x to set FS Range as 2g. */
75  /*! Configure the MMA865x to set ODR to 100Hz. */
77  /*! Configure the MMA865x to set High Resolution mode. */
80 
81 /*! Prepare the register read list to read the FIFO Status from MMA865x. */
83 
84 /*! Prepare the register read list to read the raw Accel data from MMA865x. */
87 
88 //-----------------------------------------------------------------------
89 // Functions
90 //-----------------------------------------------------------------------
91 /*!
92  * @brief Main function
93  */
94 int main(void)
95 {
97  uint8_t dataReady;
100 
101  ARM_DRIVER_I2C *I2Cdrv = &I2C_S_DRIVER; // Now using the shield.h value!!!
102  mma865x_i2c_sensorhandle_t mma865xDriver;
103 
104  BOARD_InitPins();
107 
108  PRINTF("\r\n ISSDK MMA865x sensor driver example for FIFO Mode. \r\n");
109 
110  /*! Initialize the I2C driver. */
111  status = I2Cdrv->Initialize(I2C_S_SIGNAL_EVENT);
112  if (ARM_DRIVER_OK != status)
113  {
114  PRINTF("\r\n I2C Initialization Failed\r\n");
115  return -1;
116  }
117 
118  /*! Set the I2C Power mode. */
119  status = I2Cdrv->PowerControl(ARM_POWER_FULL);
120  if (ARM_DRIVER_OK != status)
121  {
122  PRINTF("\r\n I2C Power Mode setting Failed\r\n");
123  return -1;
124  }
125 
126  /*! Set the I2C bus speed. */
127  status = I2Cdrv->Control(ARM_I2C_BUS_SPEED, ARM_I2C_BUS_SPEED_FAST);
128  if (ARM_DRIVER_OK != status)
129  {
130  PRINTF("\r\n I2C Control Mode setting Failed\r\n");
131  return -1;
132  }
133 
134  /*! Initialize the MMA865x sensor driver. */
137  if (SENSOR_ERROR_NONE != status)
138  {
139  PRINTF("\r\n Sensor Initialization Failed\r\n");
140  return -1;
141  }
142  PRINTF("\r\n Successfully Initiliazed Sensor\r\n");
143 
144  /*! Set the task to be executed while waiting for I2C transactions to complete. */
146 
147  /*! Configure the MMA865x sensor driver with FIFO mode. */
148  status = MMA865x_I2C_Configure(&mma865xDriver, cMma865xConfigFifo);
149  if (SENSOR_ERROR_NONE != status)
150  {
151  PRINTF("\r\n MMA865x Sensor Configuration Failed, Err = %d \r\n", status);
152  return -1;
153  }
154  PRINTF("\r\n MMA865x now active and entering data read loop... \r\n");
155 
156  for (;;) /* Forever loop */
157  {
158  /*! Wait for data ready from the MMA865x. */
159  status = MMA865x_I2C_ReadData(&mma865xDriver, cMma865xFifoStatus, &dataReady);
160  if (0 == (dataReady & MMA865x_F_STATUS_F_WMKF_MASK))
161  { /* Loop, if new sample is not available. */
162  continue;
163  }
164 
165  /*! Read the raw sensor data from the MMA865x. */
166  status = MMA865x_I2C_ReadData(&mma865xDriver, cMma865xOutputValues, data);
167  if (ARM_DRIVER_OK != status)
168  {
169  PRINTF("\r\n Read Failed. \r\n");
170  return -1;
171  }
172 
173  for (uint8_t i = 0; i < FIFO_WATERMARK; i++)
174  {
175  /*! Convert the raw sensor data to signed 16-bit container for display to the debug port. */
176  rawData.accel[0] =
177  ((int16_t)data[i * MMA865x_ACCEL_DATA_SIZE + 0] << 8) | data[i * MMA865x_ACCEL_DATA_SIZE + 1];
178  rawData.accel[0] /= 16;
179  rawData.accel[1] =
180  ((int16_t)data[i * MMA865x_ACCEL_DATA_SIZE + 2] << 8) | data[i * MMA865x_ACCEL_DATA_SIZE + 3];
181  rawData.accel[1] /= 16;
182  rawData.accel[2] =
183  ((int16_t)data[i * MMA865x_ACCEL_DATA_SIZE + 4] << 8) | data[i * MMA865x_ACCEL_DATA_SIZE + 5];
184  rawData.accel[2] /= 16;
185  }
186  /* NOTE: PRINTF is relatively expensive in terms of CPU time, specially when used with-in execution loop.
187  * Hence, we display only the last sample from each FIFO Burst Read. */
188  PRINTF("\r\n Accel X = %d Y = %d Z = %d \r\n", rawData.accel[0], rawData.accel[1], rawData.accel[2]);
189  ASK_USER_TO_RESUME(992 / FIFO_WATERMARK); /* Ask for user input after processing 992 samples. */
190  }
191 }
#define MMA865x_XYZ_DATA_CFG_FS_MASK
Definition: mma865x.h:530
#define __END_WRITE_DATA__
Definition: sensor_drv.h:71
int32_t MMA865x_I2C_Initialize(mma865x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)
The interface function to initialize the sensor.
Definition: mma865x_drv.c:48
This structure defines the mma865x raw data buffer.
Definition: mma865x_drv.h:64
#define MMA865x_F_SETUP_F_MODE_STOP_MODE
Definition: mma865x.h:302
#define BOARD_BootClockRUN
Definition: clock_config.h:45
int16_t accel[3]
Definition: mma865x_drv.h:67
#define MMA865x_F_STATUS_F_WMKF_MASK
Definition: mma865x.h:195
uint8_t data[FXLS8962_DATA_SIZE]
int32_t MMA865x_I2C_ReadData(mma865x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)
The interface function to read the sensor data.
Definition: mma865x_drv.c:132
int32_t status
void BOARD_InitDebugConsole(void)
Definition: board.c:41
This defines the sensor specific information.
Definition: mma865x_drv.h:55
const registerreadlist_t cMma865xFifoStatus[]
Definition: mma865x_fifo.c:82
void(* registeridlefunction_t)(void *userParam)
This is the register idle function type.
Definition: sensor_drv.h:123
#define MMA865x_CTRL_REG1_DR_MASK
Definition: mma865x.h:1534
#define __END_READ_DATA__
Definition: sensor_drv.h:77
#define MMA865x_F_SETUP_F_WMRK_MASK
Definition: mma865x.h:290
#define MMA8652_I2C_ADDR
const registerwritelist_t cMma865xConfigFifo[]
Definition: mma865x_fifo.c:69
#define MMA865x_CTRL_REG1_DR_100HZ
Definition: mma865x.h:1551
void MMA865x_I2C_SetIdleTask(mma865x_i2c_sensorhandle_t *pSensorHandle, registeridlefunction_t idleTask, void *userParam)
: The interface function to set the I2C Idle Task.
Definition: mma865x_drv.c:79
#define MMA8652_WHOAMI_VALUE
Definition: mma865x.h:65
const registerreadlist_t cMma865xOutputValues[]
Definition: mma865x_fifo.c:85
#define ASK_USER_TO_RESUME(x)
Definition: frdm_k64f.h:132
int32_t MMA865x_I2C_Configure(mma865x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)
The interface function to configure he sensor.
Definition: mma865x_drv.c:87
#define MMA865x_XYZ_DATA_CFG_FS_2G
Definition: mma865x.h:542
#define MMA865x_CTRL_REG2_MODS_MASK
Definition: mma865x.h:1592
#define MMA865x_ACCEL_DATA_SIZE
Definition: mma865x_fifo.c:63
#define I2C_S_DEVICE_INDEX
Definition: issdk_hal.h:61
#define MMA865x_F_SETUP_F_MODE_MASK
Definition: mma865x.h:293
#define I2C_S_DRIVER
Definition: issdk_hal.h:59
The mma865x_drv.h file describes the MMA865x driver interface and structures.
#define FIFO_WATERMARK
Definition: mma865x_fifo.c:62
typedef int32_t(DATA_FORMAT_Append_t))(void *pData
The interface function to append the data on the formated stream.
fxls8962_acceldataUser_t rawData
#define MMA865x_CTRL_REG2_MODS_HR
Definition: mma865x.h:1623
This structure defines the Write command List.
Definition: sensor_drv.h:94
This structure defines the Read command List.
Definition: sensor_drv.h:104
#define SMC
Definition: lpc54114.h:144
int main(void)
Main function.
Definition: mma865x_fifo.c:94
status_t SMC_SetPowerModeWait(void *arg)
Configures the system to WAIT power mode. API name used from Kinetis family to maintain compatibility...
Definition: lpc54114.c:181
void BOARD_InitPins(void)
Configures pin routing and optionally pin electrical features.
Definition: pin_mux.c:73
#define I2C_S_SIGNAL_EVENT
Definition: issdk_hal.h:60