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
|
/*++
Copyright (c) Microsoft Corporation. All rights reserved.
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR
PURPOSE.
Module Name:
Interrupt.c
Abstract:
This modules has routines configure a continuous reader on an
interrupt pipe to asynchronously read toggle switch states.
Environment:
User mode
--*/
#include <osrusbfx2.h>
#if defined(EVENT_TRACING)
#include "interrupt.tmh"
#endif
_IRQL_requires_(PASSIVE_LEVEL)
NTSTATUS
OsrFxConfigContReaderForInterruptEndPoint(
_In_ PDEVICE_CONTEXT DeviceContext
)
/*++
Routine Description:
This routine configures a continuous reader on the
interrupt endpoint. It's called from the PrepareHarware event.
Arguments:
Return Value:
NT status value
--*/
{
WDF_USB_CONTINUOUS_READER_CONFIG contReaderConfig;
NTSTATUS status;
WDF_USB_CONTINUOUS_READER_CONFIG_INIT(&contReaderConfig,
OsrFxEvtUsbInterruptPipeReadComplete,
DeviceContext, // Context
sizeof(UCHAR)); // TransferLength
contReaderConfig.EvtUsbTargetPipeReadersFailed = OsrFxEvtUsbInterruptReadersFailed;
//
// Reader requests are not posted to the target automatically.
// Driver must explictly call WdfIoTargetStart to kick start the
// reader. In this sample, it's done in D0Entry.
// By defaut, framework queues two requests to the target
// endpoint. Driver can configure up to 10 requests with CONFIG macro.
//
status = WdfUsbTargetPipeConfigContinuousReader(DeviceContext->InterruptPipe,
&contReaderConfig);
if (!NT_SUCCESS(status)) {
TraceEvents(TRACE_LEVEL_ERROR, DBG_PNP,
"OsrFxConfigContReaderForInterruptEndPoint failed %x\n",
status);
return status;
}
return status;
}
VOID
OsrFxEvtUsbInterruptPipeReadComplete(
WDFUSBPIPE Pipe,
WDFMEMORY Buffer,
size_t NumBytesTransferred,
WDFCONTEXT Context
)
/*++
Routine Description:
This the completion routine of the continour reader. This can
called concurrently on multiprocessor system if there are
more than one readers configured. So make sure to protect
access to global resources.
Arguments:
Buffer - This buffer is freed when this call returns.
If the driver wants to delay processing of the buffer, it
can take an additional referrence.
Context - Provided in the WDF_USB_CONTINUOUS_READER_CONFIG_INIT macro
Return Value:
NT status value
--*/
{
PUCHAR switchState = NULL;
WDFDEVICE device;
PDEVICE_CONTEXT pDeviceContext = Context;
UNREFERENCED_PARAMETER(Pipe);
device = WdfObjectContextGetObject(pDeviceContext);
//
// Make sure that there is data in the read packet. Depending on the device
// specification, it is possible for it to return a 0 length read in
// certain conditions.
//
if (NumBytesTransferred == 0) {
TraceEvents(TRACE_LEVEL_WARNING, DBG_INIT,
"OsrFxEvtUsbInterruptPipeReadComplete Zero length read "
"occured on the Interrupt Pipe's Continuous Reader\n"
);
return;
}
assert(NumBytesTransferred == sizeof(UCHAR));
switchState = WdfMemoryGetBuffer(Buffer, NULL);
TraceEvents(TRACE_LEVEL_INFORMATION, DBG_INIT,
"OsrFxEvtUsbInterruptPipeReadComplete SwitchState %x\n",
*switchState);
pDeviceContext->CurrentSwitchState = *switchState;
//
// Handle any pending Interrupt Message IOCTLs. Note that the OSR USB device
// will generate an interrupt message when the the device resumes from a low
// power state. So if the Interrupt Message IOCTL was sent after the device
// has gone to a low power state, the pending Interrupt Message IOCTL will
// get completed in the function call below, before the user twiddles the
// dip switches on the OSR USB device. If this is not the desired behavior
// for your driver, then you could handle this condition by maintaining a
// state variable on D0Entry to track interrupt messages caused by power up.
//
OsrUsbIoctlGetInterruptMessage(device, STATUS_SUCCESS);
}
BOOLEAN
OsrFxEvtUsbInterruptReadersFailed(
_In_ WDFUSBPIPE Pipe,
_In_ NTSTATUS Status,
_In_ USBD_STATUS UsbdStatus
)
{
WDFDEVICE device = WdfIoTargetGetDevice(WdfUsbTargetPipeGetIoTarget(Pipe));
PDEVICE_CONTEXT pDeviceContext = GetDeviceContext(device);
UNREFERENCED_PARAMETER(UsbdStatus);
//
// Clear the current switch state.
//
pDeviceContext->CurrentSwitchState = 0;
//
// Service the pending interrupt switch change request
//
OsrUsbIoctlGetInterruptMessage(device, Status);
return TRUE;
}
|
