Edit

UART_INITIALIZE_PORT callback function (uart.h)

  • Article

Initializes or resets the UART hardware. This callback function is called before calling any other driver functions.

Syntax

UART_INITIALIZE_PORT UartInitializePort;

BOOLEAN UartInitializePort(
            PCHAR LoadOptions,
  [_Inout_] PCPPORT Port,
            BOOLEAN MemoryMapped,
            UCHAR AccessSize,
            UCHAR BitWidth
)
{...}

Parameters

LoadOptions

[_In_opt_Optional Null_terminated] A null-terminated load option string.

[_Inout_] Port

A pointer to a _CPPORT structure that is filled with information about port initialization.

MemoryMapped

A boolean value that indicates whether the UART hardware is accessed through memory-mapped registers or legacy port I/O.

AccessSize

An ACPI Generic Access Size value that indicates the type of bus access that should be performed when accessing the UART hardware.

BitWidth

A number that indicates the width of the UART registers.

Return value

Returns TRUE if the port has been successfully initialized, FALSE otherwise.

Remarks

Register your implementation of this callback function by setting the appropriate member of UART_HARDWARE_DRIVER.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1803
Header uart.h

See also

UART_HARDWARE_DRIVER

_CPPORT

uart.h