ISF  1.1
Intelligent Sensing Framework
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Include/isf_sm_dsa_adapter.h File Reference

The isf_sm_dsa_adapter.h contains the data types and enumerations used by the Sensor Manager and the Digital Sensor Abstraction (DSA) implementation. More...

#include "isf_types.h"
#include <mqx.h>
#include "lwevent.h"
#include "isf_sysconf_types.h"

Go to the source code of this file.

Data Structures

struct  sm_dsa_ControlInterface_st
 This defines the DSA adapter control interface abstract function list. More...
struct  sm_dsa_DeviceInfoBlock_st
 This defines the DSA adapter device information block. More...
struct  sm_dsa_FunctionalInterface_st
 This defines the DSA adapter functional interface. More...
struct  sm_Dsa_SensorStatus_st
 This defines the DSA adapter sensor status bit-field structure. More...
struct  sm_DsaAdapter_st
 This defines the DSA adapter structure required for static initialization of the concrete instance of a given sensor adapter. More...
struct  sm_SensorConfigSettings_st
 This defines the DSA sensor configuration parameter structure configuring the sensor settings by a subscriber task. More...
struct  sm_DevConfigHdr_St
 This defines the DSA sensor device configuration header structure used for adapter initial configuration. More...
struct  sm_SensorHandle_St
 This is defines the DSA sensor device handle structure to invoke the adapter access functions. More...
struct  SensorConfig_st
 This defines the DSA sensor configuration structure defining each individual sensor adapter in the DSA Sensor List. More...

Typedefs

typedef int32 sm_status_t
 This is the Sensor Manager API return type definition.
typedef enum sm_dsa_error_types sm_dsa_err_t
 This enumerates the error types returned by the DSA sensor functions.
typedef struct
sm_dsa_ControlInterface_st 
sm_dsa_ControlInterface_t
 This defines the DSA adapter control interface abstract function list.
typedef struct
sm_dsa_DeviceInfoBlock_st 
sm_dsa_DeviceInfoBlock_t
 This defines the DSA adapter device information block.
typedef struct
sm_dsa_FunctionalInterface_st 
sm_dsa_FunctionalInterface_t
 This defines the DSA adapter functional interface.
typedef struct
sm_Dsa_SensorStatus_st 
sm_DsaAdapterStatus_t
 This defines the DSA adapter sensor status bit-field structure.
typedef struct sm_DsaAdapter_st sm_DsaAdapter_t
 This defines the DSA adapter structure required for static initialization of the concrete instance of a given sensor adapter.
typedef struct
sm_SensorConfigSettings_st 
SM_SensorConfigSettings_t
 This defines the DSA sensor configuration parameter structure configuring the sensor settings by a subscriber task.
typedef struct sm_DevConfigHdr_St sm_DevConfigHdr_t
 This defines the DSA sensor device configuration header structure used for adapter initial configuration.
typedef struct sm_SensorHandle_St sm_SensorHandle_t
 This is defines the DSA sensor device handle structure to invoke the adapter access functions.
typedef struct SensorConfig_st SensorConfig_t
 This defines the DSA sensor configuration structure defining each individual sensor adapter in the DSA Sensor List.

Enumerations

enum  sm_dsa_error_types {
  SM_DSA_ERR_INITIALIZE = 1, SM_DSA_ERR_VALIDATE_SETTINGS, SM_DSA_ERR_CONFIGURE, SM_DSA_ERR_START_DATA,
  SM_DSA_ERR_END_DATA, SM_DSA_ERR_CALIBRATE, SM_DSA_ERR_PARAM
}
 This enumerates the error types returned by the DSA sensor functions. More...

Detailed Description

The isf_sm_dsa_adapter.h contains the data types and enumerations used by the Sensor Manager and the Digital Sensor Abstraction (DSA) implementation.

Definition in file isf_sm_dsa_adapter.h.


Typedef Documentation

This defines the DSA sensor configuration structure defining each individual sensor adapter in the DSA Sensor List.

This defines the DSA sensor device configuration header structure used for adapter initial configuration.

This defines the DSA adapter control interface abstract function list.

This defines the DSA adapter device information block.

This enumerates the error types returned by the DSA sensor functions.

This defines the DSA adapter functional interface.

This defines the DSA adapter structure required for static initialization of the concrete instance of a given sensor adapter.

This defines the DSA adapter sensor status bit-field structure.

This defines the DSA sensor configuration parameter structure configuring the sensor settings by a subscriber task.

This is defines the DSA sensor device handle structure to invoke the adapter access functions.

typedef int32 sm_status_t

This is the Sensor Manager API return type definition.

Definition at line 20 of file isf_sm_dsa_adapter.h.


Enumeration Type Documentation

This enumerates the error types returned by the DSA sensor functions.

Enumerator:
SM_DSA_ERR_INITIALIZE 

Adapter initialize error.

SM_DSA_ERR_VALIDATE_SETTINGS 

Adapter settings validation error.

SM_DSA_ERR_CONFIGURE 

Adapter configuration error.

SM_DSA_ERR_START_DATA 

Adapter data start error.

SM_DSA_ERR_END_DATA 

Adapter data end error.

SM_DSA_ERR_CALIBRATE 

Adapter calibration error.

SM_DSA_ERR_PARAM 

Adapter parameter error.

Definition at line 26 of file isf_sm_dsa_adapter.h.