-
Notifications
You must be signed in to change notification settings - Fork 0
/
Device.cpp
249 lines (190 loc) · 7.96 KB
/
Device.cpp
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
/*++
Module Name:
device.c - Device handling events for example driver.
Abstract:
This file contains the device entry points and callbacks.
Environment:
Kernel-mode Driver Framework
--*/
#include "driver.h"
#include "device.tmh"
#ifdef ALLOC_PRAGMA
#pragma alloc_text (PAGE, NetAdapterCxExampleCreateDevice)
#pragma alloc_text (PAGE, NetAdapterCxExamplePrepareHardware)
#pragma alloc_text (PAGE, NetAdapterCxExampleReleaseHardware)
#endif
NTSTATUS
NetAdapterCxExampleCreateDevice(
_Inout_ PWDFDEVICE_INIT DeviceInit
)
/*++
Routine Description:
Worker routine called to create a device and its software resources.
Arguments:
DeviceInit - Pointer to an opaque init structure. Memory for this
structure will be freed by the framework when the WdfDeviceCreate
succeeds. So don't access the structure after that point.
Return Value:
NTSTATUS
--*/
{
WDF_OBJECT_ATTRIBUTES deviceAttributes;
WDF_OBJECT_ATTRIBUTES adapterAttributes;
PDEVICE_CONTEXT deviceContext;
PADAPTER_CONTEXT adapterContext;
WDFDEVICE device;
NTSTATUS status;
WDF_PNPPOWER_EVENT_CALLBACKS pnpPowerCallbacks;
PAGED_CODE();
TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DEVICE, "%!FUNC! Entry");
WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&deviceAttributes, DEVICE_CONTEXT);
WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&adapterAttributes, ADAPTER_CONTEXT);
WDF_PNPPOWER_EVENT_CALLBACKS_INIT(&pnpPowerCallbacks);
status = NetDeviceInitConfig(DeviceInit);
if (!NT_SUCCESS(status))
{
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE, "NetDeviceInitConfig failed %!STATUS!", status);
return status;
}
pnpPowerCallbacks.EvtDevicePrepareHardware = NetAdapterCxExamplePrepareHardware;
pnpPowerCallbacks.EvtDeviceReleaseHardware = NetAdapterCxExampleReleaseHardware;
WdfDeviceInitSetPnpPowerEventCallbacks(DeviceInit, &pnpPowerCallbacks);
status = WdfDeviceCreate(&DeviceInit, &deviceAttributes, &device);
if (!NT_SUCCESS(status))
{
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE, "WdfDeviceCreate failed %!STATUS!", status);
return status;
}
// Get a pointer to the device context structure.
deviceContext = DeviceGetContext(device);
// Create a net adapter
// Allocate the net adapter initialization structure
auto adapterInit = NetAdapterInitAllocate(device);
if (adapterInit == NULL)
{
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE, "NetAdapterInitAllocate failed %!STATUS!", status);
return status;
}
// Datapath callbacks for creating packet queues
NET_ADAPTER_DATAPATH_CALLBACKS datapathCallbacks;
NET_ADAPTER_DATAPATH_CALLBACKS_INIT(&datapathCallbacks,
NetAdapterCxExampleCreateTxQueue,
NetAdapterCxExampleCreateRxQueue);
NetAdapterInitSetDatapathCallbacks(adapterInit,
&datapathCallbacks);
// Create the adapter
status = NetAdapterCreate(adapterInit, &adapterAttributes, &deviceContext->NetAdapter);
// Always free the adapter initialization object
NetAdapterInitFree(adapterInit);
if (NT_SUCCESS(status)) {
// Initialize the adapter's context
adapterContext = AdapterGetContext(deviceContext->NetAdapter);
// Save Device for later use
adapterContext->Device = device;
}
else {
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE,
"NetAdapterCreate failed %!STATUS!", status);
return status;
}
// Limitations say that we must pass a reference string to WdfDeviceCreateDeviceInterface:
// If the client driver calls WdfDeviceCreateDeviceInterface with the ReferenceString parameter equal
// to NULL, NDIS intercepts I/O requests sent to the device interface. To avoid this behavior, specify
// any reference string.
// https://learn.microsoft.com/en-us/windows-hardware/drivers/netcx/netadaptercx-limitations
UNICODE_STRING referenceString;
RtlUnicodeStringInit(&referenceString, L"netadaptercx-exmaple");
// Create a device interface so that applications can find and talk to us.
status = WdfDeviceCreateDeviceInterface(device, &GUID_DEVINTERFACE_NetAdapterCxExample, &referenceString);
if (!NT_SUCCESS(status)) {
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE, "WdfDeviceCreateDeviceInterface failed %!STATUS!", status);
return status;
}
// Initialize the I/O Package and any Queues
status = NetAdapterCxExampleQueueInitialize(device);
if (!NT_SUCCESS(status)) {
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE, "NetAdapterCxExampleQueueInitialize failed %!STATUS!", status);
return status;
}
TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DEVICE, "%!FUNC! Exit");
return status;
}
_Use_decl_annotations_
NTSTATUS NetAdapterCxExamplePrepareHardware(
WDFDEVICE Device,
WDFCMRESLIST ResourcesRaw,
WDFCMRESLIST ResourcesTranslated
)
{
NTSTATUS status = STATUS_SUCCESS;
WDF_DMA_ENABLER_CONFIG dmaEnablerConfig;
PAGED_CODE();
UNREFERENCED_PARAMETER(ResourcesRaw);
UNREFERENCED_PARAMETER(ResourcesTranslated);
TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DEVICE, "%!FUNC! Entry");
auto deviceContext = DeviceGetContext(Device);
auto adapterContext = AdapterGetContext(deviceContext->NetAdapter);
//
// Skip setting up PCI resources
//
// Setup for DMA
WdfDeviceSetAlignmentRequirement(Device, FILE_QUAD_ALIGNMENT);
WDF_DMA_ENABLER_CONFIG_INIT(&dmaEnablerConfig, WdfDmaProfilePacket, 4096);
dmaEnablerConfig.WdmDmaVersionOverride = 3;
status = WdfDmaEnablerCreate(Device, &dmaEnablerConfig, WDF_NO_OBJECT_ATTRIBUTES,
&deviceContext->DmaEnabler);
if (!NT_SUCCESS(status)) {
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE, "WdfDmaEnablerCreate failed %!STATUS!",
status);
return status;
}
// Setup minimal Tx/Rx capabilities
NET_ADAPTER_TX_CAPABILITIES txCapabilities;
NET_ADAPTER_TX_CAPABILITIES_INIT(
&txCapabilities,
1);
txCapabilities.MappingRequirement = NetMemoryMappingRequirementNone;
NET_ADAPTER_RX_CAPABILITIES rxCapabilities;
NET_ADAPTER_RX_CAPABILITIES_INIT_SYSTEM_MANAGED(
&rxCapabilities,
1580,
1);
NetAdapterSetDataPathCapabilities(deviceContext->NetAdapter, &txCapabilities, &rxCapabilities);
NET_ADAPTER_LINK_LAYER_CAPABILITIES linkLayerCapabilities;
NET_ADAPTER_LINK_LAYER_CAPABILITIES_INIT(
&linkLayerCapabilities,
1'000'000'000,
1'000'000'000);
NetAdapterSetLinkLayerCapabilities(deviceContext->NetAdapter, &linkLayerCapabilities);
NetAdapterSetLinkLayerMtuSize(deviceContext->NetAdapter, 1500);
UCHAR tmpAddress[6] = { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06 };
NET_ADAPTER_LINK_LAYER_ADDRESS_INIT(&adapterContext->PermanentAddress, 6, tmpAddress);
NET_ADAPTER_LINK_LAYER_ADDRESS_INIT(&adapterContext->CurrentAddress, 6, tmpAddress);
NetAdapterSetPermanentLinkLayerAddress(deviceContext->NetAdapter, &adapterContext->PermanentAddress);
NetAdapterSetCurrentLinkLayerAddress(deviceContext->NetAdapter, &adapterContext->CurrentAddress);
// Start the NetAdapter
TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DEVICE, "Starting NetAdapter");
status = NetAdapterStart(deviceContext->NetAdapter);
if (!NT_SUCCESS(status)) {
TraceEvents(TRACE_LEVEL_ERROR, TRACE_DEVICE, "NetAdapterStart failed %!STATUS!", status);
return status;
}
TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DEVICE, "%!FUNC! Exit");
return status;
}
_Use_decl_annotations_
NTSTATUS
NetAdapterCxExampleReleaseHardware(
WDFDEVICE Device,
WDFCMRESLIST ResourcesTranslated
)
{
UNREFERENCED_PARAMETER(ResourcesTranslated);
PAGED_CODE();
TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DEVICE, "%!FUNC! Entry");
auto deviceContext = DeviceGetContext(Device);
// Stop the NetAdapter
NetAdapterStop(deviceContext->NetAdapter);
TraceEvents(TRACE_LEVEL_INFORMATION, TRACE_DEVICE, "%!FUNC! Exit");
return STATUS_SUCCESS;
}