-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathfxls8974_drv_i2c.h
113 lines (101 loc) · 5.26 KB
/
fxls8974_drv_i2c.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
* Copyright 2022 NXP
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file fxls8974_drv_i2c.h
* @brief The fxls8974_drv_i2c.h file describes the FXLS8974CF driver interface and structures.
*/
#ifndef FXLS8974_DRV_I2C_H_
#define FXLS8974_DRV_I2C_H_
/* Standard C Includes */
#include <stdint.h>
#include <string.h>
/* ISSDK Includes */
#include "fxls8974.h"
#include "sensor_io_i2c.h"
#include "register_io_i2c.h"
/*******************************************************************************
* Definitions
******************************************************************************/
/*!
* @brief This defines the sensor specific information for I2C.
*/
typedef struct
{
registerDeviceInfo_t deviceInfo; /*!< I2C device context. */
ARM_DRIVER_I2C *pCommDrv; /*!< Pointer to the i2c driver. */
bool isInitialized; /*!< whether sensor is intialized or not.*/
uint16_t slaveAddress; /*!< slave address.*/
} fxls8974_i2c_sensorhandle_t;
/*! @brief This structure defines the fxls8974 raw data buffer.*/
typedef struct
{
uint32_t timestamp; /*! The time, this sample was recorded. */
int16_t accel[3]; /*!< The accel data */
} fxls8974_acceldata_t;
/*******************************************************************************
* APIs
******************************************************************************/
/*! @brief The interface function to initialize the sensor.
* @details This function initialize the sensor and sensor handle.
* @param[in] pSensorHandle handle to the sensor.
* @param[in] pBus pointer to the CMSIS API compatible I2C bus object.
* @param[in] index the I2C device number.
* @param[in] sAddress slave address of the device on the bus.
* @param[in] whoami WHO_AM_I value of the device.
* @constraints This should be the first API to be called.
* Application has to ensure that previous instances of these APIs have exited before invocation.
* @reeentrant No
* @return ::FXLS8974_I2C_Initialize() returns the status .
*/
int32_t FXLS8974_I2C_Initialize(
fxls8974_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t *whoAmi);
/*! @brief : The interface function to set the I2C Idle Task.
* @param[in] : fxls8974_i2c_sensorhandle_t *pSensorHandle, handle to the sensor handle.
* @param[in] : registeridlefunction_t idleTask, function pointer to the function to execute on I2C Idle Time.
* @param[in] : void *userParam, the pointer to the user idle ftask parameters.
* @return void.
* @constraints This can be called any number of times only after FXLS8974_I2C_Initialize().
* Application has to ensure that previous instances of these APIs have exited before invocation.
* @reeentrant No
*/
void FXLS8974_I2C_SetIdleTask(fxls8974_i2c_sensorhandle_t *pSensorHandle,
registeridlefunction_t idleTask,
void *userParam);
/*! @brief The interface function to configure he sensor.
* @details This function configure the sensor with requested ODR, Range and registers in the regsiter pair array.
* @param[in] pSensorHandle handle to the sensor.
* @param[in] pRegWriteList pointer to the register list.
* @constraints This can be called any number of times only after FXLS8974_I2C_Initialize().
* Application has to ensure that previous instances of these APIs have exited before invocation.
* @reeentrant No
* @return ::FXLS8974_I2C_Configure() returns the status .
*/
int32_t FXLS8974_I2C_Configure(fxls8974_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList);
/*! @brief The interface function to read the sensor data.
* @details This function read the sensor data out from the device and returns raw data in a byte stream.
* @param[in] pSensorHandle handle to the sensor.
* @param[in] pReadList pointer to the list of device registers and values to read.
* @param[out] pBuffer buffer which holds raw sensor data.This buffer may be back to back databuffer based
* command read in the list.
* @constraints This can be called any number of times only after FXLS8974_I2C_Initialize().
* Application has to ensure that previous instances of these APIs have exited before invocation.
* @reeentrant No
* @return ::FXLS8974_I2C_ReadData() returns the status .
*/
int32_t FXLS8974_I2C_ReadData(fxls8974_i2c_sensorhandle_t *pSensorHandle,
const registerreadlist_t *pReadList,
uint8_t *pBuffer);
/*! @brief The interface function to De Initialize sensor..
* @details This function made sensor in a power safe state and de initialize its handle.
* @param[in] pSensorHandle handle to the sensor.
* @constraints This can be called only after FXLS8974_I2C_Initialize().
* Application has to ensure that previous instances of these APIs have exited before invocation.
* @reeentrant No
* @return ::FXLS8974_I2C_DeInit() returns the status .
*/
int32_t FXLS8974_I2C_DeInit(fxls8974_i2c_sensorhandle_t *pSensorHandle);
#endif // FXLS8974_DRV_I2C_H_