nc-uart-uart_initialize_port.md

UID	title	description	tech.root	ms.date	keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.lib	req.dll	req.irql	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	targetos	f1_keywords	topic_type	api_type	api_location	api_name
NC:uart.UART_INITIALIZE_PORT	UART_INITIALIZE_PORT (uart.h)	Initializes or resets the UART hardware.	serports	10/19/2018	UART_INITIALIZE_PORT callback function	uart.h			Windows 10, version 1803														Windows	UART_INITIALIZE_PORT uart/UART_INITIALIZE_PORT	apiref	UserDefined	uart.h	UART_INITIALIZE_PORT

UART_INITIALIZE_PORT callback function

-description

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

-parameters

-param LoadOptions

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

-param Port [Inout]

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

-param MemoryMapped

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

-param AccessSize

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

-param BitWidth

A number that indicates the width of the UART registers.

-returns

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

-prototype

//Declaration

UART_INITIALIZE_PORT UartInitializePort;

// Definition

BOOLEAN UartInitializePort
(
	PCHAR LoadOptions
	PCPPORT Port
	BOOLEAN MemoryMapped
	UCHAR AccessSize
	UCHAR BitWidth
)
{...}

-remarks

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

-see-also

UART_HARDWARE_DRIVER

_CPPORT

uart.h