111 lines
5.2 KiB
C
111 lines
5.2 KiB
C
/*
|
|
* Copyright 2018 NXP
|
|
* All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
/**
|
|
* @file isl29023_drv.h
|
|
* @brief The isl29023_drv.h file describes the ISL29023 driver interface and structures.
|
|
*/
|
|
|
|
#ifndef ISL29023_FI_H_
|
|
#define ISL29023_FI_H_
|
|
|
|
/* Standard C Includes */
|
|
#include <stdint.h>
|
|
|
|
/* ISSDK Includes */
|
|
#include "isl29023.h"
|
|
#include "sensor_io_i2c.h"
|
|
#include "register_io_i2c.h"
|
|
|
|
/*******************************************************************************
|
|
* Definitions
|
|
******************************************************************************/
|
|
/*! @brief This defines the sensor specific information. */
|
|
typedef struct
|
|
{
|
|
registerDeviceInfo_t deviceInfo; /*!< I2C device context. */
|
|
ARM_DRIVER_I2C *pCommDrv; /*!< Pointer to the i2c driver. */
|
|
bool isInitialized; /*!< Init status.*/
|
|
uint16_t slaveAddress; /*!< slave address.*/
|
|
} isl29023_i2c_sensorhandle_t;
|
|
|
|
/*! @brief This structure defines the isl29023 raw data buffer. */
|
|
typedef struct
|
|
{
|
|
uint32_t timestamp; /*!< Time stamp value in micro-seconds. */
|
|
uint16_t light; /*!< ADC output: unsigned 16/12/8/4-bits resolution */
|
|
} isl29023_lightdata_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 ::ISL29023_I2C_Initialize() returns the status.
|
|
*/
|
|
int32_t ISL29023_I2C_Initialize(
|
|
isl29023_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] : isl29023_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 ISL29023_I2C_Initialize().
|
|
* Application has to ensure that previous instances of these APIs have exited before invocation.
|
|
* @reeentrant No
|
|
*/
|
|
void ISL29023_I2C_SetIdleTask(isl29023_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 ISL29023_I2C_Initialize().
|
|
* Application has to ensure that previous instances of these APIs have exited before invocation.
|
|
* @reeentrant No
|
|
* @return ::ISL29023_I2C_Configure() returns the status.
|
|
*/
|
|
int32_t ISL29023_I2C_Configure(isl29023_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 only after ISL29023_I2C_Initialize().
|
|
* Application has to ensure that previous instances of these APIs have exited before invocation.
|
|
* @reeentrant No
|
|
* @return ::ISL29023_I2C_ReadData() returns the status .
|
|
*/
|
|
int32_t ISL29023_I2C_ReadData(isl29023_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 ISL29023_I2C_Initialize() has been called.
|
|
* Application has to ensure that previous instances of these APIs have exited before invocation.
|
|
* @reeentrant No
|
|
* @return ::ISL29023_I2C_DeInit() returns the status.
|
|
*/
|
|
int32_t ISL29023_I2C_DeInit(isl29023_i2c_sensorhandle_t *pSensorHandle);
|
|
|
|
#endif // ISL29023_FI_H_
|