sensor_api.h

/****************************************************************************
 * modules/include/sensing/sensor_api.h
 *
 *   Copyright 2018 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#ifndef __INCLUDE_SENSING_SENSOR_API_H
#define __INCLUDE_SENSING_SENSOR_API_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <sdk/config.h>
 
#ifdef __cplusplus
/* MemoryManager can used only C++.
 * If you use Memory Manager Library
 * to be selected from kconfig
 */
#include "memutils/memory_manager/MemHandle.h"
#endif
#include "memutils/message/MsgPacket.h"
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
/*--------------------------------------------------------------------
 *  Command Structure
 *
 * This is Sensor Control Command for Sensor Manager
 *
 * the Sensor Manager is controlled from commands.
 * follow is these commands.
  --------------------------------------------------------------------*/
typedef struct
{
  unsigned int size    : 8;               
  unsigned int code    : 8;               
  unsigned int reserve : 16;              
#ifdef __cplusplus
  unsigned int get_code(void)
  {
    return(code);
  }
#endif /* __cplusplus */
 
} sensor_command_header_t;
 
/*--------------------------------------------------------------------------*/
typedef struct
{
  sensor_command_header_t header;  
  unsigned int self : 8;           
  unsigned int time : 24;          
  unsigned int fs   : 16;          
  unsigned int size : 16;          
  bool         is_ptr;             
  union
    {
      uint32_t data;               
      void*    adr;                
    };
 
#ifdef __cplusplus
  unsigned int get_self(void)
    {
      return self;
    }
#endif /* __cplusplus */
 
} sensor_command_data_t;
 
/*--------------------------------------------------------------------------*/
#ifdef __cplusplus
typedef struct
{
  sensor_command_header_t header;  
  unsigned int self : 8;           
  unsigned int time : 24;          
  unsigned int fs   : 16;          
  unsigned int size : 16;          
/* If you use Memory Manager Library to be selected from kconfig */
 
  MemMgrLite::MemHandle  mh;       
  unsigned int get_self(void)
    {
      return self;
    }
} sensor_command_data_mh_t;
 
#endif /* __cplusplus */
 
/*--------------------------------------------------------------------------*/
typedef bool (*sensor_data_callback_t)(sensor_command_data_t&);
 
/*--------------------------------------------------------------------------*/
typedef bool (*sensor_data_mh_callback_t)(sensor_command_data_mh_t&);
 
 
/*--------------------------------------------------------------------------*/
#ifdef CONFIG_SENSING_MANAGER_POWERCTRL
typedef bool (*sensor_power_callback_t)(bool);
#endif /* CONFIG_SENSING_MANAGER_POWERCTRL */
 
/*--------------------------------------------------------------------------*/
typedef void (*api_response_callback_t)(unsigned int code,
                                        unsigned int ercd,
                                        unsigned int self_id);
 
/*--------------------------------------------------------------------------*/
typedef struct
{
  sensor_command_header_t header;         
  unsigned int self: 8;                   
  unsigned int subscriptions: 24;         
  sensor_data_callback_t    callback;     
  sensor_data_mh_callback_t callback_mh;  
#ifdef CONFIG_SENSING_MANAGER_POWERCTRL
  sensor_power_callback_t   callback_pw;  
#endif /* CONFIG_SENSING_MANAGER_POWERCTRL */
 
  unsigned int get_self(void)
    {
      return self;
    }
 
  unsigned int get_subscriptions(void)
    {
      return subscriptions;
    }
} sensor_command_register_t;
 
/*--------------------------------------------------------------------*/
typedef struct
{
  sensor_command_header_t header;         
  unsigned int self;                      
  unsigned int get_self(void)
    {
      return self;
    }
} sensor_command_release_t;
 
/*--------------------------------------------------------------------*/
typedef struct
{
  sensor_command_header_t header;         
  unsigned int self          : 8;         
  unsigned int subscriptions : 24;        
  bool add;                               
  unsigned int get_self(void)
    {
      return self;
    }
 
  unsigned int get_subscriptions(void)
    {
      return subscriptions;
    }
} sensor_command_change_subscription_t;
 
/*--------------------------------------------------------------------*/
typedef struct
{
  sensor_command_header_t header;         
  unsigned int self : 8;                  
  unsigned int time : 24;                 
  unsigned int data;                      
  unsigned int get_self(void)
    {
      return self;
    }
} sensor_command_result_t;
 
/*--------------------------------------------------------------------------*/
#ifdef CONFIG_SENSING_MANAGER_POWERCTRL
typedef struct
{
  sensor_command_header_t header;         
  unsigned int self: 8;                   
  unsigned int subscriptions: 24;         
  unsigned int get_self(void)
  {
    return self;
  }
 
  unsigned int get_subscriptions(void)
  {
    return subscriptions;
  }
 
} sensor_command_power_t;
 
#endif /* CONFIG_SENSING_MANAGER_POWERCTRL */
 
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------
    Command(Evant) Code.
  --------------------------------------------------------------------*/
enum SensorCommandCode
{
  ResisterClient = 0,                     
  ReleaseClient,                          
  ChangeSubscription,                     
#ifdef CONFIG_SENSING_MANAGER_POWERCTRL
  SetPower,
 
  ClearPower,
#endif /* CONFIG_SENSING_MANAGER_POWERCTRL */ 
 
  SendData,
 
  SendDataMH,
 
  SendResult,
 
  SensorCommandMum
};
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*--------------------------------------------------------------------
    External Sensor Manager Interface
  --------------------------------------------------------------------*/
extern bool SS_ActivateSensorSubSystem(MsgQueId selfMId,
                                       api_response_callback_t callback);
 
extern bool SS_DeactivateSensorSubSystem();
 
extern void SS_SendSensorData(FAR sensor_command_data_t *packet);
 
extern void SS_SendSensorResult(FAR sensor_command_result_t *packet);
 
extern void SS_SendSensorResister(FAR sensor_command_register_t *packet);
 
#ifdef CONFIG_SENSING_MANAGER_POWERCTRL
extern void SS_SendSensorSetPower(FAR sensor_command_power_t *packet);
extern void SS_SendSensorClearPower(FAR sensor_command_power_t *packet);
 
#endif /* CONFIG_SENSING_MANAGER_POWERCTRL */
 
extern void SS_SendSensorRelease(FAR sensor_command_release_t *packet);
 
extern void SS_SendSensorChangeSubscription(FAR sensor_command_change_subscription_t *packet);
 
#ifdef __cplusplus
 
extern void SS_SendSensorDataMH(FAR sensor_command_data_mh_t *packet);
 
} /* extern "C" */
#endif /* __cplusplus */
 
#endif /* __INCLUDE_SENSING_SENSOR_API_H */