ISF  2.2 rev 5
Intelligent Sensing Framework for Kinetis with Processor Expert
isf_dsa_adapter.h File Reference
#include "isf.h"
#include "isf_sysconf_types.h"
#include "isf_sensor_types.h"
#include "isf_fifo.h"
Include dependency graph for isf_dsa_adapter.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  isf_dsa_DeviceInfoBlock_st
 This defines the DSA adapter device information block. More...
 
struct  isf_dsa_SensorSettings_st
 This defines the DSA sensor configuration parameter structure configuring the sensor settings by a subscriber task. More...
 
struct  isf_dsa_ControlData_st
 This defines the DSA adapter functional interface. More...
 
struct  isf_SensorHandle_st
 This defines the DSA sensor device handle structure used to invoke the adapter access functions. More...
 
struct  isf_dsa_info_t
 
struct  isf_dsa_ControlInterface_st
 This defines the DSA adapter control interface abstract function list. More...
 
struct  isf_dsa_Adapter_st
 This defines the DSA adapter structure required for static initialization of the concrete instance of a given sensor adapter. 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 isf_dsa_status_t
 This is the Sensor Manager API return type definition. More...
 
typedef enum isf_dsa_error_enums isf_dsa_err_t
 This enumerates the error types returned by the DSA sensor functions. More...
 
typedef enum isf_dsa_result_enums isf_dsa_result_types_t
 
typedef enum isf_dsa_AdapterStatus_enums isf_dsa_AdapterStatus_t
 This defines the standard DSA adapter sensor status types. User defined sensor adapters may need additional or different states. More...
 
typedef struct isf_dsa_DeviceInfoBlock_st isf_dsa_DeviceInfoBlock_t
 This defines the DSA adapter device information block. More...
 
typedef struct isf_dsa_SensorSettings_st isf_dsa_SensorSettings_t
 This defines the DSA sensor configuration parameter structure configuring the sensor settings by a subscriber task. More...
 
typedef struct isf_dsa_ControlData_st isf_dsa_ControlData_t
 This defines the DSA adapter functional interface. More...
 
typedef struct SensorConfig_st isf_SensorConfig_t
 
typedef struct isf_SensorHandle_st isf_SensorHandle_t
 This defines the DSA sensor device handle structure used to invoke the adapter access functions. More...
 
typedef isf_dsa_status_tisf_dsa_data_converter_t) (volatile isf_SensorHandle_t *, isf_SensorDataTypes_t, isf_dsa_result_types_t, void *, void *, int32 *numBytes)
 
typedef struct isf_dsa_ControlInterface_st isf_dsa_ControlInterface_t
 This defines the DSA adapter control interface abstract function list. More...
 
typedef struct isf_dsa_Adapter_st isf_dsa_Adapter_t
 This defines the DSA adapter structure required for static initialization of the concrete instance of a given sensor adapter. More...
 

Enumerations

enum  isf_dsa_error_enums {
  DSA_ERR_INITIALIZE = 1, DSA_ERR_VALIDATE_SETTINGS, DSA_ERR_CONFIGURE, DSA_ERR_START_DATA,
  DSA_ERR_END_DATA, DSA_ERR_CALIBRATE, DSA_ERR_SHUTDOWN, DSA_ERR_PARAM,
  DSA_ERR_NO_MEM, DSA_ERR_BAD_SENSOR_DATA_TYPE, DSA_ERR_BAD_RESULT_TYPE, DSA_RET_SETTINGS_CHANGED,
  DSA_FIFO_FULL
}
 This enumerates the error types returned by the DSA sensor functions. More...
 
enum  isf_dsa_result_enums { DSA_RESULT_TYPE_RAW_COUNTS = 1, DSA_RESULT_TYPE_ENG_FIXED = 2, DSA_RESULT_TYPE_ENG_FLOAT = 3 }
 
enum  isf_dsa_AdapterStatus_enums { DSA_STATE_NOT_INITIALIZED = 0, DSA_STATE_INITIALIZED = 1, DSA_STATE_CONFIGURED_STOPPED = 2, DSA_STATE_CONFIGURED_STARTED = 3 }
 This defines the standard DSA adapter sensor status types. User defined sensor adapters may need additional or different states. More...
 

Typedef Documentation

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

This defines the standard DSA adapter sensor status types. User defined sensor adapters may need additional or different states.

This defines the DSA adapter functional interface.

This defines the DSA adapter control interface abstract function list.

typedef isf_dsa_status_t( isf_dsa_data_converter_t) (volatile isf_SensorHandle_t *, isf_SensorDataTypes_t, isf_dsa_result_types_t, void *, void *, int32 *numBytes)

Definition at line 121 of file isf_dsa_adapter.h.

This defines the DSA adapter device information block.

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

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

This is the Sensor Manager API return type definition.

Definition at line 21 of file isf_dsa_adapter.h.

Definition at line 101 of file isf_dsa_adapter.h.

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

Enumeration Type Documentation

This defines the standard DSA adapter sensor status types. User defined sensor adapters may need additional or different states.

Enumerator
DSA_STATE_NOT_INITIALIZED 
DSA_STATE_INITIALIZED 
DSA_STATE_CONFIGURED_STOPPED 
DSA_STATE_CONFIGURED_STARTED 

Definition at line 56 of file isf_dsa_adapter.h.

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

Enumerator
DSA_ERR_INITIALIZE 

Adapter initialize error.

DSA_ERR_VALIDATE_SETTINGS 

Adapter settings validation error.

DSA_ERR_CONFIGURE 

Driver configuration error.

DSA_ERR_START_DATA 

Adapter data start error.

DSA_ERR_END_DATA 

Adapter data end error.

DSA_ERR_CALIBRATE 

Adapter calibration error.

DSA_ERR_SHUTDOWN 

Adapter shutdown error.

DSA_ERR_PARAM 

Adapter parameter error.

DSA_ERR_NO_MEM 

A dynamic memory allocation request failed

DSA_ERR_BAD_SENSOR_DATA_TYPE 

The requested sensor data type is not supported

DSA_ERR_BAD_RESULT_TYPE 

The requested result type is not supported

DSA_RET_SETTINGS_CHANGED 

Requested settings were changed for compatibility

DSA_FIFO_FULL 

The FIFO has reached its maximum depth

Definition at line 27 of file isf_dsa_adapter.h.

Enumerator
DSA_RESULT_TYPE_RAW_COUNTS 
DSA_RESULT_TYPE_ENG_FIXED 
DSA_RESULT_TYPE_ENG_FLOAT 

Definition at line 45 of file isf_dsa_adapter.h.