summaryrefslogtreecommitdiff
path: root/sensors/Pedometer/Device.h
blob: 593e0b95c5165181b57584475fb58fc42cf33896 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
//Copyright (C) Microsoft Corporation, All Rights Reserved
//
//Abstract:
//
//    This module contains the type definitions for the client
//    driver's device callback class.
//
//Environment:
//
//    Windows User-Mode Driver Framework (UMDF)

#pragma once

#include <windows.h>
#include <wdf.h>
#include <math.h>

#include "SensorsTrace.h"
#include <SensorsCx.h>
#include <SensorsUtils.h>

#define SENSOR_POOL_TAG_PEDOMETER 'odeP'

#define Pedometer_Default_MinDataInterval_Ms  (100) // milliseconds
#define Pedometer_Default_Threshold_StepCount (1) // threshold in step counts
#define Pedometer_Default_Power_Milliwatts    (2.0f) // milli watts
#define Pedometer_TimeoutForHistoryThread_Ms  (1000) // milli seconds
#define Pedometer_Default_HistoryInterval_Ms  (60000) // 1 minute in milli seconds
#define Pedometer_Default_MaxHistoryEntries   (60) // max of 60 history entries

// Sensor Common Properties
typedef enum
{
    SENSOR_PROPERTY_STATE = 0,
    SENSOR_PROPERTY_MIN_INTERVAL,
    SENSOR_PROPERTY_MAX_DATAFIELDSIZE,
    SENSOR_PROPERTY_SENSOR_TYPE,
    SENSOR_PROPERTY_SENSOR_POWER,
    SENSOR_PROPERTY_MAX_HISTORYSIZE,
    SENSOR_PROPERTY_HISTORY_INTERVAL,
    SENSOR_PROPERTY_MAX_HISTROYRECORDSIZE,
    SENSOR_PROPERTY_SUPPORTED_STEPTYPES,
    SENSOR_COMMON_PROPERTIES_COUNT
} SENSOR_COMMON_PROPERTIES_INDEX;

// Sensor Enumeration Properties
typedef enum
{
    SENSOR_TYPE_GUID = 0,
    SENSOR_MANUFACTURER,
    SENSOR_MODEL,
    SENSOR_PERSISTENT_UNIQUEID,
    SENSOR_CATEGORY,
    SENSOR_ISPRIMARY,

    // These enumeration properties overlap with
    // a subset of the common properties, and
    // facilitate discovery without opening a sensor
    SENSOR_POWER,
    SENSOR_MAX_HISTORYSIZE,
    SENSOR_SUPPORTED_STEPTYPES,
    SENSOR_ENUMERATION_PROPERTIES_COUNT
} SENSOR_ENUMERATION_PROPERTIES_INDEX;

// Data-field Properties
typedef enum
{
    SENSOR_RESOLUTION = 0,
    SENSOR_MIN_RANGE,
    SENSOR_MAX_RANGE,
    SENSOR_DATA_FIELD_PROPERTY_COUNT
} SENSOR_DATA_FIELD_PROPERTY_INDEX;

// Supported Data Fields
typedef enum
{
    PEDOMETER_DATAFIELD_TIMESTAMP = 0,
    PEDOMETER_DATAFIELD_FIRST_AFTER_RESET,
    PEDOMETER_DATAFIELD_STEP_TYPE,
    PEDOMETER_DATAFIELD_STEP_COUNT,
    PEDOMETER_DATAFIELD_STEP_DURATION,
    PEDOMETER_DATAFIELD_COUNT
} PEDOMETER_DATAFIELD_INDEX;

// Supported Data
typedef enum
{
    PEDOMETER_DATA_TIMESTAMP = 0,
    PEDOMETER_DATA_FIRST_AFTER_RESET,
    PEDOMETER_DATA_UNKNOWN_STEP_TYPE,
    PEDOMETER_DATA_UNKNOWN_STEP_COUNT,
    PEDOMETER_DATA_UNKNOWN_STEP_DURATION,
    PEDOMETER_DATA_WALKING_STEP_TYPE,
    PEDOMETER_DATA_WALKING_STEP_COUNT,
    PEDOMETER_DATA_WALKING_STEP_DURATION,
    PEDOMETER_DATA_RUNNING_STEP_TYPE,
    PEDOMETER_DATA_RUNNING_STEP_COUNT,
    PEDOMETER_DATA_RUNNING_STEP_DURATION,
    PEDOMETER_DATA_COUNT
} PEDOMETER_DATA_INDEX;

typedef enum
{
    PEDOMETER_THRESHOLD_STEP_COUNT = 0,
    PEDOMETER_THRESHOLD_COUNT
} PEDOMETER_THRESHOLD_INDEX;

typedef struct PedometerSample
{
    FILETIME            Timestamp;
    BOOL                IsFirstAfterReset;
    ULONG               UnknownStepCount;
    INT64               UnknownStepDurationMs;
    ULONG               WalkingStepCount;
    INT64               WalkingStepDurationMs;
    ULONG               RunningStepCount;
    INT64               RunningStepDurationMs;
} PedometerSample, *PPedometerSample;

// History buffer
typedef struct
{
    PPedometerSample pData;
    ULONG FirstElemIndex; // index of the oldest entry
    ULONG LastElemIndex; // index of the latest entry
    ULONG NumOfElems; // number of entries
    ULONG BufferLength; // length of the buffer
} HistoryCircBuffer, *PHistoryCircBuffer;


typedef class PedometerDevice
{
private:
    // Simulator
    WDFOBJECT                   m_SimulatorInstance;

    // WDF
    WDFDEVICE                   m_FxDevice;
    SENSOROBJECT                m_SensorInstance;
    WDFWAITLOCK                 m_Lock;
    WDFTIMER                    m_Timer;

    // Sensor operation
    BOOLEAN                     m_PoweredOn;
    BOOLEAN                     m_Started;
    ULONG                       m_Interval;

    BOOLEAN                     m_FirstSample;
    ULONG                       m_StartTime;
    ULONGLONG                   m_SampleCount;

    ULONG                       m_CachedThreshold;
    PedometerSample             m_LastSample;

    // History operation
    BOOLEAN                     m_HistorySupported;
    BOOLEAN                     m_HistoryRetrievalStarted;
    ULONG                       m_HistoryMarshalledRecordSize;
    HANDLE                      m_hThread;

    PSENSOR_COLLECTION_LIST     m_ClientHistoryBuffer;
    ULONG                       m_ClientHistoryBufferSize;

    // Sensor Specific Properties
    PSENSOR_COLLECTION_LIST     m_pEnumerationProperties;
    PSENSOR_COLLECTION_LIST     m_pProperties;
    PSENSOR_PROPERTY_LIST       m_pSupportedDataFields;
    PSENSOR_COLLECTION_LIST     m_pDataFieldProperties;
    PSENSOR_COLLECTION_LIST     m_pThresholds;
    PSENSOR_COLLECTION_LIST     m_pData;

public:
    // WDF callbacks
    static EVT_WDF_DRIVER_DEVICE_ADD                OnDeviceAdd;
    static EVT_WDF_DEVICE_PREPARE_HARDWARE          OnPrepareHardware;
    static EVT_WDF_DEVICE_RELEASE_HARDWARE          OnReleaseHardware;
    static EVT_WDF_DEVICE_D0_ENTRY                  OnD0Entry;
    static EVT_WDF_DEVICE_D0_EXIT                   OnD0Exit;
    static EVT_WDF_TIMER                            OnTimerExpire;

    // CLX callbacks
    static EVT_SENSOR_DRIVER_START_SENSOR               OnStart;
    static EVT_SENSOR_DRIVER_STOP_SENSOR                OnStop;
    static EVT_SENSOR_DRIVER_GET_SUPPORTED_DATA_FIELDS  OnGetSupportedDataFields;
    static EVT_SENSOR_DRIVER_GET_PROPERTIES             OnGetProperties;
    static EVT_SENSOR_DRIVER_GET_DATA_FIELD_PROPERTIES  OnGetDataFieldProperties;
    static EVT_SENSOR_DRIVER_GET_DATA_INTERVAL          OnGetDataInterval;
    static EVT_SENSOR_DRIVER_SET_DATA_INTERVAL          OnSetDataInterval;
    static EVT_SENSOR_DRIVER_GET_DATA_THRESHOLDS        OnGetDataThresholds;
    static EVT_SENSOR_DRIVER_SET_DATA_THRESHOLDS        OnSetDataThresholds;
    static EVT_SENSOR_DRIVER_DEVICE_IO_CONTROL          OnIoControl;
    static EVT_SENSOR_DRIVER_START_SENSOR_HISTORY       OnStartHistory;
    static EVT_SENSOR_DRIVER_STOP_SENSOR_HISTORY        OnStopHistory;
    static EVT_SENSOR_DRIVER_CLEAR_SENSOR_HISTORY       OnClearHistory;
    static EVT_SENSOR_DRIVER_START_HISTORY_RETRIEVAL    OnStartHistoryRetrieval;
    static EVT_SENSOR_DRIVER_CANCEL_HISTORY_RETRIEVAL   OnCancelHistoryRetrieval;
private:

    NTSTATUS                    Initialize(_In_ WDFDEVICE Device, _In_ SENSOROBJECT SensorObj);
    NTSTATUS                    GetData();
    VOID                        ResetPedometer();
    static ULONG WINAPI HistoryRetrievalThread(_In_ LPVOID lpParam);

} PedometerDevice, *PPedometerDevice;

// Set up accessor function to retrieve device context
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(PedometerDevice, GetPedometerContextFromSensorInstance);

#define PedometerDevice_StepCount_Resolution           (1)
#define PedometerDevice_StepCount_Minimum              (0)
#define PedometerDevice_StepCount_Maximum              (0xFFFFFFFF)