PI8042_KEYBOARD_INITIALIZATION_ROUTINE callback function (ntdd8042.h)

Article
02/22/2024

A PI8042_KEYBOARD_INITIALIZATION_ROUTINE-typed callback routine supplements the default initialization of a keyboard device by I8042prt.

Syntax

PI8042_KEYBOARD_INITIALIZATION_ROUTINE Pi8042KeyboardInitializationRoutine;

NTSTATUS Pi8042KeyboardInitializationRoutine(
  [in]  PVOID InitializationContext,
  [in]  PVOID SynchFuncContext,
  [in]  PI8042_SYNCH_READ_PORT ReadPort,
  [in]  PI8042_SYNCH_WRITE_PORT WritePort,
  [out] PBOOLEAN TurnTranslationOn
)
{...}

Parameters

[in] InitializationContext

Pointer to the filter device object of the driver that supplies the callback.

[in] SynchFuncContext

Pointer to the context for the callbacks that are pointed to by ReadPort and Writeport.

[in] ReadPort

Pointer to a PI8042_SYNCH_READ_PORT callback that reads from the port.

[in] WritePort

Pointer to a PI8042_SYNCH_WRITE_PORT callback that writes to the port.

[out] TurnTranslationOn

Specifies whether to turn translation on or off. If TranslationOn is TRUE, translation is turned on; otherwise, translation is turned off.

Return value

A PI8042_KEYBOARD_INITIALIZATION_ROUTINE callback returns an appropriate NTSTATUS code.

Remarks

An upper-level keyboard filter driver can provide a PI8042_KEYBOARD_INITIALIZATION_ROUTINE callback.

If an upper-level keyboard filter driver supplies an initialization callback, I8042prt calls the filter initialization callback when I8042prt initializes the keyboard. Default keyboard initialization includes the following operations: reset the keyboard, set the typematic rate and delay, and set the light-emitting diodes (LED).

Requirements

Requirement	Value
Target Platform	Desktop
Header	ntdd8042.h (include Ntdd8042.h)
IRQL	PASSIVE_LEVEL