MCUXpresso_MIMXRT1021xxxxx/middleware/issdk/sensors/fxos8700_drv.c
2022-08-23 23:00:33 +08:00

353 lines
12 KiB
C

/*
* Copyright (c) 2015 - 2016, Freescale Semiconductor, Inc.
* Copyright 2016-2017 NXP
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file fxos8700_drv.c
* @brief The fxos8700_drv.c file implements the fxos8700 sensor driver functional interfaces.
*/
//-----------------------------------------------------------------------
// ISSDK Includes
//-----------------------------------------------------------------------
#include "gpio_driver.h"
#include "fxos8700_drv.h"
//-----------------------------------------------------------------------
// Global Variables
//-----------------------------------------------------------------------
uint8_t fxos8700_spiRead_CmdBuffer[FXOS8700_SPI_MAX_MSG_SIZE] = {0};
uint8_t fxos8700_spiRead_DataBuffer[FXOS8700_SPI_MAX_MSG_SIZE] = {0};
uint8_t fxos8700_spiWrite_CmdDataBuffer[FXOS8700_SPI_MAX_MSG_SIZE] = {0};
//-----------------------------------------------------------------------
// Functions
//-----------------------------------------------------------------------
void FXOS8700_SPI_ReadPreprocess(void *pCmdOut, uint32_t offset, uint32_t size)
{
spiCmdParams_t *pSlaveCmd = pCmdOut;
uint8_t *pWBuff = fxos8700_spiRead_CmdBuffer;
uint8_t *pRBuff = fxos8700_spiRead_DataBuffer;
/* Formatting for Read command of FXOS8700 SENSOR. */
*(pWBuff) = offset & 0x7F; /* offset is the internal register address of the sensor at which write is performed. */
*(pWBuff + 1) = offset & 0x80;
/* Create the slave read command. */
pSlaveCmd->size = size + FXOS8700_SPI_CMD_LEN;
pSlaveCmd->pWriteBuffer = pWBuff;
pSlaveCmd->pReadBuffer = pRBuff;
}
void FXOS8700_SPI_WritePreprocess(void *pCmdOut, uint32_t offset, uint32_t size, void *pWritebuffer)
{
spiCmdParams_t *pSlaveCmd = pCmdOut;
uint8_t *pWBuff = fxos8700_spiWrite_CmdDataBuffer;
uint8_t *pRBuff = fxos8700_spiWrite_CmdDataBuffer + size + FXOS8700_SPI_CMD_LEN;
/* Formatting for Write command of FXOS8700 SENSOR. */
*(pWBuff) = offset | 0x80; /* offset is the internal register address of the sensor at which write is performed. */
*(pWBuff + 1) = offset & 0x80;
/* Copy the slave write command */
memcpy(pWBuff + FXOS8700_SPI_CMD_LEN, pWritebuffer, size);
/* Create the slave command. */
pSlaveCmd->size = size + FXOS8700_SPI_CMD_LEN;
pSlaveCmd->pWriteBuffer = pWBuff;
pSlaveCmd->pReadBuffer = pRBuff;
}
int32_t FXOS8700_SPI_Initialize(
fxos8700_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t whoAmi)
{
int32_t status;
FXOS8700_WHO_AM_I_t reg;
GENERIC_DRIVER_GPIO *pGPIODriver = &Driver_GPIO_KSDK;
/*! Check the input parameters. */
if ((pSensorHandle == NULL) || (pBus == NULL) || (pSlaveSelect == NULL))
{
return SENSOR_ERROR_INVALID_PARAM;
}
/*! Initialize the sensor handle. */
pSensorHandle->pCommDrv = pBus;
pSensorHandle->slaveParams.pReadPreprocessFN = FXOS8700_SPI_ReadPreprocess;
pSensorHandle->slaveParams.pWritePreprocessFN = FXOS8700_SPI_WritePreprocess;
pSensorHandle->slaveParams.pTargetSlavePinID = pSlaveSelect;
pSensorHandle->slaveParams.spiCmdLen = FXOS8700_SPI_CMD_LEN;
pSensorHandle->slaveParams.ssActiveValue = FXOS8700_SS_ACTIVE_VALUE;
pSensorHandle->deviceInfo.deviceInstance = index;
pSensorHandle->deviceInfo.functionParam = NULL;
pSensorHandle->deviceInfo.idleFunction = NULL;
/* Initialize the Slave Select Pin. */
pGPIODriver->pin_init(pSlaveSelect, GPIO_DIRECTION_OUT, NULL, NULL, NULL);
if (pSensorHandle->slaveParams.ssActiveValue == SPI_SS_ACTIVE_LOW)
{
pGPIODriver->set_pin(pSlaveSelect);
}
else
{
pGPIODriver->clr_pin(pSlaveSelect);
}
/*! Read and store the device's WHO_AM_I.*/
status = Register_SPI_Read(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, &pSensorHandle->slaveParams,
FXOS8700_WHO_AM_I, 1, &reg);
if ((ARM_DRIVER_OK != status) || (whoAmi != reg))
{
pSensorHandle->isInitialized = false;
return SENSOR_ERROR_INIT;
}
pSensorHandle->isInitialized = true;
return SENSOR_ERROR_NONE;
}
void FXOS8700_SPI_SetIdleTask(fxos8700_spi_sensorhandle_t *pSensorHandle,
registeridlefunction_t idleTask,
void *userParam)
{
pSensorHandle->deviceInfo.functionParam = userParam;
pSensorHandle->deviceInfo.idleFunction = idleTask;
}
int32_t FXOS8700_SPI_Configure(fxos8700_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)
{
int32_t status;
/*! Validate for the correct handle and register write list.*/
if ((pSensorHandle == NULL) || (pRegWriteList == NULL))
{
return SENSOR_ERROR_INVALID_PARAM;
}
/*! Check whether sensor handle is initialized before applying configuration.*/
if (pSensorHandle->isInitialized != true)
{
return SENSOR_ERROR_INIT;
}
/*! Put the device into standby mode so that configuration can be applied.*/
status =
Register_SPI_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, &pSensorHandle->slaveParams,
FXOS8700_CTRL_REG1, FXOS8700_CTRL_REG1_ACTIVE_STANDBY_MODE, FXOS8700_CTRL_REG1_ACTIVE_MASK);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_WRITE;
}
/*! Apply the Sensor Configuration based on the Register Write List */
status = Sensor_SPI_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, &pSensorHandle->slaveParams,
pRegWriteList);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_WRITE;
}
/*! Put the device into active mode and ready for reading data.*/
status =
Register_SPI_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, &pSensorHandle->slaveParams,
FXOS8700_CTRL_REG1, FXOS8700_CTRL_REG1_ACTIVE_ACTIVE_MODE, FXOS8700_CTRL_REG1_ACTIVE_MASK);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_WRITE;
}
return SENSOR_ERROR_NONE;
}
int32_t FXOS8700_SPI_ReadData(fxos8700_spi_sensorhandle_t *pSensorHandle,
const registerreadlist_t *pReadList,
uint8_t *pBuffer)
{
int32_t status;
/*! Validate for the correct handle and register read list.*/
if ((pSensorHandle == NULL) || (pReadList == NULL) || (pBuffer == NULL))
{
return SENSOR_ERROR_INVALID_PARAM;
}
/*! Check whether sensor handle is initialized before reading sensor data.*/
if (pSensorHandle->isInitialized != true)
{
return SENSOR_ERROR_INIT;
}
/*! Parse through the read list and read the data one by one. */
status = Sensor_SPI_Read(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, &pSensorHandle->slaveParams,
pReadList, pBuffer);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_READ;
}
return SENSOR_ERROR_NONE;
}
int32_t FXOS8700_SPI_Deinit(fxos8700_spi_sensorhandle_t *pSensorHandle)
{
if (pSensorHandle == NULL)
{
return SENSOR_ERROR_INVALID_PARAM;
}
/*! Check whether sensor handle is initialized before triggering sensor reset.*/
if (pSensorHandle->isInitialized != true)
{
return SENSOR_ERROR_INIT;
}
/*! Trigger sensor device reset.*/
Register_SPI_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, &pSensorHandle->slaveParams,
FXOS8700_CTRL_REG2, FXOS8700_CTRL_REG2_RST_EN, FXOS8700_CTRL_REG2_RST_MASK);
/*! De-initialize sensor handle.
* We do not validate write success since 8700 reset before sensing ack for the transaction. */
pSensorHandle->isInitialized = false;
return SENSOR_ERROR_NONE;
}
int32_t FXOS8700_I2C_Initialize(
fxos8700_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)
{
int32_t status;
FXOS8700_WHO_AM_I_t reg;
if ((pSensorHandle == NULL) || (pBus == NULL))
{
return SENSOR_ERROR_INVALID_PARAM;
}
pSensorHandle->deviceInfo.deviceInstance = index;
pSensorHandle->deviceInfo.functionParam = NULL;
pSensorHandle->deviceInfo.idleFunction = NULL;
/*! Read and store the device's WHO_AM_I.*/
status = Register_I2C_Read(pBus, &pSensorHandle->deviceInfo, sAddress, FXOS8700_WHO_AM_I, 1, &reg);
if ((ARM_DRIVER_OK != status) || (whoAmi != reg))
{
pSensorHandle->isInitialized = false;
return SENSOR_ERROR_INIT;
}
/*! Initialize the sensor handle. */
pSensorHandle->pCommDrv = pBus;
pSensorHandle->slaveAddress = sAddress;
pSensorHandle->isInitialized = true;
return SENSOR_ERROR_NONE;
}
void FXOS8700_I2C_SetIdleTask(fxos8700_i2c_sensorhandle_t *pSensorHandle,
registeridlefunction_t idleTask,
void *userParam)
{
pSensorHandle->deviceInfo.functionParam = userParam;
pSensorHandle->deviceInfo.idleFunction = idleTask;
}
int32_t FXOS8700_I2C_Configure(fxos8700_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)
{
int32_t status;
/*! Validate for the correct handle and register write list.*/
if ((pSensorHandle == NULL) || (pRegWriteList == NULL))
{
return SENSOR_ERROR_INVALID_PARAM;
}
/*! Check whether sensor handle is initialized before applying configuration.*/
if (pSensorHandle->isInitialized != true)
{
return SENSOR_ERROR_INIT;
}
/* Put the device into standby mode so that configuration can be applied.*/
status = Register_I2C_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, pSensorHandle->slaveAddress,
FXOS8700_CTRL_REG1, FXOS8700_CTRL_REG1_ACTIVE_STANDBY_MODE,
FXOS8700_CTRL_REG1_ACTIVE_MASK, false);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_WRITE;
}
/* Appy the Sensor Configuration based on the Register List */
status = Sensor_I2C_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, pSensorHandle->slaveAddress,
pRegWriteList);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_WRITE;
}
/* Put the device into active mode and ready for reading data.*/
status = Register_I2C_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, pSensorHandle->slaveAddress,
FXOS8700_CTRL_REG1, FXOS8700_CTRL_REG1_ACTIVE_ACTIVE_MODE,
FXOS8700_CTRL_REG1_ACTIVE_MASK, false);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_WRITE;
}
return SENSOR_ERROR_NONE;
}
int32_t FXOS8700_I2C_ReadData(fxos8700_i2c_sensorhandle_t *pSensorHandle,
const registerreadlist_t *pReadList,
uint8_t *pBuffer)
{
int32_t status;
/*! Validate for the correct handle and register read list.*/
if ((pSensorHandle == NULL) || (pReadList == NULL) || (pBuffer == NULL))
{
return SENSOR_ERROR_INVALID_PARAM;
}
/*! Check whether sensor handle is initialized before reading sensor data.*/
if (pSensorHandle->isInitialized != true)
{
return SENSOR_ERROR_INIT;
}
/*! Parse through the read list and read the data one by one*/
status = Sensor_I2C_Read(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, pSensorHandle->slaveAddress,
pReadList, pBuffer);
if (ARM_DRIVER_OK != status)
{
return SENSOR_ERROR_READ;
}
return SENSOR_ERROR_NONE;
}
int32_t FXOS8700_I2C_Deinit(fxos8700_i2c_sensorhandle_t *pSensorHandle)
{
if (pSensorHandle == NULL)
{
return SENSOR_ERROR_INVALID_PARAM;
}
/*! Check whether sensor handle is initialized before triggering sensor reset.*/
if (pSensorHandle->isInitialized != true)
{
return SENSOR_ERROR_INIT;
}
/*! Trigger sensor device reset.*/
Register_I2C_Write(pSensorHandle->pCommDrv, &pSensorHandle->deviceInfo, pSensorHandle->slaveAddress,
FXOS8700_CTRL_REG2, FXOS8700_CTRL_REG2_RST_EN, FXOS8700_CTRL_REG2_RST_MASK, false);
pSensorHandle->isInitialized = false;
return SENSOR_ERROR_NONE;
}