sensor_alg_interface.h

/* Copyright Statement:
 *
 * (C) 2005-2017 MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __SENSOR_ALG_INTERFACE_H__
#define __SENSOR_ALG_INTERFACE_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <math.h>

#if defined(__CC_ARM)
    #pragma anon_unions
#elif defined(__ICCARM__)
    #pragma language=extended
#elif defined(__GNUC__)
/* Anonymous unions are enabled by default. */
#endif

#define SENSOR_TYPE_ACCELEROMETER                   (0)

#define SENSOR_TYPE_MAGNETIC_FIELD                  (1)

#define SENSOR_TYPE_PRESSURE                        (2)

#define SENSOR_TYPE_GYROSCOPE                       (3)

#define SENSOR_TYPE_PROXIMITY                       (4)

#define SENSOR_TYPE_BIOSENSOR_EKG                   (5)

#define SENSOR_TYPE_BIOSENSOR_EEG                   (6)

#define SENSOR_TYPE_BIOSENSOR_EMG                   (7)

#define SENSOR_TYPE_BIOSENSOR_GSR                   (8)

#define SENSOR_TYPE_BIOSENSOR_PPG1                  (9)

#define SENSOR_TYPE_BIOSENSOR_PPG2                  (10)

#define SENSOR_TYPE_BIOSENSOR_BISI                  (11)

#define SENSOR_TYPE_BIOSENSOR_PPG1_512HZ            (12)

#define SENSOR_PHYSICAL_TYPE_ALL                    (13)

#define SENSOR_VIRTUAL_TYPE_START                   (13)

#define SENSOR_TYPE_PEDOMETER                       (SENSOR_VIRTUAL_TYPE_START)

#define SENSOR_TYPE_ACTIVITY                        (SENSOR_VIRTUAL_TYPE_START+1)

#define SENSOR_TYPE_GESTURE_CHECK_TIME              (SENSOR_VIRTUAL_TYPE_START+2)

#define SENSOR_TYPE_GESTURE_TAP                     (SENSOR_VIRTUAL_TYPE_START+3)

#define SENSOR_TYPE_GESTURE_SHAKE                   (SENSOR_VIRTUAL_TYPE_START+4)

#define SENSOR_TYPE_GESTURE_TWIST                   (SENSOR_VIRTUAL_TYPE_START+5)

#define SENSOR_TYPE_FALL                            (SENSOR_VIRTUAL_TYPE_START+6)

#define SENSOR_TYPE_SLEEP                           (SENSOR_VIRTUAL_TYPE_START+7)

#define SENSOR_TYPE_PDR                             (SENSOR_VIRTUAL_TYPE_START+8)

#define SENSOR_TYPE_HEART_RATE_MONITOR              (SENSOR_VIRTUAL_TYPE_START+9)

#define SENSOR_TYPE_HEART_RATE_VARIABILITY_MONITOR  (SENSOR_VIRTUAL_TYPE_START+10)

#define SENSOR_TYPE_BLOOD_PRESSURE_MONITOR          (SENSOR_VIRTUAL_TYPE_START+11)

#define SENSOR_TYPE_SLEEP_STAGING                   (SENSOR_VIRTUAL_TYPE_START+12)

#define SENSOR_TYPE_MOTION_DETECT                   (SENSOR_VIRTUAL_TYPE_START+13)

#define SENSOR_TYPE_ELECTRIC_HEART_RATE_MONITOR     (SENSOR_VIRTUAL_TYPE_START+14)

#define SENSOR_TYPE_ALL                             (SENSOR_VIRTUAL_TYPE_START+15)

typedef enum {
    SENSOR_ACTIVITY_STILL, 
    SENSOR_ACTIVITY_STANDING, 
    SENSOR_ACTIVITY_SITTING, 
    SENSOR_ACTIVITY_LAYING, 
    SENSOR_ACTIVITY_ON_FOOT, 
    SENSOR_ACTIVITY_WALKING, 
    SENSOR_ACTIVITY_RUNNING, 
    SENSOR_ACTIVITY_CLIMBING, 
    SENSOR_ACTIVITY_ON_BICYCLE, 
    SENSOR_ACTIVITY_IN_VEHICLE, 
    SENSOR_ACTIVITY_TILTING, 
    SENSOR_ACTIVITY_UNKNOWN, 
    SENSOR_ACTIVITY_MAX 
} sensor_activity_type_t;

typedef enum {
    SENSOR_GESTURE_NONE,
    SENSOR_GESTURE_SHAKE, 
    SENSOR_GESTURE_TAP,
    SENSOR_GESTURE_TWIST,
    SENSOR_GESTURE_FLIP,
    SENSOR_GESTURE_SNAPSHOT,
    SENSOR_GESTURE_PICKUP,
    SENSOR_GESTURE_CHECK_TIME 
} sensor_gesture_type_t;

typedef enum {
    SENSOR_FALL_NONE, 
    SENSOR_FALL_FALL,
    SENSOR_FALL_FLOP,
    SENSOR_FALL_MAX
} sensor_fall_type_t;

typedef enum {
    SENSOR_REPORT_MODE_ON_CHANGE = 1, 
    SENSOR_REPORT_MODE_ONE_SHOT = 2, 
    SENSOR_REPORT_MODE_CONTINUOUS = 4 
} sensor_report_mode_t;

typedef enum {
    SENSOR_STATUS_NO_CONTACT = -1, 
    SENSOR_STATUS_UNRELIABLE = 0, 
    SENSOR_STATUS_ACCURACY_LOW = 1, 
    SENSOR_STATUS_ACCURACY_MEDIUM = 2, 
    SENSOR_STATUS_ACCURACY_HIGH = 3, 
} sensor_status_t;

typedef struct {
    union {
        int32_t v[3]; 
        struct {
            int32_t x; 
            int32_t y; 
            int32_t z; 
        };
        struct {
            int32_t azimuth; 
            int32_t pitch; 
            int32_t roll; 
        };
    };
    uint32_t status; 
    int32_t reserved[3]; 
} sensor_vec_t;

typedef struct {
    union {
        int32_t uncali[3]; 
        struct {
            int32_t x_uncali; 
            int32_t y_uncali; 
            int32_t z_uncali; 
        };
    };
    union {
        int32_t bias[3]; 
        struct {
            int32_t x_bias; 
            int32_t y_bias; 
            int32_t z_bias; 
        };
    };
} sensor_uncalibrated_event_t;

typedef struct {
    int32_t bpm; 
    int32_t status; 
} sensor_heart_rate_event_t;

typedef struct {
  int32_t SDNN; 
  int32_t LF; 
  int32_t HF; 
  int32_t LF_HF; 
  int32_t bpm; 
  int32_t status; 
  int32_t *beatPos; 
  int32_t numBeatPos;  
  int32_t feature_type; 
} sensor_heart_rate_variability_event_t;

typedef struct {
    int32_t sbp; 
    int32_t dbp; 
    int32_t bpm; 
    int32_t status; 
    int32_t *pwtt; 
    int32_t numPwtt;  
    int32_t feature_type; 
} sensor_blood_pressure_event_t;

typedef struct {
    int32_t type; 
    uint32_t data; 
} sensor_bio_t;

typedef struct {
    int32_t probability[SENSOR_ACTIVITY_MAX]; 
} sensor_activity_t;

typedef struct {
    int32_t probability; 
} sensor_gesture_t;

typedef struct {
    uint32_t accumulated_step_count; 
    uint32_t accumulated_step_length; 
    uint32_t step_frequency; 
    uint32_t step_length; 
    uint8_t step_type;
} sensor_pedometer_event_t;

typedef struct {
    int32_t pressure; 
    int32_t temperature; 
    uint32_t status; 
} sensor_pressure_vec_t;

typedef struct {
    int32_t relative_humidity; 
    int32_t temperature; 
    uint32_t status; 
} sensor_relative_humidity_vec_t;

typedef struct {
    int32_t state; 
    int32_t *feature; 
    int32_t feature_num;  
    int32_t feature_type; 
} sensor_sleepmonitor_event_t;

typedef struct {
    int32_t probability[SENSOR_FALL_MAX];  
} sensor_fall_t;

typedef struct {
    uint32_t sensor_type; 
    uint32_t time_stamp; 
    union {
        union {
            sensor_vec_t accelerometer_t; 
            sensor_vec_t gyroscope_t; 
            sensor_vec_t magnetic_t; 
            sensor_vec_t orientation_t; 
            sensor_vec_t pdr_event; 
            int32_t light; 
            int32_t distance; 
            sensor_pressure_vec_t pressure_t; 
            sensor_relative_humidity_vec_t relative_humidity_t; 
            sensor_uncalibrated_event_t uncalibrated_acc_t; 
            sensor_uncalibrated_event_t uncalibrated_mag_t; 
            sensor_uncalibrated_event_t uncalibrated_gyro_t; 
            sensor_pedometer_event_t pedometer_t; 
            sensor_heart_rate_event_t heart_rate_t; 
            sensor_heart_rate_variability_event_t heart_rate_variability_t; 
            sensor_blood_pressure_event_t blood_pressure_t; 
            sensor_sleepmonitor_event_t sleep_data_t; 
            sensor_activity_t activity_data_t; 
            sensor_gesture_t gesture_data_t; 
            sensor_fall_t fall_data_t; 
            sensor_bio_t bio_data; 
            int32_t value[16]; 
        };
        union {
            uint64_t data[8]; 
            uint64_t step_counter; 
        };
    };
} sensor_data_unit_t;

typedef struct sensor_data {
    sensor_data_unit_t *data; 
    uint32_t fifo_max_size; 
    uint32_t data_exist_count; 
} sensor_data_t;

typedef struct sensor_input_list {
    uint32_t input_type; 
    uint32_t sampling_delay; 
    struct sensor_input_list *next_input; 
    uint32_t timeout; 
} sensor_input_list_t;

typedef int32_t (*sensor_descriptor_operate_callback_t)(int32_t command, void *buffer_out, int32_t size_out, void *buffer_in, int32_t size_in);

typedef int32_t (*sensor_descriptor_get_result_callback_t)(sensor_data_t *const output);

typedef int32_t (*sensor_descriptor_process_data_callback_t)(const sensor_data_t *input_list, void *reserved);

typedef struct sensor_descriptor {
    uint32_t sensor_type; 
    int32_t version; 
    int32_t report_mode; 
    sensor_input_list_t *input_list; 
    sensor_descriptor_operate_callback_t operate; 
    sensor_descriptor_get_result_callback_t get_result; 
    sensor_descriptor_process_data_callback_t process_data; 
    int32_t accumulate; 
} sensor_descriptor_t;

int32_t sensor_fusion_algorithm_register_type(const sensor_descriptor_t *desp);

int32_t sensor_fusion_algorithm_register_data_buffer(uint32_t sensor_type, uint32_t exist_data_count);

int32_t sensor_fusion_algorithm_notify(uint32_t sensor_type);

#define SENSOR_DEFAULT_DELAY    (200)

#define SENSOR_DELAY        0x01

#define SENSOR_ENABLE       0x02

#define SENSOR_GET_DATA     0x04

#define SENSOR_CUST     0x08

#define SENSOR_BATCH     0x10

typedef int32_t (*sensor_driver_object_operate_callback_t)(void *self, uint32_t command, void *buff_out, int32_t size_out, int32_t *actual_out,
        void *buff_in, int32_t size_in);
typedef struct sensor_driver_object {
    void *self; 
    int32_t polling; 
    sensor_driver_object_operate_callback_t sensor_operate; 
} sensor_driver_object_t;

int32_t sensor_driver_attach(uint32_t sensor_type, sensor_driver_object_t *obj);

typedef int32_t (*sensor_subscriber_send_digest_callback_t)(sensor_data_t *const output);

#define SENSOR_MAX_SUBSCRIBER_NAME_LEN          ( 8 )

typedef struct sensor_subscriber {
    char name[SENSOR_MAX_SUBSCRIBER_NAME_LEN]; 
    int32_t handle; 
    uint32_t type; 
    uint32_t delay; 
    sensor_subscriber_send_digest_callback_t send_digest; 
    uint32_t timeout; 
} sensor_subscriber_t;

int32_t sensor_manager_init(void);

int32_t sensor_get_latest_sensor_data(uint32_t type, sensor_data_t *const output);

int32_t sensor_subscribe_sensor(sensor_subscriber_t *subscriber);

int32_t sensor_unsubscribe_sensor(int32_t handle);

int sensor_manager_set_cust_from_app(uint32_t sensor_type, void *in_data_buf, int32_t in_size);

#ifdef __cplusplus
}
#endif

#endif /*__SENSOR_ALG_INTERFACE_H__*/