[reactos] 01/01: [DRIVERS] Fix misusages of the RTL_REGISTRY_OPTIONAL flag.

[Hermès Bélusca-Maïto]

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=4795177ced1da7d33a72b6...

commit 4795177ced1da7d33a72b652a6ebfaee3ce2612b
Author:     Hermès Bélusca-Maïto [e-mail]
AuthorDate: Fri Dec 13 22:33:26 2024 +0100
Commit:     Hermès Bélusca-Maïto [e-mail]
CommitDate: Sat Dec 14 19:12:11 2024 +0100

[DRIVERS] Fix misusages of the RTL_REGISTRY_OPTIONAL flag.

See https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/wdm/nf-wdm-rt...

The RTL_REGISTRY_OPTIONAL applies to the first parameter of the
    RtlQueryRegistryValues() function, not to the Flags member of the
    table entries. However, a RTL_QUERY_REGISTRY_REQUIRED flag exists
    to mark values whose existence is NOT optional.

Problematic usage was introduced in the following modules:
    drivers/input/i8042prt: Commit e7e959fb0 (r30000)
    drivers/input/kbdclass: Commit 5a77f871d (r18911)
    drivers/input/mouclass: Commit aeeab7d1f (r18906)
    drivers/input/sermouse: Commit 3f348259c (r19100)
    rosapps/drivers/green : Commit c8a90f769 (r21165)
---
 drivers/input/i8042prt/registry.c    | 32 ++++++++++++++++----------------
 drivers/input/kbdclass/kbdclass.c    |  8 ++++----
 drivers/input/mouclass/mouclass.c    |  8 ++++----
 drivers/input/sermouse/sermouse.c    |  4 ++--
 modules/rosapps/drivers/green/misc.c |  8 ++++----
 5 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/drivers/input/i8042prt/registry.c b/drivers/input/i8042prt/registry.c
index 48b6ebfd234..9a675daa742 100644
--- a/drivers/input/i8042prt/registry.c
+++ b/drivers/input/i8042prt/registry.c
@@ -55,105 +55,105 @@ ReadRegistryEntries(
    Parameters[0].Flags = RTL_QUERY_REGISTRY_SUBKEY;
    Parameters[0].Name = L"Parameters";

-	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[1].Name = L"KeyboardDataQueueSize";
    Parameters[1].EntryContext = &Settings->KeyboardDataQueueSize;
    Parameters[1].DefaultType = REG_DWORD;
    Parameters[1].DefaultData = &DefaultKeyboardDataQueueSize;
    Parameters[1].DefaultLength = sizeof(ULONG);

-	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[2].Name = L"KeyboardDeviceBaseName";
    Parameters[2].EntryContext = &Settings->KeyboardDeviceBaseName;
    Parameters[2].DefaultType = REG_SZ;
    Parameters[2].DefaultData = (PVOID)DefaultKeyboardDeviceBaseName;
    Parameters[2].DefaultLength = 0;

-	Parameters[3].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[3].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[3].Name = L"MouseDataQueueSize";
    Parameters[3].EntryContext = &Settings->MouseDataQueueSize;
    Parameters[3].DefaultType = REG_DWORD;
    Parameters[3].DefaultData = &DefaultMouseDataQueueSize;
    Parameters[3].DefaultLength = sizeof(ULONG);

-	Parameters[4].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[4].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[4].Name = L"MouseResolution";
    Parameters[4].EntryContext = &Settings->MouseResolution;
    Parameters[4].DefaultType = REG_DWORD;
    Parameters[4].DefaultData = &DefaultMouseResolution;
    Parameters[4].DefaultLength = sizeof(ULONG);

-	Parameters[5].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[5].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[5].Name = L"MouseSynchIn100ns";
    Parameters[5].EntryContext = &Settings->MouseSynchIn100ns;
    Parameters[5].DefaultType = REG_DWORD;
    Parameters[5].DefaultData = &DefaultMouseSynchIn100ns;
    Parameters[5].DefaultLength = sizeof(ULONG);

-	Parameters[6].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[6].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[6].Name = L"NumberOfButtons";
    Parameters[6].EntryContext = &Settings->NumberOfButtons;
    Parameters[6].DefaultType = REG_DWORD;
    Parameters[6].DefaultData = &DefaultNumberOfButtons;
    Parameters[6].DefaultLength = sizeof(ULONG);

-	Parameters[7].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[7].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[7].Name = L"PointerDeviceBaseName";
    Parameters[7].EntryContext = &Settings->PointerDeviceBaseName;
    Parameters[7].DefaultType = REG_SZ;
    Parameters[7].DefaultData = (PVOID)DefaultPointerDeviceBaseName;
    Parameters[7].DefaultLength = 0;

-	Parameters[8].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[8].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[8].Name = L"PollStatusIterations";
    Parameters[8].EntryContext = &Settings->PollStatusIterations;
    Parameters[8].DefaultType = REG_DWORD;
    Parameters[8].DefaultData = &DefaultPollStatusIterations;
    Parameters[8].DefaultLength = sizeof(ULONG);

-	Parameters[9].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[9].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[9].Name = L"OverrideKeyboardType";
    Parameters[9].EntryContext = &Settings->OverrideKeyboardType;
    Parameters[9].DefaultType = REG_DWORD;
    Parameters[9].DefaultData = &DefaultOverrideKeyboardType;
    Parameters[9].DefaultLength = sizeof(ULONG);

-	Parameters[10].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[10].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[10].Name = L"OverrideKeyboardSubtype";
    Parameters[10].EntryContext = &Settings->OverrideKeyboardSubtype;
    Parameters[10].DefaultType = REG_DWORD;
    Parameters[10].DefaultData = &DefaultOverrideKeyboardSubtype;
    Parameters[10].DefaultLength = sizeof(ULONG);

-	Parameters[11].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[11].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[11].Name = L"PollingIterations";
    Parameters[11].EntryContext = &Settings->PollingIterations;
    Parameters[11].DefaultType = REG_DWORD;
    Parameters[11].DefaultData = &DefaultPollingIterations;
    Parameters[11].DefaultLength = sizeof(ULONG);

-	Parameters[12].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[12].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[12].Name = L"PollingIterationsMaximum";
    Parameters[12].EntryContext = &Settings->PollingIterationsMaximum;
    Parameters[12].DefaultType = REG_DWORD;
    Parameters[12].DefaultData = &DefaultPollingIterationsMaximum;
    Parameters[12].DefaultLength = sizeof(ULONG);

-	Parameters[13].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[13].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[13].Name = L"ResendIterations";
    Parameters[13].EntryContext = &Settings->ResendIterations;
    Parameters[13].DefaultType = REG_DWORD;
    Parameters[13].DefaultData = &DefaultResendIterations;
    Parameters[13].DefaultLength = sizeof(ULONG);

-	Parameters[14].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[14].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[14].Name = L"SampleRate";
    Parameters[14].EntryContext = &Settings->SampleRate;
    Parameters[14].DefaultType = REG_DWORD;
    Parameters[14].DefaultData = &DefaultSampleRate;
    Parameters[14].DefaultLength = sizeof(ULONG);

-	Parameters[15].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[15].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[15].Name = L"CrashOnCtrlScroll";
    Parameters[15].EntryContext = &Settings->CrashOnCtrlScroll;
    Parameters[15].DefaultType = REG_DWORD;
@@ -161,7 +161,7 @@ ReadRegistryEntries(
    Parameters[15].DefaultLength = sizeof(ULONG);

Status = RtlQueryRegistryValues(
-		RTL_REGISTRY_ABSOLUTE,
+		RTL_REGISTRY_ABSOLUTE | RTL_REGISTRY_OPTIONAL,
    	RegistryPath->Buffer,
    	Parameters,
    	NULL,
diff --git a/drivers/input/kbdclass/kbdclass.c b/drivers/input/kbdclass/kbdclass.c
index ccf83532aaf..357eb581cd1 100644
--- a/drivers/input/kbdclass/kbdclass.c
+++ b/drivers/input/kbdclass/kbdclass.c
@@ -254,21 +254,21 @@ ReadRegistryEntries(

RtlZeroMemory(Parameters, sizeof(Parameters));

-	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[0].Name = L"ConnectMultiplePorts";
    Parameters[0].EntryContext = &DriverExtension->ConnectMultiplePorts;
    Parameters[0].DefaultType = REG_DWORD;
    Parameters[0].DefaultData = &DefaultConnectMultiplePorts;
    Parameters[0].DefaultLength = sizeof(ULONG);

-	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[1].Name = L"KeyboardDataQueueSize";
    Parameters[1].EntryContext = &DriverExtension->DataQueueSize;
    Parameters[1].DefaultType = REG_DWORD;
    Parameters[1].DefaultData = &DefaultDataQueueSize;
    Parameters[1].DefaultLength = sizeof(ULONG);

-	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[2].Name = L"KeyboardDeviceBaseName";
    Parameters[2].EntryContext = &DriverExtension->DeviceBaseName;
    Parameters[2].DefaultType = REG_SZ;
@@ -276,7 +276,7 @@ ReadRegistryEntries(
    Parameters[2].DefaultLength = 0;

Status = RtlQueryRegistryValues(
-		RTL_REGISTRY_ABSOLUTE,
+		RTL_REGISTRY_ABSOLUTE | RTL_REGISTRY_OPTIONAL,
    	ParametersRegistryKey.Buffer,
    	Parameters,
    	NULL,
diff --git a/drivers/input/mouclass/mouclass.c b/drivers/input/mouclass/mouclass.c
index f84dcc30238..81e1e38618d 100644
--- a/drivers/input/mouclass/mouclass.c
+++ b/drivers/input/mouclass/mouclass.c
@@ -221,21 +221,21 @@ ReadRegistryEntries(

RtlZeroMemory(Parameters, sizeof(Parameters));

-	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[0].Name = L"ConnectMultiplePorts";
    Parameters[0].EntryContext = &DriverExtension->ConnectMultiplePorts;
    Parameters[0].DefaultType = REG_DWORD;
    Parameters[0].DefaultData = &DefaultConnectMultiplePorts;
    Parameters[0].DefaultLength = sizeof(ULONG);

-	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[1].Name = L"MouseDataQueueSize";
    Parameters[1].EntryContext = &DriverExtension->DataQueueSize;
    Parameters[1].DefaultType = REG_DWORD;
    Parameters[1].DefaultData = &DefaultDataQueueSize;
    Parameters[1].DefaultLength = sizeof(ULONG);

-	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[2].Name = L"PointerDeviceBaseName";
    Parameters[2].EntryContext = &DriverExtension->DeviceBaseName;
    Parameters[2].DefaultType = REG_SZ;
@@ -243,7 +243,7 @@ ReadRegistryEntries(
    Parameters[2].DefaultLength = 0;

Status = RtlQueryRegistryValues(
-		RTL_REGISTRY_ABSOLUTE,
+		RTL_REGISTRY_ABSOLUTE | RTL_REGISTRY_OPTIONAL,
    	ParametersRegistryKey.Buffer,
    	Parameters,
    	NULL,
diff --git a/drivers/input/sermouse/sermouse.c b/drivers/input/sermouse/sermouse.c
index c7e8b789a46..9b4868133d7 100644
--- a/drivers/input/sermouse/sermouse.c
+++ b/drivers/input/sermouse/sermouse.c
@@ -56,7 +56,7 @@ ReadRegistryEntries(

RtlZeroMemory(Parameters, sizeof(Parameters));

-	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[0].Name = L"NumberOfButtons";
    Parameters[0].EntryContext = &DriverExtension->NumberOfButtons;
    Parameters[0].DefaultType = REG_DWORD;
@@ -64,7 +64,7 @@ ReadRegistryEntries(
    Parameters[0].DefaultLength = sizeof(ULONG);

Status = RtlQueryRegistryValues(
-		RTL_REGISTRY_ABSOLUTE,
+		RTL_REGISTRY_ABSOLUTE | RTL_REGISTRY_OPTIONAL,
    	ParametersRegistryKey.Buffer,
    	Parameters,
    	NULL,
diff --git a/modules/rosapps/drivers/green/misc.c b/modules/rosapps/drivers/green/misc.c
index b467146a742..50b84755bbf 100644
--- a/modules/rosapps/drivers/green/misc.c
+++ b/modules/rosapps/drivers/green/misc.c
@@ -85,18 +85,18 @@ ReadRegistryEntries(

RtlZeroMemory(Parameters, sizeof(Parameters));

-	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT;
+	Parameters[0].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_QUERY_REGISTRY_REQUIRED;
    Parameters[0].Name = L"AttachedDevice";
    Parameters[0].EntryContext = &DriverExtension->AttachedDeviceName;

-	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[1].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[1].Name = L"DeviceReported";
    Parameters[1].EntryContext = &DriverExtension->DeviceReported;
    Parameters[1].DefaultType = REG_DWORD;
    Parameters[1].DefaultData = &DefaultDeviceReported;
    Parameters[1].DefaultLength = sizeof(ULONG);

-	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT | RTL_REGISTRY_OPTIONAL;
+	Parameters[2].Flags = RTL_QUERY_REGISTRY_DIRECT;
    Parameters[2].Name = L"SampleRate";
    Parameters[2].EntryContext = &DriverExtension->SampleRate;
    Parameters[2].DefaultType = REG_DWORD;
@@ -104,7 +104,7 @@ ReadRegistryEntries(
    Parameters[2].DefaultLength = sizeof(ULONG);

Status = RtlQueryRegistryValues(
-		RTL_REGISTRY_ABSOLUTE,
+		RTL_REGISTRY_ABSOLUTE | RTL_REGISTRY_OPTIONAL,
    	ParametersRegistryKey.Buffer,
    	Parameters,
    	NULL,