/*
 * ________________________________________________________________________________________________________
 * Copyright (c) 2017 InvenSense Inc. All rights reserved.
 *
 * This software, related documentation and any modifications thereto (collectively "Software") is subject
 * to InvenSense and its licensors' intellectual property rights under U.S. and international copyright
 * and other intellectual property rights laws.
 *
 * InvenSense and its licensors retain all intellectual property and proprietary rights in and to the Software
 * and any use, reproduction, disclosure or distribution of the Software without an express license agreement
 * from InvenSense is strictly prohibited.
 *
 * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, THE SOFTWARE IS
 * PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
 * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, IN NO EVENT SHALL
 * INVENSENSE BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, 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 THE SOFTWARE.
 * ________________________________________________________________________________________________________
 */

/** @defgroup Apex APEX
 *  @brief High-level functions to drive APEX features
 *  @{
 */

/** @file inv_imu_apex.h */

#ifndef _INV_IMU_APEX_H_
#define _INV_IMU_APEX_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "imu/inv_imu_defs.h"

#include "Invn/InvError.h"

#include <stdint.h>
#include <string.h>

/* Forward declarations */
struct inv_imu_device;

/** IMU APEX inputs parameters definition */
typedef struct {
	APEX_CONFIG3_PEDO_AMP_TH_t            pedo_amp_th;
	uint8_t                               pedo_step_cnt_th;
	uint8_t                               pedo_step_det_th;
	APEX_CONFIG4_PEDO_SB_TIMER_TH_t       pedo_sb_timer_th;
	APEX_CONFIG4_PEDO_HI_ENRGY_TH_t       pedo_hi_enrgy_th;
	APEX_CONFIG5_TILT_WAIT_TIME_t         tilt_wait_time;
	APEX_CONFIG2_DMP_POWER_SAVE_TIME_t    power_save_time;
	APEX_CONFIG0_DMP_POWER_SAVE_t         power_save;
	APEX_CONFIG9_SENSITIVITY_MODE_t       sensitivity_mode;
	APEX_CONFIG2_LOW_ENERGY_AMP_TH_t      low_energy_amp_th;
	APEX_CONFIG9_SMD_SENSITIVITY_t        smd_sensitivity;
	APEX_CONFIG9_FF_DEBOUNCE_DURATION_t   ff_debounce_duration;
	APEX_CONFIG12_FF_MAX_DURATION_t       ff_max_duration_cm;
	APEX_CONFIG12_FF_MIN_DURATION_t       ff_min_duration_cm;
	APEX_CONFIG10_LOWG_PEAK_TH_t          lowg_peak_th;
	APEX_CONFIG5_LOWG_PEAK_TH_HYST_t      lowg_peak_hyst;
	APEX_CONFIG10_LOWG_TIME_TH_SAMPLES_t  lowg_samples_th;
	APEX_CONFIG11_HIGHG_PEAK_TH_t         highg_peak_th;
	APEX_CONFIG5_HIGHG_PEAK_TH_HYST_t     highg_peak_hyst;
	APEX_CONFIG11_HIGHG_TIME_TH_SAMPLES_t highg_samples_th;
} inv_imu_apex_parameters_t;

/** APEX pedometer outputs */
typedef struct inv_imu_apex_step_activity {
	/** Number of steps taken */
	uint16_t step_cnt;

	/** Walk/run cadence in number of samples. 
	 *  Format is u6.2. (at 50Hz and 2Hz walk frequency, if the cadency 
	 *  is 25 samples, the register will output 100). 
	 */
	uint8_t step_cadence;

	/** Detected activity. 
	 *  Unknown (0), Walk (1) or Run (2) 
	 */
	uint8_t activity_class;
} inv_imu_apex_step_activity_t;

/** @brief Enable Free Fall.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 */
int inv_imu_apex_enable_ff(struct inv_imu_device *s);

/** @brief Disable Free Fall.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 */
int inv_imu_apex_disable_ff(struct inv_imu_device *s);

/** @brief Enable Significant Motion Detection.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 *  @warning SMD requires to have the pedometer enabled to work.
 */
int inv_imu_apex_enable_smd(struct inv_imu_device *s);

/** @brief Disable Significant Motion Detection.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 */
int inv_imu_apex_disable_smd(struct inv_imu_device *s);

/** @brief Fill the APEX parameters structure with all the default parameters for APEX algorithms.
 *  @param[in] s             Pointer to device.
 *  @param[out] apex_inputs  Default input parameters.
 *  @return                  0 on success, negative value on error.
 */
int inv_imu_apex_init_parameters_struct(struct inv_imu_device *    s,
                                        inv_imu_apex_parameters_t *apex_inputs);

/** @brief Configures DMP parameters for APEX algorithms. 
 *  @param[in] s            Pointer to device.
 *  @param[in] apex_inputs  The requested input parameters.
 *  @return                 0 on success, negative value on error.
 *  @warning APEX inputs can't change on the fly, this should be called before enabling 
 *           any APEX features.
 *  @warning This API can't be called twice within 10 ms.
 */
int inv_imu_apex_configure_parameters(struct inv_imu_device *          s,
                                      const inv_imu_apex_parameters_t *apex_inputs);

/** @brief Returns current DMP parameters for APEX algorithms.
 *  @param[in] s             Pointer to device.
 *  @param[out] apex_params  The current parameter, fetched from registers.
 *  @return                  0 on success, negative value on error.
 */
int inv_imu_apex_get_parameters(struct inv_imu_device *s, inv_imu_apex_parameters_t *apex_params);

/** @brief Configure DMP Output Data Rate for APEX algorithms.
 *  @param[in] s          Pointer to device.
 *  @param[in] frequency  The requested frequency.
 *  @return               0 on success, negative value on error.
 *  @warning Accel frequency must be higher or equal to DMP frequency.
 */
int inv_imu_apex_set_frequency(struct inv_imu_device *s, const APEX_CONFIG1_DMP_ODR_t frequency);

/** @brief Enable APEX algorithm Pedometer.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 */
int inv_imu_apex_enable_pedometer(struct inv_imu_device *s);

/** @brief Disable APEX algorithm Pedometer.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 */
int inv_imu_apex_disable_pedometer(struct inv_imu_device *s);

/** @brief Enable APEX algorithm Tilt.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 */
int inv_imu_apex_enable_tilt(struct inv_imu_device *s);

/** @brief Disable APEX algorithm Tilt.
 *  @param[in] s  Pointer to device.
 *  @return       0 on success, negative value on error.
 */
int inv_imu_apex_disable_tilt(struct inv_imu_device *s);

/** @brief  Retrieve APEX pedometer outputs and format them
 *  @param[in] s              Pointer to device.
 *  @param[out] apex_activity Apex step and activity data value.
 *  @return                   0 on success, negative value on error.
 */
int inv_imu_apex_get_data_activity(struct inv_imu_device *       s,
                                   inv_imu_apex_step_activity_t *apex_activity);

/** @brief  Retrieve APEX free fall outputs and format them
 *  @param[in] s                   Pointer to device.
 *  @param[out] freefall_duration  Free fall duration in number of sample.
 *  @return                        0 on success, negative value on error.
 */
int inv_imu_apex_get_data_free_fall(struct inv_imu_device *s, uint16_t *freefall_duration);

#ifdef __cplusplus
}
#endif

#endif /* _INV_IMU_APEX_H_ */

/** @} */
