uartp.h File Reference

Go to the source code of this file.

Macros
#define	SET_FLAGS(_x, _f)   ((_x) |= (_f))
#define	CLEAR_FLAGS(_x, _f)   ((_x) &= ~(_f))
#define	CLEAR_OTHER_FLAGS(_x, _f)   ((_x) &= (_f))
#define	CHECK_FLAG(_x, _f)   ((_x) & (_f))
#define	READ_PORT_UCHAR   UartHardwareAccess.ReadPort8
#define	WRITE_PORT_UCHAR   UartHardwareAccess.WritePort8
#define	READ_PORT_USHORT   UartHardwareAccess.ReadPort16
#define	WRITE_PORT_USHORT   UartHardwareAccess.WritePort16
#define	READ_PORT_ULONG   UartHardwareAccess.ReadPort32
#define	WRITE_PORT_ULONG   UartHardwareAccess.WritePort32
#define	READ_REGISTER_UCHAR   UartHardwareAccess.ReadRegister8
#define	WRITE_REGISTER_UCHAR   UartHardwareAccess.WriteRegister8
#define	READ_REGISTER_USHORT   UartHardwareAccess.ReadRegister16
#define	WRITE_REGISTER_USHORT   UartHardwareAccess.WriteRegister16
#define	READ_REGISTER_ULONG   UartHardwareAccess.ReadRegister32
#define	WRITE_REGISTER_ULONG   UartHardwareAccess.WriteRegister32
#define	READ_REGISTER_ULONG64   UartHardwareAccess.ReadRegister64
#define	WRITE_REGISTER_ULONG64   UartHardwareAccess.WriteRegister64

Typedefs
typedef enum _ACPI_GENERIC_ACCESS_SIZE	ACPI_GENERIC_ACCESS_SIZE
typedef enum _ACPI_GENERIC_ACCESS_SIZE *	PACPI_GENERIC_ACCESS_SIZE

Enumerations
enum	_ACPI_GENERIC_ACCESS_SIZE {   AcpiGenericAccessSizeLegacy = 0 , AcpiGenericAccessSizeByte , AcpiGenericAccessSizeWord , AcpiGenericAccessSizeDWord ,   AcpiGenericAccessSizeQWord }

Functions
BOOLEAN	UartpSetAccess (_Inout_ PCPPORT Port, const BOOLEAN MemoryMapped, const UCHAR AccessSize, const UCHAR BitWidth)

Variables
UART_HARDWARE_ACCESS	UartHardwareAccess

Macro Definition Documentation

CHECK_FLAG

#define CHECK_FLAG	(		_x,
			_f )   ((_x) & (_f))

CLEAR_FLAGS

#define CLEAR_FLAGS	(		_x,
			_f )   ((_x) &= ~(_f))

CLEAR_OTHER_FLAGS

#define CLEAR_OTHER_FLAGS	(		_x,
			_f )   ((_x) &= (_f))

READ_PORT_UCHAR

#define READ_PORT_UCHAR   UartHardwareAccess.ReadPort8

READ_PORT_ULONG

#define READ_PORT_ULONG   UartHardwareAccess.ReadPort32

READ_PORT_USHORT

#define READ_PORT_USHORT   UartHardwareAccess.ReadPort16

READ_REGISTER_UCHAR

#define READ_REGISTER_UCHAR   UartHardwareAccess.ReadRegister8

READ_REGISTER_ULONG

#define READ_REGISTER_ULONG   UartHardwareAccess.ReadRegister32

READ_REGISTER_ULONG64

#define READ_REGISTER_ULONG64   UartHardwareAccess.ReadRegister64

READ_REGISTER_USHORT

#define READ_REGISTER_USHORT   UartHardwareAccess.ReadRegister16

SET_FLAGS

#define SET_FLAGS	(		_x,
			_f )   ((_x) |= (_f))

WRITE_PORT_UCHAR

#define WRITE_PORT_UCHAR   UartHardwareAccess.WritePort8

WRITE_PORT_ULONG

#define WRITE_PORT_ULONG   UartHardwareAccess.WritePort32

WRITE_PORT_USHORT

#define WRITE_PORT_USHORT   UartHardwareAccess.WritePort16

WRITE_REGISTER_UCHAR

#define WRITE_REGISTER_UCHAR   UartHardwareAccess.WriteRegister8

WRITE_REGISTER_ULONG

#define WRITE_REGISTER_ULONG   UartHardwareAccess.WriteRegister32

WRITE_REGISTER_ULONG64

#define WRITE_REGISTER_ULONG64   UartHardwareAccess.WriteRegister64

WRITE_REGISTER_USHORT

#define WRITE_REGISTER_USHORT   UartHardwareAccess.WriteRegister16

Typedef Documentation

ACPI_GENERIC_ACCESS_SIZE

typedef enum _ACPI_GENERIC_ACCESS_SIZE ACPI_GENERIC_ACCESS_SIZE

PACPI_GENERIC_ACCESS_SIZE

typedef enum _ACPI_GENERIC_ACCESS_SIZE * PACPI_GENERIC_ACCESS_SIZE

Enumeration Type Documentation

_ACPI_GENERIC_ACCESS_SIZE

enum _ACPI_GENERIC_ACCESS_SIZE

Enumerator
AcpiGenericAccessSizeLegacy
AcpiGenericAccessSizeByte
AcpiGenericAccessSizeWord
AcpiGenericAccessSizeDWord
AcpiGenericAccessSizeQWord

{
    AcpiGenericAccessSizeLegacy = 0,
    AcpiGenericAccessSizeByte,
    AcpiGenericAccessSizeWord,
    AcpiGenericAccessSizeDWord,
    AcpiGenericAccessSizeQWord
} ACPI_GENERIC_ACCESS_SIZE,

Function Documentation

UartpSetAccess()

BOOLEAN UartpSetAccess	(	_Inout_ PCPPORT	Port,
		const BOOLEAN	MemoryMapped,
		const UCHAR	AccessSize,
		const UCHAR	BitWidth )

{
    UCHAR                             MinRegisterWidth;
    BOOLEAN                           PowerOfTwo;
    UART_HARDWARE_READ_INDEXED_UCHAR  ReadFunction;
    UART_HARDWARE_WRITE_INDEXED_UCHAR WriteFunction;
 
    MinRegisterWidth = 8;
 
    //
    // Select the appropriate port access routines depending upon whether this
    // serial port is mapped into memory or I/O space.
    //
 
    if (MemoryMapped == FALSE)
    {
        switch ((ACPI_GENERIC_ACCESS_SIZE)AccessSize)
        {
#if defined(_X86_) || defined(_AMD64_)
 
        case AcpiGenericAccessSizeLegacy:
            __fallthrough;
 
        case AcpiGenericAccessSizeByte:
            WriteFunction = WritePortWithIndex8;
            ReadFunction  = ReadPortWithIndex8;
            break;
 
        case AcpiGenericAccessSizeWord:
            WriteFunction    = WritePortWithIndex16;
            ReadFunction     = ReadPortWithIndex16;
            MinRegisterWidth = 16;
            break;
 
        case AcpiGenericAccessSizeDWord:
            WriteFunction    = WritePortWithIndex32;
            ReadFunction     = ReadPortWithIndex32;
            MinRegisterWidth = 32;
            break;
 
            //
            // The quad word access size isn't supported for port based I/O.
            //
 
#endif
 
        default:
            return FALSE;
        }
    }
    else
    {
        switch ((ACPI_GENERIC_ACCESS_SIZE)AccessSize)
        {
        case AcpiGenericAccessSizeLegacy:
            __fallthrough;
 
        case AcpiGenericAccessSizeByte:
            WriteFunction = WriteRegisterWithIndex8;
            ReadFunction  = ReadRegisterWithIndex8;
            break;
 
        case AcpiGenericAccessSizeWord:
            WriteFunction    = WriteRegisterWithIndex16;
            ReadFunction     = ReadRegisterWithIndex16;
            MinRegisterWidth = 16;
            break;
 
        case AcpiGenericAccessSizeDWord:
            WriteFunction    = WriteRegisterWithIndex32;
            ReadFunction     = ReadRegisterWithIndex32;
            MinRegisterWidth = 32;
            break;
 
#if defined(_WIN64)
 
        case AcpiGenericAccessSizeQWord:
            WriteFunction    = WriteRegisterWithIndex64;
            ReadFunction     = ReadRegisterWithIndex64;
            MinRegisterWidth = 64;
            break;
 
#endif
 
        default:
            return FALSE;
        }
    }
 
    //
    // Validate BitWidth parameter.
    //
 
    PowerOfTwo = ((BitWidth & (BitWidth - 1)) == 0);
    if ((PowerOfTwo == FALSE) ||
        (BitWidth < MinRegisterWidth) ||
        (BitWidth > MAX_REGISTER_WIDTH))
    {
        return FALSE;
    }
 
    Port->ByteWidth = BitWidth / 8;
    Port->Write     = WriteFunction;
    Port->Read      = ReadFunction;
    return TRUE;
}

Variable Documentation

UartHardwareAccess

UART_HARDWARE_ACCESS UartHardwareAccess

extern

                                          {
 
#if defined(_X86_)
 
    ReadPort8,
    WritePort8,
    ReadPort16,
    WritePort16,
    ReadPort32,
    WritePort32,
 
#elif defined(_AMD64_)
 
    READ_PORT_UCHAR,
    WRITE_PORT_UCHAR,
    READ_PORT_USHORT,
    WRITE_PORT_USHORT,
    READ_PORT_ULONG,
    WRITE_PORT_ULONG,
 
#else
 
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
    NULL,
 
#endif
 
#if defined(_X86_)
 
    ReadRegister8,
    WriteRegister8,
    ReadRegister16,
    WriteRegister16,
    ReadRegister32,
    WriteRegister32,
 
#else
 
    READ_REGISTER_UCHAR,
    WRITE_REGISTER_UCHAR,
    READ_REGISTER_USHORT,
    WRITE_REGISTER_USHORT,
    READ_REGISTER_ULONG,
    WRITE_REGISTER_ULONG,
 
#endif
 
#if defined(_WIN64)
 
    READ_REGISTER_ULONG64,
    WRITE_REGISTER_ULONG64
 
#else
 
    NULL,
    NULL
 
#endif
 
};