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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
//Copyright (C) Microsoft Corporation, All Rights Reserved.
//
//Abstract:
//
// This module contains the implementation of the simple device orientation sensor sample
// hardware simulator.
//
//Environment:
//
// Windows User-Mode Driver Framework (UMDF)
#include "HardwareSimulator.h"
#include "HardwareSimulator.tmh"
// Simulated device orientations
const ABI::Windows::Devices::Sensors::SimpleOrientation OrientationData[] = {
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Facedown,
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_NotRotated,
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Faceup,
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Rotated90DegreesCounterclockwise,
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Facedown,
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Rotated180DegreesCounterclockwise,
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Faceup,
ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Rotated270DegreesCounterclockwise
};
HardwareSimulator::_HardwareSimulator() :
m_Index(0),
m_Lock(NULL),
m_State(SimulatorState_NotInitialized),
m_SimulatorInstance(NULL),
m_Timer(NULL)
{
}
HardwareSimulator::~_HardwareSimulator()
{
}
// This static routine performs simulator initialization. The routine creates a
// timer object that periodically updates the m_Index location
// Returns an NTSTATUS code
NTSTATUS HardwareSimulator::Initialize(
_In_ WDFDEVICE Device, // WDF device representing the sensor
_Out_ WDFOBJECT *SimulatorInstance) // Instance of the WDF object for the simulator
{
PHardwareSimulator pSimulator = nullptr;
NTSTATUS Status = STATUS_SUCCESS;
WDF_OBJECT_ATTRIBUTES HardwareSimulatorAttributes = {};
SENSOR_FunctionEnter();
// Create WDFOBJECT for the hardware simulator
WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&HardwareSimulatorAttributes, HardwareSimulator);
HardwareSimulatorAttributes.ParentObject = Device;
Status = WdfObjectCreate(&HardwareSimulatorAttributes, SimulatorInstance);
if (!NT_SUCCESS(Status))
{
TraceError("SDOS %!FUNC! WdfObjectCreate failed %!STATUS!", Status);
goto Exit;
}
pSimulator = GetHardwareSimulatorContextFromInstance(*SimulatorInstance);
if (nullptr == pSimulator)
{
Status = STATUS_INSUFFICIENT_RESOURCES;
TraceError("SDOS %!FUNC! GetHardwareSimulatorContextFromInstance failed %!STATUS!", Status);
goto Exit;
}
pSimulator->InitializeInternal(*SimulatorInstance);
Exit:
SENSOR_FunctionExit(Status);
return Status;
}
// Internal routine to perform simulator initialization
// Returns an NTSTATUS code
NTSTATUS HardwareSimulator::InitializeInternal(
_In_ WDFOBJECT SimulatorInstance) // Instance of the WDF object for the simulator
{
NTSTATUS Status = STATUS_SUCCESS;
WDF_OBJECT_ATTRIBUTES TimerAttributes = {};
WDF_TIMER_CONFIG TimerConfig = {};
SENSOR_FunctionEnter();
// Only initialize the simulator if it is in the "not initialized" state
if (SimulatorState_NotInitialized == m_State)
{
// Create Lock
Status = WdfWaitLockCreate(WDF_NO_OBJECT_ATTRIBUTES, &m_Lock);
if (!NT_SUCCESS(Status))
{
m_Lock = NULL;
TraceError("SDOS %!FUNC! WdfWaitLockCreate failed %!STATUS!", Status);
goto Exit;
}
// Create a timer object for simulation updates
WDF_TIMER_CONFIG_INIT(&TimerConfig, HardwareSimulator::OnTimerExpire);
WDF_OBJECT_ATTRIBUTES_INIT(&TimerAttributes);
TimerAttributes.ParentObject = SimulatorInstance;
TimerAttributes.ExecutionLevel = WdfExecutionLevelPassive;
Status = WdfTimerCreate(&TimerConfig, &TimerAttributes, &m_Timer);
if (!NT_SUCCESS(Status))
{
m_Timer = NULL;
TraceError("SDOS %!FUNC! WdfTimerCreate failed %!STATUS!", Status);
goto Exit;
}
// Set the simulator state to "initialized"
m_State = SimulatorState_Initialized;
m_SimulatorInstance = SimulatorInstance;
}
Exit:
if (!NT_SUCCESS(Status) && NULL != m_Lock)
{
WdfObjectDelete(m_Lock);
m_Lock = NULL;
}
SENSOR_FunctionExit(Status);
return Status;
}
// This routine perform a simulator cleanup
// Returns an NTSTATUS code
NTSTATUS HardwareSimulator::Cleanup()
{
NTSTATUS status = STATUS_SUCCESS;
if (SimulatorState_Started == m_State)
{
Stop();
}
// Delete lock
if (NULL != m_Lock)
{
WdfObjectDelete(m_Lock);
m_Lock = NULL;
}
// Set the simulator state to "not initialized"
m_State = SimulatorState_NotInitialized;
return status;
}
// This routine starts the simulator
// Returns an NTSTATUS code
NTSTATUS HardwareSimulator::Start()
{
NTSTATUS status = STATUS_SUCCESS;
SENSOR_FunctionEnter();
if (SimulatorState_Initialized == m_State)
{
WdfTimerStart(m_Timer, WDF_REL_TIMEOUT_IN_MS(HardwareSimulator_HardwareInterval));
m_State = SimulatorState_Started;
}
SENSOR_FunctionExit(status);
return status;
}
// This routine stops the simulator
// Returns an NTSTATUS code
NTSTATUS HardwareSimulator::Stop()
{
NTSTATUS status = STATUS_SUCCESS;
SENSOR_FunctionEnter();
if (SimulatorState_Started == m_State)
{
WdfTimerStop(m_Timer, TRUE);
m_State = SimulatorState_Initialized;
}
SENSOR_FunctionExit(status);
return status;
}
// This callback is called when the simulator wait time has expired and the simulator
// is ready to switch to the next sample. The callback updates the sample index and
// schedules the next wake up time.
VOID HardwareSimulator::OnTimerExpire(
_In_ WDFTIMER Timer) // WDF timer object
{
HardwareSimulator *pSimulator = nullptr;
NTSTATUS Status = STATUS_SUCCESS;
SENSOR_FunctionEnter();
pSimulator = GetHardwareSimulatorContextFromInstance(WdfTimerGetParentObject(Timer));
if (nullptr == pSimulator)
{
Status = STATUS_INSUFFICIENT_RESOURCES;
TraceError("SDOS %!FUNC! GetHardwareSimulatorContextFromInstance failed %!STATUS!", Status);
}
if (NT_SUCCESS(Status))
{
// Increment the sample index, roll over if the index reach the end of the array
WdfWaitLockAcquire(pSimulator->m_Lock, NULL);
pSimulator->m_Index++;
pSimulator->m_Index %= ARRAYSIZE(OrientationData);
WdfWaitLockRelease(pSimulator->m_Lock);
WdfTimerStart(pSimulator->m_Timer, WDF_REL_TIMEOUT_IN_MS(HardwareSimulator_HardwareInterval));
}
SENSOR_FunctionExit(Status);
}
// This routine returns the current sample from the driver at the current m_Index location.
// Returns one of the ABI::Windows::Devices::Sensors::SimpleOrientation enum values.
ABI::Windows::Devices::Sensors::SimpleOrientation HardwareSimulator::GetOrientation()
{
ABI::Windows::Devices::Sensors::SimpleOrientation Sample = ABI::Windows::Devices::Sensors::SimpleOrientation::SimpleOrientation_Faceup;
NTSTATUS Status = STATUS_SUCCESS;
SENSOR_FunctionEnter();
WdfWaitLockAcquire(m_Lock, NULL);
Sample = OrientationData[m_Index];
WdfWaitLockRelease(m_Lock);
SENSOR_FunctionExit(Status);
return Sample;
}
|
