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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
/*++
Copyright (c) Microsoft Corporation All Rights Reserved
Module Name:
Device.c
Abstract:
This file handles device specific operations.
Environment:
Kernel mode only
--*/
#include "driver.h"
#include "Device.tmh"
#ifdef ALLOC_PRAGMA
#pragma alloc_text(PAGE, DeviceQueryDeviceParameters)
#endif
#define STR_BAUDRATE L"BaudRateIndex"
VOID
DeviceQueryDeviceParameters(
_In_ WDFDRIVER _Driver
)
/*++
Routine Description:
Query driver's registry location for device specific parameter, such as baudrate.
HLM\system\CCS\Services\serialhcibus\Parameters\
KeyName/Type/value
Arguments:
_Driver - WDF Driver object
Return Value:
None
--*/
{
WDFKEY Key;
NTSTATUS Status;
UNICODE_STRING ValueName;
ULONG Value = 0;
PAGED_CODE();
Status = WdfDriverOpenParametersRegistryKey(_Driver,
GENERIC_READ,
WDF_NO_OBJECT_ATTRIBUTES,
&Key
);
if (NT_SUCCESS(Status)) {
RtlInitUnicodeString(&ValueName, STR_BAUDRATE);
Status = WdfRegistryQueryULong(Key, &ValueName, &Value);
if (NT_SUCCESS(Status)) {
// Vendor: can cache and use this values.
}
WdfRegistryClose(Key);
}
}
NTSTATUS
DeviceEnableWakeControl(
_In_ WDFDEVICE _Device,
_In_ SYSTEM_POWER_STATE _PowerState
)
/*++
Routine Description:
Vendor: This is a device specific function, and it arms the wake mechanism
for this driver to receive the wake signal. This could be using an
HOST_WAKE GPIO interrupt, or inband CTS/RTS mechanism.
Arguments:
_Device - WDF Device object
_PowerState - Context used for reading data from target UART device
Return Value:
NTSTATUS
--*/
{
UNREFERENCED_PARAMETER(_Device);
UNREFERENCED_PARAMETER(_PowerState);
return STATUS_SUCCESS;
}
VOID
DeviceDisableWakeControl(
WDFDEVICE _Device
)
/*++
Routine Description:
Vendor: This is a device specific function, and it disarms the wake mechanism
for this driver to receive the wake signal.
Arguments:
_Device - WDF Device object
Return Value:
VOID
--*/
{
UNREFERENCED_PARAMETER(_Device);
return;
}
BOOLEAN
DeviceInitialize(
_In_ PFDO_EXTENSION _FdoExtension,
_In_ WDFIOTARGET _IoTargetSerial,
_In_ WDFREQUEST _RequestSync,
_In_ BOOLEAN _IsUartReset
)
/*++
Routine Description:
This function perform device specific operations to intialize in order
to bring the device to operational state.
Arguments:
_FdoExtension - Function device object extension
_IoTargetSerial - IO Target to issue request to serial port
_RequestSync - A reuseable WDF Request to issue serial control
-IsUartReset - Is UART Reset is required
Return Value:
TRUE if initialization is completed and successful; FALSE otherwise.
--*/
{
UNREFERENCED_PARAMETER(_FdoExtension);
UNREFERENCED_PARAMETER(_IoTargetSerial);
UNREFERENCED_PARAMETER(_RequestSync);
UNREFERENCED_PARAMETER(_IsUartReset);
//
// Vendor specifc operation;
//
return TRUE;
}
NTSTATUS
DeviceEnable(
_In_ WDFDEVICE _Device,
_In_ BOOLEAN _IsEnabled
)
/*++
Routine Description:
This function enable/wake serial bus device.
Arguments:
_Device - Supplies a handle to the framework device object.
_IsEnabled - Boolean to enable or disable the BT device.
Return Value:
NTSTATUS code.
--*/
{
UNREFERENCED_PARAMETER(_Device);
UNREFERENCED_PARAMETER(_IsEnabled);
return STATUS_SUCCESS;
}
NTSTATUS
DevicePowerOn(
_In_ WDFDEVICE _Device
)
/*++
Routine Description:
This routine powers on the serial bus device
Arguments:
_Device - Supplies a handle to the framework device object.
Return Value:
NT status code.
--*/
{
UNREFERENCED_PARAMETER(_Device);
return STATUS_SUCCESS;
}
NTSTATUS
DevicePowerOff(
_In_ WDFDEVICE _Device
)
/*++
Routine Description:
This routine powers off the serial bus device
Arguments:
_Device - Supplies a handle to the framework device object.
Return Value:
NT status code.
--*/
{
UNREFERENCED_PARAMETER(_Device);
return STATUS_SUCCESS;
}
_Use_decl_annotations_
VOID
DeviceDoPLDR(
WDFDEVICE _Fdo
)
/*++
Routine Description:
This vendor-specific routine takes appropriate actions necessary to fully reset the device.
Arguments:
_Fdo - Framework device object representing the FDO.
Return Value:
VOID.
--*/
{
UNREFERENCED_PARAMETER(_Fdo);
}
|