Windows 驱动开发 - 6

上篇《Windows 驱动开发 - 5》我们设置了回调事件EvtIoDeviceControl，我们在此篇来实现他。

    我们知道在进行读写之前我们要进行一定约定，比如同步。

    在WDF中控制同步约定的方法为：WdfUsbTargetDeviceSendControlTransferSynchronously

1. NTSTATUS WdfUsbTargetDeviceSendControlTransferSynchronously(
   
2.   [in] WDFUSBDEVICE UsbDevice,
   
3.   [in, optional] WDFREQUEST Request,
   
4.   [in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions,
   
5.   [in] PWDF_USB_CONTROL_SETUP_PACKET SetupPacket,
   
6.   [in, optional] PWDF_MEMORY_DESCRIPTOR MemoryDescriptor,
   
7.   [out, optional] PULONG BytesTransferred
   
8. );

(1) 选项请求

          对WDF_REQUEST_SEND_OPTIONS结构的设置。

1. typedef struct _WDF_REQUEST_SEND_OPTIONS {
   
2.   ULONG Size;
   
3.   ULONG Flags;
   
4.   LONGLONG Timeout;
   
5. } WDF_REQUEST_SEND_OPTIONS, *PWDF_REQUEST_SEND_OPTIONS;

1). 初始化

            使用WDF_REQUEST_SEND_OPTIONS_INIT方法进行初始化.

1. VOID WDF_REQUEST_SEND_OPTIONS_INIT(
   
2.   _Out_ PWDF_REQUEST_SEND_OPTIONS Options,
   
3.   _In_ ULONG Flags
   
4. );

2). 设置超时
            使用WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT方法进行超时设置。

1. VOID WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT(
   
2.   _Inout_ PWDF_REQUEST_SEND_OPTIONS Options,
   
3.   _In_ LONGLONG Timeout
   
4. );

  (2) 包设置

          使用WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR方法进行包设置。

1. VOID WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR(
   
2.   _Out_ PWDF_USB_CONTROL_SETUP_PACKET Packet,
   
3.   _In_ WDF_USB_BMREQUEST_DIRECTION Direction,
   
4.   _In_ WDF_USB_BMREQUEST_RECIPIENT Recipient,
   
5.   _In_ BYTE Request,
   
6.   _In_ USHORT Value,
   
7.   _In_ USHORT Index
   
8. );

    (3) 内存描述

        1). 内存请求

             使用WdfRequestRetrieveInputMemory方法进行请求。

1. NTSTATUS WdfRequestRetrieveInputMemory(
   
2.   [in] WDFREQUEST Request,
   
3.   [out] WDFMEMORY *Memory
   
4. );

        2). 初始化内存句柄

             使用WDF_MEMORY_DESCRIPTOR_INIT_HANDLE方法进行内存句柄的初始化。

1. VOID WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(
   
2.   _Out_ PWDF_MEMORY_DESCRIPTOR Descriptor,
   
3.   _In_ WDFMEMORY Memory,
   
4.   _In_opt_ PWDFMEMORY_OFFSET Offsets
   
5. );

代码：

step3.c

1. /*++
   
2. 
   
3. Step3: This steps shows:
   
4.        1) How to create a default parallel queue to receive a IOCTL requests to
   
5.           set bar graph display.
   
6.        2) How to retreive memory handle from the requests and use that to send
   
7.           a vendor command to the USB device.
   
8. --*/
   
9. 
   
10. #include "ntddk.h"
    
11. #include "wdf.h"
    
12. #include "prototypes.h"
    
13. #pragma warning(disable:4200) // suppress nameless struct/union warning
    
14. #pragma warning(disable:4201) // suppress nameless struct/union warning
    
15. #pragma warning(disable:4214) // suppress bit field types other than int warning
    
16. #include "usbdi.h"
    
17. #pragma warning(default:4200)
    
18. #pragma warning(default:4201)
    
19. #pragma warning(default:4214)
    
20. #include "wdfusb.h"
    
21. #include "initguid.h"
    
22. 
    
23. DEFINE_GUID(GUID_DEVINTERFACE_OSRUSBFX2, // Generated using guidgen.exe
    
24.    0x573e8c73, 0xcb4, 0x4471, 0xa1, 0xbf, 0xfa, 0xb2, 0x6c, 0x31, 0xd3, 0x84);
    
25. // {573E8C73-0CB4-4471-A1BF-FAB26C31D384}
    
26. 
    
27. #define IOCTL_INDEX 0x800
    
28. #define FILE_DEVICE_OSRUSBFX2 0x65500
    
29. #define USBFX2LK_SET_BARGRAPH_DISPLAY 0xD8
    
30. #define IOCTL_OSRUSBFX2_SET_BAR_GRAPH_DISPLAY CTL_CODE(FILE_DEVICE_OSRUSBFX2,\
    
31.                                                     IOCTL_INDEX + 5, \
    
32.                                                     METHOD_BUFFERED, \
    
33.                                                     FILE_WRITE_ACCESS)
    
34. typedef struct _DEVICE_CONTEXT {
    
35.   WDFUSBDEVICE UsbDevice;
    
36.   WDFUSBINTERFACE UsbInterface;
    
37. } DEVICE_CONTEXT, *PDEVICE_CONTEXT;
    
38. 
    
39. WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(DEVICE_CONTEXT, GetDeviceContext)
    
40. 
    
41. 
    
42. NTSTATUS
    
43. DriverEntry(
    
44.     IN PDRIVER_OBJECT DriverObject,
    
45.     IN PUNICODE_STRING RegistryPath
    
46.     )
    
47. {
    
48.     WDF_DRIVER_CONFIG config;
    
49.     NTSTATUS status;
    
50. 
    
51.     KdPrint(("DriverEntry of Step3\n"));
    
52. 
    
53.     WDF_DRIVER_CONFIG_INIT(&config, EvtDeviceAdd);
    
54. 
    
55.     status = WdfDriverCreate(DriverObject,
    
56.                         RegistryPath,
    
57.                         WDF_NO_OBJECT_ATTRIBUTES,
    
58.                         &config,
    
59.                         WDF_NO_HANDLE
    
60.                         );
    
61. 
    
62.     if (!NT_SUCCESS(status)) {
    
63.         KdPrint(("WdfDriverCreate failed 0x%x\n", status));
    
64.     }
    
65. 
    
66.     return status;
    
67. }
    
68. 
    
69. NTSTATUS
    
70. EvtDeviceAdd(
    
71.     IN WDFDRIVER Driver,
    
72.     IN PWDFDEVICE_INIT DeviceInit
    
73.     )
    
74. {
    
75.     WDF_OBJECT_ATTRIBUTES attributes;
    
76.     NTSTATUS status;
    
77.     WDFDEVICE device;
    
78.     PDEVICE_CONTEXT pDevContext;
    
79.     WDF_PNPPOWER_EVENT_CALLBACKS pnpPowerCallbacks;
    
80.     WDF_IO_QUEUE_CONFIG ioQueueConfig;
    
81.     
    
82.     UNREFERENCED_PARAMETER(Driver);
    
83. 
    
84.     WDF_PNPPOWER_EVENT_CALLBACKS_INIT(&pnpPowerCallbacks);
    
85.     pnpPowerCallbacks.EvtDevicePrepareHardware = EvtDevicePrepareHardware;
    
86.     WdfDeviceInitSetPnpPowerEventCallbacks(DeviceInit, &pnpPowerCallbacks);
    
87. 
    
88.     WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&attributes, DEVICE_CONTEXT);
    
89. 
    
90.     status = WdfDeviceCreate(&DeviceInit, &attributes, &device);
    
91.     if (!NT_SUCCESS(status)) {
    
92.         KdPrint(("WdfDeviceCreate failed 0x%x\n", status));
    
93.         return status;
    
94.     }
    
95. 
    
96.     pDevContext = GetDeviceContext(device);
    
97. 
    
98.     status = WdfDeviceCreateDeviceInterface(device,
    
99.                                 (LPGUID) &GUID_DEVINTERFACE_OSRUSBFX2,
    
100.                                 NULL);// Reference String
     
101.     if (!NT_SUCCESS(status)) {
     
102.         KdPrint(("WdfDeviceCreateDeviceInterface failed 0x%x\n", status));
     
103.         return status;
     
104.     }
     
105. 
     
106.     WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE(&ioQueueConfig,
     
107.                                     WdfIoQueueDispatchParallel);
     
108. 
     
109.     ioQueueConfig.EvtIoDeviceControl = EvtIoDeviceControl;
     
110. 
     
111.     status = WdfIoQueueCreate(device,
     
112.                          &ioQueueConfig,
     
113.                          WDF_NO_OBJECT_ATTRIBUTES,
     
114.                          WDF_NO_HANDLE);
     
115.     if (!NT_SUCCESS(status)) {
     
116.         KdPrint(("WdfIoQueueCreate failed %!STATUS!\n", status));
     
117.         return status;
     
118.     }
     
119. 
     
120.     return status;
     
121. }
     
122. 
     
123. 
     
124. NTSTATUS
     
125. EvtDevicePrepareHardware(
     
126.     IN WDFDEVICE Device,
     
127.     IN WDFCMRESLIST ResourceList,
     
128.     IN WDFCMRESLIST ResourceListTranslated
     
129.     )
     
130. {
     
131.     NTSTATUS status;
     
132.     PDEVICE_CONTEXT pDeviceContext;
     
133.     WDF_USB_DEVICE_SELECT_CONFIG_PARAMS configParams;
     
134.  
     
135.     UNREFERENCED_PARAMETER(ResourceList);
     
136.     UNREFERENCED_PARAMETER(ResourceListTranslated);
     
137. 
     
138.     pDeviceContext = GetDeviceContext(Device);
     
139. 
     
140.     //
     
141.     // Create the USB device if it is not already created.
     
142.     //
     
143.     if (pDeviceContext->UsbDevice == NULL) {
     
144. 
     
145.         status = WdfUsbTargetDeviceCreate(Device,
     
146.                                     WDF_NO_OBJECT_ATTRIBUTES,
     
147.                                     &pDeviceContext->UsbDevice);
     
148.         if (!NT_SUCCESS(status)) {
     
149.             KdPrint(("WdfUsbTargetDeviceCreate failed 0x%x\n", status));
     
150.             return status;
     
151.         }
     
152.     }
     
153. 
     
154.     WDF_USB_DEVICE_SELECT_CONFIG_PARAMS_INIT_SINGLE_INTERFACE(&configParams);
     
155. 
     
156.     status = WdfUsbTargetDeviceSelectConfig(pDeviceContext->UsbDevice,
     
157.                                         WDF_NO_OBJECT_ATTRIBUTES,
     
158.                                         &configParams);
     
159.     if(!NT_SUCCESS(status)) {
     
160.         KdPrint(("WdfUsbTargetDeviceSelectConfig failed 0x%x\n", status));
     
161.         return status;
     
162.     }
     
163. 
     
164.     pDeviceContext->UsbInterface =
     
165.                 configParams.Types.SingleInterface.ConfiguredUsbInterface;
     
166.     return status;
     
167. }
     
168. 
     
169. VOID
     
170. EvtIoDeviceControl(
     
171.     IN WDFQUEUE Queue,
     
172.     IN WDFREQUEST Request,
     
173.     IN size_t OutputBufferLength,
     
174.     IN size_t InputBufferLength,
     
175.     IN ULONG IoControlCode
     
176.     )
     
177. {
     
178.     WDFDEVICE device;
     
179.     PDEVICE_CONTEXT pDevContext;
     
180.     size_t bytesTransferred = 0;
     
181.     NTSTATUS status;
     
182.     WDF_USB_CONTROL_SETUP_PACKET controlSetupPacket;
     
183.     WDF_MEMORY_DESCRIPTOR memDesc;
     
184.     WDFMEMORY memory;
     
185.     WDF_REQUEST_SEND_OPTIONS sendOptions;
     
186.      
     
187.     UNREFERENCED_PARAMETER(InputBufferLength);
     
188.     UNREFERENCED_PARAMETER(OutputBufferLength);
     
189.     
     
190.     device = WdfIoQueueGetDevice(Queue);
     
191.     pDevContext = GetDeviceContext(device);
     
192. 
     
193.     switch(IoControlCode) {
     
194. 
     
195.     case IOCTL_OSRUSBFX2_SET_BAR_GRAPH_DISPLAY:
     
196. 
     
197.         if(InputBufferLength < sizeof(UCHAR)) {
     
198.             status = STATUS_BUFFER_OVERFLOW;
     
199.             bytesTransferred = sizeof(UCHAR);
     
200.             break;
     
201.         }
     
202. 
     
203.         status = WdfRequestRetrieveInputMemory(Request, &memory);
     
204.         if (!NT_SUCCESS(status)) {
     
205.             KdPrint(("WdfRequestRetrieveMemory failed 0x%x", status));
     
206.             break;
     
207.         }
     
208. 
     
209.         WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR(&controlSetupPacket,
     
210.                                         BmRequestHostToDevice,
     
211.                                         BmRequestToDevice,
     
212.                                         USBFX2LK_SET_BARGRAPH_DISPLAY, // Request
     
213.                                         0, // Value
     
214.                                         0); // Index
     
215. 
     
216.         WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(&memDesc, memory, NULL);
     
217. 
     
218.        //
     
219.        // Send the I/O with a timeout to avoid hanging the calling
     
220.        // thread indefinitely.
     
221.        //
     
222.         WDF_REQUEST_SEND_OPTIONS_INIT(&sendOptions,
     
223.                                   WDF_REQUEST_SEND_OPTION_TIMEOUT);
     
224. 
     
225.         WDF_REQUEST_SEND_OPTIONS_SET_TIMEOUT(&sendOptions,
     
226.                                          WDF_REL_TIMEOUT_IN_MS(100));
     
227.         status = WdfUsbTargetDeviceSendControlTransferSynchronously(
     
228.                                         pDevContext->UsbDevice,
     
229.                                         NULL, // Optional WDFREQUEST
     
230.                                         &sendOptions, // PWDF_REQUEST_SEND_OPTIONS
     
231.                                         &controlSetupPacket,
     
232.                                         &memDesc,
     
233.                                         (PULONG)&bytesTransferred);
     
234.         if (!NT_SUCCESS(status)) {
     
235.             KdPrint(("SendControlTransfer failed 0x%x", status));
     
236.             break;
     
237.         }
     
238.         break;
     
239. 
     
240.     default:
     
241.         status = STATUS_INVALID_DEVICE_REQUEST;
     
242.         break;
     
243.     }
     
244. 
     
245.     WdfRequestCompleteWithInformation(Request, status, bytesTransferred);
     
246. 
     
247.     return;
     
248. }