/*
 * __________________________________________________________________
 *
 * Copyright (C) [2023] by InvenSense, Inc.
 * 
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose with or without fee is hereby granted.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY  AND FITNESS. IN NO EVENT SHALL
 * THE AUTHOR BE LIABLE  FOR ANY SPECIAL, DIRECT, INDIRECT, OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 * __________________________________________________________________
 */

#ifndef _EXAMPLE_PEDOMETER_H_
#define _EXAMPLE_PEDOMETER_H_

#include <stdint.h>
#include "Invn/Drivers/Ixm42xxx/Ixm42xxxTransport.h"
#include "Invn/Drivers/Ixm42xxx/Ixm42xxxDefs.h"
#include "Invn/Drivers/Ixm42xxx/Ixm42xxxDriver_HL.h"
#include "Invn/Drivers/Ixm42xxx/Ixm42xxxDriver_HL_apex.h"

/**
 * \brief This function is in charge of reseting and initializing Ixm42xxx device. It should
 * be succesfully executed before any access to Ixm42xxx device.
 *
 * \return 0 on success, negative value on error.
 */
int SetupInvDevice(struct inv_ixm42xxx_serif * icm_serif);

/**
 * \brief This function configures the device in order to output accelerometer.
 *
 * Then function sets frequency for accel and pedometer and it 
 * starts them in the requested power mode with the requested configuration.
 *
 * \param[in] pedometer_freq :   pedometer frequency. See IXM42XXX_APEX_CONFIG0_DMP_ODR_t in Ixm42xxxDefs.h 
 *                         for possible values.
 * \param[in] power_mode :       pedometer power save mode. See IXM42XXX_APEX_CONFIG0_DMP_POWER_SAVE_t in Ixm42xxxDefs.h 
 *                         for possible values.
 * \param[in] pedo_amp_th : pedometer peak threshold to consider a valid step. See IXM42XXX_APEX_CONFIG2_PEDO_AMP_TH_t 
 *                         in Ixm42xxxDefs.h for possible values.
 * \param[in] pedo_step_cnt_th : number of steps that must be detected before the pedometer step count begins incrementing.
 * \param[in] pedo_sb_timer_th : pedometer duration of non-walk to exit the curent walk mode in number of samples. See 
 *                         IXM42XXX_APEX_CONFIG3_PEDO_SB_TIMER_TH_t in Ixm42xxxDefs.h for possible values.
 * \param[in] pedo_step_det_th : number of low latency steps that must be detected before the pedometer step count begins incrementing.
 * \param[in] sensitivity_mode : pedometer sensitivity mode. See IXM42XXX_APEX_CONFIG9_SENSITIVITY_MODE_t in Ixm42xxxDefs.h 
 *                         for possible values.
 * \return 0 on success, negative value on error.
 */
int ConfigureInvDevice(IXM42XXX_APEX_CONFIG0_DMP_ODR_t pedometer_freq,
					   IXM42XXX_APEX_CONFIG0_DMP_POWER_SAVE_t power_mode,
					   IXM42XXX_APEX_CONFIG2_PEDO_AMP_TH_t pedo_amp_th,
					   uint8_t pedo_step_cnt_th,
					   IXM42XXX_APEX_CONFIG3_PEDO_SB_TIMER_TH_t pedo_sb_timer_th,
					   uint8_t pedo_step_det_th,
					   IXM42XXX_APEX_CONFIG9_SENSITIVITY_MODE_t sensitivity_mode);

/**
 * \brief This function extracts data from the Ixm42xxx FIFO.
 *
 * The function just calls Ixm42xxx driver function inv_ixm42xxx_get_data_from_fifo.
 * But note that for each packet extracted from FIFO, a user defined function is called to 
 * allow custom handling of each packet.
 *
 * \return 0 on success, negative value on error.
 */
int GetDataFromInvDevice(void);


#endif /* !_EXAMPLE_PEDOMETER_H_ */
