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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
/*++
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:
AcpiReader.h
Abstract:
Contains ACPI reader module.
Environment:
Kernel mode
--*/
#pragma once
#ifndef _ACPIREADER_H_
#define _ACPIREADER_H_
/* make prototypes usable from C++ */
#ifdef __cplusplus
extern "C" {
#endif
#include <acpiioct.h>
// Number of seconds for ACPI request timeout.
#define ACPI_REQUEST_TIMEOUT_SEC 5
//
// Device properties UUID in the ACPI methods.
// {DAFFD814-6EBA-4D8C-8A91-BC9BBF4AA301}
//
DEFINE_GUID(DSD_DEVICE_PROPERTIES_GUID,
0xDAFFD814, 0x6EBA, 0x4D8C, 0x8A, 0x91, 0xBC, 0x9B, 0xBF, 0x4A, 0xA3, 0x01);
//
// Hierarchical data extension UUID in the ACPI methods.
// {DBB8E3E6-5886-4BA6-8795-1319F52A966B}
//
DEFINE_GUID(DSD_HIERARCHICAL_DATA_EXTENSION_GUID,
0xDBB8E3E6, 0x5886, 0x4BA6, 0x87, 0x95, 0x13, 0x19, 0xF5, 0x2A, 0x96, 0x6B);
//
// Buffer UUID in ACPI methods.
// {EDB12DD0-363D-4085-A3D2-49522CA160C4}
//
DEFINE_GUID(DSD_BUFFER_GUID,
0xEDB12DD0, 0x363D, 0x4085, 0xA3, 0xD2, 0x49, 0x52, 0x2C, 0xA1, 0x60, 0xC4);
namespace ACPIREADER
{
typedef enum
{
ACPI_METHOD_SECTION_UNKNOWN = 0,
ACPI_METHOD_SECTION_DEVICE_PROPERTIES = 1,
ACPI_METHOD_SECTION_HIERARCHICAL_DATA_EXTENSION = 2,
ACPI_METHOD_SECTION_BUFFER = 3
} ACPI_METHOD_SECTION;
class AcpiReader
{
private:
WDFDEVICE m_AcpiDevice{ nullptr };
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
ParseULongLong(
_In_ PACPI_METHOD_ARGUMENT Argument,
_Out_ PULONGLONG Value);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
ParseULong(
_In_ PACPI_METHOD_ARGUMENT Argument,
_Out_ PULONG Value);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
ParseString(
_In_ PACPI_METHOD_ARGUMENT Argument,
_Out_writes_opt_z_(ValueStringSize) char * ValueString,
_In_ ULONG ValueStringSize,
_Out_ PULONG PropertyValueSize);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
ParseBuffer(
_In_ PACPI_METHOD_ARGUMENT Argument,
_Out_writes_bytes_(ValueBufferSize) PVOID ValueBuffer,
_In_ ULONG ValueBufferSize,
_Out_ PULONG PropertyValueSize);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
ParseGuid(
_In_ PACPI_METHOD_ARGUMENT Argument,
_Out_writes_bytes_(BufferLength) PVOID Buffer,
_In_ ULONG BufferLength);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
GetProperty(
_In_ LPCSTR PropertyName,
_In_ ACPI_METHOD_SECTION PropertySection,
_In_ WDFMEMORY AcpiEvalOutputBuf,
_Outptr_result_maybenull_ PACPI_METHOD_ARGUMENT * PropertyValue);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
ParsePropertiesPackage(
_In_ LPCSTR PropertyName,
_In_ size_t PropertyLength,
_In_ PACPI_METHOD_ARGUMENT Package,
_Outptr_result_maybenull_ PACPI_METHOD_ARGUMENT * PropertyValue);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
FindProperty(
_In_ LPCSTR PropertyName,
_In_ size_t PropertyLength,
_In_ PACPI_METHOD_ARGUMENT Package,
_Outptr_result_maybenull_ PACPI_METHOD_ARGUMENT * PropertyValue);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
ParseULongArray(
_In_ PACPI_METHOD_ARGUMENT Argument,
_Out_writes_(ValueArrayCount) ULONG * ValueArray,
_In_ ULONG ValueArrayCount,
_Out_ PULONG PropertyValueArrayCount);
public:
static
_Must_inspect_result_
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
_CreateAndInitialize(_In_ WDFDEVICE Device, _In_ RECORDER_LOG Log, _In_ ULONG MemoryTag);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
EnumChildren(
_Out_ WDFMEMORY * EnumChildrenOutput);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
EvaluateMethod(
_In_ LPCSTR MethodName,
_Out_ WDFMEMORY * ReturnMemory);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
EvaluateAdr(
_In_opt_ LPCSTR ChildDeviceName,
_Out_ PULONGLONG Address);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
EvaluateAdr(
_Out_ PULONGLONG Address);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
GetPropertyULongLong(
_In_ LPCSTR PropertyName,
_In_ ACPI_METHOD_SECTION PropertySection,
_In_ WDFMEMORY AcpiEvalOutputBuf,
_Out_ PULONGLONG PropertyValue);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
GetPropertyULong(
_In_ LPCSTR PropertyName,
_In_ ACPI_METHOD_SECTION PropertySection,
_In_ WDFMEMORY AcpiEvalOutputBuf,
_Out_ PULONG PropertyValue);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
GetPropertyString(
_In_ LPCSTR PropertyName,
_In_ ACPI_METHOD_SECTION PropertySection,
_In_ WDFMEMORY AcpiEvalOutputBuf,
_Out_writes_opt_z_(ValueStringSize) char * ValueString,
_In_ ULONG ValueStringSize,
_Out_ PULONG PropertyValueSize);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
GetPropertyBuffer(
_In_ LPCSTR PropertyName,
_In_ WDFMEMORY AcpiEvalOutputBuf,
_Out_writes_bytes_(ValueBufferSize) PVOID ValueBuffer,
_In_ ULONG ValueBufferSize,
_Out_ PULONG PropertyValueSize);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
NTSTATUS
GetPropertyULongArray(
_In_ LPCSTR PropertyName,
_In_ ACPI_METHOD_SECTION PropertySection,
_In_ WDFMEMORY AcpiEvalOutputBuf,
_Out_writes_(ValueArrayCount) ULONG * ValueArray,
_In_ ULONG ValueArrayCount,
_Out_ PULONG PropertyValueArrayCount);
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
VOID
FreeBuffer(
_Inout_ WDFMEMORY* AcpiEvalOutputBuf);
protected:
static
RECORDER_LOG s_AcpiReaderLog;
static
ULONG s_MemoryTag;
static
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
EVT_WDF_OBJECT_CONTEXT_DESTROY
EvtContextDestroy;
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
AcpiReader(_In_ WDFDEVICE Device) : m_AcpiDevice(Device) { PAGED_CODE(); }
// Placement-new to construct the object inside the WDF context space.
static
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
void*
operator new (
_In_ size_t /* SizeInBytes */,
_In_ void* ContextMemory
)
{
PAGED_CODE();
// We already have the memory courtesy of WDF so we don't have to allocate anything.
return ContextMemory;
}
static
__drv_maxIRQL(PASSIVE_LEVEL)
PAGED_CODE_SEG
void
operator delete (
_In_ void* /* ContextMemory */
)
{
PAGED_CODE();
// Since we didn't allocate the memory, don't try to deallocate it.
}
};
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(AcpiReader, GetAcpiReaderDeviceContext)
}
/* make internal prototypes usable from C++ */
#ifdef __cplusplus
}
#endif
#endif // _ACPIREADER_H_
|
